@psalomo/jsonrpc-client 1.1.0 → 1.3.0

package/dist/validated/index.d.ts

@@ -0,0 +1,168 @@
+import type { NearRpcClient } from '../client.js';
+import type { AccessKeyView, AccountView, CallResult, CryptoHash, EXPERIMENTALMaintenanceWindowsResponse, EXPERIMENTALValidatorsOrderedResponse, GenesisConfig, GenesisConfigRequest, MaintenanceWindowsResponse, RpcBlockRequest, RpcBlockResponse, RpcChunkRequest, RpcChunkResponse, RpcClientConfigRequest, RpcClientConfigResponse, RpcCongestionLevelRequest, RpcCongestionLevelResponse, RpcGasPriceRequest, RpcGasPriceResponse, RpcHealthRequest, RpcHealthResponse, RpcLightClientBlockProofRequest, RpcLightClientBlockProofResponse, RpcLightClientExecutionProofRequest, RpcLightClientExecutionProofResponse, RpcLightClientNextBlockRequest, RpcLightClientNextBlockResponse, RpcMaintenanceWindowsRequest, RpcNetworkInfoRequest, RpcNetworkInfoResponse, RpcProtocolConfigRequest, RpcProtocolConfigResponse, RpcQueryRequest, RpcQueryResponse, RpcReceiptRequest, RpcReceiptResponse, RpcSendTransactionRequest, RpcSplitStorageInfoRequest, RpcSplitStorageInfoResponse, RpcStateChangesInBlockByTypeRequest, RpcStateChangesInBlockByTypeResponse, RpcStateChangesInBlockRequest, RpcStateChangesInBlockResponse, RpcStatusRequest, RpcStatusResponse, RpcTransactionResponse, RpcTransactionStatusRequest, RpcValidatorRequest, RpcValidatorResponse, RpcValidatorsOrderedRequest } from '@psalomo/jsonrpc-types';
+export { parseCallResultToJson, viewFunctionAsJson } from '../convenience.js';
+export declare function enableValidation(): void;
+export declare function viewAccount(client: NearRpcClient, params: {
+    accountId: string;
+    finality?: 'final' | 'near-final' | 'optimistic';
+    blockId?: string | number;
+}): Promise<AccountView>;
+export declare function viewFunction(client: NearRpcClient, params: {
+    accountId: string;
+    methodName: string;
+    argsBase64?: string;
+    finality?: 'final' | 'near-final' | 'optimistic';
+    blockId?: string | number;
+}): Promise<CallResult>;
+export declare function viewAccessKey(client: NearRpcClient, params: {
+    accountId: string;
+    publicKey: string;
+    finality?: 'final' | 'near-final' | 'optimistic';
+    blockId?: string | number;
+}): Promise<AccessKeyView>;
+/**
+ * [Deprecated] Returns changes for a given account, contract or contract code
+ * for given block height or hash. Consider using changes instead.
+ */
+export 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
+ */
+export 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)
+ */
+export declare function experimentalCongestionLevel(client: NearRpcClient, params?: RpcCongestionLevelRequest): Promise<RpcCongestionLevelResponse>;
+/**
+ * [Deprecated] Get initial state and parameters for the genesis block.
+ * Consider genesis_config instead.
+ */
+export declare function experimentalGenesisConfig(client: NearRpcClient, params?: GenesisConfigRequest): Promise<GenesisConfig>;
+/** Returns the proofs for a transaction execution. */
+export declare function experimentalLightClientBlockProof(client: NearRpcClient, params?: RpcLightClientBlockProofRequest): Promise<RpcLightClientBlockProofResponse>;
+/** Returns the proofs for a transaction execution. */
+export 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.
+ */
+export 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
+ */
+export declare function experimentalProtocolConfig(client: NearRpcClient, params?: RpcProtocolConfigRequest): Promise<RpcProtocolConfigResponse>;
+/** Fetches a receipt by its ID (as is, without a status or execution outcome) */
+export 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)
+ */
+export 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.
+ */
+export 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.
+ */
+export declare function experimentalValidatorsOrdered(client: NearRpcClient, params?: RpcValidatorsOrderedRequest): Promise<EXPERIMENTALValidatorsOrderedResponse>;
+/** Returns block details for given height or hash */
+export 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.
+ */
+export declare function blockEffects(client: NearRpcClient, params?: RpcStateChangesInBlockRequest): Promise<RpcStateChangesInBlockByTypeResponse>;
+/**
+ * [Deprecated] Sends a transaction and immediately returns transaction hash.
+ * Consider using send_tx instead.
+ */
+export 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.
+ */
+export 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.
+ */
+export 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.
+ */
+export declare function chunk(client: NearRpcClient, params?: RpcChunkRequest): Promise<RpcChunkResponse>;
+/** Queries client node configuration */
+export 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.
+ */
+export declare function gasPrice(client: NearRpcClient, params?: RpcGasPriceRequest): Promise<RpcGasPriceResponse>;
+/** Get initial state and parameters for the genesis block */
+export declare function genesisConfig(client: NearRpcClient, params?: GenesisConfigRequest): Promise<GenesisConfig>;
+/** Returns the current health status of the RPC node the client connects to. */
+export declare function health(client: NearRpcClient, params?: RpcHealthRequest): Promise<RpcHealthResponse>;
+/** Returns the proofs for a transaction execution. */
+export 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.
+ */
+export 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.
+ */
+export declare function networkInfo(client: NearRpcClient, params?: RpcNetworkInfoRequest): Promise<RpcNetworkInfoResponse>;
+/** Returns the next light client block. */
+export 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.
+ */
+export 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.
+ */
+export 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.
+ */
+export declare function status(client: NearRpcClient, params?: RpcStatusRequest): Promise<RpcStatusResponse>;
+/**
+ * Queries status of a transaction by hash and returns the final transaction
+ * result.
+ */
+export 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.
+ */
+export declare function validators(client: NearRpcClient, params?: RpcValidatorRequest): Promise<RpcValidatorResponse>;
+//# sourceMappingURL=index.d.ts.map

