celestiaorg / celestia-app

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

feat!: version `UpgradeHeightDelay` #3980

Closed evan-forbes closed 1 month ago

evan-forbes commented 1 month ago

Overview

closes #3978 #3979

this is just a nice to have for v3. If we're worried about this causing issues at all, we should just postpone this imo.

coderabbitai[bot] commented 1 month ago
📝 Walkthrough ## Walkthrough The pull request introduces several modifications across multiple files, primarily focusing on the application's initialization, upgrade handling, and timeout configurations. Key changes include the removal of the `DefaultUpgradeHeightDelay` constant, updates to method signatures in the `App` struct, and the introduction of new timeout constants in versioned packages. Additionally, the `docker-compose.yml` file has been updated to specify Dockerfile locations for services, and various test files have been adjusted to reflect these changes in functionality and structure. ## Changes | File | Change Summary | |----------------------------------------|-----------------------------------------------------------------------------------------------------| | app/app.go | Updated `SignalKeeper` initialization, modified `EndBlocker`, `InitChain`, and `Info` method signatures. | | app/default_overrides.go | Changed `DefaultConsensusConfig` to use dynamic timeout retrieval. | | app/module/configurator_test.go | Modified `keeper` instantiation in `TestConfigurator`. | | app/test/upgrade_test.go | Adjusted upgrade logic to utilize dynamic timeout parameters. | | go.mod | Updated several dependencies and their versions. | | local_devnet/docker-compose.yml | Added `dockerfile` specifications for services and set dependencies among them. | | pkg/appconsts/global_consts.go | Removed `DefaultUpgradeHeightDelay` constant and `UpgradeHeightDelay` function. | | pkg/appconsts/v1/app_consts.go | Added new constants: `TimeoutPropose`, `TimeoutCommit`, `UpgradeHeightDelay`. | | pkg/appconsts/v2/app_consts.go | Added new constants: `TimeoutPropose`, `TimeoutCommit`, `UpgradeHeightDelay`. | | pkg/appconsts/v3/app_consts.go | Added new constants: `TimeoutPropose`, `TimeoutCommit`, `UpgradeHeightDelay`. | | pkg/appconsts/versioned_consts.go | Added methods for dynamic timeout and upgrade height retrieval based on versioning. | | test/e2e/benchmark/benchmark.go | Introduced `NewBenchmarkTest` function and modified comments. | | test/e2e/benchmark/manifest.go | Added `GenesisAppVersion` field to `Manifest` struct. | | test/e2e/major_upgrade_v3.go | Updated version string and timer duration in `MajorUpgradeToV3`. | | test/e2e/simple.go | Clarified comment for `E2ESimple` function. | | test/e2e/testnet/testnet.go | Added variadic parameters to multiple methods in `Testnet` struct. | | test/util/testnode/app_wrapper.go | Introduced `wrapEndBlocker` function. | | test/util/testnode/config.go | Modified `DefaultAppCreator` and `CustomAppCreator` functions for end blocker configuration. | | test/util/testnode/network.go | Assigned `tmNode` variable to `cctx` context object. | | test/util/testnode/node_interaction_api.go | Added `tmNode` field and `GetTMNode()` method to `Context` struct. | | x/blobstream/integration_test.go | Added wait for blocks in `SetupSuite` method. | | x/signal/integration_test.go | Modified block height adjustment logic in `TestUpgradeIntegration`. | | x/signal/keeper.go | Removed `upgradeHeightDelayBlocks` field and updated `NewKeeper` function. | | x/signal/keeper_test.go | Adjusted keeper instantiation and upgrade logic in tests. | ## Assessment against linked issues | Objective | Addressed | Explanation | |--------------------------------------------------------------------|-----------|---------------------------------------------------| | Stop requiring `TestAppUpgradeV3` to produce enough blocks (3978) | ✅ | | ## Possibly related issues - **#3979**: The changes in this PR regarding the removal of `DefaultUpgradeHeightDelay` may align with the need to version the delay for future upgrades. ## Possibly related PRs - **#3450**: Related changes in `app/app.go` regarding initialization logic. - **#3560**: Modifications to the `EndBlocker` function align with changes in this PR. - **#3680**: Updates in test configuration may interact with consensus parameters introduced in this PR. - **#3890**: Changes in upgrade logic are relevant to the overall upgrade handling. - **#3910**: Enhancements to upgrade testing align with the focus of this PR. - **#3961**: Changes to mempool configuration may affect timing and behavior discussed in this PR. ## Suggested labels `required` ## 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.
cmwaters commented 1 month ago

Another option is to set a time instead of a number of blocks, which becomes the delay. This makes it easier to know when exactly the switch to vX will happen

evan-forbes commented 1 month ago

Another option is to set a time instead of a number of blocks, which becomes the delay. This makes it easier to know when exactly the switch to vX will happen

I like that the most!

if we postpone to v4, then I definitely think we should do that and bother with the migration etc

evan-forbes commented 1 month ago

merging now but I'm assigning myself the flups

thanks everyone!!