Enum solana_program::message::SanitizedMessage

pub enum SanitizedMessage {
    Legacy(LegacyMessage),
    V0(LoadedMessage),
}

Sanitized message of a transaction which includes a set of atomic instructions to be executed on-chain

Variants

Legacy(LegacyMessage)

Sanitized legacy message

V0(LoadedMessage)

Sanitized version #0 message with mapped addresses

Implementations

impl SanitizedMessage

pub fn has_duplicates(&self) -> bool

Return true if this message contains duplicate account keys

pub fn header(&self) -> &MessageHeader

Message header which identifies the number of signer and writable or readonly accounts

pub fn legacy_message(&self) -> Option<&LegacyMessage>

Returns a legacy message if this sanitized message wraps one

pub fn fee_payer(&self) -> &Pubkey

Returns the fee payer for the transaction

pub fn recent_blockhash(&self) -> &Hash

The hash of a recent block, used for timing out a transaction

pub fn instructions(&self) -> &[CompiledInstruction]

Program instructions that will be executed in sequence and committed in one atomic transaction if all succeed.

pub fn program_instructions_iter(
    &self
) -> impl Iterator<Item = (&Pubkey, &CompiledInstruction)>

Program instructions iterator which includes each instruction’s program id.

pub fn account_keys_iter(&self) -> Box<dyn Iterator<Item = &Pubkey>>

Iterator of all account keys referenced in this message, included mapped keys.

pub fn account_keys_len(&self) -> usize

Length of all account keys referenced in this message, included mapped keys.

pub fn get_account_key(&self, index: usize) -> Option<&Pubkey>

Returns the address of the account at the specified index.

pub fn is_invoked(&self, key_index: usize) -> bool

Returns true if the account at the specified index is invoked as a program in this message.

pub fn is_non_loader_key(&self, key_index: usize) -> bool

Returns true if the account at the specified index is not invoked as a program or, if invoked, is passed to a program.

pub fn is_writable(&self, index: usize) -> bool

Returns true if the account at the specified index is writable by the instructions in this message.

pub fn is_signer(&self, index: usize) -> bool

Returns true if the account at the specified index signed this message.

pub fn num_readonly_accounts(&self) -> usize

Return the number of readonly accounts loaded by this message.

pub fn try_compile_instruction(
    &self,
    ix: &Instruction
) -> Option<CompiledInstruction>

Try to compile an instruction using the account keys in this message.

pub fn decompile_instructions(&self) -> Vec<BorrowedInstruction<'_>>

Decompile message instructions without cloning account keys

pub fn is_upgradeable_loader_present(&self) -> bool

Inspect all message keys for the bpf upgradeable loader

pub fn get_durable_nonce(&self, nonce_must_be_writable: bool) -> Option<&Pubkey>

If the message uses a durable nonce, return the pubkey of the nonce account

Trait Implementations

impl Clone for SanitizedMessage

fn clone(&self) -> SanitizedMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SanitizedMessage

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

Formats the value using the given formatter.

impl TryFrom<Message> for SanitizedMessage

type Error = SanitizeMessageError

The type returned in the event of a conversion error.

fn try_from(message: LegacyMessage) -> Result<Self, Self::Error>

Performs the conversion.