docs: add validator migration guide and networks list table #1854
Conversation
WalkthroughThe pull request enhances the validator node documentation by introducing a comprehensive guide for migrating a validator to a new machine. The new section provides a detailed, step-by-step process that covers setting up a new consensus node, stopping the old validator, securely transferring the validator key, and restarting the validator. Additionally, a new FAQ entry is added to help users troubleshoot a specific block version mismatch error, improving the overall documentation's utility and user guidance. Changes
Poem
Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
how-to-guides/validator-node.md (2)
275-283: Clarify the service name placeholderThe
<SERVICE_NAME>placeholder needs more context. Consider adding a note explaining that this should be replaced with the actual SystemD service name (e.g.,celestia-appd.service) that was set up during the initial validator configuration.
293-297: Consider additional backup recommendationsWhile backing up
priv_validator_key.jsonis crucial, consider recommending backup of additional important files:
config/node_key.jsonfor node identitydata/priv_validator_state.jsonfor validator stateconfig/client.tomlfor custom configurations
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/validator-node.md(2 hunks)
🔇 Additional comments (2)
how-to-guides/validator-node.md (2)
184-189: Well-structured networks table!The table provides clear and accurate information about available networks, with proper documentation links and correct chain IDs.
251-253: Excellent warning about double signing risks!The note effectively emphasizes the critical nature of the migration process and potential consequences of mistakes.
| If everything checks out, you can now restart the new node with the updated validator key: | ||
|
|
||
| ```bash | ||
| sudo systemctl restart <SERVICE_NAME> | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add verification steps after migration
Consider adding commands to verify the validator is operating correctly after migration:
- Check validator status and voting power
- Verify block signing
- Monitor for any missed blocks
Example verification commands to add:
+# Check validator status
+celestia-appd query staking validator $(celestia-appd keys show $VALIDATOR_WALLET --bech val -a)
+
+# Monitor block signing
+celestia-appd query slashing signing-info $(celestia-appd tendermint show-validator)Committable suggestion skipped: line range outside the PR's diff.
Overview
This PR adds two sections to the docs, specifically to the
validator-node.mdfile:Summary by CodeRabbit