@ckb-ccc/core 0.0.9-alpha.1 → 0.0.10-alpha.4

package/dist.commonjs/client/jsonRpc/index.js

@@ -1,7 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientJsonRpc = void 0;
 const cross_fetch_1 = __importDefault(require("cross-fetch"));
@@ -23,130 +25,155 @@ const advanced_1 = require("./advanced");
  * ```
  */
 async function transform(value, transformer) {
-    if (transformer) {
-        return transformer(value);
-    }
-    return value;
+  if (transformer) {
+    return transformer(value);
+  }
+  return value;
 }
 /**
  * An abstract class implementing JSON-RPC client functionality for a specific URL and timeout.
  * Provides methods for sending transactions and building JSON-RPC payloads.
  */
 class ClientJsonRpc extends client_1.Client {
+  /**
+   * Creates an instance of ClientJsonRpc.
+   *
+   * @param url - The URL of the JSON-RPC server.
+   * @param timeout - The timeout for requests in milliseconds, default is 30000.
+   */
+  constructor(url_, timeout = 30000) {
+    super();
+    this.url_ = url_;
+    this.timeout = timeout;
     /**
-     * Creates an instance of ClientJsonRpc.
+     * Send a transaction to node.
      *
-     * @param url - The URL of the JSON-RPC server.
-     * @param timeout - The timeout for requests in milliseconds, default is 30000.
+     * @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.
      */
-    constructor(url_, timeout = 30000) {
-        super();
-        this.url_ = url_;
-        this.timeout = timeout;
-        /**
-         * 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", [advanced_1.JsonRpcTransformers.transactionFrom], hex_1.hexFrom);
-        /**
-         * Get a transaction from node.
-         *
-         * @param txHash - The hash of the transaction.
-         * @returns The transaction with status.
-         */
-        this.getTransactionNoCache = this.buildSender("get_transaction", [hex_1.hexFrom], advanced_1.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", [
-            advanced_1.JsonRpcTransformers.indexerSearchKeyFrom,
-            (order) => order ?? "asc",
-            (limit) => (0, num_1.numToHex)(limit ?? 10),
-        ], advanced_1.JsonRpcTransformers.findCellsResponseTo);
-        /**
-         * 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", [advanced_1.JsonRpcTransformers.indexerSearchKeyFrom], ({ capacity }) => (0, num_1.numFrom)(capacity));
-    }
+    this.sendTransactionNoCache = this.buildSender(
+      "send_transaction",
+      [advanced_1.JsonRpcTransformers.transactionFrom],
+      hex_1.hexFrom,
+    );
     /**
-     * Returns the URL of the JSON-RPC server.
+     * Get a transaction from node.
      *
-     * @returns The URL of the JSON-RPC server.
+     * @param txHash - The hash of the transaction.
+     * @returns The transaction with status.
      */
-    get url() {
-        return this.url_;
-    }
+    this.getTransactionNoCache = this.buildSender(
+      "get_transaction",
+      [hex_1.hexFrom],
+      advanced_1.JsonRpcTransformers.transactionResponseTo,
+    );
     /**
-     * Builds a sender function for a JSON-RPC method.
+     * find cells from node.
      *
-     * @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.
+     * @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.
      */
-    buildSender(rpcMethod, inTransformers, outTransformer) {
-        return async (...req) => {
-            const payload = ClientJsonRpc.buildPayload(rpcMethod, await Promise.all(req
-                .concat(Array.from(new Array(Math.max(inTransformers.length - req.length, 0))))
-                .map((v, i) => transform(v, inTransformers[i]))));
-            return transform(await this.send(payload), outTransformer);
-        };
-    }
+    this.findCellsPagedNoCache = this.buildSender(
+      "get_cells",
+      [
+        advanced_1.JsonRpcTransformers.indexerSearchKeyFrom,
+        (order) => order ?? "asc",
+        (limit) => (0, num_1.numToHex)(limit ?? 10),
+      ],
+      advanced_1.JsonRpcTransformers.findCellsResponseTo,
+    );
     /**
-     * Sends a JSON-RPC request to the server.
+     * get cells capacity from node.
      *
-     * @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.
+     * @param key - The search key of cells.
+     * @returns The sum of cells capacity.
      */
-    async send(payload) {
-        const aborter = new AbortController();
-        const abortTimer = setTimeout(() => aborter.abort(), this.timeout);
-        const raw = await (0, cross_fetch_1.default)(this.url, {
-            method: "POST",
-            headers: {
-                "content-type": "application/json",
-            },
-            body: JSON.stringify(payload),
-            signal: aborter.signal,
-        });
-        clearTimeout(abortTimer);
-        const res = (await raw.json());
-        if (res.id !== payload.id) {
-            throw new Error(`Id mismatched, got ${res.id}, expected ${payload.id}`);
-        }
-        if (res.error) {
-            throw res.error;
-        }
-        return res.result;
+    this.getCellsCapacity = this.buildSender(
+      "get_cells_capacity",
+      [advanced_1.JsonRpcTransformers.indexerSearchKeyFrom],
+      ({ capacity }) => (0, num_1.numFrom)(capacity),
+    );
+  }
+  /**
+   * Returns the URL of the JSON-RPC server.
+   *
+   * @returns The URL of the JSON-RPC server.
+   */
+  get url() {
+    return this.url_;
+  }
+  /**
+   * 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) => {
+      const payload = ClientJsonRpc.buildPayload(
+        rpcMethod,
+        await Promise.all(
+          req
+            .concat(
+              Array.from(
+                new Array(Math.max(inTransformers.length - req.length, 0)),
+              ),
+            )
+            .map((v, i) => transform(v, inTransformers[i])),
+        ),
+      );
+      return transform(await this.send(payload), outTransformer);
+    };
+  }
+  /**
+   * 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.
+   */
+  async send(payload) {
+    const aborter = new AbortController();
+    const abortTimer = setTimeout(() => aborter.abort(), this.timeout);
+    const raw = await (0, cross_fetch_1.default)(this.url, {
+      method: "POST",
+      headers: {
+        "content-type": "application/json",
+      },
+      body: JSON.stringify(payload),
+      signal: aborter.signal,
+    });
+    clearTimeout(abortTimer);
+    const res = await raw.json();
+    if (res.id !== payload.id) {
+      throw new Error(`Id mismatched, got ${res.id}, expected ${payload.id}`);
     }
-    /**
-     * 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.
-     */
-    static buildPayload(method, req) {
-        return {
-            id: Math.round(Math.random() * 10000),
-            method,
-            params: req,
-            jsonrpc: "2.0",
-        };
+    if (res.error) {
+      throw res.error;
     }
+    return res.result;
+  }
+  /**
+   * 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.
+   */
+  static buildPayload(method, req) {
+    return {
+      id: Math.round(Math.random() * 10000),
+      method,
+      params: req,
+      jsonrpc: "2.0",
+    };
+  }
 }
 exports.ClientJsonRpc = ClientJsonRpc;

package/dist.commonjs/client/jsonRpc/transformers.d.ts

@@ -1,40 +1,80 @@
-import { CellDep, CellDepLike, CellInput, CellInputLike, CellOutput, CellOutputLike, DepType, DepTypeLike, HashType, HashTypeLike, OutPoint, OutPointLike, Script, ScriptLike, Transaction, TransactionLike } from "../../ckb";
+import {
+  CellDep,
+  CellDepLike,
+  CellInput,
+  CellInputLike,
+  CellOutput,
+  CellOutputLike,
+  DepType,
+  DepTypeLike,
+  HashType,
+  HashTypeLike,
+  OutPoint,
+  OutPointLike,
+  Script,
+  ScriptLike,
+  Transaction,
+  TransactionLike,
+} from "../../ckb";
 import { Hex } from "../../hex";
 import { NumLike } from "../../num";
-import { ClientFindCellsResponse, ClientIndexerSearchKeyLike, ClientTransactionResponse, TransactionStatus } from "../clientTypes";
-import { JsonRpcCellDep, JsonRpcCellInput, JsonRpcCellOutput, JsonRpcDepType, JsonRpcHashType, JsonRpcIndexerSearchKey, JsonRpcOutPoint, JsonRpcScript, JsonRpcTransaction } from "./types";
+import {
+  ClientFindCellsResponse,
+  ClientIndexerSearchKeyLike,
+  ClientTransactionResponse,
+  TransactionStatus,
+} from "../clientTypes";
+import {
+  JsonRpcCellDep,
+  JsonRpcCellInput,
+  JsonRpcCellOutput,
+  JsonRpcDepType,
+  JsonRpcHashType,
+  JsonRpcIndexerSearchKey,
+  JsonRpcOutPoint,
+  JsonRpcScript,
+  JsonRpcTransaction,
+} from "./types";
 export declare class JsonRpcTransformers {
-    static hashTypeFrom(hashType: HashTypeLike): JsonRpcHashType;
-    static hashTypeTo(hashType: JsonRpcHashType): HashType;
-    static depTypeFrom(depType: DepTypeLike): JsonRpcDepType;
-    static depTypeTo(depType: JsonRpcDepType): DepType;
-    static scriptFrom(scriptLike: ScriptLike): JsonRpcScript;
-    static scriptTo(script: JsonRpcScript): Script;
-    static outPointFrom(outPointLike: OutPointLike): JsonRpcOutPoint;
-    static outPointTo(outPoint: JsonRpcOutPoint): OutPoint;
-    static cellInputFrom(cellInputLike: CellInputLike): JsonRpcCellInput;
-    static cellInputTo(cellInput: JsonRpcCellInput): CellInput;
-    static cellOutputFrom(cellOutput: CellOutputLike): JsonRpcCellOutput;
-    static cellOutputTo(cellOutput: JsonRpcCellOutput): CellOutput;
-    static cellDepFrom(cellDep: CellDepLike): JsonRpcCellDep;
-    static cellDepTo(cellDep: JsonRpcCellDep): CellDep;
-    static transactionFrom(txLike: TransactionLike): JsonRpcTransaction;
-    static transactionTo(tx: JsonRpcTransaction): Transaction;
-    static transactionResponseTo({ tx_status: { status }, transaction, }: {
-        tx_status: {
-            status: TransactionStatus;
-        };
-        transaction: JsonRpcTransaction | null;
-    }): ClientTransactionResponse | null;
-    static rangeFrom([a, b]: [NumLike, NumLike]): [Hex, Hex];
-    static indexerSearchKeyFrom(keyLike: ClientIndexerSearchKeyLike): JsonRpcIndexerSearchKey;
-    static findCellsResponseTo({ last_cursor, objects, }: {
-        last_cursor: string;
-        objects: {
-            out_point: JsonRpcOutPoint;
-            output: JsonRpcCellOutput;
-            output_data?: Hex;
-        }[];
-    }): ClientFindCellsResponse;
+  static hashTypeFrom(hashType: HashTypeLike): JsonRpcHashType;
+  static hashTypeTo(hashType: JsonRpcHashType): HashType;
+  static depTypeFrom(depType: DepTypeLike): JsonRpcDepType;
+  static depTypeTo(depType: JsonRpcDepType): DepType;
+  static scriptFrom(scriptLike: ScriptLike): JsonRpcScript;
+  static scriptTo(script: JsonRpcScript): Script;
+  static outPointFrom(outPointLike: OutPointLike): JsonRpcOutPoint;
+  static outPointTo(outPoint: JsonRpcOutPoint): OutPoint;
+  static cellInputFrom(cellInputLike: CellInputLike): JsonRpcCellInput;
+  static cellInputTo(cellInput: JsonRpcCellInput): CellInput;
+  static cellOutputFrom(cellOutput: CellOutputLike): JsonRpcCellOutput;
+  static cellOutputTo(cellOutput: JsonRpcCellOutput): CellOutput;
+  static cellDepFrom(cellDep: CellDepLike): JsonRpcCellDep;
+  static cellDepTo(cellDep: JsonRpcCellDep): CellDep;
+  static transactionFrom(txLike: TransactionLike): JsonRpcTransaction;
+  static transactionTo(tx: JsonRpcTransaction): Transaction;
+  static transactionResponseTo({
+    tx_status: { status },
+    transaction,
+  }: {
+    tx_status: {
+      status: TransactionStatus;
+    };
+    transaction: JsonRpcTransaction | null;
+  }): ClientTransactionResponse | null;
+  static rangeFrom([a, b]: [NumLike, NumLike]): [Hex, Hex];
+  static indexerSearchKeyFrom(
+    keyLike: ClientIndexerSearchKeyLike,
+  ): JsonRpcIndexerSearchKey;
+  static findCellsResponseTo({
+    last_cursor,
+    objects,
+  }: {
+    last_cursor: string;
+    objects: {
+      out_point: JsonRpcOutPoint;
+      output: JsonRpcCellOutput;
+      output_data?: Hex;
+    }[];
+  }): ClientFindCellsResponse;
 }
-//# sourceMappingURL=transformers.d.ts.map
+//# sourceMappingURL=transformers.d.ts.map