Struct InvokeContext

pub struct InvokeContext<'a> {
    pub transaction_context: &'a mut TransactionContext,
    pub sysvar_cache: Cow<'a, SysvarCache>,
    pub trace_log: Vec<[u64; 12]>,
    pub tx_executor_cache: Rc<RefCell<TransactionExecutorCache>>,
    pub feature_set: Arc<FeatureSet>,
    pub timings: ExecuteDetailsTimings,
    pub blockhash: Hash,
    pub scoobies_per_signature: u64,
    /* private fields */
}

Fields

transaction_context: &'a mut TransactionContext

sysvar_cache: Cow<'a, SysvarCache>

trace_log: Vec<[u64; 12]>

tx_executor_cache: Rc<RefCell<TransactionExecutorCache>>

feature_set: Arc<FeatureSet>

timings: ExecuteDetailsTimings

blockhash: Hash

scoobies_per_signature: u64

Implementations

impl<'a> InvokeContext<'a>

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

pub fn new_mock( transaction_context: &'a mut TransactionContext, builtin_programs: &'a [BuiltinProgram], ) -> 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 cbe_sdk::instruction::TRANSACTION_LEVEL_STACK_HEIGHT

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

Entrypoint for a cross-program invocation from a builtin program

pub fn prepare_instruction( &mut self, instruction: &Instruction, 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 get_log_collector(&self) -> Option<Rc<RefCell<LogCollector>>>

Get this invocation’s LogCollector

pub fn consume_checked(&self, amount: u64) -> Result<(), InstructionError>

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 set_syscall_context( &mut self, check_aligned: bool, check_size: bool, orig_account_lengths: Vec<usize>, allocator: Rc<RefCell<dyn Alloc>>, ) -> Result<(), InstructionError>

pub fn get_check_aligned(&self) -> bool

pub fn get_check_size(&self) -> bool

pub fn get_orig_account_lengths(&self) -> Result<&[usize], InstructionError>

Get the original account lengths

pub fn get_allocator(&self) -> Result<Rc<RefCell<dyn Alloc>>, 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