Skip to content

Commit 28c0eb8

Browse files
committed
docs: fix code snippets to match actual zilkworm source
Cross-repo audit against erigontech/zilkworm@master surfaced 6 drifts where docs claimed CLI flags / Make targets / help text that don't exist in the actual source. Fixes (all against prover_hypercube/src/main.rs unless noted): 1. getting-started.md — `prove` options table: drop the bogus `--is-test` row (flag only exists in commented-out prover_turbo) and rewrite `--block-number` + `--file-name` descriptions to match source ("Block number to prove" / "Path to the unified RLP input file (overrides --block-number lookup)"). 2. getting-started.md — `execute` options table: same fixes as #1. 3. getting-started.md — CUDA example: `--n 1` is not a real flag (it was a leftover from before z6m_prover existed). Replace with the canonical `--block-number 1`. 4. src/pages/index.tsx (landing hero) — `z6m_prover verify proof.json` would fail with a clap parse error. The `verify` subcommand requires named flags only: `--proof-path <PATH>` and `--vk-path <PATH>`. Update the hero example accordingly. 5. riscv-testing-eests-on-rv32im-via-qemu.md — `make rv32im_eest_blockchain_tests` target does not exist in qemu_runner/Makefile. The intended target is `make eest-rv32` (or `make eest-blockchain-tests`, which defaults to ARCH=rv32). Switch to `eest-rv32`. Regenerated llms-full.txt so the inline copies of the affected pages stay in sync.
1 parent 1b2ad23 commit 28c0eb8

4 files changed

Lines changed: 11 additions & 15 deletions

File tree

docs/basics/getting-started.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,7 @@ Usage: z6m_prover execute [OPTIONS]
6666
6767
Options:
6868
--block-number <BLOCK_NUMBER> Block number to execute [default: 0]
69-
--file-name <FILE_NAME> Whether the input file is an Ethereum/tests file
70-
--is-test
69+
--file-name <FILE_NAME> Path to the unified RLP input file (overrides --block-number lookup)
7170
--data-dir <DATA_DIR> Data directory
7271
-h, --help Print help
7372
@@ -78,9 +77,8 @@ Options:
7877
```text
7978
Usage: z6m_prover prove [OPTIONS]
8079
Options:
81-
--block-number <BLOCK_NUMBER> JSON file to load ethereum/tests format test from [default: 0]
82-
--file-name <FILE_NAME> Whether the input file is an Ethereum/tests file
83-
--is-test
80+
--block-number <BLOCK_NUMBER> Block number to prove [default: 0]
81+
--file-name <FILE_NAME> Path to the unified RLP input file (overrides --block-number lookup)
8482
--data-dir <DATA_DIR> Data directory
8583
--pk-path <PK_PATH> Proving key path [default: pk.bin]
8684
--proof-path <PROOF_PATH> Proof output path
@@ -98,5 +96,5 @@ $ user@machine-with-gpu
9896
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
9997

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

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: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,7 @@ Usage: z6m_prover execute [OPTIONS]
145145

146146
Options:
147147
--block-number <BLOCK_NUMBER> Block number to execute [default: 0]
148-
--file-name <FILE_NAME> Whether the input file is an Ethereum/tests file
149-
--is-test
148+
--file-name <FILE_NAME> Path to the unified RLP input file (overrides --block-number lookup)
150149
--data-dir <DATA_DIR> Data directory
151150
-h, --help Print help
152151

@@ -157,9 +156,8 @@ Options:
157156
```text
158157
Usage: z6m_prover prove [OPTIONS]
159158
Options:
160-
--block-number <BLOCK_NUMBER> JSON file to load ethereum/tests format test from [default: 0]
161-
--file-name <FILE_NAME> Whether the input file is an Ethereum/tests file
162-
--is-test
159+
--block-number <BLOCK_NUMBER> Block number to prove [default: 0]
160+
--file-name <FILE_NAME> Path to the unified RLP input file (overrides --block-number lookup)
163161
--data-dir <DATA_DIR> Data directory
164162
--pk-path <PK_PATH> Proving key path [default: pk.bin]
165163
--proof-path <PROOF_PATH> Proof output path
@@ -177,7 +175,7 @@ $ user@machine-with-gpu
177175
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
178176

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

183181
---
@@ -388,7 +386,7 @@ git submodule foreach 'git lfs pull'
388386

389387
```bash
390388
cd zilkworm/qemu_runner
391-
make rv32im_eest_blockchain_tests
389+
make eest-rv32
392390
```
393391

394392
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)