Avalanche SDK Client - v0.0.4-alpha.14
    Preparing search index...

    Type Alias GetBalanceReturnType

    Return type for the platform.getBalance method.

    type GetBalanceReturnType = {
        balance: bigint;
        balances: Record<string, string>;
        lockedNotStakeable: bigint;
        lockedNotStakeables: Record<string, string>;
        lockedStakeable: bigint;
        lockedStakeables: Record<string, string>;
        unlocked: bigint;
        unlockeds: Record<string, string>;
        utxoIDs: { outputIndex: number; txID: string }[];
    }
    Index

    Properties

    balance: bigint

    The total AVAX balance of the queried addresses

    balances: Record<string, string>

    The total balance of each asset, keyed by asset ID, as a decimal string

    lockedNotStakeable: bigint

    The locked and not stakeable AVAX balance of the queried addresses

    lockedNotStakeables: Record<string, string>

    The locked and not stakeable balance of each asset, keyed by asset ID, as a decimal string

    lockedStakeable: bigint

    The locked stakeable AVAX balance of the queried addresses

    lockedStakeables: Record<string, string>

    The locked stakeable balance of each asset, keyed by asset ID, as a decimal string

    unlocked: bigint

    The unlocked AVAX balance of the queried addresses

    unlockeds: Record<string, string>

    The unlocked balance of each asset, keyed by asset ID, as a decimal string

    utxoIDs: { outputIndex: number; txID: string }[]

    The IDs of the UTXOs that reference the queried addresses

    Type declaration

    • outputIndex: number

      The output index of the UTXO.

    • txID: string

      The transaction ID of the UTXO.