Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
test(evm): ante handler setup ctx coverage
- Loading branch information
1 parent
af87b51
commit a862309
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| // Copyright (c) 2023-2024 Nibi, Inc. | ||
| package app | ||
|
|
||
| import ( | ||
| "strconv" | ||
|
|
||
| errorsmod "cosmossdk.io/errors" | ||
| "github.com/NibiruChain/nibiru/x/evm" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| errortypes "github.com/cosmos/cosmos-sdk/types/errors" | ||
| ) | ||
|
|
||
| // EthEmitEventDecorator emit events in ante handler in case of tx execution failed (out of block gas limit). | ||
| type EthEmitEventDecorator struct { | ||
| AppKeepers | ||
| } | ||
|
|
||
| // NewEthEmitEventDecorator creates a new EthEmitEventDecorator | ||
| func NewEthEmitEventDecorator(k AppKeepers) EthEmitEventDecorator { | ||
| return EthEmitEventDecorator{AppKeepers: k} | ||
| } | ||
|
|
||
| // AnteHandle emits some basic events for the eth messages | ||
| func (eeed EthEmitEventDecorator) AnteHandle( | ||
| ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler, | ||
| ) (newCtx sdk.Context, err error) { | ||
| // After eth tx passed ante handler, the fee is deducted and nonce increased, | ||
| // it shouldn't be ignored by json-rpc. We need to emit some events at the | ||
| // very end of ante handler to be indexed by the consensus engine. | ||
| txIndex := eeed.EvmKeeper.EVMState().BlockTxIndex.GetOr(ctx, 0) | ||
|
|
||
| for i, msg := range tx.GetMsgs() { | ||
| msgEthTx, ok := msg.(*evm.MsgEthereumTx) | ||
| if !ok { | ||
| return ctx, errorsmod.Wrapf(errortypes.ErrUnknownRequest, "invalid message type %T, expected %T", msg, (*evm.MsgEthereumTx)(nil)) | ||
| } | ||
|
|
||
| // emit ethereum tx hash as an event so that it can be indexed by | ||
| // Tendermint for query purposes it's emitted in ante handler, so we can | ||
| // query failed transaction (out of block gas limit). | ||
| ctx.EventManager().EmitEvent(sdk.NewEvent( | ||
| evm.EventTypeEthereumTx, | ||
| sdk.NewAttribute(evm.AttributeKeyEthereumTxHash, msgEthTx.Hash), | ||
| sdk.NewAttribute(evm.AttributeKeyTxIndex, strconv.FormatUint(txIndex+uint64(i), 10)), // #nosec G701 | ||
| )) | ||
| } | ||
|
|
||
| return next(ctx, tx, simulate) | ||
| } | ||
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,42 @@ | ||
| package app_test | ||
|
|
||
| import ( | ||
| "math" | ||
|
|
||
| "github.com/NibiruChain/nibiru/app" | ||
| "github.com/NibiruChain/nibiru/x/evm/evmtest" | ||
| storetypes "github.com/cosmos/cosmos-sdk/store/types" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| ) | ||
|
|
||
| func (s *TestSuite) TestEthSetupContextDecorator() { | ||
| deps := evmtest.NewTestDeps() | ||
| stateDB := deps.StateDB() | ||
| anteDec := app.NewEthSetUpContextDecorator(deps.Chain.AppKeepers) | ||
|
|
||
| s.Require().NoError(stateDB.Commit()) | ||
| tx := happyCreateContractTx(&deps) | ||
|
|
||
| // Set block gas used to non 0 to check that handler resets it | ||
| anteDec.EvmKeeper.EvmState.BlockGasUsed.Set(deps.Ctx, 1000) | ||
|
|
||
| // Ante handler returns new context | ||
| newCtx, err := anteDec.AnteHandle( | ||
| deps.Ctx, tx, false, NextNoOpAnteHandler, | ||
| ) | ||
| s.Require().NoError(err) | ||
|
|
||
| // Check that ctx gas meter is set up to infinite | ||
| ctxGasMeter := newCtx.GasMeter() | ||
| s.Require().Equal(sdk.Gas(math.MaxUint64), ctxGasMeter.GasRemaining()) | ||
|
|
||
| // Check that gas configs are reset to default | ||
| defaultGasConfig := storetypes.GasConfig{} | ||
| s.Require().Equal(defaultGasConfig, newCtx.KVGasConfig()) | ||
| s.Require().Equal(defaultGasConfig, newCtx.TransientKVGasConfig()) | ||
|
|
||
| // Check that block gas used is reset to 0 | ||
| gas, err := anteDec.EvmKeeper.EvmState.BlockGasUsed.Get(newCtx) | ||
| s.Require().NoError(err) | ||
| s.Require().Equal(gas, uint64(0)) | ||
| } |
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,123 @@ | ||
| // Copyright (c) 2023-2024 Nibi, Inc. | ||
| package app | ||
|
|
||
| import ( | ||
| "errors" | ||
|
|
||
| errorsmod "cosmossdk.io/errors" | ||
| sdkmath "cosmossdk.io/math" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| errortypes "github.com/cosmos/cosmos-sdk/types/errors" | ||
| gethcore "github.com/ethereum/go-ethereum/core/types" | ||
|
|
||
| "github.com/NibiruChain/nibiru/x/evm" | ||
| ) | ||
|
|
||
| // EthValidateBasicDecorator is adapted from ValidateBasicDecorator from cosmos-sdk, it ignores ErrNoSignatures | ||
| type EthValidateBasicDecorator struct { | ||
| AppKeepers | ||
| } | ||
|
|
||
| // NewEthValidateBasicDecorator creates a new EthValidateBasicDecorator | ||
| func NewEthValidateBasicDecorator(k AppKeepers) EthValidateBasicDecorator { | ||
| return EthValidateBasicDecorator{ | ||
| AppKeepers: k, | ||
| } | ||
| } | ||
|
|
||
| // AnteHandle handles basic validation of tx | ||
| func (vbd EthValidateBasicDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (sdk.Context, error) { | ||
| // no need to validate basic on recheck tx, call next antehandler | ||
| if ctx.IsReCheckTx() { | ||
| return next(ctx, tx, simulate) | ||
| } | ||
|
|
||
| err := tx.ValidateBasic() | ||
| // ErrNoSignatures is fine with eth tx | ||
| if err != nil && !errors.Is(err, errortypes.ErrNoSignatures) { | ||
| return ctx, errorsmod.Wrap(err, "tx basic validation failed") | ||
| } | ||
|
|
||
| // For eth type cosmos tx, some fields should be verified as zero values, | ||
| // since we will only verify the signature against the hash of the MsgEthereumTx.Data | ||
| wrapperTx, ok := tx.(protoTxProvider) | ||
| if !ok { | ||
| return ctx, errorsmod.Wrapf(errortypes.ErrUnknownRequest, "invalid tx type %T, didn't implement interface protoTxProvider", tx) | ||
| } | ||
|
|
||
| protoTx := wrapperTx.GetProtoTx() | ||
| body := protoTx.Body | ||
| if body.Memo != "" || body.TimeoutHeight != uint64(0) || len(body.NonCriticalExtensionOptions) > 0 { | ||
| return ctx, errorsmod.Wrap(errortypes.ErrInvalidRequest, | ||
| "for eth tx body Memo TimeoutHeight NonCriticalExtensionOptions should be empty") | ||
| } | ||
|
|
||
| if len(body.ExtensionOptions) != 1 { | ||
| return ctx, errorsmod.Wrap(errortypes.ErrInvalidRequest, "for eth tx length of ExtensionOptions should be 1") | ||
| } | ||
|
|
||
| authInfo := protoTx.AuthInfo | ||
| if len(authInfo.SignerInfos) > 0 { | ||
| return ctx, errorsmod.Wrap(errortypes.ErrInvalidRequest, "for eth tx AuthInfo SignerInfos should be empty") | ||
| } | ||
|
|
||
| if authInfo.Fee.Payer != "" || authInfo.Fee.Granter != "" { | ||
| return ctx, errorsmod.Wrap(errortypes.ErrInvalidRequest, "for eth tx AuthInfo Fee payer and granter should be empty") | ||
| } | ||
|
|
||
| sigs := protoTx.Signatures | ||
| if len(sigs) > 0 { | ||
| return ctx, errorsmod.Wrap(errortypes.ErrInvalidRequest, "for eth tx Signatures should be empty") | ||
| } | ||
|
|
||
| txFee := sdk.Coins{} | ||
| txGasLimit := uint64(0) | ||
|
|
||
| evmParams := vbd.EvmKeeper.GetParams(ctx) | ||
| baseFee := vbd.EvmKeeper.GetBaseFee(ctx) | ||
| enableCreate := evmParams.GetEnableCreate() | ||
| enableCall := evmParams.GetEnableCall() | ||
| evmDenom := evmParams.GetEvmDenom() | ||
|
|
||
| for _, msg := range protoTx.GetMsgs() { | ||
| msgEthTx, ok := msg.(*evm.MsgEthereumTx) | ||
| if !ok { | ||
| return ctx, errorsmod.Wrapf(errortypes.ErrUnknownRequest, "invalid message type %T, expected %T", msg, (*evm.MsgEthereumTx)(nil)) | ||
| } | ||
|
|
||
| // Validate `From` field | ||
| if msgEthTx.From != "" { | ||
| return ctx, errorsmod.Wrapf(errortypes.ErrInvalidRequest, "invalid From %s, expect empty string", msgEthTx.From) | ||
| } | ||
|
|
||
| txGasLimit += msgEthTx.GetGas() | ||
|
|
||
| txData, err := evm.UnpackTxData(msgEthTx.Data) | ||
| if err != nil { | ||
| return ctx, errorsmod.Wrap(err, "failed to unpack MsgEthereumTx Data") | ||
| } | ||
|
|
||
| // return error if contract creation or call are disabled through governance | ||
| if !enableCreate && txData.GetTo() == nil { | ||
| return ctx, errorsmod.Wrap(evm.ErrCreateDisabled, "failed to create new contract") | ||
| } else if !enableCall && txData.GetTo() != nil { | ||
| return ctx, errorsmod.Wrap(evm.ErrCallDisabled, "failed to call contract") | ||
| } | ||
|
|
||
| if baseFee == nil && txData.TxType() == gethcore.DynamicFeeTxType { | ||
| return ctx, errorsmod.Wrap(gethcore.ErrTxTypeNotSupported, "dynamic fee tx not supported") | ||
| } | ||
|
|
||
| txFee = txFee.Add(sdk.Coin{Denom: evmDenom, Amount: sdkmath.NewIntFromBigInt(txData.Fee())}) | ||
| } | ||
|
|
||
| if !authInfo.Fee.Amount.IsEqual(txFee) { | ||
| return ctx, errorsmod.Wrapf(errortypes.ErrInvalidRequest, "invalid AuthInfo Fee Amount (%s != %s)", authInfo.Fee.Amount, txFee) | ||
| } | ||
|
|
||
| if authInfo.Fee.GasLimit != txGasLimit { | ||
| return ctx, errorsmod.Wrapf(errortypes.ErrInvalidRequest, "invalid AuthInfo Fee GasLimit (%d != %d)", authInfo.Fee.GasLimit, txGasLimit) | ||
| } | ||
|
|
||
| return next(ctx, tx, simulate) | ||
| } | ||