@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.38 kB
TypeScript
import { Chain, Transport } from "viem";
import { AvalancheCoreClient as Client } from "../../clients/createAvalancheCoreClient.js";
import { ReadinessParameters, ReadinessReturnType } from "./types/readiness.js";
/**
* Returns the last evaluation of the startup health check results.
* This indicates if the node has finished initializing and is ready to handle requests.
*
* - Docs: https://build.avax.network/docs/api-reference/health-api#healthreadiness
*
* @param client - The client to use. {@link AvalancheCoreClient}
* @param params - Optional tags to filter readiness checks. {@link ReadinessParameters}
* @returns The readiness check results. {@link ReadinessReturnType}
*
* @example
* ```ts
* import { createAvalancheCoreClient } from '@avalanche-sdk/client'
* import { avalanche } from '@avalanche-sdk/client/chains'
* import { readiness } from '@avalanche-sdk/client/methods/health'
*
* const client = createAvalancheCoreClient({
* chain: avalanche,
* transport: {
* type: "http",
* url: "<url>",
* },
* })
*
* const readinessStatus = await readiness(client, {
* tags: ["11111111111111111111111111111111LpoYY"]
* })
* ```
*/
export declare function readiness<chain extends Chain | undefined>(client: Client<Transport, chain>, params: ReadinessParameters): Promise<ReadinessReturnType>;
//# sourceMappingURL=readiness.d.ts.map