Struct Interpreter

pub struct Interpreter<M, S, Tx = (), Ecal = NotSupportedEcal> { /* private fields */ }

VM interpreter.

The internal state of the VM isn’t expose because the intended usage is to either inspect the resulting receipts after a transaction execution, or the resulting mutated transaction.

These can be obtained with the help of a crate::transactor::Transactor or a client implementation.

Implementations

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where Tx: Default, Ecal: Default,

pub fn with_storage( memory: M, storage: S, interpreter_params: InterpreterParams, ) -> Self

Create a new interpreter instance out of a storage implementation.

If the provided storage implements crate::storage::InterpreterStorage, the returned interpreter will provide full functionality.

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where Tx: Default,

pub fn with_storage_and_ecal( memory: M, storage: S, interpreter_params: InterpreterParams, ecal_state: Ecal, ) -> Self

Create a new interpreter instance out of a storage implementation.

If the provided storage implements crate::storage::InterpreterStorage, the returned interpreter will provide full functionality.

impl<M, S, Tx, Ecal> Interpreter<M, Record<S>, Tx, Ecal>

where S: InterpreterStorage, Tx: ExecutableTransaction,

pub fn remove_recording(self) -> Interpreter<M, S, Tx, Ecal>

Remove the [Recording] wrapper from the storage. Recording storage changes has an overhead so it’s useful to be able to remove it once the diff is generated.

pub fn storage_diff(&self) -> Diff<Deltas>

Get the diff of changes to this VMs storage.

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where M: Memory, S: InterpreterStorage, Tx: ExecutableTransaction,

pub fn add_recording(self) -> Interpreter<M, Record<S>, Tx, Ecal>

Add a [Recording] wrapper around the storage to record any changes this VM makes to it’s storage. Recording storage changes has an overhead so should be used in production.

pub fn reset_vm_state(&mut self, diff: &Diff<InitialVmState>)

where Tx: Clone + 'static,

Change this VMs internal state to match the initial state from this diff.

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where M: Memory,

pub fn diff(&self, other: &Self) -> Diff<Deltas>

where Tx: PartialEq + Clone + Debug + 'static,

The diff function generates a diff of VM state, represented by the Diff struct, between two VMs internal states.

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where M: Memory, S: InterpreterStorage, Tx: ExecutableTransaction, Ecal: EcalHandler,

pub fn execute( &mut self, ) -> Result<ExecuteState, InterpreterError<S::DataError>>

Execute the current instruction located in $m[$pc].

pub fn instruction<R: Into<RawInstruction> + Copy>( &mut self, raw: R, ) -> Result<ExecuteState, InterpreterError<S::DataError>>

Execute a provided instruction

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where M: Memory, S: InterpreterStorage, Tx: ExecutableTransaction, <Tx as IntoChecked>::Metadata: CheckedMetadata, Ecal: EcalHandler,

pub fn transact( &mut self, tx: Ready<Tx>, ) -> Result<StateTransitionRef<'_, Tx>, InterpreterError<S::DataError>>

Initialize a pre-allocated instance of Interpreter with the provided transaction and execute it. The result will be bound to the lifetime of the interpreter and will avoid unnecessary copy with the data that can be referenced from the interpreter instance itself.

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where S: InterpreterStorage,

pub fn deploy( &mut self, tx: Ready<Create>, ) -> Result<Create, InterpreterError<S::DataError>>

Deploys Create transaction without initialization VM and without invalidation of the last state of execution of the Script transaction.

Returns Create transaction with all modifications after execution.

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where S: InterpreterStorage,

pub fn upgrade( &mut self, tx: Ready<Upgrade>, ) -> Result<Upgrade, InterpreterError<S::DataError>>

Executes Upgrade transaction without initialization VM and without invalidation of the last state of execution of the Script transaction.

Returns Upgrade transaction with all modifications after execution.

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where S: InterpreterStorage,

pub fn upload( &mut self, tx: Ready<Upload>, ) -> Result<Upload, InterpreterError<S::DataError>>

Executes Upload transaction without initialization VM and without invalidation of the last state of execution of the Script transaction.

Returns Upload transaction with all modifications after execution.

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where S: InterpreterStorage,

pub fn blob( &mut self, tx: Ready<Blob>, ) -> Result<Blob, InterpreterError<S::DataError>>

Executes Blob transaction without initialization VM and without invalidation of the last state of execution of the Script transaction.

Returns Blob transaction with all modifications after execution.

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where M: Memory, S: InterpreterStorage, Tx: ExecutableTransaction, Ecal: EcalHandler,

pub fn resume(&mut self) -> Result<ProgramState, InterpreterError<S::DataError>>

Continue the execution from a previously interrupted program flow.

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where M: Memory, S: InterpreterStorage, Tx: ExecutableTransaction,

pub fn prepare_call( &mut self, ra: RegId, rb: RegId, rc: RegId, rd: RegId, ) -> IoResult<(), S::DataError>

Prepare a call instruction for execution

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

pub fn remaining_gas(&self) -> Word

Global remaining gas amount

pub fn gas_charge(&mut self, gas: Word) -> SimpleResult<()>

Do a gas charge with the given amount, panicing when running out of gas.

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where M: Memory, Tx: ExecutableTransaction, S: InterpreterStorage,

