fix(mempool): Prevent runTx failures

cosmos/config/config.go

@@ -26,12 +26,13 @@ import (
 	"github.com/berachain/polaris/cosmos/config/flags"
 	"github.com/berachain/polaris/eth"
 	"github.com/berachain/polaris/eth/accounts"
-	"github.com/berachain/polaris/eth/node"
-	"github.com/berachain/polaris/eth/polar"
 
 	sdkflags "github.com/cosmos/cosmos-sdk/client/flags"
 	servertypes "github.com/cosmos/cosmos-sdk/server/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	version "github.com/cosmos/cosmos-sdk/version"
+
+	"github.com/ethereum/go-ethereum/common/hexutil"
 )
 
 type Config = eth.Config
@@ -49,17 +50,6 @@ func SetupCosmosConfig() {
 	config.Seal()
 }
 
-// DefaultConfig returns the default configuration for a polaris chain.
-func DefaultConfig() *Config {
-	nodeCfg := node.DefaultConfig()
-	nodeCfg.DataDir = ""
-	nodeCfg.KeyStoreDir = ""
-	return &Config{
-		Polar: *polar.DefaultConfig(),
-		Node:  *nodeCfg,
-	}
-}
-
 // MustReadConfigFromAppOpts reads the configuration options from the given
 // application options. Panics if the configuration cannot be read.
 func MustReadConfigFromAppOpts(opts servertypes.AppOptions) *Config {
@@ -105,6 +95,17 @@ func readConfigFromAppOptsParser(parser AppOptionsParser) (*Config, error) {
 		parser.GetHexutilBytes(flags.MinerExtraData); err != nil {
 		return nil, err
 	}
+
+	if len(conf.Polar.Miner.ExtraData) == 0 {
+		commit := version.NewInfo().GitCommit
+		if len(commit) != 40 { //nolint:gomnd // its okay.
+			return nil, err
+		}
+		conf.Polar.Miner.ExtraData = hexutil.Bytes(
+			commit[32:40],
+		)
+	}
+
 	if conf.Polar.Miner.GasFloor, err =
 		parser.GetUint64(flags.MinerGasFloor); err != nil {
 		return nil, err

cosmos/config/default.go

@@ -0,0 +1,72 @@
+// SPDX-License-Identifier: BUSL-1.1
+//
+// Copyright (C) 2023, Berachain Foundation. All rights reserved.
+// Use of this software is govered by the Business Source License included
+// in the LICENSE file of this repository and at www.mariadb.com/bsl11.
+//
+// ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY
+// TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER
+// VERSIONS OF THE LICENSED WORK.
+//
+// THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF
+// LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF
+// LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE).
+//
+// TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+// AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+// EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+// TITLE.
+
+package config
+
+import (
+	"github.com/berachain/polaris/eth/node"
+	"github.com/berachain/polaris/eth/polar"
+
+	cmtcfg "github.com/cometbft/cometbft/config"
+
+	serverconfig "github.com/cosmos/cosmos-sdk/server/config"
+)
+
+// RecommendedCometBFTConfig returns the recommended CometBFT config
+// for the application.
+func RecommendedCometBFTConfig() *cmtcfg.Config {
+	cfg := cmtcfg.DefaultConfig()
+	cfg.Mempool.Size = 30000
+	cfg.Mempool.CacheSize = 30000
+	cfg.Mempool.Recheck = true
+	cfg.Mempool.Type = "flood"
+
+	cfg.P2P.MaxNumInboundPeers = 10
+	cfg.P2P.MaxNumOutboundPeers = 15
+
+	cfg.TxIndex.Indexer = "null"
+
+	cfg.Instrumentation.Prometheus = true
+	return cfg
+}
+
+// RecommendedServerConfig returns the recommended server config.
+func RecommendedServerConfig() *serverconfig.Config {
+	cfg := serverconfig.DefaultConfig()
+	cfg.MinGasPrices = "0abera"
+	cfg.API.Enable = true
+	cfg.Telemetry.Enabled = true
+	cfg.Telemetry.PrometheusRetentionTime = 180
+	cfg.Telemetry.EnableHostnameLabel = true
+	cfg.Telemetry.GlobalLabels = [][]string{}
+	cfg.IAVLCacheSize = 20000
+	return cfg
+}
+
+// DefaultPolarisConfig returns the default polaris config.
+func DefaultPolarisConfig() *Config {
+	nodeCfg := node.DefaultConfig()
+	nodeCfg.DataDir = ""
+	nodeCfg.KeyStoreDir = ""
+	return &Config{
+		Polar: *polar.DefaultConfig(),
+		Node:  *nodeCfg,
+	}
+}

cosmos/go.mod

@@ -7,7 +7,7 @@ replace (
 	github.com/99designs/keyring => github.com/cosmos/keyring v1.2.0
 	github.com/cockroachdb/pebble => github.com/cockroachdb/pebble v0.0.0-20230928194634-aa077af62593
 	// We replace `go-ethereum` with `polaris-geth` in order include our required changes.
-	github.com/ethereum/go-ethereum => github.com/berachain/polaris-geth v0.0.0-20240108202417-27ce389773c0
+	github.com/ethereum/go-ethereum => github.com/berachain/polaris-geth v0.0.0-20240114134402-f43e40102ad1
 	// Fix upstream GHSA-h395-qcrw-5vmq and GHSA-3vp4-m3rf-835h vulnerabilities.
 	// TODO Remove it: https://github.com/cosmos/cosmos-sdk/issues/10409
 	github.com/gin-gonic/gin => github.com/gin-gonic/gin v1.9.1

cosmos/go.sum

@@ -112,8 +112,8 @@ github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24
 github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
-github.com/berachain/polaris-geth v0.0.0-20240108202417-27ce389773c0 h1:jGah7o6k6xytfTFH7hIKmfJZOPnAhCb9bmCb+lRS4Bk=
-github.com/berachain/polaris-geth v0.0.0-20240108202417-27ce389773c0/go.mod h1:sc48XYQxCzH3fG9BcrXCOOgQk2JfZzNAmIKnceogzsA=
+github.com/berachain/polaris-geth v0.0.0-20240114134402-f43e40102ad1 h1:Rh5+bQB/Z1fdQhVT7ltZQRAVNOn3KJe6zsA5gUXnPDc=
+github.com/berachain/polaris-geth v0.0.0-20240114134402-f43e40102ad1/go.mod h1:sc48XYQxCzH3fG9BcrXCOOgQk2JfZzNAmIKnceogzsA=
 github.com/berachain/polaris/contracts v0.1.0-alpha h1:ZRkh0JyMHp11Xe8z7gcJhfnn9X6vU6/3iSG3Bdi/kJQ=
 github.com/berachain/polaris/contracts v0.1.0-alpha/go.mod h1:Sm1T+tIQGuP0wEJnF/TlgZiJ+NPHgOZWO7vAz7FkwVs=
 github.com/berachain/polaris/eth v0.1.2-alpha h1:kKp2peFLTGK3LaupZcngycSHk+zRxmczGKgsiU59R08=

cosmos/runtime/abci/proposal.go

@@ -27,6 +27,7 @@
 
 	"github.com/berachain/polaris/cosmos/runtime/chain"
 	"github.com/berachain/polaris/cosmos/runtime/miner"
+	"github.com/berachain/polaris/cosmos/runtime/txpool"
 
 	cometabci "github.com/cometbft/cometbft/abci/types"
 
@@ -42,6 +43,7 @@
 	beginBlocker      sdk.BeginBlocker
 	wrappedMiner      *miner.Miner
 	wrappedBlockchain *chain.WrappedBlockchain
+	wrappedTxPool     *txpool.Mempool
 
 	// TODO: refactor validator commands out of the wbc and miner.
 	// valCmdProcessor   *ValidatorCommands

cosmos/runtime/runtime.go

@@ -54,7 +54,7 @@ import (
 // EVMKeeper is an interface that defines the methods needed for the EVM setup.
 type EVMKeeper interface {
 	// Setup initializes the EVM keeper.
-	Setup(core.Blockchain) error
+	Setup(core.Blockchain, *txpool.Mempool) error
 	GetStatePluginFactory() core.StatePluginFactory
 	SetLatestQueryContext(context.Context) error
 	GetHost() core.PolarisHostChain
@@ -154,7 +154,7 @@ func (p *Polaris) Build(
 	app.SetPrepareProposal(p.ProposalProvider.PrepareProposal)
 	app.SetProcessProposal(p.ProposalProvider.ProcessProposal)
 
-	if err := ek.Setup(p.WrappedBlockchain); err != nil {
+	if err := ek.Setup(p.WrappedBlockchain, p.WrappedTxPool); err != nil {
 		return err
 	}
 

cosmos/runtime/txpool/ante.go

@@ -27,6 +27,7 @@ import (
 	"github.com/berachain/polaris/cosmos/x/evm/types"
 	"github.com/berachain/polaris/lib/utils"
 
+	"github.com/cosmos/cosmos-sdk/telemetry"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 
 	"github.com/ethereum/go-ethereum/common"
@@ -41,9 +42,10 @@ func (m *Mempool) AnteHandle(
 	ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler,
 ) (sdk.Context, error) {
 	msgs := tx.GetMsgs()
+	// Record the time it takes to build a payload.
 
 	// We only want to eject transactions from comet on recheck.
-	if ctx.ExecMode() == sdk.ExecModeReCheck {
+	if ctx.ExecMode() == sdk.ExecModeCheck || ctx.ExecMode() == sdk.ExecModeReCheck {
 		if wet, ok := utils.GetAs[*types.WrappedEthereumTransaction](msgs[0]); ok {
 			if m.shouldEjectFromCometMempool(ctx.BlockTime(), wet.Unwrap()) {
 				return ctx, errors.New("eject from comet mempool")
@@ -57,6 +59,7 @@ func (m *Mempool) AnteHandle(
 func (m *Mempool) shouldEjectFromCometMempool(
 	currentTime time.Time, tx *ethtypes.Transaction,
 ) bool {
+	defer telemetry.MeasureSince(time.Now(), MetricKeyTimeShouldEject)
 	if tx == nil {
 		return false
 	}
@@ -66,21 +69,22 @@ func (m *Mempool) shouldEjectFromCometMempool(
 	// 1. If the transaction has been included in a block.
 	// 2. If the transaction is unknown to the node.
 	// 3. If the transaction has been in the mempool for longer than the configured timeout.
-	return txStatus == txpool.TxStatusIncluded || txStatus == txpool.TxStatusUnknown ||
+	return txStatus == txpool.TxStatusIncluded ||
 		currentTime.Sub(tx.Time()) > m.lifetime
 }
 
 // txStatus returns the status of the transaction.
 func (m *Mempool) txStatus(hash common.Hash) txpool.TxStatus {
-	// Looking for the transaction in txpool first.
-	status := m.txpool.Status(hash)
+	// // Looking for the transaction in txpool first.
+	// status := m.txpool.Status(hash)
 
-	// If the transaction is unknown to the pool, try looking it up locally.
-	if status == txpool.TxStatusUnknown {
-		lookup := m.chain.GetTransactionLookup(hash)
-		if lookup != nil {
-			status = txpool.TxStatusIncluded
-		}
+	// // If the transaction is unknown to the pool, try looking it up locally.
+	// if status == txpool.TxStatusUnknown {
+	var status txpool.TxStatus
+	lookup := m.chain.GetTransactionLookup(hash)
+	if lookup != nil {
+		status = txpool.TxStatusIncluded
 	}
+	// }
 	return status
 }

cosmos/runtime/txpool/handler.go

@@ -223,7 +223,9 @@ func (h *handler) broadcastTransaction(tx *ethtypes.Transaction, retries int) {
 		return
 	}
 
-	if rsp == nil || rsp.Code == 0 {
+	// If rsp == 1, likely the txn is already in a block, and thus the broadcast failing is actually
+	// the desired behaviour.
+	if rsp == nil || rsp.Code == 0 || rsp.Code == 1 {
 		return
 	}
 

cosmos/runtime/txpool/mempool.go

@@ -61,7 +61,7 @@ type GethTxPool interface {
 // is to allow for transactions coming in from CometBFT's gossip to be added to the underlying
 // geth txpool during `CheckTx`, that is the only purpose of `Mempool“.
 type Mempool struct {
-	txpool   eth.TxPool
+	eth.TxPool
 	lifetime time.Duration
 	chain    core.ChainReader
 	handler  Lifecycle
@@ -70,7 +70,7 @@ type Mempool struct {
 // New creates a new Mempool.
 func New(chain core.ChainReader, txpool eth.TxPool, lifetime time.Duration) *Mempool {
 	return &Mempool{
-		txpool:   txpool,
+		TxPool:   txpool,
 		chain:    chain,
 		lifetime: lifetime,
 	}
@@ -82,7 +82,7 @@ func (m *Mempool) Init(
 	txBroadcaster TxBroadcaster,
 	txSerializer TxSerializer,
 ) {
-	m.handler = newHandler(txBroadcaster, m.txpool, txSerializer, logger)
+	m.handler = newHandler(txBroadcaster, m.TxPool, txSerializer, logger)
 }
 
 // Start starts the Mempool TxHandler.
@@ -107,7 +107,7 @@ func (m *Mempool) Insert(ctx context.Context, sdkTx sdk.Tx) error {
 	if wet, ok := utils.GetAs[*types.WrappedEthereumTransaction](msgs[0]); !ok {
 		// We have to return nil for non-ethereum transactions as to not fail check-tx.
 		return nil
-	} else if errs := m.txpool.Add(
+	} else if errs := m.TxPool.Add(
 		[]*ethtypes.Transaction{wet.Unwrap()}, false, false,
 	); len(errs) != 0 {
 		// Handle case where a node broadcasts to itself, we don't want it to fail CheckTx.
@@ -122,7 +122,7 @@ func (m *Mempool) Insert(ctx context.Context, sdkTx sdk.Tx) error {
 
 // CountTx returns the number of transactions currently in the mempool.
 func (m *Mempool) CountTx() int {
-	runnable, blocked := m.txpool.Stats()
+	runnable, blocked := m.TxPool.Stats()
 	return runnable + blocked
 }
 
@@ -132,6 +132,21 @@ func (m *Mempool) Select(context.Context, [][]byte) mempool.Iterator {
 }
 
 // Remove is an intentional no-op as the eth txpool handles removals.
-func (m *Mempool) Remove(sdk.Tx) error {
+func (m *Mempool) Remove(tx sdk.Tx) error {
+	msgs := tx.GetMsgs()
+	if len(msgs) == 1 {
+		env, ok := utils.GetAs[*types.WrappedPayloadEnvelope](msgs[0])
+		if !ok {
+			return nil
+		}
+
+		txBzs := env.UnwrapPayload().ExecutionPayload.Transactions
+
+		for _, txBz := range txBzs {
+			ethTx := new(ethtypes.Transaction)
+			_ = ethTx.UnmarshalBinary(txBz)
+			m.TxPool.Remove(ethTx.Hash())
+		}
+	}
 	return nil
 }

cosmos/runtime/txpool/mempool_test.go

@@ -50,7 +50,7 @@
 	BeforeEach(func() {
 		txPool = mocks.NewGethTxPool(t)
 		sdkTx = mocks.NewSdkTx(t)
-		mempool = &Mempool{txpool: txPool}
+		mempool = &Mempool{TxPool: txPool}
 		wet, _ = evmtypes.WrapTx(ethtypes.NewTx(&ethtypes.LegacyTx{}))
 	})
 

cosmos/runtime/txpool/telemetry.go

@@ -23,4 +23,5 @@ package txpool
 const (
 	MetricKeyMempoolFull      = "polaris_cometbft_mempool_full"
 	MetricKeyBroadcastFailure = "polaris_cometbft_broadcast_failure"
+	MetricKeyTimeShouldEject  = "polaris_cometbft_time_should_eject"
 )

cosmos/x/evm/genesis_test.go

@@ -67,7 +67,7 @@ var _ = Describe("Genesis", func() {
 	BeforeEach(func() {
 		ctx, ak, _, _ = testutil.SetupMinimalKeepers(log.NewTestLogger(GinkgoT()))
 		ctx = ctx.WithBlockHeight(0)
-		cfg := config.DefaultConfig()
+		cfg := config.DefaultPolarisConfig()
 		ethGen.Config = params.DefaultChainConfig
 		cfg.Node.DataDir = GinkgoT().TempDir()
 		cfg.Node.KeyStoreDir = GinkgoT().TempDir()
@@ -86,6 +86,7 @@ var _ = Describe("Genesis", func() {
 		)
 		err = k.Setup(
 			chain.New(core.NewChain(k.Host, params.DefaultChainConfig, beacon.NewFaker()), nil),
+			nil,
 		)
 		Expect(err).ToNot(HaveOccurred())