@ckb-ccc/core 1.2.3 → 1.3.0

package/dist/client/jsonRpc/client.js

@@ -0,0 +1,220 @@
+import { Cell, OutPoint, } from "../../ckb/index.js";
+import { hexFrom } from "../../hex/index.js";
+import { RequestorJsonRpc, } from "../../jsonRpc/requestor.js";
+import { numFrom, numToHex } from "../../num/index.js";
+import { apply } from "../../utils/index.js";
+import { Client } from "../client.js";
+import { ErrorClientBase, ErrorClientDuplicatedTransaction, ErrorClientRBFRejected, ErrorClientResolveUnknown, ErrorClientVerification, } from "../clientTypes.js";
+import { JsonRpcTransformers, } from "./advanced.js";
+const ERROR_PARSERS = [
+    [
+        "Resolve\\(Unknown\\(OutPoint\\((0x.*)\\)\\)\\)",
+        (error, match) => new ErrorClientResolveUnknown(error, OutPoint.fromBytes(match[1])),
+    ],
+    [
+        "Verification\\(Error { kind: Script, inner: TransactionScriptError { source: (Inputs|Outputs)\\[([0-9]*)\\].(Lock|Type), cause: ValidationFailure: see error code (-?[0-9])* on page https://nervosnetwork\\.github\\.io/ckb-script-error-codes/by-(type|data)-hash/(.*)\\.html",
+        (error, match) => new ErrorClientVerification(error, match[3] === "Lock"
+            ? "lock"
+            : match[1] === "Inputs"
+                ? "inputType"
+                : "outputType", match[2], Number(match[4]), match[5] === "data" ? "data" : "type", match[6]),
+    ],
+    [
+        "Duplicated\\(Byte32\\((0x.*)\\)\\)",
+        (error, match) => new ErrorClientDuplicatedTransaction(error, match[1]),
+    ],
+    [
+        'RBFRejected\\("Tx\'s current fee is ([0-9]*), expect it to >= ([0-9]*) to replace old txs"\\)',
+        (error, match) => new ErrorClientRBFRejected(error, match[1], match[2]),
+    ],
+];
+/**
+ * An abstract class implementing JSON-RPC client functionality for a specific URL and timeout.
+ * Provides methods for sending transactions and building JSON-RPC payloads.
+ */
+export class ClientJsonRpc extends Client {
+    /**
+     * Creates an instance of ClientJsonRpc.
+     *
+     * @param url_ - The URL of the JSON-RPC server.
+     * @param timeout - The timeout for requests in milliseconds
+     */
+    constructor(url_, config) {
+        super(config);
+        /**
+         * Get fee rate statistics
+         *
+         * @returns Fee rate statistics
+         */
+        this.getFeeRateStatistics = this.buildSender("get_fee_rate_statistics", [(n) => apply(numFrom, n)], ({ mean, median }) => ({
+            mean: numFrom(mean),
+            median: numFrom(median),
+        }));
+        /**
+         * Get tip block number
+         *
+         * @returns Tip block number
+         */
+        this.getTip = this.buildSender("get_tip_block_number", [], numFrom);
+        /**
+         * Get tip block header
+         *
+         * @param verbosity - result format which allows 0 and 1. (Optional, the default is 1.)
+         * @returns BlockHeader
+         */
+        this.getTipHeader = this.buildSender("get_tip_header", [], (b) => apply(JsonRpcTransformers.blockHeaderTo, b));
+        /**
+         * Get block by block number
+         *
+         * @param blockNumber - The block number.
+         * @param verbosity - result format which allows 0 and 2. (Optional, the default is 2.)
+         * @param withCycles - whether the return cycles of block transactions. (Optional, default false.)
+         * @returns Block
+         */
+        this.getBlockByNumber = this.buildSender("get_block_by_number", [(v) => numToHex(numFrom(v))], (b) => apply(JsonRpcTransformers.blockTo, b));
+        /**
+         * Get block by block hash
+         *
+         * @param blockHash - The block hash.
+         * @param verbosity - result format which allows 0 and 2. (Optional, the default is 2.)
+         * @param withCycles - whether the return cycles of block transactions. (Optional, default false.)
+         * @returns Block
+         */
+        this.getBlockByHash = this.buildSender("get_block", [hexFrom], (b) => apply(JsonRpcTransformers.blockTo, b));
+        /**
+         * Get header by block number
+         *
+         * @param blockNumber - The block number.
+         * @param verbosity - result format which allows 0 and 1. (Optional, the default is 1.)
+         * @returns BlockHeader
+         */
+        this.getHeaderByNumber = this.buildSender("get_header_by_number", [(v) => numToHex(numFrom(v))], (b) => apply(JsonRpcTransformers.blockHeaderTo, b));
+        /**
+         * Get header by block hash
+         *
+         * @param blockHash - The block hash.
+         * @param verbosity - result format which allows 0 and 1. (Optional, the default is 1.)
+         * @returns BlockHeader
+         */
+        this.getHeaderByHash = this.buildSender("get_header", [hexFrom], (b) => apply(JsonRpcTransformers.blockHeaderTo, b));
+        /**
+         * Estimate cycles of a transaction.
+         *
+         * @param transaction - The transaction to estimate.
+         * @returns Consumed cycles
+         */
+        this.estimateCycles = this.buildSender("estimate_cycles", [JsonRpcTransformers.transactionFrom], ({ cycles }) => numFrom(cycles));
+        /**
+         * Test a transaction.
+         *
+         * @param transaction - The transaction to test.
+         * @param validator - "passthrough": Disable validation. "well_known_scripts_only": Only accept well known scripts in the transaction.
+         * @returns Consumed cycles
+         */
+        this.sendTransactionDry = this.buildSender("test_tx_pool_accept", [JsonRpcTransformers.transactionFrom], ({ cycles }) => numFrom(cycles));
+        /**
+         * Send a transaction to node.
+         *
+         * @param transaction - The transaction to send.
+         * @param validator - "passthrough": Disable validation. "well_known_scripts_only": Only accept well known scripts in the transaction.
+         * @returns Transaction hash.
+         */
+        this.sendTransactionNoCache = this.buildSender("send_transaction", [JsonRpcTransformers.transactionFrom], hexFrom);
+        /**
+         * Get a transaction from node.
+         *
+         * @param txHash - The hash of the transaction.
+         * @returns The transaction with status.
+         */
+        this.getTransactionNoCache = this.buildSender("get_transaction", [hexFrom], JsonRpcTransformers.transactionResponseTo);
+        /**
+         * find cells from node.
+         *
+         * @param key - The search key of cells.
+         * @param order - The order of cells.
+         * @param limit - The max return size of cells.
+         * @param after - Pagination parameter.
+         * @returns The found cells.
+         */
+        this.findCellsPagedNoCache = this.buildSender("get_cells", [
+            JsonRpcTransformers.indexerSearchKeyFrom,
+            (order) => order ?? "asc",
+            (limit) => numToHex(limit ?? 10),
+        ], JsonRpcTransformers.findCellsResponseTo);
+        /**
+         * find transactions from node.
+         *
+         * @param key - The search key of transactions.
+         * @param order - The order of transactions.
+         * @param limit - The max return size of transactions.
+         * @param after - Pagination parameter.
+         * @returns The found transactions.
+         */
+        this.findTransactionsPaged = this.buildSender("get_transactions", [
+            JsonRpcTransformers.indexerSearchKeyTransactionFrom,
+            (order) => order ?? "asc",
+            (limit) => numToHex(limit ?? 10),
+        ], JsonRpcTransformers.findTransactionsResponseTo);
+        /**
+         * get cells capacity from node.
+         *
+         * @param key - The search key of cells.
+         * @returns The sum of cells capacity.
+         */
+        this.getCellsCapacity = this.buildSender("get_cells_capacity", [JsonRpcTransformers.indexerSearchKeyFrom], ({ capacity }) => numFrom(capacity));
+        this.requestor =
+            config?.requestor ??
+                new RequestorJsonRpc(url_, config, (errAny) => {
+                    if (typeof errAny !== "object" ||
+                        errAny === null ||
+                        !("data" in errAny) ||
+                        typeof errAny.data !== "string") {
+                        throw errAny;
+                    }
+                    const err = errAny;
+                    for (const [regexp, builder] of ERROR_PARSERS) {
+                        const match = err.data.match(regexp);
+                        if (match) {
+                            throw builder(err, match);
+                        }
+                    }
+                    throw new ErrorClientBase(err);
+                });
+    }
+    /**
+     * Returns the URL of the JSON-RPC server.
+     *
+     * @returns The URL of the JSON-RPC server.
+     */
+    get url() {
+        return this.requestor.url;
+    }
+    /**
+     * Get a live cell from node.
+     *
+     * @param outPoint - The out point of the cell.
+     * @param withData - Include data in the response.
+     * @param includeTxPool - Include cells in the tx pool.
+     * @returns The cell
+     */
+    getCellLiveNoCache(outPoint, withData, includeTxPool) {
+        return this.buildSender("get_live_cell", [JsonRpcTransformers.outPointFrom], ({ cell, }) => apply(({ output, data, }) => Cell.from({
+            cellOutput: JsonRpcTransformers.cellOutputTo(output),
+            outputData: data?.content ?? "0x",
+            outPoint,
+        }), cell))(outPoint, withData ?? true, includeTxPool);
+    }
+    /**
+     * Builds a sender function for a JSON-RPC method.
+     *
+     * @param rpcMethod - The JSON-RPC method.
+     * @param inTransformers - An array of input transformers.
+     * @param outTransformer - An output transformer function.
+     * @returns A function that sends a JSON-RPC request with the given method and transformed parameters.
+     */
+    buildSender(rpcMethod, inTransformers, outTransformer) {
+        return async (...req) => {
+            return this.requestor.request(rpcMethod, req, inTransformers, outTransformer);
+        };
+    }
+}

