@avalanche-sdk/client
Version:
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
34 lines • 1.24 kB
TypeScript
import { Chain, Transport } from "viem";
import { AvalancheCoreClient as Client } from "../../clients/createAvalancheCoreClient.js";
import { GetUTXOsParameters, GetUTXOsReturnType } from "./types/getUTXOs.js";
/**
* Get the UTXOs for a set of addresses.
*
* - Docs: https://build.avax.network/docs/api-reference/c-chain/api#avaxgetutxos
*
* @param client - The client to use. {@link AvalancheCoreClient}
* @param params - The parameters to use. {@link GetUTXOsParameters}
* @returns The UTXOs for a set of addresses. {@link GetUTXOsReturnType}
*
* @example
* ```ts
* import { createAvalancheCoreClient } from '@avalanche-sdk/client'
* import { avalanche } from '@avalanche-sdk/client/chains'
* import { getUTXOs } from '@avalanche-sdk/client/methods/cChain'
*
* const client = createAvalancheCoreClient({
* chain: avalanche,
* transport: {
* type: "http",
* url: "<url>",
* },
* })
*
* const utxos = await getUTXOs(client, {
* addresses: ["X-avax1...", "X-avax2..."],
* limit: 100
* })
* ```
*/
export declare function getUTXOs<chain extends Chain | undefined>(client: Client<Transport, chain>, params: GetUTXOsParameters): Promise<GetUTXOsReturnType>;
//# sourceMappingURL=getUTXOs.d.ts.map