solana-loader-v2-interface 3.1.0

Solana non-upgradable BPF loader v2 instructions.
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

//! Instructions for the non-upgradable BPF loader.
#![cfg_attr(docsrs, feature(doc_cfg))]

#[cfg(feature = "stable-abi")]
use solana_frozen_abi_macro::{frozen_abi, StableAbi, StableAbiSample};
#[cfg(feature = "wincode")]
use wincode::{SchemaRead, SchemaWrite};
#[cfg(any(feature = "bincode", feature = "wincode"))]
use {
    solana_instruction::{AccountMeta, Instruction},
    solana_pubkey::Pubkey,
    solana_sdk_ids::sysvar::rent,
};

#[cfg_attr(
    feature = "stable-abi",
    frozen_abi(
        abi_digest = "C8z9CxbjNT9UwGVkCkubvUsZH7ZUJPNkNn9TmRp6ZsPC",
        abi_serializer = ["bincode", "wincode"],
        test_roundtrip = "eq_and_wire"
    ),
    derive(StableAbi, StableAbiSample)
)]
#[cfg_attr(
    feature = "serde",
    derive(serde_derive::Deserialize, serde_derive::Serialize)
)]
#[cfg_attr(feature = "wincode", derive(SchemaRead, SchemaWrite))]
#[derive(Debug, PartialEq, Eq, Clone)]
pub enum LoaderInstruction {
    /// Write program data into an account
    ///
    /// # Account references
    ///   0. [WRITE, SIGNER] Account to write to
    Write {
        /// Offset at which to write the given bytes
        offset: u32,

        /// Serialized program data
        #[cfg_attr(feature = "serde", serde(with = "serde_bytes"))]
        bytes: Vec<u8>,
    },

    /// Finalize an account loaded with program data for execution
    ///
    /// The exact preparation steps is loader specific but on success the loader must set the executable
    /// bit of the account.
    ///
    /// # Account references
    ///   0. [WRITE, SIGNER] The account to prepare for execution
    ///   1. [] Rent sysvar
    Finalize,
}

#[cfg(all(feature = "bincode", not(feature = "wincode")))]
#[inline(always)]
fn create_instruction(
    program_id: Pubkey,
    data: &LoaderInstruction,
    accounts: Vec<AccountMeta>,
) -> Instruction {
    Instruction::new_with_bincode(program_id, data, accounts)
}

#[cfg(feature = "wincode")]
#[inline(always)]
fn create_instruction(
    program_id: Pubkey,
    data: &LoaderInstruction,
    accounts: Vec<AccountMeta>,
) -> Instruction {
    Instruction::new_with_wincode(program_id, data, accounts)
}

#[deprecated(since = "2.2.0", note = "Use loader-v4 instead")]
#[cfg(any(feature = "bincode", feature = "wincode"))]
pub fn write(
    account_pubkey: &Pubkey,
    program_id: &Pubkey,
    offset: u32,
    bytes: Vec<u8>,
) -> Instruction {
    let account_metas = vec![AccountMeta::new(*account_pubkey, true)];
    create_instruction(
        *program_id,
        &LoaderInstruction::Write { offset, bytes },
        account_metas,
    )
}

#[deprecated(since = "2.2.0", note = "Use loader-v4 instead")]
#[cfg(any(feature = "bincode", feature = "wincode"))]
pub fn finalize(account_pubkey: &Pubkey, program_id: &Pubkey) -> Instruction {
    let account_metas = vec![
        AccountMeta::new(*account_pubkey, true),
        AccountMeta::new_readonly(rent::id(), false),
    ];
    create_instruction(*program_id, &LoaderInstruction::Finalize, account_metas)
}

#[cfg(all(test, feature = "bincode", feature = "wincode"))]
mod tests {
    use super::*;

    #[test]
    #[allow(deprecated)]
    fn test_builders_match_bincode_encoding() {
        let account = Pubkey::new_unique();
        let program_id = Pubkey::new_unique();
        for (ix, expected) in [
            (
                write(&account, &program_id, 7, vec![9, 8, 7]),
                LoaderInstruction::Write {
                    offset: 7,
                    bytes: vec![9, 8, 7],
                },
            ),
            (finalize(&account, &program_id), LoaderInstruction::Finalize),
        ] {
            assert_eq!(ix.program_id, program_id);
            assert_eq!(ix.data, bincode::serialize(&expected).unwrap());
        }
    }
}