@ckb-ccc/core 0.0.4-alpha.1 → 0.0.4-alpha.12

package/dist/client/clientPublicMainnet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clientPublicMainnet.d.ts","sourceRoot":"","sources":["../../src/client/clientPublicMainnet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,qBAAa,mBAAoB,SAAQ,aAAa;gBACxC,OAAO,CAAC,EAAE,MAAM;IAItB,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAInC,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;CAG7E"}
+{"version":3,"file":"clientPublicMainnet.d.ts","sourceRoot":"","sources":["../../src/client/clientPublicMainnet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,qBAAa,mBAAoB,SAAQ,aAAa;gBACxC,GAAG,SAAgC,EAAE,OAAO,CAAC,EAAE,MAAM;IAI3D,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAInC,cAAc,CAClB,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC,CAAC;CAGlD"}

package/dist/client/clientPublicMainnet.js

@@ -1,8 +1,8 @@
 import { MAINNET_SCRIPTS } from "./clientPublicMainnet.advanced";
 import { ClientJsonRpc } from "./jsonRpc";
 export class ClientPublicMainnet extends ClientJsonRpc {
-    constructor(timeout) {
-        super("https://mainnet.ckbapp.dev/", timeout);
+    constructor(url = "https://mainnet.ckbapp.dev/", timeout) {
+        super(url, timeout);
     }
     async getAddressPrefix() {
         return "ckb";

package/dist/client/clientPublicTestnet.advanced.d.ts

@@ -1,4 +1,4 @@
-import { ScriptLike } from "../ckb";
+import { Script } from "../ckb";
 import { KnownScript } from "./client";
-export declare const TESTNET_SCRIPTS: Record<KnownScript, Omit<ScriptLike, "args">>;
+export declare const TESTNET_SCRIPTS: Record<KnownScript, Pick<Script, "codeHash" | "hashType">>;
 //# sourceMappingURL=clientPublicTestnet.advanced.d.ts.map

package/dist/client/clientPublicTestnet.advanced.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clientPublicTestnet.advanced.d.ts","sourceRoot":"","sources":["../../src/client/clientPublicTestnet.advanced.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CA0BzE,CAAC"}
+{"version":3,"file":"clientPublicTestnet.advanced.d.ts","sourceRoot":"","sources":["../../src/client/clientPublicTestnet.advanced.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,eAAO,MAAM,eAAe,EAAE,MAAM,CAClC,WAAW,EACX,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC,CA2BtC,CAAC"}

package/dist/client/clientPublicTestnet.d.ts

@@ -1,9 +1,9 @@
-import { ScriptLike } from "../ckb";
+import { Script } from "../ckb";
 import { KnownScript } from "./client";
 import { ClientJsonRpc } from "./jsonRpc";
 export declare class ClientPublicTestnet extends ClientJsonRpc {
-    constructor(timeout?: number);
+    constructor(url?: string, timeout?: number);
     getAddressPrefix(): Promise<string>;
-    getKnownScript(script: KnownScript): Promise<Omit<ScriptLike, "args">>;
+    getKnownScript(script: KnownScript): Promise<Pick<Script, "codeHash" | "hashType">>;
 }
 //# sourceMappingURL=clientPublicTestnet.d.ts.map

package/dist/client/clientPublicTestnet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clientPublicTestnet.d.ts","sourceRoot":"","sources":["../../src/client/clientPublicTestnet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,qBAAa,mBAAoB,SAAQ,aAAa;gBACxC,OAAO,CAAC,EAAE,MAAM;IAItB,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAInC,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;CAG7E"}
+{"version":3,"file":"clientPublicTestnet.d.ts","sourceRoot":"","sources":["../../src/client/clientPublicTestnet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,qBAAa,mBAAoB,SAAQ,aAAa;gBACxC,GAAG,SAAgC,EAAE,OAAO,CAAC,EAAE,MAAM;IAI3D,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAInC,cAAc,CAClB,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC,CAAC;CAGlD"}

package/dist/client/clientPublicTestnet.js

@@ -1,8 +1,8 @@
 import { TESTNET_SCRIPTS } from "./clientPublicTestnet.advanced";
 import { ClientJsonRpc } from "./jsonRpc";
 export class ClientPublicTestnet extends ClientJsonRpc {
-    constructor(timeout) {
-        super("https://testnet.ckbapp.dev/", timeout);
+    constructor(url = "https://testnet.ckbapp.dev/", timeout) {
+        super(url, timeout);
     }
     async getAddressPrefix() {
         return "ckt";

package/dist/client/clientTypes.d.ts

@@ -1,2 +1,8 @@
+import { Transaction } from "../ckb";
 export type OutputsValidator = "passthrough" | "well_known_scripts_only";
+export type TransactionStatus = "pending" | "proposed" | "committed" | "unknown" | "rejected";
+export type ClientTransactionResponse = {
+    transaction: Transaction;
+    status: TransactionStatus;
+};
 //# sourceMappingURL=clientTypes.d.ts.map

package/dist/client/clientTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clientTypes.d.ts","sourceRoot":"","sources":["../../src/client/clientTypes.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG,yBAAyB,CAAC"}
+{"version":3,"file":"clientTypes.d.ts","sourceRoot":"","sources":["../../src/client/clientTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAErC,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG,yBAAyB,CAAC;AAEzE,MAAM,MAAM,iBAAiB,GACzB,SAAS,GACT,UAAU,GACV,WAAW,GACX,SAAS,GACT,UAAU,CAAC;AACf,MAAM,MAAM,yBAAyB,GAAG;IACtC,WAAW,EAAE,WAAW,CAAC;IACzB,MAAM,EAAE,iBAAiB,CAAC;CAC3B,CAAC"}

package/dist/client/index.d.ts

@@ -2,4 +2,5 @@ export * from "./client";
 export * from "./clientPublicMainnet";
 export * from "./clientPublicTestnet";
 export * from "./clientTypes";
+export * from "./jsonRpc";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC"}

package/dist/client/index.js

@@ -2,3 +2,4 @@ export * from "./client";
 export * from "./clientPublicMainnet";
 export * from "./clientPublicTestnet";
 export * from "./clientTypes";
+export * from "./jsonRpc";

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

@@ -1,88 +1,3 @@
-import { CellDepLike, CellInputLike, CellOutputLike, DepTypeLike, OutPointLike, ScriptLike, TransactionLike } from "../../ckb";
-import type { Client } from "../client";
-export type JsonRpcPayload = {
-    id: number;
-    jsonrpc: "2.0";
-    method: string;
-    params: unknown[] | Record<string, unknown>;
-};
-export type JsonRpcMethod = {
-    method: keyof Client;
-    rpcMethod: string;
-    inTransformers: (((_: any) => unknown) | undefined)[];
-    outTransformer?: (_: any) => unknown;
-};
-export declare class JsonRpcTransformers {
-    static toDepType(depType: DepTypeLike): "code" | "dep_group";
-    static toScript(script: ScriptLike): {
-        code_hash: import("../..").BytesLike;
-        hash_type: import("../../ckb").HashTypeLike;
-        args: import("../..").BytesLike;
-    };
-    static toOutPoint(outPoint: OutPointLike): {
-        index: `0x${string}`;
-        tx_hash: import("../..").BytesLike;
-    };
-    static toCellInput(cellInput: CellInputLike): {
-        previous_output: {
-            index: `0x${string}`;
-            tx_hash: import("../..").BytesLike;
-        };
-        since: `0x${string}`;
-    };
-    static toCellOutput(cellOutput: CellOutputLike): {
-        capacity: `0x${string}`;
-        lock: {
-            code_hash: import("../..").BytesLike;
-            hash_type: import("../../ckb").HashTypeLike;
-            args: import("../..").BytesLike;
-        };
-        type: {
-            code_hash: import("../..").BytesLike;
-            hash_type: import("../../ckb").HashTypeLike;
-            args: import("../..").BytesLike;
-        } | undefined;
-    };
-    static toCellDep(cellDep: CellDepLike): {
-        out_point: {
-            index: `0x${string}`;
-            tx_hash: import("../..").BytesLike;
-        };
-        dep_type: string;
-    };
-    static toTransaction(tx: TransactionLike): {
-        version: `0x${string}`;
-        cell_deps: {
-            out_point: {
-                index: `0x${string}`;
-                tx_hash: import("../..").BytesLike;
-            };
-            dep_type: string;
-        }[];
-        header_deps: import("../..").BytesLike[];
-        inputs: {
-            previous_output: {
-                index: `0x${string}`;
-                tx_hash: import("../..").BytesLike;
-            };
-            since: `0x${string}`;
-        }[];
-        outputs: {
-            capacity: `0x${string}`;
-            lock: {
-                code_hash: import("../..").BytesLike;
-                hash_type: import("../../ckb").HashTypeLike;
-                args: import("../..").BytesLike;
-            };
-            type: {
-                code_hash: import("../..").BytesLike;
-                hash_type: import("../../ckb").HashTypeLike;
-                args: import("../..").BytesLike;
-            } | undefined;
-        }[];
-        outputs_data: import("../..").BytesLike[];
-        witnesses: import("../..").BytesLike[];
-    };
-}
-export declare const CkbRpcMethods: JsonRpcMethod[];
+export * from "./transformers";
+export * from "./types";
 //# sourceMappingURL=advanced.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"advanced.d.ts","sourceRoot":"","sources":["../../../src/client/jsonRpc/advanced.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,aAAa,EACb,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,eAAe,EAEhB,MAAM,WAAW,CAAC;AAInB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAExC,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,KAAK,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAElB,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC;IAEtD,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC;CACtC,CAAC;AAEF,qBAAa,mBAAmB;IAC9B,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW;IAQrC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU;;;;;IAOlC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,YAAY;;;;IAMxC,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,aAAa;;;;;;;IAM3C,MAAM,CAAC,YAAY,CAAC,UAAU,EAAE,cAAc;;;;;;;;;;;;;IAO9C,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,WAAW;;;;;;;IAMrC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAWzC;AAED,eAAO,MAAM,aAAa,EAAE,aAAa,EAOxC,CAAC"}
+{"version":3,"file":"advanced.d.ts","sourceRoot":"","sources":["../../../src/client/jsonRpc/advanced.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC"}

package/dist/client/jsonRpc/advanced.js

@@ -1,65 +1,2 @@
-import { depTypeFrom, } from "../../ckb";
-import { hexFrom } from "../../hex";
-import { numToHex } from "../../num";
-import { apply } from "../../utils";
-export class JsonRpcTransformers {
-    static toDepType(depType) {
-        switch (depTypeFrom(depType)) {
-            case "code":
-                return "code";
-            case "depGroup":
-                return "dep_group";
-        }
-    }
-    static toScript(script) {
-        return {
-            code_hash: script.codeHash,
-            hash_type: script.hashType,
-            args: script.args,
-        };
-    }
-    static toOutPoint(outPoint) {
-        return {
-            index: numToHex(outPoint.index),
-            tx_hash: outPoint.txHash,
-        };
-    }
-    static toCellInput(cellInput) {
-        return {
-            previous_output: JsonRpcTransformers.toOutPoint(cellInput.previousOutput),
-            since: numToHex(cellInput.since),
-        };
-    }
-    static toCellOutput(cellOutput) {
-        return {
-            capacity: numToHex(cellOutput.capacity),
-            lock: JsonRpcTransformers.toScript(cellOutput.lock),
-            type: apply(JsonRpcTransformers.toScript, cellOutput.type),
-        };
-    }
-    static toCellDep(cellDep) {
-        return {
-            out_point: JsonRpcTransformers.toOutPoint(cellDep.outPoint),
-            dep_type: JsonRpcTransformers.toDepType(cellDep.depType),
-        };
-    }
-    static toTransaction(tx) {
-        return {
-            version: numToHex(tx.version),
-            cell_deps: tx.cellDeps.map((c) => JsonRpcTransformers.toCellDep(c)),
-            header_deps: tx.headerDeps,
-            inputs: tx.inputs.map((i) => JsonRpcTransformers.toCellInput(i)),
-            outputs: tx.outputs.map((o) => JsonRpcTransformers.toCellOutput(o)),
-            outputs_data: tx.outputsData,
-            witnesses: tx.witnesses,
-        };
-    }
-}
-export const CkbRpcMethods = [
-    {
-        method: "sendTransaction",
-        rpcMethod: "send_transaction",
-        inTransformers: [JsonRpcTransformers.toTransaction],
-        outTransformer: hexFrom,
-    },
-];
+export * from "./transformers";
+export * from "./types";

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

@@ -1,14 +1,68 @@
-import type { Client } from "../client";
-import { JsonRpcMethod, JsonRpcPayload } from "./advanced";
-export interface ClientJsonRpc extends Pick<Client, "sendTransaction"> {
-}
-export declare abstract class ClientJsonRpc implements Pick<Client, "sendTransaction"> {
+import { TransactionLike } from "../../ckb";
+import { Hex, HexLike } from "../../hex";
+import { Client } from "../client";
+import { ClientTransactionResponse, OutputsValidator } from "../clientTypes";
+import { JsonRpcPayload } from "./advanced";
+/**
+ * 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 timeout;
+    /**
+     * 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: string, timeout?: number);
+    /**
+     * Returns the URL of the JSON-RPC server.
+     *
+     * @returns The URL of the JSON-RPC server.
+     */
     getUrl(): string;
-    buildSender({ rpcMethod, inTransformers, outTransformer }: JsonRpcMethod): (...req: unknown[]) => Promise<unknown>;
+    /**
+     * 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.
+     */
+    sendTransaction: (transaction: TransactionLike, validator?: OutputsValidator | undefined) => Promise<Hex>;
+    /**
+     * Get a transaction from node.
+     *
+     * @param txHash - The hash of the transaction.
+     * @returns The transaction with status.
+     */
+    getTransaction: (txHash: HexLike) => Promise<ClientTransactionResponse>;
+    /**
+     * 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.
+     */
     static buildPayload(method: string, req: unknown[]): JsonRpcPayload;
 }
 //# 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":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAiB,aAAa,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE1E,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,MAAM,EAAE,iBAAiB,CAAC;CAAG;AAYzE,8BAAsB,aAAc,YAAW,IAAI,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAE1E,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,OAAO;gBADP,GAAG,EAAE,MAAM,EACX,OAAO,SAAQ;IAUlC,MAAM;IAIN,WAAW,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE,cAAc,EAAE,EAAE,aAAa,YAChD,OAAO,EAAE;IAU3B,IAAI,CAAC,OAAO,EAAE,cAAc;IA4BlC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,cAAc;CAQpE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/jsonRpc/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,GAAG,EAAE,OAAO,EAAW,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAC7E,OAAO,EAAE,cAAc,EAAuB,MAAM,YAAY,CAAC;AA0BjE;;;GAGG;AAEH,8BAAsB,aAAc,SAAQ,MAAM;IAS9C,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAT1B;;;;;OAKG;gBAGgB,GAAG,EAAE,MAAM,EACX,OAAO,SAAQ;IAKlC;;;;OAIG;IAEH,MAAM;IAIN;;;;;;OAMG;IAEH,eAAe,gBAKA,eAAe,cAChB,gBAAgB,GAAG,SAAS,KACrC,QAAQ,GAAG,CAAC,CAAC;IAElB;;;;;OAKG;IAEH,cAAc,WAIA,OAAO,KAAK,QAAQ,yBAAyB,CAAC,CAAC;IAE7D;;;;;;;OAOG;IAEH,WAAW,CACT,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EACrD,cAAc,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,OAAO,YAEd,OAAO,EAAE;IAUjC;;;;;;;OAOG;IAEG,IAAI,CAAC,OAAO,EAAE,cAAc;IA4BlC;;;;;;OAMG;IAEH,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,cAAc;CAQpE"}

package/dist/client/jsonRpc/index.js

@@ -1,29 +1,87 @@
 import fetch from "cross-fetch";
-import { CkbRpcMethods } from "./advanced";
+import { hexFrom } from "../../hex";
+import { Client } from "../client";
+import { JsonRpcTransformers } from "./advanced";
+/**
+ * Applies a transformation function to a value if the transformer is provided.
+ *
+ * @param value - The value to be transformed.
+ * @param transformer - An optional transformation function.
+ * @returns The transformed value if a transformer is provided, otherwise the original value.
+ *
+ * @example
+ * ```typescript
+ * const result = await transform(5, (x) => x * 2); // Outputs 10
+ * const resultWithoutTransformer = await transform(5); // Outputs 5
+ * ```
+ */
 async function transform(value, transformer) {
     if (transformer) {
         return transformer(value);
     }
     return value;
 }
-export class ClientJsonRpc {
+/**
+ * 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, default is 30000.
+     */
     constructor(url, timeout = 30000) {
+        super();
         this.url = url;
         this.timeout = timeout;
-        CkbRpcMethods.map((method) => Object.defineProperty(this, method.method, {
-            value: this.buildSender(method),
-            enumerable: true,
-        }));
+        /**
+         * 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.sendTransaction = 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.getTransaction = this.buildSender("get_transaction", [hexFrom], JsonRpcTransformers.transactionResponseTo);
     }
+    /**
+     * Returns the URL of the JSON-RPC server.
+     *
+     * @returns The URL of the JSON-RPC server.
+     */
     getUrl() {
         return this.url;
     }
-    buildSender({ rpcMethod, inTransformers, outTransformer }) {
+    /**
+     * 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.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);
@@ -45,6 +103,13 @@ export class ClientJsonRpc {
         }
         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),

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

@@ -0,0 +1,28 @@
+import { CellDep, CellDepLike, CellInput, CellInputLike, CellOutput, CellOutputLike, DepType, DepTypeLike, HashType, HashTypeLike, OutPoint, OutPointLike, Script, ScriptLike, Transaction, TransactionLike } from "../../ckb";
+import { ClientTransactionResponse, TransactionStatus } from "../clientTypes";
+import { JsonRpcCellDep, JsonRpcCellInput, JsonRpcCellOutput, JsonRpcDepType, JsonRpcHashType, 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(cellInput: 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;
+    }): ClientTransactionResponse;
+}
+//# sourceMappingURL=transformers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transformers.d.ts","sourceRoot":"","sources":["../../../src/client/jsonRpc/transformers.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,WAAW,EACX,SAAS,EACT,aAAa,EACb,UAAU,EACV,cAAc,EACd,OAAO,EACP,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,YAAY,EACZ,MAAM,EACN,UAAU,EACV,WAAW,EACX,eAAe,EAGhB,MAAM,WAAW,CAAC;AAGnB,OAAO,EAAE,yBAAyB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,eAAe,EACf,aAAa,EACb,kBAAkB,EACnB,MAAM,SAAS,CAAC;AAEjB,qBAAa,mBAAmB;IAC9B,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,YAAY,GAAG,eAAe;IAG5D,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,GAAG,QAAQ;IAGtD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,cAAc;IAQxD,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO;IAQlD,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,UAAU,GAAG,aAAa;IAQxD,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM;IAO9C,MAAM,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,GAAG,eAAe;IAOhE,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,GAAG,QAAQ;IAMtD,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,aAAa,GAAG,gBAAgB;IAQhE,MAAM,CAAC,WAAW,CAAC,SAAS,EAAE,gBAAgB,GAAG,SAAS;IAM1D,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,cAAc,GAAG,iBAAiB;IAOpE,MAAM,CAAC,YAAY,CAAC,UAAU,EAAE,iBAAiB,GAAG,UAAU;IAO9D,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,cAAc;IAMxD,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO;IAMlD,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,eAAe,GAAG,kBAAkB;IAYnE,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,kBAAkB,GAAG,WAAW;IAWzD,MAAM,CAAC,qBAAqB,CAAC,EAC3B,SAAS,EAAE,EAAE,MAAM,EAAE,EACrB,WAAW,GACZ,EAAE;QACD,SAAS,EAAE;YAAE,MAAM,EAAE,iBAAiB,CAAA;SAAE,CAAC;QACzC,WAAW,EAAE,kBAAkB,CAAC;KACjC,GAAG,yBAAyB;CAM9B"}

package/dist/client/jsonRpc/transformers.js

@@ -0,0 +1,122 @@
+import { CellDep, CellInput, CellOutput, OutPoint, Script, Transaction, depTypeFrom, hashTypeFrom, } from "../../ckb";
+import { numToHex } from "../../num";
+import { apply } from "../../utils";
+export class JsonRpcTransformers {
+    static hashTypeFrom(hashType) {
+        return hashTypeFrom(hashType);
+    }
+    static hashTypeTo(hashType) {
+        return hashType;
+    }
+    static depTypeFrom(depType) {
+        switch (depTypeFrom(depType)) {
+            case "code":
+                return "code";
+            case "depGroup":
+                return "dep_group";
+        }
+    }
+    static depTypeTo(depType) {
+        switch (depType) {
+            case "code":
+                return "code";
+            case "dep_group":
+                return "depGroup";
+        }
+    }
+    static scriptFrom(scriptLike) {
+        const script = Script.from(scriptLike);
+        return {
+            code_hash: script.codeHash,
+            hash_type: JsonRpcTransformers.hashTypeFrom(script.hashType),
+            args: script.args,
+        };
+    }
+    static scriptTo(script) {
+        return Script.from({
+            codeHash: script.code_hash,
+            hashType: JsonRpcTransformers.hashTypeTo(script.hash_type),
+            args: script.args,
+        });
+    }
+    static outPointFrom(outPointLike) {
+        const outPoint = OutPoint.from(outPointLike);
+        return {
+            index: numToHex(outPoint.index),
+            tx_hash: outPoint.txHash,
+        };
+    }
+    static outPointTo(outPoint) {
+        return OutPoint.from({
+            index: outPoint.index,
+            txHash: outPoint.tx_hash,
+        });
+    }
+    static cellInputFrom(cellInput) {
+        return {
+            previous_output: JsonRpcTransformers.outPointFrom(cellInput.previousOutput),
+            since: numToHex(cellInput.since),
+        };
+    }
+    static cellInputTo(cellInput) {
+        return CellInput.from({
+            previousOutput: JsonRpcTransformers.outPointTo(cellInput.previous_output),
+            since: cellInput.since,
+        });
+    }
+    static cellOutputFrom(cellOutput) {
+        return {
+            capacity: numToHex(cellOutput.capacity),
+            lock: JsonRpcTransformers.scriptFrom(cellOutput.lock),
+            type: apply(JsonRpcTransformers.scriptFrom, cellOutput.type),
+        };
+    }
+    static cellOutputTo(cellOutput) {
+        return CellOutput.from({
+            capacity: cellOutput.capacity,
+            lock: JsonRpcTransformers.scriptTo(cellOutput.lock),
+            type: apply(JsonRpcTransformers.scriptTo, cellOutput.type),
+        });
+    }
+    static cellDepFrom(cellDep) {
+        return {
+            out_point: JsonRpcTransformers.outPointFrom(cellDep.outPoint),
+            dep_type: JsonRpcTransformers.depTypeFrom(cellDep.depType),
+        };
+    }
+    static cellDepTo(cellDep) {
+        return CellDep.from({
+            outPoint: JsonRpcTransformers.outPointTo(cellDep.out_point),
+            depType: JsonRpcTransformers.depTypeTo(cellDep.dep_type),
+        });
+    }
+    static transactionFrom(txLike) {
+        const tx = Transaction.from(txLike);
+        return {
+            version: numToHex(tx.version),
+            cell_deps: tx.cellDeps.map((c) => JsonRpcTransformers.cellDepFrom(c)),
+            header_deps: tx.headerDeps,
+            inputs: tx.inputs.map((i) => JsonRpcTransformers.cellInputFrom(i)),
+            outputs: tx.outputs.map((o) => JsonRpcTransformers.cellOutputFrom(o)),
+            outputs_data: tx.outputsData,
+            witnesses: tx.witnesses,
+        };
+    }
+    static transactionTo(tx) {
+        return Transaction.from({
+            version: tx.version,
+            cellDeps: tx.cell_deps.map((c) => JsonRpcTransformers.cellDepTo(c)),
+            headerDeps: tx.header_deps,
+            inputs: tx.inputs.map((i) => JsonRpcTransformers.cellInputTo(i)),
+            outputs: tx.outputs.map((o) => JsonRpcTransformers.cellOutputTo(o)),
+            outputsData: tx.outputs_data,
+            witnesses: tx.witnesses,
+        });
+    }
+    static transactionResponseTo({ tx_status: { status }, transaction, }) {
+        return {
+            transaction: JsonRpcTransformers.transactionTo(transaction),
+            status,
+        };
+    }
+}

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

@@ -0,0 +1,41 @@
+import { Hex } from "../../hex";
+export type JsonRpcPayload = {
+    id: number;
+    jsonrpc: "2.0";
+    method: string;
+    params: unknown[] | Record<string, unknown>;
+};
+export type JsonRpcHashType = "type" | "data" | "data1" | "data2";
+export type JsonRpcDepType = "dep_group" | "code";
+export type JsonRpcScript = {
+    code_hash: Hex;
+    hash_type: JsonRpcHashType;
+    args: Hex;
+};
+export type JsonRpcOutPoint = {
+    index: Hex;
+    tx_hash: Hex;
+};
+export type JsonRpcCellInput = {
+    previous_output: JsonRpcOutPoint;
+    since: Hex;
+};
+export type JsonRpcCellOutput = {
+    capacity: Hex;
+    lock: JsonRpcScript;
+    type?: JsonRpcScript;
+};
+export type JsonRpcCellDep = {
+    out_point: JsonRpcOutPoint;
+    dep_type: JsonRpcDepType;
+};
+export type JsonRpcTransaction = {
+    version: Hex;
+    cell_deps: JsonRpcCellDep[];
+    header_deps: Hex[];
+    inputs: JsonRpcCellInput[];
+    outputs: JsonRpcCellOutput[];
+    outputs_data: Hex[];
+    witnesses: Hex[];
+};
+//# sourceMappingURL=types.d.ts.map