Struct solana_program_runtime::invoke_context::InvokeContext

pub struct InvokeContext<'a> {

    pub transaction_context: &'a mut TransactionContext,
    rent: Rent,
    pre_accounts: Vec<PreAccount>,
    builtin_programs: &'a [BuiltinProgram],
    sysvar_cache: &'a SysvarCache,
    log_collector: Option<Rc<RefCell<LogCollector>>>,
    compute_budget: ComputeBudget,
    current_compute_budget: ComputeBudget,
    compute_meter: RefCell<u64>,
    accounts_data_meter: AccountsDataMeter,
    pub tx_executor_cache: Rc<RefCell<TransactionExecutorCache>>,
    pub feature_set: Arc<FeatureSet>,
    pub timings: ExecuteDetailsTimings,
    pub blockhash: Hash,
    pub lamports_per_signature: u64,
    pub syscall_context: Vec<Option<SyscallContext>>,
}

Fields

transaction_context: &'a mut TransactionContext

rent: Rent

pre_accounts: Vec<PreAccount>

builtin_programs: &'a [BuiltinProgram]

sysvar_cache: &'a SysvarCache

log_collector: Option<Rc<RefCell<LogCollector>>>

compute_budget: ComputeBudget

current_compute_budget: ComputeBudget

compute_meter: RefCell<u64>

accounts_data_meter: AccountsDataMeter

tx_executor_cache: Rc<RefCell<TransactionExecutorCache>>

feature_set: Arc<FeatureSet>

timings: ExecuteDetailsTimings

blockhash: Hash

lamports_per_signature: u64

syscall_context: Vec<Option<SyscallContext>>

Implementations

impl<'a> InvokeContext<'a>

pub fn new( transaction_context: &'a mut TransactionContext, rent: Rent, builtin_programs: &'a [BuiltinProgram], sysvar_cache: &'a SysvarCache, log_collector: Option<Rc<RefCell<LogCollector>>>, compute_budget: ComputeBudget, tx_executor_cache: Rc<RefCell<TransactionExecutorCache>>, feature_set: Arc<FeatureSet>, blockhash: Hash, lamports_per_signature: u64, prev_accounts_data_len: u64 ) -> Self

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

fn verify( &mut self, instruction_accounts: &[InstructionAccount], program_indices: &[IndexOfAccount] ) -> Result<(), InstructionError>

Verify the results of an instruction

Note: instruction_accounts must be the same as passed to InvokeContext::push(), so that they match the order of pre_accounts.

fn verify_and_update( &mut self, instruction_accounts: &[InstructionAccount], before_instruction_context_push: bool ) -> Result<(), InstructionError>

Verify and update PreAccount state based on program execution

Note: instruction_accounts must be the same as passed to InvokeContext::push(), so that they match the order of pre_accounts.

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

fn process_executable_chain( &mut self, compute_units_consumed: &mut u64, timings: &mut ExecuteTimings ) -> Result<(), InstructionError>

Calls the instruction’s program entrypoint method

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_accounts_data_meter(&self) -> &AccountsDataMeter

Get this invocation’s AccountsDataMeter

pub fn get_compute_budget(&self) -> &ComputeBudget

Get this invocation’s compute budget

pub fn get_sysvar_cache(&self) -> &SysvarCache

Get cached sysvars

pub fn get_check_aligned(&self) -> bool

pub fn get_check_size(&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>

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