Adding `cairo_lang_runner` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add cairo-lang-runner

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

cairo-lang-runner = "2.15.0"

The cairo_lang_runner library will be automatically available globally. Read the cairo_lang_runner library documentation.

Back to the crate overview.

Readme

Compiling and running cairo files

cargo run --bin cairo-run -- --single-file /path/to/file.cairo

If we want to run code that is gas tested:

cargo run --bin cairo-run -- --single-file /path/to/file.cairo --available-gas 200

We currently only run the main function with no arguments besides implicits.

Example

// Calculates fib...
fn main() -> u128 {
    fib(1_u128, 1_u128, 100_u128)
}

fn fib(a: u128, b: u128, n: u128) -> u128 {
    if n == 0 {
        a
    } else {
        fib(b, a + b, n - 1_u128)
    }
}

Command-Line Options

--single-file - Treat the path as a single file instead of a project directory.
--available-gas <amount> - Set the amount of gas available for execution.
--print-full-memory - Print the full memory state after execution.
--allow-warnings - Allow the compilation to succeed even with warnings.
--run-profiler - Run the profiler and display profiling information.

Additional Information

When compiling with --available-gas, if there are cycles in the code, calls to withdraw_gas_all will be automatically added.
Functions with calls to withdraw_gas_all will not compile without --available-gas value.
Functions without calls to withdraw_gas_all will not compile with --available-gas value.
When running functions returning arrays --print-full-memory should probably be used, to actually see the values contained in the array.

Adding cairo_lang_runner library as a dependency

Adding `cairo_lang_runner` library as a dependency