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

Disable create pool with non exit fee #4767

Merged
merged 8 commits into from
Mar 31, 2023
Merged

Disable create pool with non exit fee #4767

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
061f0e4
disable in create pool
hieuvubk Mar 27, 2023
4a35d22
fix ttests
hieuvubk Mar 28, 2023
4f5773a
fix e2e
hieuvubk Mar 28, 2023
6af7c9c
add test case
hieuvubk Mar 28, 2023
5536b82
change exit fee e2e
hieuvubk Mar 28, 2023
90730d9
refactor
hieuvubk Mar 29, 2023
4a0cc6a
update changelog
hieuvubk Mar 29, 2023
e1304d8
update proto
hieuvubk Mar 29, 2023
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* [#4582](https://github.com/osmosis-labs/osmosis/pull/4582) Consistently generate build tags metadata, to return a comma-separated list without stray quotes. This affects the output from `version` CLI subcommand and server info API calls.
* [#4549](https://github.com/osmosis-labs/osmosis/pull/4549) Add single pool price estimate queries
* [#4767](https://github.com/osmosis-labs/osmosis/pull/4767) Disable create pool with non-zero exit fee

### API Breaks

Expand Down
2 changes: 1 addition & 1 deletion app/apptesting/test_suite.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ func (s *KeeperTestHelper) SetupGammPoolsWithBondDenomMultiplier(multipliers []s

poolParams := balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.Dec(sdk.ZeroInt()),
}
msg := balancer.NewMsgCreateBalancerPool(acc1, poolParams, poolAssets, defaultFutureGovernor)

Expand Down
2 changes: 1 addition & 1 deletion app/upgrades/v15/upgrade_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ func (suite *UpgradeTestSuite) TestMigrateBalancerToStablePools() {

// Create the balancer pool
swapFee := sdk.MustNewDecFromStr("0.003")
exitFee := sdk.MustNewDecFromStr("0.025")
exitFee := sdk.ZeroDec()
poolID, err := suite.App.PoolManagerKeeper.CreatePool(
suite.Ctx,
balancer.NewMsgCreateBalancerPool(suite.TestAccs[0],
Expand Down
3 changes: 3 additions & 0 deletions proto/osmosis/gamm/pool-models/balancer/balancerPool.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ message PoolParams {
(gogoproto.moretags) = "yaml:\"swap_fee\"",
(gogoproto.nullable) = false
];
// N.B.: exit fee is disabled during pool creation in x/poolmanager. While old
// pools can maintain a non-zero fee. No new pool can be created with non-zero
// fee anymore
string exit_fee = 2 [
(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
(gogoproto.moretags) = "yaml:\"exit_fee\"",
Expand Down
3 changes: 3 additions & 0 deletions proto/osmosis/gamm/pool-models/stableswap/stableswap_pool.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ message PoolParams {
(gogoproto.moretags) = "yaml:\"swap_fee\"",
(gogoproto.nullable) = false
];
// N.B.: exit fee is disabled during pool creation in x/poolmanager. While old
// pools can maintain a non-zero fee. No new pool can be created with non-zero
// fee anymore
string exit_fee = 2 [
(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
(gogoproto.moretags) = "yaml:\"exit_fee\"",
Expand Down
2 changes: 1 addition & 1 deletion tests/e2e/scripts/ibcDenomPool.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"weights": "5ibc/C053D637CCA2A2BA030E2C5EE1B28A16F71CCB0E45E8BE52766DC1B241B77878,5uosmo",
"initial-deposit": "499404ibc/C053D637CCA2A2BA030E2C5EE1B28A16F71CCB0E45E8BE52766DC1B241B77878,500000uosmo",
"swap-fee": "0.01",
"exit-fee": "0.01",
"exit-fee": "0.00",
"future-governor": ""
}
2 changes: 1 addition & 1 deletion tests/e2e/scripts/nativeDenomPool.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"weights": "5uosmo,5stake",
"initial-deposit": "499404uosmo,500000stake",
"swap-fee": "0.01",
"exit-fee": "0.01",
"exit-fee": "0.00",
"future-governor": ""
}
2 changes: 1 addition & 1 deletion tests/e2e/scripts/nativeDenomThreeAssetPool.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"weights": "5stake,5uion,5uosmo",
"initial-deposit": "10000000stake,1000000uion,20000000uosmo",
"swap-fee": "0.01",
"exit-fee": "0.01",
"exit-fee": "0.00",
"future-governor": ""
}
2 changes: 1 addition & 1 deletion tests/e2e/scripts/pool1A.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"weights": "5ibc/ED07A3391A112B175915CD8FAF43A2DA8E4790EDE12566649D0C2F97716B8518,5uosmo",
"initial-deposit": "499404ibc/ED07A3391A112B175915CD8FAF43A2DA8E4790EDE12566649D0C2F97716B8518,500000uosmo",
"swap-fee": "0.01",
"exit-fee": "0.01",
"exit-fee": "0.0",
"future-governor": ""
}
2 changes: 1 addition & 1 deletion tests/e2e/scripts/pool1B.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"weights": "5ibc/C053D637CCA2A2BA030E2C5EE1B28A16F71CCB0E45E8BE52766DC1B241B77878,5uosmo",
"initial-deposit": "499404ibc/C053D637CCA2A2BA030E2C5EE1B28A16F71CCB0E45E8BE52766DC1B241B77878,500000uosmo",
"swap-fee": "0.01",
"exit-fee": "0.01",
"exit-fee": "0.0",
"future-governor": ""
}
4 changes: 2 additions & 2 deletions tests/ibc-hooks/ibc_middleware_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,7 @@ func (suite *HooksTestSuite) SetupPools(chainName Chain, multipliers []sdk.Dec)

poolParams := balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.ZeroDec(),
}
msg := balancer.NewMsgCreateBalancerPool(acc1, poolParams, poolAssets, defaultFutureGovernor)

Expand Down Expand Up @@ -1268,7 +1268,7 @@ func (suite *HooksTestSuite) CreateIBCPoolOnChainB() uint64 {

poolParams := balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.ZeroDec(),
}
msg := balancer.NewMsgCreateBalancerPool(acc1, poolParams, poolAssets, defaultFutureGovernor)

Expand Down
8 changes: 4 additions & 4 deletions x/gamm/keeper/genesis_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func TestGammInitGenesis(t *testing.T) {

balancerPool, err := balancer.NewBalancerPool(1, balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.ZeroDec(),
}, []balancer.PoolAsset{
{
Weight: sdk.NewInt(1),
Expand Down Expand Up @@ -92,7 +92,7 @@ func TestGammExportGenesis(t *testing.T) {

msg := balancer.NewMsgCreateBalancerPool(acc1, balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.ZeroDec(),
}, []balancer.PoolAsset{{
Weight: sdk.NewInt(100),
Token: sdk.NewCoin("foo", sdk.NewInt(10000)),
Expand All @@ -105,7 +105,7 @@ func TestGammExportGenesis(t *testing.T) {

msg = balancer.NewMsgCreateBalancerPool(acc1, balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.ZeroDec(),
}, []balancer.PoolAsset{{
Weight: sdk.NewInt(70),
Token: sdk.NewCoin("foo", sdk.NewInt(10000)),
Expand Down Expand Up @@ -146,7 +146,7 @@ func TestMarshalUnmarshalGenesis(t *testing.T) {

msg := balancer.NewMsgCreateBalancerPool(acc1, balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.ZeroDec(),
}, []balancer.PoolAsset{{
Weight: sdk.NewInt(100),
Token: sdk.NewCoin("foo", sdk.NewInt(10000)),
Expand Down
5 changes: 5 additions & 0 deletions x/gamm/keeper/keeper_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ type KeeperTestSuite struct {

queryClient types.QueryClient
}
var (
defaultSwapFee = sdk.MustNewDecFromStr("0.025")
defaultZeroExitFee = sdk.ZeroDec()
)


func TestKeeperTestSuite(t *testing.T) {
suite.Run(t, new(KeeperTestSuite))
Expand Down
31 changes: 19 additions & 12 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 @@ -18,15 +18,14 @@ import (
)

var (
defaultSwapFee = sdk.MustNewDecFromStr("0.025")
defaultExitFee = sdk.MustNewDecFromStr("0.025")

defaultPoolParams = balancer.PoolParams{
SwapFee: defaultSwapFee,
ExitFee: defaultExitFee,
ExitFee: defaultZeroExitFee,
}
defaultStableSwapPoolParams = stableswap.PoolParams{
SwapFee: defaultSwapFee,
ExitFee: defaultExitFee,
ExitFee: defaultZeroExitFee,
}
defaultScalingFactor = []uint64{1, 1}
defaultFutureGovernor = ""
Expand Down Expand Up @@ -88,7 +87,7 @@ func (suite *KeeperTestSuite) TestCreateBalancerPool() {
name: "create a pool with negative swap fee",
msg: balancer.NewMsgCreateBalancerPool(testAccount, balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(-1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: defaultZeroExitFee,
}, defaultPoolAssets, defaultFutureGovernor),
emptySender: false,
expectPass: false,
Expand All @@ -101,18 +100,26 @@ func (suite *KeeperTestSuite) TestCreateBalancerPool() {
emptySender: false,
expectPass: false,
}, {
name: "create the pool with empty PoolAssets",
name: "create a pool with non zero exit fee",
msg: balancer.NewMsgCreateBalancerPool(testAccount, balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
}, defaultPoolAssets, defaultFutureGovernor),
emptySender: false,
expectPass: false,
}, {
name: "create the pool with empty PoolAssets",
msg: balancer.NewMsgCreateBalancerPool(testAccount, balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: defaultZeroExitFee,
}, []balancertypes.PoolAsset{}, defaultFutureGovernor),
emptySender: false,
expectPass: false,
}, {
name: "create the pool with 0 weighted PoolAsset",
msg: balancer.NewMsgCreateBalancerPool(testAccount, balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: defaultZeroExitFee,
}, []balancertypes.PoolAsset{{
Weight: sdk.NewInt(0),
Token: sdk.NewCoin("foo", sdk.NewInt(10000)),
Expand All @@ -126,7 +133,7 @@ func (suite *KeeperTestSuite) TestCreateBalancerPool() {
name: "create the pool with negative weighted PoolAsset",
msg: balancer.NewMsgCreateBalancerPool(testAccount, balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: defaultZeroExitFee,
}, []balancertypes.PoolAsset{{
Weight: sdk.NewInt(-1),
Token: sdk.NewCoin("foo", sdk.NewInt(10000)),
Expand All @@ -140,7 +147,7 @@ func (suite *KeeperTestSuite) TestCreateBalancerPool() {
name: "create the pool with 0 balance PoolAsset",
msg: balancer.NewMsgCreateBalancerPool(testAccount, balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: defaultZeroExitFee,
}, []balancertypes.PoolAsset{{
Weight: sdk.NewInt(100),
Token: sdk.NewCoin("foo", sdk.NewInt(0)),
Expand All @@ -154,7 +161,7 @@ func (suite *KeeperTestSuite) TestCreateBalancerPool() {
name: "create the pool with negative balance PoolAsset",
msg: balancer.NewMsgCreateBalancerPool(testAccount, balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: defaultZeroExitFee,
}, []balancertypes.PoolAsset{{
Weight: sdk.NewInt(100),
Token: sdk.Coin{
Expand All @@ -171,7 +178,7 @@ func (suite *KeeperTestSuite) TestCreateBalancerPool() {
name: "create the pool with duplicated PoolAssets",
msg: balancer.NewMsgCreateBalancerPool(testAccount, balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: defaultZeroExitFee,
}, []balancertypes.PoolAsset{{
Weight: sdk.NewInt(100),
Token: sdk.NewCoin("foo", sdk.NewInt(10000)),
Expand Down Expand Up @@ -515,7 +522,7 @@ func (suite *KeeperTestSuite) TestJoinPoolNoSwap() {
// Create the pool at first
msg := balancer.NewMsgCreateBalancerPool(testAccount, balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: defaultZeroExitFee,
}, defaultPoolAssets, defaultFutureGovernor)
poolId, err := poolmanagerKeeper.CreatePool(suite.Ctx, msg)
suite.Require().NoError(err, "test: %v", test.name)
Expand Down
8 changes: 4 additions & 4 deletions x/gamm/keeper/pool_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ var (
}
defaultPoolParamsStableSwap = stableswap.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.ZeroDec(),
}
defaultPoolId = uint64(1)
defaultAcctFundsStableSwap sdk.Coins = sdk.NewCoins(
Expand Down Expand Up @@ -286,7 +286,7 @@ func (suite *KeeperTestSuite) TestGetPoolAndPoke() {
isPokePool: true,
poolId: suite.prepareCustomBalancerPool(defaultAcctFunds, startPoolWeightAssets, balancer.PoolParams{
SwapFee: defaultSwapFee,
ExitFee: defaultExitFee,
ExitFee: defaultZeroExitFee,
SmoothWeightChangeParams: &balancer.SmoothWeightChangeParams{
StartTime: time.Unix(startTime, 0), // start time is before block time so the weights should change
Duration: time.Hour,
Expand All @@ -300,7 +300,7 @@ func (suite *KeeperTestSuite) TestGetPoolAndPoke() {
defaultAcctFunds,
stableswap.PoolParams{
SwapFee: defaultSwapFee,
ExitFee: defaultExitFee,
ExitFee: defaultZeroExitFee,
},
sdk.NewCoins(sdk.NewCoin(defaultAcctFunds[0].Denom, defaultAcctFunds[0].Amount.QuoRaw(2)), sdk.NewCoin(defaultAcctFunds[1].Denom, defaultAcctFunds[1].Amount.QuoRaw(2))),
[]uint64{1, 1},
Expand Down Expand Up @@ -502,7 +502,7 @@ func (suite *KeeperTestSuite) TestSetStableSwapScalingFactors() {
defaultAcctFunds,
stableswap.PoolParams{
SwapFee: defaultSwapFee,
ExitFee: defaultExitFee,
ExitFee: defaultZeroExitFee,
},
sdk.NewCoins(sdk.NewCoin(defaultAcctFunds[0].Denom, defaultAcctFunds[0].Amount.QuoRaw(2)), sdk.NewCoin(defaultAcctFunds[1].Denom, defaultAcctFunds[1].Amount.QuoRaw(2))),
tc.scalingFactors,
Expand Down
8 changes: 4 additions & 4 deletions 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 @@ -30,13 +30,13 @@ func TestBalancerPoolParams(t *testing.T) {
shouldErr bool
}{
// Should work
{defaultSwapFee, defaultExitFee, noErr},
{defaultSwapFee, defaultZeroExitFee, noErr},
// Can't set the swap fee as negative
{sdk.NewDecWithPrec(-1, 2), defaultExitFee, wantErr},
{sdk.NewDecWithPrec(-1, 2), defaultZeroExitFee, wantErr},
// Can't set the swap fee as 1
{sdk.NewDec(1), defaultExitFee, wantErr},
{sdk.NewDec(1), defaultZeroExitFee, wantErr},
// Can't set the swap fee above 1
{sdk.NewDecWithPrec(15, 1), defaultExitFee, wantErr},
{sdk.NewDecWithPrec(15, 1), defaultZeroExitFee, wantErr},
// Can't set the exit fee as negative
{defaultSwapFee, sdk.NewDecWithPrec(-1, 2), wantErr},
// Can't set the exit fee as 1
Expand Down
5 changes: 4 additions & 1 deletion x/gamm/pool-models/balancer/balancerPool.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions x/gamm/pool-models/balancer/marshal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func TestPoolJson(t *testing.T) {
}
pacc, err := balancer.NewBalancerPool(poolId, balancer.PoolParams{
SwapFee: defaultSwapFee,
ExitFee: defaultExitFee,
ExitFee: defaultZeroExitFee,
}, jsonAssetTest, defaultFutureGovernor, defaultCurBlockTime)
require.NoError(t, err)

Expand All @@ -66,7 +66,7 @@ func TestPoolProtoMarshal(t *testing.T) {

require.Equal(t, pool2.Id, uint64(10))
require.Equal(t, pool2.PoolParams.SwapFee, defaultSwapFee)
require.Equal(t, pool2.PoolParams.ExitFee, defaultExitFee)
require.Equal(t, pool2.PoolParams.ExitFee, sdk.MustNewDecFromStr("0.025"))
require.Equal(t, pool2.FuturePoolGovernor, "")
require.Equal(t, pool2.TotalShares, sdk.Coin{Denom: "gamm/pool/10", Amount: sdk.ZeroInt()})
require.Equal(t, pool2.PoolAssets, []balancer.PoolAsset{
Expand Down
6 changes: 3 additions & 3 deletions x/gamm/pool-models/balancer/msgs_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func TestMsgCreateBalancerPool_ValidateBasic(t *testing.T) {

poolParams := &balancer.PoolParams{
SwapFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.NewDecWithPrec(1, 2),
ExitFee: sdk.ZeroDec(),
}

msg := &balancer.MsgCreateBalancerPool{
Expand Down Expand Up @@ -252,7 +252,7 @@ func (suite *KeeperTestSuite) TestMsgCreateBalancerPool() {
"basic success test": {
msg: balancer.MsgCreateBalancerPool{
Sender: suite.TestAccs[0].String(),
PoolParams: &balancer.PoolParams{SwapFee: sdk.NewDecWithPrec(1, 2), ExitFee: sdk.NewDecWithPrec(1, 3)},
PoolParams: &balancer.PoolParams{SwapFee: sdk.NewDecWithPrec(1, 2), ExitFee: sdk.ZeroDec()},
PoolAssets: apptesting.DefaultPoolAssets,
FuturePoolGovernor: "",
},
Expand All @@ -261,7 +261,7 @@ func (suite *KeeperTestSuite) TestMsgCreateBalancerPool() {
"error due to negative swap fee": {
msg: balancer.MsgCreateBalancerPool{
Sender: suite.TestAccs[0].String(),
PoolParams: &balancer.PoolParams{SwapFee: sdk.NewDecWithPrec(1, 2).Neg(), ExitFee: sdk.NewDecWithPrec(1, 3)},
PoolParams: &balancer.PoolParams{SwapFee: sdk.NewDecWithPrec(1, 2).Neg(), ExitFee: sdk.ZeroDec()},
PoolAssets: apptesting.DefaultPoolAssets,
FuturePoolGovernor: "",
},
Expand Down
Loading