solana_program/loader_v4_instruction.rs
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
//! Instructions for the v4 built-in loader program.
#[repr(u8)]
#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Clone)]
pub enum LoaderV4Instruction {
/// Write ELF data into an undeployed program account.
///
/// # Account references
/// 0. `[writable]` The program account to write to.
/// 1. `[signer]` The authority of the program.
Write {
/// Offset at which to write the given bytes.
offset: u32,
/// Serialized program data
#[serde(with = "serde_bytes")]
bytes: Vec<u8>,
},
/// Changes the size of an undeployed program account.
///
/// A program account is automatically initialized when its size is first increased.
/// In this initial truncate, the program account needs to be a signer and
/// it also sets the authority needed for subsequent operations.
/// Decreasing to size zero closes the program account and resets it
/// into an uninitialized state.
/// Providing additional lamports upfront might be necessary to reach rent exemption.
/// Superflous funds are transferred to the recipient account.
///
/// # Account references
/// 0. `[(signer), writable]` The program account to change the size of.
/// 1. `[signer]` The authority of the program.
/// 2. `[writable]` Optional, the recipient account.
Truncate {
/// The new size after the operation.
new_size: u32,
},
/// Verify the data of a program account to be a valid ELF.
///
/// If this succeeds the program becomes executable, and is ready to use.
/// A source program account can be provided to overwrite the data before deployment
/// in one step, instead retracting the program and writing to it and redeploying it.
/// The source program is truncated to zero (thus closed) and lamports necessary for
/// rent exemption are transferred, in case that the source was bigger than the program.
///
/// # Account references
/// 0. `[writable]` The program account to deploy.
/// 1. `[signer]` The authority of the program.
/// 2. `[writable]` Optional, an undeployed source program account to take data and lamports from.
Deploy,
/// Undo the deployment of a program account.
///
/// The program is no longer executable and goes into maintenance.
/// Necessary for writing data and truncating.
///
/// # Account references
/// 0. `[writable]` The program account to retract.
/// 1. `[signer]` The authority of the program.
Retract,
/// Transfers the authority over a program account.
///
/// WARNING: Using this instruction without providing a new authority
/// finalizes the program (it becomes immutable).
///
/// # Account references
/// 0. `[writable]` The program account to change the authority of.
/// 1. `[signer]` The current authority of the program.
/// 2. `[signer]` The new authority of the program. Optional if program is currently deployed.
TransferAuthority,
}