Enum spl_token::instruction::TokenInstruction

[−] Show declaration

[+] Expand attributes
#[repr(C)]pub enum TokenInstruction {
    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,
    },
}

[−] Expand description

Instructions supported by the token program.

Variants

InitializeMint

[−] Expand description

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.

Accounts expected by this instruction:

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

[−] Show fields

Fields of InitializeMint

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.

InitializeAccount

[−] Expand description

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

[−] Expand description

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 <=

[−] Show fields

Fields of InitializeMultisig

m: u8

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

Transfer

[−] Expand description

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.

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.

[−] Show fields

Fields of Transfer

amount: u64

The amount of tokens to transfer.

Approve

[−] Expand description

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

[−] Show fields

Fields of Approve

amount: u64

The amount of tokens the delegate is approved for.

Revoke

[−] Expand description

Revokes the delegate’s authority.

Accounts expected by this instruction:

• Single owner

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

• Multisignature owner

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

SetAuthority

[−] Expand description

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

[−] Show fields

Fields of SetAuthority

authority_type: AuthorityType

The type of authority to update.

new_authority: COption<Pubkey>

The new authority

MintTo

[−] Expand description

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.

[−] Show fields

Fields of MintTo

amount: u64

The amount of new tokens to mint.

Burn

[−] Expand description

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.

[−] Show fields

Fields of Burn

amount: u64

The amount of tokens to burn.

CloseAccount

[−] Expand description

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

[−] Expand description

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

[−] Expand description

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

[−] Expand description

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.

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.

[−] Show fields

Fields of TransferChecked

amount: u64

The amount of tokens to transfer.

decimals: u8

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

ApproveChecked

[−] Expand description

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

[−] Show fields

Fields of ApproveChecked

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.

MintToChecked

[−] Expand description

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.

[−] Show fields

Fields of MintToChecked

amount: u64

The amount of new tokens to mint.

decimals: u8

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

BurnChecked

[−] Expand description

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.

[−] Show fields

Fields of BurnChecked

amount: u64

The amount of tokens to burn.

decimals: u8

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

InitializeAccount2

[−] Expand description

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

[−] Show fields

Fields of InitializeAccount2

owner: Pubkey

The new account’s owner/multisignature.

Implementations

impl TokenInstruction[−]

pub fn unpack(input: &[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 Clone for TokenInstruction[+]

[+] Show hidden undocumented items

fn clone(&self) -> TokenInstruction[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for TokenInstruction[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl PartialEq<TokenInstruction> for TokenInstruction[+]

[+] Show hidden undocumented items

fn eq(&self, other: &TokenInstruction) -> bool[−]

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

fn ne(&self, other: &TokenInstruction) -> bool[−]

This method tests for !=.

impl StructuralPartialEq for TokenInstruction