search

celestiaorg / celestia-app

Celestia consensus node
https://celestiaorg.github.io/celestia-app/
Apache License 2.0
345 stars 292 forks source link

feat: add script to configure v3 #4022

Closed evan-forbes closed 2 weeks ago

evan-forbes commented 2 weeks ago

Overview

adds a script and better docs for configuring everything for v3

coderabbitai[bot] commented 2 weeks ago
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough ## Walkthrough The pull request introduces modifications to the `Makefile`, `app/default_overrides.go`, and the release notes. A new variable `CONFIG_FILE` and `SEND_RECV_RATE` are added to the `Makefile`, along with a new target `configure-v3` for managing configuration settings. The `app/default_overrides.go` file is updated to set `SendRate` and `RecvRate` to 10 MiB, enhancing P2P communication. The release notes are revised to include instructions for node operators on enabling new configurations and using the `configure-v3` command, along with clarifications on upgrade signaling. ## Changes | File | Change Summary | |----------------------------------------|----------------------------------------------------------------------------------------------------------------------| | Makefile | - Added variable `CONFIG_FILE ?= ${HOME}/.celestia-app/config/config.toml` | | | - Added variable `SEND_RECV_RATE ?= 10485760 # 10 MiB` | | | - Added target `configure-v3` for updating configuration parameters. | | app/default_overrides.go | - Added constant `const mebibyte = 1048576` | | | - Updated `cfg.P2P.SendRate = 10 * mebibyte` in `DefaultConsensusConfig` function. | | | - Updated `cfg.P2P.RecvRate = 10 * mebibyte` in `DefaultConsensusConfig` function. | | docs/release-notes/release-notes.md | - Updated release notes for version 3.0.0 with new configuration instructions. | | | - Added commands `make enable-bbr` and `make configure-v3`. | | | - Clarified instructions for enabling BBR and configuring nodes for version 3. | ## Possibly related PRs - **#3961**: This PR modifies the `app/default_overrides.go` file to increase the `TTLNumBlocks` from 5 to 12, which directly relates to the changes in the main PR that also involve updating the `ttl-num-blocks` parameter in the `Makefile`. - **#4006**: This PR adds notes about the requirement for consensus node operators to manually set the `ttl-num-blocks` parameter to 12 in the `config.toml` file, which is consistent with the changes made in the main PR regarding configuration management. ## Suggested labels `bug` ## Suggested reviewers - rootulp - liamsi - ninabarbakadze - staheri14 - cmwaters

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?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > ‼️ **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
coderabbitai[bot] commented 2 weeks ago
📝 Walkthrough ## Walkthrough The changes in this pull request involve modifications to the `Makefile`, `app/default_overrides.go`, and the release notes. A new variable and target are added to the `Makefile` for configuring application settings, while the `default_overrides.go` file introduces constants for data rates and updates configuration settings for state synchronization. The release notes are updated to reflect new requirements for node operators, including instructions for enabling specific features and configuration settings for version 3.0.0. ## Changes | File | Change Summary | |-------------------------------------|-------------------------------------------------------------------------------------------------| | Makefile | - Added variable `CONFIG_FILE` for configuration file path.
- Added variable `SEND_RECV_RATE` set to 10 MiB.
- Introduced target `configure-v3` for updating configuration settings. | | app/default_overrides.go | - Added constant `mebibyte`.
- Updated `SendRate` and `RecvRate` in `DefaultConsensusConfig` to 10 MiB.
- Updated `SnapshotInterval` and `SnapshotKeepRecent` in `DefaultAppConfig`. | | docs/release-notes/release-notes.md | - Updated release notes for version 3.0.0 with new instructions for node operators.
- Added commands for enabling MCTCP and configuring the node for version 3.
- Clarified requirements for enabling BBR. | ## Possibly related PRs - **#3961**: This PR modifies the `app/default_overrides.go` file to increase the `TTLNumBlocks` from 5 to 12, which directly relates to the changes made in the main PR that also updates `ttl-num-blocks` from `5` to `12` in the configuration file. - **#4006**: This PR adds notes about the requirement for consensus node operators to manually set the `ttl-num-blocks` parameter to 12 in the `config.toml` file, which is directly connected to the changes made in the main PR regarding the configuration updates. ## Suggested reviewers - rootulp - liamsi - ninabarbakadze - rach-id

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?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > ‼️ **IMPORTANT** > Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged. - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.