refactor: use eslint in packages/examples

Author: ShookLyngs

.eslintrc.json

@@ -0,0 +1,20 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "rules": {
+  }
+}

.github/workflows/test.yaml

@@ -43,11 +43,11 @@ jobs:
       - name: Install dependencies
         run: pnpm i
 
-      - name: Lint packages
-        run: pnpm lint:fix
-
       - name: Build packages
         run: pnpm run build:packages
+
+      - name: Lint packages
+        run: pnpm run lint:packages
 
       - name: Run tests for packages
         run: pnpm run test:packages

.husky/pre-commit

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx lint-staged
+pnpm exec lint-staged

examples/rgbpp/eslint.config.js

@@ -6,7 +6,8 @@
   "type": "module",
   "scripts": {
     "format": "prettier --write '**/*.{js,ts}'",
-    "lint:fix": "pnpm eslint . && prettier --check '**/*.{js,ts}'"
+    "lint": "tsc && eslint . && prettier --check '**/*.{js,ts}'",
+    "lint:fix": "tsc && eslint --fix --ext .js,.ts . && prettier --write '**/*.{js,ts}'"
   },
   "dependencies": {
     "@exact-realty/multipart-parser": "^1.0.13",
@@ -18,10 +19,7 @@
     "axios": "^1.6.8"
   },
   "devDependencies": {
-    "@eslint/js": "^9.1.1",
     "@types/node": "^20.11.28",
-    "eslint": "^8.56.0",
-    "typescript": "^5.4.2",
-    "typescript-eslint": "^7.7.1"
+    "typescript": "^5.4.2"
   }
 }

examples/rgbpp/package.json

@@ -7,6 +7,7 @@
     "composite": false,
     "resolveJsonModule": true,
     "strictNullChecks": true,
+    "noEmit": true,
     "declaration": true,
     "declarationMap": true,
     "esModuleInterop": true,
@@ -18,7 +19,7 @@
     "noUnusedParameters": false,
     "preserveWatchOutput": true,
     "skipLibCheck": true,
-    "strict": true,
+    "strict": true
   },
   "include": ["local/**/*.ts", "queue/**/*.ts"],
   "exclude": ["node_modules"]

examples/rgbpp/tsconfig.json

