forked from osmosis-labs/osmosis
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: twap key refactor (osmosis-labs#7472)
* twap key refactor * [create-pull-request] automated change * use rc1 of v23 * use alpine * Update config.go * delete all time indexed keys in twap store * add changelog * respect prune limit * add upgrade test for pruning old time indexed keys * comment clean up * Update CHANGELOG.md Co-authored-by: Dev Ojha <[email protected]> * remove outdated comment * update readme * readme * add key sep to end --------- Co-authored-by: Dev Ojha <[email protected]>
- Loading branch information
1 parent
5aedf82
commit 49cd790
Showing
18 changed files
with
379 additions
and
227 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
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.