package/dist/client/jsonRpc/index.d.ts

@@ -1,183 +1,2 @@
-import { Cell, OutPointLike, TransactionLike } from "../../ckb/index.js";
-import { Hex, HexLike } from "../../hex/index.js";
-import { Num, NumLike } from "../../num/index.js";
-import { ClientCache } from "../cache/index.js";
-import { Client } from "../client.js";
-import { ClientFindCellsResponse, ClientIndexerSearchKeyLike, ClientTransactionResponse, OutputsValidator } from "../clientTypes.js";
-import { JsonRpcPayload, Transport } from "../transports/advanced.js";
-/**
- * An abstract class implementing JSON-RPC client functionality for a specific URL and timeout.
- * Provides methods for sending transactions and building JSON-RPC payloads.
- */
-export declare abstract class ClientJsonRpc extends Client {
-    private readonly url_;
-    private readonly maxConcurrent?;
-    private concurrent;
-    private readonly pending;
-    private id;
-    private readonly transport;
-    /**
-     * Creates an instance of ClientJsonRpc.
-     *
-     * @param url_ - The URL of the JSON-RPC server.
-     * @param timeout - The timeout for requests in milliseconds
-     */
-    constructor(url_: string, config?: {
-        timeout?: number;
-        cache?: ClientCache;
-        maxConcurrent?: number;
-        transport?: Transport;
-    });
-    /**
-     * Returns the URL of the JSON-RPC server.
-     *
-     * @returns The URL of the JSON-RPC server.
-     */
-    get url(): string;
-    /**
-     * Get fee rate statistics
-     *
-     * @returns Fee rate statistics
-     */
-    getFeeRateStatistics: Client["getFeeRateStatistics"];
-    /**
-     * Get tip block number
-     *
-     * @returns Tip block number
-     */
-    getTip: () => Promise<Num>;
-    /**
-     * Get tip block header
-     *
-     * @param verbosity - result format which allows 0 and 1. (Optional, the default is 1.)
-     * @returns BlockHeader
-     */
-    getTipHeader: Client["getTipHeader"];
-    /**
-     * Get block by block number
-     *
-     * @param blockNumber - The block number.
-     * @param verbosity - result format which allows 0 and 2. (Optional, the default is 2.)
-     * @param withCycles - whether the return cycles of block transactions. (Optional, default false.)
-     * @returns Block
-     */
-    getBlockByNumber: Client["getBlockByNumber"];
-    /**
-     * Get block by block hash
-     *
-     * @param blockHash - The block hash.
-     * @param verbosity - result format which allows 0 and 2. (Optional, the default is 2.)
-     * @param withCycles - whether the return cycles of block transactions. (Optional, default false.)
-     * @returns Block
-     */
-    getBlockByHash: Client["getBlockByHash"];
-    /**
-     * Get header by block number
-     *
-     * @param blockNumber - The block number.
-     * @param verbosity - result format which allows 0 and 1. (Optional, the default is 1.)
-     * @returns BlockHeader
-     */
-    getHeaderByNumber: Client["getHeaderByNumber"];
-    /**
-     * Get header by block hash
-     *
-     * @param blockHash - The block hash.
-     * @param verbosity - result format which allows 0 and 1. (Optional, the default is 1.)
-     * @returns BlockHeader
-     */
-    getHeaderByHash: Client["getHeaderByHash"];
-    /**
-     * Estimate cycles of a transaction.
-     *
-     * @param transaction - The transaction to estimate.
-     * @returns Consumed cycles
-     */
-    estimateCycles: Client["estimateCycles"];
-    /**
-     * Test a transaction.
-     *
-     * @param transaction - The transaction to test.
-     * @param validator - "passthrough": Disable validation. "well_known_scripts_only": Only accept well known scripts in the transaction.
-     * @returns Consumed cycles
-     */
-    sendTransactionDry: Client["sendTransactionDry"];
-    /**
-     * Send a transaction to node.
-     *
-     * @param transaction - The transaction to send.
-     * @param validator - "passthrough": Disable validation. "well_known_scripts_only": Only accept well known scripts in the transaction.
-     * @returns Transaction hash.
-     */
-    sendTransactionNoCache: (transaction: TransactionLike, validator?: OutputsValidator | undefined) => Promise<Hex>;
-    /**
-     * Get a transaction from node.
-     *
-     * @param txHash - The hash of the transaction.
-     * @returns The transaction with status.
-     */
-    getTransactionNoCache: (txHash: HexLike) => Promise<ClientTransactionResponse | undefined>;
-    /**
-     * Get a live cell from node.
-     *
-     * @param outPoint - The out point of the cell.
-     * @param withData - Include data in the response.
-     * @param includeTxPool - Include cells in the tx pool.
-     * @returns The cell
-     */
-    getCellLiveNoCache(outPoint: OutPointLike, withData?: boolean | null, includeTxPool?: boolean | null): Promise<Cell | undefined>;
-    /**
-     * find cells from node.
-     *
-     * @param key - The search key of cells.
-     * @param order - The order of cells.
-     * @param limit - The max return size of cells.
-     * @param after - Pagination parameter.
-     * @returns The found cells.
-     */
-    findCellsPagedNoCache: (key: ClientIndexerSearchKeyLike, order?: "asc" | "desc", limit?: NumLike, after?: string) => Promise<ClientFindCellsResponse>;
-    /**
-     * find transactions from node.
-     *
-     * @param key - The search key of transactions.
-     * @param order - The order of transactions.
-     * @param limit - The max return size of transactions.
-     * @param after - Pagination parameter.
-     * @returns The found transactions.
-     */
-    findTransactionsPaged: Client["findTransactionsPaged"];
-    /**
-     * get cells capacity from node.
-     *
-     * @param key - The search key of cells.
-     * @returns The sum of cells capacity.
-     */
-    getCellsCapacity: (key: ClientIndexerSearchKeyLike) => Promise<Num>;
-    /**
-     * Builds a sender function for a JSON-RPC method.
-     *
-     * @param rpcMethod - The JSON-RPC method.
-     * @param inTransformers - An array of input transformers.
-     * @param outTransformer - An output transformer function.
-     * @returns A function that sends a JSON-RPC request with the given method and transformed parameters.
-     */
-    buildSender(rpcMethod: string, inTransformers: (((_: any) => unknown) | undefined)[], outTransformer?: (_: any) => unknown): (...req: unknown[]) => Promise<unknown>;
-    /**
-     * Sends a JSON-RPC request to the server.
-     *
-     * @param payload - The JSON-RPC payload to send.
-     * @returns The result of the JSON-RPC request.
-     *
-     * @throws Will throw an error if the response ID does not match the request ID, or if the response contains an error.
-     */
-    send(payload: JsonRpcPayload): Promise<unknown>;
-    /**
-     * Builds a JSON-RPC payload for the given method and parameters.
-     *
-     * @param method - The JSON-RPC method name.
-     * @param req - The parameters for the JSON-RPC method.
-     * @returns The JSON-RPC payload.
-     */
-    buildPayload(method: string, req: unknown[]): JsonRpcPayload;
-}
+export * from "./client.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/client/jsonRpc/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/jsonRpc/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EAEJ,YAAY,EACZ,eAAe,EAChB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,GAAG,EAAE,OAAO,EAAW,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,GAAG,EAAE,OAAO,EAAqB,MAAM,oBAAoB,CAAC;AAErE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EACL,uBAAuB,EACvB,0BAA0B,EAC1B,yBAAyB,EAOzB,gBAAgB,EACjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,cAAc,EACd,SAAS,EAEV,MAAM,2BAA2B,CAAC;AAgEnC;;;GAGG;AAEH,8BAAsB,aAAc,SAAQ,MAAM;IAgB9C,OAAO,CAAC,QAAQ,CAAC,IAAI;IAfvB,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAS;IACxC,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAE9C,OAAO,CAAC,EAAE,CAAK;IACf,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IAEtC;;;;;OAKG;gBAGgB,IAAI,EAAE,MAAM,EAC7B,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,WAAW,CAAC;QACpB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,SAAS,CAAC,EAAE,SAAS,CAAC;KACvB;IAQH;;;;OAIG;IAEH,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED;;;;OAIG;IAEH,oBAAoB,EAOf,MAAM,CAAC,sBAAsB,CAAC,CAAC;IAEpC;;;;OAIG;IAEH,MAAM,EAID,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;IAExB;;;;;OAKG;IACH,YAAY,EAIP,MAAM,CAAC,cAAc,CAAC,CAAC;IAE5B;;;;;;;OAOG;IACH,gBAAgB,EAIX,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAEhC;;;;;;;OAOG;IACH,cAAc,EAET,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAE9B;;;;;;OAMG;IACH,iBAAiB,EAIZ,MAAM,CAAC,mBAAmB,CAAC,CAAC;IAEjC;;;;;;OAMG;IACH,eAAe,EAIV,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAE/B;;;;;OAKG;IACH,cAAc,EAIT,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAE9B;;;;;;OAMG;IAEH,kBAAkB,EAIb,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAElC;;;;;;OAMG;IAEH,sBAAsB,EAIjB,CACH,WAAW,EAAE,eAAe,EAC5B,SAAS,CAAC,EAAE,gBAAgB,GAAG,SAAS,KACrC,OAAO,CAAC,GAAG,CAAC,CAAC;IAElB;;;;;OAKG;IAEH,qBAAqB,EAIhB,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,yBAAyB,GAAG,SAAS,CAAC,CAAC;IAEzE;;;;;;;OAOG;IACH,kBAAkB,CAChB,QAAQ,EAAE,YAAY,EACtB,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,EACzB,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,GA4BkB,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IAG3E;;;;;;;;OAQG;IAEH,qBAAqB,EAQhB,CACH,GAAG,EAAE,0BAA0B,EAC/B,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,EACtB,KAAK,CAAC,EAAE,OAAO,EACf,KAAK,CAAC,EAAE,MAAM,KACX,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEtC;;;;;;;;OAQG;IAEH,qBAAqB,EAQhB,MAAM,CAAC,uBAAuB,CAAC,CAAC;IAErC;;;;;OAKG;IAEH,gBAAgB,EAIX,CAAC,GAAG,EAAE,0BAA0B,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IAEvD;;;;;;;OAOG;IAEH,WAAW,CACT,SAAS,EAAE,MAAM,EAEjB,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EAErD,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,OAAO,GACnC,CAAC,GAAG,GAAG,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC;IAsC1C;;;;;;;OAOG;IACG,IAAI,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IA6BrD;;;;;;OAMG;IAEH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,cAAc;CAQ7D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/jsonRpc/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}