pub fn init_predicate( &mut self, context: Context, tx: Tx, gas_limit: Word, ) -> Result<(), InterpreterError<S::DataError>>

Initialize the VM for a predicate context

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where M: Memory, S: InterpreterStorage, <S as InterpreterStorage>::DataError: From<S::DataError>, Tx: ExecutableTransaction, <Tx as IntoChecked>::Metadata: CheckedMetadata,

pub fn init_script( &mut self, ready_tx: Ready<Tx>, ) -> Result<(), InterpreterError<S::DataError>>

Initialize the VM with a given transaction, backed by a storage provider that allows execution of contract opcodes.

For predicate estimation and verification, check Self::init_predicate

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where M: Memory,

pub fn allocate(&mut self, amount: Word) -> SimpleResult<()>

Expand heap by amount bytes.

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where Tx: ExecutableTransaction,

pub const fn single_stepping(&self) -> bool

Get single-stepping mode

pub fn set_single_stepping(&mut self, single_stepping: bool)

Set single-stepping mode

pub fn clear_breakpoints(&mut self)

Clear all set breakpoints.

pub fn set_breakpoint(&mut self, breakpoint: Breakpoint)

Set a new breakpoint for the provided location.

pub fn overwrite_breakpoints(&mut self, breakpoints: &[Breakpoint])

Overwrite all breakpoints with a new set of breakpoints.

pub fn remove_breakpoint(&mut self, breakpoint: &Breakpoint)

Remove a previously set breakpoint.

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

where Ecal: EcalHandler,

pub fn ecal_state(&self) -> &Ecal

Read access to the ECAL state

pub fn ecal_state_mut(&mut self) -> &mut Ecal

Write access to the ECAL state

impl<M: Memory, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

pub fn memory(&self) -> &MemoryInstance

Returns the current state of the VM memory

impl<M: AsMut<MemoryInstance>, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

pub fn memory_mut(&mut self) -> &mut MemoryInstance

Returns mutable access to the vm memory

impl<M, S, Tx, Ecal> Interpreter<M, S, Tx, Ecal>

pub const fn registers(&self) -> &[Word]

Returns the current state of the registers

pub fn registers_mut(&mut self) -> &mut [Word]

Returns mutable access to the registers

pub const fn debugger(&self) -> &Debugger

Debug handler

pub fn transaction(&self) -> &Tx

The current transaction.

pub fn initial_balances(&self) -> &InitialBalances

The initial balances.

pub fn max_inputs(&self) -> u16

Get max_inputs value

pub fn gas_price(&self) -> Word

Gas price for current block

pub fn gas_costs(&self) -> &GasCosts

Gas costs for opcodes

pub fn fee_params(&self) -> &FeeParameters

Get the Fee Parameters

pub fn base_asset_id(&self) -> &AssetId

Get the base Asset ID

pub fn contract_max_size(&self) -> u64

Get contract_max_size value

pub fn tx_offset(&self) -> usize

Get tx_offset value

pub fn max_message_data_length(&self) -> u64

Get max_message_data_length value

pub fn chain_id(&self) -> ChainId

Get the chain id

pub fn receipts(&self) -> &[Receipt]

Receipts generated by a transaction execution.

pub fn compute_receipts_root(&self) -> Bytes32

Compute current receipts root

Trait Implementations

impl<M, S, Tx, Ecal> AsMut<S> for Interpreter<M, S, Tx, Ecal>

fn as_mut(&mut self) -> &mut S

Converts this type into a mutable reference of the (usually inferred) input type.

impl<M, S, Tx, Ecal> AsRef<Interpreter<M, S, Tx, Ecal>> for Transactor<M, S, Tx, Ecal>

where Tx: ExecutableTransaction, S: InterpreterStorage, Ecal: EcalHandler,

fn as_ref(&self) -> &Interpreter<M, S, Tx, Ecal>

Converts this type into a shared reference of the (usually inferred) input type.

impl<M, S, Tx, Ecal> AsRef<S> for Interpreter<M, S, Tx, Ecal>

fn as_ref(&self) -> &S

Converts this type into a shared reference of the (usually inferred) input type.

impl<M: Clone, S: Clone, Tx: Clone, Ecal: Clone> Clone for Interpreter<M, S, Tx, Ecal>

fn clone(&self) -> Interpreter<M, S, Tx, Ecal>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<M: Debug, S: Debug, Tx: Debug, Ecal: Debug> Debug for Interpreter<M, S, Tx, Ecal>

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

Formats the value using the given formatter.

impl<M, S, Tx, Ecal> From<Interpreter<M, S, Tx, Ecal>> for Transactor<M, S, Tx, Ecal>

where Tx: ExecutableTransaction, S: InterpreterStorage,

fn from(interpreter: Interpreter<M, S, Tx, Ecal>) -> Self

Converts to this type from the input type.

impl<M, S, Tx, Ecal> From<Transactor<M, S, Tx, Ecal>> for Interpreter<M, S, Tx, Ecal>

where Tx: ExecutableTransaction, S: InterpreterStorage,

fn from(transactor: Transactor<M, S, Tx, Ecal>) -> Self

Converts to this type from the input type.

impl<M, S, Tx, Ecal> PartialEq for Interpreter<M, S, Tx, Ecal>

where M: Memory, Tx: PartialEq,

fn eq(&self, other: &Self) -> bool

Does not compare storage, debugger or profiler

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.