Skip to main content

Transaction

Struct Transaction 

Source
pub struct Transaction {
    pub signatures: Vec<SignatureBytes>,
    pub message: Message,
}
Expand description

A Solana transaction

Fields§

§signatures: Vec<SignatureBytes>

The signatures

§message: Message

The message

Implementations§

Source§

impl Transaction

Source

pub fn new(message: Message) -> Self

Create a new transaction

Source

pub fn add_signature(&mut self, signature: SignatureBytes)

Add a signature to the transaction

Source

pub fn num_required_signatures(&self) -> u8

Get the number of required signatures

Source

pub fn num_readonly_signed_accounts(&self) -> u8

Get the number of read-only signed accounts

Source

pub fn num_readonly_unsigned_accounts(&self) -> u8

Get the number of read-only unsigned accounts

Source

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

Get the account keys

Source

pub fn recent_blockhash(&self) -> &[u8; 32]

Get the recent blockhash

Source

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

Get the instructions

Source

pub fn deserialize_with_version(bytes: &[u8]) -> Result<Self>

Deserialize a transaction from bytes

Source

pub fn serialize_legacy(&self) -> Result<Vec<u8>>

Serializes the full transaction into the Solana legacy wire format.

Source

pub fn sign(&mut self, private_keys: &[&[u8]]) -> Result<()>

Sign the transaction with one or more private keys The private keys must correspond to the signing accounts in the same order

Examples found in repository?
examples/basic.rs (line 61)
6fn main() -> Result<(), Box<dyn std::error::Error>> {
7    println!("🚀 Solana Primitives - Transaction Signing Example");
8    println!("═══════════════════════════════════════════════════");
9
10    // Generate a test private key from base58 string
11    // ⚠️  WARNING: This is for demonstration only!
12    // In production, use proper key generation and secure storage
13    let private_key_base58 = "3KSeAx7jkVrjJ2PXjhzVMnJfV3zsyT4ADWtpnHxks5eD";
14    let private_key = bs58::decode(private_key_base58).into_vec()?;
15
16    // Generate corresponding public key
17    let fee_payer_pubkey_bytes = get_public_key(&private_key)?;
18    let fee_payer = Pubkey::new(fee_payer_pubkey_bytes);
19
20    let recipient = Pubkey::from_base58("4fYNw3dojWmQ4dXtSGE9epjRGy9uFrCRgbvGgQBNZCQF")?;
21
22    // Use a dummy blockhash for this example (in production, get from RPC)
23    let recent_blockhash = [1u8; 32]; // Use non-zero for visual distinction
24
25    println!("\n📝 Building Transaction:");
26    println!("   - Fee payer: {}", fee_payer.to_base58());
27    println!("   - Recipient: {}", recipient.to_base58());
28
29    // Create a simple SOL transfer instruction
30    let transfer_instruction = transfer(&fee_payer, &recipient, 1_000_000); // 0.001 SOL
31
32    // Build transaction
33    let mut tx_builder = TransactionBuilder::new(fee_payer, recent_blockhash);
34    tx_builder.add_instruction(transfer_instruction);
35
36    let mut transaction = tx_builder.build()?;
37
38    println!("✅ Unsigned transaction created:");
39    println!(
40        "   - Instructions: {}",
41        transaction.message.instructions.len()
42    );
43    println!(
44        "   - Account keys: {}",
45        transaction.message.account_keys.len()
46    );
47    println!(
48        "   - Required signatures: {}",
49        transaction.message.header.num_required_signatures
50    );
51    println!("   - Is signed: {}", transaction.is_signed());
52
53    // Validate transaction size
54    transaction.validate_size()?;
55    println!("✅ Transaction size validation passed");
56
57    println!("\n🔐 Signing Transaction:");
58
59    // Method 1: Sign the entire transaction at once
60    let private_keys = [private_key.as_ref()]; // References to private keys
61    transaction.sign(&private_keys)?;
62
63    println!("✅ Transaction signed successfully!");
64    println!("   - Is signed: {}", transaction.is_signed());
65    println!("   - Signature count: {}", transaction.signatures.len());
66
67    // Display the signature (first 16 bytes for brevity)
68    if let Some(first_signature) = transaction.signatures.first() {
69        let sig_bytes = first_signature.as_bytes();
70        println!("   - First signature: {}...", hex::encode(&sig_bytes[..16]));
71    }
72
73    println!("\n📦 Final Transaction:");
74    // Serialize the complete signed transaction
75    let transaction_bytes = borsh::to_vec(&transaction)?;
76    println!("   - Serialized size: {} bytes", transaction_bytes.len());
77    println!(
78        "   - Base64 encoded: {}",
79        base64::prelude::BASE64_STANDARD.encode(&transaction_bytes)
80    );
81
82    // Demonstrate partial signing (useful for multi-sig scenarios)
83    println!("\n🔄 Demonstrating Partial Signing:");
84
85    // Create a new transaction builder for partial signing demo
86    let mut partial_tx_builder = TransactionBuilder::new(fee_payer, recent_blockhash);
87    partial_tx_builder.add_instruction(transfer(&fee_payer, &recipient, 1_000_000));
88    let mut partial_tx = partial_tx_builder.build()?;
89    println!(
90        "   - Before partial sign - Is signed: {}",
91        partial_tx.is_signed()
92    );
93
94    // Partial sign with specific keys and their corresponding public keys
95    let private_keys_for_partial = [private_key.as_ref()];
96    let public_keys_for_partial = [fee_payer];
97    partial_tx.partial_sign(&private_keys_for_partial, &public_keys_for_partial)?;
98
99    println!("✅ Partial signing completed!");
100    println!(
101        "   - After partial sign - Is signed: {}",
102        partial_tx.is_signed()
103    );
104
105    println!("\n🎯 Summary:");
106    println!("   ✓ Transaction built using InstructionBuilder");
107    println!("   ✓ Transaction validated for size limits");
108    println!("   ✓ Transaction signed with private key");
109    println!("   ✓ Partial signing demonstrated");
110    println!("   ✓ Transaction serialized for network submission");
111
112    println!("\n📡 Next Steps:");
113    println!("   - Submit transaction_bytes to Solana RPC endpoint");
114    println!("   - Monitor transaction status on-chain");
115    println!("   - Handle success/failure responses");
116
117    Ok(())
118}
Source

