software-mansion / universal-sierra-compiler Goto Github PK

We should consider creating a script which will go through every contract on a network and will try to compile its sierra

We should consider publishing this crate on crates.io, based on the preferred way of using the compiled binary

New version of sierra was introduced in 2.5.0
This needs to be supported in this crate/binary as well

Preferably a table in README or in release descriptions

https://github.com/software-mansion/universal-sierra-compiler/blob/046bdfd164c66bf1c55d37cb229dd7cb2ac2ee07/src/commands/compile_contract.rs#L43C70-L43C74

Please verify if there is more 🙏

We should describe:

• what it does
• how it can be useful in scope of other tools
• how we use it in snfoundry
• how and when to upgrade it

Not sure what is the exact problem, but running install script on macos does seem to not always be adding usc to path, eg
https://github.com/foundry-rs/starknet-foundry/actions/runs/8173634078/job/22347462794

the same thing works fine for linux though

I think many people will ponder this question:

Why is this a binary and not a regular Rust crate?

Especially as for some projects, it would be much easier to consume a Rust crate. I think I get why it is this like this, but it's completely not an obvious answer. I think the README is a fine place.

We are using in forge the cairo_lang_sierra::program::Program class and compiling it down to CASM with cairo_lang_sierra_to_casm::compiler::compile.

This binary should be able to compile that artifact as well

Reference:
https://github.com/foundry-rs/starknet-foundry/blob/master/crates/forge-runner/src/sierra_casm_runner.rs#L67

          a nice idea would be to smoke-test here but it can be added later

Originally posted by @Arcticae in #8 (comment)

We should create a bunch of e2e tests to check the binary.
Those can be similar to sncasts' e2e tests

https://github.com/foundry-rs/starknet-foundry/blob/93b2a2a976073411d3ec694dcc330b67f1b8ab3b/crates/sncast/tests/e2e/declare.rs#L46

We should expose some public API (if not already sufficient) and publish the crate on crates.io in order to facilitate use in other rust-based tools.