Enum TokenError 

#[non_exhaustive]
pub enum TokenError {
    Rpc(ClientError),
    MintNotFound(Pubkey),
    MintDecodeFailed {
        mint: Pubkey,
        reason: String,
    },
    TokenAccountDecodeFailed {
        token_account: Pubkey,
        reason: String,
    },
    LengthMismatch {
        mints: usize,
        mint_accounts: usize,
    },
    TransferHookDetected {
        mint: Pubkey,
        program: Pubkey,
    },
    WithBalanceNotSupported(Pubkey),
    IncoherentWrapStrategy,
    InstructionBuild(String),
    InsufficientBalance {
        mint: Pubkey,
        required: u64,
        actual: u64,
    },
    RequireBalanceForSolNotSupported(Pubkey),
}

All errors returned by solana-token-toolkit public API.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Rpc(ClientError)

An RPC call failed.

MintNotFound(Pubkey)

A requested mint account does not exist on chain.

MintDecodeFailed

Failed to decode a mint account.

Fields

mint: Pubkey

The mint pubkey whose account data could not be decoded.

reason: String

Underlying decode error message.

TokenAccountDecodeFailed

Failed to decode a token account (e.g. while reading wSOL balance).

Fields

token_account: Pubkey

The token account pubkey whose data could not be decoded.

reason: String

Underlying decode error message.

LengthMismatch

assemble_token_account_state was called with mismatched slice lengths.

Fields

mints: usize

Length of the mints slice.

mint_accounts: usize

Length of the mint_accounts slice.

TransferHookDetected

reject_transfer_hook_mints found a hook on a mint.

Fields

mint: Pubkey

The mint that has the transfer hook.

program: Pubkey

The hook program ID configured on the mint.

WithBalanceNotSupported(Pubkey)

MintIntent::WithBalance was used with a non-SOL mint.

IncoherentWrapStrategy

MintIntent::WithBalance for native SOL was paired with WrapSolStrategy::None.

InstructionBuild(String)

An spl-token-* instruction builder returned an error.

InsufficientBalance

MintIntent::RequireTokenBalance failed because actual balance is below required. actual is 0 when the ATA does not exist on chain.

Fields

mint: Pubkey

The mint whose balance check failed.

required: u64

The amount the caller required.

actual: u64

The actual balance found in state.mints[mint].ata_account (or 0 if missing).

RequireBalanceForSolNotSupported(Pubkey)

MintIntent::RequireTokenBalance was used with native_mint::ID (SOL/wSOL). For SOL balance preparation, use MintIntent::WithBalance (which transfers SOL into wSOL).

Trait Implementations

impl Debug for TokenError

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

Formats the value using the given formatter.

impl Display for TokenError

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

Formats the value using the given formatter.

impl Error for TokenError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for TokenError

fn from(source: ClientError) -> Self

Converts to this type from the input type.