solana_program::system_instruction

Enum SystemInstruction

Source
pub enum SystemInstruction {
Show 13 variants CreateAccount { lamports: u64, space: u64, owner: Pubkey, }, Assign { owner: Pubkey, }, Transfer { lamports: u64, }, CreateAccountWithSeed { base: Pubkey, seed: String, lamports: u64, space: u64, owner: Pubkey, }, AdvanceNonceAccount, WithdrawNonceAccount(u64), InitializeNonceAccount(Pubkey), AuthorizeNonceAccount(Pubkey), Allocate { space: u64, }, AllocateWithSeed { base: Pubkey, seed: String, space: u64, owner: Pubkey, }, AssignWithSeed { base: Pubkey, seed: String, owner: Pubkey, }, TransferWithSeed { lamports: u64, from_seed: String, from_owner: Pubkey, }, UpgradeNonceAccount,
}
Expand description

An instruction to the system program.

Variants§

§

CreateAccount

Create a new account

§Account references

  1. [WRITE, SIGNER] Funding account
  2. [WRITE, SIGNER] New account

Fields

§lamports: u64

Number of lamports to transfer to the new account

§space: u64

Number of bytes of memory to allocate

§owner: Pubkey

Address of program that will own the new account

§

Assign

Assign account to a program

§Account references

  1. [WRITE, SIGNER] Assigned account public key

Fields

§owner: Pubkey

Owner program account

§

Transfer

Transfer lamports

§Account references

  1. [WRITE, SIGNER] Funding account
  2. [WRITE] Recipient account

Fields

§lamports: u64
§

CreateAccountWithSeed

Create a new account at an address derived from a base pubkey and a seed

§Account references

  1. [WRITE, SIGNER] Funding account
  2. [WRITE] Created account
  3. [SIGNER] (optional) Base account; the account matching the base Pubkey below must be provided as a signer, but may be the same as the funding account and provided as account 0

Fields

§base: Pubkey

Base public key

§seed: String

String of ASCII chars, no longer than Pubkey::MAX_SEED_LEN

§lamports: u64

Number of lamports to transfer to the new account

§space: u64

Number of bytes of memory to allocate

§owner: Pubkey

Owner program account address

§

AdvanceNonceAccount

Consumes a stored nonce, replacing it with a successor

§Account references

  1. [WRITE] Nonce account
  2. [] RecentBlockhashes sysvar
  3. [SIGNER] Nonce authority
§

WithdrawNonceAccount(u64)

Withdraw funds from a nonce account

§Account references

  1. [WRITE] Nonce account
  2. [WRITE] Recipient account
  3. [] RecentBlockhashes sysvar
  4. [] Rent sysvar
  5. [SIGNER] Nonce authority

The u64 parameter is the lamports to withdraw, which must leave the account balance above the rent exempt reserve or at zero.

§

InitializeNonceAccount(Pubkey)

Drive state of Uninitialized nonce account to Initialized, setting the nonce value

§Account references

  1. [WRITE] Nonce account
  2. [] RecentBlockhashes sysvar
  3. [] Rent sysvar

The Pubkey parameter specifies the entity authorized to execute nonce instruction on the account

No signatures are required to execute this instruction, enabling derived nonce account addresses

§

AuthorizeNonceAccount(Pubkey)

Change the entity authorized to execute nonce instructions on the account

§Account references

  1. [WRITE] Nonce account
  2. [SIGNER] Nonce authority

The Pubkey parameter identifies the entity to authorize

§

Allocate

Allocate space in a (possibly new) account without funding

§Account references

  1. [WRITE, SIGNER] New account

Fields

§space: u64

Number of bytes of memory to allocate

§

AllocateWithSeed

Allocate space for and assign an account at an address derived from a base public key and a seed

§Account references

  1. [WRITE] Allocated account
  2. [SIGNER] Base account

Fields

§base: Pubkey

Base public key

§seed: String

String of ASCII chars, no longer than pubkey::MAX_SEED_LEN

§space: u64

Number of bytes of memory to allocate

§owner: Pubkey

Owner program account

§

AssignWithSeed

Assign account to a program based on a seed

§Account references

  1. [WRITE] Assigned account
  2. [SIGNER] Base account

Fields

§base: Pubkey

Base public key

§seed: String

String of ASCII chars, no longer than pubkey::MAX_SEED_LEN

§owner: Pubkey

Owner program account

§

TransferWithSeed

Transfer lamports from a derived address

§Account references

  1. [WRITE] Funding account
  2. [SIGNER] Base for funding account
  3. [WRITE] Recipient account

Fields

§lamports: u64

Amount to transfer

§from_seed: String

Seed to use to derive the funding account address

§from_owner: Pubkey

Owner to use to derive the funding account address

§

UpgradeNonceAccount

One-time idempotent upgrade of legacy nonce versions in order to bump them out of chain blockhash domain.

§Account references

  1. [WRITE] Nonce account

Trait Implementations§

Source§

impl Clone for SystemInstruction

Source§

fn clone(&self) -> SystemInstruction

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SystemInstruction

Source§

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

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

impl<'de> Deserialize<'de> for SystemInstruction

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 PartialEq for SystemInstruction

Source§

fn eq(&self, other: &SystemInstruction) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for SystemInstruction

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
Source§

impl Eq for SystemInstruction

Source§

impl StructuralPartialEq for SystemInstruction

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, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

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