Class TatumClient

constructor

• new TatumClient(__namedParameters: { testnet: boolean }): TatumClient

  Parameters

  • __namedParameters: { testnet: boolean }

  Returns TatumClient

Readonlytestnet

Staticinstance

balance

• balance(
      __namedParameters: {
          address: string;
          mint: string;
          network: TatumNetwork;
      },
  ): Promise<
      { ok: true; value: string }
      | { error: TatumBalanceError; ok: false },
  >

  The current confirmed balance in base units; mint is native or a token contract.

  Parameters

  • __namedParameters: { address: string; mint: string; network: TatumNetwork }

  Returns Promise<{ ok: true; value: string } | { error: TatumBalanceError; ok: false }>

bitcoinHistory

• bitcoinHistory(
      __namedParameters: { address: string; offset: number; pageSize: number },
  ): Promise<
      | { ok: true; value: TatumUtxoTransaction[] }
      | { error: TatumError; ok: false },
  >

  One page of an address's Bitcoin history, newest first; offset counts transactions.

  Parameters

  • __namedParameters: { address: string; offset: number; pageSize: number }

  Returns Promise<
      | { ok: true; value: TatumUtxoTransaction[] }
      | { error: TatumError; ok: false },
  >

createAlert

• createAlert(
      __namedParameters: {
          address: string;
          network: TatumNetwork;
          url: string;
      },
  ): Promise<
      { error: TatumError; ok: false }
      | { ok: true; value: { id: string } },
  >

  An ADDRESS_EVENT alert posting every confirmed transfer of address to url.

  Parameters

  • __namedParameters: { address: string; network: TatumNetwork; url: string }

  Returns Promise<{ error: TatumError; ok: false } | { ok: true; value: { id: string } }>

deleteAlert

• deleteAlert(
      __namedParameters: { id: string },
  ): Promise<
      { ok: true; value: void }
      | { error: TatumAlertDeleteError; ok: false },
  >

  Parameters

  • __namedParameters: { id: string }

  Returns Promise<{ ok: true; value: void } | { error: TatumAlertDeleteError; ok: false }>

listAlerts

• listAlerts(
      __namedParameters: { cursor?: string; pageSize: number },
  ): Promise<
      | { error: TatumError; ok: false }
      | {
          ok: true;
          value: {
              cursor: string | null;
              ids: string[];
              items: {
                  address: string;
                  id: string;
                  network: TatumNetwork | null;
                  url: string;
              }[];
          };
      },
  >

  One page of address alerts, newest first. network is null for a chain this client no longer serves (an EVM alert from before ENG-3919), so the mirror can still delete it. offset counts items, unlike the v4 data endpoints. The cursor follows the unfiltered page, so it pages on.

  Parameters

  • __namedParameters: { cursor?: string; pageSize: number }

  Returns Promise<
      | { error: TatumError; ok: false }
      | {
          ok: true;
          value: {
              cursor: string | null;
              ids: string[];
              items: {
                  address: string;
                  id: string;
                  network: TatumNetwork | null;
                  url: string;
              }[];
          };
      },
  >

transaction

• transaction(
      query: TransactionQuery,
  ): Promise<
      | { error: TatumError; ok: false }
      | { ok: true; value: TatumTransaction | null },
  >

  The Bitcoin or Tron transaction by hash, or null while it is unknown or not yet in a block.

  Parameters

  • query: TransactionQuery

  Returns Promise<
      | { error: TatumError; ok: false }
      | { ok: true; value: TatumTransaction | null },
  >

tronHistory

• tronHistory(
      __namedParameters: {
          address: string;
          cursor?: string;
          kind: "trx" | "trc20";
      },
  ): Promise<
      | { error: TatumError; ok: false }
      | {
          ok: true;
          value: { cursor: string | null; items: TatumTronHistoryItem[] };
      },
  >

  200 confirmed TRX or TRC-20 transactions per page, paged by Tatum's next cursor.

  Parameters

  • __namedParameters: { address: string; cursor?: string; kind: "trx" | "trc20" }

  Returns Promise<
      | { error: TatumError; ok: false }
      | {
          ok: true;
          value: { cursor: string | null; items: TatumTronHistoryItem[] };
      },
  >