Struct InvokeContext 

pub struct InvokeContext<'a, 'ix_data> {
    pub transaction_context: &'a mut TransactionContext<'ix_data>,
    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<'ix_data>

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, 'ix_data> InvokeContext<'a, 'ix_data>

pub fn new( transaction_context: &'a mut TransactionContext<'ix_data>, program_cache_for_tx_batch: &'a mut ProgramCacheForTxBatch, environment_config: EnvironmentConfig<'a>, log_collector: Option<Rc<RefCell<LogCollector>>>, compute_budget: SVMTransactionExecutionBudget, execution_cost: SVMTransactionExecutionCost, ) -> InvokeContext<'a, 'ix_data>

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

Push a stack frame onto the invocation stack

pub fn get_stack_height(&self) -> usize

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

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

Entrypoint for a cross-program invocation from a builtin program

pub fn prepare_next_instruction( &mut self, instruction: Instruction, signers: &[Address], ) -> Result<(), InstructionError>

Helper to prepare for process_instruction() when the instruction is not a top level one, and depends on AccountMetas

pub fn prepare_next_top_level_instruction( &mut self, message: &impl SVMMessage, instruction: &SVMInstruction<'_>, program_account_index: u16, data: &'ix_data [u8], ) -> Result<(), InstructionError>

Helper to prepare for process_instruction()/process_precompile() when the instruction is a top level one

pub fn process_instruction( &mut self, 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( &mut self, program_id: &Address, instruction_data: &[u8], 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) -> &SVMTransactionExecutionBudget

Get this invocation’s compute budget

pub fn get_execution_cost(&self) -> &SVMTransactionExecutionCost

Get this invocation’s compute budget

pub fn get_feature_set(&self) -> &SVMFeatureSet

Get the current feature set.

pub fn get_program_runtime_environments_for_deployment( &self, ) -> &ProgramRuntimeEnvironments

pub fn is_stake_raise_minimum_delegation_to_1_sol_active(&self) -> bool

pub fn is_deprecate_legacy_vote_ixs_active(&self) -> bool

pub fn get_sysvar_cache(&self) -> &SysvarCache

Get cached sysvars

pub fn get_epoch_stake(&self) -> u64

Get cached epoch total stake.

pub fn get_epoch_stake_for_vote_account(&self, pubkey: &'a Address) -> u64

Get cached stake for the epoch vote account.

pub fn is_precompile(&self, pubkey: &Address) -> bool

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 insert_register_trace(&mut self, register_trace: Vec<[u64; 12]>)

Insert a VM register trace

pub fn iterate_vm_traces( &self, callback: &dyn Fn(InstructionContext<'_, '_>, &Executable<InvokeContext<'static, 'static>>, &[[u64; 12]]), )

Iterates over all VM register traces (including CPI)

Trait Implementations

impl ContextObject for InvokeContext<'_, '_>

fn consume(&mut self, amount: u64)

Consume instructions from meter

fn get_remaining(&self) -> u64

Get the number of remaining instructions allowed