docs: Update setup guide for v0.4.0 #308
Conversation
✅ Deploy Preview for genlayer-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughDocs and examples updated for v0.4.0: added staking/validator onboarding and operator-key flows, renamed config keys (rollup → genlayerchain*, genvm keys), added node validator/operator fields, expanded env-var overrides and Docker Compose examples, and added changelog and upgrade/breaking-change guidance. Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
dohernandez
force-pushed
the
docs/node/v0.4
branch
from
3b24e29 to
c98495e
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
pages/validators/setup-guide.mdx (2)
682-686: Clarify warning callout about validator wallet address setup timing.The warning states "before starting the node, ensure you have the operator address and validator wallet address set up." This is correct but could be clearer about consequences:
- If these are not set, the node will operate as a full node (not validator)
- The warning might benefit from linking to the "Validator Joining the Network" section
Enhance clarity by explicitly stating the consequence:
- <Callout type="warning" emoji="🚨"> - **Important: Before starting the node, ensure you have the operator address and validator wallet address - set up. If you do not have setup the validator wallet address, your node will not be able to validate, - therefore it will act as a full node instead. -</Callout> + <Callout type="warning" emoji="🚨"> + **Before starting the node: Validator setup required** + + Set both `validatorWalletAddress` and `operatorAddress` in your `config.yaml` (see [Validator Joining the Network](#validator-joining-the-network-section) below). + + **If not configured:** Your node will run as a full node and will not validate blocks or earn rewards. +</Callout>
399-677: Validator Joining section is comprehensive but very long—consider breaking into a separate reference document.The new "Validator Joining the Network" section (lines 399–677) is extensive (~280 lines) and comprehensive. While high-quality, its length may overwhelm users following the main setup flow.
Consider one of these approaches:
- Move to a separate page: Create
pages/validators/joining-as-validator.mdxand link to it from the setup guide with a brief intro.- Collapse with details component: Use a
<details>or collapsible component for the full validator joining flow, showing only a high-level summary by default.- Keep inline but add table of contents: Add internal anchor links so users can skip to subsections.
Example structure if kept inline:
### Validator Joining the Network This section guides you through becoming a validator on the GenLayer testnet using the GenLayer CLI. **Quick Start:** - [Prerequisites](#prerequisites) - [Step 1-3: Account Setup](#account-setup) - [Step 4-5: Funding and Staking](#funding) - ...This would improve navigation without sacrificing content completeness.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/validators/setup-guide.mdx(8 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/validators/setup-guide.mdx
pages/validators/setup-guide.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/validators/setup-guide.mdx: Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Consensus contract addresses change with network upgrades and must be updated in configuration examples
Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Files:
pages/validators/setup-guide.mdx
🧠 Learnings (11)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Changelog Updates (pages/validators/changelog.mdx): Add new version entries at the top in reverse chronological order, use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc, and include missing intermediate versions if needed
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Use consistent format for changelog entries: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Applied to files:
pages/validators/setup-guide.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Playwright E2E
🔇 Additional comments (3)
pages/validators/setup-guide.mdx (3)
109-109: Text clarity improvement approved.The change from "Typically you will want" to "Typically, you will want" improves punctuation and readability.
147-148: Align example configuration with reference config template.The configuration example at lines 147-148 uses field names
genlayerchainrpcurlandgenlayerchainwebsocketurl, but the reference configuration template atcontent/validators/config.yamland the instructional text on line 140 both referencezksyncurlandzksyncwebsocketurl. Update the example to match the reference template for consistency.Likely an incorrect or invalid review comment.
152-154: Consensus contract addresses and genesis block are correctly configured for v0.4.0.The contract addresses and genesis block (lines 152-154) were intentionally updated for v0.4.0 in commit c98495e and match the configuration in
content/validators/config.yaml. The values are:
- ConsensusMain:
0xe30293d600fF9B2C865d91307826F28006A458f4- ConsensusData:
0x2a50afD9d3E0ACC824aC4850d7B4c5561aB5D27a- Genesis:
817855Configuration is consistent and properly labeled as "Asimov - Phase 4".
dohernandez
force-pushed
the
docs/node/v0.4
branch
from
c98495e to
d68f755
Compare
…or genvm-module-web
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (2)
pages/validators/setup-guide.mdx (2)
843-844: Add security warning for default password.The default password
12345678is weak and exposed in version control. Add a callout warning users to change this before production.# Keystore password (used to unlock the pre-imported wallet) +# IMPORTANT: Change this to a strong password before production use! NODE_PASSWORD=12345678
777-777: Avoid exposing password in docker-compose entrypoint; source from .env instead.Line 777 embeds
${NODE_PASSWORD:-12345678}directly in the entrypoint, which may leak the password in process logs or debuggers. Extract it to the environment instead.- entrypoint: [ - "sh", "-c", "/app/bin/genlayernode run --password ${NODE_PASSWORD:-12345678}", - ] + entrypoint: [ + "sh", "-c", "/app/bin/genlayernode run --password $NODE_PASSWORD", + ]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/validators/setup-guide.mdx(8 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/validators/setup-guide.mdx
pages/validators/setup-guide.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/validators/setup-guide.mdx: Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Consensus contract addresses change with network upgrades and must be updated in configuration examples
Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Files:
pages/validators/setup-guide.mdx
🧠 Learnings (14)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.173Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Changelog Updates (pages/validators/changelog.mdx): Add new version entries at the top in reverse chronological order, use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc, and include missing intermediate versions if needed
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Use consistent format for changelog entries: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-12-03T17:07:37.173Z
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.173Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Applied to files:
pages/validators/setup-guide.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Playwright E2E
🔇 Additional comments (4)
pages/validators/setup-guide.mdx (4)
806-825: ✓ Excellent documentation ofgenvm-module-web-docker.yamlseparation.Clear explanation (lines 806-825) of why the tarball's
genvm-module-web.yaml(localhost) differs from the docker-compose version (service name), with concrete example. This directly addresses the prior review concern and aligns with the learning from @dohernandez.
399-677: ✓ Comprehensive validator joining section with best practices.New validator onboarding walkthrough (lines 399–677) is thorough, step-by-step, and includes security best practices (separate operator wallet, identity metadata). Command examples are clear and include expected outputs.
883-945: ✓ Monitoring and observability guidance added.New sections on metrics (lines 883–945) and logs/metrics forwarding (line 958) provide production-ready observability guidance with concrete examples and best practices.
Also applies to: 958-958
147-148: ✓ Configuration examples updated for v0.4.0.RPC endpoint keys renamed (
genlayerchainrpcurl,genlayerchainwebsocketurl) and consensus contract addresses updated to Asimov Phase 4, with genesis block specified for faster startup. Aligns with config changes across the PR.Also applies to: 152-154
dohernandez
force-pushed
the
docs/node/v0.4
branch
from
c5ad107 to
304484d
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
pages/validators/setup-guide.mdx (2)
714-714: Fix inconsistency:genvm.manage_modulesrenamed togenvm.start_manager.Line 714 references the old field name
genvm.manage_modules, but the config example at line 228 shows the field has been renamed togenvm.start_manager. This mismatch will confuse users.- - To start them automatically in node configuration set `genvm.manage_modules` to `true` + - To start them automatically in node configuration set `genvm.start_manager` to `true`
142-142: Update comment to reflect renamed configuration fields.Line 142 advises users to modify
zksyncurlandzksyncwebsocketurl, but these fields have been renamed togenlayerchainrpcurlandgenlayerchainwebsocketurl(lines 147–148). The outdated comment will mislead users.-You can use the following example configuration. **Note:** For most users, you will only need to modify the `zksyncurl` and `zksyncwebsocketurl` values below. +You can use the following example configuration. **Note:** For most users, you will only need to modify the `genlayerchainrpcurl` and `genlayerchainwebsocketurl` values below.
♻️ Duplicate comments (1)
pages/validators/setup-guide.mdx (1)
844-844: Add security warning for weak default password.Line 844 sets a weak default password
12345678without any security guidance. Users running this in production could unintentionally deploy with a trivial credential.# Keystore password (used to unlock the pre-imported wallet) +# IMPORTANT: Change this to a strong password before production use! NODE_PASSWORD=12345678
🧹 Nitpick comments (1)
pages/validators/setup-guide.mdx (1)
184-193: Clarify purpose of new node configuration fields.Lines 190–193 add
validatorWalletAddressandoperatorAddressfields. While the field names are clear, consider adding a brief inline comment explaining when these are required (e.g., "required for validator mode; leave empty to run as full node"). This will reduce user confusion, especially for those upgrading from v0.3.x.# Mode can be "validator" or "full". # Default value is "validator". mode: "validator" - # Address of the ValidatorWallet contract (required for validator mode) + # ValidatorWallet contract address (required for validator mode; leave empty to run as full node) validatorWalletAddress: "" - # Address of the operator that owns the ValidatorWallet + # Operator address that owns the ValidatorWallet (required for validator mode) operatorAddress: ""
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/validators/setup-guide.mdx(8 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/validators/setup-guide.mdx
pages/validators/setup-guide.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/validators/setup-guide.mdx: Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Consensus contract addresses change with network upgrades and must be updated in configuration examples
Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Files:
pages/validators/setup-guide.mdx
🧠 Learnings (14)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.173Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Changelog Updates (pages/validators/changelog.mdx): Add new version entries at the top in reverse chronological order, use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc, and include missing intermediate versions if needed
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Use consistent format for changelog entries: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-12-03T17:07:37.173Z
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.173Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Applied to files:
pages/validators/setup-guide.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - genlayer-docs
- GitHub Check: Header rules - genlayer-docs
- GitHub Check: Pages changed - genlayer-docs
- GitHub Check: Playwright E2E
🔇 Additional comments (3)
pages/validators/setup-guide.mdx (3)
806-824: Excellent clarification on docker-compose GenVM configuration.The documentation now clearly explains that
genvm-module-web-docker.yamlmust be created separately from the tarball'sgenvm-module-web.yamlto point the webdriver to the Docker service name instead of localhost. This directly addresses the prior learning and user confusion. The step-by-step guidance (lines 808–824) is clear and actionable.
399-676: Comprehensive validator onboarding section added.The new "Validator Joining the Network" section (lines 399–676) provides detailed CLI-based instructions covering account creation, staking, operator setup, identity configuration, and troubleshooting. The explanation of why to use a separate operator address (lines 506–515) is particularly helpful for security-conscious validators.
883-957: Comprehensive metrics and monitoring guidance added.The new "Monitoring with Metrics" section provides clear instructions on accessing metrics endpoints, configuring collectors, and best practices. The callout recommending Prometheus + Grafana for production validators is appropriate.
pages/validators/setup-guide.mdx
Outdated
|
|
||
| ```bash | ||
| # Create operator account on your validator server | ||
| genlayer account create --output ./operator.json |
There was a problem hiding this comment.
Not sure you explain how to import the operator address in the node
There was a problem hiding this comment.
This is the operator account? or it is an account for the genlayer? This was not clear to me. When I join the validators I did create the account genlayer account create but did not use it as operator.
There was a problem hiding this comment.
This generates the keystore for the operator, if you don't have one already
…on of GenLayer Consensus v0.4 with Staking
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
pages/validators/setup-guide.mdx (1)
714-714: Update deprecated GenVM field name references.Lines 714, 721, and 728 still reference the deprecated
genvm.manage_modulesfield, but the configuration section (line 228) and config.yaml use the new namestart_manager. Update these references to use the current field name for consistency throughout the guide. Based on learnings, this change is tested and verified.Apply this diff:
3. (Optional) Run two services (modules) in background (this is a crucial step for running _Intelligent_ contracts). This can be done automatically or manually. - - To start them automatically in node configuration set `genvm.manage_modules` to `true` + - To start them automatically in node configuration set `genvm.start_manager` to `true` - To start them manually run ```bash ./third_party/genvm/bin/genvm-modules web & ./third_party/genvm/bin/genvm-modules llm & ``` <Callout type="info"> - Note: If you are using the default configuration, `genvm.manage_modules` is + Note: If you are using the default configuration, `genvm.start_manager` is set to `true` by default, meaning the node will manage these modules automatically. </Callout>Also applies to: 721-721, 728-728
🧹 Nitpick comments (4)
pages/validators/upgrade.mdx (1)
28-57: Clarify version scope of Configuration Change section.Line 28 introduces a "Configuration Change" section but doesn't specify which version transition this applies to (appears to reference v0.3.8). The consensus contract addresses shown (Asimov - Phase 3) differ from the Phase 4 addresses in setup-guide and config.yaml. Add a header like "v0.3.8 Configuration Change" or restructure to make the version scope explicit, and consider adding a callout explaining the Phase 3 vs Phase 4 distinction for users upgrading from earlier versions.
pages/validators/setup-guide.mdx (3)
827-862: Docker-compose environment configuration is complete and well-documented.The .env template provides clear sections for WebDriver, Node, and LLM configuration. NODE_VERSION is correctly pinned to v0.4.0, and LLM provider keys are properly documented with variable names. However, add a warning about the weak default password.
Add a security note to line 843-844:
# Keystore password (used to unlock the pre-imported wallet) +# ⚠️ IMPORTANT: Change this to a strong password before production use! NODE_PASSWORD=12345678
958-960: Clarify alloy service reference and logging setup.Lines 958-960 reference an "alloy service provided in docker-compose.yaml from extracted tarball," but the docker-compose.yaml template shown (lines 758-804) does not include an alloy service. Either add the alloy service definition to the shown docker-compose.yaml or clarify that it's an optional additional service available in the tarball for advanced monitoring setups.
690-705: LLM provider setup is clear; verify environment variable handling for docker-compose.The binary execution path correctly shows environment variable exports. Ensure documentation clearly notes that when using docker-compose, these LLM API keys should be set in the .env file (as shown at lines 857-862) and will be loaded via the
env_filedirective on line 782. Consider adding a cross-reference note for clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
content/validators/changelog/v0.4.0.mdx(1 hunks)content/validators/config.yaml(4 hunks)pages/validators/changelog.mdx(1 hunks)pages/validators/setup-guide.mdx(8 hunks)pages/validators/upgrade.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- content/validators/changelog/v0.4.0.mdx
🧰 Additional context used
📓 Path-based instructions (3)
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/validators/changelog.mdxpages/validators/upgrade.mdxpages/validators/setup-guide.mdx
pages/validators/changelog.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/validators/changelog.mdx: Changelog Updates (pages/validators/changelog.mdx): Add new version entries at the top in reverse chronological order, use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc, and include missing intermediate versions if needed
Use consistent format for changelog entries: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Include missing intermediate versions in changelog.mdx if needed
Add new version entries at the top in reverse chronological order in changelog.mdx
Use consistent format for changelog entries in changelog.mdx
Files:
pages/validators/changelog.mdx
pages/validators/setup-guide.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/validators/setup-guide.mdx: Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Consensus contract addresses change with network upgrades and must be updated in configuration examples
Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Files:
pages/validators/setup-guide.mdx
🧠 Learnings (17)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.173Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Use consistent format for changelog entries: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Applied to files:
pages/validators/changelog.mdxpages/validators/upgrade.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Changelog Updates (pages/validators/changelog.mdx): Add new version entries at the top in reverse chronological order, use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc, and include missing intermediate versions if needed
Applied to files:
pages/validators/changelog.mdxpages/validators/upgrade.mdxpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/validators/changelog.mdxpages/validators/upgrade.mdxcontent/validators/config.yamlpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/validators/changelog.mdxpages/validators/upgrade.mdxcontent/validators/config.yamlpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/changelog.mdxpages/validators/upgrade.mdxcontent/validators/config.yamlpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Use consistent format for changelog entries in changelog.mdx
Applied to files:
pages/validators/changelog.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Include missing intermediate versions in changelog.mdx if needed
Applied to files:
pages/validators/changelog.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/changelog.mdxpages/validators/upgrade.mdxcontent/validators/config.yamlpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Add new version entries at the top in reverse chronological order in changelog.mdx
Applied to files:
pages/validators/changelog.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Applied to files:
pages/validators/changelog.mdxpages/validators/upgrade.mdxpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/validators/upgrade.mdxcontent/validators/config.yamlpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Applied to files:
pages/validators/upgrade.mdxcontent/validators/config.yamlpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/validators/upgrade.mdxpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-12-03T17:07:37.173Z
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.173Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Applied to files:
pages/validators/setup-guide.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - genlayer-docs
- GitHub Check: Header rules - genlayer-docs
- GitHub Check: Pages changed - genlayer-docs
- GitHub Check: Playwright E2E
🔇 Additional comments (10)
pages/validators/changelog.mdx (1)
3-75: Changelog structure is well-organized and comprehensive.The v0.4.0 entry follows the required format exactly (# v0.x.x header, ## subsections for features/fixes/misc), is positioned at the top in reverse chronological order, and includes comprehensive coverage of the release. Format consistency is maintained throughout.
pages/validators/upgrade.mdx (1)
14-27: Breaking change section for v0.4 is clear and actionable.The new v0.3.x → v0.4 section properly explains the requirement for a fresh setup, provides step-by-step instructions, and emphasizes running the doctor command for validation. The distinction from non-breaking upgrade paths is well-communicated.
content/validators/config.yaml (3)
3-10: Config update properly reflects v0.4.0 GenLayer chain changes.RPC endpoint naming is clarified (zksync → genlayerchain), consensus section header reflects Asimov - Phase 4, and contract addresses are updated with the new genesis block. The TODO placeholders guide users appropriately.
40-49: New node configuration fields are properly documented.The addition of
validatorWalletAddressandoperatorAddressfields with clear comments correctly exposes the validator setup requirements. These align with the expanded validator onboarding guidance in setup-guide.mdx.
72-86: GenVM configuration refactor is consistent and well-documented.Field renames (bin_dir → root_dir, manage_modules → start_manager) align with the documented GenVM changes. New fields
manager_urlandpermitsare appropriately commented. The configuration structure supports autodiscovery and dynamic permit updates.pages/validators/setup-guide.mdx (5)
88-120: Version references are correctly updated to v0.4.0.The version list, export statement, and download commands are all properly updated to reference v0.4.0, and the new "Run Genvm setup" step (lines 126-130) is appropriately added to the setup workflow.
147-154: Consensus configuration reflects Asimov Phase 4 deployment.Updated contract addresses, genesis block (4632386), and Phase 4 header align with the network upgrade. The optional genesis block guidance is well-commented per learnings.
191-193: Node and GenVM configuration fields properly updated for v0.4.0.New
validatorWalletAddressandoperatorAddressfields are documented, RPC methods are enabled appropriately (eth_sendRawTransaction, zks_getTransaction), and GenVM configuration uses the updated field names (root_dir, start_manager, manager_url, permits). All align with content/validators/config.yaml.Also applies to: 216-217, 227-230
399-676: Validator joining section is comprehensive and well-structured.The new 9-step validator onboarding guide clearly explains account creation, network setup, staking requirements, and the operator/validator wallet separation (lines 506-527). The troubleshooting section and identity management steps add practical value. This directly addresses the prior reviewer's question about operator address setup.
754-825: Docker-compose deployment is well-documented with proper networking guidance.The docker-compose.yaml template is complete with webdriver and node services, version pinning to v0.4.0 is consistent, and the genvm-module-web-docker.yaml explanation (lines 806-825) properly documents the need for a separate Docker-specific configuration per the established learning. The distinction between localhost (binary) and service name (Docker) is clear.
|
I would also explain the .env in the docs. Are we using a default config.yaml and another one to override? |
|
In general Operator <> Validator addresses is not so clear. I would also add you can have multiple validators with one operator wallet. |
We introduced the overwrite through .env. I'll explain it |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
pages/validators/setup-guide.mdx (1)
742-742: Update GenVM config field name reference in binary section to match config.yaml.Line 742 and 748-751 reference
genvm.manage_modulesin the narrative, but this field has been renamed tostart_managerin the actual configuration (line 228). Update the text for consistency.- - To start them automatically in node configuration set `genvm.manage_modules` to `true` + - To start them automatically in node configuration set `genvm.start_manager` to `true`- Note: If you are using the default configuration, `genvm.manage_modules` is + Note: If you are using the default configuration, `genvm.start_manager` is set to `true` by default, meaning the node will manage these modulesBased on learnings, the config field renames have been tested and verified.
Also applies to: 748-752
🧹 Nitpick comments (2)
pages/validators/setup-guide.mdx (2)
467-467: Example addresses should use placeholders instead of potentially real addresses.The validator joining section uses specific addresses in examples (0x86D0d159483CBf01E920ECfF8bB7F0Cd7E964E7E and variations). While these may be testnet examples, it's clearer to use obviously placeholder format for security and to avoid confusion about whether these are actual deployments.
Recommend replacing with clearly identifiable placeholders like:
- address: '0x86D0d159483CBf01E920ECfF8bB7F0Cd7E964E7E', + address: '0x1234567890123456789012345678901234567890',And:
-genlayer staking validator-join --amount 42000gen --operator 0xOperator... +genlayer staking validator-join --amount 42000gen --operator 0xYourOperatorAddressOr explicitly prefix with example/sample notation.
Also applies to: 538-538, 588-588
990-991: Clarify alloy service reference and provide guidance.Lines 990-991 reference an
alloyservice in the docker-compose.yaml from the extracted tarball for logs and metrics forwarding, but provide no guidance on how to use it. Consider adding a brief note explaining what alloy is and where to find usage documentation, or provide a simple configuration example.Suggested addition after line 991:
For centralized logging and metrics collection, the tarball includes an optional `alloy` service in the docker-compose.yaml. Refer to the [Grafana Alloy documentation](https://grafana.com/docs/alloy/) for configuration options and how to forward metrics to your monitoring infrastructure.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/validators/config.yaml(4 hunks)pages/validators/setup-guide.mdx(9 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- content/validators/config.yaml
🧰 Additional context used
📓 Path-based instructions (2)
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/validators/setup-guide.mdx
pages/validators/setup-guide.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/validators/setup-guide.mdx: Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Consensus contract addresses change with network upgrades and must be updated in configuration examples
Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Files:
pages/validators/setup-guide.mdx
🧠 Learnings (13)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.173Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Changelog Updates (pages/validators/changelog.mdx): Add new version entries at the top in reverse chronological order, use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc, and include missing intermediate versions if needed
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Changelog Updates (pages/validators/changelog.mdx): Add new version entries at the top in reverse chronological order, use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc, and include missing intermediate versions if needed
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-12-03T17:07:37.173Z
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.173Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Applied to files:
pages/validators/setup-guide.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - genlayer-docs
- GitHub Check: Header rules - genlayer-docs
- GitHub Check: Pages changed - genlayer-docs
- GitHub Check: Playwright E2E
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
pages/validators/setup-guide.mdx (1)
565-575: Update field name to match current configuration:genvm.manage_modules→genvm.start_manager.Lines 565 and 572 reference
genvm.manage_modules, but the actual configuration file at line 229 uses the field namestart_manager. Update the documentation to match the current config field name to avoid confusion:- - To start them automatically in node configuration set `genvm.manage_modules` to `true` + - To start them automatically in node configuration set `genvm.start_manager` to `true`- Note: If you are using the default configuration, `genvm.manage_modules` is + Note: If you are using the default configuration, `genvm.start_manager` is set to `true` by default, meaning the node will manage these modules automatically.
🧹 Nitpick comments (2)
pages/api-references/genlayer-cli.mdx (2)
315-319: Clarify "signer" terminology in operator address default.Line 317 states the operator address "defaults to signer"—users unfamiliar with blockchain conventions may not understand this means the account submitting the transaction. Consider rephrasing for clarity:
--operator <address> Operator address (defaults to transaction signer's account)
326-329: Add context explaining validator wallet vs. operator address distinction.The PR feedback noted confusion around the distinction between Operator and Validator addresses. While the commands properly label these (
--validator <address>for validator wallet,--operator <address>for operator), the documentation lacks a brief note explaining when and why these are separate. Consider adding a short callout:Validator Wallet vs. Operator Address: A validator wallet holds staked tokens and controls validator shares. An operator address is a delegated account that can perform actions on behalf of the validator (e.g., claiming rewards, adjusting settings). One validator wallet can have multiple operators.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/api-references/genlayer-cli.mdx(1 hunks)pages/validators/setup-guide.mdx(10 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/api-references/genlayer-cli.mdxpages/validators/setup-guide.mdx
pages/validators/setup-guide.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/validators/setup-guide.mdx: Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Consensus contract addresses change with network upgrades and must be updated in configuration examples
Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Files:
pages/validators/setup-guide.mdx
🧠 Learnings (14)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.200Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Use consistent format for changelog entries: # v0.x.x, ## New features, ## Bug fixes, ## Misc
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/api-references/genlayer-cli.mdxpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/api-references/genlayer-cli.mdxpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Applied to files:
pages/api-references/genlayer-cli.mdxpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/api-references/genlayer-cli.mdxpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Changelog Updates (pages/validators/changelog.mdx): Add new version entries at the top in reverse chronological order, use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc, and include missing intermediate versions if needed
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Use consistent format for changelog entries: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-12-03T17:07:37.200Z
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.200Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Applied to files:
pages/validators/setup-guide.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Cursor Bugbot
- GitHub Check: Playwright E2E
🔇 Additional comments (9)
pages/api-references/genlayer-cli.mdx (1)
275-372: Staking Operations section is well-documented and aligned with v0.4.0 validator lifecycle.The comprehensive staking commands (wizard, validator-join, validator-exit, set-operator, set-identity, delegator operations) and common options are clearly organized with practical examples. The section properly reflects the new validator onboarding and management flows for v0.4.0.
pages/validators/setup-guide.mdx (8)
261-299: Environment variable override documentation is comprehensive and well-structured.The new "Overriding Configuration with Environment Variables" section provides clear guidance on the
GENLAYERNODE_prefix pattern, includes a helpful mapping table, and usage examples. This directly addresses the PR objective of explaining how users can override configuration via environment variables, particularly useful for Docker deployments and sensitive values. The precedence note ("Environment variables take precedence over values inconfig.yaml") is also valuable.
657-676: Excellent documentation ofgenvm-module-web-docker.yamlsetup and Docker networking requirements.The explanation at lines 657-676 clearly articulates why a separate Docker-specific config file is needed (service name vs. localhost), provides step-by-step instructions for creating it, and highlights the key difference between binary and Docker-compose execution. This properly implements the learning requirement and addresses the user feedback from previous review.
626-626: Node image version properly pinned to v0.4.0.The fallback version is now explicitly set to
v0.4.0instead oflatest, ensuring deterministic image pulls across deployments. This aligns with the correction flagged in prior review and maintains consistency with line 696 (NODE_VERSION=v0.4.0).
361-453: Operator key setup section provides comprehensive guidance with security best practices.The new section properly separates Owner vs. Operator concepts, documents import from wizard and generation workflows, and includes clear backup/restore procedures with security warnings. The distinction between cold (owner) and hot (operator) wallets is well-explained, addressing feedback from PR comments about the unclear distinction between Operator and Validator addresses.
454-525: Validator joining section comprehensively covers wizard and manual workflows.The new section walks through the interactive wizard, explains prerequisite checks, and provides step-by-step CLI commands for manual setup. It clarifies why a separate operator address is recommended and includes commands for managing validators (deposit, exit, claim, set-operator, set-identity), fully addressing the PR objective of adding validator onboarding instructions.
681-681: Clear explanation of dual-purpose.envfile for Docker Compose and node configuration overrides.The callout at line 681 explicitly states that the
.envfile serves two purposes (Docker Compose variables andGENLAYERNODE_*configuration overrides), which directly addresses the PR objective of explaining how.envfile behavior works. The cross-reference to the environment variable override section is helpful.
151-154: Consensus addresses and genesis block are correctly updated for Asimov Phase 4.The configuration example reflects the v0.4.0 network upgrade with updated consensus contract addresses and genesis block number (4632386). The optional genesis block note is appropriate per the coding guidelines.
147-148: Configuration field names updated to reflect GenVM and node restructuring.The rollup section correctly uses the new field names (
genlayerchainrpcurlandgenlayerchainwebsocketurlinstead of older naming), and the node section includes the new fields (validatorWalletAddress,operatorAddress,mode). These align with the broader v0.4.0 changes documented across the PR.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
This PR is being reviewed by Cursor Bugbot
Details
You are on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle.
To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.
Updates the description of the Owner address in the validator setup guide. Emphasizes that the Owner address is the only address that can withdraw staked funds, highlighting its critical role in security and control of staked assets.
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
pages/validators/setup-guide.mdx (1)
556-556: Update deprecated GenVM field name references.Lines 556 and 563–564 reference the outdated
genvm.manage_modulesfield, but the configuration example at line 311 uses the new field namegenvm.start_manager. Update these references for consistency.- - To start them automatically in node configuration set `genvm.manage_modules` to `true` + - To start them automatically in node configuration set `genvm.start_manager` to `true`- Note: If you are using the default configuration, `genvm.manage_modules` is + Note: If you are using the default configuration, `genvm.start_manager` is set to `true` by default, meaning the node will manage these modulesAlso applies to: 563-564
🧹 Nitpick comments (1)
pages/validators/setup-guide.mdx (1)
19-19: Fix grammatical issue: add missing subject to sentence.The description for the Operator address is missing a subject and should start with "It can be..." or "The Operator can be..."
-| **Operator** | Hot wallet on your server that signs blocks. Can be same as owner, but separate is recommended. | Node config: `operatorAddress` | +| **Operator** | Hot wallet on your server that signs blocks. It can be the same as owner, but separate is recommended. | Node config: `operatorAddress` |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/validators/setup-guide.mdx(12 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/validators/setup-guide.mdx
pages/validators/setup-guide.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/validators/setup-guide.mdx: Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Consensus contract addresses change with network upgrades and must be updated in configuration examples
Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Files:
pages/validators/setup-guide.mdx
🧠 Learnings (13)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.200Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Changelog Updates (pages/validators/changelog.mdx): Add new version entries at the top in reverse chronological order, use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc, and include missing intermediate versions if needed
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-12-03T17:07:37.200Z
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.200Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Applied to files:
pages/validators/setup-guide.mdx
🪛 LanguageTool
pages/validators/setup-guide.mdx
[style] ~19-~19: To form a complete sentence, be sure to include a subject.
Context: ...allet on your server that signs blocks. Can be same as owner, but separate is recom...
(MISSING_IT_THERE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Redirect rules - genlayer-docs
- GitHub Check: Header rules - genlayer-docs
- GitHub Check: Pages changed - genlayer-docs
- GitHub Check: Cursor Bugbot
- GitHub Check: Playwright E2E
pages/validators/setup-guide.mdx
Outdated
| #### Step 2: View Your Account | ||
|
|
||
| ```bash | ||
| genlayer account |
There was a problem hiding this comment.
I would explain this is an operator account
pages/validators/setup-guide.mdx
Outdated
| - `--amount <amount>` - Stake amount (e.g., `42000gen` or `42000`) | ||
| - `--operator <address>` - Operator address (recommended, see below) | ||
|
|
||
| ##### Why Use an Operator Address? |
There was a problem hiding this comment.
Regarding my previous command, maybe put this before?
There was a problem hiding this comment.
I would also add a note on how to use existing operator keys, with an admonition indicating the folder with the keys in <0.4
pages/validators/setup-guide.mdx
Outdated
| ```sh | ||
| ./bin/genlayernode account new -c $(pwd)/configs/node/config.yaml --setup --password "your secret password" # Remember it! You will need it to unlock your account when running the node | ||
| ``` | ||
| <Callout type="info"> |
There was a problem hiding this comment.
We have three wallets
Owner
Operator
Validator
This is not immediately clear from this callout, I think we can explain it a but better, "Owner vs Operator vs Validator"
|
|
||
| - Stop the node if it is running. | ||
| - Back up the `configs/node/config.yaml` file so that you can refer to any values you have set in the previous version. | ||
| - Back up the `data/node/keystore` folder so that you can maintain your previous operator key. |
There was a problem hiding this comment.
We should explain how to use this key as operator
| </Callout> | ||
|
|
||
| You should see the following output: | ||
| #### Option 1: Import from CLI Wizard (Recommended) |
There was a problem hiding this comment.
I would explain here how to use a previously backed up keystore from phase 3
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
pages/validators/setup-guide.mdx (1)
556-565: Update outdated GenVM field name reference.Line 556 references
genvm.manage_modules, but the config example at line 311 uses the updated field namestart_manager. Update the binary running section to use the correct field name for consistency:- - To start them automatically in node configuration set `genvm.manage_modules` to `true` + - To start them automatically in node configuration set `genvm.start_manager` to `true`Also update the note at line 563:
- Note: If you are using the default configuration, `genvm.manage_modules` is + Note: If you are using the default configuration, `genvm.start_manager` is
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/validators/setup-guide.mdx(12 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/validators/setup-guide.mdx
pages/validators/setup-guide.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/validators/setup-guide.mdx: Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Consensus contract addresses change with network upgrades and must be updated in configuration examples
Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Files:
pages/validators/setup-guide.mdx
🧠 Learnings (13)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.200Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-12-03T17:07:37.200Z
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.200Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Changelog Updates (pages/validators/changelog.mdx): Add new version entries at the top in reverse chronological order, use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc, and include missing intermediate versions if needed
Applied to files:
pages/validators/setup-guide.mdx
🪛 LanguageTool
pages/validators/setup-guide.mdx
[style] ~19-~19: To form a complete sentence, be sure to include a subject.
Context: ...allet on your server that signs blocks. Can be same as owner, but separate is recom...
(MISSING_IT_THERE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Playwright E2E
- GitHub Check: Cursor Bugbot
🔇 Additional comments (6)
pages/validators/setup-guide.mdx (6)
7-87: ✅ Validator wallet and config setup sections well-structured.The new validator wallet section clearly distinguishes Owner, Operator, and Validator Wallet addresses, and the wizard-driven flow is user-friendly. Configuration examples properly reference v0.4.0 values with correct Asimov Phase 4 addresses and genesis block. Prior concerns about address clarity have been effectively addressed. Based on learnings, setup guide now correctly updates version references and configuration values for network upgrades.
Also applies to: 218-240
447-516: ✅ Comprehensive operator key management workflow.The three-step operator key lifecycle (import/backup/restore) is well-documented with clear examples, proper security warnings, and verification steps. Both wizard-import and server-generation paths are covered, giving users flexibility. This addresses the prior concern about documenting operator key flows and is well-integrated with the validator setup narrative.
343-379: ✅ Clear environment variable override documentation.The
GENLAYERNODE_prefix pattern is well-explained with practical examples and precedence clarified. This supports modern infrastructure-as-code deployments and Docker workflows effectively. The pattern, examples, and usage scenarios provide users with sufficient guidance for configuration management.
417-425: ✅ Precompilation guidance appropriately positioned.The precompilation section clearly communicates this is an optional but recommended performance optimization, with practical guidance on when to re-run it (after version upgrades). Positioning after GenVM setup is logical in the setup flow.
568-580: ✅ Doctor command enhanced with GenVM diagnostics documentation.The doctor command now explicitly lists comprehensive validation areas including GenVM modules, LLM provider connectivity, and network configuration. This directly addresses the learning requirement and provides users with confidence their setup is correct before running. As per coding guidelines and learnings, this enhancement properly documents the integrated diagnostics.
606-687: ✅ Docker image versions appropriately pinned to v0.4.0.Both Docker image references now use explicit v0.4.0 tags instead of the problematic
latestfallback. Line 617 uses${NODE_VERSION:-v0.4.0}and line 687 explicitly setsNODE_VERSION=v0.4.0, ensuring deterministic deployments. This resolves the prior critical issue about non-deterministic image pulls.
| | Address | Description | Where Used | | ||
| |---------|-------------|------------| | ||
| | **Owner** | The only address that can withdraw staked funds. Keep this secure (cold wallet). | CLI wizard - signs staking transaction | | ||
| | **Operator** | Hot wallet on your server that signs blocks. Can be same as owner, but separate is recommended. | Node config: `operatorAddress` | | ||
| | **Validator Wallet** | Smart contract created when you join. This is your validator's on-chain identity. | Node config: `validatorWalletAddress` | | ||
|
|
||
| The wizard outputs all three addresses at the end. Save them - you'll need the Validator Wallet and Operator addresses for your node configuration. | ||
| </Callout> |
There was a problem hiding this comment.
Complete the incomplete sentence in the Validator Addresses table.
Line 19 ends with an incomplete phrase: "Can be same as owner, but separate is recom..." Should be:
-| **Operator** | Hot wallet on your server that signs blocks. Can be same as owner, but separate is recom... | Node config: `operatorAddress` |
+| **Operator** | Hot wallet on your server that signs blocks. Can be same as owner, but separate is recommended for security. | Node config: `operatorAddress` |🧰 Tools
🪛 LanguageTool
[style] ~19-~19: To form a complete sentence, be sure to include a subject.
Context: ...allet on your server that signs blocks. Can be same as owner, but separate is recom...
(MISSING_IT_THERE)
🤖 Prompt for AI Agents
pages/validators/setup-guide.mdx around lines 16 to 23: the "Operator"
description row in the Validator Addresses table contains an incomplete sentence
("Can be same as owner, but separate is recom..."); update that cell to complete
the sentence to read "Can be same as owner, but separate is recommended." so the
table text is clear and grammatically correct.
| ATOMAKEY= | ||
| ``` | ||
|
|
||
| or simply use the provided `docker-compose.yaml`, `.env.example` and the `genvm-module-web-docker.yaml` from the extracted tarball. |
There was a problem hiding this comment.
Clarify that genvm-module-web-docker.yaml must be created, not retrieved from tarball.
Line 710 contradicts the earlier guidance (lines 648–667) by stating that genvm-module-web-docker.yaml is "provided in the extracted tarball." Per the preceding explanation and learnings, users must create genvm-module-web-docker.yaml themselves; only the default genvm-module-web.yaml (configured for localhost) is included in the tarball.
Update line 710 to clarify:
-or simply use the provided `docker-compose.yaml`, `.env.example` and the `genvm-module-web-docker.yaml` from the extracted tarball.
+or use the provided `docker-compose.yaml` and `.env.example` from the extracted tarball; ensure you also create `genvm-module-web-docker.yaml` as described above.🤖 Prompt for AI Agents
In pages/validators/setup-guide.mdx around line 710, the sentence incorrectly
says genvm-module-web-docker.yaml is provided in the extracted tarball; change
the wording to clarify that genvm-module-web-docker.yaml must be created by the
user (only genvm-module-web.yaml for localhost is included in the tarball),
e.g., replace "from the extracted tarball" with a note that
genvm-module-web-docker.yaml should be created based on the provided
genvm-module-web.yaml or examples and is not included in the tarball.
Adds new staking commands and options to the genlayer-cli documentation. This includes: - validator-prime - delegation-info - quarantined-validators - banned-validators Also adds options for the new commands and examples.
dohernandez
left a comment
dohernandez
left a comment
There was a problem hiding this comment.
LGTM, but I can not approve my own PR 😄
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
pages/validators/setup-guide.mdx (2)
16-22: Complete the truncated sentence in the Validator Addresses table.Line 19 ends with an incomplete phrase. Finish the sentence to clarify the security recommendation:
-| **Operator** | Hot wallet on your server that signs blocks. Can be same as owner, but separate is recom... | Node config: `operatorAddress` | +| **Operator** | Hot wallet on your server that signs blocks. Can be same as owner, but separate is recommended for security. | Node config: `operatorAddress` |
716-716: Clarify thatgenvm-module-web-docker.yamlmust be created, not retrieved from tarball.Line 716 contradicts the detailed guidance at lines 654–673. The statement "use the provided...
genvm-module-web-docker.yamlfrom the extracted tarball" is inaccurate. The earlier section explicitly instructs users to creategenvm-module-web-docker.yamlby copying and modifyinggenvm-module-web.yaml. The tarball includes onlygenvm-module-web.yaml(configured forlocalhost), notgenvm-module-web-docker.yaml.Update line 716 to:
-or simply use the provided `docker-compose.yaml`, `.env.example` and the `genvm-module-web-docker.yaml` from the extracted tarball. +or use the provided `docker-compose.yaml` and `.env.example` from the extracted tarball; ensure you create `genvm-module-web-docker.yaml` as described in the preceding section.
🧹 Nitpick comments (1)
pages/validators/setup-guide.mdx (1)
562-572: Clarify deprecated configuration field name in GenVM setup notes.Line 562 references
genvm.manage_modulesto control automatic module startup, but the configuration example at line 315 shows the updated field namestart_manager. While past review feedback confirmed this is tested and working, the documentation should clarify which field name is current. Add a note or update line 562 to reference the new field name for consistency:- - To start them automatically in node configuration set `genvm.manage_modules` to `true` + - To start them automatically in node configuration set `genvm.start_manager` to `true`Alternatively, if
genvm.manage_modulesis still supported for backward compatibility, add a note explaining the relationship between the old and new field names.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/api-references/genlayer-cli.mdx(1 hunks)pages/validators/setup-guide.mdx(18 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/api-references/genlayer-cli.mdxpages/validators/setup-guide.mdx
pages/validators/setup-guide.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/validators/setup-guide.mdx: Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Consensus contract addresses change with network upgrades and must be updated in configuration examples
Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Files:
pages/validators/setup-guide.mdx
🧠 Learnings (13)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.200Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/api-references/genlayer-cli.mdxpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/api-references/genlayer-cli.mdxpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Applied to files:
pages/api-references/genlayer-cli.mdxpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/api-references/genlayer-cli.mdxpages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-12-03T17:07:37.200Z
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.200Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Changelog Updates (pages/validators/changelog.mdx): Add new version entries at the top in reverse chronological order, use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc, and include missing intermediate versions if needed
Applied to files:
pages/validators/setup-guide.mdx
🪛 LanguageTool
pages/validators/setup-guide.mdx
[style] ~19-~19: To form a complete sentence, be sure to include a subject.
Context: ...allet on your server that signs blocks. Can be same as owner, but separate is recom...
(MISSING_IT_THERE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Cursor Bugbot
- GitHub Check: Redirect rules - genlayer-docs
- GitHub Check: Header rules - genlayer-docs
- GitHub Check: Playwright E2E
- GitHub Check: Pages changed - genlayer-docs
🔇 Additional comments (10)
pages/api-references/genlayer-cli.mdx (1)
185-390: Comprehensive CLI documentation expansion aligns well with v0.4.0 validator onboarding.The Network, Account, Staking, Keypair, and Localnet Validator sections are well-structured with clear usage patterns, command hierarchies, and examples. The staking operations documentation properly reflects the wizard-driven onboarding flow and operator/validator address concepts introduced in the setup guide.
pages/validators/setup-guide.mdx (9)
347-385: Environment variable override documentation is clear and comprehensive.The new section documenting the
GENLAYERNODE_prefix pattern for configuration overrides is well-structured with a conversion guide and practical examples. This directly addresses prior feedback about making the override behavior explicit and helps users understand how to deploy via Docker or in containerized environments.
654-673: GenVM WebDriver configuration for Docker is well-documented.The explanation clearly distinguishes between the tarball's default
genvm-module-web.yaml(configured for localhost/binary) and the Docker-specificgenvm-module-web-docker.yamlthat users must create. The inline diff showing the webdriver URL change to use the Docker service name is helpful. Based on learnings, this guidance is accurate.
454-521: Operator key import and backup procedures are thorough and well-organized.The documentation clearly presents two options (CLI wizard import vs. generate new), with explicit commands for import, restore, and backup workflows. The security callouts for verification and backup storage are appropriate. Commands reference the correct config paths and include password/passphrase prompts.
233-240: Consensus contract addresses and genesis block correctly updated for Asimov Phase 4.Configuration snippet reflects the network upgrade with new contract addresses (
contractmainaddress,contractdataaddress) and genesis block4632386. These align with the PR objectives for v0.4.0 configuration updates. Based on learnings about updating consensus addresses and genesis block numbers during network upgrades, this is accurate.
276-304: Node configuration keys properly reflect v0.4.0 changes.New fields
validatorWalletAddressandoperatorAddressare introduced with clear comments explaining their purpose and how to obtain them. The RPC method enablements (eth_sendRawTransaction,zks_getTransaction) are correctly configured. These align with the config changes described in the PR summary.
7-87: New validator wallet creation section provides clear onboarding guidance.The "Create the Validator Wallet" section introduces the three-wallet distinction (Owner/Operator/Validator) with a helpful reference table, walks through the wizard-driven flow, and emphasizes saving addresses for node configuration. The section properly prioritizes the CLI wizard as the recommended approach while documenting manual alternatives. This aligns well with the expanded CLI documentation and the new account/staking operations in the CLI reference.
174-199: Version list correctly updated with v0.4.0 at top.The version list in the download instructions now reflects v0.4.0 as the latest release, with v0.3.x versions listed below. This aligns with the PR objectives for updating version references for the v0.4.0 release per learnings.
735-808: Monitoring with metrics section is comprehensive and production-ready.The documentation covers metrics access, available metric collectors (node, GenVM, WebDriver), configuration customization, example queries, best practices, and recommends a monitoring stack (Prometheus/Grafana) for production validators. This provides clear operational guidance aligned with the broader v0.4.0 feature set. The section is well-structured and actionable.
623-623: Docker Compose setup correctly pins Node image to v0.4.0 and documents .env usage.Line 623 properly uses
${NODE_VERSION:-v0.4.0}as the fallback (notlatest), and line 693 setsNODE_VERSION=v0.4.0in the.envfile. The introductory callout at lines 677–679 explains that the.envfile serves dual purposes (Docker Compose variables andGENLAYERNODE_*config overrides), helping users understand how environment configuration works. This addresses past feedback about version pinning and configuration clarity.Also applies to: 625-625, 693-714
Adds a link to the staking documentation for a deeper understanding of how staking works in GenLayer.
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
pages/validators/setup-guide.mdx (1)
563-574: Update deprecated GenVM configuration field names from v0.3.x to v0.4.0.Lines 564 and 571 reference the deprecated
genvm.manage_modulesfield name. Per the v0.4.0 configuration section (line 317), this should begenvm.start_manager. Update both references for consistency:- - To start them automatically in node configuration set `genvm.manage_modules` to `true` + - To start them automatically in node configuration set `genvm.start_manager` to `true`- Note: If you are using the default configuration, `genvm.manage_modules` is + Note: If you are using the default configuration, `genvm.start_manager` isAs per coding guidelines, this is a v0.4.0 documentation update where field names were renamed during a breaking change. Using the old name creates confusion and potential configuration errors.
♻️ Duplicate comments (2)
pages/validators/setup-guide.mdx (2)
718-718: Clarify thatgenvm-module-web-docker.yamlis NOT included in the tarball.Line 718 states: "use the provided
docker-compose.yaml,.env.exampleand thegenvm-module-web-docker.yamlfrom the extracted tarball."This contradicts the detailed explanation above (lines 656–675) which correctly states users must create
genvm-module-web-docker.yamlthemselves. Only the defaultgenvm-module-web.yamlis in the tarball.Update to:
-or use the provided `docker-compose.yaml` and `.env.example` from the extracted tarball; ensure you also create `genvm-module-web-docker.yaml` as described above. +or use the provided `docker-compose.yaml` and `.env.example` from the extracted tarball; ensure you also create `genvm-module-web-docker.yaml` as described in the previous step.This issue was previously flagged in past reviews. The inline documentation (lines 656–675) is correct, but this line contradicts it and could mislead users.
15-25: Complete the incomplete sentence in Operator address description.Line 21 ends with "recom..." which appears truncated. The full text should be:
-| **Operator** | Hot wallet on your server that signs blocks. Can be same as owner, but separate is recom... | Node config: `operatorAddress` | +| **Operator** | Hot wallet on your server that signs blocks. Can be same as owner, but separate is recommended for security. | Node config: `operatorAddress` |
🧹 Nitpick comments (1)
pages/validators/setup-guide.mdx (1)
604-610: Add clarity about docker-compose setup intended use (testing vs production).The docker-compose section uses a pre-generated keystore with a known password (12345678). While this is fine for testing/development, the guide should explicitly clarify that this Docker setup is primarily for testing and development environments, and production validators should use the binary setup method where they control keystore generation.
Add a callout before line 604:
+<Callout type="warning" emoji="⚠️"> + **For Testing and Development Only:** The docker-compose setup uses a pre-generated keystore with a default password. This is suitable for testing, demos, and development. For production validators, use the binary setup method (above) where you generate and manage your own secure keystore. +</Callout> + #### Running the Node using docker-composeThis would prevent users from accidentally running production validators with a known keystore password.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/validators/setup-guide.mdx(18 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/validators/setup-guide.mdx
pages/validators/setup-guide.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/validators/setup-guide.mdx: Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Consensus contract addresses change with network upgrades and must be updated in configuration examples
Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Files:
pages/validators/setup-guide.mdx
🧠 Learnings (13)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.200Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Changelog Updates (pages/validators/changelog.mdx): Add new version entries at the top in reverse chronological order, use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc, and include missing intermediate versions if needed
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-12-03T17:07:37.200Z
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.200Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Applied to files:
pages/validators/setup-guide.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Enhance command documentation in setup-guide.mdx when new features are added to existing commands
Applied to files:
pages/validators/setup-guide.mdx
🪛 LanguageTool
pages/validators/setup-guide.mdx
[style] ~7-~7: Consider a different adjective to strengthen your wording.
Context: ...or running a GenLayer validator. For a deeper understanding of how staking works in G...
(DEEP_PROFOUND)
[style] ~21-~21: To form a complete sentence, be sure to include a subject.
Context: ...allet on your server that signs blocks. Can be same as owner, but separate is recom...
(MISSING_IT_THERE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - genlayer-docs
- GitHub Check: Cursor Bugbot
- GitHub Check: Playwright E2E
- GitHub Check: Header rules - genlayer-docs
🔇 Additional comments (6)
pages/validators/setup-guide.mdx (6)
165-202: Version references are correctly updated to v0.4.0.The download section properly shows v0.4.0 as the latest version and uses it as the default in the export command. This is consistent with v0.4.0 release guidance.
220-347: Configuration section correctly updated for v0.4.0 with new field names and consensus addresses.The config.yaml examples properly reflect all v0.4.0 changes:
- GenVM field renames (
root_dir,start_manager) instead of deprecated v0.3.x names- Asimov Phase 4 consensus contract addresses and genesis block
- New
validatorWalletAddressandoperatorAddressfields with clear guidance- Appropriate RPC endpoint method configuration
This aligns with the v0.4.0 breaking changes documented in the upgrade guide.
349-388: Environment variable override mechanism is clearly documented with good examples.The new GENLAYERNODE_* prefix pattern for configuration overrides is well-explained with a comprehensive mapping table and practical examples. This is particularly useful for Docker deployments.
453-523: Operator key import and backup section is comprehensive and well-structured.Provides multiple pathways (wizard export, generate new, restore from backup) with clear command syntax, expected outputs, and appropriate security warnings. This directly addresses feedback about clarifying operator address import workflows.
656-675: Excellent documentation of genvm-module-web-docker.yaml creation for docker-compose.Lines 656–675 clearly explain:
- Why a separate file is needed (webdriver container service name vs localhost)
- That it's NOT included in the tarball
- How to create it from the tarball's genvm-module-web.yaml
- The specific configuration difference required
This directly addresses the learning and resolves prior confusion. Based on learnings: "users must create genvm-module-web-docker.yaml (separate from tarball's genvm-module-web.yaml) to point webdriver URL to docker service name."
737-810: Monitoring and metrics documentation is comprehensive and well-organized.The section provides clear guidance on:
- Accessing metrics endpoints with practical examples
- Configuring metrics collectors with interval customization
- Verifying metrics functionality with curl commands
- Production best practices with alerting and visualization recommendations
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
pages/validators/upgrade.mdx (1)
14-19: Add cross-reference to v0.4 configuration updates.Lines 14–19 introduce the breaking change and reference the setup guide, but don't mention that validators should also review the new configuration keys and addresses. Consider adding a note that configuration keys have changed (e.g.,
rollup.genlayerchain*per the PR summary) and validators should check the newconfigs/node/config.yamlexample.This would provide early awareness before they reach the "Configuration Change" section below.
Suggested addition after line 19:
This release involves a change from a single validator address to owner/operator separation. You will need to follow the [setup guide](/validators/setup-guide) to create your new Validator Wallet. + +**Configuration**: Configuration keys have been updated in v0.4 (e.g., `rollup.genlayerchain*` replaces `rollup.*`). Review the example in the setup guide to ensure you apply the correct keys in your new setup.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/validators/upgrade.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/**/*.mdx
📄 CodeRabbit inference engine (CLAUDE.md)
pages/**/*.mdx: All content is in MDX format supporting React components
Import and use custom components within MDX files
Create .mdx file in appropriate pages/ subdirectory when adding new pages
All content should support React components in MDX files
Files:
pages/validators/upgrade.mdx
🧠 Learnings (11)
📓 Common learnings
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the validator setup guide
Learnt from: dohernandez
Repo: genlayerlabs/genlayer-docs PR: 308
File: pages/validators/setup-guide.mdx:790-790
Timestamp: 2025-12-03T17:07:37.200Z
Learning: In pages/validators/setup-guide.mdx: When documenting docker-compose setup, users must create genvm-module-web-docker.yaml (separate from the tarball's genvm-module-web.yaml) to point the webdriver URL to the docker service name (http://webdriver-container:4444) instead of localhost, as the tarball version is configured for binary execution with localhost.
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Setup Guide Updates (pages/validators/setup-guide.mdx): Update version references in download examples and version lists, update configuration examples with new contract addresses when applicable, enhance command documentation when new features are added to existing commands, update genesis block configuration in consensus section when network upgrades occur
Applied to files:
pages/validators/upgrade.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update genesis block configuration in consensus section of setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/upgrade.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version list in curl command output example (line ~88), download command version variable (line ~113), consensus contract addresses and genesis block number (lines ~143-146), and command documentation (line ~347) in setup-guide.mdx for new validator releases
Applied to files:
pages/validators/upgrade.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update consensus contract addresses and genesis block number in setup-guide.mdx when network upgrades occur
Applied to files:
pages/validators/upgrade.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update configuration examples with new contract addresses in setup-guide.mdx when applicable
Applied to files:
pages/validators/upgrade.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in configuration examples
Applied to files:
pages/validators/upgrade.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Changelog Updates (pages/validators/changelog.mdx): Add new version entries at the top in reverse chronological order, use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc, and include missing intermediate versions if needed
Applied to files:
pages/validators/upgrade.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/changelog.mdx : Use consistent format for changelog entries: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Applied to files:
pages/validators/upgrade.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Update version references in download examples and version lists in setup-guide.mdx when new validator releases occur
Applied to files:
pages/validators/upgrade.mdx
📚 Learning: 2025-07-24T07:56:58.272Z
Learnt from: CR
Repo: genlayerlabs/genlayer-docs PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-07-24T07:56:58.272Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup (optional but recommended) and should be updated in documentation when network upgrades occur
Applied to files:
pages/validators/upgrade.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Redirect rules - genlayer-docs
- GitHub Check: Header rules - genlayer-docs
- GitHub Check: Pages changed - genlayer-docs
- GitHub Check: Playwright E2E
- GitHub Check: Cursor Bugbot
| <Callout type="warning" emoji="⚠️"> | ||
| **Recommended: Keep your current validator key as the operator key** | ||
|
|
||
| To maintain continuity, retain your current keystore and use your existing validator address as the operator address when following the setup guide. You can find your current validator address in `configs/node/wallet.yaml`. | ||
| </Callout> | ||
|
|
||
| - Stop the node if it is running. | ||
| - Note your current validator address from `configs/node/wallet.yaml` - you'll use this as your operator address. | ||
| - Back up the `configs/node/config.yaml` file so that you can refer to any values you have set in the previous version. | ||
| - Back up the `data/node/keystore` folder so that you can maintain your previous operator key. |
There was a problem hiding this comment.
Clarify how to use the backed-up operator key during new v0.4 setup.
The warning callout instructs users to retain the keystore, but the operational steps (specifically line 30) back up the keystore without explaining the next step: how and where to use/import this key in the v0.4 setup. This leaves a gap that was flagged in the previous review.
Provide a reference or inline step explaining that users should follow the keystore import process in the setup guide to restore their operator key, or add a step here showing where in the setup flow the backed-up keystore is imported.
Additionally, clarify the owner/operator relationship: make it explicit that the old validator address becomes the new operator address, and that a single operator wallet can manage validator(s) during the v0.4 setup.
Suggested revision:
<Callout type="warning" emoji="⚠️">
**Recommended: Keep your current validator key as the operator key**
To maintain continuity, retain your current keystore and use your existing validator address as the operator address when following the setup guide. You can find your current validator address in `configs/node/wallet.yaml`.
+
+ **How to restore your operator key**: During setup, import your backed-up keystore folder (see "Restore Operator Key" in the setup guide). Your existing validator address becomes your operator address in v0.4, and a single operator wallet can manage one or more validators.
</Callout>
- Stop the node if it is running.
- Note your current validator address from `configs/node/wallet.yaml` - you'll use this as your operator address.
- Back up the `configs/node/config.yaml` file so that you can refer to any values you have set in the previous version.
- Back up the `data/node/keystore` folder so that you can restore your operator key during the new v0.4 setup (see setup guide for import steps).
- Download the packaged binary.
- Install the new version.
- Remove the storage folder `data/node/genlayer.db`.
- Check that configuration is correct by running `genlayernode doctor` command.
- Start the node.This addresses the past feedback from rasca and clarifies the operator key restoration process.
🤖 Prompt for AI Agents
pages/validators/upgrade.mdx lines 21-30: the section backs up the keystore but
doesn't tell users how to restore/import that operator key in v0.4 or clarify
owner/operator relationship; update these steps to add a short inline
instruction pointing users to the keystore import flow in
/validators/setup-guide (or add the exact import step) — e.g., after backing up
data/node/keystore, add “During the v0.4 setup, import your backed‑up keystore
as the operator key following the keystore import steps in
/validators/setup-guide” and explicitly state that the old validator address
becomes the operator address and a single operator wallet can manage
validator(s) in v0.4.
Update setup guide for v0.4.0
Added instruction to validator join and how to run the node using docker compose too.
Summary by CodeRabbit
Documentation
New Features
Configuration / RPC
Breaking Changes
Bug Fixes
✏️ Tip: You can customize this high-level summary in your review settings.
Note
Adds v0.4.0 changelog and rewrites validator docs with staking/validator wallet flow, updated config/RPC, expanded CLI (accounts/staking/network), Docker Compose, env overrides, and a breaking-change upgrade guide.
content/validators/changelog/v0.4.0.mdxand updatepages/validators/changelog.mdxwith features, fixes, and misc changes.pages/validators/setup-guide.mdx:.envusage, WebDriver container config, and genvm setup/precompile guidance.GENLAYERNODE_*).pages/api-references/genlayer-cli.mdx:pages/validators/upgrade.mdx(v0.3.x → v0.4) with fresh setup and DB reset instructions.content/validators/config.yaml)contractmainaddress,contractdataaddress, andgenesis.genlayerchainrpcurl/genlayerchainwebsocketurl.node.validatorWalletAddressandnode.operatorAddress; rename mode "archive" → "full".eth_sendRawTransactionand addzks_*method (zks_getTransaction).root_dir,start_manager,manager_url).Written by Cursor Bugbot for commit ab12428. This will update automatically on new commits. Configure here.