Enum spl_token_2022::instruction::TokenInstruction

#[repr(C)]
pub enum TokenInstruction<'a> {
    InitializeMint {
        decimals: u8,
        mint_authority: Pubkey,
        freeze_authority: COption<Pubkey>,
    },
    InitializeAccount,
    InitializeMultisig {
        m: u8,
    },
    Transfer {
        amount: u64,
    },
    Approve {
        amount: u64,
    },
    Revoke,
    SetAuthority {
        authority_type: AuthorityType,
        new_authority: COption<Pubkey>,
    },
    MintTo {
        amount: u64,
    },
    Burn {
        amount: u64,
    },
    CloseAccount,
    FreezeAccount,
    ThawAccount,
    TransferChecked {
        amount: u64,
        decimals: u8,
    },
    ApproveChecked {
        amount: u64,
        decimals: u8,
    },
    MintToChecked {
        amount: u64,
        decimals: u8,
    },
    BurnChecked {
        amount: u64,
        decimals: u8,
    },
    InitializeAccount2 {
        owner: Pubkey,
    },
    SyncNative,
    InitializeAccount3 {
        owner: Pubkey,
    },
    InitializeMultisig2 {
        m: u8,
    },
    InitializeMint2 {
        decimals: u8,
        mint_authority: Pubkey,
        freeze_authority: COption<Pubkey>,
    },
    GetAccountDataSize {
        extension_types: Vec<ExtensionType>,
    },
    InitializeImmutableOwner,
    AmountToUiAmount {
        amount: u64,
    },
    UiAmountToAmount {
        ui_amount: &'a str,
    },
    InitializeMintCloseAuthority {
        close_authority: COption<Pubkey>,
    },
    TransferFeeExtension(TransferFeeInstruction),
    ConfidentialTransferExtension,
    DefaultAccountStateExtension,
    Reallocate {
        extension_types: Vec<ExtensionType>,
    },
    MemoTransferExtension,
    CreateNativeMint,
    InitializeNonTransferableMint,
    InterestBearingMintExtension,
    CpiGuardExtension,
    InitializePermanentDelegate {
        delegate: Pubkey,
    },
    TransferHookExtension,
    ConfidentialTransferFeeExtension,
    WithdrawExcessLamports,
    MetadataPointerExtension,
    GroupPointerExtension,
    GroupMemberPointerExtension,
}

Instructions supported by the token program.

Variants

InitializeMint

Fields

decimals: u8

Number of base 10 digits to the right of the decimal place.

mint_authority: Pubkey

The authority/multisignature to mint tokens.

freeze_authority: COption<Pubkey>

The freeze authority/multisignature of the mint.

Initializes a new mint and optionally deposits all the newly minted tokens in an account.

The InitializeMint instruction requires no signers and MUST be included within the same Transaction as the system program’s CreateAccount instruction that creates the account being initialized. Otherwise another party can acquire ownership of the uninitialized account.

All extensions must be initialized before calling this instruction.

Accounts expected by this instruction:

0. [writable] The mint to initialize.
1. [] Rent sysvar

InitializeAccount

Initializes a new account to hold tokens. If this account is associated with the native mint then the token balance of the initialized account will be equal to the amount of SOL in the account. If this account is associated with another mint, that mint must be initialized before this command can succeed.

The InitializeAccount instruction requires no signers and MUST be included within the same Transaction as the system program’s CreateAccount instruction that creates the account being initialized. Otherwise another party can acquire ownership of the uninitialized account.

Accounts expected by this instruction:

0. [writable] The account to initialize.
1. [] The mint this account will be associated with.
2. [] The new account’s owner/multisignature.
3. [] Rent sysvar

InitializeMultisig

Fields

m: u8

The number of signers (M) required to validate this multisignature account.

Initializes a multisignature account with N provided signers.

Multisignature accounts can used in place of any single owner/delegate accounts in any token instruction that require an owner/delegate to be present. The variant field represents the number of signers (M) required to validate this multisignature account.

The InitializeMultisig instruction requires no signers and MUST be included within the same Transaction as the system program’s CreateAccount instruction that creates the account being initialized. Otherwise another party can acquire ownership of the uninitialized account.

Accounts expected by this instruction:

