Skip to content

Commit bead2fa

Browse files
committed
docs: fix code snippets verified against the actual z6m_prover binary
Verified every CLI claim by running `docker run somnergy/z6m_prover ...` against `latest`. The published image is the source of truth for what users actually see — `master` of erigontech/zilkworm has refactored some flags/descriptions but the image hasn't been rebuilt yet, so docs should match the image until a new image ships. ## Real bugs (fixed) - **docs/basics/getting-started.md (CUDA example)** — `--n 1` is not a real flag in any version. Replace with `--block-number 1` (which the binary actually accepts). - **src/pages/index.tsx (landing hero)** — `z6m_prover verify proof.json` would clap-error: the `verify` subcommand has no positional argument, only `--proof-path` (default `proof.bin`) and `--vk-path` (default `vk.bin`). Rewrite to `z6m_prover verify --proof-path proof.json --vk-path vk.bin`. - **docs/testing/riscv-testing-eests-on-rv32im-via-qemu.md** — `make rv32im_eest_blockchain_tests` does not exist in `qemu_runner/Makefile`. The intended target is `make eest-rv32` (or `make eest-blockchain-tests` which defaults to `ARCH=rv32`). ## Re-verified, left as-is The prove/execute option tables (including `--is-test` and the "JSON file..." / "Whether the input file is..." descriptions) match the binary verbatim — these were temporarily "corrected" against master source in an earlier draft of this PR and have been reverted to match what users see when they actually run `--help`.
1 parent 1b2ad23 commit bead2fa

4 files changed

Lines changed: 5 additions & 5 deletions

File tree

docs/basics/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,5 +98,5 @@ $ user@machine-with-gpu
9898
docker run --gpus all --rm --network host -v "$PWD:/work:rw" -v /var/run/docker.sock:/var/run/docker.sock -w /work -it --entrypoint bash somnergy/z6m_prover
9999

100100
root@instance-20250919-091229:/work#
101-
SP1_PROVER=cuda RUST_BACKTRACE=full RUST_LOG=info z6m_prover prove --n 1 --file-name test.json
101+
SP1_PROVER=cuda RUST_BACKTRACE=full RUST_LOG=info z6m_prover prove --block-number 1 --file-name test.json
102102
```

docs/testing/riscv-testing-eests-on-rv32im-via-qemu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ git submodule foreach 'git lfs pull'
5454

5555
```bash
5656
cd zilkworm/qemu_runner
57-
make rv32im_eest_blockchain_tests
57+
make eest-rv32
5858
```
5959

6060
That would build the project for rv32im and invoke `ctest` to launch a bunch of `qemu-system-riscv32` instances in the background. Each of these instances is passed with a JSON file to run as a test.\

src/pages/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ const capabilities: Card[] = [
104104

105105
const exampleCommand = `// Create block proofs in one command
106106
z6m_prover prove --block-number 23456789 --proof-path proof.json
107-
z6m_prover verify proof.json`;
107+
z6m_prover verify --proof-path proof.json --vk-path vk.bin`;
108108

109109
export default function Home(): React.ReactElement {
110110
return (

static/llms-full.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ $ user@machine-with-gpu
177177
docker run --gpus all --rm --network host -v "$PWD:/work:rw" -v /var/run/docker.sock:/var/run/docker.sock -w /work -it --entrypoint bash somnergy/z6m_prover
178178

179179
root@instance-20250919-091229:/work#
180-
SP1_PROVER=cuda RUST_BACKTRACE=full RUST_LOG=info z6m_prover prove --n 1 --file-name test.json
180+
SP1_PROVER=cuda RUST_BACKTRACE=full RUST_LOG=info z6m_prover prove --block-number 1 --file-name test.json
181181
```
182182

183183
---
@@ -388,7 +388,7 @@ git submodule foreach 'git lfs pull'
388388

389389
```bash
390390
cd zilkworm/qemu_runner
391-
make rv32im_eest_blockchain_tests
391+
make eest-rv32
392392
```
393393

394394
That would build the project for rv32im and invoke `ctest` to launch a bunch of `qemu-system-riscv32` instances in the background. Each of these instances is passed with a JSON file to run as a test.\

0 commit comments

Comments
 (0)