fix: use PriorityMempool with signer extractor to prevent missing signers error in tx execution (#245)

* Problem: diff mempool max-txs trigger apphash mismatch

add test

* upstream repeated tx sender recovery is wastful #227

* sender address verification is not decoupled from execution #358

* fix main lint

* Apply suggestions from code review

* Problem: EVMChainID is not aligned in tests

* lint

* fix test

* align cfg

* eth signer not accurate in state machine #470

* keep deprecated

* Update config.go

---------

Co-authored-by: Alex | Interchain Labs <alex@interchainlabs.io>
Co-authored-by: Vlad J <vladjdk@gmail.com>

Author: 3 people

ante/evm/04_validate.go

@@ -24,10 +24,9 @@ func ValidateMsg(
 	txData evmtypes.TxData,
 	from sdktypes.AccAddress,
 ) error {
-	if from != nil {
-		return errorsmod.Wrapf(errortypes.ErrInvalidRequest, "invalid from address; expected nil; got: %q", from.String())
+	if txData == nil {
+		return errorsmod.Wrap(errortypes.ErrInvalidRequest, "transaction is nil")
 	}
-
 	return checkDisabledCreateCall(
 		txData,
 		&evmParams.AccessControl,

ante/evm/05_signature_verification.go

@@ -83,16 +83,8 @@ func SignatureVerification(
 		}
 	}
 
-	sender, err := signer.Sender(ethTx)
-	if err != nil {
-		return errorsmod.Wrapf(
-			errortypes.ErrorInvalidSigner,
-			"couldn't retrieve sender address from the ethereum transaction: %s",
-			err.Error(),
-		)
+	if err := msg.VerifySender(signer); err != nil {
+		return errorsmod.Wrapf(errortypes.ErrorInvalidSigner, "signature verification failed: %s", err.Error())
 	}
-
-	// set up the sender to the transaction field if not already
-	msg.From = sender.Hex()
 	return nil
 }

ante/evm/mono_decorator.go

@@ -156,7 +156,7 @@ func (md MonoDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, ne
 	}
 
 	// 7. can transfer
-	coreMsg, err := ethMsg.AsMessage(decUtils.Signer, decUtils.BaseFee)
+	coreMsg, err := ethMsg.AsMessage(decUtils.BaseFee)
 	if err != nil {
 		return ctx, errorsmod.Wrapf(
 			err,

ante/evm/mono_decorator_test.go

@@ -117,10 +117,9 @@ func signMsgEthereumTx(t *testing.T, privKey *ethsecp256k1.PrivKey, args *evmsdk
 	t.Helper()
 	msg := evmsdktypes.NewTx(args)
 	fromAddr := common.BytesToAddress(privKey.PubKey().Address().Bytes())
-	msg.From = fromAddr.Hex()
+	msg.From = fromAddr.Bytes()
 	ethSigner := ethtypes.LatestSignerForChainID(evmsdktypes.GetEthChainConfig().ChainID)
 	require.NoError(t, msg.Sign(ethSigner, utiltx.NewSigner(privKey)))
-	msg.From = ""
 	return msg
 }
 

api/cosmos/evm/vm/v1/tx.pulsar.go

@@ -26,7 +26,7 @@ func TestTxEncoding(t *testing.T) {
 		Input:     []byte{},
 	}
 	msg := evmtypes.NewTx(&ethTxParams)
-	msg.From = addr.Hex()
+	msg.From = addr.Bytes()
 
 	ethSigner := ethtypes.LatestSignerForChainID(big.NewInt(1))
 	err := msg.Sign(ethSigner, signer)

encoding/config_test.go

@@ -35,11 +35,12 @@ import (
 	"github.com/cosmos/cosmos-sdk/client/pruning"
 	"github.com/cosmos/cosmos-sdk/client/rpc"
 	"github.com/cosmos/cosmos-sdk/client/snapshot"
+	"github.com/cosmos/cosmos-sdk/server"
 	sdkserver "github.com/cosmos/cosmos-sdk/server"
 	servertypes "github.com/cosmos/cosmos-sdk/server/types"
 	simtestutil "github.com/cosmos/cosmos-sdk/testutil/sims"
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	sdkmempool "github.com/cosmos/cosmos-sdk/types/mempool"
+	"github.com/cosmos/cosmos-sdk/types/mempool"
 	sdktestutil "github.com/cosmos/cosmos-sdk/types/module/testutil"
 	"github.com/cosmos/cosmos-sdk/types/tx/signing"
 	authcmd "github.com/cosmos/cosmos-sdk/x/auth/client/cli"
@@ -316,10 +317,19 @@ func newApp(
 
 	// Set up the required mempool and ABCI proposal handlers for Cosmos EVM
 	baseappOptions = append(baseappOptions, func(app *baseapp.BaseApp) {
-		mempool := sdkmempool.NoOpMempool{}
-		app.SetMempool(mempool)
-
-		handler := baseapp.NewDefaultProposalHandler(mempool, app)
+		var mpool mempool.Mempool
+		if maxTxs := cast.ToInt(appOpts.Get(server.FlagMempoolMaxTxs)); maxTxs >= 0 {
+			// Setup Mempool and Proposal Handlers
+			mpool = mempool.NewPriorityMempool(mempool.PriorityNonceMempoolConfig[int64]{
+				TxPriority:      mempool.NewDefaultTxPriority(),
+				SignerExtractor: evmd.NewEthSignerExtractionAdapter(mempool.NewDefaultSignerExtractionAdapter()),
+				MaxTx:           maxTxs,
+			})
+		} else {
+			mpool = mempool.NoOpMempool{}
+		}
+		app.SetMempool(mpool)
+		handler := baseapp.NewDefaultProposalHandler(mpool, app)
 		app.SetPrepareProposal(handler.PrepareProposalHandler())
 		app.SetProcessProposal(handler.ProcessProposalHandler())
 	})

evmd/cmd/evmd/cmd/root.go

@@ -0,0 +1,43 @@
+package evmd
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	mempool "github.com/cosmos/cosmos-sdk/types/mempool"
+	authante "github.com/cosmos/cosmos-sdk/x/auth/ante"
+	evmtypes "github.com/cosmos/evm/x/vm/types"
+)
+
+var _ mempool.SignerExtractionAdapter = EthSignerExtractionAdapter{}
+
+// EthSignerExtractionAdapter is the default implementation of SignerExtractionAdapter. It extracts the signers
+// from a cosmos-sdk tx via GetSignaturesV2.
+type EthSignerExtractionAdapter struct {
+	fallback mempool.SignerExtractionAdapter
+}
+
+// NewEthSignerExtractionAdapter constructs a new EthSignerExtractionAdapter instance
+func NewEthSignerExtractionAdapter(fallback mempool.SignerExtractionAdapter) EthSignerExtractionAdapter {
+	return EthSignerExtractionAdapter{fallback}
+}
+
+// GetSigners implements the Adapter interface
+// NOTE: only the first item is used by the mempool
+func (s EthSignerExtractionAdapter) GetSigners(tx sdk.Tx) ([]mempool.SignerData, error) {
+	if txWithExtensions, ok := tx.(authante.HasExtensionOptionsTx); ok {
+		opts := txWithExtensions.GetExtensionOptions()
+		if len(opts) > 0 && opts[0].GetTypeUrl() == "/cosmos.evm.vm.v1.ExtensionOptionsEthereumTx" {
+			for _, msg := range tx.GetMsgs() {
+				if ethMsg, ok := msg.(*evmtypes.MsgEthereumTx); ok {
+					return []mempool.SignerData{
+						mempool.NewSignerData(
+							ethMsg.GetFrom(),
+							ethMsg.AsTransaction().Nonce(),
+						),
+					}, nil
+				}
+			}
+		}
+	}
+
+	return s.fallback.GetSigners(tx)
+}

evmd/signer.go

@@ -0,0 +1,79 @@
+package evmd_test
+
+import (
+	"math/big"
+	"testing"
+
+	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	mempool "github.com/cosmos/cosmos-sdk/types/mempool"
+	"github.com/cosmos/evm/evmd"
+	"github.com/cosmos/evm/x/vm/types"
+	"github.com/stretchr/testify/require"
+	protov2 "google.golang.org/protobuf/proto"
+)
+
+type mockFallback struct {
+	called bool
+}
+
+func (m *mockFallback) GetSigners(tx sdk.Tx) ([]mempool.SignerData, error) {
+	m.called = true
+	return []mempool.SignerData{mempool.NewSignerData(sdk.AccAddress("fallback"), 1)}, nil
+}
+
+type mockHasExtOptions struct {
+	msg sdk.Msg
+}
+
+func (m *mockHasExtOptions) GetMsgs() []sdk.Msg { return []sdk.Msg{m.msg} }
+func (m *mockHasExtOptions) GetMsgsV2() ([]protov2.Message, error) {
+	return []protov2.Message{}, nil
+}
+func (m *mockHasExtOptions) GetExtensionOptions() []*codectypes.Any {
+	return []*codectypes.Any{
+		{
+			TypeUrl: "/cosmos.evm.vm.v1.ExtensionOptionsEthereumTx",
+			Value:   []byte{},
+		},
+	}
+}
+func (m *mockHasExtOptions) GetNonCriticalExtensionOptions() []*codectypes.Any { return nil }
+
+func TestGetSigners(t *testing.T) {
+	ethAddr := sdk.AccAddress("ethsigner")
+	evmTx := &types.EvmTxArgs{
+		ChainID:   big.NewInt(100),
+		Nonce:     1,
+		Amount:    big.NewInt(10),
+		GasLimit:  100000,
+		GasPrice:  big.NewInt(150),
+		GasFeeCap: big.NewInt(200),
+	}
+	ethMsg := types.NewTx(evmTx)
+	ethMsg.From = ethAddr.Bytes()
+	txWithEth := &mockHasExtOptions{
+		msg: ethMsg,
+	}
+	fallback := &mockFallback{}
+	adapter := evmd.NewEthSignerExtractionAdapter(fallback)
+	signers, err := adapter.GetSigners(txWithEth)
+	require.NoError(t, err)
+	require.Equal(t, []mempool.SignerData{
+		mempool.NewSignerData(
+			ethMsg.GetFrom(),
+			ethMsg.AsTransaction().Nonce(),
+		),
+	}, signers)
+	require.False(t, fallback.called)
+
+	fallback = &mockFallback{}
+	txWithEth = &mockHasExtOptions{}
+	adapter = evmd.NewEthSignerExtractionAdapter(fallback)
+	signers, err = adapter.GetSigners(txWithEth)
+	require.NoError(t, err)
+	fallbackSigners, err := new(mockFallback).GetSigners(txWithEth)
+	require.NoError(t, err)
+	require.Equal(t, fallbackSigners, signers)
+	require.True(t, fallback.called)
+}

evmd/signer_test.go

@@ -8,6 +8,7 @@ import (
 	"github.com/cosmos/evm/evmd"
 	"github.com/cosmos/evm/evmd/cmd/evmd/config"
 	testconfig "github.com/cosmos/evm/testutil/config"
+	"github.com/cosmos/evm/testutil/constants"
 	feemarkettypes "github.com/cosmos/evm/x/feemarket/types"
 	ibctesting "github.com/cosmos/ibc-go/v10/testing"
 
@@ -54,7 +55,7 @@ func SetupEvmd() (ibctesting.TestingApp, map[string]json.RawMessage) {
 		nil,
 		true,
 		simutils.EmptyAppOptions{},
-		9001,
+		constants.ExampleEIP155ChainID,
 		testconfig.EvmAppOptions,
 	)
 	// disable base fee for testing