0. [writable] The multisignature account to initialize.
1. [] Rent sysvar
2. ..2+N. [] The signer accounts, must equal to N where 1 <= N <= 11.

Transfer

Fields

amount: u64

👎Deprecated since 4.0.0: please use TransferChecked or TransferCheckedWithFee instead

The amount of tokens to transfer.

👎Deprecated since 4.0.0: please use TransferChecked or TransferCheckedWithFee instead

NOTE This instruction is deprecated in favor of TransferChecked or TransferCheckedWithFee

Transfers tokens from one account to another either directly or via a delegate. If this account is associated with the native mint then equal amounts of SOL and Tokens will be transferred to the destination account.

If either account contains an TransferFeeAmount extension, this will fail. Mints with the TransferFeeConfig extension are required in order to assess the fee.

Accounts expected by this instruction:

• Single owner/delegate

0. [writable] The source account.
1. [writable] The destination account.
2. [signer] The source account’s owner/delegate.

• Multisignature owner/delegate

0. [writable] The source account.
1. [writable] The destination account.
2. [] The source account’s multisignature owner/delegate.
3. ..3+M [signer] M signer accounts.

Approve

Fields

amount: u64

The amount of tokens the delegate is approved for.

Approves a delegate. A delegate is given the authority over tokens on behalf of the source account’s owner.

Accounts expected by this instruction:

• Single owner

0. [writable] The source account.
1. [] The delegate.
2. [signer] The source account owner.

• Multisignature owner

0. [writable] The source account.
1. [] The delegate.
2. [] The source account’s multisignature owner.
3. ..3+M [signer] M signer accounts

Revoke

Revokes the delegate’s authority.

Accounts expected by this instruction:

• Single owner

0. [writable] The source account.
1. [signer] The source account owner or current delegate.

• Multisignature owner

0. [writable] The source account.
1. [] The source account’s multisignature owner or current delegate.
2. ..2+M [signer] M signer accounts

SetAuthority

Fields

authority_type: AuthorityType

The type of authority to update.

new_authority: COption<Pubkey>

The new authority

Sets a new authority of a mint or account.

Accounts expected by this instruction:

• Single authority

0. [writable] The mint or account to change the authority of.
1. [signer] The current authority of the mint or account.

• Multisignature authority

0. [writable] The mint or account to change the authority of.
1. [] The mint’s or account’s current multisignature authority.
2. ..2+M [signer] M signer accounts

MintTo

Fields

amount: u64

The amount of new tokens to mint.

Mints new tokens to an account. The native mint does not support minting.

Accounts expected by this instruction:

• Single authority

0. [writable] The mint.
1. [writable] The account to mint tokens to.
2. [signer] The mint’s minting authority.

• Multisignature authority

0. [writable] The mint.
1. [writable] The account to mint tokens to.
2. [] The mint’s multisignature mint-tokens authority.
3. ..3+M [signer] M signer accounts.

Burn

Fields

amount: u64

The amount of tokens to burn.

Burns tokens by removing them from an account. Burn does not support accounts associated with the native mint, use CloseAccount instead.

Accounts expected by this instruction:

• Single owner/delegate

0. [writable] The account to burn from.
1. [writable] The token mint.
2. [signer] The account’s owner/delegate.

• Multisignature owner/delegate

0. [writable] The account to burn from.
1. [writable] The token mint.
2. [] The account’s multisignature owner/delegate.
3. ..3+M [signer] M signer accounts.

CloseAccount

Close an account by transferring all its SOL to the destination account. Non-native accounts may only be closed if its token amount is zero.

Accounts with the TransferFeeAmount extension may only be closed if the withheld amount is zero.

Accounts with the ConfidentialTransfer extension may only be closed if the pending and available balance ciphertexts are empty. Use ConfidentialTransferInstruction::ApplyPendingBalance and ConfidentialTransferInstruction::EmptyAccount to empty these ciphertexts.

Accounts with the ConfidentialTransferFee extension may only be closed if the withheld amount ciphertext is empty. Use ConfidentialTransferFeeInstruction::HarvestWithheldTokensToMint to empty this ciphertext.

Mints may be closed if they have the MintCloseAuthority extension and their token supply is zero

Accounts

Accounts expected by this instruction:

