-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move migrateTickLiquidityPrices and migrateInactiveTranchePrices to a…
…nother (v4) consensus migration to simplify testnet migration
- Loading branch information
1 parent
b42c0d7
commit 56b0ff7
Showing
6 changed files
with
195 additions
and
149 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,112 @@ | ||
| package v4 | ||
|
|
||
| import ( | ||
| errorsmod "cosmossdk.io/errors" | ||
| "cosmossdk.io/store/prefix" | ||
| storetypes "cosmossdk.io/store/types" | ||
| "github.com/cosmos/cosmos-sdk/codec" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
|
|
||
| "github.com/neutron-org/neutron/v4/x/dex/types" | ||
| ) | ||
|
|
||
| // MigrateStore performs in-place store migrations. | ||
| // The migration adds new dex params -- GoodTilPurgeAllowance & MaxJITsPerBlock// for handling JIT orders. | ||
| func MigrateStore(ctx sdk.Context, cdc codec.BinaryCodec, storeKey storetypes.StoreKey) error { | ||
| if err := migrateTickLiquidityPrices(ctx, cdc, storeKey); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if err := migrateInactiveTranchePrices(ctx, cdc, storeKey); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| type migrationUpdate struct { | ||
| key []byte | ||
| val []byte | ||
| } | ||
|
|
||
| func migrateTickLiquidityPrices(ctx sdk.Context, cdc codec.BinaryCodec, storeKey storetypes.StoreKey) error { | ||
| // Due to change in precision of PrecDec between v2 and v3 we need to recompute all PrecDecs in the kvstore | ||
| ctx.Logger().Info("Migrating TickLiquidity Prices...") | ||
|
|
||
| // Iterate through all tickLiquidity | ||
| store := prefix.NewStore(ctx.KVStore(storeKey), types.KeyPrefix(types.TickLiquidityKeyPrefix)) | ||
| iterator := storetypes.KVStorePrefixIterator(store, []byte{}) | ||
| ticksToUpdate := make([]migrationUpdate, 0) | ||
|
|
||
| for ; iterator.Valid(); iterator.Next() { | ||
| var tickLiq types.TickLiquidity | ||
| var updatedTickLiq types.TickLiquidity | ||
| cdc.MustUnmarshal(iterator.Value(), &tickLiq) | ||
| // Recalculate all prices | ||
| switch liquidity := tickLiq.Liquidity.(type) { | ||
| case *types.TickLiquidity_LimitOrderTranche: | ||
| liquidity.LimitOrderTranche.PriceTakerToMaker = types.MustCalcPrice(liquidity.LimitOrderTranche.Key.TickIndexTakerToMaker) | ||
| updatedTickLiq = types.TickLiquidity{Liquidity: liquidity} | ||
| case *types.TickLiquidity_PoolReserves: | ||
| poolReservesKey := liquidity.PoolReserves.Key | ||
| liquidity.PoolReserves.PriceTakerToMaker = types.MustCalcPrice(poolReservesKey.TickIndexTakerToMaker) | ||
| liquidity.PoolReserves.PriceOppositeTakerToMaker = poolReservesKey.Counterpart().MustPriceTakerToMaker() | ||
| updatedTickLiq = types.TickLiquidity{Liquidity: liquidity} | ||
|
|
||
| default: | ||
| panic("Tick does not contain valid liqudityType") | ||
| } | ||
|
|
||
| bz := cdc.MustMarshal(&updatedTickLiq) | ||
| ticksToUpdate = append(ticksToUpdate, migrationUpdate{key: iterator.Key(), val: bz}) | ||
|
|
||
| } | ||
|
|
||
| err := iterator.Close() | ||
| if err != nil { | ||
| return errorsmod.Wrap(err, "iterator failed to close during migration") | ||
| } | ||
|
|
||
| // Store the updated TickLiquidity | ||
| for _, v := range ticksToUpdate { | ||
| store.Set(v.key, v.val) | ||
| } | ||
|
|
||
| ctx.Logger().Info("Finished migrating TickLiquidity Prices...") | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func migrateInactiveTranchePrices(ctx sdk.Context, cdc codec.BinaryCodec, storeKey storetypes.StoreKey) error { | ||
| // Due to change in precision of PrecDec between v2 and v3 we need to recompute all PrecDecs in the kvstore | ||
| ctx.Logger().Info("Migrating InactiveLimitOrderTranche Prices...") | ||
|
|
||
| // Iterate through all InactiveTranches | ||
| store := prefix.NewStore(ctx.KVStore(storeKey), types.KeyPrefix(types.InactiveLimitOrderTrancheKeyPrefix)) | ||
| iterator := storetypes.KVStorePrefixIterator(store, []byte{}) | ||
| ticksToUpdate := make([]migrationUpdate, 0) | ||
|
|
||
| for ; iterator.Valid(); iterator.Next() { | ||
| var tranche types.LimitOrderTranche | ||
| cdc.MustUnmarshal(iterator.Value(), &tranche) | ||
| // Recalculate price | ||
| tranche.PriceTakerToMaker = types.MustCalcPrice(tranche.Key.TickIndexTakerToMaker) | ||
|
|
||
| bz := cdc.MustMarshal(&tranche) | ||
| ticksToUpdate = append(ticksToUpdate, migrationUpdate{key: iterator.Key(), val: bz}) | ||
| } | ||
|
|
||
| err := iterator.Close() | ||
| if err != nil { | ||
| return errorsmod.Wrap(err, "iterator failed to close during migration") | ||
| } | ||
|
|
||
| // Store the updated InactiveTranches | ||
| for _, v := range ticksToUpdate { | ||
| store.Set(v.key, v.val) | ||
| } | ||
|
|
||
| ctx.Logger().Info("Finished migrating InactiveLimitOrderTranche Prices...") | ||
|
|
||
| return nil | ||
| } |
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,73 @@ | ||
| package v4_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/suite" | ||
|
|
||
| "github.com/neutron-org/neutron/v4/testutil" | ||
| "github.com/neutron-org/neutron/v4/utils/math" | ||
| v4 "github.com/neutron-org/neutron/v4/x/dex/migrations/v4" | ||
| "github.com/neutron-org/neutron/v4/x/dex/types" | ||
| ) | ||
|
|
||
| type V4DexMigrationTestSuite struct { | ||
| testutil.IBCConnectionTestSuite | ||
| } | ||
|
|
||
| func TestKeeperTestSuite(t *testing.T) { | ||
| suite.Run(t, new(V4DexMigrationTestSuite)) | ||
| } | ||
|
|
||
| func (suite *V4DexMigrationTestSuite) TestPriceUpdates() { | ||
| var ( | ||
| app = suite.GetNeutronZoneApp(suite.ChainA) | ||
| storeKey = app.GetKey(types.StoreKey) | ||
| ctx = suite.ChainA.GetContext() | ||
| cdc = app.AppCodec() | ||
| ) | ||
|
|
||
| // Write tranche with incorrect price | ||
| trancheKey := &types.LimitOrderTrancheKey{ | ||
| TradePairId: types.MustNewTradePairID("TokenA", "TokenB"), | ||
| TickIndexTakerToMaker: -50, | ||
| TrancheKey: "123", | ||
| } | ||
| tranche := &types.LimitOrderTranche{ | ||
| Key: trancheKey, | ||
| PriceTakerToMaker: math.ZeroPrecDec(), | ||
| } | ||
| app.DexKeeper.SetLimitOrderTranche(ctx, tranche) | ||
|
|
||
| // also create inactive tranche | ||
| app.DexKeeper.SetInactiveLimitOrderTranche(ctx, tranche) | ||
|
|
||
| // Write poolReserves with incorrect prices | ||
| poolKey := &types.PoolReservesKey{ | ||
| TradePairId: types.MustNewTradePairID("TokenA", "TokenB"), | ||
| TickIndexTakerToMaker: 60000, | ||
| Fee: 1, | ||
| } | ||
| poolReserves := &types.PoolReserves{ | ||
| Key: poolKey, | ||
| PriceTakerToMaker: math.ZeroPrecDec(), | ||
| PriceOppositeTakerToMaker: math.ZeroPrecDec(), | ||
| } | ||
| app.DexKeeper.SetPoolReserves(ctx, poolReserves) | ||
|
|
||
| // Run migration | ||
| suite.NoError(v4.MigrateStore(ctx, cdc, storeKey)) | ||
|
|
||
| // Check LimitOrderTranche has correct price | ||
| newTranche := app.DexKeeper.GetLimitOrderTranche(ctx, trancheKey) | ||
| suite.True(newTranche.PriceTakerToMaker.Equal(math.MustNewPrecDecFromStr("1.005012269623051203500693815"))) | ||
|
|
||
| // check InactiveLimitOrderTranche has correct price | ||
| inactiveTranche, _ := app.DexKeeper.GetInactiveLimitOrderTranche(ctx, trancheKey) | ||
| suite.True(inactiveTranche.PriceTakerToMaker.Equal(math.MustNewPrecDecFromStr("1.005012269623051203500693815"))) | ||
|
|
||
| // Check PoolReserves has the correct prices | ||
| newPool, _ := app.DexKeeper.GetPoolReserves(ctx, poolKey) | ||
| suite.True(newPool.PriceTakerToMaker.Equal(math.MustNewPrecDecFromStr("0.002479495864288162666675923"))) | ||
| suite.True(newPool.PriceOppositeTakerToMaker.Equal(math.MustNewPrecDecFromStr("403.227141612124702272520931931"))) | ||
| } |
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