Keeta LogoKeeta Logo@keetanetwork/keetanet-client
    Preparing search index...

    Type Alias GetAccountStateAPIResponseFormatted<AccountType>

    Account information

    type GetAccountStateAPIResponseFormatted<
        AccountType extends AccountKeyAlgorithm = AccountKeyAlgorithm,
    > = {
        account: Account<AccountType>;
        balances: GetAllBalancesResponse;
        currentHeadBlock: string | null;
        currentHeadBlockHeight: string | null;
        info: DistributiveOmit<AccountInfoForType<AccountType>, "account">;
        representative: Account | null;
    }

    Type Parameters

    Index

    Properties

    The account for which this information is for

    The balances for the account Each token will have a balance, even if it is 0 This will be an empty array if the account is not open

    Type declaration

    • balance: bigint

      The account balance of the specified token

      This is in raw units, and not the display units that the token uses

    • token: TokenAddress

      The account of the token

    currentHeadBlock: string | null

    The current head block for the account, if there is one this will be null if the account is not open

    currentHeadBlockHeight: string | null

    The current height of the head block for the account, if there is one this will be null if the account is not open

    Metadata for the account which can be set with the ['setInfo']() method

    representative: Account | null

    The current representative for the account, if there is one this will be null if the account is not open or if the account has not yet set a representative