• Single owner

0. [writable] The account to close.
1. [writable] The destination account.
2. [signer] The account’s owner.

• Multisignature owner

0. [writable] The account to close.
1. [writable] The destination account.
2. [] The account’s multisignature owner.
3. ..3+M [signer] M signer accounts.

FreezeAccount

Freeze an Initialized account using the Mint’s freeze_authority (if set).

Accounts expected by this instruction:

• Single owner

0. [writable] The account to freeze.
1. [] The token mint.
2. [signer] The mint freeze authority.

• Multisignature owner

0. [writable] The account to freeze.
1. [] The token mint.
2. [] The mint’s multisignature freeze authority.
3. ..3+M [signer] M signer accounts.

ThawAccount

Thaw a Frozen account using the Mint’s freeze_authority (if set).

Accounts expected by this instruction:

• Single owner

0. [writable] The account to freeze.
1. [] The token mint.
2. [signer] The mint freeze authority.

• Multisignature owner

0. [writable] The account to freeze.
1. [] The token mint.
2. [] The mint’s multisignature freeze authority.
3. ..3+M [signer] M signer accounts.

TransferChecked

Fields

amount: u64

The amount of tokens to transfer.

decimals: u8

Expected number of base 10 digits to the right of the decimal place.

Transfers tokens from one account to another either directly or via a delegate. If this account is associated with the native mint then equal amounts of SOL and Tokens will be transferred to the destination account.

This instruction differs from Transfer in that the token mint and decimals value is checked by the caller. This may be useful when creating transactions offline or within a hardware wallet.

If either account contains an TransferFeeAmount extension, the fee is withheld in the destination account.

Accounts expected by this instruction:

• Single owner/delegate

0. [writable] The source account.
1. [] The token mint.
2. [writable] The destination account.
3. [signer] The source account’s owner/delegate.

• Multisignature owner/delegate

0. [writable] The source account.
1. [] The token mint.
2. [writable] The destination account.
3. [] The source account’s multisignature owner/delegate.
4. ..4+M [signer] M signer accounts.

ApproveChecked

Fields

amount: u64

The amount of tokens the delegate is approved for.

decimals: u8

Expected number of base 10 digits to the right of the decimal place.

Approves a delegate. A delegate is given the authority over tokens on behalf of the source account’s owner.

This instruction differs from Approve in that the token mint and decimals value is checked by the caller. This may be useful when creating transactions offline or within a hardware wallet.

Accounts expected by this instruction:

• Single owner

0. [writable] The source account.
1. [] The token mint.
2. [] The delegate.
3. [signer] The source account owner.

• Multisignature owner

0. [writable] The source account.
1. [] The token mint.
2. [] The delegate.
3. [] The source account’s multisignature owner.
4. ..4+M [signer] M signer accounts

MintToChecked

Fields

amount: u64

The amount of new tokens to mint.

decimals: u8

Expected number of base 10 digits to the right of the decimal place.

Mints new tokens to an account. The native mint does not support minting.

This instruction differs from MintTo in that the decimals value is checked by the caller. This may be useful when creating transactions offline or within a hardware wallet.

Accounts expected by this instruction:

• Single authority

0. [writable] The mint.
1. [writable] The account to mint tokens to.
2. [signer] The mint’s minting authority.

• Multisignature authority

0. [writable] The mint.
1. [writable] The account to mint tokens to.
2. [] The mint’s multisignature mint-tokens authority.
3. ..3+M [signer] M signer accounts.

BurnChecked

Fields

amount: u64

The amount of tokens to burn.

decimals: u8

Expected number of base 10 digits to the right of the decimal place.

Burns tokens by removing them from an account. BurnChecked does not support accounts associated with the native mint, use CloseAccount instead.

This instruction differs from Burn in that the decimals value is checked by the caller. This may be useful when creating transactions offline or within a hardware wallet.

Accounts expected by this instruction:

• Single owner/delegate

0. [writable] The account to burn from.
1. [writable] The token mint.
2. [signer] The account’s owner/delegate.

• Multisignature owner/delegate

0. [writable] The account to burn from.
1. [writable] The token mint.
2. [] The account’s multisignature owner/delegate.
3. ..3+M [signer] M signer accounts.

InitializeAccount2

