Struct EvalContext

pub struct EvalContext<'a> { /* private fields */ }

Evaluation context for the AVM

Implementations

impl<'a> EvalContext<'a>

pub fn new( program: &'a [u8], run_mode: RunMode, cost_budget: u64, version: TealVersion, group_index: usize, group_size: usize, ledger: &'a mut dyn LedgerAccess, ) -> Self

Create a new evaluation context

pub fn set_trace_enabled(&mut self, enabled: bool)

Enable or disable execution tracing

pub fn trace(&self) -> &[String]

Get the execution trace

pub fn add_trace(&mut self, message: String)

Add a trace entry

pub fn stack(&self) -> &[StackValue]

Get a read-only reference to the stack

pub fn push(&mut self, value: StackValue) -> AvmResult<()>

Push a value onto the stack

pub fn pop(&mut self) -> AvmResult<StackValue>

Pop a value from the stack

pub fn peek(&self) -> AvmResult<&StackValue>

Peek at the top value on the stack without removing it

pub fn stack_size(&self) -> usize

Get the current stack size

pub fn stack_is_empty(&self) -> bool

Check if the stack is empty

pub fn peek_at_depth(&self, depth: usize) -> AvmResult<&StackValue>

Get value at stack depth N (0 = top, 1 = one below top, etc.)

pub fn remove_at_depth(&mut self, depth: usize) -> AvmResult<StackValue>

Remove value at stack depth N and return it

pub fn insert_at_depth( &mut self, depth: usize, value: StackValue, ) -> AvmResult<()>

Insert value at stack depth N (0 = top)

pub fn pc(&self) -> usize

Get the current program counter

pub fn program_len(&self) -> usize

Get the program length

pub fn set_pc(&mut self, pc: usize) -> AvmResult<()>

Set the program counter

pub fn advance_pc(&mut self, offset: usize) -> AvmResult<()>

Advance the program counter

pub fn current_byte(&self) -> AvmResult<u8>

Get the current program byte at PC

pub fn read_bytes(&self, count: usize) -> AvmResult<&[u8]>

Read bytes from program starting at PC

pub fn add_cost(&mut self, cost: u64) -> AvmResult<()>

Add to the execution cost

pub fn cost(&self) -> u64

Get the current execution cost

pub fn cost_budget(&self) -> u64

Get the cost budget

pub fn version(&self) -> TealVersion

Get the TEAL version

pub fn run_mode(&self) -> RunMode

Get the run mode

pub fn group_index(&self) -> usize

Get the group index

pub fn group_size(&self) -> usize

Get the group size

pub fn get_scratch(&self, index: u8) -> AvmResult<&StackValue>

Get a value from scratch space

pub fn set_scratch(&mut self, index: u8, value: StackValue) -> AvmResult<()>

Set a value in scratch space

pub fn call_subroutine(&mut self, target: usize) -> AvmResult<()>

Call a subroutine

pub fn return_from_subroutine(&mut self) -> AvmResult<()>

Return from a subroutine

pub fn ledger(&self) -> &dyn LedgerAccess

Get the ledger access interface

pub fn ledger_mut(&mut self) -> &mut dyn LedgerAccess

Get mutable access to the ledger

pub fn is_finished(&self) -> bool

Check if execution is finished

pub fn set_function_prototype( &mut self, args: usize, returns: usize, ) -> AvmResult<()>

Set function prototype

pub fn frame_dig(&self, depth: i8) -> AvmResult<StackValue>

Dig value from function frame

pub fn frame_bury(&mut self, depth: i8, value: StackValue) -> AvmResult<()>

Bury value in function frame

pub fn set_int_constants(&mut self, constants: Vec<u64>)

Store integer constants from intcblock

pub fn set_byte_constants(&mut self, constants: Vec<Vec<u8>>)

Store byte constants from bytecblock

pub fn get_int_constant(&self, index: usize) -> AvmResult<u64>

Get integer constant by index

pub fn get_byte_constant(&self, index: usize) -> AvmResult<&[u8]>

Get byte constant by index

pub fn get_program(&self) -> &[u8]

Get program reference for reading bytes

pub fn branch(&mut self, target: i16) -> AvmResult<()>

Branch to a relative target

pub fn current_opcode_spec<'b>( &self, vm: &'b VirtualMachine, ) -> AvmResult<&'b OpSpec>

Get current opcode specification (for debugging)

pub fn step( &mut self, vm: &VirtualMachine, config: &ExecutionConfig, ) -> AvmResult<()>

Execute a single step with the given VM and config

Trait Implementations

impl<'a> Debug for EvalContext<'a>

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

Formats the value using the given formatter.