docs: add notes about upgrading for validators in the release notes #4006
Conversation
cmwaters
requested review from
rootulp and
rach-id
and removed request for
a team
📝 WalkthroughWalkthroughThe release notes for version 3.0.0 of the Celestia application have been updated to include new requirements and functionalities for consensus node operators. Key changes include the mandatory use of the BBR congestion control algorithm and the configuration of the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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
Documentation and Community
|
![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
🧹 Outside diff range and nitpick comments (4)
docs/release-notes/release-notes.md (4)
16-17: Consider adding more context about the x/signal module.The introduction of the x/signal module could benefit from a brief explanation of its purpose and benefits compared to the previous upgrade mechanism.
- Upgrades now use the `x/signal` module to coordinate the network to an upgrade height. + Upgrades now use the `x/signal` module to coordinate network upgrades more efficiently. This module allows validators to signal their upgrade readiness and automatically determines the upgrade height once consensus is reached.
18-22: Add prerequisites for the upgrade signaling command.The command section should clarify any prerequisites or conditions that must be met before a validator can signal for the upgrade.
-The following command can be used, if you are a validator in the active set, to signal to upgrade to v3 +### Signaling for the Upgrade + +Prerequisites: +- You must be a validator in the active set +- Your node must be running the latest version + +Use the following command to signal your readiness for the v3 upgrade:
39-40: Improve documentation reference formatting.The reference to module documentation needs better formatting and context.
-For more information refer to the module [docs](../../x/signal/README.md) +For more information, refer to the [x/signal module documentation](../../x/signal/README.md).🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: A comma might be missing here.
Context: ...sion 3 at height 2348907. ``` For more information refer to the module [docs](../../x/sign...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
34-37: Add error handling example for the upgrade query.The upgrade query example should include possible error scenarios.
```bash celestia-appd query signal upgrade > An upgrade is pending to app version 3 at height 2348907. +> # Or when no upgrade is pending: +> No pending upgrades found.</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: .coderabbit.yaml** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Files that changed from the base of the PR and between 312def62a1fcb688c30f7f98ae92e81924f3ceee and 47d5a5f22a89bdc17a557b548ff74f1f894b0d29. </details> <details> <summary>📒 Files selected for processing (1)</summary> * docs/release-notes/release-notes.md (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary><blockquote> <details> <summary>docs/release-notes/release-notes.md</summary><blockquote> [uncategorized] ~30-~30: This word is normally spelled with a hyphen. Context: ..., the upgrade will be ready. There is a hard coded delay between confirmation of the upgra... (HARD_CODE_COMPOUND) --- [uncategorized] ~30-~30: The preposition ‘of’ seems more likely in this position. Context: ...nfirmation of the upgrade and execution to the new state machine. To view the up... (AI_HYDRA_LEO_REPLACE_TO_OF) --- [uncategorized] ~39-~39: A comma might be missing here. Context: ...sion 3 at height 2348907. ``` For more information refer to the module [docs](../../x/sign... (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA) </blockquote></details> </blockquote></details> <details> <summary>🪛 Markdownlint</summary><blockquote> <details> <summary>docs/release-notes/release-notes.md</summary><blockquote> 30-30: Expected: 0 or 2; Actual: 1 Trailing spaces (MD009, no-trailing-spaces) </blockquote></details> </blockquote></details> </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| Once 5/6+ of the voting power have signalled, the upgrade will be ready. There is a hard coded delay between confirmation of the upgrade and execution to the new state machine. | ||
|
|
There was a problem hiding this comment.
Fix grammar and add specifics about the upgrade delay.
The sentence structure needs improvement, and the hard-coded delay should be specified.
-Once 5/6+ of the voting power have signalled, the upgrade will be ready. There is a hard coded delay between confirmation of the upgrade and execution to the new state machine.
+Once 5/6+ of the voting power has signaled, the upgrade will be confirmed. There is a hard-coded delay of X blocks between the upgrade confirmation and execution of the new state machine.Committable suggestion was skipped due to low confidence.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~30-~30: This word is normally spelled with a hyphen.
Context: ..., the upgrade will be ready. There is a hard coded delay between confirmation of the upgra...(HARD_CODE_COMPOUND)
[uncategorized] ~30-~30: The preposition ‘of’ seems more likely in this position.
Context: ...nfirmation of the upgrade and execution to the new state machine. To view the up...(AI_HYDRA_LEO_REPLACE_TO_OF)
🪛 Markdownlint
30-30: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
| The following command can be used, if you are a validator in the active set, to signal to upgrade to v3 | ||
|
|
||
| ```bash | ||
| celestia-appd tx signal signal 3 <plus transaction flags> |
There was a problem hiding this comment.
[personal opinion][nit]
| celestia-appd tx signal signal 3 <plus transaction flags> | |
| celestia-appd tx signal signal 3 <transaction flags> |
the plus seems a bit redundant
| @@ -13,6 +13,31 @@ This guide provides notes for major version releases. These notes may be helpful | |||
| sed -i 's/ttl-num-blocks = 5/ttl-num-blocks = 12/' ~/.celestia-app/config/config.toml | |||
| ``` | |||
|
|
|||
| - Upgrades now use the `x/signal` module to coordinate the network to an upgrade height. | |||
|
|
|||
| The following command can be used, if you are a validator in the active set, to signal to upgrade to v3 | |||
There was a problem hiding this comment.
| The following command can be used, if you are a validator in the active set, to signal to upgrade to v3 | |
| The following command can be used, if you are a validator in the active set, to signal to upgrade to v3: |
| celestia-appd tx signal signal 3 <plus transaction flags> | ||
| ``` | ||
|
|
||
| You can track the tally of signalling by validators using the following query |
There was a problem hiding this comment.
| You can track the tally of signalling by validators using the following query | |
| You can track the tally of signalling by validators using the following query: |
| > An upgrade is pending to app version 3 at height 2348907. | ||
| ``` | ||
|
|
||
| For more information refer to the module [docs](../../x/signal/README.md) |
There was a problem hiding this comment.
| For more information refer to the module [docs](../../x/signal/README.md) | |
| For more information refer to the module [docs](../../x/signal/README.md). |
Provide some information to validators on signalling to upgrade