Fields

owner: Pubkey

The new account’s owner/multisignature.

Like InitializeAccount, but the owner pubkey is passed via instruction data rather than the accounts list. This variant may be preferable when using Cross Program Invocation from an instruction that does not need the owner’s AccountInfo otherwise.

Accounts expected by this instruction:

0. [writable] The account to initialize.
1. [] The mint this account will be associated with.
2. [] Rent sysvar

SyncNative

Given a wrapped / native token account (a token account containing SOL) updates its amount field based on the account’s underlying lamports. This is useful if a non-wrapped SOL account uses system_instruction::transfer to move lamports to a wrapped token account, and needs to have its token amount field updated.

Accounts expected by this instruction:

0. [writable] The native token account to sync with its underlying lamports.

InitializeAccount3

Fields

owner: Pubkey

The new account’s owner/multisignature.

Like InitializeAccount2, but does not require the Rent sysvar to be provided

Accounts expected by this instruction:

0. [writable] The account to initialize.
1. [] The mint this account will be associated with.

InitializeMultisig2

Fields

m: u8

The number of signers (M) required to validate this multisignature account.

Like InitializeMultisig, but does not require the Rent sysvar to be provided

Accounts expected by this instruction:

0. [writable] The multisignature account to initialize.
1. ..1+N. [] The signer accounts, must equal to N where 1 <= N <= 11.

InitializeMint2

Fields

decimals: u8

Number of base 10 digits to the right of the decimal place.

mint_authority: Pubkey

The authority/multisignature to mint tokens.

freeze_authority: COption<Pubkey>

The freeze authority/multisignature of the mint.

Like InitializeMint, but does not require the Rent sysvar to be provided

Accounts expected by this instruction:

0. [writable] The mint to initialize.

GetAccountDataSize

Fields

extension_types: Vec<ExtensionType>

Additional extension types to include in the returned account size

Gets the required size of an account for the given mint as a little-endian u64.

Return data can be fetched using sol_get_return_data and deserializing the return data as a little-endian u64.

Accounts expected by this instruction:

0. [] The mint to calculate for

InitializeImmutableOwner

Initialize the Immutable Owner extension for the given token account

Fails if the account has already been initialized, so must be called before InitializeAccount.

Accounts expected by this instruction:

0. [writable] The account to initialize.

Data expected by this instruction: None

AmountToUiAmount

Fields

amount: u64

The amount of tokens to convert.

Convert an Amount of tokens to a UiAmount string, using the given mint.

Fails on an invalid mint.

Return data can be fetched using sol_get_return_data and deserialized with String::from_utf8.

Accounts expected by this instruction:

0. [] The mint to calculate for

UiAmountToAmount

Fields

ui_amount: &'a str

The ui_amount of tokens to convert.

Convert a UiAmount of tokens to a little-endian u64 raw Amount, using the given mint.

Return data can be fetched using sol_get_return_data and deserializing the return data as a little-endian u64.

Accounts expected by this instruction:

0. [] The mint to calculate for

InitializeMintCloseAuthority

Fields

close_authority: COption<Pubkey>

Authority that must sign the CloseAccount instruction on a mint

Initialize the close account authority on a new mint.

Fails if the mint has already been initialized, so must be called before InitializeMint.

The mint must have exactly enough space allocated for the base mint (82 bytes), plus 83 bytes of padding, 1 byte reserved for the account type, then space required for this extension, plus any others.

Accounts expected by this instruction:

0. [writable] The mint to initialize.

TransferFeeExtension(TransferFeeInstruction)

The common instruction prefix for Transfer Fee extension instructions.

See extension::transfer_fee::instruction::TransferFeeInstruction for further details about the extended instructions that share this instruction prefix

ConfidentialTransferExtension

The common instruction prefix for Confidential Transfer extension instructions.

See extension::confidential_transfer::instruction::ConfidentialTransferInstruction for further details about the extended instructions that share this instruction prefix

DefaultAccountStateExtension

The common instruction prefix for Default Account State extension instructions.

See extension::default_account_state::instruction::DefaultAccountStateInstruction for further details about the extended instructions that share this instruction prefix

Reallocate

Fields

extension_types: Vec<ExtensionType>

New extension types to include in the reallocated account

