Helius SDK - v3.0.0
    Preparing search index...

    Type Alias TokenTransfer

    Parsed, human-readable token or native SOL transfer record.

    type TokenTransfer = {
        amount: string;
        blockTime: number;
        confirmationStatus: "finalized" | "confirmed";
        decimals: number;
        feeAccount?: string;
        feeAmount?: string;
        feeUiAmount?: string;
        fromTokenAccount?: string;
        fromUserAccount: string | null;
        innerInstructionIdx: number;
        instructionIdx: number;
        mint: string;
        signature: string;
        slot: number;
        toTokenAccount?: string;
        toUserAccount: string | null;
        transactionIdx: number;
        type:
            | "transfer"
            | "mint"
            | "burn"
            | "wrap"
            | "unwrap"
            | "changeOwner"
            | "withdrawWithheldFee";
        uiAmount: string;
    }
    Index

    Properties

    amount: string

    Raw transfer amount as a string to preserve precision.

    blockTime: number

    Unix timestamp in seconds for the block.

    confirmationStatus: "finalized" | "confirmed"

    Confirmation status.

    decimals: number

    Token decimals. Native SOL uses 9.

    feeAccount?: string

    Token account associated with the withheld fee.

    feeAmount?: string

    Transfer fee withheld by the Token-2022 transfer-fee extension.

    feeUiAmount?: string

    Human-readable fee amount. Present only when feeAmount is present.

    fromTokenAccount?: string

    Source token account. Omitted when not applicable, such as native SOL transfers.

    fromUserAccount: string | null

    Wallet address that sent the tokens, or null when no sender exists.

    innerInstructionIdx: number

    Index within inner instructions. 0 when the transfer is top-level.

    instructionIdx: number

    Index of the instruction within the transaction.

    mint: string

    Token mint address.

    signature: string

    Base58-encoded transaction signature.

    slot: number

    Slot number containing the transaction.

    toTokenAccount?: string

    Destination token account. Omitted when not applicable, such as native SOL transfers.

    toUserAccount: string | null

    Wallet address that received the tokens, or null when no recipient exists.

    transactionIdx: number

    Index of the transaction within the block.

    type:
        | "transfer"
        | "mint"
        | "burn"
        | "wrap"
        | "unwrap"
        | "changeOwner"
        | "withdrawWithheldFee"

    Parsed transfer type.

    uiAmount: string

    Human-readable amount.