@avalanche-sdk/client/src/methods/pChain/getL1Validator.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 {
  GetL1ValidatorParameters,
  GetL1ValidatorReturnType,
} from "./types/getL1Validator.js";

/**
 * Get the L1 validator information.
 *
 * - Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetl1validator
 *
 * @param client - The client to use. {@link AvalancheCoreClient}
 * @param params - The validator node ID {@link GetL1ValidatorParameters}
 * @returns The L1 validator information. {@link GetL1ValidatorReturnType}
 *
 * @example
 * ```ts
 * import { createAvalancheCoreClient } from '@avalanche-sdk/client'
 * import { avalanche } from '@avalanche-sdk/client/chains'
 * import { getL1Validator } from '@avalanche-sdk/client/methods/pChain'
 *
 * const client = createAvalancheCoreClient({
 *   chain: avalanche,
 *   transport: {
 *     type: "http",
 *     url: "<url>",
 *   },
 * })
 *
 * const validator = await getL1Validator(client, {
 *   nodeID: "NodeID-111111111111111111111111111111111111111"
 * })
 * ```
 */
export async function getL1Validator<chain extends Chain | undefined>(
  client: Client<Transport, chain>,
  params: GetL1ValidatorParameters
): Promise<GetL1ValidatorReturnType> {
  const l1Validator = await client.request<
    PChainRpcSchema,
    {
      method: "platform.getL1Validator";
      params: GetL1ValidatorParameters;
    },
    GetL1ValidatorReturnType
  >({
    method: "platform.getL1Validator",
    params,
  });

  return {
    ...l1Validator,
    startTime: BigInt(l1Validator.startTime),
    weight: BigInt(l1Validator.weight),
    ...(l1Validator.minNonce && { minNonce: BigInt(l1Validator.minNonce) }),
    ...(l1Validator.balance && { balance: BigInt(l1Validator.balance) }),
    ...(l1Validator.height && { height: BigInt(l1Validator.height) }),
  };
}