-
Notifications
You must be signed in to change notification settings - Fork 45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add missing SDK 0.47 upgrade items #323
Conversation
WalkthroughThe changes introduced in this pull request involve enhancements to the upgrade handling and module management within the Changes
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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
- app/app.go (2 hunks)
- app/upgrades/v8/upgrades.go (1 hunks)
- x/cork/keeper/msg_server.go (0 hunks)
- x/pubsub/keeper/msg_server.go (0 hunks)
💤 Files with no reviewable changes (2)
- x/cork/keeper/msg_server.go
- x/pubsub/keeper/msg_server.go
🔇 Additional comments (4)
app/upgrades/v8/upgrades.go (2)
4-4
: LGTM: Required imports added correctly
The new imports are necessary for the consensus parameter migration functionality.
Also applies to: 7-8
15-16
: Verify all callers of CreateUpgradeHandler
The function signature change is correct for SDK 0.47 upgrade requirements. However, this is a breaking change that requires verification of all callers.
✅ Verification successful
The search results show that CreateUpgradeHandler
is called in app/app.go
with all the required new parameters (baseAppLegacySS
and consensusParamsKeeper
). The function is also defined in multiple upgrade versions (v4-v8), but this is expected as each version has its own independent implementation with different parameter requirements based on the upgrade needs.
Breaking change is properly handled
The caller in app/app.go
has been correctly updated to pass the new parameters required by the v8 upgrade handler. Other upgrade handlers (v4-v7) are independent implementations and don't need modifications.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Find all callers of CreateUpgradeHandler to ensure they've been updated
# with the new parameters
# Search for function calls to CreateUpgradeHandler
rg -A 5 "CreateUpgradeHandler\("
Length of output: 2215
app/app.go (2)
1041-1042
: LGTM! Verify upgrade handler implementation.
The changes to the upgrade handler setup are correct for SDK 0.47:
- Added
baseAppLegacySS
for parameter migration - Added
ConsensusParamsKeeper
for x/consensus module
Let's verify the upgrade handler implementation:
#!/bin/bash
# Description: Verify that the upgrade handler is properly implemented
# Test: Check the upgrade handler implementation
rg -A 10 "CreateUpgradeHandler" app/upgrades/v8/upgrades.go
Also applies to: 1049-1050
1027-1031
: LGTM! Verify module initialization.
The addition of new modules in the store upgrades looks correct:
consensusparamtypes
andcrisistypes
are standard additions for SDK 0.47addressestypes
is properly included alongside the SDK modules
Let's verify the module initialization:
✅ Verification successful
Modules are properly initialized and integrated
The verification shows that all three modules (addressestypes
, consensusparamtypes
, and crisistypes
) are correctly:
- Imported and declared
- Have their keepers properly initialized
- Are registered in the module manager
- Have their store keys set up
- Have their params subspaces configured
The addition of these modules in the store upgrades is consistent with their integration in the rest of the application.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that the new modules are properly initialized in the InitGenesis order
# Test: Check if the modules are included in InitGenesis order
rg -A 5 "SetOrderInitGenesis" app/app.go
Length of output: 656
Script:
#!/bin/bash
# Let's try a different approach to verify module initialization
# Check for module initialization patterns in app.go
rg -B 2 -A 5 "InitGenesis" app/app.go
# Also check for module manager setup
rg -B 2 -A 10 "NewManager" app/app.go
# Check if these modules are registered in the module manager
rg "addresses|consensusparam|crisis" app/app.go
Length of output: 3713
// new x/consensus module params migration | ||
baseapp.MigrateParams(ctx, baseAppLegacySS, consensusParamsKeeper) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Consider adding error handling for parameter migration
While the parameter migration is correctly implemented, consider handling potential errors from MigrateParams
to ensure a more robust upgrade process.
// new x/consensus module params migration
-baseapp.MigrateParams(ctx, baseAppLegacySS, consensusParamsKeeper)
+if err := baseapp.MigrateParams(ctx, baseAppLegacySS, consensusParamsKeeper); err != nil {
+ return nil, fmt.Errorf("failed to migrate consensus params: %w", err)
+}
Committable suggestion was skipped due to low confidence.
Summary by CodeRabbit
New Features
Bug Fixes
Refactor