pub fn partial_sign( &mut self, private_keys: &[&[u8]], public_keys: &[Pubkey], ) -> Result<()>

Partially sign the transaction with specific private keys Updates only the signatures for the provided keys based on their public key positions

Examples found in repository?
examples/basic.rs (line 97)
6fn main() -> Result<(), Box<dyn std::error::Error>> {
7    println!("🚀 Solana Primitives - Transaction Signing Example");
8    println!("═══════════════════════════════════════════════════");
9
10    // Generate a test private key from base58 string
11    // ⚠️  WARNING: This is for demonstration only!
12    // In production, use proper key generation and secure storage
13    let private_key_base58 = "3KSeAx7jkVrjJ2PXjhzVMnJfV3zsyT4ADWtpnHxks5eD";
14    let private_key = bs58::decode(private_key_base58).into_vec()?;
15
16    // Generate corresponding public key
17    let fee_payer_pubkey_bytes = get_public_key(&private_key)?;
18    let fee_payer = Pubkey::new(fee_payer_pubkey_bytes);
19
20    let recipient = Pubkey::from_base58("4fYNw3dojWmQ4dXtSGE9epjRGy9uFrCRgbvGgQBNZCQF")?;
21
22    // Use a dummy blockhash for this example (in production, get from RPC)
23    let recent_blockhash = [1u8; 32]; // Use non-zero for visual distinction
24
25    println!("\n📝 Building Transaction:");
26    println!("   - Fee payer: {}", fee_payer.to_base58());
27    println!("   - Recipient: {}", recipient.to_base58());
28
29    // Create a simple SOL transfer instruction
30    let transfer_instruction = transfer(&fee_payer, &recipient, 1_000_000); // 0.001 SOL
31
32    // Build transaction
33    let mut tx_builder = TransactionBuilder::new(fee_payer, recent_blockhash);
34    tx_builder.add_instruction(transfer_instruction);
35
36    let mut transaction = tx_builder.build()?;
37
38    println!("✅ Unsigned transaction created:");
39    println!(
40        "   - Instructions: {}",
41        transaction.message.instructions.len()
42    );
43    println!(
44        "   - Account keys: {}",
45        transaction.message.account_keys.len()
46    );
47    println!(
48        "   - Required signatures: {}",
49        transaction.message.header.num_required_signatures
50    );
51    println!("   - Is signed: {}", transaction.is_signed());
52
53    // Validate transaction size
54    transaction.validate_size()?;
55    println!("✅ Transaction size validation passed");
56
57    println!("\n🔐 Signing Transaction:");
58
59    // Method 1: Sign the entire transaction at once
60    let private_keys = [private_key.as_ref()]; // References to private keys
61    transaction.sign(&private_keys)?;
62
63    println!("✅ Transaction signed successfully!");
64    println!("   - Is signed: {}", transaction.is_signed());
65    println!("   - Signature count: {}", transaction.signatures.len());
66
67    // Display the signature (first 16 bytes for brevity)
68    if let Some(first_signature) = transaction.signatures.first() {
69        let sig_bytes = first_signature.as_bytes();
70        println!("   - First signature: {}...", hex::encode(&sig_bytes[..16]));
71    }
72
73    println!("\n📦 Final Transaction:");
74    // Serialize the complete signed transaction
75    let transaction_bytes = borsh::to_vec(&transaction)?;
76    println!("   - Serialized size: {} bytes", transaction_bytes.len());
77    println!(
78        "   - Base64 encoded: {}",
79        base64::prelude::BASE64_STANDARD.encode(&transaction_bytes)
80    );
81
82    // Demonstrate partial signing (useful for multi-sig scenarios)
83    println!("\n🔄 Demonstrating Partial Signing:");
84
85    // Create a new transaction builder for partial signing demo
86    let mut partial_tx_builder = TransactionBuilder::new(fee_payer, recent_blockhash);
87    partial_tx_builder.add_instruction(transfer(&fee_payer, &recipient, 1_000_000));
88    let mut partial_tx = partial_tx_builder.build()?;
89    println!(
90        "   - Before partial sign - Is signed: {}",
91        partial_tx.is_signed()
92    );
93
94    // Partial sign with specific keys and their corresponding public keys
95    let private_keys_for_partial = [private_key.as_ref()];
96    let public_keys_for_partial = [fee_payer];
97    partial_tx.partial_sign(&private_keys_for_partial, &public_keys_for_partial)?;
98
99    println!("✅ Partial signing completed!");
100    println!(
101        "   - After partial sign - Is signed: {}",
102        partial_tx.is_signed()
103    );
104
105    println!("\n🎯 Summary:");
106    println!("   ✓ Transaction built using InstructionBuilder");
107    println!("   ✓ Transaction validated for size limits");
108    println!("   ✓ Transaction signed with private key");
109    println!("   ✓ Partial signing demonstrated");
110    println!("   ✓ Transaction serialized for network submission");
111
112    println!("\n📡 Next Steps:");
113    println!("   - Submit transaction_bytes to Solana RPC endpoint");
114    println!("   - Monitor transaction status on-chain");
115    println!("   - Handle success/failure responses");
116
117    Ok(())
118}
Source

