feat: twap key refactor #7472
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
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,104 @@ | ||
| package v24_test | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/suite" | ||
|
|
||
| upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types" | ||
|
|
||
| abci "github.com/cometbft/cometbft/abci/types" | ||
|
|
||
| "github.com/osmosis-labs/osmosis/osmomath" | ||
| "github.com/osmosis-labs/osmosis/osmoutils" | ||
| "github.com/osmosis-labs/osmosis/v23/app/apptesting" | ||
|
|
||
| "github.com/osmosis-labs/osmosis/v23/x/twap/types" | ||
| twaptypes "github.com/osmosis-labs/osmosis/v23/x/twap/types" | ||
| ) | ||
|
|
||
| const ( | ||
| v24UpgradeHeight = int64(10) | ||
| HistoricalTWAPTimeIndexPrefix = "historical_time_index" | ||
| KeySeparator = "|" | ||
| ) | ||
|
|
||
| type UpgradeTestSuite struct { | ||
| apptesting.KeeperTestHelper | ||
| } | ||
|
|
||
| func TestUpgradeTestSuite(t *testing.T) { | ||
| suite.Run(t, new(UpgradeTestSuite)) | ||
| } | ||
|
|
||
| func (s *UpgradeTestSuite) TestUpgrade() { | ||
|
|
||
| s.Setup() | ||
|
|
||
| // Manually set up TWAP records indexed by both pool ID and time. | ||
| twapStoreKey := s.App.GetKey(twaptypes.ModuleName) | ||
| store := s.Ctx.KVStore(twapStoreKey) | ||
| twap := twaptypes.TwapRecord{ | ||
| PoolId: 1, | ||
| Asset0Denom: "foo", | ||
| Asset1Denom: "bar", | ||
| Height: 1, | ||
| Time: time.Date(2023, 0o2, 1, 0, 0, 0, 0, time.UTC), | ||
| P0LastSpotPrice: osmomath.OneDec(), | ||
| P1LastSpotPrice: osmomath.OneDec(), | ||
| P0ArithmeticTwapAccumulator: osmomath.ZeroDec(), | ||
| P1ArithmeticTwapAccumulator: osmomath.ZeroDec(), | ||
| GeometricTwapAccumulator: osmomath.ZeroDec(), | ||
| LastErrorTime: time.Time{}, // no previous error | ||
| } | ||
| poolIndexKey := types.FormatHistoricalPoolIndexTWAPKey(twap.PoolId, twap.Asset0Denom, twap.Asset1Denom, twap.Time) | ||
| osmoutils.MustSet(store, poolIndexKey, &twap) | ||
|
|
||
| // The time index key is a bit manual since we removed the old code that did this programmatically. | ||
| var buffer bytes.Buffer | ||
| timeS := osmoutils.FormatTimeString(twap.Time) | ||
| fmt.Fprintf(&buffer, "%s%d%s%s%s%s%s%s", HistoricalTWAPTimeIndexPrefix, twap.PoolId, KeySeparator, twap.Asset0Denom, KeySeparator, twap.Asset1Denom, KeySeparator, timeS) | ||
| timeIndexKey := buffer.Bytes() | ||
| osmoutils.MustSet(store, timeIndexKey, &twap) | ||
|
|
||
| // TWAP records indexed by time should exist | ||
| twapRecords, err := osmoutils.GatherValuesFromStorePrefix(store, []byte(HistoricalTWAPTimeIndexPrefix), types.ParseTwapFromBz) | ||
| s.Require().NoError(err) | ||
| s.Require().Len(twapRecords, 1) | ||
| s.Require().Equal(twap, twapRecords[0]) | ||
|
|
||
| // TWAP records indexed by pool ID should exist. | ||
| twapRecords, err = s.App.TwapKeeper.GetAllHistoricalPoolIndexedTWAPsForPoolId(s.Ctx, twap.PoolId) | ||
| s.Require().NoError(err) | ||
| s.Require().Len(twapRecords, 1) | ||
| s.Require().Equal(twap, twapRecords[0]) | ||
|
|
||
| dummyUpgrade(s) | ||
| s.Require().NotPanics(func() { | ||
| s.App.BeginBlocker(s.Ctx, abci.RequestBeginBlock{}) | ||
| }) | ||
|
|
||
| // TWAP records indexed by time should be completely removed. | ||
| twapRecords, err = osmoutils.GatherValuesFromStorePrefix(store, []byte(HistoricalTWAPTimeIndexPrefix), types.ParseTwapFromBz) | ||
| s.Require().NoError(err) | ||
| s.Require().Len(twapRecords, 0) | ||
|
|
||
| // TWAP records indexed by pool ID should be untouched. | ||
| twapRecords, err = s.App.TwapKeeper.GetAllHistoricalPoolIndexedTWAPsForPoolId(s.Ctx, twap.PoolId) | ||
| s.Require().NoError(err) | ||
| s.Require().Len(twapRecords, 1) | ||
| s.Require().Equal(twap, twapRecords[0]) | ||
| } | ||
|
|
||
| func dummyUpgrade(s *UpgradeTestSuite) { | ||
| s.Ctx = s.Ctx.WithBlockHeight(v24UpgradeHeight - 1) | ||
| plan := upgradetypes.Plan{Name: "v24", Height: v24UpgradeHeight} | ||
| 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(v24UpgradeHeight) | ||
| } | ||
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
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
Oops, something went wrong.
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.
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.
Drive by change, this folder no longer lives in Osmosis repo