@avalanche-sdk/client/src/methods/pChain/getBlockchainStatus.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 { Chain, Transport } from "viem";
import {
  AvalancheCoreClient,
  AvalancheCoreClient as Client,
} from "../../clients/createAvalancheCoreClient.js";
import { PChainRpcSchema } from "./pChainRpcSchema.js";
import {
  GetBlockchainStatusParameters,
  GetBlockchainStatusReturnType,
} from "./types/getBlockchainStatus.js";

/**
 * Get the status of a blockchain.
 *
 * - Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetblockchainstatus
 *
 * @param client - The client to use to make the request {@link AvalancheCoreClient}
 * @param params - The blockchain ID {@link GetBlockchainStatusParameters}
 * @returns The blockchain status. {@link GetBlockchainStatusReturnType}
 *
 * @example
 * ```ts
 * import { createAvalancheCoreClient } from '@avalanche-sdk/client'
 * import { avalanche } from '@avalanche-sdk/client/chains'
 * import { getBlockchainStatus } from '@avalanche-sdk/client/methods/pChain'
 *
 * const client = createAvalancheCoreClient({
 *   chain: avalanche,
 *   transport: {
 *     type: "http",
 *     url: "<url>",
 *   },
 * })
 *
 * const status = await getBlockchainStatus(client, {
 *   blockchainID: "11111111111111111111111111111111LpoYY"
 * })
 * ```
 */
export async function getBlockchainStatus<chain extends Chain | undefined>(
  client: Client<Transport, chain>,
  params: GetBlockchainStatusParameters
): Promise<GetBlockchainStatusReturnType> {
  return client.request<
    PChainRpcSchema,
    {
      method: "platform.getBlockchainStatus";
      params: GetBlockchainStatusParameters;
    },
    GetBlockchainStatusReturnType
  >({
    method: "platform.getBlockchainStatus",
    params,
  });
}