Enum spl_token_2022::extension::transfer_fee::instruction::TransferFeeInstruction

#[repr(u8)]
pub enum TransferFeeInstruction {
    InitializeTransferFeeConfig {
        transfer_fee_config_authority: COption<Pubkey>,
        withdraw_withheld_authority: COption<Pubkey>,
        transfer_fee_basis_points: u16,
        maximum_fee: u64,
    },
    TransferCheckedWithFee {
        amount: u64,
        decimals: u8,
        fee: u64,
    },
    WithdrawWithheldTokensFromMint,
    WithdrawWithheldTokensFromAccounts {
        num_token_accounts: u8,
    },
    HarvestWithheldTokensToMint,
    SetTransferFee {
        transfer_fee_basis_points: u16,
        maximum_fee: u64,
    },
}

Transfer Fee extension instructions

Variants

InitializeTransferFeeConfig

Initialize the transfer fee 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.

Fields

transfer_fee_config_authority: COption<Pubkey>

Pubkey that may update the fees

withdraw_withheld_authority: COption<Pubkey>

Withdraw instructions must be signed by this key

transfer_fee_basis_points: u16

Amount of transfer collected as fees, expressed as basis points of the transfer amount

maximum_fee: u64

Maximum fee assessed on transfers

TransferCheckedWithFee

Transfer, providing expected mint information and fees

This instruction succeeds if the mint has no configured transfer fee and the provided fee is 0. This allows applications to use TransferCheckedWithFee with any mint.

Accounts expected by this instruction:

• Single owner/delegate

0. [writable] The source account. May include the TransferFeeAmount extension.
1. [] The token mint. May include the TransferFeeConfig extension.
2. [writable] The destination account. May include the TransferFeeAmount extension.
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.

Fields

amount: u64

The amount of tokens to transfer.

decimals: u8

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

fee: u64

Expected fee assessed on this transfer, calculated off-chain based on the transfer_fee_basis_points and maximum_fee of the mint. May be 0 for a mint without a configured transfer fee.

WithdrawWithheldTokensFromMint

Transfer all withheld tokens in the mint to an account. Signed by the mint’s withdraw withheld tokens authority.

Accounts expected by this instruction:

• Single owner/delegate

0. [writable] The token mint. Must include the TransferFeeConfig extension.
1. [writable] The fee receiver account. Must include the TransferFeeAmount extension associated with the provided mint.
2. [signer] The mint’s withdraw_withheld_authority.

• Multisignature owner/delegate

0. [writable] The token mint.
1. [writable] The destination account.
2. [] The mint’s multisig withdraw_withheld_authority.
3. ..3+M [signer] M signer accounts.

WithdrawWithheldTokensFromAccounts

Transfer all withheld tokens to an account. Signed by the mint’s withdraw withheld tokens authority.

Accounts expected by this instruction:

• Single owner/delegate

0. [] The token mint. Must include the TransferFeeConfig extension.
1. [writable] The fee receiver account. Must include the TransferFeeAmount extension and be associated with the provided mint.
2. [signer] The mint’s withdraw_withheld_authority.
3. ..3+N [writable] The source accounts to withdraw from.

• Multisignature owner/delegate

0. [] The token mint.
1. [writable] The destination account.
2. [] The mint’s multisig withdraw_withheld_authority.
3. ..3+M [signer] M signer accounts. 3+M+1. ..3+M+N [writable] The source accounts to withdraw from.

Fields

num_token_accounts: u8

Number of token accounts harvested

HarvestWithheldTokensToMint

Permissionless instruction to transfer all withheld tokens to the mint.

Succeeds for frozen accounts.

Accounts provided should include the TransferFeeAmount extension. If not, the account is skipped.

Accounts expected by this instruction:

0. [writable] The mint.
1. ..1+N [writable] The source accounts to harvest from.

SetTransferFee

Set transfer fee. Only supported for mints that include the TransferFeeConfig extension.

Accounts expected by this instruction:

• Single authority

0. [writable] The mint.
1. [signer] The mint’s fee account owner.

• Multisignature authority

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

Fields

transfer_fee_basis_points: u16

Amount of transfer collected as fees, expressed as basis points of the transfer amount

maximum_fee: u64

Maximum fee assessed on transfers

Implementations

impl TransferFeeInstruction

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

Unpacks a byte buffer into a TransferFeeInstruction

pub fn pack(&self, buffer: &mut Vec<u8>)

Packs a TransferFeeInstruction into a byte buffer.

Trait Implementations

impl Clone for TransferFeeInstruction

fn clone(&self) -> TransferFeeInstruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransferFeeInstruction

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

Formats the value using the given formatter.

impl PartialEq for TransferFeeInstruction

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

impl StructuralPartialEq for TransferFeeInstruction