pub fn is_signed(&self) -> bool

Check if the transaction has been signed by all required signers

Examples found in repository?
examples/basic.rs (line 51)
6fn main() -> Result<(), Box<dyn std::error::Error>> {
7    println!("🚀 Solana Primitives - Transaction Signing Example");
8    println!("═══════════════════════════════════════════════════");
9
10    // Generate a test private key from base58 string
11    // ⚠️  WARNING: This is for demonstration only!
12    // In production, use proper key generation and secure storage
13    let private_key_base58 = "3KSeAx7jkVrjJ2PXjhzVMnJfV3zsyT4ADWtpnHxks5eD";
14    let private_key = bs58::decode(private_key_base58).into_vec()?;
15
16    // Generate corresponding public key
17    let fee_payer_pubkey_bytes = get_public_key(&private_key)?;
18    let fee_payer = Pubkey::new(fee_payer_pubkey_bytes);
19
20    let recipient = Pubkey::from_base58("4fYNw3dojWmQ4dXtSGE9epjRGy9uFrCRgbvGgQBNZCQF")?;
21
22    // Use a dummy blockhash for this example (in production, get from RPC)
23    let recent_blockhash = [1u8; 32]; // Use non-zero for visual distinction
24
25    println!("\n📝 Building Transaction:");
26    println!("   - Fee payer: {}", fee_payer.to_base58());
27    println!("   - Recipient: {}", recipient.to_base58());
28
29    // Create a simple SOL transfer instruction
30    let transfer_instruction = transfer(&fee_payer, &recipient, 1_000_000); // 0.001 SOL
31
32    // Build transaction
33    let mut tx_builder = TransactionBuilder::new(fee_payer, recent_blockhash);
34    tx_builder.add_instruction(transfer_instruction);
35
36    let mut transaction = tx_builder.build()?;
37
38    println!("✅ Unsigned transaction created:");
39    println!(
40        "   - Instructions: {}",
41        transaction.message.instructions.len()
42    );
43    println!(
44        "   - Account keys: {}",
45        transaction.message.account_keys.len()
46    );
47    println!(
48        "   - Required signatures: {}",
49        transaction.message.header.num_required_signatures
50    );
51    println!("   - Is signed: {}", transaction.is_signed());
52
53    // Validate transaction size
54    transaction.validate_size()?;
55    println!("✅ Transaction size validation passed");
56
57    println!("\n🔐 Signing Transaction:");
58
59    // Method 1: Sign the entire transaction at once
60    let private_keys = [private_key.as_ref()]; // References to private keys
61    transaction.sign(&private_keys)?;
62
63    println!("✅ Transaction signed successfully!");
64    println!("   - Is signed: {}", transaction.is_signed());
65    println!("   - Signature count: {}", transaction.signatures.len());
66
67    // Display the signature (first 16 bytes for brevity)
68    if let Some(first_signature) = transaction.signatures.first() {
69        let sig_bytes = first_signature.as_bytes();
70        println!("   - First signature: {}...", hex::encode(&sig_bytes[..16]));
71    }
72
73    println!("\n📦 Final Transaction:");
74    // Serialize the complete signed transaction
75    let transaction_bytes = borsh::to_vec(&transaction)?;
76    println!("   - Serialized size: {} bytes", transaction_bytes.len());
77    println!(
78        "   - Base64 encoded: {}",
79        base64::prelude::BASE64_STANDARD.encode(&transaction_bytes)
80    );
81
82    // Demonstrate partial signing (useful for multi-sig scenarios)
83    println!("\n🔄 Demonstrating Partial Signing:");
84
85    // Create a new transaction builder for partial signing demo
86    let mut partial_tx_builder = TransactionBuilder::new(fee_payer, recent_blockhash);
87    partial_tx_builder.add_instruction(transfer(&fee_payer, &recipient, 1_000_000));
88    let mut partial_tx = partial_tx_builder.build()?;
89    println!(
90        "   - Before partial sign - Is signed: {}",
91        partial_tx.is_signed()
92    );
93
94    // Partial sign with specific keys and their corresponding public keys
95    let private_keys_for_partial = [private_key.as_ref()];
96    let public_keys_for_partial = [fee_payer];
97    partial_tx.partial_sign(&private_keys_for_partial, &public_keys_for_partial)?;
98
99    println!("✅ Partial signing completed!");
100    println!(
101        "   - After partial sign - Is signed: {}",
102        partial_tx.is_signed()
103    );
104
105    println!("\n🎯 Summary:");
106    println!("   ✓ Transaction built using InstructionBuilder");
107    println!("   ✓ Transaction validated for size limits");
108    println!("   ✓ Transaction signed with private key");
109    println!("   ✓ Partial signing demonstrated");
110    println!("   ✓ Transaction serialized for network submission");
111
112    println!("\n📡 Next Steps:");
113    println!("   - Submit transaction_bytes to Solana RPC endpoint");
114    println!("   - Monitor transaction status on-chain");
115    println!("   - Handle success/failure responses");
116
117    Ok(())
118}
Source

