Enum SystemInstruction 

pub enum SystemInstruction {
    CreateAccount {
        lamports: u64,
        space: u64,
        owner: Address,
    },
    Assign {
        owner: Address,
    },
    Transfer {
        lamports: u64,
    },
    CreateAccountWithSeed {
        base: Address,
        seed: String,
        lamports: u64,
        space: u64,
        owner: Address,
    },
    AdvanceNonceAccount,
    WithdrawNonceAccount(u64),
    InitializeNonceAccount(Address),
    AuthorizeNonceAccount(Address),
    Allocate {
        space: u64,
    },
    AllocateWithSeed {
        base: Address,
        seed: String,
        space: u64,
        owner: Address,
    },
    AssignWithSeed {
        base: Address,
        seed: String,
        owner: Address,
    },
    TransferWithSeed {
        lamports: u64,
        from_seed: String,
        from_owner: Address,
    },
    UpgradeNonceAccount,
    CreateAccountAllowPrefund {
        lamports: u64,
        space: u64,
        owner: Address,
    },
}

An instruction to the system program.

Variants

CreateAccount

Create a new account

Account references

0. [WRITE, SIGNER] Funding account
1. [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: Address

Address of program that will own the new account

Assign

Assign account to a program

Account references

0. [WRITE, SIGNER] Assigned account public key

Fields

owner: Address

Owner program account

Transfer

Transfer lamports

Account references

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

Fields

lamports: u64

CreateAccountWithSeed

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

Account references

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

Fields

base: Address

Base address

seed: String

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

lamports: u64

Number of lamports to transfer to the new account

space: u64

Number of bytes of memory to allocate

owner: Address

Owner program account address

AdvanceNonceAccount

Consumes a stored nonce, replacing it with a successor

Account references

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

WithdrawNonceAccount(u64)

Withdraw funds from a nonce account

Account references

0. [WRITE] Nonce account
1. [WRITE] Recipient account
2. [] RecentBlockhashes sysvar
3. [] Rent sysvar
4. [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(Address)

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

Account references

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

The Address 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(Address)

Change the entity authorized to execute nonce instructions on the account

Account references

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

The Address parameter identifies the entity to authorize

Allocate

Allocate space in a (possibly new) account without funding

Account references

0. [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

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

Fields

base: Address

Base address

seed: String

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

space: u64

Number of bytes of memory to allocate

owner: Address

Owner program account

AssignWithSeed

Assign account to a program based on a seed

Account references

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

Fields

base: Address

Base address

seed: String

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

owner: Address

Owner program account

TransferWithSeed

Transfer lamports from a derived address

Account references

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

Fields

lamports: u64

Amount to transfer

from_seed: String

Seed to use to derive the funding account address

from_owner: Address

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

0. [WRITE] Nonce account

CreateAccountAllowPrefund

Create a new account without enforcing the invariant that the account’s current lamports must be 0.

This constructor is identical to create_account with the exception that it does not check that the destination account (to_pubkey) has a zero lamport balance prior to creation. This enables patterns where you first transfer lamports to prefund an account, then use create_account_allow_prefund as a single CPI to transfer additional lamports, allocate space, and assign ownership.

Use create_account for typical account creation. Use create_account_allow_prefund when the target account has already been prefunded and you want to complete the creation process with a single CPI.

Safety considerations As with allocate and assign when invoked manually, this instruction can brick a wallet if used incorrectly; do not pass in a wallet system account as the new account. This instruction does not prevent the new account from having more lamports than required for rent exemption, and all lamports will become locked.

Account references

If lamports > 0 (meaning lamports are being transferred): 0. [WRITE, SIGNER] New account

1. [WRITE, SIGNER] Funding account

If lamports == 0 (no lamports to be transferred), you may omit funding account: 0. [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: Address

Address of program that will own the new account

Trait Implementations

impl AbiEnumVisitor for SystemInstruction

fn visit_for_abi(&self, digester: &mut AbiDigester) -> DigestResult

impl AbiExample for SystemInstruction

fn example() -> Self

impl Clone for SystemInstruction

fn clone(&self) -> SystemInstruction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemInstruction

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SystemInstruction

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SystemInstruction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SystemInstruction

impl StructuralPartialEq for SystemInstruction