@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.25 kB
TypeScript
import { Chain, Transport } from "viem";
import { AvalancheCoreClient as Client } from "../../clients/createAvalancheCoreClient.js";
import { GetIndexParameters, GetIndexReturnType } from "./types/getIndex.js";
/**
* Get the index of a container by its ID.
*
* - Docs: https://build.avax.network/docs/api-reference/index-api#indexgetindex
*
* @param client - The client to use. {@link AvalancheCoreClient}
* @param params - The container ID and encoding. {@link GetIndexParameters}
* @returns The container index. {@link GetIndexReturnType}
*
* @example
* ```ts
* import { createAvalancheCoreClient } from '@avalanche-sdk/client'
* import { avalanche } from '@avalanche-sdk/client/chains'
* import { getIndex } from '@avalanche-sdk/client/methods/index'
*
* const client = createAvalancheCoreClient({
* chain: avalanche,
* transport: {
* type: "http",
* url: "<url>",
* },
* })
*
* const index = await getIndex(client, {
* id: "6fXf5hncR8LXvwtM8iezFQBpK5cubV6y1dWgpJCcNyzGB1EzY",
* encoding: "hex"
* })
* ```
*/
export declare function getIndex<chain extends Chain | undefined>(client: Client<Transport, chain>, params: GetIndexParameters): Promise<GetIndexReturnType>;
//# sourceMappingURL=getIndex.d.ts.map