Struct sputnikvm::ContextVM

pub struct ContextVM<M, P: Patch> { /* private fields */ }

A VM that executes using a context and block information.

Implementations

impl<M: Memory + Default, P: Patch> ContextVM<M, P>

pub fn new(context: Context, block: HeaderParams) -> Self

Create a new VM using the given context, block header and patch.

pub fn with_states(
    context: Context,
    block: HeaderParams,
    account_state: AccountState<P::Account>,
    blockhash_state: BlockhashState
) -> Self

Create a new VM with the given account state and blockhash state.

pub fn with_init<F: FnOnce(&mut ContextVM<M, P>)>(
    context: Context,
    block: HeaderParams,
    account_state: AccountState<P::Account>,
    blockhash_state: BlockhashState,
    f: F
) -> Self

Create a new VM with customized initialization code.

pub fn with_previous(
    context: Context,
    block: HeaderParams,
    vm: &ContextVM<M, P>
) -> Self

Create a new VM with the result of the previous VM. This is usually used by transaction for chainning them.

pub fn current_state(&self) -> &State<M, P>

Returns the current state of the VM.

pub fn current_machine(&self) -> &Machine<M, P>

Returns the current runtime machine.

pub fn add_context_history_hook<F: 'static + Fn(&Context)>(&mut self, f: F)

Add a new context history hook.

Trait Implementations

impl<M: Memory + Default, P: Patch> VM for ContextVM<M, P>

fn commit_account(
    &mut self,
    commitment: AccountCommitment
) -> Result<(), CommitError>

Commit an account information to this VM. This should only be used when receiving RequireError.

fn commit_blockhash(
    &mut self,
    number: U256,
    hash: H256
) -> Result<(), CommitError>

Commit a block hash to this VM. This should only be used when receiving RequireError.

fn status(&self) -> VMStatus

Returns the current status of the VM.

fn peek(&self) -> Option<Instruction>

Read the next instruction to be executed.

fn peek_opcode(&self) -> Option<Opcode>

Read the next opcode to be executed.

fn step(&mut self) -> Result<(), RequireError>

Run one instruction and return. If it succeeds, VM status can still be Running. If the call stack has more than one items, this will only executes the last items’ one single instruction.

fn fire(&mut self) -> Result<(), RequireError>

Run instructions until it reaches a RequireError or exits. If this function succeeds, the VM status can only be either ExitedOk or ExitedErr.

fn accounts(&self) -> Values<'_, Address, AccountChange>

Returns the changed or committed accounts information up to current execution status.

fn used_addresses(&self) -> Set<Address>

Returns all fetched or modified addresses.

fn out(&self) -> &[u8]

Returns the out value, if any.

fn available_gas(&self) -> Gas

Returns the available gas of this VM.

fn refunded_gas(&self) -> Gas

Returns the refunded gas of this VM.

fn logs(&self) -> &[Log]

Returns logs to be appended to the current block if the user decided to accept the running status of this VM.

fn removed(&self) -> &[Address]

Returns all removed account addresses as for current VM execution.

fn used_gas(&self) -> Gas

Returns the real used gas by the transaction or the VM context. Only available when the status of the VM is exited. Otherwise returns zero.