Auto-swap non-osmo tx fees to osmo

app/ante.go

@@ -31,6 +31,7 @@ func NewAnteHandler(
 ) sdk.AnteHandler {
 	mempoolFeeOptions := txfeestypes.NewMempoolFeeOptions(appOpts)
 	mempoolFeeDecorator := txfeeskeeper.NewMempoolFeeDecorator(*txFeesKeeper, mempoolFeeOptions)
+	deductFeeDecorator := txfeeskeeper.NewDeductFeeDecorator(*txFeesKeeper, ak, bankKeeper, nil)
 	return sdk.ChainAnteDecorators(
 		ante.NewSetUpContextDecorator(), // outermost AnteDecorator. SetUpContext must be called first
 		wasmkeeper.NewLimitSimulationGasDecorator(wasmConfig.SimulationGasLimit),
@@ -43,7 +44,7 @@ func NewAnteHandler(
 		ante.TxTimeoutHeightDecorator{},
 		ante.NewValidateMemoDecorator(ak),
 		ante.NewConsumeGasForTxSizeDecorator(ak),
-		ante.NewDeductFeeDecorator(ak, bankKeeper, nil),
+		deductFeeDecorator,
 		ante.NewSetPubKeyDecorator(ak), // SetPubKeyDecorator must be called before all signature verification decorators
 		ante.NewValidateSigCountDecorator(ak),
 		ante.NewSigGasConsumeDecorator(ak, sigGasConsumer),

app/keepers.go

@@ -56,6 +56,9 @@ import (
 	stakingkeeper "github.com/cosmos/cosmos-sdk/x/staking/keeper"
 	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
 
+	// Staking: Allows the Tendermint validator set to be chosen based on bonded stake.
+	feegrantkeeper "github.com/cosmos/cosmos-sdk/x/feegrant/keeper"
+
 	// Upgrade:  Software upgrades handling and coordination.
 	"github.com/cosmos/cosmos-sdk/x/upgrade"
 	upgradekeeper "github.com/cosmos/cosmos-sdk/x/upgrade/keeper"
@@ -158,6 +161,7 @@ type appKeepers struct {
 	MintKeeper           *mintkeeper.Keeper
 	PoolIncentivesKeeper *poolincentiveskeeper.Keeper
 	TxFeesKeeper         *txfeeskeeper.Keeper
+	FeeGrantKeeper 		 *feegrantkeeper.Keeper
 	SuperfluidKeeper     *superfluidkeeper.Keeper
 	GovKeeper            *govkeeper.Keeper
 	WasmKeeper           *wasm.Keeper
@@ -358,13 +362,28 @@ func (app *OsmosisApp) InitNormalKeepers(
 	)
 	app.PoolIncentivesKeeper = &poolIncentivesKeeper
 
+	// Note: gammKeeper is expected to satisfy the SpotPriceCalculator interface parameter
 	txFeesKeeper := txfeeskeeper.NewKeeper(
 		appCodec,
+		app.AccountKeeper,
+		app.BankKeeper,
+		app.EpochsKeeper,
 		keys[txfeestypes.StoreKey],
 		app.GAMMKeeper,
+		app.GAMMKeeper,
+		txfeestypes.FeeCollectorName,
+		txfeestypes.FooCollectorName,
 	)
 	app.TxFeesKeeper = &txFeesKeeper
 
+	// Note: gammKeeper is expected to satisfy the SpotPriceCalculator interface parameter
+	feeGrantKeeper := feegrantkeeper.NewKeeper(
+		appCodec,
+		keys[txfeestypes.StoreKey],
+		app.AccountKeeper,
+	)
+	app.FeeGrantKeeper = &feeGrantKeeper
+
 	// The last arguments can contain custom message handlers, and custom query handlers,
 	// if we want to allow any custom callbacks
 	supportedFeatures := "iterator,staking,stargate"
@@ -465,6 +484,7 @@ func (app *OsmosisApp) SetupHooks() {
 	app.EpochsKeeper.SetHooks(
 		epochstypes.NewMultiEpochHooks(
 			// insert epoch hooks receivers here
+			app.TxFeesKeeper.Hooks(),
 			app.SuperfluidKeeper.Hooks(),
 			app.IncentivesKeeper.Hooks(),
 			app.MintKeeper.Hooks(),

app/modules.go

@@ -186,6 +186,7 @@ var moduleAaccountPermissions = map[string][]string{
 	poolincentivestypes.ModuleName:           nil,
 	superfluidtypes.ModuleName:               {authtypes.Minter, authtypes.Burner},
 	txfeestypes.ModuleName:                   nil,
+	txfeestypes.FooCollectorName:             nil,
 	wasm.ModuleName:                          {authtypes.Burner},
 }
 

x/txfees/keeper/feedecorator.go

@@ -1,11 +1,15 @@
 package keeper
 
 import (
+	"fmt"
+
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 
 	"github.com/osmosis-labs/osmosis/v7/x/txfees/keeper/txfee_filters"
 	"github.com/osmosis-labs/osmosis/v7/x/txfees/types"
+
+	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
 )
 
 // MempoolFeeDecorator will check if the transaction's fee is at least as large
@@ -119,3 +123,120 @@ func (mfd MempoolFeeDecorator) GetMinBaseGasPriceForTx(ctx sdk.Context, baseDeno
 	}
 	return cfgMinGasPrice
 }
+
+// DeductFeeDecorator deducts fees from the first signer of the tx.
+// If the first signer does not have the funds to pay for the fees, we return an InsufficientFunds error.
+// We call next AnteHandler if fees successfully deducted.
+//
+// CONTRACT: Tx must implement FeeTx interface to use DeductFeeDecorator
+type DeductFeeDecorator struct {
+	ak             types.AccountKeeper
+	bankKeeper     types.BankKeeper
+	feegrantKeeper types.FeegrantKeeper
+	txFeesKeeper   Keeper
+}
+
+func NewDeductFeeDecorator(tk Keeper, ak types.AccountKeeper, bk types.BankKeeper, fk types.FeegrantKeeper) DeductFeeDecorator {
+	return DeductFeeDecorator{
+		ak:             ak,
+		bankKeeper:     bk,
+		feegrantKeeper: fk,
+		txFeesKeeper: tk,
+	}
+}
+
+func (dfd DeductFeeDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (newCtx sdk.Context, err error) {
+
+	feeTx, ok := tx.(sdk.FeeTx)
+	if !ok {
+		return ctx, sdkerrors.Wrap(sdkerrors.ErrTxDecode, "Tx must be a FeeTx")
+	}
+
+	// checks to make sure the module account has been set to collect fees in OSMO
+	if addr := dfd.ak.GetModuleAddress(types.FeeCollectorName); addr == nil {
+		return ctx, fmt.Errorf("Fee collector module account (%s) has not been set", types.FeeCollectorName)
+	}
+
+	// checks to make sure a separate module account has been set to collect fees not in OSMO
+	if addrFoo := dfd.ak.GetModuleAddress(types.FooCollectorName); addrFoo == nil {
+		return ctx, fmt.Errorf("Foo collector module account (%s) has not been set", types.FooCollectorName)
+	}
+
+	// fee can be in any denom (checked for validity later)
+	fee := feeTx.GetFee()
+	feePayer := feeTx.FeePayer()
+	feeGranter := feeTx.FeeGranter()
+
+	// set the fee payer as the default address to deduct fees from
+	deductFeesFrom := feePayer
+
+	// If a fee granter was set, deduct fee from the fee granter's account.
+	if feeGranter != nil {
+		if dfd.feegrantKeeper == nil {
+			return ctx, sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "fee grants is not enabled")
+		} else if !feeGranter.Equals(feePayer) {
+			err := dfd.feegrantKeeper.UseGrantedFees(ctx, feeGranter, feePayer, fee, tx.GetMsgs())
+
+			if err != nil {
+				return ctx, sdkerrors.Wrapf(err, "%s not allowed to pay fees from %s", feeGranter, feePayer)
+			}
+		}
+
+		// if no errors, change the account that is charged for fees to the fee granter
+		deductFeesFrom = feeGranter
+	}
+
+	deductFeesFromAcc := dfd.ak.GetAccount(ctx, deductFeesFrom)
+	if deductFeesFromAcc == nil {
+		return ctx, sdkerrors.Wrapf(sdkerrors.ErrUnknownAddress, "fee payer address: %s does not exist", deductFeesFrom)
+	}
+
+	// deducts the fees and transfer them to the module account
+	if !feeTx.GetFee().IsZero() {
+		err = DeductFees(dfd.txFeesKeeper, dfd.bankKeeper, ctx, deductFeesFromAcc, feeTx.GetFee())
+		if err != nil {
+			return ctx, err
+		}
+	}
+
+	events := sdk.Events{sdk.NewEvent(sdk.EventTypeTx,
+		sdk.NewAttribute(sdk.AttributeKeyFee, feeTx.GetFee().String()),
+	)}
+	ctx.EventManager().EmitEvents(events)
+
+	return next(ctx, tx, simulate)
+}
+
+// DeductFees deducts fees from the given account and transfers them to the set module account.
+func DeductFees(txFeesKeeper types.TxFeesKeeper, bankKeeper types.BankKeeper, ctx sdk.Context, acc authtypes.AccountI, fees sdk.Coins) error {
+
+	// Checks the validity of the fee tokens (sorted, have positive amount, valid and unique denomination)
+	if !fees.IsValid() {
+		return sdkerrors.Wrapf(sdkerrors.ErrInsufficientFee, "invalid fee amount: %s", fees)
+	}
+
+	// pulls base denom from TxFeesKeeper (should be uOSMO)
+	baseDenom, err := txFeesKeeper.GetBaseDenom(ctx)
+	if err != nil {
+		return err
+	}
+
+	// checks if input fee is uOSMO (assumes only one fee token exists in the fees array (as per the check in mempoolFeeDecorator))
+	if fees[0].Denom == baseDenom {
+
+		// sends to FeeCollectorName module account
+		err := bankKeeper.SendCoinsFromAccountToModule(ctx, acc.GetAddress(), types.FeeCollectorName, fees)
+		if err != nil {
+			return sdkerrors.Wrapf(sdkerrors.ErrInsufficientFunds, err.Error())
+		}
+	} else {
+
+		// sends to FooCollectorName module account
+		err := bankKeeper.SendCoinsFromAccountToModule(ctx, acc.GetAddress(), types.FooCollectorName, fees)
+		if err != nil {
+			return sdkerrors.Wrapf(sdkerrors.ErrInsufficientFunds, err.Error())
+		}
+	}
+
+	return nil
+}

x/txfees/keeper/feedecorator_test.go

@@ -12,6 +12,22 @@ import (
 func (suite *KeeperTestSuite) TestFeeDecorator() {
 	suite.SetupTest(false)
 
+	/*
+	// Note: gammKeeper is expected to satisfy the SpotPriceCalculator interface parameter
+	txFeesKeeper := txfeeskeeper.NewKeeper(
+		appCodec,
+		suite.app.AccountKeeper,
+		suite.app.BankKeeper,
+		suite.app.EpochsKeeper,
+		keys[txfeestypes.StoreKey],
+		app.GAMMKeeper,
+		app.GAMMKeeper,
+		txfeestypes.FeeCollectorName,
+		txfeestypes.FooCollectorName,
+	)
+	app.TxFeesKeeper = &txFeesKeeper
+	*/
+
 	mempoolFeeOpts := types.NewDefaultMempoolFeeOptions()
 	mempoolFeeOpts.MinGasPriceForHighGasTx = sdk.MustNewDecFromStr("0.0025")
 	baseDenom, _ := suite.app.TxFeesKeeper.GetBaseDenom(suite.ctx)
@@ -31,6 +47,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 		gasRequested uint64
 		isCheckTx    bool
 		expectPass   bool
+		baseDenomGas bool
 	}{
 		{
 			name:         "no min gas price - checktx",
@@ -39,6 +56,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: 10000,
 			isCheckTx:    true,
 			expectPass:   true,
+			baseDenomGas: true,
 		},
 		{
 			name:         "no min gas price - delivertx",
@@ -47,6 +65,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: 10000,
 			isCheckTx:    false,
 			expectPass:   true,
+			baseDenomGas: true,
 		},
 		{
 			name:  "works with valid basedenom fee",
@@ -56,6 +75,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: 10000,
 			isCheckTx:    true,
 			expectPass:   true,
+			baseDenomGas: true,
 		},
 		{
 			name:  "doesn't work with not enough fee in checktx",
@@ -65,6 +85,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: 10000,
 			isCheckTx:    true,
 			expectPass:   false,
+			baseDenomGas: true,
 		},
 		{
 			name:  "works with not enough fee in delivertx",
@@ -74,6 +95,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: 10000,
 			isCheckTx:    false,
 			expectPass:   true,
+			baseDenomGas: true,
 		},
 		{
 			name:  "works with valid converted fee",
@@ -83,6 +105,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: 10000,
 			isCheckTx:    true,
 			expectPass:   true,
+			baseDenomGas: false,
 		},
 		{
 			name:  "doesn't work with not enough converted fee in checktx",
@@ -92,6 +115,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: 10000,
 			isCheckTx:    true,
 			expectPass:   false,
+			baseDenomGas: false,
 		},
 		{
 			name:  "works with not enough converted fee in delivertx",
@@ -101,6 +125,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: 10000,
 			isCheckTx:    false,
 			expectPass:   true,
+			baseDenomGas: false,
 		},
 		{
 			name:         "multiple fee coins - checktx",
@@ -109,6 +134,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: 10000,
 			isCheckTx:    true,
 			expectPass:   false,
+			baseDenomGas: false,
 		},
 		{
 			name:         "multiple fee coins - delivertx",
@@ -117,6 +143,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: 10000,
 			isCheckTx:    false,
 			expectPass:   false,
+			baseDenomGas: false,
 		},
 		{
 			name:         "invalid fee denom",
@@ -125,6 +152,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: 10000,
 			isCheckTx:    false,
 			expectPass:   false,
+			baseDenomGas: false,
 		},
 		{
 			name:         "mingasprice not containing basedenom gets treated as min gas price 0",
@@ -133,6 +161,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: 10000,
 			isCheckTx:    true,
 			expectPass:   true,
+			baseDenomGas: false,
 		},
 		{
 			name:         "tx with gas wanted more than allowed should not pass",
@@ -141,6 +170,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: mempoolFeeOpts.MaxGasWantedPerTx + 1,
 			isCheckTx:    true,
 			expectPass:   false,
+			baseDenomGas: false,
 		},
 		{
 			name:         "tx with high gas and not enough fee should no pass",
@@ -149,6 +179,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: mempoolFeeOpts.HighGasTxThreshold,
 			isCheckTx:    true,
 			expectPass:   false,
+			baseDenomGas: false,
 		},
 		{
 			name:         "tx with high gas and enough fee should pass",
@@ -157,6 +188,7 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 			gasRequested: mempoolFeeOpts.HighGasTxThreshold,
 			isCheckTx:    true,
 			expectPass:   true,
+			baseDenomGas: false,
 		},
 	}
 
@@ -171,9 +203,29 @@ func (suite *KeeperTestSuite) TestFeeDecorator() {
 		), []legacytx.StdSignature{}, "")
 
 		mfd := keeper.NewMempoolFeeDecorator(*suite.app.TxFeesKeeper, mempoolFeeOpts)
-		antehandler := sdk.ChainAnteDecorators(mfd)
-		_, err := antehandler(suite.ctx, tx, false)
+		antehandlerMFD := sdk.ChainAnteDecorators(mfd)
+		_, err := antehandlerMFD(suite.ctx, tx, false)
+		if tc.expectPass {
+			suite.Require().NoError(err, "test: %s", tc.name)
+		} else {
+			suite.Require().Error(err, "test: %s", tc.name)
+		}
+
+		// DeductFeeDecorator tests:
+
+		// Does FeeGrantKeeper need to be added to the TxFeesKeeper struct?
+
+		dfd := keeper.NewDeductFeeDecorator(*suite.app.TxFeesKeeper, *suite.app.AccountKeeper, *suite.app.BankKeeper, *suite.app.FeeGrantKeeper)
+		antehandlerDFD := sdk.ChainAnteDecorators(dfd)
+		_, err = antehandlerDFD(suite.ctx, tx, false)
 		if tc.expectPass {
+			if tc.baseDenomGas {
+				// check main module account osmo balance & require no non-OSMO
+				// also require that the balance of the second module account (just get AllBalances) has not changed (suite.Require().Equalf(123, 123, "error message %s", "formatted"))
+			} else {
+				// check second module account to make sure the right fee amount has flowed there
+				// also require that the balance of the main module account (just get AllBalances) has not changed (suite.Require().Equalf(123, 123, "error message %s", "formatted"))
+			}
 			suite.Require().NoError(err, "test: %s", tc.name)
 		} else {
 			suite.Require().Error(err, "test: %s", tc.name)