@avalanche-sdk/client/src/methods/health/types/readiness.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 { RequestErrorType } from "viem/utils";

/**
 * Parameters for the `health.readiness` method.
 *
 * @property tags - Optional array of tags to filter readiness checks
 */
export type ReadinessParameters = {
  tags?: string[];
};

/**
 * Return type for the `health.readiness` method.
 *
 * @property checks - Object containing readiness check results for each component
 * @property healthy - Overall readiness status of the node
 */
export type ReadinessReturnType = {
  checks: {
    [key: string]: {
      message: {
        timestamp: string;
        duration: number;
        contiguousFailures: number;
        timeOfFirstFailure: string | null;
      };
      healthy: boolean;
    };
  };
  healthy: boolean;
};

export type ReadinessErrorType = RequestErrorType;

export type ReadinessMethod = {
  Method: "health.readiness";
  Parameters: ReadinessParameters;
  ReturnType: ReadinessReturnType;
};