Allow whitelisted tx fee tokens based on conversion rate to OSMO

app/ante.go

@@ -0,0 +1,40 @@
+package app
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/cosmos/cosmos-sdk/x/auth/signing"
+	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+
+	ante "github.com/cosmos/cosmos-sdk/x/auth/ante"
+
+	txfeeskeeper "github.com/osmosis-labs/osmosis/x/txfees/keeper"
+	txfeestypes "github.com/osmosis-labs/osmosis/x/txfees/types"
+)
+
+// Link to default ante handler used by cosmos sdk:
+// https://github.com/cosmos/cosmos-sdk/blob/v0.43.0/x/auth/ante/ante.go#L41
+func NewAnteHandler(
+	ak ante.AccountKeeper, bankKeeper authtypes.BankKeeper,
+	txFeesKeeper txfeeskeeper.Keeper, spotPriceCalculator txfeestypes.SpotPriceCalculator,
+	sigGasConsumer ante.SignatureVerificationGasConsumer,
+	signModeHandler signing.SignModeHandler,
+) sdk.AnteHandler {
+	return sdk.ChainAnteDecorators(
+		ante.NewSetUpContextDecorator(), // outermost AnteDecorator. SetUpContext must be called first
+		ante.NewRejectExtensionOptionsDecorator(),
+		// Use Mempool Fee Decorator from our txfees module instead of default one from auth
+		// https://github.com/cosmos/cosmos-sdk/blob/master/x/auth/middleware/fee.go#L34
+		txfeeskeeper.NewMempoolFeeDecorator(txFeesKeeper),
+		ante.NewValidateBasicDecorator(),
+		ante.TxTimeoutHeightDecorator{},
+		ante.NewValidateMemoDecorator(ak),
+		ante.NewConsumeGasForTxSizeDecorator(ak),
+		ante.NewRejectFeeGranterDecorator(),
+		ante.NewSetPubKeyDecorator(ak), // SetPubKeyDecorator must be called before all signature verification decorators
+		ante.NewValidateSigCountDecorator(ak),
+		ante.NewDeductFeeDecorator(ak, bankKeeper),
+		ante.NewSigGasConsumeDecorator(ak, sigGasConsumer),
+		ante.NewSigVerificationDecorator(ak, signModeHandler),
+		ante.NewIncrementSequenceDecorator(ak),
+	)
+}

app/app.go

@@ -108,6 +108,9 @@ import (
 	poolincentivesclient "github.com/osmosis-labs/osmosis/x/pool-incentives/client"
 	poolincentiveskeeper "github.com/osmosis-labs/osmosis/x/pool-incentives/keeper"
 	poolincentivestypes "github.com/osmosis-labs/osmosis/x/pool-incentives/types"
+	"github.com/osmosis-labs/osmosis/x/txfees"
+	txfeeskeeper "github.com/osmosis-labs/osmosis/x/txfees/keeper"
+	txfeestypes "github.com/osmosis-labs/osmosis/x/txfees/types"
 )
 
 const appName = "OsmosisApp"
@@ -140,6 +143,7 @@ var (
 		transfer.AppModuleBasic{},
 		vesting.AppModuleBasic{},
 		gamm.AppModuleBasic{},
+		txfees.AppModuleBasic{},
 		incentives.AppModuleBasic{},
 		lockup.AppModuleBasic{},
 		poolincentives.AppModuleBasic{},
@@ -162,6 +166,7 @@ var (
 		incentivestypes.ModuleName:               {authtypes.Minter, authtypes.Burner},
 		lockuptypes.ModuleName:                   {authtypes.Minter, authtypes.Burner},
 		poolincentivestypes.ModuleName:           nil,
+		txfeestypes.ModuleName:                   nil,
 	}
 
 	// module accounts that are allowed to receive tokens
@@ -209,6 +214,7 @@ type OsmosisApp struct {
 	LockupKeeper         lockupkeeper.Keeper
 	EpochsKeeper         epochskeeper.Keeper
 	PoolIncentivesKeeper poolincentiveskeeper.Keeper
+	TxFeesKeeper         txfeeskeeper.Keeper
 
 	// make scoped keepers public for test purposes
 	ScopedIBCKeeper      capabilitykeeper.ScopedKeeper
@@ -251,7 +257,7 @@ func NewOsmosisApp(
 		govtypes.StoreKey, paramstypes.StoreKey, ibchost.StoreKey, upgradetypes.StoreKey,
 		evidencetypes.StoreKey, ibctransfertypes.StoreKey, capabilitytypes.StoreKey,
 		gammtypes.StoreKey, lockuptypes.StoreKey, claimtypes.StoreKey, incentivestypes.StoreKey,
-		epochstypes.StoreKey, poolincentivestypes.StoreKey,
+		epochstypes.StoreKey, poolincentivestypes.StoreKey, txfeestypes.StoreKey,
 	)
 	tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey)
 	memKeys := sdk.NewMemoryStoreKeys(capabilitytypes.MemStoreKey)
@@ -401,6 +407,12 @@ func NewOsmosisApp(
 		),
 	)
 
