Skip to content

doc: add windows generated project mock test workaround #374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RetricSu merged 1 commit into from
Feb 2, 2026
Merged

doc: add windows generated project mock test workaround #374

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,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:**
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent capitalization: This line uses "Windows Users" (capital U) while line 58 of the same file uses "Windows users" (lowercase u). For consistency with the existing note, this should be "Windows users".

Copilot uses AI. Check for mistakes.

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:
Comment on lines +164 to +166
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment in the code example is slightly inconsistent with the actual template code. The template files at lines 32-33 of both .mock.test.ts.template and .mock.test.js.template show the comment "if you are using the native ckb-debugger, you can delete the following line." However, this documentation says "When using native ckb-debugger, comment out or delete the following line". Consider aligning the wording more closely with the template, or updating the templates to match this documentation.

Suggested change
- Comment out or delete the `verifier.setWasmDebuggerEnabled(true)` line:
```typescript
// When using native ckb-debugger, comment out or delete the following line:
- Delete the `verifier.setWasmDebuggerEnabled(true)` line:
```typescript
// if you are using the native ckb-debugger, you can delete the following line:

Copilot uses AI. Check for mistakes.
// verifier.setWasmDebuggerEnabled(true);
```

After completing these steps, `npm run test` should pass without mock test failures.

### 3. Deploy Your Contract {#deploy-contract}

```sh
Expand Down
Loading