@psalomo/jsonrpc-client 1.2.0 → 1.3.0

package/dist/browser-standalone.js

@@ -4890,132 +4890,215 @@ Object.entries(PATH_TO_METHOD_MAP).forEach(([path, method]) => {
 var RPC_METHODS = Object.values(PATH_TO_METHOD_MAP);
 
 // Auto-generated static RPC functions for tree-shaking
-// Generated at: 2025-07-31T19:21:47.589Z
+// Generated at: 2025-08-03T18:51:29.359Z
 // Total functions: 31
 //
 // This file is automatically generated by tools/codegen/generate-client-interface.ts
 // Do not edit manually - changes will be overwritten
-// EXPERIMENTAL_changes static function
+/**
+ * [Deprecated] Returns changes for a given account, contract or contract code
+ * for given block height or hash. Consider using changes instead.
+ */
 async function experimentalChanges$1(client, params) {
     return client.makeRequest('EXPERIMENTAL_changes', params);
 }
-// EXPERIMENTAL_changes_in_block static function
+/**
+ * [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
+ */
 async function experimentalChangesInBlock$1(client, params) {
     return client.makeRequest('EXPERIMENTAL_changes_in_block', params);
 }
-// EXPERIMENTAL_congestion_level static function
+/**
+ * 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)
+ */
 async function experimentalCongestionLevel$1(client, params) {
     return client.makeRequest('EXPERIMENTAL_congestion_level', params);
 }
-// EXPERIMENTAL_genesis_config static function
+/**
+ * [Deprecated] Get initial state and parameters for the genesis block.
+ * Consider genesis_config instead.
+ */
 async function experimentalGenesisConfig$1(client, params) {
     return client.makeRequest('EXPERIMENTAL_genesis_config', params);
 }
-// EXPERIMENTAL_light_client_block_proof static function
+/** Returns the proofs for a transaction execution. */
 async function experimentalLightClientBlockProof$1(client, params) {
     return client.makeRequest('EXPERIMENTAL_light_client_block_proof', params);
 }
-// EXPERIMENTAL_light_client_proof static function
+/** Returns the proofs for a transaction execution. */
 async function experimentalLightClientProof$1(client, params) {
     return client.makeRequest('EXPERIMENTAL_light_client_proof', params);
 }
-// EXPERIMENTAL_maintenance_windows static function
+/**
+ * [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.
+ */
 async function experimentalMaintenanceWindows$1(client, params) {
     return client.makeRequest('EXPERIMENTAL_maintenance_windows', params);
 }
-// EXPERIMENTAL_protocol_config static function
+/**
+ * A configuration that defines the protocol-level parameters such as
+ * gas/storage costs, limits, feature flags, other settings
+ */
 async function experimentalProtocolConfig$1(client, params) {
     return client.makeRequest('EXPERIMENTAL_protocol_config', params);
 }
-// EXPERIMENTAL_receipt static function
+/** Fetches a receipt by its ID (as is, without a status or execution outcome) */
 async function experimentalReceipt$1(client, params) {
     return client.makeRequest('EXPERIMENTAL_receipt', params);
 }
-// EXPERIMENTAL_split_storage_info static function
+/**
+ * Contains the split storage information. More info on split storage
+ * [here](https://near-nodes.io/archival/split-storage-archival)
+ */
 async function experimentalSplitStorageInfo$1(client, params) {
     return client.makeRequest('EXPERIMENTAL_split_storage_info', params);
 }
-// EXPERIMENTAL_tx_status static function
+/**
+ * Queries status of a transaction by hash, returning the final transaction
+ * result and details of all receipts.
+ */
 async function experimentalTxStatus$1(client, params) {
     return client.makeRequest('EXPERIMENTAL_tx_status', params);
 }
-// EXPERIMENTAL_validators_ordered static function
+/**
+ * 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.
+ */
 async function experimentalValidatorsOrdered$1(client, params) {
     return client.makeRequest('EXPERIMENTAL_validators_ordered', params);
 }
-// block static function
+/** Returns block details for given height or hash */
 async function block$1(client, params) {
     return client.makeRequest('block', params);
 }
-// block_effects static function
+/**
+ * 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.
+ */
 async function blockEffects$1(client, params) {
     return client.makeRequest('block_effects', params);
 }
-// broadcast_tx_async static function
+/**
+ * [Deprecated] Sends a transaction and immediately returns transaction hash.
+ * Consider using send_tx instead.
+ */
 async function broadcastTxAsync$1(client, params) {
     return client.makeRequest('broadcast_tx_async', params);
 }
-// broadcast_tx_commit static function
+/**
+ * [Deprecated] Sends a transaction and waits until transaction is fully
+ * complete. (Has a 10 second timeout). Consider using send_tx instead.
+ */
 async function broadcastTxCommit$1(client, params) {
     return client.makeRequest('broadcast_tx_commit', params);
 }
-// changes static function
+/**
+ * Returns changes for a given account, contract or contract code for given
+ * block height or hash.
+ */
 async function changes$1(client, params) {
     return client.makeRequest('changes', params);
 }
-// chunk static function
+/**
+ * Returns details of a specific chunk. You can run a block details query to
+ * get a valid chunk hash.
+ */
 async function chunk$1(client, params) {
     return client.makeRequest('chunk', params);
 }
-// client_config static function
+/** Queries client node configuration */
 async function clientConfig$1(client, params) {
     return client.makeRequest('client_config', params);
 }
-// gas_price static function
+/**
+ * Returns gas price for a specific block_height or block_hash. Using [null]
+ * will return the most recent block's gas price.
+ */
 async function gasPrice$1(client, params) {
     return client.makeRequest('gas_price', params);
 }
-// genesis_config static function
+/** Get initial state and parameters for the genesis block */
 async function genesisConfig$1(client, params) {
     return client.makeRequest('genesis_config', params);
 }
-// health static function
+/** Returns the current health status of the RPC node the client connects to. */
 async function health$1(client, params) {
     return client.makeRequest('health', params);
 }
-// light_client_proof static function
+/** Returns the proofs for a transaction execution. */
 async function lightClientProof$1(client, params) {
     return client.makeRequest('light_client_proof', params);
 }
-// maintenance_windows static function
+/**
+ * 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.
+ */
 async function maintenanceWindows$1(client, params) {
     return client.makeRequest('maintenance_windows', params);
 }
-// network_info static function
+/**
+ * Queries the current state of node network connections. This includes
+ * information about active peers, transmitted data, known producers, etc.
+ */
 async function networkInfo$1(client, params) {
     return client.makeRequest('network_info', params);
 }
-// next_light_client_block static function
+/** Returns the next light client block. */
 async function nextLightClientBlock$1(client, params) {
     return client.makeRequest('next_light_client_block', params);
 }
-// query static function
+/**
+ * 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.
+ */
 async function query$1(client, params) {
     return client.makeRequest('query', params);
 }
-// send_tx static function
+/**
+ * Sends transaction. Returns the guaranteed execution status and the results
+ * the blockchain can provide at the moment.
+ */
 async function sendTx$1(client, params) {
     return client.makeRequest('send_tx', params);
 }
-// status static function
+/**
+ * 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.
+ */
 async function status$1(client, params) {
     return client.makeRequest('status', params);
 }
-// tx static function
+/**
+ * Queries status of a transaction by hash and returns the final transaction
+ * result.
+ */
 async function tx$1(client, params) {
     return client.makeRequest('tx', params);
 }
-// validators static function
+/**
+ * Queries active validators on the network. Returns details and the state of
+ * validation on the blockchain.
+ */
 async function validators$1(client, params) {
     return client.makeRequest('validators', params);
 }
@@ -5044,7 +5127,7 @@ async function viewFunctionAsJson(client, params) {
 }
 
 // Auto-generated validation wrapper functions
-// Generated at: 2025-07-31T19:21:47.592Z
+// Generated at: 2025-08-03T18:51:29.361Z
 // Total functions: 31
 //
 // This file is automatically generated by tools/codegen/generate-validation-wrappers.ts
@@ -5096,6 +5179,10 @@ async function viewAccessKey(client, params) {
     return query(client, queryParams);
 }
 // Validation wrapper functions
+/**
+ * [Deprecated] Returns changes for a given account, contract or contract code
+ * for given block height or hash. Consider using changes instead.
+ */
 async function experimentalChanges(client, params) {
     // Validate request parameters
     const requestSchema = RpcStateChangesInBlockByTypeRequestSchema();
@@ -5120,6 +5207,12 @@ async function experimentalChanges(client, params) {
     }
     return result;
 }
+/**
+ * [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
+ */
 async function experimentalChangesInBlock(client, params) {
     // Validate request parameters
     const requestSchema = RpcStateChangesInBlockRequestSchema();
@@ -5144,6 +5237,10 @@ async function experimentalChangesInBlock(client, params) {
     }
     return result;
 }
+/**
+ * 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)
+ */
 async function experimentalCongestionLevel(client, params) {
     // Validate request parameters
     const requestSchema = RpcCongestionLevelRequestSchema();
@@ -5168,6 +5265,10 @@ async function experimentalCongestionLevel(client, params) {
     }
     return result;
 }
+/**
+ * [Deprecated] Get initial state and parameters for the genesis block.
+ * Consider genesis_config instead.
+ */
 async function experimentalGenesisConfig(client, params) {
     // Validate request parameters
     const requestSchema = GenesisConfigRequestSchema();
@@ -5192,6 +5293,7 @@ async function experimentalGenesisConfig(client, params) {
     }
     return result;
 }
+/** Returns the proofs for a transaction execution. */
 async function experimentalLightClientBlockProof(client, params) {
     // Validate request parameters
     const requestSchema = RpcLightClientBlockProofRequestSchema();
@@ -5216,6 +5318,7 @@ async function experimentalLightClientBlockProof(client, params) {
     }
     return result;
 }
+/** Returns the proofs for a transaction execution. */
 async function experimentalLightClientProof(client, params) {
     // Validate request parameters
     const requestSchema = RpcLightClientExecutionProofRequestSchema();
@@ -5240,6 +5343,12 @@ async function experimentalLightClientProof(client, params) {
     }
     return result;
 }
+/**
+ * [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.
+ */
 async function experimentalMaintenanceWindows(client, params) {
     // Validate request parameters
     const requestSchema = RpcMaintenanceWindowsRequestSchema();
@@ -5254,6 +5363,10 @@ async function experimentalMaintenanceWindows(client, params) {
     // Call the base function (no response validation needed)
     return experimentalMaintenanceWindows$1(client, params);
 }
+/**
+ * A configuration that defines the protocol-level parameters such as
+ * gas/storage costs, limits, feature flags, other settings
+ */
 async function experimentalProtocolConfig(client, params) {
     // Validate request parameters
     const requestSchema = RpcProtocolConfigRequestSchema();
@@ -5278,6 +5391,7 @@ async function experimentalProtocolConfig(client, params) {
     }
     return result;
 }
+/** Fetches a receipt by its ID (as is, without a status or execution outcome) */
 async function experimentalReceipt(client, params) {
     // Validate request parameters
     const requestSchema = RpcReceiptRequestSchema();
@@ -5302,6 +5416,10 @@ async function experimentalReceipt(client, params) {
     }
     return result;
 }
+/**
+ * Contains the split storage information. More info on split storage
+ * [here](https://near-nodes.io/archival/split-storage-archival)
+ */
 async function experimentalSplitStorageInfo(client, params) {
     // Validate request parameters
     const requestSchema = RpcSplitStorageInfoRequestSchema();
@@ -5326,6 +5444,10 @@ async function experimentalSplitStorageInfo(client, params) {
     }
     return result;
 }
+/**
+ * Queries status of a transaction by hash, returning the final transaction
+ * result and details of all receipts.
+ */
 async function experimentalTxStatus(client, params) {
     // Validate request parameters
     const requestSchema = RpcTransactionStatusRequestSchema();
@@ -5350,6 +5472,11 @@ async function experimentalTxStatus(client, params) {
     }
     return result;
 }
+/**
+ * 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.
+ */
 async function experimentalValidatorsOrdered(client, params) {
     // Validate request parameters
     const requestSchema = RpcValidatorsOrderedRequestSchema();
@@ -5364,6 +5491,7 @@ async function experimentalValidatorsOrdered(client, params) {
     // Call the base function (no response validation needed)
     return experimentalValidatorsOrdered$1(client, params);
 }
+/** Returns block details for given height or hash */
 async function block(client, params) {
     // Validate request parameters
     const requestSchema = RpcBlockRequestSchema();
@@ -5388,6 +5516,11 @@ async function block(client, params) {
     }
     return result;
 }
+/**
+ * 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.
+ */
 async function blockEffects(client, params) {
     // Validate request parameters
     const requestSchema = RpcStateChangesInBlockRequestSchema();
@@ -5412,6 +5545,10 @@ async function blockEffects(client, params) {
     }
     return result;
 }
+/**
+ * [Deprecated] Sends a transaction and immediately returns transaction hash.
+ * Consider using send_tx instead.
+ */
 async function broadcastTxAsync(client, params) {
     // Validate request parameters
     const requestSchema = RpcSendTransactionRequestSchema();
@@ -5436,6 +5573,10 @@ async function broadcastTxAsync(client, params) {
     }
     return result;
 }
+/**
+ * [Deprecated] Sends a transaction and waits until transaction is fully
+ * complete. (Has a 10 second timeout). Consider using send_tx instead.
+ */
 async function broadcastTxCommit(client, params) {
     // Validate request parameters
     const requestSchema = RpcSendTransactionRequestSchema();
@@ -5460,6 +5601,10 @@ async function broadcastTxCommit(client, params) {
     }
     return result;
 }
+/**
+ * Returns changes for a given account, contract or contract code for given
+ * block height or hash.
+ */
 async function changes(client, params) {
     // Validate request parameters
     const requestSchema = RpcStateChangesInBlockByTypeRequestSchema();
@@ -5484,6 +5629,10 @@ async function changes(client, params) {
     }
     return result;
 }
+/**
+ * Returns details of a specific chunk. You can run a block details query to
+ * get a valid chunk hash.
+ */
 async function chunk(client, params) {
     // Validate request parameters
     const requestSchema = RpcChunkRequestSchema();
@@ -5508,6 +5657,7 @@ async function chunk(client, params) {
     }
     return result;
 }
+/** Queries client node configuration */
 async function clientConfig(client, params) {
     // Validate request parameters
     const requestSchema = RpcClientConfigRequestSchema();
@@ -5532,6 +5682,10 @@ async function clientConfig(client, params) {
     }
     return result;
 }
+/**
+ * Returns gas price for a specific block_height or block_hash. Using [null]
+ * will return the most recent block's gas price.
+ */
 async function gasPrice(client, params) {
     // Validate request parameters
     const requestSchema = RpcGasPriceRequestSchema();
@@ -5556,6 +5710,7 @@ async function gasPrice(client, params) {
     }
     return result;
 }
+/** Get initial state and parameters for the genesis block */
 async function genesisConfig(client, params) {
     // Validate request parameters
     const requestSchema = GenesisConfigRequestSchema();
@@ -5580,6 +5735,7 @@ async function genesisConfig(client, params) {
     }
     return result;
 }
+/** Returns the current health status of the RPC node the client connects to. */
 async function health(client, params) {
     // Validate request parameters
     const requestSchema = RpcHealthRequestSchema();
@@ -5604,6 +5760,7 @@ async function health(client, params) {
     }
     return result;
 }
+/** Returns the proofs for a transaction execution. */
 async function lightClientProof(client, params) {
     // Validate request parameters
     const requestSchema = RpcLightClientExecutionProofRequestSchema();
@@ -5628,6 +5785,11 @@ async function lightClientProof(client, params) {
     }
     return result;
 }
+/**
+ * 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.
+ */
 async function maintenanceWindows(client, params) {
     // Validate request parameters
     const requestSchema = RpcMaintenanceWindowsRequestSchema();
@@ -5642,6 +5804,10 @@ async function maintenanceWindows(client, params) {
     // Call the base function (no response validation needed)
     return maintenanceWindows$1(client, params);
 }
+/**
+ * Queries the current state of node network connections. This includes
+ * information about active peers, transmitted data, known producers, etc.
+ */
 async function networkInfo(client, params) {
     // Validate request parameters
     const requestSchema = RpcNetworkInfoRequestSchema();
@@ -5666,6 +5832,7 @@ async function networkInfo(client, params) {
     }
     return result;
 }
+/** Returns the next light client block. */
 async function nextLightClientBlock(client, params) {
     // Validate request parameters
     const requestSchema = RpcLightClientNextBlockRequestSchema();
@@ -5690,6 +5857,19 @@ async function nextLightClientBlock(client, params) {
     }
     return result;
 }
+/**
+ * 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.
+ */
 async function query(client, params) {
     // Validate request parameters
     const requestSchema = RpcQueryRequestSchema();
@@ -5714,6 +5894,10 @@ async function query(client, params) {
     }
     return result;
 }
+/**
+ * Sends transaction. Returns the guaranteed execution status and the results
+ * the blockchain can provide at the moment.
+ */
 async function sendTx(client, params) {
     // Validate request parameters
     const requestSchema = RpcSendTransactionRequestSchema();
@@ -5738,6 +5922,11 @@ async function sendTx(client, params) {
     }
     return result;
 }
+/**
+ * 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.
+ */
 async function status(client, params) {
     // Validate request parameters
     const requestSchema = RpcStatusRequestSchema();
@@ -5762,6 +5951,10 @@ async function status(client, params) {
     }
     return result;
 }
+/**
+ * Queries status of a transaction by hash and returns the final transaction
+ * result.
+ */
 async function tx(client, params) {
     // Validate request parameters
     const requestSchema = RpcTransactionStatusRequestSchema();
@@ -5786,6 +5979,10 @@ async function tx(client, params) {
     }
     return result;
 }
+/**
+ * Queries active validators on the network. Returns details and the state of
+ * validation on the blockchain.
+ */
 async function validators(client, params) {
     // Validate request parameters
     const requestSchema = RpcValidatorRequestSchema();