Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: add PokeTokenWeights to Pool interface #1232

Merged
merged 8 commits into from
Apr 12, 2022
Merged

refactor: add PokeTokenWeights to Pool interface #1232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6e1a6b8
updates
alexanderbez Apr 11, 2022
bb90a73
updates
alexanderbez Apr 11, 2022
f6ddef8
updates
alexanderbez Apr 11, 2022
0ba70e8
updates
alexanderbez Apr 11, 2022
374ddc1
updates
alexanderbez Apr 11, 2022
8e83178
updates
alexanderbez Apr 11, 2022
d559eca
updates
alexanderbez Apr 11, 2022
a91c0ab
updates
alexanderbez Apr 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions app/apptesting/test_suite.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,21 @@ import (

"github.com/cosmos/cosmos-sdk/crypto/keys/secp256k1"
"github.com/cosmos/cosmos-sdk/simapp"

abci "github.com/tendermint/tendermint/abci/types"
tmproto "github.com/tendermint/tendermint/proto/tendermint/types"

sdk "github.com/cosmos/cosmos-sdk/types"
distrtypes "github.com/cosmos/cosmos-sdk/x/distribution/types"
slashingtypes "github.com/cosmos/cosmos-sdk/x/slashing/types"
"github.com/cosmos/cosmos-sdk/x/staking/teststaking"
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
"github.com/stretchr/testify/suite"
abci "github.com/tendermint/tendermint/abci/types"
"github.com/tendermint/tendermint/crypto/ed25519"
tmproto "github.com/tendermint/tendermint/proto/tendermint/types"

"github.com/osmosis-labs/osmosis/v7/app"
"github.com/osmosis-labs/osmosis/v7/x/gamm/pool-models/balancer"
gammtypes "github.com/osmosis-labs/osmosis/v7/x/gamm/types"
lockupkeeper "github.com/osmosis-labs/osmosis/v7/x/lockup/keeper"
lockuptypes "github.com/osmosis-labs/osmosis/v7/x/lockup/types"

"github.com/stretchr/testify/suite"
"github.com/tendermint/tendermint/crypto/ed25519"
)

