Enum spl_transfer_hook_interface::instruction::TransferHookInstruction

#[repr(C)]
pub enum TransferHookInstruction {
    Execute {
        amount: u64,
    },
    InitializeExtraAccountMetaList {
        extra_account_metas: Vec<ExtraAccountMeta>,
    },
    UpdateExtraAccountMetaList {
        extra_account_metas: Vec<ExtraAccountMeta>,
    },
}

Instructions supported by the transfer hook interface.

Variants

Execute

Runs additional transfer logic.

Accounts expected by this instruction:

0. [] Source account
1. [] Token mint
2. [] Destination account
3. [] Source account’s owner/delegate
4. [] Validation account 5..5+M [] M additional accounts, written in validation account data

Fields

amount: u64

Amount of tokens to transfer

InitializeExtraAccountMetaList

Initializes the extra account metas on an account, writing into the first open TLV space.

Accounts expected by this instruction:

0. [w] Account with extra account metas
1. [] Mint
2. [s] Mint authority
3. [] System program

Fields

extra_account_metas: Vec<ExtraAccountMeta>

List of ExtraAccountMetas to write into the account

UpdateExtraAccountMetaList

Updates the extra account metas on an account by overwriting the existing list.

Accounts expected by this instruction:

0. [w] Account with extra account metas
1. [] Mint
2. [s] Mint authority

Fields

extra_account_metas: Vec<ExtraAccountMeta>

The new list of ExtraAccountMetas to overwrite the existing entry in the account.

Implementations

impl TransferHookInstruction

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

Unpacks a byte buffer into a TransferHookInstruction.

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

Packs a TokenInstruction into a byte buffer.

Trait Implementations

impl Clone for TransferHookInstruction

fn clone(&self) -> TransferHookInstruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransferHookInstruction

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

Formats the value using the given formatter.

impl PartialEq for TransferHookInstruction

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