@@ -7,10 +7,10 @@
   "scripts": {
     "prepare": "husky",
     "test:packages": "turbo run test --filter=./packages/*",
-    "build": "turbo run build",
     "build:packages": "turbo run build --filter=./packages/*",
     "lint:fix": "turbo run lint:fix",
-    "lint:fix-all": "prettier --write '{packages,apps, examples}/**/*.{js,jsx,ts,tsx,md,json}'",
+    "lint:packages": "turbo run lint --filter=./{packages,examples}/*",
+    "lint:fix-all": "prettier --write '{packages,apps,examples}/**/*.{js,jsx,ts,tsx,md,json}'",
     "clean": "turbo run clean",
     "clean:packages": "turbo run clean --filter=./packags/*",
     "clean:dependencies": "pnpm clean:sub-dependencies && rimraf node_modules",
@@ -20,6 +20,9 @@
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.1",
+    "@typescript-eslint/eslint-plugin": "^7.8.0",
+    "@typescript-eslint/parser": "^7.8.0",
+    "eslint": "^8.56.0",
     "husky": "^9.0.11",
     "lint-staged": "^15.2.2",
     "prettier": "^3.2.5",
@@ -29,7 +32,10 @@
     "typescript": "^5.4.3"
   },
   "lint-staged": {
-    "{packages,apps, examples}/**/*.{js,jsx,ts,tsx,md,json}": "prettier --ignore-unknown --write"
+    "{packages,apps,examples}/**/*.{js,jsx,ts,tsx,md,json}": [
+      "eslint --fix",
+      "prettier --ignore-unknown --write"
+    ]
   },
   "packageManager": "^pnpm@8.0.0",
   "engines": {

package.json

@@ -4,8 +4,8 @@
   "scripts": {
     "test": "vitest",
     "build": "tsc -p tsconfig.build.json",
-    "lint": "prettier --check '{src,tests}/**/*.{js,jsx,ts,tsx}'",
-    "lint:fix": "prettier --write '{src,tests}/**/*.{js,jsx,ts,tsx}'",
+    "lint": "tsc && eslint --ext .js,.ts {src,tests}/** && prettier --check '{src,tests}/**/*.{js,ts}'",
+    "lint:fix": "tsc && eslint --fix --ext .js,.ts {src,tests}/** && prettier --write '{src,tests}/**/*.{js,ts}'",
     "clean": "pnpm run clean:cache & pnpm run clean:build",
     "clean:build": "rimraf lib && pnpm run clean:buildinfo",
     "clean:buildinfo": "rimraf tsconfig.*tsbuildinfo",

packages/btc/package.json

@@ -154,7 +154,9 @@ export function decodeAddress(address: string): {
           dust: getAddressTypeDust(addressType),
         };
       }
-    } catch (e) {}
+    } catch (e) {
+      // Do nothing (no need to throw here)
+    }
   } else {
     try {
       decodeBase58 = bitcoin.address.fromBase58Check(address);
@@ -187,7 +189,9 @@ export function decodeAddress(address: string): {
           dust: getAddressTypeDust(addressType),
         };
       }
-    } catch (e) {}
+    } catch (e) {
+      // Do nothing (no need to throw here)
+    }
   }
 
   return {

packages/btc/src/address.ts

@@ -1,10 +1,4 @@
-import {
-  BtcApiRecommendedFeeRates,
-  BtcApiUtxoParams,
-  BtcAssetsApi,
-  BtcAssetsApiError,
-  ErrorCodes as ServiceErrorCodes,
-} from '@rgbpp-sdk/service';
+import { BtcApiUtxoParams, BtcAssetsApi, BtcAssetsApiError, ErrorCodes as ServiceErrorCodes } from '@rgbpp-sdk/service';
 import { Output, Utxo } from '../transaction/utxo';
 import { NetworkType } from '../preset/types';
 import { ErrorCodes, TxBuildError } from '../error';

packages/btc/src/query/source.ts

@@ -157,9 +157,17 @@ export class TxBuilder {
     // otherwise use the average fee rate from the DataSource
     const currentFeeRate = feeRate ?? this.feeRate ?? averageFeeRate!;
 
-    let currentFee: number = 0;
-    let previousFee: number = 0;
-    while (true) {
+    let currentFee = 0;
+    let previousFee = 0;
+    let isLoopedOnce = false;
+    let isFeeExpected = false;
+    while (!isFeeExpected) {
+      if (isLoopedOnce) {
+        previousFee = currentFee;
+        this.inputs = clone(originalInputs);
+        this.outputs = clone(originalOutputs);
+      }
+
       const { needCollect, needReturn, inputsTotal } = this.summary();
       const safeToProcess = inputsTotal > 0 || previousFee > 0;
       const returnAmount = needReturn - previousFee;
@@ -186,13 +194,10 @@ export class TxBuilder {
 
       const addressType = getAddressType(address);
       currentFee = await this.calculateFee(addressType, currentFeeRate);
-      if ([-1, 0, 1].includes(currentFee - previousFee)) {
-        break;
+      isFeeExpected = [-1, 0, 1].includes(currentFee - previousFee);
+      if (!isLoopedOnce) {
+        isLoopedOnce = true;
       }
-
-      previousFee = currentFee;
-      this.inputs = clone(originalInputs);
-      this.outputs = clone(originalOutputs);
     }
 
     return {

packages/btc/src/transaction/build.ts

@@ -33,8 +33,8 @@ export function opReturnScriptPubKeyToData(script: Buffer): Buffer {
     throw TxBuildError.withComment(ErrorCodes.UNSUPPORTED_OP_RETURN_SCRIPT, script.toString('hex'));
   }
 
-  const [_op, data] = bitcoin.script.decompile(script)!;
-  return data as Buffer;
+  const res = bitcoin.script.decompile(script)!;
+  return res[1] as Buffer;
 }
 
 /**

packages/btc/src/transaction/embed.ts

@@ -1,6 +1,10 @@
 import { bitcoin, ecc, ECPair } from './bitcoin';
 import { bytes } from '@ckb-lumos/codec';
 
+interface TweakableSigner extends bitcoin.Signer {
+  privateKey?: Buffer;
+}
+
 const textEncoder = new TextEncoder();
 
 export function toXOnly(pubKey: Buffer): Buffer {
@@ -11,14 +15,14 @@ function tapTweakHash(publicKey: Buffer, hash: Buffer | undefined): Buffer {
   return bitcoin.crypto.taggedHash('TapTweak', Buffer.concat(hash ? [publicKey, hash] : [publicKey]));
 }
 
-export function tweakSigner<T extends bitcoin.Signer>(
+export function tweakSigner<T extends TweakableSigner>(
   signer: T,
   options?: {
     network?: bitcoin.Network;
     tweakHash?: Buffer;
   },
 ): bitcoin.Signer {
-  let privateKey: Uint8Array | undefined = (signer as any).privateKey;
+  let privateKey: Uint8Array | undefined = signer.privateKey ? new Uint8Array(signer.privateKey) : undefined;
   if (!privateKey) {
     throw new Error('Private key is required for tweaking signer!');
   }
@@ -54,7 +58,7 @@ export function remove0x(hex: string): string {
  * utf8ToBuffer('hello') // => Uint8Array(5) [ 104, 101, 108, 108, 111 ]
  */
 export function utf8ToBuffer(text: string): Uint8Array {
-  let result = text.trim();
+  const result = text.trim();
   if (result.startsWith('0x')) {
     return bytes.bytify(result);
   }

packages/btc/src/utils.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { service, source } from './shared/env';
+import { source } from './shared/env';
 import { ErrorCodes } from '../src';
 
 describe('DataSource', { retry: 3 }, () => {

packages/btc/tests/DataSource.test.ts

@@ -36,15 +36,15 @@ const launchRgbppAsset = async () => {
   });
 
   const emptyWitness = { lock: '', inputType: '', outputType: '' };
-  let unsignedTx: CKBComponents.RawTransactionToSign = {
+  const unsignedTx: CKBComponents.RawTransactionToSign = {
     ...ckbRawTx,
     cellDeps: [...ckbRawTx.cellDeps, getSecp256k1CellDep(false)],
     witnesses: [emptyWitness, ...ckbRawTx.witnesses.slice(1)],
   };
 
   const signedTx = collector.getCkb().signTransaction(LAUNCH_SECP256K1_PRIVATE_KEY)(unsignedTx);
 
-  let txHash = await collector.getCkb().rpc.sendTransaction(signedTx, 'passthrough');
+  const txHash = await collector.getCkb().rpc.sendTransaction(signedTx, 'passthrough');
   console.info(`Rgbpp asset has been jumping from CKB to BTC and tx hash is ${txHash}`);
 };
 

packages/ckb/example/launch.ts

@@ -4,8 +4,8 @@
   "scripts": {
     "test": "vitest",
     "build": "tsc -p tsconfig.build.json",
-    "lint": "prettier --check 'src/**/*.{js,jsx,ts,tsx}'",
-    "lint:fix": "prettier --write 'src/**/*.{js,jsx,ts,tsx}'",
+    "lint": "tsc && eslint --ext .ts {src,example}/* && prettier --check '{src,example}/**/*.{js,ts}'",
+    "lint:fix": "tsc && eslint --fix --ext .ts {src,example}/* && prettier --write '{src,example}/**/*.{js,ts}'",
     "splitCells": "npx ts-node example/paymaster.ts",
     "clean": "pnpm run clean:cache & pnpm run clean:build",
     "clean:build": "rimraf lib && pnpm run clean:buildinfo",

packages/ckb/package.json

@@ -37,12 +37,12 @@ export class Collector {
     isDataMustBeEmpty?: boolean;
     outputCapacityRange?: Hex[];
   }): Promise<IndexerCell[] | undefined> {
-    let param: any = {
+    let param: unknown = {
       script_search_mode: 'exact',
     };
     if (lock) {
       param = {
-        ...param,
+        ...param!,
         script: parseScript(lock),
         script_type: 'lock',
         filter: {
@@ -53,19 +53,19 @@ export class Collector {
       };
     } else if (type) {
       param = {
-        ...param,
+        ...param!,
         script: parseScript(type),
         script_type: 'type',
       };
     }
-    let payload = {
+    const payload = {
       id: Math.floor(Math.random() * 100000),
       jsonrpc: '2.0',
       method: 'get_cells',
       params: [param, 'asc', '0x3E8'],
     };
     const body = JSON.stringify(payload, null, '  ');
-    let response = (
+    const response = (
       await axios({
         method: 'post',
         url: this.ckbIndexerUrl,
@@ -86,9 +86,9 @@ export class Collector {
 
   collectInputs(liveCells: IndexerCell[], needCapacity: bigint, fee: bigint, config?: CollectConfig): CollectResult {
     const changeCapacity = config?.minCapacity ?? MIN_CAPACITY;
-    let inputs: CKBComponents.CellInput[] = [];
+    const inputs: CKBComponents.CellInput[] = [];
     let sumInputsCapacity = BigInt(0);
-    for (let cell of liveCells) {
+    for (const cell of liveCells) {
       inputs.push({
         previousOutput: {
           txHash: cell.outPoint.txHash,
@@ -109,11 +109,11 @@ export class Collector {
   }
 
   collectUdtInputs({ liveCells, needAmount }: { liveCells: IndexerCell[]; needAmount: bigint }): CollectUdtResult {
-    let inputs: CKBComponents.CellInput[] = [];
+    const inputs: CKBComponents.CellInput[] = [];
     let sumInputsCapacity = BigInt(0);
     let sumAmount = BigInt(0);
     const isRgbppLock = liveCells.length > 0 && isRgbppLockCellIgnoreChain(liveCells[0].output);
-    for (let cell of liveCells) {
+    for (const cell of liveCells) {
       inputs.push({
         previousOutput: {
           txHash: cell.outPoint.txHash,

packages/ckb/src/collector/index.ts

@@ -29,7 +29,7 @@ export const splitMultiCellsWithSecp256k1 = async ({
 
   const cellCapacity = BigInt(capacityWithCKB) * CKB_UNIT;
   const needCapacity = cellCapacity * BigInt(cellAmount);
-  let txFee = MAX_FEE;
+  const txFee = MAX_FEE;
   const { inputs, sumInputsCapacity } = collector.collectInputs(emptyCells, needCapacity, txFee, {
     minCapacity: SECP256K1_MIN_CAPACITY,
   });

packages/ckb/src/paymaster/index.ts

@@ -157,7 +157,7 @@ export const signBtcTimeCellSpentTx = async ({
   const changeCapacity = BigInt(emptyCells[0].output.capacity) - estimatedTxFee;
   rawTx.outputs[0].capacity = append0x(changeCapacity.toString(16));
 
-  let keyMap = new Map<string, string>();
+  const keyMap = new Map<string, string>();
   keyMap.set(scriptToHash(masterLock), secp256k1PrivateKey);
   keyMap.set(scriptToHash(getBtcTimeLockScript(isMainnet)), '');