@avalanche-sdk/client/dist/methods/xChain/getBalance.d.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 as Client } from "../../clients/createAvalancheCoreClient.js";
import { GetBalanceParameters, GetBalanceReturnType } from "./types/getBalance.js";
/**
 * Get the balance of an asset controlled by given addresses.
 *
 * - Docs: https://build.avax.network/docs/api-reference/x-chain/api#avmgetbalance
 *
 * @param client - The client to use. {@link AvalancheCoreClient}
 * @param params - The addresses and asset ID. {@link GetBalanceParameters}
 * @returns The balance of the asset. {@link GetBalanceReturnType}
 *
 * @example
 * ```ts
 * import { createAvalancheCoreClient } from '@avalanche-sdk/client'
 * import { avalanche } from '@avalanche-sdk/client/chains'
 * import { getBalance } from '@avalanche-sdk/client/methods/xChain'
 *
 * const client = createAvalancheCoreClient({
 *   chain: avalanche,
 *   transport: {
 *     type: "http",
 *     url: "<url>",
 *   },
 * })
 *
 * const balance = await getBalance(client, {
 *   addresses: ["X-avax18jma8ppw3nhx5r4ap8clazz0dps7rv5ukulre5"],
 *   assetID: "FvwEAhmxKfeiG8SnEvq42hc6whRyY3EFYAvebMqDNDGCgxN5Z"
 * })
 * ```
 */
export declare function getBalance<chain extends Chain | undefined>(client: Client<Transport, chain>, params: GetBalanceParameters): Promise<GetBalanceReturnType>;
//# sourceMappingURL=getBalance.d.ts.map