type KeeperTestHelper struct {
Expand Down Expand Up @@ -179,7 +176,7 @@ func (keeperTestHelper *KeeperTestHelper) SetupGammPoolsWithBondDenomMultiplier(
poolId, err := keeperTestHelper.App.GAMMKeeper.CreatePool(keeperTestHelper.Ctx, msg)
keeperTestHelper.Require().NoError(err)

pool, err := keeperTestHelper.App.GAMMKeeper.GetPool(keeperTestHelper.Ctx, poolId)
pool, err := keeperTestHelper.App.GAMMKeeper.GetPoolAndPoke(keeperTestHelper.Ctx, poolId)
keeperTestHelper.Require().NoError(err)

pools = append(pools, pool)
Expand Down
2 changes: 1 addition & 1 deletion app/upgrades/v5/whitelist_feetokens.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ func InitialWhitelistedFeetokens(ctx sdk.Context, gamm *gammkeeper.Keeper) []typ
panic(err)
}

pool, poolExistsErr := gamm.GetPool(ctx, poolId)
pool, poolExistsErr := gamm.GetPoolAndPoke(ctx, poolId)
_ = pool
if poolExistsErr != nil {
continue
Expand Down
4 changes: 2 additions & 2 deletions app/wasm/queries.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ func NewQueryPlugin(
}

func (qp QueryPlugin) GetPoolState(ctx sdk.Context, poolID uint64) (*wasmbindings.PoolAssets, error) {
poolData, err := qp.gammKeeper.GetPool(ctx, poolID)
poolData, err := qp.gammKeeper.GetPoolAndPoke(ctx, poolID)
if err != nil {
return nil, sdkerrors.Wrap(err, "gamm get pool")
}
Expand All @@ -50,7 +50,7 @@ func (qp QueryPlugin) GetSpotPrice(ctx sdk.Context, spotPrice *wasmbindings.Spot
return nil, sdkerrors.Wrap(err, "gamm get spot price")
}
if withSwapFee {
poolData, err := qp.gammKeeper.GetPool(ctx, poolId)
poolData, err := qp.gammKeeper.GetPoolAndPoke(ctx, poolId)
if err != nil {
return nil, sdkerrors.Wrap(err, "gamm get pool")
}
Expand Down
3 changes: 2 additions & 1 deletion x/gamm/genesis.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package gamm
import (
codectypes "github.com/cosmos/cosmos-sdk/codec/types"
sdk "github.com/cosmos/cosmos-sdk/types"

"github.com/osmosis-labs/osmosis/v7/x/gamm/keeper"
"github.com/osmosis-labs/osmosis/v7/x/gamm/types"
)
Expand Down Expand Up @@ -36,7 +37,7 @@ func InitGenesis(ctx sdk.Context, k keeper.Keeper, genState types.GenesisState,

// ExportGenesis returns the capability module's exported genesis.
func ExportGenesis(ctx sdk.Context, k keeper.Keeper) *types.GenesisState {
pools, err := k.GetPools(ctx)
pools, err := k.GetPoolsAndPoke(ctx)
if err != nil {
panic(err)
}
Expand Down
13 changes: 7 additions & 6 deletions x/gamm/genesis_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@ import (
codectypes "github.com/cosmos/cosmos-sdk/codec/types"
"github.com/cosmos/cosmos-sdk/simapp"
sdk "github.com/cosmos/cosmos-sdk/types"
osmoapp "github.com/osmosis-labs/osmosis/v7/app"
"github.com/osmosis-labs/osmosis/v7/x/gamm"
"github.com/osmosis-labs/osmosis/v7/x/gamm/pool-models/balancer"
"github.com/osmosis-labs/osmosis/v7/x/gamm/types"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/tendermint/tendermint/crypto/ed25519"
tmproto "github.com/tendermint/tendermint/proto/tendermint/types"

osmoapp "github.com/osmosis-labs/osmosis/v7/app"
"github.com/osmosis-labs/osmosis/v7/x/gamm"
"github.com/osmosis-labs/osmosis/v7/x/gamm/pool-models/balancer"
"github.com/osmosis-labs/osmosis/v7/x/gamm/types"
)

func TestGammInitGenesis(t *testing.T) {
Expand Down Expand Up @@ -47,7 +48,7 @@ func TestGammInitGenesis(t *testing.T) {
}, app.AppCodec())

require.Equal(t, app.GAMMKeeper.GetNextPoolNumberAndIncrement(ctx), uint64(2))
poolStored, err := app.GAMMKeeper.GetPool(ctx, 1)
poolStored, err := app.GAMMKeeper.GetPoolAndPoke(ctx, 1)
require.NoError(t, err)
require.Equal(t, balancerPool.GetId(), poolStored.GetId())
require.Equal(t, balancerPool.GetAddress(), poolStored.GetAddress())
Expand All @@ -58,7 +59,7 @@ func TestGammInitGenesis(t *testing.T) {
// require.Equal(t, balancerPool.GetAllPoolAssets(), poolStored.GetAllPoolAssets())
require.Equal(t, balancerPool.String(), poolStored.String())

_, err = app.GAMMKeeper.GetPool(ctx, 2)
_, err = app.GAMMKeeper.GetPoolAndPoke(ctx, 2)
require.Error(t, err)

liquidity := app.GAMMKeeper.GetTotalLiquidity(ctx)
Expand Down
14 changes: 7 additions & 7 deletions x/gamm/keeper/grpc_query.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ func (q Querier) Pool(

sdkCtx := sdk.UnwrapSDKContext(ctx)

pool, err := q.Keeper.GetPool(sdkCtx, req.PoolId)
pool, err := q.Keeper.GetPoolAndPoke(sdkCtx, req.PoolId)
if err != nil {
return nil, status.Error(codes.Internal, err.Error())
}
Expand Down Expand Up @@ -85,8 +85,8 @@ func (q Querier) Pools(
return err
}

// Use GetPool function because it runs PokeWeights
poolI, err = q.Keeper.GetPool(sdkCtx, poolI.GetId())
// Use GetPoolAndPoke function because it runs PokeWeights
poolI, err = q.Keeper.GetPoolAndPoke(sdkCtx, poolI.GetId())
if err != nil {
return err
}
Expand Down Expand Up @@ -137,7 +137,7 @@ func (q Querier) PoolParams(ctx context.Context, req *types.QueryPoolParamsReque

sdkCtx := sdk.UnwrapSDKContext(ctx)

pool, err := q.Keeper.GetPool(sdkCtx, req.PoolId)
pool, err := q.Keeper.GetPoolAndPoke(sdkCtx, req.PoolId)
if err != nil {
return nil, status.Error(codes.Internal, err.Error())
}
Expand Down Expand Up @@ -166,7 +166,7 @@ func (q Querier) TotalPoolLiquidity(ctx context.Context, req *types.QueryTotalPo

sdkCtx := sdk.UnwrapSDKContext(ctx)

pool, err := q.Keeper.GetPool(sdkCtx, req.PoolId)
pool, err := q.Keeper.GetPoolAndPoke(sdkCtx, req.PoolId)
if err != nil {
return nil, status.Error(codes.Internal, err.Error())
}
Expand All @@ -183,7 +183,7 @@ func (q Querier) TotalShares(ctx context.Context, req *types.QueryTotalSharesReq

sdkCtx := sdk.UnwrapSDKContext(ctx)

pool, err := q.Keeper.GetPool(sdkCtx, req.PoolId)
pool, err := q.Keeper.GetPoolAndPoke(sdkCtx, req.PoolId)
if err != nil {
return nil, status.Error(codes.Internal, err.Error())
}
Expand All @@ -210,7 +210,7 @@ func (q Querier) SpotPrice(ctx context.Context, req *types.QuerySpotPriceRequest

sdkCtx := sdk.UnwrapSDKContext(ctx)

pool, err := q.Keeper.GetPool(sdkCtx, req.PoolId)
pool, err := q.Keeper.GetPoolAndPoke(sdkCtx, req.PoolId)
if err != nil {
return nil, status.Errorf(codes.Internal, "failed to get pool by ID: %s", err)
}
Expand Down
2 changes: 1 addition & 1 deletion x/gamm/keeper/invariants.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ func AllInvariants(keeper Keeper, bk types.BankKeeper) sdk.Invariant {
// pool assets
func PoolAccountInvariant(keeper Keeper, bk types.BankKeeper) sdk.Invariant {
return func(ctx sdk.Context) (string, bool) {
pools, err := keeper.GetPools(ctx)
pools, err := keeper.GetPoolsAndPoke(ctx)
if err != nil {
return sdk.FormatInvariant(types.ModuleName, poolBalanceInvariantName,
"\tgamm pool retrieval failed"), true
Expand Down
11 changes: 7 additions & 4 deletions x/gamm/keeper/multihop_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ func (suite *KeeperTestSuite) TestBalancerPoolSimpleMultihopSwapExactAmountIn()
if i != 0 {
tokenInDenom = test.param.routes[i-1].TokenOutDenom
}
pool, err := keeper.GetPool(suite.ctx, route.PoolId)
pool, err := keeper.GetPoolAndPoke(suite.ctx, route.PoolId)
suite.NoError(err, "test: %v", test.name)

sp, err := pool.SpotPrice(suite.ctx, tokenInDenom, route.TokenOutDenom)
Expand All @@ -80,7 +80,8 @@ func (suite *KeeperTestSuite) TestBalancerPoolSimpleMultihopSwapExactAmountIn()
if i != 0 {
tokenInDenom = test.param.routes[i-1].TokenOutDenom
}
pool, err := keeper.GetPool(suite.ctx, route.PoolId)

pool, err := keeper.GetPoolAndPoke(suite.ctx, route.PoolId)
suite.NoError(err, "test: %v", test.name)

sp, err := pool.SpotPrice(suite.ctx, tokenInDenom, route.TokenOutDenom)
Expand Down Expand Up @@ -151,7 +152,8 @@ func (suite *KeeperTestSuite) TestBalancerPoolSimpleMultihopSwapExactAmountOut()
if i != len(test.param.routes)-1 {
tokenOutDenom = test.param.routes[i+1].TokenInDenom
}
pool, err := keeper.GetPool(suite.ctx, route.PoolId)

pool, err := keeper.GetPoolAndPoke(suite.ctx, route.PoolId)
suite.NoError(err, "test: %v", test.name)

sp, err := pool.SpotPrice(suite.ctx, route.TokenInDenom, tokenOutDenom)
Expand All @@ -172,7 +174,8 @@ func (suite *KeeperTestSuite) TestBalancerPoolSimpleMultihopSwapExactAmountOut()
if i != len(test.param.routes)-1 {
tokenOutDenom = test.param.routes[i+1].TokenInDenom
}
pool, err := keeper.GetPool(suite.ctx, route.PoolId)

pool, err := keeper.GetPoolAndPoke(suite.ctx, route.PoolId)
suite.NoError(err, "test: %v", test.name)

sp, err := pool.SpotPrice(suite.ctx, route.TokenInDenom, tokenOutDenom)
Expand Down
15 changes: 8 additions & 7 deletions x/gamm/keeper/pool.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ func (k Keeper) UnmarshalPool(bz []byte) (types.PoolI, error) {
return acc, k.cdc.UnmarshalInterface(bz, &acc)
}

func (k Keeper) GetPool(ctx sdk.Context, poolId uint64) (types.PoolI, error) {
// GetPoolAndPoke returns a PoolI based on it's identifier if one exists. Prior
// to returning the pool, the weights of the pool are updated via PokePool.
func (k Keeper) GetPoolAndPoke(ctx sdk.Context, poolId uint64) (types.PoolI, error) {
store := ctx.KVStore(k.storeKey)
poolKey := types.GetKeyPrefixPools(poolId)
if !store.Has(poolKey) {
Expand All @@ -34,14 +36,14 @@ func (k Keeper) GetPool(ctx sdk.Context, poolId uint64) (types.PoolI, error) {
return nil, err
}

// pool.PokeTokenWeights(ctx.BlockTime())
pool.PokePool(ctx.BlockTime())

return pool, nil
}

// Get pool, and check if the pool is active / allowed to be swapped against
func (k Keeper) getPoolForSwap(ctx sdk.Context, poolId uint64) (types.PoolI, error) {
pool, err := k.GetPool(ctx, poolId)
pool, err := k.GetPoolAndPoke(ctx, poolId)
if err != nil {
return &balancer.Pool{}, err
}
Expand All @@ -57,7 +59,7 @@ func (k Keeper) iterator(ctx sdk.Context, prefix []byte) sdk.Iterator {
return sdk.KVStorePrefixIterator(store, prefix)
}

func (k Keeper) GetPools(ctx sdk.Context) (res []types.PoolI, err error) {
func (k Keeper) GetPoolsAndPoke(ctx sdk.Context) (res []types.PoolI, err error) {
iter := k.iterator(ctx, types.KeyPrefixPools)
defer iter.Close()

Expand All @@ -69,12 +71,11 @@ func (k Keeper) GetPools(ctx sdk.Context) (res []types.PoolI, err error) {
return nil, err
}

// pool.PokeTokenWeights(ctx.BlockTime())

pool.PokePool(ctx.BlockTime())
res = append(res, pool)
}

return
return res, nil
}

func (k Keeper) SetPool(ctx sdk.Context, pool types.PoolI) error {
Expand Down
7 changes: 4 additions & 3 deletions x/gamm/keeper/pool_service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ func (k Keeper) CalculateSpotPrice(
baseAssetDenom string,
quoteAssetDenom string,
) (sdk.Dec, error) {
pool, err := k.GetPool(ctx, poolID)
pool, err := k.GetPoolAndPoke(ctx, poolID)
if err != nil {
return sdk.Dec{}, err
}

return pool.SpotPrice(ctx, baseAssetDenom, quoteAssetDenom)
}

Expand Down Expand Up @@ -182,7 +183,7 @@ func (k Keeper) JoinPoolNoSwap(
shareOutAmount sdk.Int,
tokenInMaxs sdk.Coins,
) (err error) {
pool, err := k.GetPool(ctx, poolId)
pool, err := k.GetPoolAndPoke(ctx, poolId)
if err != nil {
return err
}
Expand Down Expand Up @@ -330,7 +331,7 @@ func (k Keeper) ExitPool(
shareInAmount sdk.Int,
tokenOutMins sdk.Coins,
) (exitCoins sdk.Coins, err error) {
pool, err := k.GetPool(ctx, poolId)
pool, err := k.GetPoolAndPoke(ctx, poolId)
if err != nil {
return sdk.Coins{}, err
}
Expand Down
6 changes: 3 additions & 3 deletions x/gamm/keeper/pool_service_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ func (suite *KeeperTestSuite) TestCreateBalancerPool() {
poolId, err := keeper.CreatePool(suite.ctx, msg)
suite.Require().NoError(err)

pool, err := keeper.GetPool(suite.ctx, poolId)
pool, err := keeper.GetPoolAndPoke(suite.ctx, poolId)
suite.Require().NoError(err)
suite.Require().Equal(types.InitPoolSharesSupply.String(), pool.GetTotalShares().String(),
fmt.Sprintf("share token should be minted as %s initially", types.InitPoolSharesSupply.String()),
Expand Down Expand Up @@ -220,7 +220,7 @@ func (suite *KeeperTestSuite) TestCreateBalancerPool() {
}, defaultPoolAssets, defaultFutureGovernor)
_, err := keeper.CreatePool(suite.ctx, msg)
suite.Require().NoError(err)
pools, err := keeper.GetPools(suite.ctx)
pools, err := keeper.GetPoolsAndPoke(suite.ctx)
suite.Require().Len(pools, 1)
suite.Require().NoError(err)
},
Expand All @@ -236,7 +236,7 @@ func (suite *KeeperTestSuite) TestCreateBalancerPool() {
}, defaultPoolAssets, defaultFutureGovernor)
_, err := keeper.CreatePool(suite.ctx, msg)
suite.Require().NoError(err)
pools, err := keeper.GetPools(suite.ctx)
pools, err := keeper.GetPoolsAndPoke(suite.ctx)
suite.Require().Len(pools, 1)
suite.Require().NoError(err)
},
Expand Down
3 changes: 2 additions & 1 deletion x/gamm/pool-models/balancer/amm_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package balancer_test

import (
sdk "github.com/cosmos/cosmos-sdk/types"

"github.com/osmosis-labs/osmosis/v7/x/gamm/pool-models/balancer"
)

Expand Down Expand Up @@ -56,7 +57,7 @@ func (suite *KeeperTestSuite) TestBalancerSpotPrice() {
tc.quoteDenomPoolInput,
)

pool, err := suite.App.GAMMKeeper.GetPool(suite.Ctx, poolId)
pool, err := suite.App.GAMMKeeper.GetPoolAndPoke(suite.Ctx, poolId)
suite.Require().NoError(err, "test: %s", tc.name)
balancerPool, isPool := pool.(*balancer.Pool)
suite.Require().True(isPool, "test: %s", tc.name)
Expand Down
Loading