Struct cairo_lang_runner::SierraCasmRunner

pub struct SierraCasmRunner { /* private fields */ }

Runner enabling running a Sierra program on the vm.

Implementations

impl SierraCasmRunner

pub fn new( sierra_program: Program, metadata_config: Option<MetadataComputationConfig>, starknet_contracts_info: OrderedHashMap<Felt252, ContractInfo>, run_profiler: bool ) -> Result<Self, RunnerError>

pub fn run_function_with_starknet_context( &self, func: &Function, args: &[Arg], available_gas: Option<usize>, starknet_state: StarknetState ) -> Result<RunResultStarknet, RunnerError>

Runs the vm starting from a function in the context of a given starknet state.

pub fn run_function_with_vm<'a, Bytecode>( &self, func: &Function, vm: &mut VirtualMachine, hint_processor: &mut dyn HintProcessor, hints_dict: HashMap<usize, Vec<HintParams>>, bytecode: Bytecode, builtins: Vec<BuiltinName> ) -> Result<RunResult, RunnerError>

where Bytecode: Iterator<Item = &'a BigInt> + Clone,

Runs the vm starting from a function with custom hint processor. Function may have implicits, but no other ref params. The cost of the function is deducted from available_gas before the execution begins.

Allows injecting Cairo VirtualMachine

pub fn run_function<'a, Bytecode>( &self, func: &Function, hint_processor: &mut dyn HintProcessor, hints_dict: HashMap<usize, Vec<HintParams>>, bytecode: Bytecode, builtins: Vec<BuiltinName> ) -> Result<RunResult, RunnerError>

where Bytecode: Iterator<Item = &'a BigInt> + Clone,

Runs the vm starting from a function with custom hint processor. Function may have implicits, but no other ref params. The cost of the function is deducted from available_gas before the execution begins.

pub fn handle_main_return_value( inner_type_size: Option<i16>, values: Vec<Felt252>, cells: &[Option<Felt252>] ) -> RunResultValue

Handling the main return value to create a RunResultValue.

pub fn get_results_data( return_types: &[(GenericTypeId, i16)], cells: &[Option<Felt252>], ap: usize ) -> (Vec<(GenericTypeId, Vec<Felt252>)>, Option<Felt252>)

Returns the final values and type of all funcs returning variables.

pub fn find_function(&self, name_suffix: &str) -> Result<&Function, RunnerError>

Finds first function ending with name_suffix.

pub fn create_entry_code_from_params( param_types: &[(GenericTypeId, i16)], args: &[Arg], initial_gas: usize, code_offset: usize ) -> Result<(Vec<Instruction>, Vec<BuiltinName>), RunnerError>

pub fn create_entry_code( &self, func: &Function, args: &[Arg], initial_gas: usize ) -> Result<(Vec<Instruction>, Vec<BuiltinName>), RunnerError>

Returns the instructions to add to the beginning of the code to successfully call the main function, as well as the builtins required to execute the program.

pub fn get_initial_available_gas( &self, func: &Function, available_gas: Option<usize> ) -> Result<usize, RunnerError>

Returns the initial value for the gas counter. If available_gas is None returns 0.

pub fn initial_required_gas(&self, func: &Function) -> Option<usize>

pub fn create_code_footer() -> Vec<Instruction>

Creates a list of instructions that will be appended to the program’s bytecode.

pub fn get_casm_program(&self) -> &CairoProgram