Check to see if a token account is large enough for a list of ExtensionTypes, and if not, use reallocation to increase the data size.

Accounts expected by this instruction:

• Single owner

0. [writable] The account to reallocate.
1. [signer, writable] The payer account to fund reallocation
2. [] System program for reallocation funding
3. [signer] The account’s owner.

• Multisignature owner

0. [writable] The account to reallocate.
1. [signer, writable] The payer account to fund reallocation
2. [] System program for reallocation funding
3. [] The account’s multisignature owner/delegate.
4. ..4+M [signer] M signer accounts.

MemoTransferExtension

The common instruction prefix for Memo Transfer account extension instructions.

See extension::memo_transfer::instruction::RequiredMemoTransfersInstruction for further details about the extended instructions that share this instruction prefix

CreateNativeMint

Creates the native mint.

This instruction only needs to be invoked once after deployment and is permissionless, Wrapped SOL (native_mint::id()) will not be available until this instruction is successfully executed.

Accounts expected by this instruction:

0. [writeable,signer] Funding account (must be a system account)
1. [writable] The native mint address
2. [] System program for mint account funding

InitializeNonTransferableMint

Initialize the non transferable extension for the given mint account

Fails if the account has already been initialized, so must be called before InitializeMint.

Accounts expected by this instruction:

0. [writable] The mint account to initialize.

Data expected by this instruction: None

InterestBearingMintExtension

The common instruction prefix for Interest Bearing extension instructions.

See extension::interest_bearing_mint::instruction::InterestBearingMintInstruction for further details about the extended instructions that share this instruction prefix

CpiGuardExtension

The common instruction prefix for CPI Guard account extension instructions.

See extension::cpi_guard::instruction::CpiGuardInstruction for further details about the extended instructions that share this instruction prefix

InitializePermanentDelegate

Fields

delegate: Pubkey

Authority that may sign for Transfers and Burns on any account

Initialize the permanent delegate on a new mint.

Fails if the mint has already been initialized, so must be called before InitializeMint.

The mint must have exactly enough space allocated for the base mint (82 bytes), plus 83 bytes of padding, 1 byte reserved for the account type, then space required for this extension, plus any others.

Accounts expected by this instruction:

0. [writable] The mint to initialize.

Data expected by this instruction: Pubkey for the permanent delegate

TransferHookExtension

The common instruction prefix for transfer hook extension instructions.

See extension::transfer_hook::instruction::TransferHookInstruction for further details about the extended instructions that share this instruction prefix

ConfidentialTransferFeeExtension

The common instruction prefix for the confidential transfer fee extension instructions.

See extension::confidential_transfer_fee::instruction::ConfidentialTransferFeeInstruction for further details about the extended instructions that share this instruction prefix

WithdrawExcessLamports

This instruction is to be used to rescue SOLs sent to any TokenProgram owned account by sending them to any other account, leaving behind only lamports for rent exemption.

0. [writable] Source Account owned by the token program
1. [writable] Destination account
2. [signer] Authority
3. ..2+M [signer] M signer accounts.

MetadataPointerExtension

The common instruction prefix for metadata pointer extension instructions.

See extension::metadata_pointer::instruction::MetadataPointerInstruction for further details about the extended instructions that share this instruction prefix

GroupPointerExtension

The common instruction prefix for group pointer extension instructions.

See extension::group_pointer::instruction::GroupPointerInstruction for further details about the extended instructions that share this instruction prefix

GroupMemberPointerExtension

The common instruction prefix for group member pointer extension instructions.

See extension::group_member_pointer::instruction::GroupMemberPointerInstruction for further details about the extended instructions that share this instruction prefix

Implementations

impl<'a> TokenInstruction<'a>

pub fn unpack(input: &'a [u8]) -> Result<Self, ProgramError>

Unpacks a byte buffer into a TokenInstruction.

pub fn pack(&self) -> Vec<u8>

Packs a TokenInstruction into a byte buffer.

Trait Implementations

impl<'a> Clone for TokenInstruction<'a>

fn clone(&self) -> TokenInstruction<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TokenInstruction<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for TokenInstruction<'a>

fn eq(&self, other: &TokenInstruction<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> StructuralPartialEq for TokenInstruction<'a>