chore(metrics): add log to tx store and metric for num height iterated on height sync

mempool/internal/heightsync/heightsync.go

@@ -8,6 +8,8 @@ import (
 	"time"
 
 	"github.com/ethereum/go-ethereum/metrics"
+
+	"cosmossdk.io/log/v2"
 )
 
 var (
@@ -26,6 +28,10 @@ var (
 	// hsDuration is the total time callers of Get spend from invocation to
 	// return.
 	hsDuration = metrics.NewRegisteredTimer("height_sync/duration", nil)
+
+	// hsHeights it the total number of heights progressed through on the
+	// height sync
+	hsHeights = metrics.NewRegisteredMeter("height_sync/heights", nil)
 )
 
 // HeightSync synchronizes access to a per-height tx store for mempool
@@ -50,7 +56,7 @@ type HeightSync[Store any] struct {
 	currentHeight *big.Int
 
 	// reset is a function that returns a new store, called at every new height
-	reset func() *Store
+	reset func(logger log.Logger) *Store
 
 	// store is the current Store that operations are happening on via Do and will
 	// be returned via Get until a new height is started via StartNewHeight
@@ -66,16 +72,19 @@ type HeightSync[Store any] struct {
 	// mu protects all of the above fields; it does not protect internal
 	// fields of the Store itself
 	mu sync.RWMutex
+
+	logger log.Logger
 }
 
 // New creates a new HeightSync starting at the given height.
-func New[Store any](startHeight *big.Int, reset func() *Store) *HeightSync[Store] {
+func New[Store any](startHeight *big.Int, reset func(logger log.Logger) *Store, logger log.Logger) *HeightSync[Store] {
 	hs := &HeightSync[Store]{
 		currentHeight: startHeight,
 		reset:         reset,
-		store:         reset(),
+		store:         reset(logger),
 		heightChanged: make(chan struct{}),
 		done:          make(chan struct{}),
+		logger:        logger,
 	}
 	// initial height is considered immediately done
 	hs.EndCurrentHeight()
@@ -96,7 +105,7 @@ func (hs *HeightSync[Store]) StartNewHeight(height *big.Int) {
 
 	// create new Store for this height
 	hs.currentHeight = new(big.Int).Set(height)
-	hs.store = hs.reset()
+	hs.store = hs.reset(hs.logger)
 
 	// close old channel and create new one to wake up consumers
 	oldChan := hs.heightChanged
@@ -117,6 +126,7 @@ func (hs *HeightSync[Store]) EndCurrentHeight() {
 	if hs.isHeightEnded() {
 		panic(fmt.Errorf("height %s already ended", hs.currentHeight.String()))
 	}
+	hsHeights.Mark(1)
 	close(hs.done)
 }
 

mempool/internal/heightsync/heightsync_test.go

@@ -11,6 +11,8 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/cosmos/evm/mempool/internal/heightsync"
+
+	"cosmossdk.io/log/v2"
 )
 
 // testStore is a simple store for testing the generic height-sync behavior.
@@ -19,7 +21,7 @@ type testStore struct {
 	mu    sync.Mutex
 }
 
-func newTestValue() *testStore {
+func newTestValue(_ log.Logger) *testStore {
 	return &testStore{}
 }
 
@@ -36,7 +38,7 @@ func (s *testStore) get() []string {
 }
 
 func TestBasicGetAfterCompletion(t *testing.T) {
-	hv := heightsync.New(big.NewInt(1), newTestValue)
+	hv := heightsync.New(big.NewInt(1), newTestValue, log.NewNopLogger())
 
 	hv.StartNewHeight(big.NewInt(1))
 	hv.Do(func(s *testStore) {
@@ -58,7 +60,7 @@ func TestBasicGetAfterCompletion(t *testing.T) {
 }
 
 func TestGetTimeoutBeforeHeight(t *testing.T) {
-	hv := heightsync.New(big.NewInt(1), newTestValue)
+	hv := heightsync.New(big.NewInt(1), newTestValue, log.NewNopLogger())
 
 	// request height 3 but don't advance to it
 	ctx, cancel := context.WithTimeout(context.Background(), 100*time.Millisecond)
@@ -70,7 +72,7 @@ func TestGetTimeoutBeforeHeight(t *testing.T) {
 
 func TestGetPartialResults(t *testing.T) {
 	synctest.Test(t, func(t *testing.T) {
-		hv := heightsync.New(big.NewInt(1), newTestValue)
+		hv := heightsync.New(big.NewInt(1), newTestValue, log.NewNopLogger())
 
 		// start new height but don't call EndCurrentHeight
 		hv.StartNewHeight(big.NewInt(1))
@@ -90,7 +92,7 @@ func TestGetPartialResults(t *testing.T) {
 
 func TestGetBehindByOneHeight(t *testing.T) {
 	synctest.Test(t, func(t *testing.T) {
-		hv := heightsync.New(big.NewInt(1), newTestValue)
+		hv := heightsync.New(big.NewInt(1), newTestValue, log.NewNopLogger())
 
 		hv.StartNewHeight(big.NewInt(1))
 		hv.Do(func(s *testStore) { s.add("height1") })
@@ -120,7 +122,7 @@ func TestGetBehindByOneHeight(t *testing.T) {
 
 func TestGetBehindByTwoHeights(t *testing.T) {
 	synctest.Test(t, func(t *testing.T) {
-		hv := heightsync.New(big.NewInt(1), newTestValue)
+		hv := heightsync.New(big.NewInt(1), newTestValue, log.NewNopLogger())
 
 		hv.StartNewHeight(big.NewInt(1))
 		hv.Do(func(s *testStore) { s.add("height1") })
@@ -155,7 +157,7 @@ func TestGetBehindByTwoHeights(t *testing.T) {
 }
 
 func TestPanicOnOldHeight(t *testing.T) {
-	hv := heightsync.New(big.NewInt(1), newTestValue)
+	hv := heightsync.New(big.NewInt(1), newTestValue, log.NewNopLogger())
 
 	hv.StartNewHeight(big.NewInt(1))
 	hv.EndCurrentHeight()
@@ -170,7 +172,7 @@ func TestPanicOnOldHeight(t *testing.T) {
 }
 
 func TestStartNewHeightResetsValue(t *testing.T) {
-	hv := heightsync.New(big.NewInt(1), newTestValue)
+	hv := heightsync.New(big.NewInt(1), newTestValue, log.NewNopLogger())
 
 	hv.StartNewHeight(big.NewInt(1))
 	hv.Do(func(s *testStore) { s.add("old") })
@@ -189,7 +191,7 @@ func TestStartNewHeightResetsValue(t *testing.T) {
 }
 
 func TestConcurrentDo(t *testing.T) {
-	hv := heightsync.New(big.NewInt(1), newTestValue)
+	hv := heightsync.New(big.NewInt(1), newTestValue, log.NewNopLogger())
 
 	hv.StartNewHeight(big.NewInt(1))
 

mempool/mempool.go

@@ -157,6 +157,7 @@ func NewExperimentalEVMMempool(
 	}
 	legacyPool := legacypool.New(
 		legacyConfig,
+		logger,
 		blockchain,
 		legacypool.WithRecheck(evmRechecker),
 	)
@@ -213,7 +214,7 @@ func NewExperimentalEVMMempool(
 		cosmosPool,
 		tracker.NewHandle(-1),
 		cosmosRechecker,
-		heightsync.New(blockchain.CurrentBlock().Number, NewCosmosTxStore),
+		heightsync.New(blockchain.CurrentBlock().Number, NewCosmosTxStore, logger.With("pool", "recheckpool")),
 		blockchain,
 	)
 

mempool/recheck_pool_test.go

@@ -1192,7 +1192,7 @@ func noopAnteHandler(ctx sdk.Context, _ sdk.Tx, _ bool) (sdk.Context, error) {
 
 // newTestRecheckedTxs creates a HeightSync[CosmosTxStore] for testing, starting at height 0.
 func newTestRecheckedTxs() *heightsync.HeightSync[mempool.CosmosTxStore] {
-	return heightsync.New(big.NewInt(0), mempool.NewCosmosTxStore)
+	return heightsync.New(big.NewInt(0), mempool.NewCosmosTxStore, log.NewNopLogger())
 }
 
 // collectIteratorTxs drains an sdkmempool.Iterator into a slice.

mempool/tx_store.go

@@ -3,6 +3,8 @@ package mempool
 import (
 	"sync"
 
+	"cosmossdk.io/log/v2"
+
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkmempool "github.com/cosmos/cosmos-sdk/types/mempool"
 )
@@ -19,7 +21,7 @@ type CosmosTxStore struct {
 }
 
 // NewCosmosTxStore creates a new CosmosTxStore.
-func NewCosmosTxStore() *CosmosTxStore {
+func NewCosmosTxStore(_ log.Logger) *CosmosTxStore {
 	return &CosmosTxStore{
 		index: make(map[sdk.Tx]int),
 	}

mempool/tx_store_test.go

@@ -8,6 +8,8 @@ import (
 
 	"github.com/cosmos/gogoproto/proto"
 
+	"cosmossdk.io/log/v2"
+
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
@@ -26,7 +28,7 @@ func newMockTx(id int) sdk.Tx {
 }
 
 func TestCosmosTxStoreAddAndGet(t *testing.T) {
-	store := NewCosmosTxStore()
+	store := NewCosmosTxStore(log.NewNopLogger())
 
 	tx1 := newMockTx(1)
 	tx2 := newMockTx(2)
@@ -41,7 +43,7 @@ func TestCosmosTxStoreAddAndGet(t *testing.T) {
 }
 
 func TestCosmosTxStoreDedup(t *testing.T) {
-	store := NewCosmosTxStore()
+	store := NewCosmosTxStore(log.NewNopLogger())
 
 	tx := newMockTx(1)
 
@@ -53,7 +55,7 @@ func TestCosmosTxStoreDedup(t *testing.T) {
 }
 
 func TestCosmosTxStoreIterator(t *testing.T) {
-	store := NewCosmosTxStore()
+	store := NewCosmosTxStore(log.NewNopLogger())
 
 	tx1 := newMockTx(1)
 	tx2 := newMockTx(2)
@@ -74,12 +76,12 @@ func TestCosmosTxStoreIterator(t *testing.T) {
 }
 
 func TestCosmosTxStoreIteratorEmpty(t *testing.T) {
-	store := NewCosmosTxStore()
+	store := NewCosmosTxStore(log.NewNopLogger())
 	require.Nil(t, store.Iterator())
 }
 
 func TestCosmosTxStoreIteratorSnapshotIsolation(t *testing.T) {
-	store := NewCosmosTxStore()
+	store := NewCosmosTxStore(log.NewNopLogger())
 
 	tx1 := newMockTx(1)
 	tx2 := newMockTx(2)

mempool/txpool/legacypool/legacypool.go

@@ -30,6 +30,7 @@ import (
 	"sync/atomic"
 	"time"
 
+	cosmoslog "cosmossdk.io/log/v2"
 	"github.com/cosmos/evm/mempool/internal/heightsync"
 	"github.com/cosmos/evm/mempool/reserver"
 	"github.com/ethereum/go-ethereum/common"
@@ -383,7 +384,7 @@ func WithRecheck(rechecker Rechecker) Option {
 
 // New creates a new transaction pool to gather, sort and filter inbound
 // transactions from the network.
-func New(config Config, chain BlockChain, opts ...Option) *LegacyPool {
+func New(config Config, logger cosmoslog.Logger, chain BlockChain, opts ...Option) *LegacyPool {
 	// Sanitize the input to ensure no vulnerable gas prices are set
 	config = (&config).sanitize()
 
@@ -398,7 +399,7 @@ func New(config Config, chain BlockChain, opts ...Option) *LegacyPool {
 		beats:            make(map[common.Address]time.Time),
 		all:              newLookup(),
 		rechecker:        newNopRechecker(),
-		validPendingTxs:  heightsync.New(chain.CurrentBlock().Number, NewTxStore),
+		validPendingTxs:  heightsync.New(chain.CurrentBlock().Number, NewTxStore, logger.With("pool", "legacypool")),
 		reqResetCh:       make(chan *txpoolResetRequest),
 		reqPromoteCh:     make(chan *accountSet),
 		reqCancelResetCh: make(chan struct{}),

mempool/txpool/legacypool/legacypool2_test.go

@@ -21,6 +21,7 @@ import (
 	"math/big"
 	"testing"
 
+	"cosmossdk.io/log/v2"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/state"
 	"github.com/ethereum/go-ethereum/core/tracing"
@@ -86,7 +87,7 @@ func TestTransactionFutureAttack(t *testing.T) {
 	config := testTxPoolConfig
 	config.GlobalQueue = 100
 	config.GlobalSlots = 100
-	pool := New(config, blockchain)
+	pool := New(config, log.NewNopLogger(), blockchain)
 	pool.Init(config.PriceLimit, blockchain.CurrentBlock(), newReserver())
 	defer pool.Close()
 
@@ -121,7 +122,7 @@ func TestTransactionFuture1559(t *testing.T) {
 	// Create the pool to test the pricing enforcement with
 	statedb, _ := state.New(types.EmptyRootHash, state.NewDatabaseForTesting())
 	blockchain := newTestBlockChain(eip1559Config, 1000000, statedb, new(event.Feed))
-	pool := New(testTxPoolConfig, blockchain)
+	pool := New(testTxPoolConfig, log.NewNopLogger(), blockchain)
 	pool.Init(testTxPoolConfig.PriceLimit, blockchain.CurrentBlock(), newReserver())
 	defer pool.Close()
 
@@ -154,7 +155,7 @@ func TestTransactionZAttack(t *testing.T) {
 	// Create the pool to test the pricing enforcement with
 	statedb, _ := state.New(types.EmptyRootHash, state.NewDatabaseForTesting())
 	blockchain := newTestBlockChain(eip1559Config, 1000000, statedb, new(event.Feed))
-	pool := New(testTxPoolConfig, blockchain)
+	pool := New(testTxPoolConfig, log.NewNopLogger(), blockchain)
 	pool.Init(testTxPoolConfig.PriceLimit, blockchain.CurrentBlock(), newReserver())
 	defer pool.Close()
 	// Create a number of test accounts, fund them and make transactions
@@ -227,7 +228,7 @@ func BenchmarkFutureAttack(b *testing.B) {
 	config := testTxPoolConfig
 	config.GlobalQueue = 100
 	config.GlobalSlots = 100
-	pool := New(config, blockchain)
+	pool := New(config, log.NewNopLogger(), blockchain)
 	pool.Init(testTxPoolConfig.PriceLimit, blockchain.CurrentBlock(), newReserver())
 	defer pool.Close()
 	fillPool(b, pool)