+	app.TxFeesKeeper = txfeeskeeper.NewKeeper(
+		appCodec,
+		keys[txfeestypes.StoreKey],
+		app.GAMMKeeper,
+	)
+
 	app.LockupKeeper = *lockupKeeper.SetHooks(
 		lockuptypes.NewMultiLockupHooks(
 		// insert lockup hooks receivers here
@@ -465,6 +477,7 @@ func NewOsmosisApp(
 		transferModule,
 		claim.NewAppModule(appCodec, *app.ClaimKeeper),
 		gamm.NewAppModule(appCodec, app.GAMMKeeper, app.AccountKeeper, app.BankKeeper),
+		txfees.NewAppModule(appCodec, app.TxFeesKeeper),
 		incentives.NewAppModule(appCodec, app.IncentivesKeeper, app.AccountKeeper, app.BankKeeper, app.EpochsKeeper),
 		lockup.NewAppModule(appCodec, app.LockupKeeper, app.AccountKeeper, app.BankKeeper),
 		poolincentives.NewAppModule(appCodec, app.PoolIncentivesKeeper),
@@ -496,13 +509,15 @@ func NewOsmosisApp(
 	app.mm.SetOrderInitGenesis(
 		capabilitytypes.ModuleName, authtypes.ModuleName, banktypes.ModuleName, distrtypes.ModuleName, stakingtypes.ModuleName,
 		slashingtypes.ModuleName, govtypes.ModuleName, minttypes.ModuleName, crisistypes.ModuleName,
-		ibchost.ModuleName, genutiltypes.ModuleName, evidencetypes.ModuleName, ibctransfertypes.ModuleName,
+		ibchost.ModuleName,
+		gammtypes.ModuleName,
+		txfeestypes.ModuleName,
+		genutiltypes.ModuleName, evidencetypes.ModuleName, ibctransfertypes.ModuleName,
 		poolincentivestypes.ModuleName,
 		claimtypes.ModuleName,
 		incentivestypes.ModuleName,
 		epochstypes.ModuleName,
 		lockuptypes.ModuleName,
-		gammtypes.ModuleName,
 	)
 
 	app.mm.RegisterInvariants(&app.CrisisKeeper)
@@ -517,6 +532,8 @@ func NewOsmosisApp(
 		auth.NewAppModule(appCodec, app.AccountKeeper, authsims.RandomGenesisAccounts),
 		bank.NewAppModule(appCodec, app.BankKeeper, app.AccountKeeper),
 		capability.NewAppModule(appCodec, *app.CapabilityKeeper),
+		gamm.NewAppModule(appCodec, app.GAMMKeeper, app.AccountKeeper, app.BankKeeper),
+		txfees.NewAppModule(appCodec, app.TxFeesKeeper),
 		gov.NewAppModule(appCodec, app.GovKeeper, app.AccountKeeper, app.BankKeeper),
 		mint.NewAppModule(appCodec, app.MintKeeper, app.AccountKeeper),
 		slashing.NewAppModule(appCodec, app.SlashingKeeper, app.AccountKeeper, app.BankKeeper, app.StakingKeeper),
@@ -525,7 +542,6 @@ func NewOsmosisApp(
 		params.NewAppModule(app.ParamsKeeper),
 		evidence.NewAppModule(app.EvidenceKeeper),
 		ibc.NewAppModule(app.IBCKeeper),
-		gamm.NewAppModule(appCodec, app.GAMMKeeper, app.AccountKeeper, app.BankKeeper),
 		incentives.NewAppModule(appCodec, app.IncentivesKeeper, app.AccountKeeper, app.BankKeeper, app.EpochsKeeper),
 		lockup.NewAppModule(appCodec, app.LockupKeeper, app.AccountKeeper, app.BankKeeper),
 		poolincentives.NewAppModule(appCodec, app.PoolIncentivesKeeper),
@@ -547,8 +563,10 @@ func NewOsmosisApp(
 	app.SetInitChainer(app.InitChainer)
 	app.SetBeginBlocker(app.BeginBlocker)
 	app.SetAnteHandler(
-		ante.NewAnteHandler(
-			app.AccountKeeper, app.BankKeeper, ante.DefaultSigVerificationGasConsumer,
+		NewAnteHandler(
+			app.AccountKeeper, app.BankKeeper,
+			app.TxFeesKeeper, app.GAMMKeeper,
+			ante.DefaultSigVerificationGasConsumer,
 			encodingConfig.TxConfig.SignModeHandler(),
 		),
 	)

app/params/config.go

@@ -11,6 +11,8 @@ const (
 	BaseCoinUnit  = "uosmo"
 	OsmoExponent  = 6
 
+	DefaultBondDenom = BaseCoinUnit
+
 	// Bech32PrefixAccAddr defines the Bech32 prefix of an account's address
 	Bech32PrefixAccAddr = "osmo"
 )

go.mod

@@ -3,7 +3,7 @@ module github.com/osmosis-labs/osmosis
 go 1.17
 
 require (
-	github.com/cosmos/cosmos-sdk v0.42.9
+	github.com/cosmos/cosmos-sdk v0.44.3
 	github.com/cosmos/go-bip39 v1.0.0
 	github.com/cosmos/iavl v0.16.0
 	github.com/gogo/protobuf v1.3.3
@@ -110,7 +110,7 @@ require (
 )
 
 replace (
-	github.com/cosmos/cosmos-sdk => github.com/osmosis-labs/cosmos-sdk v0.42.10-0.20211008194120-d0e63ff7691b
+	github.com/cosmos/cosmos-sdk => github.com/osmosis-labs/cosmos-sdk v0.42.10-0.20211023185410-6c7920d1c005
 	github.com/gogo/protobuf => github.com/regen-network/protobuf v1.3.3-alpha.regen.1
 	github.com/tendermint/tendermint => github.com/tendermint/tendermint v0.34.14
 	github.com/tendermint/tm-db => github.com/osmosis-labs/tm-db v0.6.5-0.20210911033928-ba9154613417

go.sum

@@ -438,8 +438,8 @@ github.com/openzipkin/zipkin-go v0.2.1/go.mod h1:NaW6tEwdmWMaCDZzg8sh+IBNOxHMPnh
 github.com/openzipkin/zipkin-go v0.2.2/go.mod h1:NaW6tEwdmWMaCDZzg8sh+IBNOxHMPnhQw8ySjnjRyN4=
 github.com/ory/dockertest v3.3.5+incompatible h1:iLLK6SQwIhcbrG783Dghaaa3WPzGc+4Emza6EbVUUGA=
 github.com/ory/dockertest v3.3.5+incompatible/go.mod h1:1vX4m9wsvi00u5bseYwXaSnhNrne+V0E6LAcBILJdPs=
-github.com/osmosis-labs/cosmos-sdk v0.42.10-0.20211008194120-d0e63ff7691b h1:kt2khOeVohgBMYoSq1ZCjkzQXstQMH2Fsdn+3zaDHNs=
-github.com/osmosis-labs/cosmos-sdk v0.42.10-0.20211008194120-d0e63ff7691b/go.mod h1:QByRyM6mubdL7o30ZuJTFWT2cwjmT+GT19XSYwyS7pc=
+github.com/osmosis-labs/cosmos-sdk v0.42.10-0.20211023185410-6c7920d1c005 h1:4Gl0RcWXDWUhhWpGqN/InSUtRCo/Sv4Gpm9yWcBMa7Y=
+github.com/osmosis-labs/cosmos-sdk v0.42.10-0.20211023185410-6c7920d1c005/go.mod h1:QByRyM6mubdL7o30ZuJTFWT2cwjmT+GT19XSYwyS7pc=
 github.com/osmosis-labs/tm-db v0.6.5-0.20210911033928-ba9154613417 h1:otchJDd2SjFWfs7Tse3ULblGcVWqMJ50BE02XCaqXOo=
 github.com/osmosis-labs/tm-db v0.6.5-0.20210911033928-ba9154613417/go.mod h1:dptYhIpJ2M5kUuenLr+Yyf3zQOv1SgBZcl8/BmWlMBw=
 github.com/otiai10/copy v1.6.0 h1:IinKAryFFuPONZ7cm6T6E2QX/vcJwSnlaA5lfoaXIiQ=

proto/osmosis/gamm/v1beta1/genesis.proto

@@ -8,20 +8,19 @@ import "cosmos/base/v1beta1/coin.proto";
 
 // Params holds parameters for the incentives module
 message Params {
-    repeated cosmos.base.v1beta1.Coin pool_creation_fee = 1 [
-        (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
-        (gogoproto.moretags) = "yaml:\"pool_creation_fee\"",
-        (gogoproto.nullable) = false
-    ];
+  repeated cosmos.base.v1beta1.Coin pool_creation_fee = 1 [
+    (gogoproto.castrepeated) = "github.com/cosmos/cosmos-sdk/types.Coins",
+    (gogoproto.moretags) = "yaml:\"pool_creation_fee\"",
+    (gogoproto.nullable) = false
+  ];
 }
 
-
 option go_package = "github.com/osmosis-labs/osmosis/x/gamm/types";
 
 // GenesisState defines the gamm module's genesis state.
 message GenesisState {
-    repeated google.protobuf.Any pools = 1
-        [ (cosmos_proto.accepts_interface) = "PoolI" ];
-    uint64 next_pool_number = 2;
-    Params params = 3 [ (gogoproto.nullable) = false ];
+  repeated google.protobuf.Any pools = 1
+      [ (cosmos_proto.accepts_interface) = "PoolI" ];
+  uint64 next_pool_number = 2;
+  Params params = 3 [ (gogoproto.nullable) = false ];
 }

proto/osmosis/store/v1beta1/tree.proto

@@ -6,9 +6,7 @@ import "cosmos/base/v1beta1/coin.proto";
 
 option go_package = "github.com/osmosis-labs/osmosis/store";
 
-message Node {
-  repeated Child children = 1;
-}
+message Node { repeated Child children = 1; }
 
 message Child {
   bytes index = 1;
@@ -18,6 +16,4 @@ message Child {
   ];
 }
 
-message Leaf {
-  Child leaf = 1;
-}
+message Leaf { Child leaf = 1; }

proto/osmosis/txfees/v1beta1/feetoken.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+package osmosis.txfees.v1beta1;
+
+import "gogoproto/gogo.proto";
+
+option go_package = "github.com/osmosis-labs/osmosis/x/txfees/types";
+
+// FeeToken is a struct that specifies a coin denom, and pool ID pair.
+// This marks the token as eligible for use as a tx fee asset in Osmosis.
+// Its price in osmo is derived through looking at the provided pool ID.
+// The pool ID must have osmo as one of its assets.
+message FeeToken {
+  option (gogoproto.equal) = true;
+
+  string denom = 1 [ (gogoproto.moretags) = "yaml:\"denom\"" ];
+  uint64 poolID = 2 [ (gogoproto.moretags) = "yaml:\"pool_id\"" ];
+}

proto/osmosis/txfees/v1beta1/genesis.proto

@@ -0,0 +1,13 @@
+syntax = "proto3";
+package osmosis.txfees.v1beta1;
+
+import "gogoproto/gogo.proto";
+import "osmosis/txfees/v1beta1/feetoken.proto";
+
+option go_package = "github.com/osmosis-labs/osmosis/x/txfees/types";
+
+// GenesisState defines the txfees module's genesis state.
+message GenesisState {
+  string basedenom = 1;
+  repeated FeeToken feetokens = 2 [ (gogoproto.nullable) = false ];
+}

proto/osmosis/txfees/v1beta1/gov.proto

@@ -0,0 +1,25 @@
+syntax = "proto3";
+package osmosis.txfees.v1beta1;
+
+import "gogoproto/gogo.proto";
+import "osmosis/txfees/v1beta1/feetoken.proto";
+
+option go_package = "github.com/osmosis-labs/osmosis/x/txfees/types";
+
+// UpdateFeeTokenProposal is a gov Content type for adding a new whitelisted fee
+// token. It must specify a denom along with gamm pool ID to use as a spot price
+// calculator. It can be used to add a new denom to the whitelist It can also be
+// used to update the Pool to associate with the denom. If Pool ID is set to 0,
+// it will remove the denom from the whitelisted set.
+message UpdateFeeTokenProposal {
+  option (gogoproto.equal) = true;
+  option (gogoproto.goproto_getters) = false;
+  option (gogoproto.goproto_stringer) = false;
+
+  string title = 1 [ (gogoproto.moretags) = "yaml:\"title\"" ];
+  string description = 2 [ (gogoproto.moretags) = "yaml:\"description\"" ];
+  FeeToken feetoken = 3 [
+    (gogoproto.moretags) = "yaml:\"fee_token\"",
+    (gogoproto.nullable) = false
+  ];
+}

proto/osmosis/txfees/v1beta1/query.proto

@@ -0,0 +1,49 @@
+syntax = "proto3";
+package osmosis.txfees.v1beta1;
+
+import "gogoproto/gogo.proto";
+import "google/api/annotations.proto";
+import "google/protobuf/duration.proto";
+
+import "osmosis/txfees/v1beta1/feetoken.proto";
+
+option go_package = "github.com/osmosis-labs/osmosis/x/txfees/types";
+
+service Query {
+  // FeeTokens returns a list of all the whitelisted fee tokens and their
+  // corresponding pools It does not include the BaseDenom, which has its own
+  // query endpoint
+  rpc FeeTokens(QueryFeeTokensRequest) returns (QueryFeeTokensResponse) {
+    option (google.api.http).get = "/osmosis/txfees/v1beta1/fee_tokens";
+  }
+
+  rpc DenomPoolId(QueryDenomPoolIdRequest) returns (QueryDenomPoolIdResponse) {
+    option (google.api.http).get =
+        "/osmosis/txfees/v1beta1/denom_pool_id/{denom}";
+  }
+
+  rpc BaseDenom(QueryBaseDenomRequest) returns (QueryBaseDenomResponse) {
+    option (google.api.http).get = "/osmosis/txfees/v1beta1/base_denom";
+  }
+}
+
+message QueryFeeTokensRequest {}
+message QueryFeeTokensResponse {
+
+  repeated FeeToken fee_tokens = 1 [
+    (gogoproto.moretags) = "yaml:\"fee_tokens\"",
+    (gogoproto.nullable) = false
+  ];
+}
+
+message QueryDenomPoolIdRequest {
+  string denom = 1 [ (gogoproto.moretags) = "yaml:\"denom\"" ];
+}
+message QueryDenomPoolIdResponse {
+  uint64 poolID = 1 [ (gogoproto.moretags) = "yaml:\"pool_id\"" ];
+}
+
+message QueryBaseDenomRequest {}
+message QueryBaseDenomResponse {
+  string base_denom = 1 [ (gogoproto.moretags) = "yaml:\"base_denom\"" ];
+}

x/gamm/types/pool_test.go

@@ -115,14 +115,14 @@ func TestPoolUpdatePoolAssetBalance(t *testing.T) {
 	// create a different pool each time.
 	pacc_internal := pacc.(*Pool)
 
-	err = pacc_internal.setInitialPoolAssets([]PoolAsset{PoolAsset{
+	err = pacc_internal.setInitialPoolAssets([]PoolAsset{{
 		Weight: sdk.NewInt(-1),
 		Token:  sdk.NewCoin("negativeWeight", sdk.NewInt(50000)),
 	}})
 
 	require.Error(t, err)
 
-	err = pacc_internal.setInitialPoolAssets([]PoolAsset{PoolAsset{
+	err = pacc_internal.setInitialPoolAssets([]PoolAsset{{
 		Weight: sdk.NewInt(0),
 		Token:  sdk.NewCoin("zeroWeight", sdk.NewInt(50000)),
 	}})

x/mint/keeper/keeper.go

@@ -55,6 +55,7 @@ func NewKeeper(
 func (k Keeper) CreateDeveloperVestingModuleAccount(ctx sdk.Context, amount sdk.Coin) {
 	moduleAcc := authtypes.NewEmptyModuleAccount(
 		types.DeveloperVestingModuleAcctName, authtypes.Minter)
+
 	k.accountKeeper.SetModuleAccount(ctx, moduleAcc)
 
 	err := k.bankKeeper.MintCoins(ctx, types.DeveloperVestingModuleAcctName, sdk.NewCoins(amount))