[v18] x/FeePay Module

.github/workflows/interchaintest-E2E.yml

@@ -64,6 +64,7 @@ jobs:
           - "ictest-tokenfactory"
           - "ictest-feeshare"
           - "ictest-pfm"
+          - "ictest-globalfee"
           - "ictest-upgrade"
           - "ictest-ibc"
           - "ictest-unity-deploy"

Makefile

@@ -139,6 +139,9 @@ ictest-feeshare: rm-testcache
 ictest-pfm: rm-testcache
 	cd interchaintest && go test -race -v -run TestPacketForwardMiddlewareRouter .
 
+ictest-globalfee: rm-testcache
+	cd interchaintest && go test -race -v -run TestJunoGlobalFee .
+
 # Executes a basic chain upgrade test via interchaintest
 ictest-upgrade: rm-testcache
 	cd interchaintest && go test -race -v -run TestBasicJunoUpgrade .
@@ -163,6 +166,9 @@ ictest-pob: rm-testcache
 ictest-drip: rm-testcache
 	cd interchaintest &&  go test -race -v -run TestJunoDrip .
 
+ictest-feepay: rm-testcache
+	cd interchaintest &&  go test -race -v -run TestJunoFeePay .
+
 ictest-burn: rm-testcache
 	cd interchaintest &&  go test -race -v -run TestJunoBurnModule .
 

app/ante.go

@@ -16,10 +16,13 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
 	"github.com/cosmos/cosmos-sdk/x/auth/ante"
+	bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper"
 	govkeeper "github.com/cosmos/cosmos-sdk/x/gov/keeper"
 	stakingkeeper "github.com/cosmos/cosmos-sdk/x/staking/keeper"
 
 	decorators "github.com/CosmosContracts/juno/v18/app/decorators"
+	feepayante "github.com/CosmosContracts/juno/v18/x/feepay/ante"
+	feepaykeeper "github.com/CosmosContracts/juno/v18/x/feepay/keeper"
 	feeshareante "github.com/CosmosContracts/juno/v18/x/feeshare/ante"
 	feesharekeeper "github.com/CosmosContracts/juno/v18/x/feeshare/keeper"
 	globalfeeante "github.com/CosmosContracts/juno/v18/x/globalfee/ante"
