@ckb-ccc/core 0.0.16-alpha.3 → 0.1.0-alpha.4

package/src/client/clientPublicTestnet.ts

@@ -1,8 +1,7 @@
 import WebSocket from "isomorphic-ws";
-import { Script } from "../ckb/index.js";
 import { ClientCache } from "./cache/index.js";
-import { CellDepInfo, KnownScript } from "./client.js";
 import { TESTNET_SCRIPTS } from "./clientPublicTestnet.advanced.js";
+import { KnownScript, ScriptInfo } from "./clientTypes.js";
 import { ClientJsonRpc } from "./jsonRpc/index.js";
 
 /**
@@ -34,15 +33,8 @@ export class ClientPublicTestnet extends ClientJsonRpc {
     return "ckt";
   }
 
-  async getKnownScript(
-    script: KnownScript,
-  ): Promise<
-    Pick<Script, "codeHash" | "hashType"> & { cellDeps: CellDepInfo[] }
-  > {
+  async getKnownScript(script: KnownScript): Promise<ScriptInfo> {
     const found = this.scripts[script];
-    return {
-      ...found,
-      cellDeps: found.cellDeps.map((c) => CellDepInfo.from(c)),
-    };
+    return ScriptInfo.from(found);
   }
 }

package/src/client/clientTypes.ts

@@ -1,10 +1,16 @@
 import {
   Cell,
+  CellDep,
+  CellDepLike,
   Epoch,
+  HashType,
+  HashTypeLike,
   OutPoint,
   OutPointLike,
   Script,
+  ScriptLike,
   Transaction,
+  hashTypeFrom,
 } from "../ckb/index.js";
 import { Hex, HexLike, hexFrom } from "../hex/index.js";
 import { Num, NumLike, numFrom } from "../num/index.js";
@@ -15,6 +21,87 @@ import {
   clientSearchKeyRangeFrom,
 } from "./clientTypes.advanced.js";
 
+/**
+ * @public
+ */
+export enum KnownScript {
+  NervosDao = "NervosDao",
+  Secp256k1Blake160 = "Secp256k1Blake160",
+  Secp256k1Multisig = "Secp256k1Multisig",
+  AnyoneCanPay = "AnyoneCanPay",
+  TypeId = "TypeId",
+  XUdt = "XUdt",
+  JoyId = "JoyId",
+  COTA = "COTA",
+  PWLock = "PWLock",
+  OmniLock = "OmniLock",
+  NostrLock = "NostrLock",
+  UniqueType = "UniqueType",
+
+  // ckb-proxy-locks https://github.com/ckb-ecofund/ckb-proxy-locks
+  AlwaysSuccess = "AlwaysSuccess",
+  InputTypeProxyLock = "InputTypeProxyLock",
+  OutputTypeProxyLock = "OutputTypeProxyLock",
+  LockProxyLock = "LockProxyLock",
+  SingleUseLock = "SingleUseLock",
+  TypeBurnLock = "TypeBurnLock",
+  EasyToDiscoverType = "EasyToDiscoverType",
+  TimeLock = "TimeLock",
+}
+
+/**
+ * @public
+ */
+export type CellDepInfoLike = {
+  cellDep: CellDepLike;
+  type?: ScriptLike | null;
+};
+
+/**
+ * @public
+ */
+export class CellDepInfo {
+  constructor(
+    public cellDep: CellDep,
+    public type?: Script,
+  ) {}
+
+  static from(cellDepInfoLike: CellDepInfoLike): CellDepInfo {
+    return new CellDepInfo(
+      CellDep.from(cellDepInfoLike.cellDep),
+      apply(Script.from, cellDepInfoLike.type),
+    );
+  }
+}
+
+/**
+ * @public
+ */
+export type ScriptInfoLike = {
+  codeHash: HexLike;
+  hashType: HashTypeLike;
+  cellDeps: CellDepInfoLike[];
+};
+
+/**
+ * @public
+ */
+export class ScriptInfo {
+  constructor(
+    public codeHash: Hex,
+    public hashType: HashType,
+    public cellDeps: CellDepInfo[],
+  ) {}
+
+  static from(scriptInfoLike: ScriptInfoLike): ScriptInfo {
+    return new ScriptInfo(
+      hexFrom(scriptInfoLike.codeHash),
+      hashTypeFrom(scriptInfoLike.hashType),
+      scriptInfoLike.cellDeps.map((c) => CellDepInfo.from(c)),
+    );
+  }
+}
+
 /**
  * @public
  */

