Struct zksync_vm2::VirtualMachine

pub struct VirtualMachine<T, W> { /* private fields */ }

High-performance out-of-circuit EraVM implementation.

Implementations

impl<T: Tracer, W: World<T>> VirtualMachine<T, W>

pub fn new( address: H160, program: Program<T, W>, caller: H160, calldata: &[u8], gas: u32, settings: Settings, ) -> Self

Creates a new VM instance.

pub fn world_diff(&self) -> &WorldDiff

Provides a reference to the World diff accumulated by VM execution so far.

pub fn run(&mut self, world: &mut W, tracer: &mut T) -> ExecutionEnd

Runs this VM with the specified World and Tracer until an end of execution due to a hook, or an error.

pub fn resume_with_additional_gas_limit( &mut self, world: &mut W, tracer: &mut T, gas_limit: u32, ) -> Option<(u32, ExecutionEnd)>

Returns how much of the extra gas limit is left and the stop reason, unless the extra gas limit was exceeded.

Needed to support account validation gas limit. We cannot simply reduce the available gas, as contracts might behave differently depending on remaining gas.

pub fn make_snapshot(&mut self)

Creates a VM snapshot. The snapshot can then be rolled back to, or discarded.

Panics

• Panics if called outside the initial (bootloader) callframe.
• Panics if this VM already has a snapshot.

pub fn rollback(&mut self)

Returns the VM to the state it was in when Self::make_snapshot() was called.

Panics

• Panics if this VM doesn’t hold a snapshot.
• Panics if called outside the initial (bootloader) callframe.

pub fn pop_snapshot(&mut self)

Pops a previously made snapshot without rolling back to it. This effectively commits all changes made up to this point, so that they cannot be rolled back.

Panics

• Panics if called outside the initial (bootloader) callframe.

Trait Implementations

impl<T: Debug, W: Debug> Debug for VirtualMachine<T, W>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Tracer, W: World<T>> StateInterface for VirtualMachine<T, W>

fn read_register(&self, register: u8) -> (U256, bool)

Reads a register with the specified zero-based index. Returns a value together with a pointer flag.

fn set_register(&mut self, register: u8, value: U256, is_pointer: bool)

Sets a register with the specified zero-based index

fn number_of_callframes(&self) -> usize

Returns the total number of call frames.

fn current_frame(&mut self) -> impl CallframeInterface + '_

Returns a mutable handle to the current call frame.

fn callframe(&mut self, n: usize) -> impl CallframeInterface + '_

Returns a mutable handle to a call frame with the specified index, where zero is the current frame, one is the frame before that etc.

fn read_heap_byte(&self, heap: HeapId, index: u32) -> u8

Reads a single byte from the specified heap at the specified 0-based offset.

fn read_heap_u256(&self, heap: HeapId, index: u32) -> U256

Reads an entire U256 word in the big-endian order from the specified heap / offset (which is the index of the most significant byte of the read value).

fn write_heap_u256(&mut self, heap: HeapId, index: u32, value: U256)

Writes an entire U256 word in the big-endian order to the specified heap at the specified offset (which is the index of the most significant byte of the written value).

fn flags(&self) -> Flags

Returns current execution flags.

fn set_flags(&mut self, flags: Flags)

Sets current execution flags.

fn transaction_number(&self) -> u16

Returns the currently set 0-based transaction number.

fn set_transaction_number(&mut self, value: u16)

Sets the current transaction number.

fn context_u128_register(&self) -> u128

Returns the value of the context register.

fn set_context_u128_register(&mut self, value: u128)

Sets the value of the context register.

fn get_storage_state(&self) -> impl Iterator<Item = ((H160, U256), U256)>

Iterates over storage slots read or written during VM execution.

fn get_transient_storage_state( &self, ) -> impl Iterator<Item = ((H160, U256), U256)>

Iterates over all transient storage slots set during VM execution.

fn get_transient_storage(&self, address: H160, slot: U256) -> U256

Gets value of the specified transient storage slot.

fn write_transient_storage(&mut self, address: H160, slot: U256, value: U256)

Sets value of the specified transient storage slot.

fn events(&self) -> impl Iterator<Item = Event>

Iterates over events emitted during VM execution.

fn l2_to_l1_logs(&self) -> impl Iterator<Item = L2ToL1Log>

Iterates over L2-to-L1 logs emitted during VM execution.

fn pubdata(&self) -> i32

Gets the current amount of published pubdata.

fn set_pubdata(&mut self, value: i32)

Sets the current amount of published pubdata.