@avalanche-sdk/client/dist/clients/createPChainClient.d.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 { Account, Address, Chain, ParseAccount, Prettify, RpcSchema, Transport } from "viem";
import { PChainRpcSchema } from "../methods/pChain/pChainRpcSchema.js";
import { AvalancheCoreClient, CreateAvalancheCoreClientErrorType } from "./createAvalancheCoreClient.js";
import { PChainActions } from "./decorators/pChain.js";
import { AvalancheClientConfig } from "./types/createAvalancheClient.js";
export type PChainClientConfig<transport extends Transport, chain extends Chain | undefined = Chain | undefined, accountOrAddress extends Account | Address | undefined = undefined, rpcSchema extends RpcSchema | undefined = undefined, raw extends boolean = false> = Prettify<AvalancheClientConfig<transport, chain, accountOrAddress, rpcSchema, raw>>;
export type PChainClient<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, accountOrAddress extends Account | undefined = undefined, rpcSchema extends RpcSchema | undefined = undefined> = Prettify<AvalancheCoreClient<transport, chain, accountOrAddress, rpcSchema extends RpcSchema ? [...PChainRpcSchema, ...rpcSchema] : PChainRpcSchema, PChainActions>>;
export type CreatePChainClientErrorType = CreateAvalancheCoreClientErrorType;
/**
 * Creates a P-Chain (Platform Chain) Client with a given transport configured for a Chain.
 *
 * The P-Chain Client is an interface to interact with the Avalanche Platform Chain through JSON-RPC API methods.
 * The Platform Chain is responsible for:
 * - Coordinating validators
 * - Managing subnets
 * - Creating and managing blockchains
 * - Handling staking operations
 *
 * @param parameters - {@link PChainClientConfig}
 * @returns A P-Chain Client. {@link PChainClient}
 *
 * @example
 * ```ts
 * import { createPChainClient} from '@avalanche-sdk/client'
 * import { avalanche } from '@avalanche-sdk/client/chains'
 *
 * const client = createPChainClient({
 *   chain: avalanche,
 *   transport: {
 *     type: "http",
 *   },
 * })
 *
 * // Get the current validators
 * const validators = await client.getCurrentValidators({})
 *
 * // Get subnet information
 * const subnet = await client.getSubnet({ subnetID: 'subnet-id' })
 * ```
 */
export declare function createPChainClient<transport extends Transport, chain extends Chain | undefined = undefined, accountOrAddress extends Account | Address | undefined = undefined, rpcSchema extends RpcSchema | undefined = undefined, raw extends boolean = false>(parameters: PChainClientConfig<transport, chain, accountOrAddress, rpcSchema, raw>): PChainClient<transport, chain, ParseAccount<accountOrAddress>, rpcSchema>;
//# sourceMappingURL=createPChainClient.d.ts.map