package/src/client/jsonRpc/index.ts

@@ -26,7 +26,12 @@ import {
   Transport,
   transportFromUri,
 } from "../transports/advanced.js";
-import { JsonRpcCellOutput, JsonRpcTransformers } from "./advanced.js";
+import {
+  JsonRpcBlock,
+  JsonRpcBlockHeader,
+  JsonRpcCellOutput,
+  JsonRpcTransformers,
+} from "./advanced.js";
 
 /**
  * Applies a transformation function to a value if the transformer is provided.
@@ -127,8 +132,11 @@ export abstract class ClientJsonRpc extends Client {
 
   getFeeRateStatistics = this.buildSender(
     "get_fee_rate_statistics",
-    [(n) => apply(numFrom, n)],
-    ({ mean, median }) => ({ mean: numFrom(mean), median: numFrom(median) }),
+    [(n: NumLike) => apply(numFrom, n)],
+    ({ mean, median }: { mean: NumLike; median: NumLike }) => ({
+      mean: numFrom(mean),
+      median: numFrom(median),
+    }),
   ) as Client["getFeeRateStatistics"];
 
   /**
@@ -149,8 +157,10 @@ export abstract class ClientJsonRpc extends Client {
    * @param verbosity - result format which allows 0 and 1. (Optional, the default is 1.)
    * @returns BlockHeader
    */
