Merge pull request #701 from ckb-js/replace-node-crypto-randomBytes

twhy · web-flow · commit d4c2cbaada31 · 2024-06-06T17:15:27.000+08:00
feat: add lumos crypto.randomBytes to replace node's
diff --git a/.changeset/tough-beers-roll.md b/.changeset/tough-beers-roll.md
@@ -0,0 +1,6 @@
+---
+"@ckb-lumos/crypto": minor
+"@ckb-lumos/lumos": minor
+---
+
+feat: add crypto.randomBytes to replace Node's crypto.randomBytes
diff --git a/.github/.codecov.yml b/.github/.codecov.yml
@@ -12,6 +12,12 @@ coverage:
         target: auto
         threshold: 1%
         base: auto
+    patch:
+      default:
+        # basic settings
+        target: auto
+        threshold: 1%
+        base: auto
 
 parsers:
   gcov:
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -9,9 +9,10 @@ jobs:
       - uses: pnpm/action-setup@v2
         with:
           version: 8.6.1
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           cache: "pnpm"
+          node-version: '18'
 
       - name: Install project dependencies and build
         run: |
@@ -38,9 +39,10 @@ jobs:
       - uses: pnpm/action-setup@v2
         with:
           version: 8.6.1
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           cache: "pnpm"
+          node-version: '18'
 
       - name: Install project dependencies and build
         run: |
@@ -60,7 +62,7 @@ jobs:
       - uses: pnpm/action-setup@v2
         with:
           version: 8.6.1
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           cache: "pnpm"
 
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -1,6 +1,7 @@
 const scopeEnumValues = [
   "base",
   "bi",
+  "crypto",
   "ckb-indexer",
   "common-scripts",
   "config-manager",
diff --git a/packages/ckb-indexer/package.json b/packages/ckb-indexer/package.json
@@ -28,6 +28,7 @@
     "events": "^3.3.0"
   },
   "devDependencies": {
+    "@ckb-lumos/crypto": "0.23.0",
     "@ckb-lumos/testkit": "0.23.0",
     "@types/lodash.uniqby": "^4.7.7",
     "@types/request": "^2.48.8",
diff --git a/packages/ckb-indexer/tests/transaction_collector.unit.test.ts b/packages/ckb-indexer/tests/transaction_collector.unit.test.ts
@@ -1,5 +1,5 @@
-import { randomBytes } from "crypto";
 import test from "ava";
+import { randomBytes } from "@ckb-lumos/crypto";
 import { Indexer, TransactionCollector } from "../src";
 import {
   indexerTransactionListThatHaveOneIoTypeInput,
diff --git a/packages/codec/package.json b/packages/codec/package.json
@@ -45,6 +45,7 @@
     ]
   },
   "devDependencies": {
+    "@ckb-lumos/crypto": "0.23.0",
     "escape-string-regexp": "^4.0.0",
     "js-yaml": "^4.1.0"
   }
diff --git a/packages/codec/tests/bytes-like.test.ts b/packages/codec/tests/bytes-like.test.ts
@@ -1,7 +1,7 @@
 import test from "ava";
 import { molecule, number } from "../src";
 import { Byte32 } from "../src/blockchain";
-import { randomBytes } from "crypto";
+import { randomBytes } from "@ckb-lumos/crypto";
 import { equal, concat, hexify } from "../src/bytes";
 import { BI } from "@ckb-lumos/bi";
 import { bytify } from "../lib/bytes";
diff --git a/packages/common-scripts/package.json b/packages/common-scripts/package.json
@@ -55,6 +55,7 @@
     ]
   },
   "devDependencies": {
+    "@ckb-lumos/crypto": "0.23.0",
     "@ckb-lumos/debugger": "0.23.0",
     "@ckb-lumos/hd": "0.23.0",
     "@types/keccak": "^3.0.1",
diff --git a/packages/common-scripts/tests/dao-with-custom-lock.test.ts b/packages/common-scripts/tests/dao-with-custom-lock.test.ts
@@ -13,7 +13,7 @@ import { dao } from "../src";
 import { Config, predefined } from "@ckb-lumos/config-manager";
 import { hexify } from "@ckb-lumos/codec/lib/bytes";
 import { Uint64 } from "@ckb-lumos/codec/lib/number";
-import { randomBytes } from "node:crypto";
+import { randomBytes } from "@ckb-lumos/crypto";
 
 const { LINA } = predefined;
 
diff --git a/packages/config-manager/package.json b/packages/config-manager/package.json
@@ -41,6 +41,9 @@
     "@types/deep-freeze-strict": "^1.1.0",
     "deep-freeze-strict": "^1.1.1"
   },
+  "devDependencies": {
+    "@ckb-lumos/crypto": "0.23.0"
+  },
   "publishConfig": {
     "access": "public"
   },
