Struct solana_sdk::transaction_context::InstructionContext

pub struct InstructionContext { /* private fields */ }

Loaded instruction shared between runtime and programs.

This context is valid for the entire duration of a (possibly cross program) instruction being processed.

Implementations

impl InstructionContext

pub fn new(
    nesting_level: usize,
    program_accounts: &[usize],
    instruction_accounts: &[InstructionAccount],
    instruction_data: &[u8]
) -> Self

New

pub fn get_stack_height(&self) -> usize

How many Instructions were on the stack after this one was pushed

That is the number of nested parent Instructions plus one (itself).

pub fn get_number_of_program_accounts(&self) -> usize

Number of program accounts

pub fn get_program_id_index(&self) -> usize

Get the index of the instruction’s program id

pub fn get_program_id(&self, transaction_context: &TransactionContext) -> Pubkey

Get the instruction’s program id

pub fn get_number_of_instruction_accounts(&self) -> usize

Number of accounts in this Instruction (without program accounts)

pub fn check_number_of_instruction_accounts(
    &self,
    expected_at_least: usize
) -> Result<(), InstructionError>

Assert that enough account were supplied to this Instruction

pub fn get_number_of_accounts(&self) -> usize

Number of accounts in this Instruction

pub fn get_instruction_data(&self) -> &[u8]

Data parameter for the programs process_instruction handler

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

Searches for a program account by its key

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

Searches for an account by its key

pub fn get_index_in_transaction(
    &self,
    index_in_instruction: usize
) -> Result<usize, InstructionError>

Translates the given instruction wide index into a transaction wide index

pub fn get_program_key<'a, 'b: 'a>(
    &'a self,
    transaction_context: &'b TransactionContext
) -> Result<&'b Pubkey, InstructionError>

Gets the key of the last program account of this Instruction

pub fn get_instruction_account_key<'a, 'b: 'a>(
    &'a self,
    transaction_context: &'b TransactionContext,
    instruction_account_index: usize
) -> Result<&'b Pubkey, InstructionError>

Gets the key of an instruction account (skipping program accounts)

pub fn try_borrow_account<'a, 'b: 'a>(
    &'a self,
    transaction_context: &'b TransactionContext,
    index_in_instruction: usize
) -> Result<BorrowedAccount<'a>, InstructionError>

Tries to borrow an account from this Instruction

pub fn try_borrow_program_account<'a, 'b: 'a>(
    &'a self,
    transaction_context: &'b TransactionContext
) -> Result<BorrowedAccount<'a>, InstructionError>

Gets the last program account of this Instruction

pub fn try_borrow_instruction_account<'a, 'b: 'a>(
    &'a self,
    transaction_context: &'b TransactionContext,
    instruction_account_index: usize
) -> Result<BorrowedAccount<'a>, InstructionError>

Gets an instruction account of this Instruction

pub fn is_signer(
    &self,
    index_in_instruction: usize
) -> Result<bool, InstructionError>

Returns whether an account is a signer

pub fn is_writable(
    &self,
    index_in_instruction: usize
) -> Result<bool, InstructionError>

Returns whether an account is writable

pub fn get_signers(
    &self,
    transaction_context: &TransactionContext
) -> HashSet<Pubkey>

Calculates the set of all keys of signer accounts in this Instruction

Trait Implementations

impl Clone for InstructionContext

fn clone(&self) -> InstructionContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstructionContext

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

Formats the value using the given formatter.