Struct VmContext

pub struct VmContext<'ctx> {
    pub witness: StateValue,
    pub destructible_input: &'ctx [(Input, StateCell)],
    pub immutable_input: &'ctx [StateValue],
    pub destructible_output: &'ctx [StateCell],
    pub immutable_output: &'ctx [StateData],
}

Context object provided to the VM instance, containing references to the operation inputs and outputs.

Fields

witness: StateValue

Operation-level witness.

destructible_input: &'ctx [(Input, StateCell)]

Operation input consisting of the destructible (read-once) memory cells.

immutable_input: &'ctx [StateValue]

Operation input consisting of the immutable (read-only) memory cells.

destructible_output: &'ctx [StateCell]

Operation output defining new destructible (read-once) memory cells.

immutable_output: &'ctx [StateData]

Operation output defining new immutable (append-only) memory cells.

Implementations

impl VmContext<'_>

pub fn state_value(&self, cat: IoCat, index: u16) -> Option<StateValue>

Returns a state value from the provided category of operation inputs/outputs using the given index.

If the operation doesn’t contain input/output with the index, returns None.

pub fn input_lock_aux(&self, index: u16) -> Option<StateValue>

Returns a state value from the destructible input previous output auxiliary data.

pub fn input_witness(&self, index: u16) -> Option<StateValue>

Returns a state value from the destructible input witness.

pub fn input_auth_token(&self, index: u16) -> Option<(AuthToken, bool)>

Returns a state value from the destructible input previous output auth token and whether it is locked by a script.

Trait Implementations

impl<'ctx> Clone for VmContext<'ctx>

fn clone(&self) -> VmContext<'ctx>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'ctx> Debug for VmContext<'ctx>

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

Formats the value using the given formatter.

impl<'ctx> PartialEq for VmContext<'ctx>

fn eq(&self, other: &VmContext<'ctx>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'ctx> Eq for VmContext<'ctx>

impl<'ctx> StructuralPartialEq for VmContext<'ctx>