Struct TransactionContext

pub struct TransactionContext { /* private fields */ }

Loaded transaction shared between runtime and programs.

This context is valid for the entire duration of a transaction being processed.

Implementations

impl TransactionContext

pub fn new( transaction_accounts: Vec<TransactionAccount>, rent: Rent, instruction_stack_capacity: usize, instruction_trace_capacity: usize, ) -> Self

Constructs a new TransactionContext

pub fn deconstruct_without_keys( self, ) -> Result<Vec<AccountSharedData>, InstructionError>

Used in mock_process_instruction

pub fn accounts(&self) -> &Rc<TransactionAccounts>

pub fn set_signature(&mut self, signature: &Signature)

Stores the signature of the current transaction

pub fn get_signature(&self) -> &Signature

Returns the signature of the current transaction

pub fn get_number_of_accounts(&self) -> IndexOfAccount

Returns the total number of accounts loaded in this Transaction

pub fn get_key_of_account_at_index( &self, index_in_transaction: IndexOfAccount, ) -> Result<&Pubkey, InstructionError>

Searches for an account by its key

pub fn get_account_at_index( &self, index_in_transaction: IndexOfAccount, ) -> Result<&RefCell<AccountSharedData>, InstructionError>

Searches for an account by its key

pub fn find_index_of_account(&self, pubkey: &Pubkey) -> Option<IndexOfAccount>

Searches for an account by its key

pub fn find_index_of_program_account( &self, pubkey: &Pubkey, ) -> Option<IndexOfAccount>

Searches for a program account by its key

pub fn get_instruction_trace_capacity(&self) -> usize

Gets the max length of the InstructionContext trace

pub fn get_instruction_trace_length(&self) -> usize

Returns the instruction trace length.

Not counting the last empty InstructionContext which is always pre-reserved for the next instruction. See also get_next_instruction_context().

pub fn get_instruction_context_at_index_in_trace( &self, index_in_trace: usize, ) -> Result<&InstructionContext, InstructionError>

Gets an InstructionContext by its index in the trace

pub fn get_instruction_context_at_nesting_level( &self, nesting_level: usize, ) -> Result<&InstructionContext, InstructionError>

Gets an InstructionContext by its nesting level in the stack

pub fn get_instruction_stack_capacity(&self) -> usize

Gets the max height of the InstructionContext stack

pub fn get_instruction_context_stack_height(&self) -> usize

Gets instruction stack height, top-level instructions are height solana_sdk::instruction::TRANSACTION_LEVEL_STACK_HEIGHT

pub fn get_current_instruction_context( &self, ) -> Result<&InstructionContext, InstructionError>

Returns the current InstructionContext

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

Returns the InstructionContext to configure for the next invocation.

The last InstructionContext is always empty and pre-reserved for the next instruction.

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

Pushes the next InstructionContext

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

Pops the current InstructionContext

pub fn get_return_data(&self) -> (&Pubkey, &[u8])

Gets the return data of the current InstructionContext or any above

pub fn set_return_data( &mut self, program_id: Pubkey, data: Vec<u8>, ) -> Result<(), InstructionError>

Set the return data of the current InstructionContext

pub fn accounts_resize_delta(&self) -> Result<i64, InstructionError>

Returns the accounts resize delta

Trait Implementations

impl Clone for TransactionContext

fn clone(&self) -> TransactionContext

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TransactionContext

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

Formats the value using the given formatter.

impl From<TransactionContext> for ExecutionRecord

Used by the bank in the runtime to write back the processed accounts and recorded instructions

fn from(context: TransactionContext) -> Self

Converts to this type from the input type.

impl PartialEq for TransactionContext

fn eq(&self, other: &TransactionContext) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TransactionContext