This repository has been archived by the owner on Apr 4, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 569
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat!: Apply feemarket to native cosmos tx (#1194)
* Problem: feemarket's query cli has redundant height parameter Soluton: - remove the positional height parameter, since there's a flag already. Update CHANGELOG.md * Apply feemarket to native cosmos tx - add tx extension option for user to input tip price - apply feemarket's base fee to native tx comments and cleanup fallback to default sdk logic when london hardfork not enabled integration test cleanup feemarket query cli commands Update CHANGELOG.md update unit tests disable feemarket in simulation tests for now fix lint Update app/simulation_test.go fix python lint fix lint Update x/evm/types/extension_option.go Co-authored-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com> address review suggestions * fix unit tests * fix integration test * improve unit test coverage * fix go lint * refactor * fix integration test * fix simulation tests * fix go linter Co-authored-by: Federico Kunze Küllmer <31522760+fedekunze@users.noreply.github.com>
- Loading branch information
Showing
24 changed files
with
1,785 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| package ante | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "math" | ||
|
|
||
| sdkmath "cosmossdk.io/math" | ||
|
|
||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| sdkerrors "github.com/cosmos/cosmos-sdk/types/errors" | ||
| authante "github.com/cosmos/cosmos-sdk/x/auth/ante" | ||
| ethermint "github.com/evmos/ethermint/types" | ||
| "github.com/evmos/ethermint/x/evm/types" | ||
| ) | ||
|
|
||
| // NewDynamicFeeChecker returns a `TxFeeChecker` that applies a dynamic fee to | ||
| // Cosmos txs using the EIP-1559 fee market logic. | ||
| // This can be called in both CheckTx and deliverTx modes. | ||
| // a) feeCap = tx.fees / tx.gas | ||
| // b) tipFeeCap = tx.MaxPriorityPrice (default) or MaxInt64 | ||
| // - when `ExtensionOptionDynamicFeeTx` is omitted, `tipFeeCap` defaults to `MaxInt64`. | ||
| // - when london hardfork is not enabled, it fallbacks to SDK default behavior (validator min-gas-prices). | ||
| // - Tx priority is set to `effectiveGasPrice / DefaultPriorityReduction`. | ||
| func NewDynamicFeeChecker(k DynamicFeeEVMKeeper) authante.TxFeeChecker { | ||
| return func(ctx sdk.Context, tx sdk.Tx) (sdk.Coins, int64, error) { | ||
| feeTx, ok := tx.(sdk.FeeTx) | ||
| if !ok { | ||
| return nil, 0, fmt.Errorf("tx must be a FeeTx") | ||
| } | ||
|
|
||
| if ctx.BlockHeight() == 0 { | ||
| // genesis transactions: fallback to min-gas-price logic | ||
| return checkTxFeeWithValidatorMinGasPrices(ctx, feeTx) | ||
| } | ||
|
|
||
| params := k.GetParams(ctx) | ||
| denom := params.EvmDenom | ||
| ethCfg := params.ChainConfig.EthereumConfig(k.ChainID()) | ||
|
|
||
| baseFee := k.GetBaseFee(ctx, ethCfg) | ||
| if baseFee == nil { | ||
| // london hardfork is not enabled: fallback to min-gas-prices logic | ||
| return checkTxFeeWithValidatorMinGasPrices(ctx, feeTx) | ||
| } | ||
|
|
||
| // default to `MaxInt64` when there's no extension option. | ||
| maxPriorityPrice := sdkmath.NewInt(math.MaxInt64) | ||
|
|
||
| // get the priority tip cap from the extension option. | ||
| if hasExtOptsTx, ok := tx.(authante.HasExtensionOptionsTx); ok { | ||
| for _, opt := range hasExtOptsTx.GetExtensionOptions() { | ||
| if extOpt, ok := opt.GetCachedValue().(*ethermint.ExtensionOptionDynamicFeeTx); ok { | ||
| maxPriorityPrice = extOpt.MaxPriorityPrice | ||
| break | ||
| } | ||
| } | ||
| } | ||
|
|
||
| gas := feeTx.GetGas() | ||
| feeCoins := feeTx.GetFee() | ||
| fee := feeCoins.AmountOfNoDenomValidation(denom) | ||
|
|
||
| feeCap := fee.Quo(sdkmath.NewIntFromUint64(gas)) | ||
| baseFeeInt := sdkmath.NewIntFromBigInt(baseFee) | ||
|
|
||
| if feeCap.LT(baseFeeInt) { | ||
| return nil, 0, sdkerrors.Wrapf(sdkerrors.ErrInsufficientFee, "insufficient gas prices; got: %s required: %s", feeCap, baseFeeInt) | ||
| } | ||
|
|
||
| // calculate the effective gas price using the EIP-1559 logic. | ||
| effectivePrice := sdkmath.NewIntFromBigInt(types.EffectiveGasPrice(baseFeeInt.BigInt(), feeCap.BigInt(), maxPriorityPrice.BigInt())) | ||
|
|
||
| // NOTE: create a new coins slice without having to validate the denom | ||
| effectiveFee := sdk.Coins{ | ||
| { | ||
| Denom: denom, | ||
| Amount: effectivePrice.Mul(sdkmath.NewIntFromUint64(gas)), | ||
| }, | ||
| } | ||
|
|
||
| bigPriority := effectivePrice.Sub(baseFeeInt).Quo(types.DefaultPriorityReduction) | ||
| priority := int64(math.MaxInt64) | ||
|
|
||
| if bigPriority.IsInt64() { | ||
| priority = bigPriority.Int64() | ||
| } | ||
|
|
||
| return effectiveFee, priority, nil | ||
| } | ||
| } | ||
|
|
||
| // checkTxFeeWithValidatorMinGasPrices implements the default fee logic, where the minimum price per | ||
| // unit of gas is fixed and set by each validator, and the tx priority is computed from the gas price. | ||
| func checkTxFeeWithValidatorMinGasPrices(ctx sdk.Context, tx sdk.FeeTx) (sdk.Coins, int64, error) { | ||
| feeCoins := tx.GetFee() | ||
| gas := tx.GetGas() | ||
| minGasPrices := ctx.MinGasPrices() | ||
|
|
||
| // Ensure that the provided fees meet a minimum threshold for the validator, | ||
| // if this is a CheckTx. This is only for local mempool purposes, and thus | ||
| // is only ran on check tx. | ||
| if ctx.IsCheckTx() && !minGasPrices.IsZero() { | ||
| requiredFees := make(sdk.Coins, len(minGasPrices)) | ||
|
|
||
| // Determine the required fees by multiplying each required minimum gas | ||
| // price by the gas limit, where fee = ceil(minGasPrice * gasLimit). | ||
| glDec := sdk.NewDec(int64(gas)) | ||
|
|
||
| for i, gp := range minGasPrices { | ||
| fee := gp.Amount.Mul(glDec) | ||
| requiredFees[i] = sdk.NewCoin(gp.Denom, fee.Ceil().RoundInt()) | ||
| } | ||
|
|
||
| if !feeCoins.IsAnyGTE(requiredFees) { | ||
| return nil, 0, sdkerrors.Wrapf(sdkerrors.ErrInsufficientFee, "insufficient fees; got: %s required: %s", feeCoins, requiredFees) | ||
| } | ||
| } | ||
|
|
||
| priority := getTxPriority(feeCoins) | ||
| return feeCoins, priority, nil | ||
| } | ||
|
|
||
| // getTxPriority returns a naive tx priority based on the amount of the smallest denomination of the fee | ||
| // provided in a transaction. | ||
| func getTxPriority(fees sdk.Coins) int64 { | ||
| var priority int64 | ||
|
|
||
| for _, fee := range fees { | ||
| amt := fee.Amount.Quo(types.DefaultPriorityReduction) | ||
| p := int64(math.MaxInt64) | ||
|
|
||
| if amt.IsInt64() { | ||
| p = amt.Int64() | ||
| } | ||
|
|
||
| if priority == 0 || p < priority { | ||
| priority = p | ||
| } | ||
| } | ||
|
|
||
| return priority | ||
| } |
Oops, something went wrong.