pub fn validate_size(&self) -> Result<()>

Validate transaction size is within limits (1232 bytes)

Examples found in repository?
examples/basic.rs (line 54)
6fn main() -> Result<(), Box<dyn std::error::Error>> {
7    println!("🚀 Solana Primitives - Transaction Signing Example");
8    println!("═══════════════════════════════════════════════════");
9
10    // Generate a test private key from base58 string
11    // ⚠️  WARNING: This is for demonstration only!
12    // In production, use proper key generation and secure storage
13    let private_key_base58 = "3KSeAx7jkVrjJ2PXjhzVMnJfV3zsyT4ADWtpnHxks5eD";
14    let private_key = bs58::decode(private_key_base58).into_vec()?;
15
16    // Generate corresponding public key
17    let fee_payer_pubkey_bytes = get_public_key(&private_key)?;
18    let fee_payer = Pubkey::new(fee_payer_pubkey_bytes);
19
20    let recipient = Pubkey::from_base58("4fYNw3dojWmQ4dXtSGE9epjRGy9uFrCRgbvGgQBNZCQF")?;
21
22    // Use a dummy blockhash for this example (in production, get from RPC)
23    let recent_blockhash = [1u8; 32]; // Use non-zero for visual distinction
24
25    println!("\n📝 Building Transaction:");
26    println!("   - Fee payer: {}", fee_payer.to_base58());
27    println!("   - Recipient: {}", recipient.to_base58());
28
29    // Create a simple SOL transfer instruction
30    let transfer_instruction = transfer(&fee_payer, &recipient, 1_000_000); // 0.001 SOL
31
32    // Build transaction
33    let mut tx_builder = TransactionBuilder::new(fee_payer, recent_blockhash);
34    tx_builder.add_instruction(transfer_instruction);
35
36    let mut transaction = tx_builder.build()?;
37
38    println!("✅ Unsigned transaction created:");
39    println!(
40        "   - Instructions: {}",
41        transaction.message.instructions.len()
42    );
43    println!(
44        "   - Account keys: {}",
45        transaction.message.account_keys.len()
46    );
47    println!(
48        "   - Required signatures: {}",
49        transaction.message.header.num_required_signatures
50    );
51    println!("   - Is signed: {}", transaction.is_signed());
52
53    // Validate transaction size
54    transaction.validate_size()?;
55    println!("✅ Transaction size validation passed");
56
57    println!("\n🔐 Signing Transaction:");
58
59    // Method 1: Sign the entire transaction at once
60    let private_keys = [private_key.as_ref()]; // References to private keys
61    transaction.sign(&private_keys)?;
62
63    println!("✅ Transaction signed successfully!");
64    println!("   - Is signed: {}", transaction.is_signed());
65    println!("   - Signature count: {}", transaction.signatures.len());
66
67    // Display the signature (first 16 bytes for brevity)
68    if let Some(first_signature) = transaction.signatures.first() {
69        let sig_bytes = first_signature.as_bytes();
70        println!("   - First signature: {}...", hex::encode(&sig_bytes[..16]));
71    }
72
73    println!("\n📦 Final Transaction:");
74    // Serialize the complete signed transaction
75    let transaction_bytes = borsh::to_vec(&transaction)?;
76    println!("   - Serialized size: {} bytes", transaction_bytes.len());
77    println!(
78        "   - Base64 encoded: {}",
79        base64::prelude::BASE64_STANDARD.encode(&transaction_bytes)
80    );
81
82    // Demonstrate partial signing (useful for multi-sig scenarios)
83    println!("\n🔄 Demonstrating Partial Signing:");
84
85    // Create a new transaction builder for partial signing demo
86    let mut partial_tx_builder = TransactionBuilder::new(fee_payer, recent_blockhash);
87    partial_tx_builder.add_instruction(transfer(&fee_payer, &recipient, 1_000_000));
88    let mut partial_tx = partial_tx_builder.build()?;
89    println!(
90        "   - Before partial sign - Is signed: {}",
91        partial_tx.is_signed()
92    );
93
94    // Partial sign with specific keys and their corresponding public keys
95    let private_keys_for_partial = [private_key.as_ref()];
96    let public_keys_for_partial = [fee_payer];
97    partial_tx.partial_sign(&private_keys_for_partial, &public_keys_for_partial)?;
98
99    println!("✅ Partial signing completed!");
100    println!(
101        "   - After partial sign - Is signed: {}",
102        partial_tx.is_signed()
103    );
104
105    println!("\n🎯 Summary:");
106    println!("   ✓ Transaction built using InstructionBuilder");
107    println!("   ✓ Transaction validated for size limits");
108    println!("   ✓ Transaction signed with private key");
109    println!("   ✓ Partial signing demonstrated");
110    println!("   ✓ Transaction serialized for network submission");
111
112    println!("\n📡 Next Steps:");
113    println!("   - Submit transaction_bytes to Solana RPC endpoint");
114    println!("   - Monitor transaction status on-chain");
115    println!("   - Handle success/failure responses");
116
117    Ok(())
118}

Trait Implementations§

Source§

impl BorshDeserialize for Transaction

Source§

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

Source§

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.
Source§

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.
Source§

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>
where R: Read,

Source§

impl BorshSerialize for Transaction

Source§

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

Source§

impl Clone for Transaction

Source§

fn clone(&self) -> Transaction

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Transaction

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Transaction

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Transaction

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.