Enum spl_associated_token_account::instruction::AssociatedTokenAccountInstruction

pub enum AssociatedTokenAccountInstruction {
    Create,
    CreateIdempotent,
    RecoverNested,
}

Instructions supported by the AssociatedTokenAccount program

Variants

Create

Creates an associated token account for the given wallet address and token mint Returns an error if the account exists.

0. [writeable,signer] Funding account (must be a system account)
1. [writeable] Associated token account address to be created
2. [] Wallet address for the new associated token account
3. [] The token mint for the new associated token account
4. [] System program
5. [] SPL Token program

CreateIdempotent

Creates an associated token account for the given wallet address and token mint, if it doesn’t already exist. Returns an error if the account exists, but with a different owner.

0. [writeable,signer] Funding account (must be a system account)
1. [writeable] Associated token account address to be created
2. [] Wallet address for the new associated token account
3. [] The token mint for the new associated token account
4. [] System program
5. [] SPL Token program

RecoverNested

Transfers from and closes a nested associated token account: an associated token account owned by an associated token account.

The tokens are moved from the nested associated token account to the wallet’s associated token account, and the nested account lamports are moved to the wallet.

Note: Nested token accounts are an anti-pattern, and almost always created unintentionally, so this instruction should only be used to recover from errors.

0. [writeable] Nested associated token account, must be owned by 3
1. [] Token mint for the nested associated token account
2. [writeable] Wallet’s associated token account
3. [] Owner associated token account address, must be owned by 5
4. [] Token mint for the owner associated token account
5. [writeable, signer] Wallet address for the owner associated token account
6. [] SPL Token program

Trait Implementations

impl BorshDeserialize for AssociatedTokenAccountInstruction

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSchema for AssociatedTokenAccountInstruction

fn declaration() -> Declaration

Get the name of the type without brackets.

fn add_definitions_recursively( definitions: &mut HashMap<Declaration, Definition> )

Recursively, using DFS, add type definitions required for this type. For primitive types this is an empty map. Type definition explains how to serialize/deserialize a type.

fn add_definition( declaration: String, definition: Definition, definitions: &mut HashMap<String, Definition> )

Helper method to add a single type definition to the map.

fn schema_container() -> BorshSchemaContainer

impl BorshSerialize for AssociatedTokenAccountInstruction

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8>, Error>

Serialize this instance into a vector of bytes.

impl Clone for AssociatedTokenAccountInstruction

fn clone(&self) -> AssociatedTokenAccountInstruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AssociatedTokenAccountInstruction

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

Formats the value using the given formatter.

impl EnumExt for AssociatedTokenAccountInstruction

fn deserialize_variant<R: Read>( reader: &mut R, variant_idx: u8 ) -> Result<Self, Error>

Deserialises given variant of an enum from the reader.

impl PartialEq for AssociatedTokenAccountInstruction

fn eq(&self, other: &AssociatedTokenAccountInstruction) -> 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 StructuralPartialEq for AssociatedTokenAccountInstruction