@avalanche-sdk/client/src/methods/xChain/getUTXOs.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 { Chain, Transport } from "viem";
import {
  AvalancheCoreClient,
  AvalancheCoreClient as Client,
} from "../../clients/createAvalancheCoreClient.js";
import { GetUTXOsParameters, GetUTXOsReturnType } from "./types/getUTXOs.js";
import { XChainRpcSchema } from "./xChainRpcSchema.js";

/**
 * Get the UTXOs for a set of addresses.
 *
 * - Docs: https://build.avax.network/docs/api-reference/x-chain/api#avmgetutxos
 *
 * @param client - The client to use. {@link AvalancheCoreClient}
 * @param params - The addresses and source chain. {@link GetUTXOsParameters}
 * @returns The UTXOs. {@link GetUTXOsReturnType}
 *
 * @example
 * ```ts
 * import { createAvalancheCoreClient } from '@avalanche-sdk/client'
 * import { avalanche } from '@avalanche-sdk/client/chains'
 * import { getUTXOs } from '@avalanche-sdk/client/methods/xChain'
 *
 * const client = createAvalancheCoreClient({
 *   chain: avalanche,
 *   transport: {
 *     type: "http",
 *     url: "<url>",
 *   },
 * })
 *
 * const utxos = await getUTXOs(client, {
 *   addresses: ["X-avax1wstkjcj4z8n0n6utxmcxap6mn9nrdz5k0v3fjh"],
 *   sourceChain: "X"
 * })
 * ```
 */
export async function getUTXOs<chain extends Chain | undefined>(
  client: Client<Transport, chain>,
  params: GetUTXOsParameters
): Promise<GetUTXOsReturnType> {
  return client.request<
    XChainRpcSchema,
    {
      method: "avm.getUTXOs";
      params: GetUTXOsParameters;
    },
    GetUTXOsReturnType
  >({
    method: "avm.getUTXOs",
    params,
  });
}