Skip to content

docs: fix README deployment instructions#63

Open
fakedev9999 wants to merge 1 commit intoyuwen/v6from
docs/fix-readme-deployment-instructions
Open

docs: fix README deployment instructions#63
fakedev9999 wants to merge 1 commit intoyuwen/v6from
docs/fix-readme-deployment-instructions

Conversation

@fakedev9999
Copy link
Member

Summary

  • Add missing CHAINS= env var to all deployment commands
  • Update version references from v3.0.0 to v6.0.0-beta.1
  • Document source .env requirement (multichain modifier reads env vars directly, not from .env file)
  • Document that --rpc-url CLI 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 from feat: add Safe Transaction Builder JSON generator #62
  • Fix typo in remappings.txt instruction (trailing period)
  • Remove hardcoded verifier address from example code

Context

These issues were discovered while testing the Sepolia E2E deployment flow. New chain developers following the current README would encounter confusing errors due to:

  1. Missing CHAINS= causing silent failures
  2. Outdated v3.0.0 version references
  3. No mention that --rpc-url is ignored
  4. No mention of source .env requirement

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