Type Alias GetBalanceReturnType

Return type for the platform.getBalance method.

type GetBalanceReturnType = {
    balance: bigint;
    lockedNotStakeable: bigint;
    lockedStakeable: bigint;
    unlocked: bigint;
    utxoIDs: { outputIndex: number; txID: string }[];
}

Properties

balance: bigint

The total balance of the queried addresses

lockedNotStakeable: bigint

The locked and not stakeable balance of the queried addresses

lockedStakeable: bigint

The locked stakeable balance of the queried addresses

unlocked: bigint

The unlocked balance of the queried addresses

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

The IDs of the UTXOs that reference the queried addresses