-  getTipHeader = this.buildSender("get_tip_header", [], (b) =>
-    apply(JsonRpcTransformers.blockHeaderTo, b),
+  getTipHeader = this.buildSender(
+    "get_tip_header",
+    [],
+    (b: JsonRpcBlockHeader) => apply(JsonRpcTransformers.blockHeaderTo, b),
   ) as Client["getTipHeader"];
 
   /**
@@ -164,7 +174,7 @@ export abstract class ClientJsonRpc extends Client {
   getBlockByNumber = this.buildSender(
     "get_block_by_number",
     [(v: NumLike) => numToHex(numFrom(v))],
-    (b) => apply(JsonRpcTransformers.blockTo, b),
+    (b: JsonRpcBlock) => apply(JsonRpcTransformers.blockTo, b),
   ) as Client["getBlockByNumber"];
 
   /**
@@ -175,7 +185,7 @@ export abstract class ClientJsonRpc extends Client {
    * @param withCycles - whether the return cycles of block transactions. (Optional, default false.)
    * @returns Block
    */
-  getBlockByHash = this.buildSender("get_block", [hexFrom], (b) =>
+  getBlockByHash = this.buildSender("get_block", [hexFrom], (b: JsonRpcBlock) =>
     apply(JsonRpcTransformers.blockTo, b),
   ) as Client["getBlockByHash"];
 
@@ -189,7 +199,7 @@ export abstract class ClientJsonRpc extends Client {
   getHeaderByNumber = this.buildSender(
     "get_header_by_number",
     [(v: NumLike) => numToHex(numFrom(v))],
-    (b) => apply(JsonRpcTransformers.blockHeaderTo, b),
+    (b: JsonRpcBlockHeader) => apply(JsonRpcTransformers.blockHeaderTo, b),
   ) as Client["getHeaderByNumber"];
 
   /**
@@ -199,8 +209,10 @@ export abstract class ClientJsonRpc extends Client {
    * @param verbosity - result format which allows 0 and 1. (Optional, the default is 1.)
    * @returns BlockHeader
    */
-  getHeaderByHash = this.buildSender("get_header", [hexFrom], (b) =>
-    apply(JsonRpcTransformers.blockHeaderTo, b),
+  getHeaderByHash = this.buildSender(
+    "get_header",
+    [hexFrom],
+    (b: JsonRpcBlockHeader) => apply(JsonRpcTransformers.blockHeaderTo, b),
   ) as Client["getHeaderByHash"];
 
   /**
@@ -315,8 +327,8 @@ export abstract class ClientJsonRpc extends Client {
     "get_cells",
     [
       JsonRpcTransformers.indexerSearchKeyFrom,
-      (order) => order ?? "asc",
-      (limit) => numToHex(limit ?? 10),
+      (order?: "asc" | "desc") => order ?? "asc",
+      (limit?: NumLike) => numToHex(limit ?? 10),
     ],
     JsonRpcTransformers.findCellsResponseTo,
   ) as (
@@ -340,8 +352,8 @@ export abstract class ClientJsonRpc extends Client {
     "get_transactions",
     [
       JsonRpcTransformers.indexerSearchKeyTransactionFrom,
-      (order) => order ?? "asc",
-      (limit) => numToHex(limit ?? 10),
+      (order?: "asc" | "desc") => order ?? "asc",
+      (limit?: NumLike) => numToHex(limit ?? 10),
     ],
     JsonRpcTransformers.findTransactionsResponseTo,
   ) as Client["findTransactionsPaged"];
@@ -356,7 +368,7 @@ export abstract class ClientJsonRpc extends Client {
   getCellsCapacity = this.buildSender(
     "get_cells_capacity",
     [JsonRpcTransformers.indexerSearchKeyFrom],
-    ({ capacity }) => numFrom(capacity),
+    ({ capacity }: { capacity: NumLike }) => numFrom(capacity),
   ) as (key: ClientIndexerSearchKeyLike) => Promise<Num>;
 
   /**
@@ -370,7 +382,9 @@ export abstract class ClientJsonRpc extends Client {
 
   buildSender(
     rpcMethod: string,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     inTransformers: (((_: any) => unknown) | undefined)[],
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     outTransformer?: (_: any) => unknown,
   ): (...req: unknown[]) => Promise<unknown> {
     return async (...req: unknown[]) => {

package/src/client/transports/http.ts

@@ -10,6 +10,7 @@ export class TransportHttp implements Transport {
     const aborter = new AbortController();
     const abortTimer = setTimeout(() => aborter.abort(), this.timeout);
 
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     const raw = await (
       await fetch(this.url, {
         method: "POST",
@@ -21,6 +22,7 @@ export class TransportHttp implements Transport {
       })
     ).json();
     clearTimeout(abortTimer);
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return raw;
   }
 }

package/src/client/transports/webSocket.ts

@@ -29,19 +29,26 @@ export class TransportWebSocket implements Transport {
         return this.openSocket;
       }
       const socket = new WebSocket(this.url);
-      const onMessage = ({ data }: { data: string }) => {
-        const res = JSON.parse(data);
-        if (typeof res !== "object" || res === null) {
-          throw new Error(`Unknown response ${data}`);
+      const onMessage = ({ data }: WebSocket.MessageEvent) => {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const res = JSON.parse(data as string);
+        if (
+          typeof res !== "object" ||
+          res === null ||
+          typeof res.id !== "number"
+        ) {
+          throw new Error(`Unknown response ${data as string}`);
         }
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const id: number = res.id;
 
-        const req = this.ongoing.get(res.id);
+        const req = this.ongoing.get(id);
         if (!req) {
           return;
         }
         const [resolve, _, timeout] = req;
         clearTimeout(timeout);
-        this.ongoing.delete(res.id);
+        this.ongoing.delete(id);
 
         resolve(res);
       };
@@ -80,13 +87,13 @@ export class TransportWebSocket implements Transport {
         reject,
         setTimeout(() => {
           this.ongoing.delete(data.id);
-          socket.then((socket) => socket.close());
+          void socket.then((socket) => socket.close());
           reject(new Error("Request timeout"));
         }, this.timeout),
       ];
       this.ongoing.set(data.id, req);
 
-      socket.then((socket) => {
+      void socket.then((socket) => {
         if (
           socket.readyState === socket.CLOSED ||
           socket.readyState === socket.CLOSING

package/src/signer/ckb/verifyJoyId.ts

@@ -12,8 +12,12 @@ export function verifyMessageJoyId(
 ): Promise<boolean> {
   const challenge =
     typeof message === "string" ? message : hexFrom(message).slice(2);
-  const { publicKey, keyType } = JSON.parse(identity);
+  const { publicKey, keyType } = JSON.parse(identity) as {
+    publicKey: string;
+    keyType: string;
+  };
 
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
   return verifySignature({
     challenge,
     pubkey: publicKey,

package/src/signer/nostr/signerNostr.ts

@@ -112,7 +112,7 @@ export abstract class SignerNostr extends Signer {
    * @returns A promise that resolves to a signed Transaction object.
    */
   async signOnlyTransaction(txLike: TransactionLike): Promise<Transaction> {
-    let tx = Transaction.from(txLike);
+    const tx = Transaction.from(txLike);
     const { script } = await this.getRecommendedAddressObj();
     const info = await tx.getSignHashInfo(script, this.client);
     if (!info) {

package/src/signer/nostr/verify.ts

@@ -13,6 +13,7 @@ export function buildNostrEventFromMessage(
 ): NostrEvent {
   if (typeof message === "string") {
     try {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
       const event = JSON.parse(message);
       if (
         typeof event === "object" &&
@@ -26,7 +27,7 @@ export function buildNostrEventFromMessage(
             (tag as unknown[]).every((v) => typeof v === "string"),
         )
       ) {
-        return event;
+        return event as NostrEvent;
       }
     } catch (_) {}
   }

package/src/utils/index.ts

@@ -106,7 +106,7 @@ export function apply<T, R>(
  * @param accumulator - A callback to be called for each value. If it returns null, the previous result will be kept.
  * @returns The accumulated result.
  */
-export async function reduceAsync<T, V>(
+export async function reduceAsync<T>(
   values: T[],
   accumulator: (
     a: T,

package/dist/fixedPoint/index.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.test.d.ts.map

package/dist/fixedPoint/index.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../src/fixedPoint/index.test.ts"],"names":[],"mappings":""}

package/dist/fixedPoint/index.test.js

@@ -1,43 +0,0 @@
-import { fixedPointFrom, fixedPointToString } from "./index.js";
-describe("fixedPointToString", () => {
-    const cases = [
-        [0n, "0"],
-        [1n, "0.00000001"],
-        [100000000n, "1"],
-        [1000000000n, "10"],
-        [1010100000n, "10.101"],
-        [11n, "1.1", 1],
-        [0n, "0", 1],
-        [1n, "1", 0],
-        [0n, "0", 0],
-    ];
-    cases.forEach(([i, o, decimals]) => test(`${i} with ${decimals ?? "default"} decimals = "${o}"`, () => {
-        expect(fixedPointToString(i, decimals)).toBe(o);
-    }));
-});
-describe("fixedPointFrom string", () => {
-    const cases = [
-        ["0", 0n],
-        ["0.00000001", 1n],
-        ["1", 100000000n],
-        ["10", 1000000000n],
-        ["10.101", 1010100000n],
-        ["1.1", 11n, 1],
-        ["0", 0n, 1],
-        ["1", 1n, 0],
-        ["0", 0n, 0],
-    ];
-    cases.forEach(([i, o, decimals]) => test(`"${i}" = ${o} with ${decimals ?? "default"} decimals `, () => {
-        expect(fixedPointFrom(i, decimals)).toBe(o);
-    }));
-});
-describe("fixedPointFrom number", () => {
-    const cases = [
-        [0.00000001, 1n],
-        [10.101, 1010100000n],
-        [1.1, 11n, 1],
-    ];
-    cases.forEach(([i, o, decimals]) => test(`${i} = ${o} with ${decimals ?? "default"} decimals `, () => {
-        expect(fixedPointFrom(i, decimals)).toBe(o);
-    }));
-});

package/dist.commonjs/fixedPoint/index.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.test.d.ts.map

package/dist.commonjs/fixedPoint/index.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../src/fixedPoint/index.test.ts"],"names":[],"mappings":""}

package/dist.commonjs/fixedPoint/index.test.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_js_1 = require("./index.js");
-describe("fixedPointToString", () => {
-    const cases = [
-        [0n, "0"],
-        [1n, "0.00000001"],
-        [100000000n, "1"],
-        [1000000000n, "10"],
-        [1010100000n, "10.101"],
-        [11n, "1.1", 1],
-        [0n, "0", 1],
-        [1n, "1", 0],
-        [0n, "0", 0],
-    ];
-    cases.forEach(([i, o, decimals]) => test(`${i} with ${decimals ?? "default"} decimals = "${o}"`, () => {
-        expect((0, index_js_1.fixedPointToString)(i, decimals)).toBe(o);
-    }));
-});
-describe("fixedPointFrom string", () => {
-    const cases = [
-        ["0", 0n],
-        ["0.00000001", 1n],
-        ["1", 100000000n],
-        ["10", 1000000000n],
-        ["10.101", 1010100000n],
-        ["1.1", 11n, 1],
-        ["0", 0n, 1],
-        ["1", 1n, 0],
-        ["0", 0n, 0],
-    ];
-    cases.forEach(([i, o, decimals]) => test(`"${i}" = ${o} with ${decimals ?? "default"} decimals `, () => {
-        expect((0, index_js_1.fixedPointFrom)(i, decimals)).toBe(o);
-    }));
-});
-describe("fixedPointFrom number", () => {
-    const cases = [
-        [0.00000001, 1n],
-        [10.101, 1010100000n],
-        [1.1, 11n, 1],
-    ];
-    cases.forEach(([i, o, decimals]) => test(`${i} = ${o} with ${decimals ?? "default"} decimals `, () => {
-        expect((0, index_js_1.fixedPointFrom)(i, decimals)).toBe(o);
-    }));
-});

package/src/fixedPoint/index.test.ts

@@ -1,55 +0,0 @@
-import { fixedPointFrom, fixedPointToString } from "./index.js";
-
-describe("fixedPointToString", () => {
-  const cases: [bigint, string, number?][] = [
-    [0n, "0"],
-    [1n, "0.00000001"],
-    [100000000n, "1"],
-    [1000000000n, "10"],
-    [1010100000n, "10.101"],
-    [11n, "1.1", 1],
-    [0n, "0", 1],
-    [1n, "1", 0],
-    [0n, "0", 0],
-  ];
-
-  cases.forEach(([i, o, decimals]) =>
-    test(`${i} with ${decimals ?? "default"} decimals = "${o}"`, () => {
-      expect(fixedPointToString(i, decimals)).toBe(o);
-    }),
-  );
-});
-
-describe("fixedPointFrom string", () => {
-  const cases: [string, bigint, number?][] = [
-    ["0", 0n],
-    ["0.00000001", 1n],
-    ["1", 100000000n],
-    ["10", 1000000000n],
-    ["10.101", 1010100000n],
-    ["1.1", 11n, 1],
-    ["0", 0n, 1],
-    ["1", 1n, 0],
-    ["0", 0n, 0],
-  ];
-
-  cases.forEach(([i, o, decimals]) =>
-    test(`"${i}" = ${o} with ${decimals ?? "default"} decimals `, () => {
-      expect(fixedPointFrom(i, decimals)).toBe(o);
-    }),
-  );
-});
-
-describe("fixedPointFrom number", () => {
-  const cases: [number, bigint, number?][] = [
-    [0.00000001, 1n],
-    [10.101, 1010100000n],
-    [1.1, 11n, 1],
-  ];
-
-  cases.forEach(([i, o, decimals]) =>
-    test(`${i} = ${o} with ${decimals ?? "default"} decimals `, () => {
-      expect(fixedPointFrom(i, decimals)).toBe(o);
-    }),
-  );
-});