add scaling factors to stableswap pool creation

CHANGELOG.md

@@ -44,6 +44,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Breaking Changes
 
+* [#2222](https://github.com/osmosis-labs/osmosis/pull/2222) Add scaling factors to MsgCreateStableswapPool
 * [#1889](https://github.com/osmosis-labs/osmosis/pull/1825) Add proto responses to gamm LP messages:
   * MsgJoinPoolResponse: share_out_amount and token_in fields 
   * MsgExitPoolResponse: token_out field 

proto/osmosis/gamm/pool-models/stableswap/tx.proto

@@ -25,7 +25,12 @@ message MsgCreateStableswapPool {
     (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins"
   ];
 
-  string future_pool_governor = 4
+  repeated uint64 scaling_factors = 4 [
+    (gogoproto.moretags) = "yaml:\"stableswap_scaling_factor\"",
+    (gogoproto.nullable) = false
+  ];
+
+  string future_pool_governor = 5
       [ (gogoproto.moretags) = "yaml:\"future_pool_governor\"" ];
 }
 

x/gamm/pool-models/internal/cfmm_common/lp_test.go

@@ -45,6 +45,7 @@ func TestCalcExitPool(t *testing.T) {
 		1,
 		stableswap.PoolParams{ExitFee: sdk.ZeroDec()},
 		twoStablePoolAssets,
+		[]uint64{1, 1},
 		"",
 	)
 	require.NoError(t, err)
@@ -62,6 +63,7 @@ func TestCalcExitPool(t *testing.T) {
 		1,
 		stableswap.PoolParams{ExitFee: sdk.MustNewDecFromStr("0.0001")},
 		twoStablePoolAssets,
+		[]uint64{1, 1},
 		"",
 	)
 	require.NoError(t, err)

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

@@ -21,12 +21,14 @@ func NewMsgCreateStableswapPool(
 	sender sdk.AccAddress,
 	poolParams PoolParams,
 	initialLiquidity sdk.Coins,
+	scalingFactors []uint64,
 	futurePoolGovernor string,
 ) MsgCreateStableswapPool {
 	return MsgCreateStableswapPool{
 		Sender:               sender.String(),
 		PoolParams:           &poolParams,
 		InitialPoolLiquidity: initialLiquidity,
+		ScalingFactors:       scalingFactors,
 		FuturePoolGovernor:   futurePoolGovernor,
 	}
 }
@@ -51,6 +53,10 @@ func (msg MsgCreateStableswapPool) ValidateBasic() error {
 	} else if len(msg.InitialPoolLiquidity) > 2 {
 		return types.ErrTooManyPoolAssets
 	}
+	// valid scaling factor lengths are 0, or one factor for each asset
+	if len(msg.ScalingFactors) != 0 && len(msg.ScalingFactors) != len(msg.InitialPoolLiquidity) {
+		return types.ErrInvalidScalingFactors
+	}
 
 	// validation for future owner
 	if err = types.ValidateFutureGovernor(msg.FuturePoolGovernor); err != nil {
@@ -91,7 +97,7 @@ func (msg MsgCreateStableswapPool) InitialLiquidity() sdk.Coins {
 }
 
 func (msg MsgCreateStableswapPool) CreatePool(ctx sdk.Context, poolId uint64) (types.PoolI, error) {
-	stableswapPool, err := NewStableswapPool(poolId, *msg.PoolParams, msg.InitialPoolLiquidity, msg.FuturePoolGovernor)
+	stableswapPool, err := NewStableswapPool(poolId, *msg.PoolParams, msg.InitialPoolLiquidity, msg.ScalingFactors, msg.FuturePoolGovernor)
 	if err != nil {
 		return nil, err
 	}

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

@@ -33,6 +33,7 @@ func TestMsgCreateStableswapPool(t *testing.T) {
 			Sender:               addr1,
 			PoolParams:           poolParams,
 			InitialPoolLiquidity: testPoolAsset,
+			ScalingFactors:       []uint64{1, 1},
 			FuturePoolGovernor:   "",
 		}
 
@@ -112,6 +113,14 @@ func TestMsgCreateStableswapPool(t *testing.T) {
 			}),
 			expectPass: false,
 		},
+		{
+			name: "scaling factors with invalid lenght",
+			msg: createMsg(func(msg MsgCreateStableswapPool) MsgCreateStableswapPool {
+				msg.ScalingFactors = []uint64{1, 2, 3}
+				return msg
+			}),
+			expectPass: false,
+		},
 		{
 			name: "invalid governor",
 			msg: createMsg(func(msg MsgCreateStableswapPool) MsgCreateStableswapPool {

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

@@ -20,13 +20,20 @@ var _ types.PoolI = &Pool{}
 // * len(initialLiquidity) = 2
 // * FutureGovernor is valid
 // * poolID doesn't already exist
-func NewStableswapPool(poolId uint64, stableswapPoolParams PoolParams, initialLiquidity sdk.Coins, futureGovernor string) (Pool, error) {
+func NewStableswapPool(poolId uint64, stableswapPoolParams PoolParams, initialLiquidity sdk.Coins, scalingFactors []uint64, futureGovernor string) (Pool, error) {
+	if len(scalingFactors) == 0 {
+		scalingFactors = []uint64{1, 1}
+	} else if scalingFactors[0] == 0 || scalingFactors[1] == 0 {
+		return Pooll{}, types.ErrInvalidStableswapScalingFactors
+	}
+
 	pool := Pool{
 		Address:            types.NewPoolAddress(poolId).String(),
 		Id:                 poolId,
 		PoolParams:         stableswapPoolParams,
 		TotalShares:        sdk.NewCoin(types.GetPoolShareDenom(poolId), types.InitPoolSharesSupply),
 		PoolLiquidity:      initialLiquidity,
+		ScalingFactor:      scalingFactors,
 		FuturePoolGovernor: futureGovernor,
 	}
 

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

@@ -13,7 +13,7 @@ func createTestPool(t *testing.T, poolLiquidity sdk.Coins, swapFee, exitFee sdk.
 	pool, err := NewStableswapPool(1, PoolParams{
 		SwapFee: swapFee,
 		ExitFee: exitFee,
-	}, poolLiquidity, "")
+	}, poolLiquidity, []uint64{1, 1}, "")
 
 	require.NoError(t, err)
 

x/gamm/types/errors.go

@@ -37,4 +37,5 @@ var (
 	ErrNotStableSwapPool               = sdkerrors.Register(ModuleName, 61, "not stableswap pool")
 	ErrInvalidStableswapScalingFactors = sdkerrors.Register(ModuleName, 62, "length between liquidity and scaling factors mismatch")
 	ErrNotScalingFactorGovernor        = sdkerrors.Register(ModuleName, 63, "not scaling factor governor")
+	ErrInvalidScalingFactors           = sdkerrors.Register(ModuleName, 64, "invalid scaling factor")
 )