Struct InvokeContext

pub struct InvokeContext<'a> {
    pub transaction_context: &'a mut TransactionContext,
    pub program_cache_for_tx_batch: &'a mut ProgramCacheForTxBatch,
    pub environment_config: EnvironmentConfig<'a>,
    pub execute_time: Option<Measure>,
    pub timings: ExecuteDetailsTimings,
    pub syscall_context: Vec<Option<SyscallContext>>,
    /* private fields */
}

Main pipeline from runtime to program execution.

Fields

transaction_context: &'a mut TransactionContext

Information about the currently executing transaction.

program_cache_for_tx_batch: &'a mut ProgramCacheForTxBatch

The local program cache for the transaction batch.

environment_config: EnvironmentConfig<'a>

Runtime configurations used to provision the invocation environment.

execute_time: Option<Measure>

Latest measurement not yet accumulated in ExecuteDetailsTimings::execute_us

timings: ExecuteDetailsTimings

syscall_context: Vec<Option<SyscallContext>>

Implementations

impl<'a> InvokeContext<'a>

pub fn new( transaction_context: &'a mut TransactionContext, program_cache_for_tx_batch: &'a mut ProgramCacheForTxBatch, environment_config: EnvironmentConfig<'a>, log_collector: Option<Rc<RefCell<LogCollector>>>, compute_budget: ComputeBudget, ) -> Self

pub fn get_environments_for_slot( &self, effective_slot: Slot, ) -> Result<&ProgramRuntimeEnvironments, InstructionError>

pub fn push(&mut self) -> Result<(), InstructionError>

Push a stack frame onto the invocation stack

pub fn pop(&mut self) -> Result<(), InstructionError>

Pop a stack frame from the invocation stack

pub fn get_stack_height(&self) -> usize

Current height of the invocation stack, top level instructions are height solana_sdk::instruction::TRANSACTION_LEVEL_STACK_HEIGHT

pub fn native_invoke( &mut self, instruction: StableInstruction, signers: &[Pubkey], ) -> Result<(), InstructionError>

Entrypoint for a cross-program invocation from a builtin program

pub fn prepare_instruction( &mut self, instruction: &StableInstruction, signers: &[Pubkey], ) -> Result<(Vec<InstructionAccount>, Vec<IndexOfAccount>), InstructionError>

Helper to prepare for process_instruction()

pub fn process_instruction( &mut self, instruction_data: &[u8], instruction_accounts: &[InstructionAccount], program_indices: &[IndexOfAccount], compute_units_consumed: &mut u64, timings: &mut ExecuteTimings, ) -> Result<(), InstructionError>

Processes an instruction and returns how many compute units were used

pub fn process_precompile<'ix_data>( &mut self, precompile: &Precompile, instruction_data: &[u8], instruction_accounts: &[InstructionAccount], program_indices: &[IndexOfAccount], message_instruction_datas_iter: impl Iterator<Item = &'ix_data [u8]>, ) -> Result<(), InstructionError>

Processes a precompile instruction

pub fn get_log_collector(&self) -> Option<Rc<RefCell<LogCollector>>>

Get this invocation’s LogCollector

pub fn consume_checked(&self, amount: u64) -> Result<(), Box<dyn Error>>

Consume compute units

pub fn mock_set_remaining(&self, remaining: u64)

Set compute units

Only use for tests and benchmarks

pub fn get_compute_budget(&self) -> &ComputeBudget

Get this invocation’s compute budget

pub fn get_feature_set(&self) -> &FeatureSet

Get the current feature set.

pub fn mock_set_feature_set(&mut self, feature_set: Arc<FeatureSet>)

Set feature set.

Only use for tests and benchmarks.

pub fn get_sysvar_cache(&self) -> &SysvarCache

Get cached sysvars

pub fn get_epoch_total_stake(&self) -> Option<u64>

Get cached epoch total stake.

pub fn get_epoch_vote_accounts(&self) -> Option<&VoteAccountsHashMap>

Get cached epoch vote accounts.

pub fn get_check_aligned(&self) -> bool

pub fn set_syscall_context( &mut self, syscall_context: SyscallContext, ) -> Result<(), InstructionError>

pub fn get_syscall_context(&self) -> Result<&SyscallContext, InstructionError>

pub fn get_syscall_context_mut( &mut self, ) -> Result<&mut SyscallContext, InstructionError>

pub fn get_traces(&self) -> &Vec<Vec<[u64; 12]>>

Return a references to traces

Trait Implementations

impl<'a> ContextObject for InvokeContext<'a>

fn trace(&mut self, state: [u64; 12])

Called for every instruction executed when tracing is enabled

fn consume(&mut self, amount: u64)

Consume instructions from meter

fn get_remaining(&self) -> u64

Get the number of remaining instructions allowed