osmosis-labs · czarcas7ic · Aug 28, 2023 · Aug 11, 2023 · Aug 11, 2023 · Aug 14, 2023
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -50,6 +50,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * [#6162](https://github.com/osmosis-labs/osmosis/pull/6162) allow zero qualifying balancer shares in CL incentives
 
+### Features
+
+* [#6034](https://github.com/osmosis-labs/osmosis/pull/6034) feat(spike): taker fee
 ## v18.0.0
 
 Fixes mainnet bugs w/ incorrect accumulation sumtrees, and CL handling for a balancer pool with 0 bonded shares.

diff --git a/Makefile b/Makefile
@@ -7,7 +7,7 @@ LEDGER_ENABLED ?= true
 SDK_PACK := $(shell go list -m github.com/cosmos/cosmos-sdk | sed  's/ /\@/g')
 BUILDDIR ?= $(CURDIR)/build
 DOCKER := $(shell which docker)
-E2E_UPGRADE_VERSION := "v18"
+E2E_UPGRADE_VERSION := "v19"
 #SHELL := /bin/bash
 
 GO_VERSION := $(shell cat go.mod | grep -E 'go [0-9].[0-9]+' | cut -d ' ' -f 2)
@@ -586,7 +586,7 @@ cl-create-bigbang-config:
 ###############################################################################
 
 go-mock-update:
-	mockgen -source=x/poolmanager/types/routes.go -destination=tests/mocks/pool_module.go -package=mocks
+	mockgen -source=x/poolmanager/types/expected_keepers.go -destination=tests/mocks/pool_module.go -package=mocks
 	mockgen -source=x/poolmanager/types/pool.go -destination=tests/mocks/pool.go -package=mocks
 	mockgen -source=x/gamm/types/pool.go -destination=tests/mocks/cfmm_pool.go -package=mocks
 	mockgen -source=x/concentrated-liquidity/types/cl_pool_extensionI.go -destination=tests/mocks/cl_pool.go -package=mocks

diff --git a/app/app.go b/app/app.go
@@ -59,6 +59,7 @@ import (
 	v16 "github.com/osmosis-labs/osmosis/v19/app/upgrades/v16"
 	v17 "github.com/osmosis-labs/osmosis/v19/app/upgrades/v17"
 	v18 "github.com/osmosis-labs/osmosis/v19/app/upgrades/v18"
+	v19 "github.com/osmosis-labs/osmosis/v19/app/upgrades/v19"
 	v3 "github.com/osmosis-labs/osmosis/v19/app/upgrades/v3"
 	v4 "github.com/osmosis-labs/osmosis/v19/app/upgrades/v4"
 	v5 "github.com/osmosis-labs/osmosis/v19/app/upgrades/v5"
@@ -104,7 +105,7 @@ var (
 
 	// _ sdksimapp.App = (*OsmosisApp)(nil)
 
-	Upgrades = []upgrades.Upgrade{v4.Upgrade, v5.Upgrade, v7.Upgrade, v9.Upgrade, v11.Upgrade, v12.Upgrade, v13.Upgrade, v14.Upgrade, v15.Upgrade, v16.Upgrade, v17.Upgrade, v18.Upgrade}
+	Upgrades = []upgrades.Upgrade{v4.Upgrade, v5.Upgrade, v7.Upgrade, v9.Upgrade, v11.Upgrade, v12.Upgrade, v13.Upgrade, v14.Upgrade, v15.Upgrade, v16.Upgrade, v17.Upgrade, v18.Upgrade, v19.Upgrade}
 	Forks    = []upgrades.Fork{v3.Fork, v6.Fork, v8.Fork, v10.Fork}
 )
 

diff --git a/app/apptesting/concentrated_liquidity.go b/app/apptesting/concentrated_liquidity.go
@@ -7,6 +7,7 @@ import (
 
 	clmodel "github.com/osmosis-labs/osmosis/v19/x/concentrated-liquidity/model"
 	"github.com/osmosis-labs/osmosis/v19/x/concentrated-liquidity/types"
+	poolmanagertypes "github.com/osmosis-labs/osmosis/v19/x/poolmanager/types"
 
 	cl "github.com/osmosis-labs/osmosis/v19/x/concentrated-liquidity"
 )
@@ -139,6 +140,9 @@ func (s *KeeperTestHelper) SetupConcentratedLiquidityDenomsAndPoolCreation() {
 	// modify authorized quote denoms to include test denoms.
 	defaultParams := types.DefaultParams()
 	defaultParams.IsPermissionlessPoolCreationEnabled = true
-	defaultParams.AuthorizedQuoteDenoms = append(defaultParams.AuthorizedQuoteDenoms, ETH, USDC, BAR, BAZ, FOO, UOSMO, STAKE, WBTC)
 	s.App.ConcentratedLiquidityKeeper.SetParams(s.Ctx, defaultParams)
+
+	poolManagerParams := s.App.PoolManagerKeeper.GetParams(s.Ctx)
+	poolManagerParams.AuthorizedQuoteDenoms = append(poolmanagertypes.DefaultParams().AuthorizedQuoteDenoms, ETH, USDC, BAR, BAZ, FOO, UOSMO, STAKE, WBTC)
+	s.App.PoolManagerKeeper.SetParams(s.Ctx, poolManagerParams)
 }
diff --git a/app/keepers/keepers.go b/app/keepers/keepers.go
@@ -379,6 +379,8 @@ func (appKeepers *AppKeepers) InitNormalKeepers(
 		appKeepers.keys[txfeestypes.StoreKey],
 		appKeepers.PoolManagerKeeper,
 		appKeepers.GAMMKeeper,
+		appKeepers.ProtoRevKeeper,
+		appKeepers.DistrKeeper,
 	)
 	appKeepers.TxFeesKeeper = &txFeesKeeper
 
@@ -509,7 +511,8 @@ func (appKeepers *AppKeepers) InitNormalKeepers(
 		AddRoute(protorevtypes.RouterKey, protorev.NewProtoRevProposalHandler(*appKeepers.ProtoRevKeeper)).
 		AddRoute(gammtypes.RouterKey, gamm.NewGammProposalHandler(*appKeepers.GAMMKeeper)).
 		AddRoute(concentratedliquiditytypes.RouterKey, concentratedliquidity.NewConcentratedLiquidityProposalHandler(*appKeepers.ConcentratedLiquidityKeeper)).
-		AddRoute(cosmwasmpooltypes.RouterKey, cosmwasmpool.NewCosmWasmPoolProposalHandler(*appKeepers.CosmwasmPoolKeeper))
+		AddRoute(cosmwasmpooltypes.RouterKey, cosmwasmpool.NewCosmWasmPoolProposalHandler(*appKeepers.CosmwasmPoolKeeper)).
+		AddRoute(poolmanagertypes.RouterKey, poolmanager.NewPoolManagerProposalHandler(*appKeepers.PoolManagerKeeper))
 
 	// The gov proposal types can be individually enabled
 	if len(wasmEnabledProposals) != 0 {

diff --git a/app/modules.go b/app/modules.go
@@ -98,30 +98,31 @@ import (
 // moduleAccountPermissions defines module account permissions
 // TODO: Having to input nil's here is unacceptable, we need a way to automatically derive this.
 var moduleAccountPermissions = map[string][]string{
-	authtypes.FeeCollectorName:               nil,
-	distrtypes.ModuleName:                    nil,
-	ibchookstypes.ModuleName:                 nil,
-	icatypes.ModuleName:                      nil,
-	icqtypes.ModuleName:                      nil,
-	minttypes.ModuleName:                     {authtypes.Minter, authtypes.Burner},
-	minttypes.DeveloperVestingModuleAcctName: nil,
-	stakingtypes.BondedPoolName:              {authtypes.Burner, authtypes.Staking},
-	stakingtypes.NotBondedPoolName:           {authtypes.Burner, authtypes.Staking},
-	govtypes.ModuleName:                      {authtypes.Burner},
-	ibctransfertypes.ModuleName:              {authtypes.Minter, authtypes.Burner},
-	gammtypes.ModuleName:                     {authtypes.Minter, authtypes.Burner},
-	incentivestypes.ModuleName:               {authtypes.Minter, authtypes.Burner},
-	protorevtypes.ModuleName:                 {authtypes.Minter, authtypes.Burner},
-	lockuptypes.ModuleName:                   {authtypes.Minter, authtypes.Burner},
-	poolincentivestypes.ModuleName:           nil,
-	superfluidtypes.ModuleName:               {authtypes.Minter, authtypes.Burner},
-	txfeestypes.ModuleName:                   nil,
-	txfeestypes.NonNativeFeeCollectorName:    nil,
-	wasm.ModuleName:                          {authtypes.Burner},
-	tokenfactorytypes.ModuleName:             {authtypes.Minter, authtypes.Burner},
-	valsetpreftypes.ModuleName:               {authtypes.Staking},
-	poolmanagertypes.ModuleName:              nil,
-	cosmwasmpooltypes.ModuleName:             nil,
+	authtypes.FeeCollectorName:                             nil,
+	distrtypes.ModuleName:                                  nil,
+	ibchookstypes.ModuleName:                               nil,
+	icatypes.ModuleName:                                    nil,
+	icqtypes.ModuleName:                                    nil,
+	minttypes.ModuleName:                                   {authtypes.Minter, authtypes.Burner},
+	minttypes.DeveloperVestingModuleAcctName:               nil,
+	stakingtypes.BondedPoolName:                            {authtypes.Burner, authtypes.Staking},
+	stakingtypes.NotBondedPoolName:                         {authtypes.Burner, authtypes.Staking},
+	govtypes.ModuleName:                                    {authtypes.Burner},
+	ibctransfertypes.ModuleName:                            {authtypes.Minter, authtypes.Burner},
+	gammtypes.ModuleName:                                   {authtypes.Minter, authtypes.Burner},
+	incentivestypes.ModuleName:                             {authtypes.Minter, authtypes.Burner},
+	protorevtypes.ModuleName:                               {authtypes.Minter, authtypes.Burner},
+	lockuptypes.ModuleName:                                 {authtypes.Minter, authtypes.Burner},
+	poolincentivestypes.ModuleName:                         nil,
+	superfluidtypes.ModuleName:                             {authtypes.Minter, authtypes.Burner},
+	txfeestypes.ModuleName:                                 nil,
+	txfeestypes.NonNativeFeeCollectorForStakingRewardsName: nil,
+	txfeestypes.NonNativeFeeCollectorForCommunityPoolName:  nil,
+	wasm.ModuleName:                                        {authtypes.Burner},
+	tokenfactorytypes.ModuleName:                           {authtypes.Minter, authtypes.Burner},
+	valsetpreftypes.ModuleName:                             {authtypes.Staking},
+	poolmanagertypes.ModuleName:                            nil,
+	cosmwasmpooltypes.ModuleName:                           nil,
 }
 
 // appModules return modules to initialize module manager.

diff --git a/app/upgrades/v15/upgrades.go b/app/upgrades/v15/upgrades.go
@@ -37,7 +37,8 @@ func CreateUpgradeHandler(
 	keepers *keepers.AppKeepers,
 ) upgradetypes.UpgradeHandler {
 	return func(ctx sdk.Context, plan upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
-		poolmanagerParams := poolmanagertypes.NewParams(keepers.GAMMKeeper.GetParams(ctx).PoolCreationFee)
+		poolmanagerParams := keepers.PoolManagerKeeper.GetParams(ctx)
+		poolmanagerParams.PoolCreationFee = keepers.GAMMKeeper.GetParams(ctx).PoolCreationFee
 
 		keepers.PoolManagerKeeper.SetParams(ctx, poolmanagerParams)
 		keepers.PacketForwardKeeper.SetParams(ctx, packetforwardtypes.DefaultParams())

diff --git a/app/upgrades/v18/upgrades_test.go b/app/upgrades/v18/upgrades_test.go
@@ -106,6 +106,7 @@ func (s *UpgradeTestSuite) TestUpgrade() {
 
 	// Swap
 	toSwap := sdk.NewCoin(pool.GetToken0(), sdk.NewInt(100))
+	s.FundAcc(s.TestAccs[0], sdk.NewCoins(toSwap))
 	_, err = s.App.ConcentratedLiquidityKeeper.SwapExactAmountIn(s.Ctx, s.TestAccs[0], updatedCLPool, toSwap, pool.GetToken1(), sdk.NewInt(1), sdk.ZeroDec())
 	s.Require().NoError(err)
 
@@ -233,7 +234,7 @@ func (suite *UpgradeTestSuite) ensurePreUpgradeDistributionPanics() {
 	suite.App.ConcentratedLiquidityKeeper.SetParams(suite.Ctx, clParams)
 
 	// prepare CL pool with the same denom as pool 3, which is the pool we are testing with
-	clPool := suite.PrepareConcentratedPoolWithCoins(v17.OSMO, v17.AKTIBCDenom)
+	clPool := suite.PrepareConcentratedPoolWithCoins(v17.AKTIBCDenom, v17.OSMO)
 	balancerToCLPoolLink := []gammmigration.BalancerToConcentratedPoolLink{
 		{
 			BalancerPoolId: 3,

diff --git a/app/upgrades/v19/constants.go b/app/upgrades/v19/constants.go
@@ -0,0 +1,19 @@
+package v19
+
+import (
+	"github.com/osmosis-labs/osmosis/v19/app/upgrades"
+
+	store "github.com/cosmos/cosmos-sdk/store/types"
+)
+
+// UpgradeName defines the on-chain upgrade name for the Osmosis v18 upgrade.
+const UpgradeName = "v19"
+
+var Upgrade = upgrades.Upgrade{
+	UpgradeName:          UpgradeName,
+	CreateUpgradeHandler: CreateUpgradeHandler,
+	StoreUpgrades: store.StoreUpgrades{
+		Added:   []string{},
+		Deleted: []string{},
+	},
+}
diff --git a/app/upgrades/v19/upgrades.go b/app/upgrades/v19/upgrades.go
@@ -0,0 +1,40 @@
+package v19
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/types/module"
+	upgradetypes "github.com/cosmos/cosmos-sdk/x/upgrade/types"
+
+	"github.com/osmosis-labs/osmosis/v19/app/keepers"
+	"github.com/osmosis-labs/osmosis/v19/app/upgrades"
+	poolmanagertypes "github.com/osmosis-labs/osmosis/v19/x/poolmanager/types"
+)
+
+func CreateUpgradeHandler(
+	mm *module.Manager,
+	configurator module.Configurator,
+	bpm upgrades.BaseAppParamManager,
+	keepers *keepers.AppKeepers,
+) upgradetypes.UpgradeHandler {
+	return func(ctx sdk.Context, plan upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
+		// Run migrations before applying any other state changes.
+		// NOTE: DO NOT PUT ANY STATE CHANGES BEFORE RunMigrations().
+		migrations, err := mm.RunMigrations(ctx, configurator, fromVM)
+		if err != nil {
+			return nil, err
+		}
+
+		// Move the current authorized quote denoms from the concentrated liquidity params to the pool manager params.
+		// This needs to be moved because the pool manager requires access to these denoms to determine if the taker fee should
+		// be swapped into OSMO or not. The concentrated liquidity module already requires access to the pool manager keeper,
+		// so the right move in this case is to move this parameter upwards in order to prevent circular dependencies.
+		// TODO: In v20 upgrade handler, delete this param from the concentrated liquidity params.
+		currentConcentratedLiquidityParams := keepers.ConcentratedLiquidityKeeper.GetParams(ctx)
+		defaultPoolManagerParams := poolmanagertypes.DefaultParams()
+		defaultPoolManagerParams.AuthorizedQuoteDenoms = currentConcentratedLiquidityParams.AuthorizedQuoteDenoms
+		defaultPoolManagerParams.TakerFeeParams.DefaultTakerFee = sdk.ZeroDec()
+		keepers.PoolManagerKeeper.SetParams(ctx, defaultPoolManagerParams)
+
+		return migrations, nil
+	}
+}
diff --git a/proto/osmosis/poolmanager/v1beta1/genesis.proto b/proto/osmosis/poolmanager/v1beta1/genesis.proto
@@ -17,6 +17,21 @@ message Params {
     (gogoproto.moretags) = "yaml:\"pool_creation_fee\"",
     (gogoproto.nullable) = false
   ];
+  // taker_fee_params is the container of taker fee parameters.
+  TakerFeeParams taker_fee_params = 2 [
+    (gogoproto.moretags) = "yaml:\"taker_fee_params\"",
+    (gogoproto.nullable) = false
+  ];
+  // authorized_quote_denoms is a list of quote denoms that can be used as
+  // token1 when creating a concentrated pool. We limit the quote assets to a
+  // small set for the purposes of having convinient price increments stemming
+  // from tick to price conversion. These increments are in a human readable
+  // magnitude only for token1 as a quote. For limit orders in the future, this
+  // will be a desirable property in terms of UX as to allow users to set limit
+  // orders at prices in terms of token1 (quote asset) that are easy to reason
+  // about.
+  repeated string authorized_quote_denoms = 3
+      [ (gogoproto.moretags) = "yaml:\"authorized_quote_denoms\"" ];
 }
 
 // GenesisState defines the poolmanager module's genesis state.
@@ -28,3 +43,64 @@ message GenesisState {
   // pool_routes is the container of the mappings from pool id to pool type.
   repeated ModuleRoute pool_routes = 3 [ (gogoproto.nullable) = false ];
 }
+
+// TakerFeeParams consolidates the taker fee parameters for the poolmanager.
+message TakerFeeParams {
+  // default_taker_fee is the fee used when creating a new pool that doesn't
+  // fall under a custom pool taker fee or stableswap taker fee category.
+  string default_taker_fee = 1 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.customname) = "DefaultTakerFee",
+    (gogoproto.nullable) = false
+  ];
+  // osmo_taker_fee_distribution defines the distribution of taker fees
+  // generated in OSMO. As of this writing, it has two catagories:
+  // - staking_rewards: the percent of the taker fee that gets distributed to
+  //   stakers.
+  // - community_pool: the percent of the taker fee that gets sent to the
+  //   community pool.
+  TakerFeeDistributionPercentage osmo_taker_fee_distribution = 2 [
+    (gogoproto.customname) = "OsmoTakerFeeDistribution",
+    (gogoproto.nullable) = false
+  ];
+  // non_osmo_taker_fee_distribution defines the distribution of taker fees
+  // generated in non-OSMO. As of this writing, it has two categories:
+  // - staking_rewards: the percent of the taker fee that gets swapped to OSMO
+  //   and then distirbuted to stakers.
+  // - community_pool: the percent of the taker fee that gets sent to the
+  //   community pool. Note: If the non-OSMO asset is an authorized_quote_denom,
+  //   that denom is sent directly to the community pool. Otherwise, it is
+  //   swapped to the community_pool_denom_to_swap_non_whitelisted_assets_to and
+  //   then sent to the community pool as that denom.
+  TakerFeeDistributionPercentage non_osmo_taker_fee_distribution = 3 [
+    (gogoproto.customname) = "NonOsmoTakerFeeDistribution",
+    (gogoproto.nullable) = false
+  ];
+  // admin_addresses is a list of addresses that are allowed to set and remove
+  // custom taker fees for denom pairs. Governance also has the ability to set
+  // and remove custom taker fees for denom pairs, but with the normal
+  // governance delay.
+  repeated string admin_addresses = 4
+      [ (gogoproto.moretags) = "yaml:\"admin_addresses\"" ];
+  // community_pool_denom_to_swap_non_whitelisted_assets_to is the denom that
+  // non-whitelisted taker fees will be swapped to before being sent to
+  // the community pool.
+  string community_pool_denom_to_swap_non_whitelisted_assets_to = 5
+      [ (gogoproto.moretags) =
+            "yaml:\"community_pool_denom_to_swap_non_whitelisted_assets_to\"" ];
+}
+
+// TakerFeeDistributionPercentage defines what percent of the taker fee category
+// gets distributed to the available categories.
+message TakerFeeDistributionPercentage {
+  string staking_rewards = 1 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.moretags) = "yaml:\"staking_rewards\"",
+    (gogoproto.nullable) = false
+  ];
+  string community_pool = 2 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.moretags) = "yaml:\"community_pool\"",
+    (gogoproto.nullable) = false
+  ];
+}
diff --git a/proto/osmosis/poolmanager/v1beta1/gov.proto b/proto/osmosis/poolmanager/v1beta1/gov.proto
@@ -0,0 +1,20 @@
+syntax = "proto3";
+package osmosis.poolmanager.v1beta1;
+
+import "gogoproto/gogo.proto";
+import "osmosis/poolmanager/v1beta1/tx.proto";
+
+option go_package = "github.com/osmosis-labs/osmosis/v19/x/poolmanager/types";
+
+// DenomPairTakerFeeProposal is a type for adding/removing a custom taker fee(s)
+// for one or more denom pairs.
+message DenomPairTakerFeeProposal {
+  option (gogoproto.goproto_getters) = false;
+  option (gogoproto.goproto_stringer) = false;
+
+  string title = 1;
+  string description = 2;
+
+  repeated osmosis.poolmanager.v1beta1.DenomPairTakerFee denom_pair_taker_fee =
+      3 [ (gogoproto.nullable) = false ];
+}
diff --git a/proto/osmosis/poolmanager/v1beta1/tx.proto b/proto/osmosis/poolmanager/v1beta1/tx.proto
@@ -17,6 +17,8 @@ service Msg {
       returns (MsgSplitRouteSwapExactAmountInResponse);
   rpc SplitRouteSwapExactAmountOut(MsgSplitRouteSwapExactAmountOut)
       returns (MsgSplitRouteSwapExactAmountOutResponse);
+  rpc SetDenomPairTakerFee(MsgSetDenomPairTakerFee)
+      returns (MsgSetDenomPairTakerFeeResponse);
 }
 
 // ===================== MsgSwapExactAmountIn
@@ -114,3 +116,26 @@ message MsgSplitRouteSwapExactAmountOutResponse {
     (gogoproto.nullable) = false
   ];
 }
+
+// ===================== MsgSetDenomPairTakerFee
+message MsgSetDenomPairTakerFee {
+  option (amino.name) = "osmosis/poolmanager/set-denom-pair-taker-fee";
+
+  string sender = 1 [ (gogoproto.moretags) = "yaml:\"sender\"" ];
+  repeated DenomPairTakerFee denom_pair_taker_fee = 2 [
+    (gogoproto.moretags) = "yaml:\"denom_pair_taker_fee\"",
+    (gogoproto.nullable) = false
+  ];
+}
+
+message MsgSetDenomPairTakerFeeResponse { bool success = 1; }
+
+message DenomPairTakerFee {
+  string denom0 = 1 [ (gogoproto.moretags) = "yaml:\"denom0\"" ];
+  string denom1 = 2 [ (gogoproto.moretags) = "yaml:\"denom1\"" ];
+  string taker_fee = 3 [
+    (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
+    (gogoproto.moretags) = "yaml:\"taker_fee\"",
+    (gogoproto.nullable) = false
+  ];
+}