-
Notifications
You must be signed in to change notification settings - Fork 341
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(upgrade): add upgrade handler for new and modified modules (#783)
Co-authored-by: Đỗ Việt Hoàng <hoangdv2429@gmail.com> Co-authored-by: Omri <omritoptix@gmail.com>
- Loading branch information
3 people
authored
Apr 2, 2024
1 parent
6cd9da4
commit 1a1da34
Showing
11 changed files
with
188 additions
and
27 deletions.
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| package v3 | ||
|
|
||
| import ( | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| delayedacktypes "github.com/dymensionxyz/dymension/v3/x/delayedack/types" | ||
| rollapptypes "github.com/dymensionxyz/dymension/v3/x/rollapp/types" | ||
| seqtypes "github.com/dymensionxyz/dymension/v3/x/sequencer/types" | ||
| ) | ||
|
|
||
| type RollappKeeper interface { | ||
| SetParams(ctx sdk.Context, params rollapptypes.Params) | ||
| } | ||
|
|
||
| type SequencerKeeper interface { | ||
| SetParams(ctx sdk.Context, params seqtypes.Params) | ||
| } | ||
|
|
||
| type DelayedAckKeeper interface { | ||
| SetParams(ctx sdk.Context, params delayedacktypes.Params) | ||
| } |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| package v3_test | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "math/big" | ||
| "testing" | ||
| "time" | ||
|
|
||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types" | ||
| app "github.com/dymensionxyz/dymension/v3/app" | ||
| "github.com/dymensionxyz/dymension/v3/app/apptesting" | ||
| incentivestypes "github.com/osmosis-labs/osmosis/v15/x/incentives/types" | ||
| "github.com/stretchr/testify/suite" | ||
| abci "github.com/tendermint/tendermint/abci/types" | ||
| tmproto "github.com/tendermint/tendermint/proto/tendermint/types" | ||
| ) | ||
|
|
||
| // UpgradeTestSuite defines the structure for the upgrade test suite | ||
| type UpgradeTestSuite struct { | ||
| suite.Suite | ||
| Ctx sdk.Context | ||
| App *app.App | ||
| } | ||
|
|
||
| // SetupTest initializes the necessary items for each test | ||
| func (s *UpgradeTestSuite) SetupTest(t *testing.T) { | ||
| s.App = apptesting.Setup(t, false) | ||
| s.Ctx = s.App.BaseApp.NewContext(false, tmproto.Header{Height: 1, ChainID: "dymension_100-1", Time: time.Now().UTC()}) | ||
| } | ||
|
|
||
| // TestUpgradeTestSuite runs the suite of tests for the upgrade handler | ||
| func TestUpgradeTestSuite(t *testing.T) { | ||
| suite.Run(t, new(UpgradeTestSuite)) | ||
| } | ||
|
|
||
| var ( | ||
| DYM = sdk.NewIntFromBigInt(new(big.Int).Exp(big.NewInt(10), big.NewInt(18), nil)) | ||
|
|
||
| // CreateGaugeFee is the fee required to create a new gauge. | ||
| expectCreateGaugeFee = DYM.Mul(sdk.NewInt(10)) | ||
| // AddToGagugeFee is the fee required to add to gauge. | ||
| expectAddToGaugeFee = sdk.ZeroInt() | ||
| ) | ||
|
|
||
| const ( | ||
| dummyUpgradeHeight = 5 | ||
| dummyEndBlockHeight = 10 | ||
| expectRollappsEnabled = false | ||
| expectDisputePeriodInBlocks = 120960 | ||
| expectMinBond = "1000000000000000000000" | ||
| ) | ||
|
|
||
| // TestUpgrade is a method of UpgradeTestSuite to test the upgrade process. | ||
| func (s *UpgradeTestSuite) TestUpgrade() { | ||
| testCases := []struct { | ||
| msg string | ||
| upgrade func() | ||
| postUpgrade func() error | ||
| expPass bool | ||
| }{ | ||
| { | ||
| "Test that upgrade does not panic and sets correct parameters", | ||
|
|
||
| func() { | ||
| // Run upgrade | ||
| s.Ctx = s.Ctx.WithBlockHeight(dummyUpgradeHeight - 1) | ||
| plan := upgradetypes.Plan{Name: "v3", Height: dummyUpgradeHeight} | ||
| err := s.App.UpgradeKeeper.ScheduleUpgrade(s.Ctx, plan) | ||
| s.Require().NoError(err) | ||
| _, exists := s.App.UpgradeKeeper.GetUpgradePlan(s.Ctx) | ||
| s.Require().True(exists) | ||
|
|
||
| s.Ctx = s.Ctx.WithBlockHeight(dummyUpgradeHeight) | ||
| // simulate the upgrade process not panic. | ||
| s.Require().NotPanics(func() { | ||
| // simulate the upgrade process. | ||
| s.App.BeginBlocker(s.Ctx, abci.RequestBeginBlock{}) | ||
| }) | ||
| }, | ||
| func() error { | ||
| // Post-update validation to ensure parameters are correctly set | ||
|
|
||
| // Check Rollapp parameters | ||
| rollappParams := s.App.RollappKeeper.GetParams(s.Ctx) | ||
| if rollappParams.RollappsEnabled != expectRollappsEnabled || rollappParams.DisputePeriodInBlocks != expectDisputePeriodInBlocks { | ||
| return fmt.Errorf("rollapp parameters not set correctly") | ||
| } | ||
|
|
||
| // Check Sequencer parameters | ||
| seqParams := s.App.SequencerKeeper.GetParams(s.Ctx) | ||
| if seqParams.MinBond.Amount.String() != expectMinBond { | ||
| return fmt.Errorf("sequencer parameters not set correctly") | ||
| } | ||
|
|
||
| // Check Incentives parameters | ||
| if !incentivestypes.CreateGaugeFee.Equal(expectCreateGaugeFee) || !incentivestypes.AddToGaugeFee.Equal(expectAddToGaugeFee) { | ||
| return fmt.Errorf("incentives parameters not set correctly") | ||
| } | ||
|
|
||
| return nil | ||
| }, | ||
| true, | ||
| }, | ||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| s.Run(fmt.Sprintf("Case %s", tc.msg), func() { | ||
| s.SetupTest(s.T()) // Reset for each case | ||
|
|
||
| tc.upgrade() | ||
| err := tc.postUpgrade() | ||
| if tc.expPass { | ||
| s.Require().NoError(err) | ||
| } else { | ||
| s.Require().Error(err) | ||
| } | ||
| }) | ||
| } | ||
| } |
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
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
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
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
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