Skip to content

Commit 02e375b

Browse files
committed
refactor(shadow-testing): merge scripts/ into tests/, deduplicate docs, fix numbering
Merge scripts/shadow-testing/ into tests/shadow-testing/: - Move fetch-l2-blocks.py to tests/shadow-testing/scripts/ - Move .env.example to tests/shadow-testing/.env.example - Remove redundant scripts/shadow-testing/ directory entirely (setup.sh, import-production-data.sh, configs/ superseded by Makefile targets and 00-import-bundle-range.sh) Deduplicate documentation: - README.md: Slim down to ~100 lines (entry + quick start + index) - docs/README.md → docs/GUIDE.md (full detailed guide) - docs/QUICKSTART.md: deleted (content merged into README.md) - AGENTS.md → docs/TROUBLESHOOTING.md (structured traps) - Update all internal links to point to new names Fix script numbering collision: - 02-deploy-verifier.sh → 03-deploy-verifier.sh - Shift all subsequent scripts (+1) - Update Makefile references and internal script calls Update root AGENTS.md cross-references.
1 parent 2422f5f commit 02e375b

22 files changed

Lines changed: 58 additions & 1302 deletions

AGENTS.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ Follow the structured testing guide in [`docs/testing/openvm-upgrade-testing-gui
2525
For testing proof generation against **real mainnet production tasks** without interfering with the live system, use the **Shadow Coordinator** approach. This is significantly faster than a full shadow fork:
2626

2727
- **Architecture**: Local coordinator (`:8390`) + local prover (GPU), fed by imported production task data.
28-
- **Docs**: [`tests/shadow-testing/docs/README.md`](tests/shadow-testing/docs/README.md) — full setup guide, troubleshooting, config reference.
29-
- **Quick Start**: [`tests/shadow-testing/docs/QUICKSTART.md`](tests/shadow-testing/docs/QUICKSTART.md)
30-
- **Automation**: [`tests/shadow-testing/scripts/setup.sh`](tests/shadow-testing/scripts/setup.sh)one-command setup for postgres, coordinator, and prover.
28+
- **Docs**: [`tests/shadow-testing/docs/GUIDE.md`](tests/shadow-testing/docs/GUIDE.md) — full setup guide, troubleshooting, config reference.
29+
- **Quick Start**: [`tests/shadow-testing/README.md`](tests/shadow-testing/README.md)
30+
- **Automation**: [`tests/shadow-testing/Makefile`](tests/shadow-testing/Makefile)Makefile targets for Docker and bare-metal shadow fork testing.
3131

3232
Key hard-won rules:
3333
- **L2 RPC for coordinator task generation** (must support `debug_executionWitness`):
@@ -201,7 +201,8 @@ make coordinator_setup
201201
| [`docs/prover-coordinator-overview.md`](docs/prover-coordinator-overview.md) | Architecture, data flow, component relationships, common operations |
202202
| [`docs/testing/openvm-upgrade-testing-guide.md`](docs/testing/openvm-upgrade-testing-guide.md) | Step-by-step testing checklist after OpenVM / zkvm-prover upgrades |
203203
| [`docs/testing/docker-compose-e2e-guide.md`](docs/testing/docker-compose-e2e-guide.md) | Production-like E2E testing with Docker Compose + Coordinator Proxy |
204-
| [`tests/shadow-testing/docs/README.md`](tests/shadow-testing/docs/README.md) | Shadow coordinator + local prover setup for production task replay |
204+
| [`tests/shadow-testing/docs/GUIDE.md`](tests/shadow-testing/docs/GUIDE.md) | Shadow coordinator + local prover setup for production task replay |
205205
| [`tests/shadow-testing/docs/LESSONS_LEARNED.md`](tests/shadow-testing/docs/LESSONS_LEARNED.md) | Hard-won debugging knowledge from past shadow tests (read before experimenting) |
206-
| [`tests/shadow-testing/docs/QUICKSTART.md`](tests/shadow-testing/docs/QUICKSTART.md) | Quick reference for common shadow testing commands |
206+
| [`tests/shadow-testing/docs/TROUBLESHOOTING.md`](tests/shadow-testing/docs/TROUBLESHOOTING.md) | Structured pitfalls and agent checklists for shadow testing |
207+
| [`tests/shadow-testing/README.md`](tests/shadow-testing/README.md) | Quick reference for common shadow testing commands |
207208
| [`docs/testing_reports/openvm-v1.6.0-guest-v0.8.0-May19.md`](docs/testing_reports/openvm-v1.6.0-guest-v0.8.0-May19.md) | Test report for PR #1783 (OpenVM 1.6.0, guest v0.8.0) |

scripts/shadow-testing/.gitignore

Lines changed: 0 additions & 6 deletions
This file was deleted.

scripts/shadow-testing/QUICKSTART.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

scripts/shadow-testing/configs/prover-local.json

Lines changed: 0 additions & 24 deletions
This file was deleted.

scripts/shadow-testing/configs/rollup-relayer-dryrun.json

Lines changed: 0 additions & 75 deletions
This file was deleted.

scripts/shadow-testing/configs/shadow-coordinator-config.json

Lines changed: 0 additions & 45 deletions
This file was deleted.

scripts/shadow-testing/import-production-data.sh

Lines changed: 0 additions & 134 deletions
This file was deleted.

0 commit comments

Comments
 (0)