Skip to content

docs: overhaul deployment documentation#64

Open
fakedev9999 wants to merge 2 commits intoyuwen/v6from
fakedev9999/docs-overhaul
Open

docs: overhaul deployment documentation#64
fakedev9999 wants to merge 2 commits intoyuwen/v6from
fakedev9999/docs-overhaul

Conversation

@fakedev9999
Copy link
Member

Summary

Restructures documentation for two audiences:

  • README.md: Rewritten for external devs who want to deploy and test SP1 verifiers on their own chains. Simple EOA path with REGISTER_ROUTE=true, step-by-step guide, env var table, architecture section, and links to canonical deployments.
  • docs/PRODUCTION_DEPLOYMENT.md: New guide for canonical verifier gateway management by Succinct Labs — covers multisig deployment flow, Safe TX Builder integration, and phase-based process (deploy → register routes via multisig → verify).
  • contracts/README.md: Updated to reflect current contract structure (Gateway, ISP1VerifierGateway, versioned verifier dirs).
  • contracts/.env.example: Added missing RPC_HOODI entry.

Also includes all changes from docs/fix-readme-deployment-instructions branch (v6.0.0-beta.1 contracts, PR #61 REGISTER_ROUTE, PR #62 safe-batch-generator).

Key fixes from fact-checking against code

  • Added --multi flag back to forge commands (required by multichain modifier's vm.createSelectFork())
  • Fixed "PLONK EVM proofs" → covers both Groth16 and Plonk
  • Removed multisig/Safe TX Builder from main README flow (moved to production guide)
  • REGISTER_ROUTE=true presented as the primary path for external devs (they own the gateway)

Test plan

  • Verify all forge script paths match actual files in script/deploy/
  • Verify env var names match .env.example and foundry.toml
  • Verify deployment JSON keys match deployments/*.json
  • Read both docs end-to-end as a new user

- Add missing CHAINS= env var to all deployment commands
- Update version references from v3.0.0 to v6.0.0-beta.1
- Add source .env requirement (multichain modifier reads env vars directly)
- Document that --rpc-url flag is ignored by multichain modifier
- Add CREATE2_SALT collision warning for gateway deployments
- Document REGISTER_ROUTE env var and multisig workflow
- Reference Safe Transaction Builder JSON generator
- Fix typo in remappings.txt instruction
- Remove hardcoded verifier address from example
- Rewrite README for external devs: simple EOA deploy path with
  REGISTER_ROUTE=true, step-by-step guide, Architecture section,
  deployed addresses linking to docs.succinct.xyz
- Create docs/PRODUCTION_DEPLOYMENT.md for canonical gateway management
  by Succinct Labs (multisig flow, Safe TX Builder, phase-based process)
- Update contracts/README.md to reflect current contract structure
- Fix contracts/.env.example: add missing RPC_HOODI entry
- Add --multi flag back to forge commands (required by multichain modifier)
@fakedev9999 fakedev9999 changed the base branch from main to yuwen/v6 February 6, 2026 06:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant