celestiaorg / celestia-app

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

fix!: v3 upgrade delay #4008

Closed evan-forbes closed 3 weeks ago

evan-forbes commented 4 weeks ago

Overview

Currently, there's a bug in v3 that will use the next version's upgrade delay instead of the current version's.

For non-arabica networks, this PR introduces a consensus breaking change that fixes this issue. For arabica networks, they will continue to use the next version's delay.

coderabbitai[bot] commented 4 weeks ago
📝 Walkthrough ## Walkthrough The changes in this pull request primarily focus on enhancing the upgrade logic and timeout configurations within the application. Modifications include updating the `UpgradeHeightDelay` function to incorporate a `chainID`, adjusting test cases to reflect these changes, and introducing new parameters for upgrade height delays. Additionally, deprecated methods have been replaced with more flexible configurations for block timing. Overall, the changes aim to improve the handling of version upgrades and their associated parameters in the testing environment. ## Changes | File Path | Change Summary | |---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | app/test/square_size_test.go | Modified `SetupSuite` in `SquareSizeIntegrationTest` to add a timeout commit configuration with `WithTimeoutCommit(time.Second)`. | | app/test/upgrade_test.go | Updated `TestAppUpgradeV3` to calculate upgrade height delay using `chainID` in calls to `appconsts.UpgradeHeightDelay`. Adjusted assertions related to timeout parameters. | | pkg/appconsts/versioned_consts.go | Updated `UpgradeHeightDelay` function signature to include `chainID`. Adjusted switch statement for `v2.Version` to return `v3.UpgradeHeightDelay` for `ArabicaChainID`. Added `strings` import. | | pkg/appconsts/versioned_consts_test.go | Added `TestUpgradeHeightDelay` to validate `UpgradeHeightDelay` behavior with various scenarios, including chain IDs and version-specific behavior. | | test/util/testnode/config.go | Introduced `WithBlockTime` method to set block time, deprecated `WithTimeoutCommit`. Updated `DefaultAppCreator` to accept multiple options. | | x/signal/integration_test.go | Modified `TestUpgradeIntegration` to use `chainID` in `appconsts.UpgradeHeightDelay` calls, affecting block height calculations. | | x/signal/keeper.go | Updated `TryUpgrade` method to calculate `UpgradeHeight` using both `ChainID` and `App` version. | | x/signal/keeper_test.go | Updated test logic to reflect new `UpgradeHeightDelay` method signature, adjusting block height calculations and context initialization. | | pkg/appconsts/chain_ids.go | Added new constant `ArabicaChainID` with value `"arabica-11"`. | | specs/src/parameters_v2.md | Updated to include new global parameter `UpgradeHeightDelay` with a default value of `50400`. | | specs/src/parameters_v3.md | Updated to include new global parameter `UpgradeHeightDelay` with a default value of `100800`. | ## Possibly related PRs - **#3560**: Introduces a delay between quorum and upgrade height, relating to timeout behavior for block commits. - **#3882**: Focuses on versioned timeouts, updating timeout settings based on application version. - **#3980**: Discusses modifications to `UpgradeHeightDelay` and its integration into application logic. - **#3910**: Implements an end-to-end upgrade test for version 3, potentially involving similar timeout configurations. - **#4006**: Adds notes about the upgrade process for validators, including considerations for timeout settings during upgrades. ## Suggested labels `enhancement` ## Suggested reviewers - staheri14 - ninabarbakadze - rootulp - 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.
github-actions[bot] commented 3 weeks ago

PR Preview Action v1.4.8 :---: :rocket: Deployed preview to https://celestiaorg.github.io/celestia-app/pr-preview/pr-4008/ on branch gh-pages at 2024-10-28 21:40 UTC