solana-primitives 0.2.6

Fundamental data structures and tools needed to construct and submit Solana transactions.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

use super::pubkey::Pubkey;
use borsh::{BorshDeserialize, BorshSerialize};
use serde::{Deserialize, Serialize};

/// Represents a Solana instruction
#[derive(Debug, Clone, BorshSerialize, BorshDeserialize, Serialize, Deserialize)]
pub struct Instruction {
    /// The program ID that will process this instruction
    #[serde(alias = "programId")]
    pub program_id: Pubkey,
    /// The accounts that will be read from or written to
    #[serde(alias = "keys")]
    pub accounts: Vec<AccountMeta>,
    /// The instruction data
    pub data: Vec<u8>,
}

/// Metadata about an account in an instruction
#[derive(Debug, Clone, BorshSerialize, BorshDeserialize, Serialize, Deserialize)]
pub struct AccountMeta {
    /// The account's public key
    #[serde(alias = "publicKey")]
    pub pubkey: Pubkey,
    /// Whether the account is a signer
    #[serde(alias = "isSigner")]
    pub is_signer: bool,
    /// Whether the account is writable
    #[serde(alias = "isWritable")]
    pub is_writable: bool,
}

impl AccountMeta {
    /// Create a new AccountMeta with explicit signer/writable flags.
    pub fn new(pubkey: Pubkey, is_signer: bool, is_writable: bool) -> Self {
        Self {
            pubkey,
            is_signer,
            is_writable,
        }
    }

    /// Create a new AccountMeta that is read-only
    pub fn new_readonly(pubkey: Pubkey) -> Self {
        Self::new(pubkey, false, false)
    }

    /// Create a new AccountMeta that is a signer
    pub fn new_signer(pubkey: Pubkey) -> Self {
        Self::new(pubkey, true, false)
    }

    /// Create a new AccountMeta that is writable
    pub fn new_writable(pubkey: Pubkey) -> Self {
        Self::new(pubkey, false, true)
    }

    /// Create a new AccountMeta that is both a signer and writable
    pub fn new_signer_writable(pubkey: Pubkey) -> Self {
        Self::new(pubkey, true, true)
    }
}

/// A compiled instruction that references accounts by their indices
#[derive(Debug, Clone, PartialEq, BorshSerialize, BorshDeserialize, Serialize, Deserialize)]
pub struct CompiledInstruction {
    /// Index into the account keys array indicating the program to execute
    pub program_id_index: u8,
    /// Indices into the account keys array indicating which accounts to pass to the program
    pub accounts: Vec<u8>,
    /// The instruction data
    pub data: Vec<u8>,
}