Add v5 upgrade handler and set up container upgrade test
#1153
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThe project introduces an upgrade to version 5.0.0, focusing on enhancing the protocol's app setup and testing environment. This includes the addition of a new upgrade handler, constants for the upgrade, and migration logic for store keys related to vault types. The testing scripts and constants are updated to support and test this new version, streamlining the upgrade process and ensuring compatibility. 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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
teddyding
changed the title
v5 upgrade handler and set up container upgrade test
teddyding
commented
Mar 7, 2024
| "block": { | ||
| "max_bytes": "4194304", | ||
| "max_gas": "-1" | ||
| "app_name": "dydxprotocold", |
There was a problem hiding this comment.
@roy-dydx Do we have a canonical way of generating this file? I just initialized genesis with rc1 binary and replaced a subset of the states
teddyding
commented
Mar 7, 2024
| @@ -153,22 +154,27 @@ setup_cosmovisor() { | |||
| done | |||
| } | |||
|
|
|||
| copy_preupgrade_binary_arch() { | |||
| download_preupgrade_binary() { | |||
There was a problem hiding this comment.
Reverting Luke's temporary changes here
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files ignored due to path filters (1)
protocol/testing/containertest/preupgrade_genesis.jsonis excluded by:!**/*.json
Files selected for processing (6)
- protocol/app/upgrades.go (2 hunks)
- protocol/app/upgrades/v5.0.0/constants.go (1 hunks)
- protocol/app/upgrades/v5.0.0/upgrade.go (1 hunks)
- protocol/testing/containertest/containertest.sh (3 hunks)
- protocol/testing/containertest/testnet.go (1 hunks)
- protocol/testing/containertest/testnet_test.go (1 hunks)
Files skipped from review due to trivial changes (1)
- protocol/testing/containertest/testnet_test.go
Additional comments: 7
protocol/app/upgrades/v5.0.0/constants.go (2)
- 10-12: The constant
UpgradeNameis correctly defined to represent the version of the upgrade. This is a good practice for clarity and maintainability.- 14-21: The
Upgradevariable is well-defined, encapsulating the upgrade name and store upgrades. Including thevaulttypes.StoreKeyin theAddedlist of store upgrades is essential for ensuring that new store keys required by the upgrade are properly initialized. This approach follows best practices for defining upgrade logic in a modular and clear manner.protocol/app/upgrades.go (2)
- 37-46: The addition of the v5.0.0 upgrade handler is correctly implemented with a check for duplicate handlers before setting the new handler. This is a crucial step to prevent accidental override of existing handlers and ensure the application's upgrade logic is correctly managed. The use of
panicfor handling duplicate handlers is appropriate here, as it prevents the application from starting in an inconsistent state.- 33-49: > 📝 NOTE
This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [10-46]
The setup functions for registering upgrade handlers and setting store loaders are well-implemented, ensuring that the application correctly handles upgrades and migrations. The approach taken here, including the use of
panicin critical error scenarios, aligns with best practices for Cosmos SDK applications, ensuring that misconfigurations are caught early in the application lifecycle.protocol/testing/containertest/testnet.go (1)
- 28-28: Updating the
UpgradeToVersionconstant to"v5.0.0"correctly reflects the protocol's upgrade to version 5.0.0. This change is essential for ensuring that the testing framework and container tests are aligned with the current version of the protocol, facilitating accurate and relevant testing scenarios.protocol/testing/containertest/containertest.sh (2)
- 10-10: Introducing the
PREUPGRADE_VERSIONvariable is a practical approach to specify the version of the binary to be used for pre-upgrade testing. This allows for more flexible and accurate testing scenarios by ensuring that tests are run against the correct version of the software, reflecting real-world upgrade paths.- 157-177: The modifications to the binary download function, now named
download_preupgrade_binary, are well-implemented. The function dynamically determines the architecture, constructs the appropriate download URL, and then downloads and extracts the pre-upgrade binary. This approach enhances the flexibility and robustness of the testing setup by ensuring that the correct binary version is used across different architectures. However, it's important to ensure that the URL used for downloading binaries is secure and that the downloaded binaries are verified to prevent potential security risks.Ensure that the download URL is secure and that downloaded binaries are verified to mitigate potential security risks.
Comment on lines
+12
to
+24
| func CreateUpgradeHandler( | ||
| mm *module.Manager, | ||
| configurator module.Configurator, | ||
| ) upgradetypes.UpgradeHandler { | ||
| return func(ctx context.Context, plan upgradetypes.Plan, vm module.VersionMap) (module.VersionMap, error) { | ||
| sdkCtx := lib.UnwrapSDKContext(ctx, "app/upgrades") | ||
| sdkCtx.Logger().Info(fmt.Sprintf("Running %s Upgrade...", UpgradeName)) | ||
|
|
||
| // TODO(TRA-93): Initialize `x/vault` module. | ||
|
|
||
| return mm.RunMigrations(ctx, configurator, vm) | ||
| } | ||
| } |
There was a problem hiding this comment.
The CreateUpgradeHandler function is well-structured, providing a clear and concise way to define the upgrade logic for version 5.0.0. It correctly unwraps the SDK context and logs the upgrade execution, which is crucial for debugging and monitoring the upgrade process. However, there's a TODO comment indicating that the initialization of the x/vault module is pending. It's important to address this TODO to ensure that all necessary module initializations are completed as part of the upgrade.
Ensure the TODO for initializing the x/vault module is addressed to complete the upgrade logic.
tqin7
approved these changes
Mar 7, 2024
Eric-Warehime
pushed a commit
to skip-mev/v4-chain
that referenced
this pull request
Mar 12, 2024
…col#1153) * wip * update preupgrade_genesis * fix preupgrade_genesis.json * nit * setupUpgradeStoreLoaders for v5.0.0 Signed-off-by: Eric <eric.warehime@gmail.com>
Eric-Warehime
added a commit
to skip-mev/v4-chain
that referenced
this pull request
Mar 12, 2024
commit d98f859 Author: Eric <eric.warehime@gmail.com> Date: Mon Mar 11 12:46:53 2024 -0700 Update sample pregenesis Signed-off-by: Eric <eric.warehime@gmail.com> commit 7f178fe Author: Mohammed Affan <affanmd@nyu.edu> Date: Mon Mar 11 13:46:08 2024 -0400 [OTE-209] Emit metrics gated through execution mode (dydxprotocol#1157) Signed-off-by: Eric <eric.warehime@gmail.com> commit 47e365d Author: dydxwill <119354122+dydxwill@users.noreply.github.com> Date: Mon Mar 11 13:43:16 2024 -0400 add aggregate comlink response code stats (dydxprotocol#1162) Signed-off-by: Eric <eric.warehime@gmail.com> commit 7774ad9 Author: shrenujb <98204323+shrenujb@users.noreply.github.com> Date: Fri Mar 8 17:30:49 2024 -0500 [TRA-70] Add state migrations for isolated markets (dydxprotocol#1155) Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange> Signed-off-by: Eric <eric.warehime@gmail.com> commit 89c7405 Author: Jonathan Fung <121899091+jonfung-dydx@users.noreply.github.com> Date: Thu Mar 7 17:28:06 2024 -0500 [CT-517] E2E tests batch cancel (dydxprotocol#1149) * more end to end test * extraprint * more e2e test Signed-off-by: Eric <eric.warehime@gmail.com> commit 41a3a41 Author: Teddy Ding <teddy@dydx.exchange> Date: Thu Mar 7 15:42:30 2024 -0500 [OTE-200] OIMF protos (dydxprotocol#1125) * OIMF protos * add default genesis value, modify methods interface * fix genesis file * fix integration test * lint Signed-off-by: Eric <eric.warehime@gmail.com> commit 2a062b1 Author: Teddy Ding <teddy@dydx.exchange> Date: Thu Mar 7 15:24:15 2024 -0500 Add `v5` upgrade handler and set up container upgrade test (dydxprotocol#1153) * wip * update preupgrade_genesis * fix preupgrade_genesis.json * nit * setupUpgradeStoreLoaders for v5.0.0 Signed-off-by: Eric <eric.warehime@gmail.com> commit b7942b3 Author: jayy04 <103467857+jayy04@users.noreply.github.com> Date: Thu Mar 7 13:43:48 2024 -0500 [CT-647] construct the initial orderbook snapshot (dydxprotocol#1147) * [CT-647] construct the initial orderbook snapshot * [CT-647] initialize new streams and send orderbook snapshot (dydxprotocol#1152) * [CT-647] initialize new streams and send orderbook snapshot * use sync once * comments Signed-off-by: Eric <eric.warehime@gmail.com> commit c67a3c6 Author: shrenujb <98204323+shrenujb@users.noreply.github.com> Date: Thu Mar 7 12:40:37 2024 -0500 [TRA-84] Move SA module address transfers to use perpetual based SA accounts (dydxprotocol#1146) Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange Signed-off-by: Eric <eric.warehime@gmail.com> commit dba23e0 Author: Mohammed Affan <affanmd@nyu.edu> Date: Thu Mar 7 10:34:11 2024 -0500 update readme link to point to the right page (dydxprotocol#1151) Signed-off-by: Eric <eric.warehime@gmail.com> commit b5870d5 Author: Tian <tian@dydx.exchange> Date: Wed Mar 6 16:43:04 2024 -0500 [TRA-86] scaffold x/vault (dydxprotocol#1148) * scaffold x/vault Signed-off-by: Eric <eric.warehime@gmail.com> commit 0eca041 Author: jayy04 <103467857+jayy04@users.noreply.github.com> Date: Wed Mar 6 10:48:42 2024 -0500 [CT-652] add command line flag for full node streaming (dydxprotocol#1145) Signed-off-by: Eric <eric.warehime@gmail.com> commit b319cb8 Author: jayy04 <103467857+jayy04@users.noreply.github.com> Date: Tue Mar 5 21:58:35 2024 -0500 [CT-646] stream offchain updates through stream manager (dydxprotocol#1138) * [CT-646] stream offchain updates through stream manager * comments * fix lint * get rid of finished * comments * comments Signed-off-by: Eric <eric.warehime@gmail.com> commit 1c54620 Author: shrenujb <98204323+shrenujb@users.noreply.github.com> Date: Tue Mar 5 16:34:19 2024 -0500 [TRA-78] Add function to retrieve collateral pool addr for a subaccount (dydxprotocol#1142) Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange> Signed-off-by: Eric <eric.warehime@gmail.com> commit b8c1d62 Author: dydxwill <119354122+dydxwill@users.noreply.github.com> Date: Tue Mar 5 15:03:28 2024 -0500 [OTE-141] implement post /compliance/geoblock (dydxprotocol#1129) Signed-off-by: Eric <eric.warehime@gmail.com> commit ab8c570 Author: Jonathan Fung <121899091+jonfung-dydx@users.noreply.github.com> Date: Tue Mar 5 11:19:53 2024 -0500 Fix mock-gen dydxprotocol#1140 Signed-off-by: Eric <eric.warehime@gmail.com> commit 12506a1 Author: shrenujb <98204323+shrenujb@users.noreply.github.com> Date: Mon Mar 4 21:33:28 2024 -0500 [TRA-64] Use market specific insurance fund for cross or isolated markets (dydxprotocol#1132) Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange> Signed-off-by: Eric <eric.warehime@gmail.com> commit 929f09e Author: Jonathan Fung <121899091+jonfung-dydx@users.noreply.github.com> Date: Mon Mar 4 13:48:04 2024 -0800 [CT-514] Clob `MsgBatchCancel` functionality (dydxprotocol#1110) * wip implementation * use new cometbft * Revert "use new cometbft" This reverts commit e5b8a03. * go mod tidy * basic e2e test * more msgBatchCancels in code * repeated fixed32 -> uint32 * remove debug prints * update cometbft replace go.mod sha * one more debug print * typo * regen indexer protos * update comment on proto * proto comment changes * extract stateful validation into own fn * pr format comments * clean up test file * new return type with success and failure Signed-off-by: Eric <eric.warehime@gmail.com> commit 41de83e Author: dydxwill <119354122+dydxwill@users.noreply.github.com> Date: Mon Mar 4 12:22:16 2024 -0500 add index to address read replica lag (dydxprotocol#1137) Signed-off-by: Eric <eric.warehime@gmail.com> commit 735d9a8 Author: dydxwill <119354122+dydxwill@users.noreply.github.com> Date: Mon Mar 4 11:56:59 2024 -0500 rename (dydxprotocol#1136) Signed-off-by: Eric <eric.warehime@gmail.com> commit 86617dd Author: jayy04 <103467857+jayy04@users.noreply.github.com> Date: Mon Mar 4 10:43:31 2024 -0500 [CT-644] instantiate grpc stream manager (dydxprotocol#1134) * [CT-644] instantiate grpc stream manager * update type * update channel type Signed-off-by: Eric <eric.warehime@gmail.com> commit 32afd64 Author: Eric <eric.warehime@gmail.com> Date: Mon Mar 11 12:41:06 2024 -0700 Update go version in Dockerfile Signed-off-by: Eric <eric.warehime@gmail.com> commit ba27204 Author: Eric <eric.warehime@gmail.com> Date: Fri Mar 8 09:44:04 2024 -0800 Add slinky utils, use that to convert between market and currency pair commit 667a804 Author: Eric <eric.warehime@gmail.com> Date: Wed Mar 6 20:43:40 2024 -0800 Update error messages commit d53292c Author: Eric <eric.warehime@gmail.com> Date: Wed Mar 6 20:16:01 2024 -0800 Update docstrings, rename OracleClient commit daad125 Author: Eric <eric.warehime@gmail.com> Date: Mon Mar 4 10:51:23 2024 -0800 VoteExtension slinky logic
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelist
Sets up v5 upgrade as well upgrade container test
Test Plan
[Describe how this PR was tested (if applicable)]
Author/Reviewer Checklist
state-breakinglabel.indexer-postgres-breakinglabel.PrepareProposalorProcessProposal, manually add the labelproposal-breaking.feature:[feature-name].backport/[branch-name].refactor,chore,bug.