Add stableswap to pooltype, and pooltype query to stargate whitelist (#…

…3356)

* Add stableswap to pooltype, and pooltype query to stargate whitelist

* Add test / make test scaffolding for stableswap. Fix validate basic bug

* Changelog entry

CHANGELOG.md

@@ -45,7 +45,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Features
 
 * [#2788](https://github.com/osmosis-labs/osmosis/pull/2788) Add logarithm base 2 implementation.
-* [#2739](https://github.com/osmosis-labs/osmosis/pull/2739) Add pool type query
+* [#2739](https://github.com/osmosis-labs/osmosis/pull/2739),[#3356](https://github.com/osmosis-labs/osmosis/pull/3356) Add pool type query, and add it to stargate whitelist
 * [#2956](https://github.com/osmosis-labs/osmosis/issues/2956) Add queries for calculating amount of shares/tokens you get by providing X tokens/shares when entering/exiting a pool
 * [#3313](https://github.com/osmosis-labs/osmosis/pull/3313) Upgrade to IBC v3.4.0, allowing for IBC transfers with metadata.
 * [#3335](https://github.com/osmosis-labs/osmosis/pull/3335) Add v2 spot price queries

app/apptesting/gamm.go

@@ -5,6 +5,7 @@ import (
 
 	gammkeeper "github.com/osmosis-labs/osmosis/v12/x/gamm/keeper"
 	"github.com/osmosis-labs/osmosis/v12/x/gamm/pool-models/balancer"
+	"github.com/osmosis-labs/osmosis/v12/x/gamm/pool-models/stableswap"
 	gammtypes "github.com/osmosis-labs/osmosis/v12/x/gamm/types"
 )
 
@@ -32,6 +33,11 @@ var DefaultPoolAssets = []balancer.PoolAsset{
 		Token:  sdk.NewCoin("uosmo", sdk.NewInt(5000000)),
 	},
 }
+var DefaultStableswapLiquidity = sdk.NewCoins(
+	sdk.NewCoin("foo", sdk.NewInt(10000000)),
+	sdk.NewCoin("bar", sdk.NewInt(10000000)),
+	sdk.NewCoin("baz", sdk.NewInt(10000000)),
+)
 
 // PrepareBalancerPoolWithCoins returns a balancer pool
 // consisted of given coins with equal weight.
@@ -81,6 +87,21 @@ func (s *KeeperTestHelper) PrepareBalancerPool() uint64 {
 	return poolId
 }
 
+func (s *KeeperTestHelper) PrepareBasicStableswapPool() uint64 {
+	// Mint some assets to the account.
+	s.FundAcc(s.TestAccs[0], DefaultAcctFunds)
+
+	params := stableswap.PoolParams{
+		SwapFee: sdk.NewDec(0),
+		ExitFee: sdk.NewDec(0),
+	}
+
+	msg := stableswap.NewMsgCreateStableswapPool(s.TestAccs[0], params, DefaultStableswapLiquidity, []uint64{}, "")
+	poolId, err := s.App.GAMMKeeper.CreatePool(s.Ctx, msg)
+	s.NoError(err)
+	return poolId
+}
+
 // PrepareBalancerPoolWithPoolParams sets up a Balancer pool with poolParams.
 func (s *KeeperTestHelper) PrepareBalancerPoolWithPoolParams(poolParams balancer.PoolParams) uint64 {
 	// Mint some assets to the account.

wasmbinding/stargate_whitelist.go

@@ -80,6 +80,7 @@ func init() {
 	setWhitelistedQuery("/osmosis.gamm.v1beta1.Query/TotalPoolLiquidity", &gammtypes.QueryTotalPoolLiquidityResponse{})
 	setWhitelistedQuery("/osmosis.gamm.v1beta1.Query/TotalShares", &gammtypes.QueryTotalSharesResponse{})
 	setWhitelistedQuery("/osmosis.gamm.v1beta1.Query/SpotPrice", &gammtypes.QuerySpotPriceResponse{})
+	setWhitelistedQuery("/osmosis.gamm.v1beta1.Query/PoolType", &gammtypes.QueryPoolTypeResponse{})
 	setWhitelistedQuery("/osmosis.gamm.v2.Query/SpotPrice", &gammv2types.QuerySpotPriceResponse{})
 
 	// incentives

x/gamm/keeper/grpc_query_test.go

@@ -10,6 +10,7 @@ import (
 
 	"github.com/osmosis-labs/osmosis/v12/x/gamm/pool-models/balancer"
 	balancertypes "github.com/osmosis-labs/osmosis/v12/x/gamm/pool-models/balancer"
+	"github.com/osmosis-labs/osmosis/v12/x/gamm/pool-models/stableswap"
 	"github.com/osmosis-labs/osmosis/v12/x/gamm/types"
 	"github.com/osmosis-labs/osmosis/v12/x/gamm/v2types"
 )
@@ -416,15 +417,21 @@ func (suite *KeeperTestSuite) TestQueryPools() {
 }
 
 func (suite *KeeperTestSuite) TestPoolType() {
-	poolId := suite.PrepareBalancerPool()
+	poolIdBalancer := suite.PrepareBalancerPool()
+	poolIdStableswap := suite.PrepareBasicStableswapPool()
 
 	// error when querying invalid pool ID
-	_, err := suite.queryClient.PoolType(gocontext.Background(), &types.QueryPoolTypeRequest{PoolId: poolId + 1})
+	_, err := suite.queryClient.PoolType(gocontext.Background(), &types.QueryPoolTypeRequest{PoolId: poolIdStableswap + 1})
 	suite.Require().Error(err)
 
-	res, err := suite.queryClient.PoolType(gocontext.Background(), &types.QueryPoolTypeRequest{PoolId: poolId})
+	res, err := suite.queryClient.PoolType(gocontext.Background(), &types.QueryPoolTypeRequest{PoolId: poolIdBalancer})
+	suite.Require().NoError(err)
+	suite.Require().Equal(balancer.PoolTypeName, res.PoolType)
+
+	res, err = suite.queryClient.PoolType(gocontext.Background(),
+		&types.QueryPoolTypeRequest{PoolId: poolIdStableswap})
 	suite.Require().NoError(err)
-	suite.Require().Equal("Balancer", res.PoolType)
+	suite.Require().Equal(stableswap.PoolTypeName, res.PoolType)
 }
 
 func (suite *KeeperTestSuite) TestQueryNumPools1() {

x/gamm/keeper/pool.go

@@ -250,7 +250,9 @@ func (k Keeper) GetPoolType(ctx sdk.Context, poolId uint64) (string, error) {
 
 	switch pool := pool.(type) {
 	case *balancer.Pool:
-		return "Balancer", nil
+		return balancer.PoolTypeName, nil
+	case *stableswap.Pool:
+		return stableswap.PoolTypeName, nil
 	default:
 		errMsg := fmt.Sprintf("unrecognized %s pool type: %T", types.ModuleName, pool)
 		return "", sdkerrors.Wrap(sdkerrors.ErrUnpackAny, errMsg)

x/gamm/pool-models/balancer/constants.go

@@ -17,4 +17,6 @@ var (
 	//
 	// This is done so that smooth weight changes have enough precision to actually be smooth.
 	GuaranteedWeightPrecision int64 = 1 << 30
+
+	PoolTypeName string = "Balancer"
 )

x/gamm/pool-models/stableswap/codec.go

@@ -54,3 +54,5 @@ func init() {
 	RegisterLegacyAminoCodec(authzcodec.Amino)
 	amino.Seal()
 }
+
+const PoolTypeName string = "Stableswap"

x/gamm/pool-models/stableswap/msgs.go

@@ -47,16 +47,21 @@ func (msg MsgCreateStableswapPool) ValidateBasic() error {
 	}
 
 	// validation for scaling factors
+	scalingFactors := msg.ScalingFactors
 	// The message's scaling factors must be empty or a valid set of scaling factors
-	if len(msg.ScalingFactors) != 0 {
-		if err = validateScalingFactors(msg.ScalingFactors, len(msg.InitialPoolLiquidity)); err != nil {
+	if len(scalingFactors) != 0 {
+		if err = validateScalingFactors(scalingFactors, len(msg.InitialPoolLiquidity)); err != nil {
 			return err
 		}
+	} else {
+		for i := 0; i < len(msg.InitialPoolLiquidity); i += 1 {
+			scalingFactors = append(scalingFactors, 1)
+		}
 	}
 
 	// validation for pool initial liquidity
 	// The message's pool liquidity must have between 2 and 8 assets with at most 10B post-scaled units in each
-	if err = validatePoolLiquidity(msg.InitialPoolLiquidity, msg.ScalingFactors); err != nil {
+	if err = validatePoolLiquidity(msg.InitialPoolLiquidity, scalingFactors); err != nil {
 		return err
 	}
 

x/gamm/pool-models/stableswap/msgs_test.go

@@ -66,6 +66,14 @@ func TestMsgCreateStableswapPoolValidateBasic(t *testing.T) {
 			}),
 			expectPass: true,
 		},
+		{
+			name: "no scaling factors",
+			msg: updateMsg(func(msg stableswap.MsgCreateStableswapPool) stableswap.MsgCreateStableswapPool {
+				msg.ScalingFactors = []uint64{}
+				return msg
+			}),
+			expectPass: true,
+		},
 		{
 			name: "invalid sender",
 			msg: updateMsg(func(msg stableswap.MsgCreateStableswapPool) stableswap.MsgCreateStableswapPool {