@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
31 lines • 1.19 kB
TypeScript
import { Chain, Transport } from "viem";
import { AvalancheCoreClient as Client } from "../../clients/createAvalancheCoreClient.js";
import { LivenessReturnType } from "./types/liveness.js";
/**
* Returns a simple health check indicating if the node is alive and can handle requests.
* This is a lightweight check that always returns healthy if the endpoint is available.
*
* - Docs: https://build.avax.network/docs/api-reference/health-api#healthliveness
*
* @param client - The client to use. {@link AvalancheCoreClient}
* @returns The liveness check results. {@link LivenessReturnType}
*
* @example
* ```ts
* import { createAvalancheCoreClient } from '@avalanche-sdk/client'
* import { avalanche } from '@avalanche-sdk/client/chains'
* import { liveness } from '@avalanche-sdk/client/methods/health'
*
* const client = createAvalancheCoreClient({
* chain: avalanche,
* transport: {
* type: "http",
* url: "<url>",
* },
* })
*
* const livenessStatus = await liveness(client)
* ```
*/
export declare function liveness<chain extends Chain | undefined>(client: Client<Transport, chain>): Promise<LivenessReturnType>;
//# sourceMappingURL=liveness.d.ts.map