@psalomo/jsonrpc-client 1.1.0 → 1.3.0

package/dist/convenience-5WSFl5pu.d.mts

@@ -0,0 +1,440 @@
+import { RpcStateChangesInBlockByTypeRequest, RpcStateChangesInBlockResponse, RpcStateChangesInBlockRequest, RpcStateChangesInBlockByTypeResponse, RpcCongestionLevelRequest, RpcCongestionLevelResponse, GenesisConfigRequest, GenesisConfig, RpcLightClientBlockProofRequest, RpcLightClientBlockProofResponse, RpcLightClientExecutionProofRequest, RpcLightClientExecutionProofResponse, RpcMaintenanceWindowsRequest, EXPERIMENTALMaintenanceWindowsResponse, RpcProtocolConfigRequest, RpcProtocolConfigResponse, RpcReceiptRequest, RpcReceiptResponse, RpcSplitStorageInfoRequest, RpcSplitStorageInfoResponse, RpcTransactionStatusRequest, RpcTransactionResponse, RpcValidatorsOrderedRequest, EXPERIMENTALValidatorsOrderedResponse, RpcBlockRequest, RpcBlockResponse, RpcSendTransactionRequest, CryptoHash, RpcChunkRequest, RpcChunkResponse, RpcClientConfigRequest, RpcClientConfigResponse, RpcGasPriceRequest, RpcGasPriceResponse, RpcHealthRequest, RpcHealthResponse, MaintenanceWindowsResponse, RpcNetworkInfoRequest, RpcNetworkInfoResponse, RpcLightClientNextBlockRequest, RpcLightClientNextBlockResponse, RpcQueryRequest, RpcQueryResponse, RpcStatusRequest, RpcStatusResponse, RpcValidatorRequest, RpcValidatorResponse, AccountView, CallResult, AccessKeyView } from '@psalomo/jsonrpc-types';
+
+interface ValidationResult {
+    validateRequest: (request: JsonRpcRequest) => void;
+    validateResponse: (response: JsonRpcResponse) => void;
+    validateMethodRequest?: (method: string, request: JsonRpcRequest) => void;
+    validateMethodResponse?: (method: string, response: JsonRpcResponse) => void;
+}
+/**
+ * Enable validation for the client
+ * This function should only be called if you want to include schema validation
+ * Calling this function will include Zod schemas in your bundle
+ */
+declare function enableValidation(): ValidationResult;
+
+interface ClientConfig {
+    endpoint: string;
+    headers?: Record<string, string>;
+    timeout?: number;
+    retries?: number;
+    validation?: ValidationResult;
+}
+interface JsonRpcRequest<T = unknown> {
+    jsonrpc: '2.0';
+    id: string;
+    method: string;
+    params?: T;
+}
+interface JsonRpcResponse<T = unknown> {
+    jsonrpc: '2.0';
+    id: string;
+    result?: T;
+    error?: JsonRpcError;
+}
+interface JsonRpcError {
+    code: number;
+    message: string;
+    data?: unknown;
+}
+declare class JsonRpcClientError extends Error {
+    code?: number | undefined;
+    data?: unknown | undefined;
+    constructor(message: string, code?: number | undefined, data?: unknown | undefined);
+}
+declare class JsonRpcNetworkError extends Error {
+    originalError?: Error | undefined;
+    responseBody?: unknown | undefined;
+    constructor(message: string, originalError?: Error | undefined, responseBody?: unknown | undefined);
+}
+/**
+ * NEAR RPC Client with static function architecture
+ * This client only holds configuration and provides a makeRequest method
+ * Individual RPC methods are provided as standalone functions that take this client as a parameter
+ */
+declare class NearRpcClient {
+    readonly endpoint: string;
+    readonly headers: Record<string, string>;
+    readonly timeout: number;
+    readonly retries: number;
+    private readonly validation;
+    constructor(config: string | ClientConfig);
+    /**
+     * Make a raw JSON-RPC request
+     * This is used internally by the standalone RPC functions
+     */
+    makeRequest<TParams = unknown, TResult = unknown>(method: string, params?: TParams): Promise<TResult>;
+    /**
+     * Create a new client with modified configuration
+     */
+    withConfig(config: Partial<ClientConfig>): NearRpcClient;
+}
+declare const defaultClient: NearRpcClient;
+
+interface RpcRequest {
+    jsonrpc: '2.0';
+    id: string | number;
+    method: string;
+    params: unknown;
+}
+interface RpcResponse<T = unknown> {
+    jsonrpc: '2.0';
+    id: string | number;
+    result?: T;
+    error?: RpcError;
+}
+interface RpcError {
+    code: number;
+    message: string;
+    data?: unknown;
+}
+declare class NearRpcError extends Error {
+    code: number;
+    data?: unknown | undefined;
+    constructor(code: number, message: string, data?: unknown | undefined);
+}
+
+interface DynamicRpcMethods {
+    /**
+     * [Deprecated] Returns changes for a given account, contract or contract code
+     * for given block height or hash. Consider using changes instead.
+     */
+    experimentalChanges(params?: RpcStateChangesInBlockByTypeRequest): Promise<RpcStateChangesInBlockResponse>;
+    /**
+     * [Deprecated] Returns changes in block for given block height or hash over
+     * all transactions for all the types. Includes changes like account_touched,
+     * access_key_touched, data_touched, contract_code_touched. Consider using
+     * block_effects instead
+     */
+    experimentalChangesInBlock(params?: RpcStateChangesInBlockRequest): Promise<RpcStateChangesInBlockByTypeResponse>;
+    /**
+     * Queries the congestion level of a shard. More info about congestion
+     * [here](https://near.github.io/nearcore/architecture/how/receipt-congestion.html?highlight=congestion#receipt-congestion)
+     */
+    experimentalCongestionLevel(params?: RpcCongestionLevelRequest): Promise<RpcCongestionLevelResponse>;
+    /**
+     * [Deprecated] Get initial state and parameters for the genesis block.
+     * Consider genesis_config instead.
+     */
+    experimentalGenesisConfig(params?: GenesisConfigRequest): Promise<GenesisConfig>;
+    /** Returns the proofs for a transaction execution. */
+    experimentalLightClientBlockProof(params?: RpcLightClientBlockProofRequest): Promise<RpcLightClientBlockProofResponse>;
+    /** Returns the proofs for a transaction execution. */
+    experimentalLightClientProof(params?: RpcLightClientExecutionProofRequest): Promise<RpcLightClientExecutionProofResponse>;
+    /**
+     * [Deprecated] Returns the future windows for maintenance in current epoch
+     * for the specified account. In the maintenance windows, the node will not be
+     * block producer or chunk producer. Consider using maintenance_windows
+     * instead.
+     */
+    experimentalMaintenanceWindows(params?: RpcMaintenanceWindowsRequest): Promise<EXPERIMENTALMaintenanceWindowsResponse>;
+    /**
+     * A configuration that defines the protocol-level parameters such as
+     * gas/storage costs, limits, feature flags, other settings
+     */
+    experimentalProtocolConfig(params?: RpcProtocolConfigRequest): Promise<RpcProtocolConfigResponse>;
+    /** Fetches a receipt by its ID (as is, without a status or execution outcome) */
+    experimentalReceipt(params?: RpcReceiptRequest): Promise<RpcReceiptResponse>;
+    /**
+     * Contains the split storage information. More info on split storage
+     * [here](https://near-nodes.io/archival/split-storage-archival)
+     */
+    experimentalSplitStorageInfo(params?: RpcSplitStorageInfoRequest): Promise<RpcSplitStorageInfoResponse>;
+    /**
+     * Queries status of a transaction by hash, returning the final transaction
+     * result and details of all receipts.
+     */
+    experimentalTxStatus(params?: RpcTransactionStatusRequest): Promise<RpcTransactionResponse>;
+    /**
+     * Returns the current epoch validators ordered in the block producer order
+     * with repetition. This endpoint is solely used for bridge currently and is
+     * not intended for other external use cases.
+     */
+    experimentalValidatorsOrdered(params?: RpcValidatorsOrderedRequest): Promise<EXPERIMENTALValidatorsOrderedResponse>;
+    /** Returns block details for given height or hash */
+    block(params?: RpcBlockRequest): Promise<RpcBlockResponse>;
+    /**
+     * Returns changes in block for given block height or hash over all
+     * transactions for all the types. Includes changes like account_touched,
+     * access_key_touched, data_touched, contract_code_touched.
+     */
+    blockEffects(params?: RpcStateChangesInBlockRequest): Promise<RpcStateChangesInBlockByTypeResponse>;
+    /**
+     * [Deprecated] Sends a transaction and immediately returns transaction hash.
+     * Consider using send_tx instead.
+     */
+    broadcastTxAsync(params?: RpcSendTransactionRequest): Promise<CryptoHash>;
+    /**
+     * [Deprecated] Sends a transaction and waits until transaction is fully
+     * complete. (Has a 10 second timeout). Consider using send_tx instead.
+     */
+    broadcastTxCommit(params?: RpcSendTransactionRequest): Promise<RpcTransactionResponse>;
+    /**
+     * Returns changes for a given account, contract or contract code for given
+     * block height or hash.
+     */
+    changes(params?: RpcStateChangesInBlockByTypeRequest): Promise<RpcStateChangesInBlockResponse>;
+    /**
+     * Returns details of a specific chunk. You can run a block details query to
+     * get a valid chunk hash.
+     */
+    chunk(params?: RpcChunkRequest): Promise<RpcChunkResponse>;
+    /** Queries client node configuration */
+    clientConfig(params?: RpcClientConfigRequest): Promise<RpcClientConfigResponse>;
+    /**
+     * Returns gas price for a specific block_height or block_hash. Using [null]
+     * will return the most recent block's gas price.
+     */
+    gasPrice(params?: RpcGasPriceRequest): Promise<RpcGasPriceResponse>;
+    /** Get initial state and parameters for the genesis block */
+    genesisConfig(params?: GenesisConfigRequest): Promise<GenesisConfig>;
+    /** Returns the current health status of the RPC node the client connects to. */
+    health(params?: RpcHealthRequest): Promise<RpcHealthResponse>;
+    /** Returns the proofs for a transaction execution. */
+    lightClientProof(params?: RpcLightClientExecutionProofRequest): Promise<RpcLightClientExecutionProofResponse>;
+    /**
+     * Returns the future windows for maintenance in current epoch for the
+     * specified account. In the maintenance windows, the node will not be block
+     * producer or chunk producer.
+     */
+    maintenanceWindows(params?: RpcMaintenanceWindowsRequest): Promise<MaintenanceWindowsResponse>;
+    /**
+     * Queries the current state of node network connections. This includes
+     * information about active peers, transmitted data, known producers, etc.
+     */
+    networkInfo(params?: RpcNetworkInfoRequest): Promise<RpcNetworkInfoResponse>;
+    /** Returns the next light client block. */
+    nextLightClientBlock(params?: RpcLightClientNextBlockRequest): Promise<RpcLightClientNextBlockResponse>;
+    /**
+     * This module allows you to make generic requests to the network. The
+     * `RpcQueryRequest` struct takes in a
+     * [`BlockReference`](https://docs.rs/near-primitives/0.12.0/near_primitives/types/enum.BlockReference.html)
+     * and a
+     * [`QueryRequest`](https://docs.rs/near-primitives/0.12.0/near_primitives/views/enum.QueryRequest.html).
+     * The `BlockReference` enum allows you to specify a block by `Finality`,
+     * `BlockId` or `SyncCheckpoint`. The `QueryRequest` enum provides multiple
+     * variants for performing the following actions: - View an account's details
+     * - View a contract's code - View the state of an account - View the
+     * `AccessKey` of an account - View the `AccessKeyList` of an account - Call a
+     * function in a contract deployed on the network.
+     */
+    query(params?: RpcQueryRequest): Promise<RpcQueryResponse>;
+    /**
+     * Sends transaction. Returns the guaranteed execution status and the results
+     * the blockchain can provide at the moment.
+     */
+    sendTx(params?: RpcSendTransactionRequest): Promise<RpcTransactionResponse>;
+    /**
+     * Requests the status of the connected RPC node. This includes information
+     * about sync status, nearcore node version, protocol version, the current set
+     * of validators, etc.
+     */
+    status(params?: RpcStatusRequest): Promise<RpcStatusResponse>;
+    /**
+     * Queries status of a transaction by hash and returns the final transaction
+     * result.
+     */
+    tx(params?: RpcTransactionStatusRequest): Promise<RpcTransactionResponse>;
+    /**
+     * Queries active validators on the network. Returns details and the state of
+     * validation on the blockchain.
+     */
+    validators(params?: RpcValidatorRequest): Promise<RpcValidatorResponse>;
+}
+interface ConvenienceMethods {
+    viewAccount(params: {
+        accountId: string;
+        finality?: 'final' | 'near-final' | 'optimistic';
+        blockId?: string | number;
+    }): Promise<AccountView>;
+    viewFunction(params: {
+        accountId: string;
+        methodName: string;
+        argsBase64?: string;
+        finality?: 'final' | 'near-final' | 'optimistic';
+        blockId?: string | number;
+    }): Promise<CallResult>;
+    viewAccessKey(params: {
+        accountId: string;
+        publicKey: string;
+        finality?: 'final' | 'near-final' | 'optimistic';
+        blockId?: string | number;
+    }): Promise<AccessKeyView>;
+}
+interface CompleteClientInterface extends DynamicRpcMethods, ConvenienceMethods {
+    call<TParams = unknown, TResult = unknown>(method: string, params?: TParams): Promise<TResult>;
+}
+/**
+ * [Deprecated] Returns changes for a given account, contract or contract code
+ * for given block height or hash. Consider using changes instead.
+ */
+declare function experimentalChanges(client: NearRpcClient, params?: RpcStateChangesInBlockByTypeRequest): Promise<RpcStateChangesInBlockResponse>;
+/**
+ * [Deprecated] Returns changes in block for given block height or hash over
+ * all transactions for all the types. Includes changes like account_touched,
+ * access_key_touched, data_touched, contract_code_touched. Consider using
+ * block_effects instead
+ */
+declare function experimentalChangesInBlock(client: NearRpcClient, params?: RpcStateChangesInBlockRequest): Promise<RpcStateChangesInBlockByTypeResponse>;
+/**
+ * Queries the congestion level of a shard. More info about congestion
+ * [here](https://near.github.io/nearcore/architecture/how/receipt-congestion.html?highlight=congestion#receipt-congestion)
+ */
+declare function experimentalCongestionLevel(client: NearRpcClient, params?: RpcCongestionLevelRequest): Promise<RpcCongestionLevelResponse>;
+/**
+ * [Deprecated] Get initial state and parameters for the genesis block.
+ * Consider genesis_config instead.
+ */
+declare function experimentalGenesisConfig(client: NearRpcClient, params?: GenesisConfigRequest): Promise<GenesisConfig>;
+/** Returns the proofs for a transaction execution. */
+declare function experimentalLightClientBlockProof(client: NearRpcClient, params?: RpcLightClientBlockProofRequest): Promise<RpcLightClientBlockProofResponse>;
+/** Returns the proofs for a transaction execution. */
+declare function experimentalLightClientProof(client: NearRpcClient, params?: RpcLightClientExecutionProofRequest): Promise<RpcLightClientExecutionProofResponse>;
+/**
+ * [Deprecated] Returns the future windows for maintenance in current epoch
+ * for the specified account. In the maintenance windows, the node will not be
+ * block producer or chunk producer. Consider using maintenance_windows
+ * instead.
+ */
+declare function experimentalMaintenanceWindows(client: NearRpcClient, params?: RpcMaintenanceWindowsRequest): Promise<EXPERIMENTALMaintenanceWindowsResponse>;
+/**
+ * A configuration that defines the protocol-level parameters such as
+ * gas/storage costs, limits, feature flags, other settings
+ */
+declare function experimentalProtocolConfig(client: NearRpcClient, params?: RpcProtocolConfigRequest): Promise<RpcProtocolConfigResponse>;
+/** Fetches a receipt by its ID (as is, without a status or execution outcome) */
+declare function experimentalReceipt(client: NearRpcClient, params?: RpcReceiptRequest): Promise<RpcReceiptResponse>;
+/**
+ * Contains the split storage information. More info on split storage
+ * [here](https://near-nodes.io/archival/split-storage-archival)
+ */
+declare function experimentalSplitStorageInfo(client: NearRpcClient, params?: RpcSplitStorageInfoRequest): Promise<RpcSplitStorageInfoResponse>;
+/**
+ * Queries status of a transaction by hash, returning the final transaction
+ * result and details of all receipts.
+ */
+declare function experimentalTxStatus(client: NearRpcClient, params?: RpcTransactionStatusRequest): Promise<RpcTransactionResponse>;
+/**
+ * Returns the current epoch validators ordered in the block producer order
+ * with repetition. This endpoint is solely used for bridge currently and is
+ * not intended for other external use cases.
+ */
+declare function experimentalValidatorsOrdered(client: NearRpcClient, params?: RpcValidatorsOrderedRequest): Promise<EXPERIMENTALValidatorsOrderedResponse>;
+/** Returns block details for given height or hash */
+declare function block(client: NearRpcClient, params?: RpcBlockRequest): Promise<RpcBlockResponse>;
+/**
+ * Returns changes in block for given block height or hash over all
+ * transactions for all the types. Includes changes like account_touched,
+ * access_key_touched, data_touched, contract_code_touched.
+ */
+declare function blockEffects(client: NearRpcClient, params?: RpcStateChangesInBlockRequest): Promise<RpcStateChangesInBlockByTypeResponse>;
+/**
+ * [Deprecated] Sends a transaction and immediately returns transaction hash.
+ * Consider using send_tx instead.
+ */
+declare function broadcastTxAsync(client: NearRpcClient, params?: RpcSendTransactionRequest): Promise<CryptoHash>;
+/**
+ * [Deprecated] Sends a transaction and waits until transaction is fully
+ * complete. (Has a 10 second timeout). Consider using send_tx instead.
+ */
+declare function broadcastTxCommit(client: NearRpcClient, params?: RpcSendTransactionRequest): Promise<RpcTransactionResponse>;
+/**
+ * Returns changes for a given account, contract or contract code for given
+ * block height or hash.
+ */
+declare function changes(client: NearRpcClient, params?: RpcStateChangesInBlockByTypeRequest): Promise<RpcStateChangesInBlockResponse>;
+/**
+ * Returns details of a specific chunk. You can run a block details query to
+ * get a valid chunk hash.
+ */
+declare function chunk(client: NearRpcClient, params?: RpcChunkRequest): Promise<RpcChunkResponse>;
+/** Queries client node configuration */
+declare function clientConfig(client: NearRpcClient, params?: RpcClientConfigRequest): Promise<RpcClientConfigResponse>;
+/**
+ * Returns gas price for a specific block_height or block_hash. Using [null]
+ * will return the most recent block's gas price.
+ */
+declare function gasPrice(client: NearRpcClient, params?: RpcGasPriceRequest): Promise<RpcGasPriceResponse>;
+/** Get initial state and parameters for the genesis block */
+declare function genesisConfig(client: NearRpcClient, params?: GenesisConfigRequest): Promise<GenesisConfig>;
+/** Returns the current health status of the RPC node the client connects to. */
+declare function health(client: NearRpcClient, params?: RpcHealthRequest): Promise<RpcHealthResponse>;
+/** Returns the proofs for a transaction execution. */
+declare function lightClientProof(client: NearRpcClient, params?: RpcLightClientExecutionProofRequest): Promise<RpcLightClientExecutionProofResponse>;
+/**
+ * Returns the future windows for maintenance in current epoch for the
+ * specified account. In the maintenance windows, the node will not be block
+ * producer or chunk producer.
+ */
+declare function maintenanceWindows(client: NearRpcClient, params?: RpcMaintenanceWindowsRequest): Promise<MaintenanceWindowsResponse>;
+/**
+ * Queries the current state of node network connections. This includes
+ * information about active peers, transmitted data, known producers, etc.
+ */
+declare function networkInfo(client: NearRpcClient, params?: RpcNetworkInfoRequest): Promise<RpcNetworkInfoResponse>;
+/** Returns the next light client block. */
+declare function nextLightClientBlock(client: NearRpcClient, params?: RpcLightClientNextBlockRequest): Promise<RpcLightClientNextBlockResponse>;
+/**
+ * This module allows you to make generic requests to the network. The
+ * `RpcQueryRequest` struct takes in a
+ * [`BlockReference`](https://docs.rs/near-primitives/0.12.0/near_primitives/types/enum.BlockReference.html)
+ * and a
+ * [`QueryRequest`](https://docs.rs/near-primitives/0.12.0/near_primitives/views/enum.QueryRequest.html).
+ * The `BlockReference` enum allows you to specify a block by `Finality`,
+ * `BlockId` or `SyncCheckpoint`. The `QueryRequest` enum provides multiple
+ * variants for performing the following actions: - View an account's details
+ * - View a contract's code - View the state of an account - View the
+ * `AccessKey` of an account - View the `AccessKeyList` of an account - Call a
+ * function in a contract deployed on the network.
+ */
+declare function query(client: NearRpcClient, params?: RpcQueryRequest): Promise<RpcQueryResponse>;
+/**
+ * Sends transaction. Returns the guaranteed execution status and the results
+ * the blockchain can provide at the moment.
+ */
+declare function sendTx(client: NearRpcClient, params?: RpcSendTransactionRequest): Promise<RpcTransactionResponse>;
+/**
+ * Requests the status of the connected RPC node. This includes information
+ * about sync status, nearcore node version, protocol version, the current set
+ * of validators, etc.
+ */
+declare function status(client: NearRpcClient, params?: RpcStatusRequest): Promise<RpcStatusResponse>;
+/**
+ * Queries status of a transaction by hash and returns the final transaction
+ * result.
+ */
+declare function tx(client: NearRpcClient, params?: RpcTransactionStatusRequest): Promise<RpcTransactionResponse>;
+/**
+ * Queries active validators on the network. Returns details and the state of
+ * validation on the blockchain.
+ */
+declare function validators(client: NearRpcClient, params?: RpcValidatorRequest): Promise<RpcValidatorResponse>;
+
+declare function viewAccount(client: NearRpcClient, params: {
+    accountId: string;
+    finality?: 'final' | 'near-final' | 'optimistic';
+    blockId?: string | number;
+}): Promise<AccountView>;
+declare function viewFunction(client: NearRpcClient, params: {
+    accountId: string;
+    methodName: string;
+    argsBase64?: string;
+    finality?: 'final' | 'near-final' | 'optimistic';
+    blockId?: string | number;
+}): Promise<CallResult>;
+declare function viewAccessKey(client: NearRpcClient, params: {
+    accountId: string;
+    publicKey: string;
+    finality?: 'final' | 'near-final' | 'optimistic';
+    blockId?: string | number;
+}): Promise<AccessKeyView>;
+declare function parseCallResultToJson<T = unknown>(callResult: CallResult): T;
+declare function viewFunctionAsJson<T = unknown>(client: NearRpcClient, params: {
+    accountId: string;
+    methodName: string;
+    argsBase64?: string;
+    finality?: 'final' | 'near-final' | 'optimistic';
+    blockId?: string | number;
+}): Promise<T>;
+
+export { blockEffects as A, broadcastTxAsync as B, type ConvenienceMethods as C, type DynamicRpcMethods as D, broadcastTxCommit as E, changes as F, chunk as G, clientConfig as H, gasPrice as I, type JsonRpcRequest as J, genesisConfig as K, health as L, lightClientProof as M, NearRpcClient as N, maintenanceWindows as O, networkInfo as P, nextLightClientBlock as Q, type RpcRequest as R, query as S, sendTx as T, status as U, tx as V, validators as W, viewAccount as X, viewFunction as Y, viewAccessKey as Z, type CompleteClientInterface as a, type ClientConfig as b, type JsonRpcResponse as c, defaultClient as d, enableValidation as e, type JsonRpcError as f, JsonRpcClientError as g, JsonRpcNetworkError as h, type RpcResponse as i, type RpcError as j, NearRpcError as k, experimentalChanges as l, experimentalChangesInBlock as m, experimentalCongestionLevel as n, experimentalGenesisConfig as o, parseCallResultToJson as p, experimentalLightClientBlockProof as q, experimentalLightClientProof as r, experimentalMaintenanceWindows as s, experimentalProtocolConfig as t, experimentalReceipt as u, viewFunctionAsJson as v, experimentalSplitStorageInfo as w, experimentalTxStatus as x, experimentalValidatorsOrdered as y, block as z };