@avalanche-sdk/client/src/utils/getUtxosForAddress.ts

A TypeScript SDK for interacting with the Avalanche network through JSON-RPC APIs. This SDK provides a comprehensive set of tools to interact with all Avalanche chains (P-Chain, X-Chain, C-Chain) and various APIs, including wallet functionality for transa

import { Utxo } from "@avalabs/avalanchejs";
import { AvalancheWalletCoreClient } from "../clients/createAvalancheWalletCoreClient.js";
import { getUTXOs as getCChainUTXOs } from "../methods/cChain/getUTXOs.js";
import { getUTXOs as getPChainUTXOs } from "../methods/pChain/getUTXOs.js";
import { getUTXOs as getXChainUTXOs } from "../methods/xChain/getUTXOs.js";
import { GetUTXOsReturnType } from "../methods/xChain/types/getUTXOs.js";
import { getUtxoFromBytes } from "./getUtxoFromBytes.js";

export type GetUtxosForAddressParams = {
  address: string;
  chainAlias: "P" | "X" | "C";
  sourceChain?: string;
};

/**
 *  Get the UTXOs for an address.
 *
 * @param client - The client to use. {@link AvalancheWalletCoreClient}
 * @param params - The parameters. {@link GetUtxosForAddressParams}
 * @returns The array of UTXOs. May contain duplicates. {@link Utxo[]}
 *
 * @example
 * ```ts
 * import { createAvalancheWalletCoreClient } from "@avalanche-sdk/client";
 * import { avalanche } from "@avalanche-sdk/client/chains";
 *
 * const client = createAvalancheWalletCoreClient({
 *   chain: avalanche,
 *   transport: {
 *     type: "http",
 *   },
 * });
 *
 * const utxos = await getUtxosForAddress(client, {
 *   address: "0x1234567890123456789012345678901234567890",
 *   chainAlias: "P",
 * });
 * ```
 */
export async function getUtxosForAddress(
  client: AvalancheWalletCoreClient,
  params: {
    address: string;
    chainAlias: "P" | "X" | "C";
    sourceChain?: string;
  }
): Promise<Utxo[]> {
  // Get the correct UTXO function based on the chain alias
  const getUTXOs = (args: any) =>
    params.chainAlias === "P"
      ? getPChainUTXOs(client.pChainClient, args)
      : params.chainAlias === "X"
      ? getXChainUTXOs(client.xChainClient, args)
      : getCChainUTXOs(client.cChainClient, args);

  // Initialize the UTXOs array and start index
  const utxos: Utxo[] = [];

  // Initialize the start index and has more flag
  let startIndex:
    | {
        address: string;
        utxo: string;
      }
    | undefined = undefined;
  let hasMore = false;

  // Fetch UTXOs until there are no more
  do {
    const utxosRes = (await getUTXOs({
      addresses: [params.address],
      ...(params.sourceChain ? { sourceChain: params.sourceChain } : {}),
      ...(startIndex === undefined ? {} : { startIndex }),
    })) as GetUTXOsReturnType;

    utxos.push(
      ...utxosRes.utxos.map((utxo: string) =>
        getUtxoFromBytes(utxo, params.chainAlias)
      )
    );

    if (Number(utxosRes.numFetched) >= 1024) {
      hasMore = true;
      startIndex = {
        address: utxosRes.endIndex.address,
        utxo: utxosRes.endIndex.utxo,
      };
    } else {
      hasMore = false;
    }

    if (utxos.length >= 5000) {
      console.warn(
        "getUtxosForAddress: Reached max utxos limit. Returning partial results."
      );
      break;
    }
  } while (hasMore);

  return utxos;
}