@@ -36,8 +39,9 @@ type HandlerOptions struct {
 
 	GovKeeper         govkeeper.Keeper
 	IBCKeeper         *ibckeeper.Keeper
+	FeePayKeeper      feepaykeeper.Keeper
 	FeeShareKeeper    feesharekeeper.Keeper
-	BankKeeperFork    feeshareante.BankKeeper
+	BankKeeper        bankkeeper.Keeper
 	TxCounterStoreKey storetypes.StoreKey
 	WasmConfig        wasmtypes.WasmConfig
 	Cdc               codec.BinaryCodec
@@ -50,6 +54,8 @@ type HandlerOptions struct {
 	BuilderKeeper builderkeeper.Keeper
 	TxEncoder     sdk.TxEncoder
 	Mempool       builderante.Mempool
+
+	BondDenom string
 }
 
 // NewAnteHandler returns an AnteHandler that checks and increments sequence
@@ -74,6 +80,7 @@ func NewAnteHandler(options HandlerOptions) (sdk.AnteHandler, error) {
 	}
 
 	anteDecorators := []sdk.AnteDecorator{
+		// GLobalFee query params for minimum fee
 		ante.NewSetUpContextDecorator(), // outermost AnteDecorator. SetUpContext must be called first
 		wasmkeeper.NewLimitSimulationGasDecorator(options.WasmConfig.SimulationGasLimit),
 		wasmkeeper.NewCountTXDecorator(options.TxCounterStoreKey),
@@ -83,9 +90,9 @@ func NewAnteHandler(options HandlerOptions) (sdk.AnteHandler, error) {
 		ante.NewTxTimeoutHeightDecorator(),
 		ante.NewValidateMemoDecorator(options.AccountKeeper),
 		ante.NewConsumeGasForTxSizeDecorator(options.AccountKeeper),
-		globalfeeante.NewFeeDecorator(options.BypassMinFeeMsgTypes, options.GlobalFeeKeeper, options.StakingKeeper, maxBypassMinFeeMsgGasUsage),
-		ante.NewDeductFeeDecorator(options.AccountKeeper, options.BankKeeper, options.FeegrantKeeper, options.TxFeeChecker),
-		feeshareante.NewFeeSharePayoutDecorator(options.BankKeeperFork, options.FeeShareKeeper),
+		globalfeeante.NewFeeDecorator(options.BypassMinFeeMsgTypes, options.GlobalFeeKeeper, options.StakingKeeper, options.FeePayKeeper, maxBypassMinFeeMsgGasUsage),
+		feepayante.NewDeductFeeDecorator(options.FeePayKeeper, options.GlobalFeeKeeper, options.AccountKeeper, options.BankKeeper, options.FeegrantKeeper, options.TxFeeChecker, options.BondDenom),
+		feeshareante.NewFeeSharePayoutDecorator(options.BankKeeper, options.FeeShareKeeper),
 		// SetPubKeyDecorator must be called before all signature verification decorators
 		ante.NewSetPubKeyDecorator(options.AccountKeeper),
 		ante.NewValidateSigCountDecorator(options.AccountKeeper),

app/app.go

@@ -276,6 +276,7 @@ func New(
 		enabledProposals,
 		appOpts,
 		wasmOpts,
+		app.GetChainBondDenom(),
 	)
 	app.keys = app.AppKeepers.GetKVStoreKey()
 
@@ -363,8 +364,9 @@ func New(
 
 			GovKeeper:         app.AppKeepers.GovKeeper,
 			IBCKeeper:         app.AppKeepers.IBCKeeper,
+			FeePayKeeper:      app.AppKeepers.FeePayKeeper,
 			FeeShareKeeper:    app.AppKeepers.FeeShareKeeper,
-			BankKeeperFork:    app.AppKeepers.BankKeeper, // since we need extra methods
+			BankKeeper:        app.AppKeepers.BankKeeper,
 			TxCounterStoreKey: app.AppKeepers.GetKey(wasmtypes.StoreKey),
 			WasmConfig:        wasmConfig,
 			Cdc:               appCodec,
@@ -376,6 +378,7 @@ func New(
 			TxEncoder:     app.txConfig.TxEncoder(),
 			BuilderKeeper: app.AppKeepers.BuildKeeper,
 			Mempool:       mempool,
+			BondDenom:     app.GetChainBondDenom(),
 		},
 	)
 	if err != nil {

app/decorators/feeprepay_poc.go.archive

@@ -0,0 +1,108 @@
+package decorators
+
+import (
+	globalfeekeeper "github.com/CosmosContracts/juno/v18/x/globalfee/keeper"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	authante "github.com/cosmos/cosmos-sdk/x/auth/ante"
+	bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper"
+	feegrantkeeper "github.com/cosmos/cosmos-sdk/x/feegrant/keeper"
+
+	errorsmod "cosmossdk.io/errors"
+)
+
+type MsgFeePrepayDecorator struct {
+	BankKeeper bankkeeper.Keeper
+	// TODO: This could be incorrect. We may need the full AuthKeeper/AccountKeeper, not just from the ante
+	AccountKeeper   authante.AccountKeeper
+	GlobalFeeKeeper globalfeekeeper.Keeper
+
+	FeeGrantKeeper feegrantkeeper.Keeper
+}
+
+func NewMsgFeePrepayDecorator(bank bankkeeper.Keeper, auth authante.AccountKeeper, globalFee globalfeekeeper.Keeper) MsgFeePrepayDecorator {
+	return MsgFeePrepayDecorator{
+		BankKeeper:      bank,
+		AccountKeeper:   auth,
+		GlobalFeeKeeper: globalFee,
+	}
+}
+
+// junod tx tokenfactory create-denom joel --fees=0ujuno --from=juno1 --home=/home/joel/.juno1 --chain-id=local-1 --keyring-backend=test -y --gas=2200000
+func (fpd MsgFeePrepayDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (newCtx sdk.Context, err error) {
+
+	ctx.Logger().Error("MsgFeePrepayDecorator", "Starting", true)
+
+	// 1. Confirm the transaction is a FeeTx
+	// 2. Calculate the total fee
+	// 3. Transfer funds to the user (either indirectly through the bank module or directly)
+	// 4. Set the new fee on the Tx
+	// 5. Continue processing as normal
+
+	// if tx is read only
+	// tx := new sdk.Tx(...tx, set the new fee)
+
+	// This may not be a FeeTx, so if error then don't exit early
+	feeTx, ok := tx.(sdk.FeeTx)
+	if !ok {
+		return ctx, errorsmod.Wrap(sdkerrors.ErrTxDecode, "Tx must implement the sdk.FeeTx interface")
+	}
+
+	// feePrePayModuleAcc := fpd.AccountKeeper.GetModuleAddress("feeprepay")
+	// fpd.FeeGrantKeeper.GrantAllowance(ctx, feePrePayModuleAcc, feeTx.FeePayer(), &feegranttypes.{})
+
+	if ctx.BlockHeight() > 0 {
+
+		// Global fee keeper params
+		p := fpd.GlobalFeeKeeper.GetParams(ctx)
+
+		// Get min juno gas
+		var minGasPrice sdk.DecCoin
+		for _, c := range p.MinimumGasPrices {
+			if c.Denom == "ujuno" {
+				minGasPrice = c
+			}
+		}
+
+		ctx.Logger().Error("MsgFeePrepayDecorator", "MinGas", minGasPrice)
+		ctx.Logger().Error("MsgFeePrepayDecorator", "FeeTx (gas)", feeTx.GetGas())
+		ctx.Logger().Error("MsgFeePrepayDecorator", "Consumed Gas", ctx.GasMeter().GasConsumed())
+
+		// Calculate gas consumed
+		consumed := ctx.GasMeter().GasConsumed()
+
+		// Determine fee by multiplying gas price by gas consumed
+		fee := minGasPrice.Amount.Mul(sdk.NewDec(int64(consumed))).RoundInt()
+
+		ctx.Logger().Error("MsgFeePrepayDecorator", "Fee", fee)
+
+		// payment := sdk.NewCoins(sdk.NewCoin("ujuno", fee))
+		payment := sdk.NewCoins(sdk.NewCoin("ujuno", sdk.NewDec(500_000).RoundInt()))
+		fpd.BankKeeper.MintCoins(ctx, "mint", payment)
+		fpd.BankKeeper.SendCoinsFromModuleToAccount(ctx, "mint", feeTx.FeePayer(), payment)
+
+		ctx.Logger().Error("MsgFeePrepayDecorator", "Minted & Sent to User", feeTx.FeePayer())
+	}
+
+	// TODOL: Thuis could give you funds and then make your next Tx successful.
+	// fpd.BankKeeper.MintCoins(ctx, "bank", coinsAmt)
+	// fpd.BankKeeper.SendCoinsFromModuleToAccount(ctx, "bank", "userAccount", coinsAmt)
+	// auto feeprepay with the TxFee or somethuing here? as an option
+	// set the Tx fee to be correct, set the accoiunt to be new and work, and then continue on
+
+	ctx.Logger().Error("MsgFeePrepayDecorator", "Finished", true)
+
+	return next(ctx, tx, simulate)
+}
+
+// TODO: Future: execute contract only.
+// func hasInvalidExecuteMsgs(msgs []sdk.Msg) bool {
+// 	for _, msg := range msgs {
+// 		if _, ok := msg.(*wasmtypes.msgExecuteContract); ok {
+// 			return true
+// 		}
+// 	}
+
+// 	return false
+// }

app/keepers/keepers.go

@@ -89,6 +89,8 @@ import (
 	cwhookstypes "github.com/CosmosContracts/juno/v18/x/cw-hooks/types"
 	dripkeeper "github.com/CosmosContracts/juno/v18/x/drip/keeper"
 	driptypes "github.com/CosmosContracts/juno/v18/x/drip/types"
+	feepaykeeper "github.com/CosmosContracts/juno/v18/x/feepay/keeper"
+	feepaytypes "github.com/CosmosContracts/juno/v18/x/feepay/types"
 	feesharekeeper "github.com/CosmosContracts/juno/v18/x/feeshare/keeper"
 	feesharetypes "github.com/CosmosContracts/juno/v18/x/feeshare/types"
 	"github.com/CosmosContracts/juno/v18/x/globalfee"
@@ -128,6 +130,7 @@ var maccPerms = map[string][]string{
 	tokenfactorytypes.ModuleName:   {authtypes.Minter, authtypes.Burner},
 	globalfee.ModuleName:           nil,
 	buildertypes.ModuleName:        nil,
+	feepaytypes.ModuleName:         nil,
 	junoburn.ModuleName:            {authtypes.Burner},
 }
 
@@ -160,6 +163,7 @@ type AppKeepers struct {
 	AuthzKeeper         authzkeeper.Keeper
 	FeeGrantKeeper      feegrantkeeper.Keeper
 	NFTKeeper           nftkeeper.Keeper
+	FeePayKeeper        feepaykeeper.Keeper
 	FeeShareKeeper      feesharekeeper.Keeper
 	GlobalFeeKeeper     globalfeekeeper.Keeper
 	ContractKeeper      *wasmkeeper.PermissionedKeeper
@@ -198,6 +202,7 @@ func NewAppKeepers(
 	enabledProposals []wasmtypes.ProposalType,
 	appOpts servertypes.AppOptions,
 	wasmOpts []wasmkeeper.Option,
+	bondDenom string,
 ) AppKeepers {
 	appKeepers := AppKeepers{}
 
@@ -543,6 +548,16 @@ func NewAppKeepers(
 		wasmOpts...,
 	)
 
+	appKeepers.FeePayKeeper = feepaykeeper.NewKeeper(
+		appKeepers.keys[feepaytypes.StoreKey],
+		appCodec,
+		&appKeepers.BankKeeper,
+		appKeepers.WasmKeeper,
+		appKeepers.AccountKeeper,
+		bondDenom,
+		govModAddress,
+	)
+
 	// set the contract keeper for the Ics20WasmHooks
 	appKeepers.ContractKeeper = wasmkeeper.NewDefaultPermissionKeeper(appKeepers.WasmKeeper)
 	appKeepers.Ics20WasmHooks.ContractKeeper = &appKeepers.WasmKeeper
@@ -731,16 +746,12 @@ func BlockedAddresses() map[string]bool {
 
 	// allow the following addresses to receive funds
 	delete(modAccAddrs, authtypes.NewModuleAddress(govtypes.ModuleName).String())
+	delete(modAccAddrs, authtypes.NewModuleAddress(feepaytypes.ModuleName).String())
 
 	return modAccAddrs
 }
 
 // GetMaccPerms returns a copy of the module account permissions
 func GetMaccPerms() map[string][]string {
-	dupMaccPerms := make(map[string][]string)
-	for k, v := range maccPerms {
-		dupMaccPerms[k] = v
-	}
-
-	return dupMaccPerms
+	return maccPerms
 }

app/keepers/keys.go

@@ -34,6 +34,7 @@ import (
 	clocktypes "github.com/CosmosContracts/juno/v18/x/clock/types"
 	cwhookstypes "github.com/CosmosContracts/juno/v18/x/cw-hooks/types"
 	driptypes "github.com/CosmosContracts/juno/v18/x/drip/types"
+	feepaytypes "github.com/CosmosContracts/juno/v18/x/feepay/types"
 	feesharetypes "github.com/CosmosContracts/juno/v18/x/feeshare/types"
 	globalfeetypes "github.com/CosmosContracts/juno/v18/x/globalfee/types"
 	minttypes "github.com/CosmosContracts/juno/v18/x/mint/types"
@@ -55,6 +56,7 @@ func (appKeepers *AppKeepers) GenerateKeys() {
 		packetforwardtypes.StoreKey,
 		ibchookstypes.StoreKey,
 		tokenfactorytypes.StoreKey,
+		feepaytypes.StoreKey,
 		feesharetypes.StoreKey,
 		globalfeetypes.StoreKey,
 		buildertypes.StoreKey,

app/modules.go

@@ -65,6 +65,8 @@ import (
 	cwhooks "github.com/CosmosContracts/juno/v18/x/cw-hooks"
 	"github.com/CosmosContracts/juno/v18/x/drip"
 	driptypes "github.com/CosmosContracts/juno/v18/x/drip/types"
+	feepay "github.com/CosmosContracts/juno/v18/x/feepay"
+	feepaytypes "github.com/CosmosContracts/juno/v18/x/feepay/types"
 	feeshare "github.com/CosmosContracts/juno/v18/x/feeshare"
 	feesharetypes "github.com/CosmosContracts/juno/v18/x/feeshare/types"
 	"github.com/CosmosContracts/juno/v18/x/globalfee"
@@ -107,6 +109,7 @@ var ModuleBasics = module.NewBasicManager(
 	feegrantmodule.AppModuleBasic{},
 	tokenfactory.AppModuleBasic{},
 	drip.AppModuleBasic{},
+	feepay.AppModuleBasic{},
 	feeshare.AppModuleBasic{},
 	globalfee.AppModuleBasic{},
 	ibc_hooks.AppModuleBasic{},
@@ -152,6 +155,7 @@ func appModules(
 		ibcfee.NewAppModule(app.AppKeepers.IBCFeeKeeper),
 		tokenfactory.NewAppModule(app.AppKeepers.TokenFactoryKeeper, app.AppKeepers.AccountKeeper, app.AppKeepers.BankKeeper, app.GetSubspace(tokenfactorytypes.ModuleName)),
 		globalfee.NewAppModule(appCodec, app.AppKeepers.GlobalFeeKeeper, bondDenom),
+		feepay.NewAppModule(app.AppKeepers.FeePayKeeper, app.AppKeepers.AccountKeeper),
 		feeshare.NewAppModule(app.AppKeepers.FeeShareKeeper, app.AppKeepers.AccountKeeper, app.GetSubspace(feesharetypes.ModuleName)),
 		wasm.NewAppModule(appCodec, &app.AppKeepers.WasmKeeper, app.AppKeepers.StakingKeeper, app.AppKeepers.AccountKeeper, app.AppKeepers.BankKeeper, app.MsgServiceRouter(), app.GetSubspace(wasmtypes.ModuleName)),
 		ica.NewAppModule(&app.AppKeepers.ICAControllerKeeper, &app.AppKeepers.ICAHostKeeper),
@@ -194,6 +198,7 @@ func simulationModules(
 		wasm.NewAppModule(appCodec, &app.AppKeepers.WasmKeeper, app.AppKeepers.StakingKeeper, app.AppKeepers.AccountKeeper, app.AppKeepers.BankKeeper, app.MsgServiceRouter(), app.GetSubspace(wasmtypes.ModuleName)),
 		ibc.NewAppModule(app.AppKeepers.IBCKeeper),
 		transfer.NewAppModule(app.AppKeepers.TransferKeeper),
+		feepay.NewAppModule(app.AppKeepers.FeePayKeeper, app.AppKeepers.AccountKeeper),
 		feeshare.NewAppModule(app.AppKeepers.FeeShareKeeper, app.AppKeepers.AccountKeeper, app.GetSubspace(feesharetypes.ModuleName)),
 		ibcfee.NewAppModule(app.AppKeepers.IBCFeeKeeper),
 	}
@@ -231,6 +236,7 @@ func orderBeginBlockers() []string {
 		icqtypes.ModuleName,
 		tokenfactorytypes.ModuleName,
 		driptypes.ModuleName,
+		feepaytypes.ModuleName,
 		feesharetypes.ModuleName,
 		globalfee.ModuleName,
 		wasmtypes.ModuleName,
@@ -270,6 +276,7 @@ func orderEndBlockers() []string {
 		icqtypes.ModuleName,
 		tokenfactorytypes.ModuleName,
 		driptypes.ModuleName,
+		feepaytypes.ModuleName,
 		feesharetypes.ModuleName,
 		globalfee.ModuleName,
 		wasmtypes.ModuleName,
@@ -309,6 +316,7 @@ func orderInitBlockers() []string {
 		icqtypes.ModuleName,
 		tokenfactorytypes.ModuleName,
 		driptypes.ModuleName,
+		feepaytypes.ModuleName,
 		feesharetypes.ModuleName,
 		globalfee.ModuleName,
 		wasmtypes.ModuleName,

app/upgrades/v18/constants.go

@@ -5,6 +5,7 @@ import (
 
 	"github.com/CosmosContracts/juno/v18/app/upgrades"
 	cwhooks "github.com/CosmosContracts/juno/v18/x/cw-hooks"
+	feepaytypes "github.com/CosmosContracts/juno/v18/x/feepay/types"
 )
 
 // UpgradeName defines the on-chain upgrade name for the upgrade.
@@ -16,6 +17,7 @@ var Upgrade = upgrades.Upgrade{
 	StoreUpgrades: store.StoreUpgrades{
 		Added: []string{
 			cwhooks.ModuleName,
+			feepaytypes.ModuleName,
 		},
 	},
 }

app/upgrades/v18/upgrades.go

@@ -10,6 +10,7 @@ import (
 	"github.com/CosmosContracts/juno/v18/app/keepers"
 	"github.com/CosmosContracts/juno/v18/app/upgrades"
 	cwhookstypes "github.com/CosmosContracts/juno/v18/x/cw-hooks/types"
+	feepaytypes "github.com/CosmosContracts/juno/v18/x/feepay/types"
 )
 
 func CreateV18UpgradeHandler(
@@ -37,6 +38,13 @@ func CreateV18UpgradeHandler(
 			return nil, err
 		}
 
+		// x/feepay
+		if err := k.FeePayKeeper.SetParams(ctx, feepaytypes.Params{
+			EnableFeepay: true,
+		}); err != nil {
+			return nil, err
+		}
+
 		return versionMap, err
 	}
 }