Merge pull request #379 from ckb-devrel/develop

Merge 0.4.4 into master

Author: RetricSu

.github/workflows/canary-publish.yml

@@ -24,9 +24,6 @@ jobs:
       - name: Install dependencies
         run: npm install -g pnpm && pnpm i
 
-      - name: Build
-        run: pnpm build
-
       - name: Set up Git identity
         run: |
           git config --local user.email "github-actions[bot]@users.noreply.github.com"
@@ -37,6 +34,9 @@ jobs:
           SHORT_COMMIT_ID=$(git log -1 --pretty=format:%h)
           npm version prerelease --preid="canary-$SHORT_COMMIT_ID"
 
+      - name: Build
+        run: pnpm build
+
       - name: Canary release to npm
         run: |
           npm publish --access public --tag canary

.github/workflows/test.yml

@@ -0,0 +1,72 @@
+name: Test
+
+on:
+  push:
+    branches: [master, develop]
+  pull_request:
+    branches: [master, develop]
+
+jobs:
+  test:
+    name: Test on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        node-version: [20.x]
+      fail-fast: false
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          # Don't use built-in cache - we'll cache pnpm store manually to include create-test deps
+
+      # Cache pnpm store - includes both main project and create-test template dependencies
+      - name: Get pnpm store directory
+        shell: bash
+        id: pnpm-cache
+        run: echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_OUTPUT
+
+      - name: Cache pnpm store
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          # Cache key includes both lockfile (main deps) and template config (create-test deps)
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml', 'src/templates/config.ts') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Run tests
+        run: pnpm test
+
+      - name: Build project
+        run: pnpm build
+
+      # Note: create-test.sh includes node startup and RPC verification,
+      # so we don't need a separate starting-node-test step
+      - name: Integration test - Create project workflow
+        shell: bash
+        run: bash scripts/create-test.sh
+
+      - name: Upload coverage to Codecov (Ubuntu only)
+        if: matrix.os == 'ubuntu-latest'
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage/lcov.info
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false

.gitignore

@@ -8,3 +8,7 @@ dist/
 templates/temp-clone-folder
 build/
 package-lock.json
+
+# Test coverage
+coverage/
+*.lcov

README.md

@@ -55,6 +55,8 @@ pnpm install -g @offckb/cli
 
 _Require Node version `>= v20.0.0`. We recommend using latest [LTS](https://nodejs.org/en/download/package-manager) version of Node to run `offckb`_
 
+**Note for Windows users:** If installation fails due to native module compilation issues, the CLI will still work but may use portable binaries instead of optimized ones. For better performance, consider installing Visual Studio Build Tools.
+
 ## Usage
 
 ```sh
@@ -140,6 +142,33 @@ offckb create <your-project-name> -c <your-contract-name>
 ```
 - The `-c` option is optional, if not provided, the contract name defaults to `hello-world`.
 
+**Note for Windows Users:**
+
+To run mock tests in the generated project, you need to manually install `ckb-debugger` until [this upstream fix about ckb-testtool wasm](https://github.com/nervosnetwork/ckb-js-vm/pull/98) is applied.
+
+**Installation Steps:**
+
+1. Download the latest `ckb-debugger` release for Windows from the [releases page](https://github.com/nervosnetwork/ckb-standalone-debugger/releases)
+2. Extract the downloaded archive (e.g., `ckb-debugger-win64.zip`)
+3. Add the extracted binary to your system PATH:
+   - Open "System Properties" → "Environment Variables"
+   - Under "System variables" or "User variables", find and edit the `Path` variable
+   - Click "New" and add the full path to the folder containing `ckb-debugger.exe`
+   - Click "OK" to save
+4. Verify installation by opening a new terminal and running:
+   ```sh
+   ckb-debugger --version
+   ```
+5. Disable WASM debugger in your mock test file:
+   - Open the mock test file (e.g., `<your-contract-name>.mock.test.ts`)
+   - Comment out or delete the `verifier.setWasmDebuggerEnabled(true)` line:
+   ```typescript
+   // When using native ckb-debugger, comment out or delete the following line:
+   // verifier.setWasmDebuggerEnabled(true);
+   ```
+
+After completing these steps, `npm run test` should pass without mock test failures.
+
 ### 3. Deploy Your Contract {#deploy-contract}
 
 ```sh

jest.config.js

@@ -0,0 +1,27 @@
+/** @type {import('jest').Config} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/src', '<rootDir>/tests'],
+  testMatch: ['**/__tests__/**/*.ts', '**/?(*.)+(spec|test).ts'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  collectCoverageFrom: [
+    'src/**/*.{ts,tsx}',
+    '!src/**/*.d.ts',
+    '!src/**/index.ts',
+  ],
+  coverageDirectory: 'coverage',
+  coverageReporters: ['text', 'lcov', 'html'],
+  moduleNameMapper: {
+    '^@/(.*)$': '<rootDir>/src/$1',
+  },
+  transform: {
+    '^.+\\.ts$': ['ts-jest', {
+      tsconfig: {
+        esModuleInterop: true,
+        allowSyntheticDefaultImports: true,
+        isolatedModules: true,
+      },
+    }],
+  },
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@offckb/cli",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "description": "ckb development network for your first try",
   "author": "CKB EcoFund",
   "license": "MIT",
@@ -27,7 +27,6 @@
   },
   "pnpm": {
     "onlyBuiltDependencies": [
-      "cpu-features",
       "secp256k1"
     ]
   },
@@ -37,7 +36,10 @@
     "clean": "node scripts/clean.js",
     "lint": "eslint \"src/**/*.ts\" --ignore-pattern 'node_modules/'",
     "lint:fix": "eslint \"src/**/*.ts\" --ignore-pattern 'node_modules/' --fix",
-    "fmt": "prettier --write '{src,templates,account}/**/*.{js,jsx,ts,tsx,md,json}'"
+    "fmt": "prettier --write '{src,templates,account}/**/*.{js,jsx,ts,tsx,md,json}'",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage"
   },
   "husky": {
     "hooks": {
@@ -55,7 +57,7 @@
   },
   "devDependencies": {
     "@types/adm-zip": "^0.5.5",
-    "@types/cpu-features": "^0.0.3",
+    "@types/jest": "^30.0.0",
     "@types/node": "^20.17.24",
     "@types/node-fetch": "^2.6.11",
     "@types/semver": "^7.5.7",
@@ -65,8 +67,10 @@
     "@vercel/ncc": "^0.38.3",
     "eslint": "^8.57.0",
     "husky": "^9.0.11",
+    "jest": "^30.2.0",
     "lint-staged": "^15.2.2",
     "prettier": "^3.2.5",
+    "ts-jest": "^29.4.6",
     "ts-node-dev": "^2.0.0",
     "typescript": "^5.3.3"
   },
@@ -80,12 +84,14 @@
     "child_process": "^1.0.2",
     "ckb-transaction-dumper": "^0.4.2",
     "commander": "^12.0.0",
-    "cpu-features": "^0.0.10",
     "http-proxy": "^1.18.1",
     "https-proxy-agent": "^7.0.5",
     "node-fetch": "2",
     "semver": "^7.6.0",
-    "tar": "^6.2.1",
+    "tar": "^7.5.3",
     "winston": "^3.17.0"
+  },
+  "optionalDependencies": {
+    "cpu-features": "^0.0.10"
   }
 }