diff --git a/packages/config-manager/tests/refresh.test.ts b/packages/config-manager/tests/refresh.test.ts
@@ -1,15 +1,15 @@
 import test from "ava";
+import { spy } from "sinon";
 import {
   createLatestTypeIdResolver,
   createRpcResolver,
   FetchOutputsByTxHashes,
   refreshScriptConfigs,
 } from "../src/refresh";
-import { ScriptConfigs } from "../src";
 import { hexify } from "@ckb-lumos/codec/lib/bytes";
-import { randomBytes } from "node:crypto";
 import { OutPoint, Output, Script } from "@ckb-lumos/base";
-import { spy } from "sinon";
+import { randomBytes } from "@ckb-lumos/crypto";
+import { ScriptConfigs } from "../src";
 
 test("refresh without update", async (t) => {
   const scriptConfigs: ScriptConfigs = {
diff --git a/packages/crypto/.eslintignore b/packages/crypto/.eslintignore
@@ -0,0 +1 @@
+lib
diff --git a/packages/crypto/.gitignore b/packages/crypto/.gitignore
@@ -0,0 +1 @@
+lib
diff --git a/packages/crypto/CHANGELOG.md b/packages/crypto/CHANGELOG.md
@@ -0,0 +1 @@
+# @ckb-lumos/crypto
diff --git a/packages/crypto/READMD.md b/packages/crypto/READMD.md
@@ -0,0 +1,3 @@
+# `@ckb-lumos/crypto`
+
+Crypto utilities used in Lumos.
diff --git a/packages/crypto/package.json b/packages/crypto/package.json
@@ -0,0 +1,52 @@
+{
+  "name": "@ckb-lumos/crypto",
+  "version": "0.23.0",
+  "description": "Crypto utilities used in Lumos",
+  "author": "Tom Wang <tom.wanghaiyi@gmail.com@gmail.com>",
+  "homepage": "https://github.com/ckb-js/lumos#readme",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "directories": {
+    "lib": "lib",
+    "test": "tests"
+  },
+  "files": [
+    "lib",
+    "index.d.ts"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ckb-js/lumos.git"
+  },
+  "scripts": {
+    "build": "pnpm run build:types && pnpm run build:js",
+    "build:types": "tsc --declaration --emitDeclarationOnly",
+    "build:js": "babel --root-mode upward src --out-dir lib --extensions .ts -s",
+    "fmt": "prettier --write \"{src,tests,examples}/**/*.ts\" package.json",
+    "lint": "eslint -c ../../.eslintrc.js \"{src,tests,examples}/**/*.ts\"",
+    "clean": "shx rm -rf lib",
+    "test": "ava **/*.test.{js,ts} --timeout=2m"
+  },
+  "bugs": {
+    "url": "https://github.com/ckb-js/lumos/issues"
+  },
+  "ava": {
+    "extensions": [
+      "ts",
+      "js"
+    ],
+    "require": [
+      "ts-node/register"
+    ]
+  },
+  "dependencies": {
+    "@noble/hashes": "^1.4.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}
diff --git a/packages/crypto/src/index.ts b/packages/crypto/src/index.ts
@@ -0,0 +1 @@
+export { randomBytes } from "@noble/hashes/utils";
diff --git a/packages/crypto/tests/index.test.ts b/packages/crypto/tests/index.test.ts
@@ -0,0 +1,10 @@
+import test from "ava";
+import { randomBytes } from "../src";
+
+test("randomBytes", (t) => {
+  const size = 32;
+  const bytes = randomBytes(size);
+  t.is(bytes.length, size);
+  t.is(bytes.byteLength, size);
+  t.is(bytes.constructor, Uint8Array);
+});
diff --git a/packages/crypto/tsconfig.json b/packages/crypto/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "lib",
+    "sourceMap": true
+  },
+  "include": ["src"]
+}
diff --git a/packages/crypto/typedoc.json b/packages/crypto/typedoc.json
@@ -0,0 +1,4 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"]
+}
diff --git a/packages/debugger/package.json b/packages/debugger/package.json
@@ -24,6 +24,7 @@
     "@ckb-lumos/base": "0.23.0",
     "@ckb-lumos/bi": "0.23.0",
     "@ckb-lumos/codec": "0.23.0",
+    "@ckb-lumos/crypto": "0.23.0",
     "@ckb-lumos/config-manager": "0.23.0",
     "@ckb-lumos/helpers": "0.23.0",
     "@ckb-lumos/rpc": "0.23.0",
diff --git a/packages/debugger/src/context.ts b/packages/debugger/src/context.ts
@@ -1,5 +1,5 @@
+import { randomBytes } from "@ckb-lumos/crypto";
 import { Header, OutPoint } from "@ckb-lumos/base";
-import * as crypto from "crypto";
 import { ScriptConfig } from "@ckb-lumos/config-manager";
 import { OutputDataLoader } from "./loader";
 import { DataLoader, TestContext } from "./types";
@@ -14,9 +14,8 @@ const TRANSACTION_HASH_LENGTH = 32;
 
 export function mockOutPoint(): OutPoint {
   return {
-    txHash: hexify(crypto.randomBytes(TRANSACTION_HASH_LENGTH)),
-    index:
-      "0x" + Uint32.unpack(crypto.randomBytes(Uint32.byteLength)).toString(16),
+    txHash: hexify(randomBytes(TRANSACTION_HASH_LENGTH)),
+    index: "0x" + Uint32.unpack(randomBytes(Uint32.byteLength)).toString(16),
   };
 }
 
diff --git a/packages/debugger/src/executor.ts b/packages/debugger/src/executor.ts
@@ -1,12 +1,12 @@
 import { DataLoader, ExecuteResult, Executor } from "./types";
 import { TransactionSkeletonType } from "@ckb-lumos/helpers";
+import { randomBytes } from "@ckb-lumos/crypto";
 import { spawnSync } from "child_process";
 import { Hash } from "@ckb-lumos/base";
 import * as fs from "fs";
 import * as os from "os";
 import * as path from "path";
 import { parseDebuggerData, parseDebuggerMessage } from "./parse";
-import * as crypto from 'crypto';
 
 interface DebuggerOptions {
   readonly loader: DataLoader;
@@ -51,8 +51,9 @@ export class CKBDebugger implements Executor {
    */
   private saveTmpTxFile(txSkeleton: TransactionSkeletonType): string {
     const debuggerData = parseDebuggerData(txSkeleton, this.loader);
-    const randomHex = crypto.randomBytes(18).toString('hex');    
-    const tempFileName = `lumos-debugger-data-${randomHex}`    
+    // eslint-disable-next-line @typescript-eslint/no-magic-numbers
+    const randomHex = Buffer.from(randomBytes(18)).toString("hex");
+    const tempFileName = `lumos-debugger-data-${randomHex}`;
     const tmpTxPath = path.join(os.tmpdir(), `${tempFileName}.json`);
     fs.writeFileSync(tmpTxPath, JSON.stringify(debuggerData));
 
diff --git a/packages/debugger/tests/context.test.ts b/packages/debugger/tests/context.test.ts
@@ -4,6 +4,7 @@ import {
   createScriptRegistry,
 } from "@ckb-lumos/experiment-tx-assembler";
 import { computeScriptHash } from "@ckb-lumos/base/lib/utils";
+import { randomBytes } from "@ckb-lumos/crypto";
 import { HexString } from "@ckb-lumos/base";
 import { CKBDebugger, CKBDebuggerDownloader, DataLoader } from "../src";
 import { TransactionSkeleton } from "@ckb-lumos/helpers";
@@ -12,7 +13,6 @@ import {
   getDefaultConfig,
   mockOutPoint,
 } from "../src/context";
-import { randomBytes } from "crypto";
 import { privateKeyToBlake160, signRecoverable } from "@ckb-lumos/hd/lib/key";
 import { hexify } from "@ckb-lumos/codec/lib/bytes";
 import {
diff --git a/packages/e2e-test/package.json b/packages/e2e-test/package.json
@@ -34,6 +34,7 @@
     "@ckb-lumos/bi": "0.23.0",
     "@ckb-lumos/ckb-indexer": "0.23.0",
     "@ckb-lumos/codec": "0.23.0",
+    "@ckb-lumos/crypto": "0.23.0",
     "@ckb-lumos/common-scripts": "0.23.0",
     "@ckb-lumos/config-manager": "0.23.0",
     "@ckb-lumos/hd": "0.23.0",
diff --git a/packages/e2e-test/src/utils.ts b/packages/e2e-test/src/utils.ts
@@ -1,11 +1,12 @@
 import { Script } from "@ckb-lumos/base";
+import { randomBytes } from "@ckb-lumos/crypto";
 import { encodeToAddress } from "@ckb-lumos/helpers";
-import { randomBytes } from "crypto";
 import { key } from "@ckb-lumos/hd";
 import { getConfig } from "@ckb-lumos/config-manager";
 import { hexify } from "@ckb-lumos/codec/lib/bytes";
 
 // secp256k1 private key is 32-bytes length
+/* eslint-disable @typescript-eslint/no-magic-numbers */
 export const generateRandomPrivateKey = (): string => hexify(randomBytes(32));
 
 export function asyncSleep(ms: number): Promise<unknown> {
diff --git a/packages/hd/package.json b/packages/hd/package.json
@@ -21,6 +21,7 @@
   "dependencies": {
     "@ckb-lumos/base": "0.23.0",
     "@ckb-lumos/bi": "0.23.0",
+    "@ckb-lumos/crypto": "0.23.0",
     "bn.js": "^5.1.3",
     "elliptic": "^6.5.4",
     "scrypt-js": "^3.0.1",
diff --git a/packages/hd/src/keystore.ts b/packages/hd/src/keystore.ts
@@ -1,7 +1,13 @@
-import crypto from "crypto";
+import {
+  Cipher,
+  ScryptOptions,
+  createCipheriv,
+  createDecipheriv,
+} from "crypto";
 import { Keccak } from "sha3";
 import { v4 as uuid } from "uuid";
 import { ExtendedPrivateKey } from "./extended_key";
+import { randomBytes } from "@ckb-lumos/crypto";
 import { HexString } from "@ckb-lumos/base";
 import { syncScrypt } from "scrypt-js";
 
@@ -94,8 +100,8 @@ export default class Keystore {
   // Create an empty keystore object that contains empty private key
   static createEmpty(): Keystore {
     const saltSize = 32;
-    const salt: Buffer = crypto.randomBytes(saltSize);
-    const iv: Buffer = crypto.randomBytes(16);
+    const salt: Buffer = Buffer.from(randomBytes(saltSize));
+    const iv: Buffer = Buffer.from(randomBytes(16));
     const kdfparams: KdfParams = {
       dklen: 32,
       salt: salt.toString("hex"),
@@ -125,8 +131,8 @@ export default class Keystore {
   ): Keystore {
     const saltSize = 32;
     const ivSize = 16;
-    const salt: Buffer = options.salt || crypto.randomBytes(saltSize);
-    const iv: Buffer = options.iv || crypto.randomBytes(ivSize);
+    const salt: Buffer = options.salt || Buffer.from(randomBytes(saltSize));
+    const iv: Buffer = options.iv || Buffer.from(randomBytes(ivSize));
     const kdfparams: KdfParams = {
       dklen: 32,
       salt: salt.toString("hex"),
@@ -145,11 +151,7 @@ export default class Keystore {
       )
     );
 
-    const cipher: crypto.Cipher = crypto.createCipheriv(
-      CIPHER,
-      derivedKey.slice(0, 16),
-      iv
-    );
+    const cipher: Cipher = createCipheriv(CIPHER, derivedKey.slice(0, 16), iv);
     if (!cipher) {
       throw new UnsupportedCipher();
     }
@@ -190,7 +192,7 @@ export default class Keystore {
     if (Keystore.mac(derivedKey, ciphertext) !== this.crypto.mac) {
       throw new IncorrectPassword();
     }
-    const decipher = crypto.createDecipheriv(
+    const decipher = createDecipheriv(
       this.crypto.cipher,
       derivedKey.slice(0, 16),
       Buffer.from(this.crypto.cipherparams.iv, "hex")
@@ -239,7 +241,7 @@ export default class Keystore {
     );
   }
 
-  static scryptOptions(kdfparams: KdfParams): crypto.ScryptOptions {
+  static scryptOptions(kdfparams: KdfParams): ScryptOptions {
     return {
       N: kdfparams.n,
       r: kdfparams.r,
diff --git a/packages/hd/src/mnemonic/index.ts b/packages/hd/src/mnemonic/index.ts
diff --git a/packages/helpers/package.json b/packages/helpers/package.json
diff --git a/packages/helpers/tests/model_helper.test.ts b/packages/helpers/tests/model_helper.test.ts
diff --git a/packages/helpers/tests/refresh.test.ts b/packages/helpers/tests/refresh.test.ts
diff --git a/packages/joyid/package.json b/packages/joyid/package.json
diff --git a/packages/joyid/tests/script-info.test.ts b/packages/joyid/tests/script-info.test.ts
diff --git a/packages/lumos/package.json b/packages/lumos/package.json
diff --git a/packages/lumos/src/index.ts b/packages/lumos/src/index.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@`
`45`	`45`	`]`
`46`	`46`	`},`
`47`	`47`	`"devDependencies": {`
	`48`	`+ "@ckb-lumos/crypto": "0.23.0",`
`48`	`49`	`"escape-string-regexp": "^4.0.0",`
`49`	`50`	`"js-yaml": "^4.1.0"`
`50`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@`
`55`	`55`	`]`
`56`	`56`	`},`
`57`	`57`	`"devDependencies": {`
	`58`	`+ "@ckb-lumos/crypto": "0.23.0",`
`58`	`59`	`"@ckb-lumos/debugger": "0.23.0",`
`59`	`60`	`"@ckb-lumos/hd": "0.23.0",`
`60`	`61`	`"@types/keccak": "^3.0.1",`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+# `@ckb-lumos/crypto`
	`2`	`+`
	`3`	`+Crypto utilities used in Lumos.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export { randomBytes } from "@noble/hashes/utils";`