pub struct TransactionContext { /* private fields */ }
Expand description
Loaded transaction shared between runtime and programs.
This context is valid for the entire duration of a transaction being processed.
Implementations§
Source§impl TransactionContext
impl TransactionContext
Sourcepub fn new(
transaction_accounts: Vec<(Pubkey, AccountSharedData)>,
rent: Rent,
instruction_stack_capacity: usize,
instruction_trace_capacity: usize,
) -> TransactionContext
Available on non-target_os="solana"
only.
pub fn new( transaction_accounts: Vec<(Pubkey, AccountSharedData)>, rent: Rent, instruction_stack_capacity: usize, instruction_trace_capacity: usize, ) -> TransactionContext
target_os="solana"
only.Constructs a new TransactionContext
pub fn set_remove_accounts_executable_flag_checks(&mut self, enabled: bool)
target_os="solana"
only.Sourcepub fn deconstruct_without_keys(
self,
) -> Result<Vec<AccountSharedData>, InstructionError>
Available on non-target_os="solana"
only.
pub fn deconstruct_without_keys( self, ) -> Result<Vec<AccountSharedData>, InstructionError>
target_os="solana"
only.Used in mock_process_instruction
pub fn accounts(&self) -> &Rc<TransactionAccounts>
target_os="solana"
only.Sourcepub fn set_signature(&mut self, signature: &Signature)
Available on non-target_os="solana"
and crate feature debug-signature
and debug-assertions enabled only.
pub fn set_signature(&mut self, signature: &Signature)
target_os="solana"
and crate feature debug-signature
and debug-assertions enabled only.Stores the signature of the current transaction
Sourcepub fn get_signature(&self) -> &Signature
Available on non-target_os="solana"
and crate feature debug-signature
and debug-assertions enabled only.
pub fn get_signature(&self) -> &Signature
target_os="solana"
and crate feature debug-signature
and debug-assertions enabled only.Returns the signature of the current transaction
Sourcepub fn get_number_of_accounts(&self) -> u16
pub fn get_number_of_accounts(&self) -> u16
Returns the total number of accounts loaded in this Transaction
Sourcepub fn get_key_of_account_at_index(
&self,
index_in_transaction: u16,
) -> Result<&Pubkey, InstructionError>
pub fn get_key_of_account_at_index( &self, index_in_transaction: u16, ) -> Result<&Pubkey, InstructionError>
Searches for an account by its key
Sourcepub fn get_account_at_index(
&self,
index_in_transaction: u16,
) -> Result<&RefCell<AccountSharedData>, InstructionError>
Available on non-target_os="solana"
only.
pub fn get_account_at_index( &self, index_in_transaction: u16, ) -> Result<&RefCell<AccountSharedData>, InstructionError>
target_os="solana"
only.Searches for an account by its key
Sourcepub fn find_index_of_account(&self, pubkey: &Pubkey) -> Option<u16>
pub fn find_index_of_account(&self, pubkey: &Pubkey) -> Option<u16>
Searches for an account by its key
Sourcepub fn find_index_of_program_account(&self, pubkey: &Pubkey) -> Option<u16>
pub fn find_index_of_program_account(&self, pubkey: &Pubkey) -> Option<u16>
Searches for a program account by its key
Sourcepub fn get_instruction_trace_capacity(&self) -> usize
pub fn get_instruction_trace_capacity(&self) -> usize
Gets the max length of the InstructionContext trace
Sourcepub fn get_instruction_trace_length(&self) -> usize
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()
.
Sourcepub fn get_instruction_context_at_index_in_trace(
&self,
index_in_trace: usize,
) -> Result<&InstructionContext, InstructionError>
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
Sourcepub fn get_instruction_context_at_nesting_level(
&self,
nesting_level: usize,
) -> Result<&InstructionContext, InstructionError>
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
Sourcepub fn get_instruction_stack_capacity(&self) -> usize
pub fn get_instruction_stack_capacity(&self) -> usize
Gets the max height of the InstructionContext stack
Sourcepub fn get_instruction_context_stack_height(&self) -> usize
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
Sourcepub fn get_current_instruction_context(
&self,
) -> Result<&InstructionContext, InstructionError>
pub fn get_current_instruction_context( &self, ) -> Result<&InstructionContext, InstructionError>
Returns the current InstructionContext
Sourcepub fn get_next_instruction_context(
&mut self,
) -> Result<&mut InstructionContext, InstructionError>
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.
Sourcepub fn push(&mut self) -> Result<(), InstructionError>
Available on non-target_os="solana"
only.
pub fn push(&mut self) -> Result<(), InstructionError>
target_os="solana"
only.Pushes the next InstructionContext
Sourcepub fn pop(&mut self) -> Result<(), InstructionError>
Available on non-target_os="solana"
only.
pub fn pop(&mut self) -> Result<(), InstructionError>
target_os="solana"
only.Pops the current InstructionContext
Sourcepub fn get_return_data(&self) -> (&Pubkey, &[u8])
pub fn get_return_data(&self) -> (&Pubkey, &[u8])
Gets the return data of the current InstructionContext or any above
Sourcepub fn set_return_data(
&mut self,
program_id: Pubkey,
data: Vec<u8>,
) -> Result<(), InstructionError>
pub fn set_return_data( &mut self, program_id: Pubkey, data: Vec<u8>, ) -> Result<(), InstructionError>
Set the return data of the current InstructionContext
Sourcepub fn accounts_resize_delta(&self) -> Result<i64, InstructionError>
pub fn accounts_resize_delta(&self) -> Result<i64, InstructionError>
Returns the accounts resize delta
Trait Implementations§
Source§impl Clone for TransactionContext
impl Clone for TransactionContext
Source§fn clone(&self) -> TransactionContext
fn clone(&self) -> TransactionContext
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TransactionContext
impl Debug for TransactionContext
Source§impl From<TransactionContext> for ExecutionRecord
Available on non-target_os="solana"
only.Used by the bank in the runtime to write back the processed accounts and recorded instructions
impl From<TransactionContext> for ExecutionRecord
target_os="solana"
only.Used by the bank in the runtime to write back the processed accounts and recorded instructions
Source§fn from(context: TransactionContext) -> ExecutionRecord
fn from(context: TransactionContext) -> ExecutionRecord
Source§impl PartialEq for TransactionContext
impl PartialEq for TransactionContext
impl StructuralPartialEq for TransactionContext
Auto Trait Implementations§
impl !Freeze for TransactionContext
impl !RefUnwindSafe for TransactionContext
impl !Send for TransactionContext
impl !Sync for TransactionContext
impl Unpin for TransactionContext
impl !UnwindSafe for TransactionContext
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more