Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions evmd/cmd/evmd/cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,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"
Expand Down Expand Up @@ -315,10 +316,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())
})
Expand Down
43 changes: 43 additions & 0 deletions evmd/signer.go
Original file line number Diff line number Diff line change
@@ -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)
}
73 changes: 73 additions & 0 deletions evmd/signer_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
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.String()
txWithEth := &mockHasExtOptions{
msg: ethMsg,
}
fallback := &mockFallback{}
adapter := evmd.NewEthSignerExtractionAdapter(fallback)
signers, err := adapter.GetSigners(txWithEth)
require.NoError(t, err)
require.Equal(t, []mempool.SignerData{{Signer: signers[0].Signer, Sequence: signers[0].Sequence}}, signers)
require.False(t, fallback.called)

fallback = &mockFallback{}
txWithEth = &mockHasExtOptions{}
adapter = evmd.NewEthSignerExtractionAdapter(fallback)
signers, err = adapter.GetSigners(txWithEth)
require.NoError(t, err)
fallbackSigners, _ := new(mockFallback).GetSigners(txWithEth)
require.Equal(t, fallbackSigners, signers)
require.True(t, fallback.called)
}