Struct solana_sdk::transaction_context::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>,
    instruction_context_capacity: usize,
    number_of_instructions_at_transaction_level: usize
) -> Self

Constructs a new TransactionContext

pub fn deconstruct(
    self
) -> (Vec<TransactionAccount>, Vec<Vec<InstructionContext>>)

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

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

Used in mock_process_instruction

pub fn get_number_of_accounts(&self) -> usize

Returns the total number of accounts loaded in this Transaction

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

Searches for an account by its key

pub fn get_keys_of_accounts(&self) -> &[Pubkey]

Returns the keys for the accounts loaded in this Transaction

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

Searches for an account by its key

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

Searches for an account by its key

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

Searches for a program account by its key

pub fn get_instruction_context_at(
    &self,
    level: usize
) -> Result<&InstructionContext, InstructionError>

Gets an InstructionContext by its nesting level in the stack

pub fn get_instruction_context_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 push(
    &mut self,
    program_accounts: &[usize],
    instruction_accounts: &[InstructionAccount],
    instruction_data: &[u8],
    record_instruction_in_transaction_context_push: bool
) -> Result<(), InstructionError>

Pushes a new 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 record_instruction(&mut self, instruction: InstructionContext)

Used by the runtime when a new CPI instruction begins

Deprecated, automatically done in push() once record_instruction_in_transaction_context_push is activated.

pub fn get_instruction_trace(&self) -> &InstructionTrace

Returns instruction trace

Trait Implementations

impl Debug for TransactionContext

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

Formats the value using the given formatter.