package/dist/validated/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/validated/index.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAElD,OAAO,KAAK,EACV,aAAa,EACb,WAAW,EACX,UAAU,EACV,UAAU,EACV,sCAAsC,EACtC,qCAAqC,EACrC,aAAa,EACb,oBAAoB,EACpB,0BAA0B,EAC1B,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,+BAA+B,EAC/B,gCAAgC,EAChC,mCAAmC,EACnC,oCAAoC,EACpC,8BAA8B,EAC9B,+BAA+B,EAC/B,4BAA4B,EAC5B,qBAAqB,EACrB,sBAAsB,EACtB,wBAAwB,EACxB,yBAAyB,EACzB,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,mCAAmC,EACnC,oCAAoC,EACpC,6BAA6B,EAC7B,8BAA8B,EAC9B,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,2BAA2B,EAC3B,mBAAmB,EACnB,oBAAoB,EACpB,2BAA2B,EAC5B,MAAM,wBAAwB,CAAC;AAiDhC,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAG9E,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC;AAGD,wBAAsB,WAAW,CAC/B,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE;IACN,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,GAAG,YAAY,GAAG,YAAY,CAAC;IACjD,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC3B,GACA,OAAO,CAAC,WAAW,CAAC,CAetB;AAED,wBAAsB,YAAY,CAChC,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE;IACN,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,GAAG,YAAY,GAAG,YAAY,CAAC;IACjD,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC3B,GACA,OAAO,CAAC,UAAU,CAAC,CAcrB;AAED,wBAAsB,aAAa,CACjC,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE;IACN,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,GAAG,YAAY,GAAG,YAAY,CAAC;IACjD,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC3B,GACA,OAAO,CAAC,aAAa,CAAC,CAiBxB;AAGD;;;GAGG;AACH,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,mCAAmC,GAC3C,OAAO,CAAC,8BAA8B,CAAC,CAwBzC;AAED;;;;;GAKG;AACH,wBAAsB,0BAA0B,CAC9C,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,6BAA6B,GACrC,OAAO,CAAC,oCAAoC,CAAC,CAwB/C;AAED;;;GAGG;AACH,wBAAsB,2BAA2B,CAC/C,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,yBAAyB,GACjC,OAAO,CAAC,0BAA0B,CAAC,CA2BrC;AAED;;;GAGG;AACH,wBAAsB,yBAAyB,CAC7C,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC,aAAa,CAAC,CAwBxB;AAED,sDAAsD;AACtD,wBAAsB,iCAAiC,CACrD,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,+BAA+B,GACvC,OAAO,CAAC,gCAAgC,CAAC,CA2B3C;AAED,sDAAsD;AACtD,wBAAsB,4BAA4B,CAChD,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,mCAAmC,GAC3C,OAAO,CAAC,oCAAoC,CAAC,CA2B/C;AAED;;;;;GAKG;AACH,wBAAsB,8BAA8B,CAClD,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,4BAA4B,GACpC,OAAO,CAAC,sCAAsC,CAAC,CAajD;AAED;;;GAGG;AACH,wBAAsB,0BAA0B,CAC9C,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,wBAAwB,GAChC,OAAO,CAAC,yBAAyB,CAAC,CAwBpC;AAED,iFAAiF;AACjF,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,iBAAiB,GACzB,OAAO,CAAC,kBAAkB,CAAC,CAwB7B;AAED;;;GAGG;AACH,wBAAsB,4BAA4B,CAChD,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,0BAA0B,GAClC,OAAO,CAAC,2BAA2B,CAAC,CA2BtC;AAED;;;GAGG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,2BAA2B,GACnC,OAAO,CAAC,sBAAsB,CAAC,CAwBjC;AAED;;;;GAIG;AACH,wBAAsB,6BAA6B,CACjD,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,2BAA2B,GACnC,OAAO,CAAC,qCAAqC,CAAC,CAahD;AAED,qDAAqD;AACrD,wBAAsB,KAAK,CACzB,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,eAAe,GACvB,OAAO,CAAC,gBAAgB,CAAC,CAwB3B;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,6BAA6B,GACrC,OAAO,CAAC,oCAAoC,CAAC,CAwB/C;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,yBAAyB,GACjC,OAAO,CAAC,UAAU,CAAC,CAwBrB;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,yBAAyB,GACjC,OAAO,CAAC,sBAAsB,CAAC,CAwBjC;AAED;;;GAGG;AACH,wBAAsB,OAAO,CAC3B,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,mCAAmC,GAC3C,OAAO,CAAC,8BAA8B,CAAC,CAwBzC;AAED;;;GAGG;AACH,wBAAsB,KAAK,CACzB,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,eAAe,GACvB,OAAO,CAAC,gBAAgB,CAAC,CAwB3B;AAED,wCAAwC;AACxC,wBAAsB,YAAY,CAChC,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,sBAAsB,GAC9B,OAAO,CAAC,uBAAuB,CAAC,CAwBlC;AAED;;;GAGG;AACH,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,kBAAkB,GAC1B,OAAO,CAAC,mBAAmB,CAAC,CAwB9B;AAED,6DAA6D;AAC7D,wBAAsB,aAAa,CACjC,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC,aAAa,CAAC,CAwBxB;AAED,gFAAgF;AAChF,wBAAsB,MAAM,CAC1B,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,gBAAgB,GACxB,OAAO,CAAC,iBAAiB,CAAC,CAwB5B;AAED,sDAAsD;AACtD,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,mCAAmC,GAC3C,OAAO,CAAC,oCAAoC,CAAC,CAwB/C;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,4BAA4B,GACpC,OAAO,CAAC,0BAA0B,CAAC,CAarC;AAED;;;GAGG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,qBAAqB,GAC7B,OAAO,CAAC,sBAAsB,CAAC,CAwBjC;AAED,2CAA2C;AAC3C,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC,CAwB1C;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,KAAK,CACzB,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,eAAe,GACvB,OAAO,CAAC,gBAAgB,CAAC,CAwB3B;AAED;;;GAGG;AACH,wBAAsB,MAAM,CAC1B,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,yBAAyB,GACjC,OAAO,CAAC,sBAAsB,CAAC,CAwBjC;AAED;;;;GAIG;AACH,wBAAsB,MAAM,CAC1B,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,gBAAgB,GACxB,OAAO,CAAC,iBAAiB,CAAC,CAwB5B;AAED;;;GAGG;AACH,wBAAsB,EAAE,CACtB,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,2BAA2B,GACnC,OAAO,CAAC,sBAAsB,CAAC,CAwBjC;AAED;;;GAGG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,aAAa,EACrB,MAAM,CAAC,EAAE,mBAAmB,GAC3B,OAAO,CAAC,oBAAoB,CAAC,CAwB/B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@psalomo/jsonrpc-client",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "TypeScript client for NEAR Protocol JSON-RPC API",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -10,6 +10,11 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.js"
+    },
+    "./no-validation": {
+      "types": "./dist/no-validation/index.d.ts",
+      "import": "./dist/no-validation/index.mjs",
+      "require": "./dist/no-validation/index.js"
     }
   },
   "files": [
@@ -30,7 +35,7 @@
     "test:coverage": "vitest run --coverage"
   },
   "dependencies": {
-    "@psalomo/jsonrpc-types": "^1.1.0"
+    "@psalomo/jsonrpc-types": "^1.3.0"
   },
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^16.0.1",