UNPKG

@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

30 lines 1.05 kB
import { Chain, Transport } from "viem"; import { AvalancheCoreClient as Client } from "../../clients/createAvalancheCoreClient.js"; import { GetHeightReturnType } from "./types/getHeight.js"; /** * Get the height of the blockchain. * * - Docs: https://build.avax.network/docs/api-reference/x-chain/api#avmgetheight * * @param client - The client to use. {@link AvalancheCoreClient} * @returns The height of the blockchain. {@link GetHeightReturnType} * * @example * ```ts * import { createAvalancheCoreClient } from '@avalanche-sdk/client' * import { avalanche } from '@avalanche-sdk/client/chains' * import { getHeight } from '@avalanche-sdk/client/methods/xChain' * * const client = createAvalancheCoreClient({ * chain: avalanche, * transport: { * type: "http", * url: "<url>", * }, * }) * * const height = await getHeight(client) * ``` */ export declare function getHeight<chain extends Chain | undefined>(client: Client<Transport, chain>): Promise<GetHeightReturnType>; //# sourceMappingURL=getHeight.d.ts.map