solana_svm_transaction/
svm_message.rs

1use {
2    crate::{
3        instruction::SVMInstruction, message_address_table_lookup::SVMMessageAddressTableLookup,
4    },
5    core::fmt::Debug,
6    solana_hash::Hash,
7    solana_message::AccountKeys,
8    solana_pubkey::Pubkey,
9    solana_sdk_ids::{ed25519_program, secp256k1_program, secp256r1_program, system_program},
10};
11
12mod sanitized_message;
13mod sanitized_transaction;
14// inlined to avoid solana-nonce dep
15#[cfg(test)]
16static_assertions::const_assert_eq!(
17    NONCED_TX_MARKER_IX_INDEX,
18    solana_nonce::NONCED_TX_MARKER_IX_INDEX
19);
20const NONCED_TX_MARKER_IX_INDEX: u8 = 0;
21
22// - Debug to support legacy logging
23pub trait SVMMessage: Debug {
24    /// Return the number of transaction-level signatures in the message.
25    fn num_transaction_signatures(&self) -> u64;
26    /// Return the number of ed25519 precompile signatures in the message.
27    fn num_ed25519_signatures(&self) -> u64 {
28        default_precompile_signature_count(&ed25519_program::ID, self.program_instructions_iter())
29    }
30    /// Return the number of secp256k1 precompile signatures in the message.
31    fn num_secp256k1_signatures(&self) -> u64 {
32        default_precompile_signature_count(&secp256k1_program::ID, self.program_instructions_iter())
33    }
34    /// Return the number of secp256r1 precompile signatures in the message.
35    fn num_secp256r1_signatures(&self) -> u64 {
36        default_precompile_signature_count(&secp256r1_program::ID, self.program_instructions_iter())
37    }
38
39    /// Returns the number of requested write-locks in this message.
40    /// This does not consider if write-locks are demoted.
41    fn num_write_locks(&self) -> u64;
42
43    /// Return the recent blockhash.
44    fn recent_blockhash(&self) -> &Hash;
45
46    /// Return the number of instructions in the message.
47    fn num_instructions(&self) -> usize;
48
49    /// Return an iterator over the instructions in the message.
50    fn instructions_iter(&self) -> impl Iterator<Item = SVMInstruction>;
51
52    /// Return an iterator over the instructions in the message, paired with
53    /// the pubkey of the program.
54    fn program_instructions_iter(&self) -> impl Iterator<Item = (&Pubkey, SVMInstruction)> + Clone;
55
56    /// Return the account keys.
57    fn account_keys(&self) -> AccountKeys;
58
59    /// Return the fee-payer
60    fn fee_payer(&self) -> &Pubkey;
61
62    /// Returns `true` if the account at `index` is writable.
63    fn is_writable(&self, index: usize) -> bool;
64
65    /// Returns `true` if the account at `index` is signer.
66    fn is_signer(&self, index: usize) -> bool;
67
68    /// Returns true if the account at the specified index is invoked as a
69    /// program in top-level instructions of this message.
70    fn is_invoked(&self, key_index: usize) -> bool;
71
72    /// Returns true if the account at the specified index is an input to some
73    /// program instruction in this message.
74    fn is_instruction_account(&self, key_index: usize) -> bool {
75        if let Ok(key_index) = u8::try_from(key_index) {
76            self.instructions_iter()
77                .any(|ix| ix.accounts.contains(&key_index))
78        } else {
79            false
80        }
81    }
82
83    /// If the message uses a durable nonce, return the pubkey of the nonce account
84    fn get_durable_nonce(&self) -> Option<&Pubkey> {
85        let account_keys = self.account_keys();
86        self.instructions_iter()
87            .nth(usize::from(NONCED_TX_MARKER_IX_INDEX))
88            .filter(
89                |ix| match account_keys.get(usize::from(ix.program_id_index)) {
90                    Some(program_id) => system_program::check_id(program_id),
91                    _ => false,
92                },
93            )
94            .filter(|ix| {
95                /// Serialized value of [`SystemInstruction::AdvanceNonceAccount`].
96                const SERIALIZED_ADVANCE_NONCE_ACCOUNT: [u8; 4] = 4u32.to_le_bytes();
97                const SERIALIZED_SIZE: usize = SERIALIZED_ADVANCE_NONCE_ACCOUNT.len();
98
99                ix.data
100                    .get(..SERIALIZED_SIZE)
101                    .map(|data| data == SERIALIZED_ADVANCE_NONCE_ACCOUNT)
102                    .unwrap_or(false)
103            })
104            .and_then(|ix| {
105                ix.accounts.first().and_then(|idx| {
106                    let index = usize::from(*idx);
107                    if !self.is_writable(index) {
108                        None
109                    } else {
110                        account_keys.get(index)
111                    }
112                })
113            })
114    }
115
116    /// For the instruction at `index`, return an iterator over input accounts
117    /// that are signers.
118    fn get_ix_signers(&self, index: usize) -> impl Iterator<Item = &Pubkey> {
119        self.instructions_iter()
120            .nth(index)
121            .into_iter()
122            .flat_map(|ix| {
123                ix.accounts
124                    .iter()
125                    .copied()
126                    .map(usize::from)
127                    .filter(|index| self.is_signer(*index))
128                    .filter_map(|signer_index| self.account_keys().get(signer_index))
129            })
130    }
131
132    /// Get the number of lookup tables.
133    fn num_lookup_tables(&self) -> usize;
134
135    /// Get message address table lookups used in the message
136    fn message_address_table_lookups(&self) -> impl Iterator<Item = SVMMessageAddressTableLookup>;
137}
138
139fn default_precompile_signature_count<'a>(
140    precompile: &Pubkey,
141    instructions: impl Iterator<Item = (&'a Pubkey, SVMInstruction<'a>)>,
142) -> u64 {
143    instructions
144        .filter(|(program_id, _)| *program_id == precompile)
145        .map(|(_, ix)| u64::from(ix.data.first().copied().unwrap_or(0)))
146        .sum()
147}
solana_svm_transaction/svm_message.rs

solana_svm_transaction/
svm_message.rs
