feat: rewrite spore-sdk in ccc

Author: ashuralyk

.changeset/dirty-knives-develop.md

@@ -0,0 +1,6 @@
+---
+"@ckb-ccc/spore": minor
+"@ckb-ccc/core": minor
+---
+
+add spore package and some known scripts

.gitignore

@@ -9,5 +9,6 @@ coverage
 packages/*/dist*
 
 .vscode
+.env.js
 
 *.DS_Store

config/tsconfig.base.json

@@ -18,5 +18,10 @@
     "forceConsistentCasingInFileNames": true,
     "skipLibCheck": true
   },
-  "include": ["src/**/*"]
-}
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "**/*test.ts"
+  ]
+}

env.example.js

@@ -0,0 +1,2 @@
+process.env.PRIVATE_KEY =
+  "0x0000000000000000000000000000000000000000000000000000000000000000";

jest.config.js

@@ -1,5 +1,9 @@
 /** @type {import('ts-jest').JestConfigWithTsJest} */
 module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-};
+  preset: "ts-jest",
+  testEnvironment: "node",
+  setupFiles: ["<rootDir>/.env.js"],
+  moduleNameMapper: {
+    "^(\\.\\.?\\/.+)\\.js$": "$1",
+  },
+};

package.json

@@ -21,8 +21,8 @@
     "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.7",
     "@types/jest": "^29.5.12",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.1.4",
+    "jest": "30.0.0-alpha.6",
+    "ts-jest": "^29.2.5",
     "typedoc": "^0.26.6",
     "typedoc-material-theme": "^1.1.0",
     "typedoc-plugin-extras": "^3.1.0",

packages/ccc/tsconfig.base.json

@@ -18,5 +18,6 @@
     "forceConsistentCasingInFileNames": true,
     "skipLibCheck": true
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "exclude": ["**/*test.ts"]
 }

packages/ckb-ccc/tsconfig.base.json

@@ -18,5 +18,6 @@
     "forceConsistentCasingInFileNames": true,
     "skipLibCheck": true
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "exclude": ["**/*test.ts"]
 }

packages/connector-react/tsconfig.base.json

@@ -19,5 +19,6 @@
     "forceConsistentCasingInFileNames": true,
     "skipLibCheck": true
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "exclude": ["**/*test.ts"]
 }

packages/connector/tsconfig.base.json

@@ -18,5 +18,6 @@
     "forceConsistentCasingInFileNames": true,
     "skipLibCheck": true
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "exclude": ["**/*test.ts"]
 }

packages/core/src/bytes/index.ts

@@ -8,7 +8,7 @@ export type Bytes = Uint8Array;
 /**
  * @public
  */
-export type BytesLike = string | Uint8Array | ArrayBuffer | number[];
+export type BytesLike = string | Uint8Array | ArrayBuffer | ArrayLike<number>;
 
 /**
  * Concatenates multiple byte-like arrays into a single byte array.
@@ -98,22 +98,23 @@ export function bytesFrom(
     return new Uint8Array(bytes);
   }
 
-  if (Array.isArray(bytes)) {
-    if (bytes.some((v) => v < 0 || 0xff < v)) {
-      throw new Error(`Invalid bytes ${JSON.stringify(bytes)}`);
+  if (typeof bytes === "string") {
+    if (encoding !== undefined) {
+      return Buffer.from(bytes, encoding);
     }
-    return new Uint8Array(bytes);
-  }
 
-  if (encoding !== undefined) {
-    return Buffer.from(bytes, encoding);
+    const str = bytes.startsWith("0x") ? bytes.slice(2) : bytes;
+    const paddedStr = str.length % 2 === 0 ? str : `0${str}`;
+    const data = Buffer.from(paddedStr, "hex");
+    if (data.length * 2 !== paddedStr.length) {
+      throw new Error(`Invalid bytes ${bytes}`);
+    }
+    return data;
   }
 
-  const str = bytes.startsWith("0x") ? bytes.slice(2) : bytes;
-  const paddedStr = str.length % 2 === 0 ? str : `0${str}`;
-  const data = Buffer.from(paddedStr, "hex");
-  if (data.length * 2 !== paddedStr.length) {
-    throw new Error(`Invalid bytes ${bytes}`);
+  const bytesArr = Array.from(bytes);
+  if (bytesArr.some((v) => v < 0 || 0xff < v)) {
+    throw new Error(`Invalid bytes ${JSON.stringify(bytes)}`);
   }
-  return data;
+  return new Uint8Array(bytes);
 }

packages/core/src/client/client.ts

@@ -1,22 +1,22 @@
 import {
   Cell,
   CellDep,
-  CellDepLike,
   OutPoint,
   OutPointLike,
-  Script,
   ScriptLike,
   Transaction,
   TransactionLike,
 } from "../ckb/index.js";
 import { Zero } from "../fixedPoint/index.js";
 import { Hex, HexLike, hexFrom } from "../hex/index.js";
 import { Num, NumLike, numFrom, numMax } from "../num/index.js";
-import { apply, reduceAsync, sleep } from "../utils/index.js";
+import { reduceAsync, sleep } from "../utils/index.js";
 import { ClientCache } from "./cache/index.js";
 import { ClientCacheMemory } from "./cache/memory.js";
 import { ClientCollectableSearchKeyLike } from "./clientTypes.advanced.js";
 import {
+  CellDepInfo,
+  CellDepInfoLike,
   ClientBlock,
   ClientBlockHeader,
   ClientFindCellsResponse,
@@ -27,62 +27,11 @@ import {
   ClientIndexerSearchKeyTransactionLike,
   ClientTransactionResponse,
   ErrorClientWaitTransactionTimeout,
+  KnownScript,
   OutputsValidator,
+  ScriptInfo,
 } from "./clientTypes.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
  */
@@ -96,11 +45,7 @@ export abstract class Client {
   abstract get url(): string;
   abstract get addressPrefix(): string;
 
-  abstract getKnownScript(
-    script: KnownScript,
-  ): Promise<
-    Pick<Script, "codeHash" | "hashType"> & { cellDeps: CellDepInfo[] }
-  >;
+  abstract getKnownScript(script: KnownScript): Promise<ScriptInfo>;
 
   abstract getFeeRateStatistics(
     blockRange?: NumLike,