Function getBalance

  • getBalance(
        address: `ct_${string}` | `ok_${string}` | `ak_${string}`,
        options: { format?: AE_AMOUNT_FORMATS } & {
            hash?: `kh_${string}` | `mh_${string}`;
            height?: number;
            onNode: Node;
        },
    ): Promise<string>

    Request the balance of specified account

    Parameters

    • address: `ct_${string}` | `ok_${string}` | `ak_${string}`

      The public account address to obtain the balance for

    • options: { format?: AE_AMOUNT_FORMATS } & {
          hash?: `kh_${string}` | `mh_${string}`;
          height?: number;
          onNode: Node;
      }

      Options

      • Optionalhash?: `kh_${string}` | `mh_${string}`

        The block hash on which to obtain the balance for (default: top of chain)

      • Optionalheight?: number

        The chain height at which to obtain the balance for (default: top of chain)

      • onNode: Node

    Returns Promise<string>

Settings

Member Visibility