address PR comments

Author: ganeshvanahalli

arbnode/blockmetadata.go

@@ -148,7 +148,7 @@ func (b *BlockMetadataFetcher) persistBlockMetadata(ctx context.Context, query [
 	batch := b.db.NewBatch()
 	queryMap := util.ArrayToSet(query)
 	for _, elem := range result {
-		pos, err := util.BlockNumberToMessageIndex(elem.BlockNumber, b.genesisBlockNum)
+		pos, err := arbutil.BlockNumberToMessageIndex(elem.BlockNumber, b.genesisBlockNum)
 		if err != nil {
 			return err
 		}
@@ -181,8 +181,8 @@ func (b *BlockMetadataFetcher) Update(ctx context.Context) time.Duration {
 	}
 
 	handleQuery := func(query []uint64) bool {
-		fromBlock := util.MessageIndexToBlockNumber(arbutil.MessageIndex(query[0]), b.genesisBlockNum)
-		toBlock := util.MessageIndexToBlockNumber(arbutil.MessageIndex(query[len(query)-1]), b.genesisBlockNum)
+		fromBlock := arbutil.MessageIndexToBlockNumber(arbutil.MessageIndex(query[0]), b.genesisBlockNum)
+		toBlock := arbutil.MessageIndexToBlockNumber(arbutil.MessageIndex(query[len(query)-1]), b.genesisBlockNum)
 
 		result, err := b.fetch(
 			ctx,
@@ -239,7 +239,7 @@ func (b *BlockMetadataFetcher) Update(ctx context.Context) time.Duration {
 func (b *BlockMetadataFetcher) InitializeTrackBlockMetadataFrom() error {
 	var err error
 	if b.startBlockNum != 0 {
-		b.trackBlockMetadataFrom, err = util.BlockNumberToMessageIndex(b.startBlockNum, b.genesisBlockNum)
+		b.trackBlockMetadataFrom, err = arbutil.BlockNumberToMessageIndex(b.startBlockNum, b.genesisBlockNum)
 		if err != nil {
 			return err
 		}

arbnode/transaction_streamer.go

@@ -35,7 +35,6 @@ import (
 	"github.com/offchainlabs/nitro/broadcaster/message"
 	"github.com/offchainlabs/nitro/execution"
 	"github.com/offchainlabs/nitro/staker"
-	"github.com/offchainlabs/nitro/util"
 	"github.com/offchainlabs/nitro/util/arbmath"
 	"github.com/offchainlabs/nitro/util/sharedmetrics"
 	"github.com/offchainlabs/nitro/util/stopwaiter"
@@ -1525,14 +1524,14 @@ func (s *TransactionStreamer) backfillTrackersForMissingBlockMetadata(ctx contex
 func (s *TransactionStreamer) Start(ctxIn context.Context) error {
 	s.StopWaiter.Start(ctxIn, s)
 	if s.config().TrackBlockMetadataFrom != 0 {
-		trackBlockMetadataFrom, err := util.BlockNumberToMessageIndex(s.config().TrackBlockMetadataFrom, s.chainConfig.ArbitrumChainParams.GenesisBlockNum)
+		trackBlockMetadataFrom, err := arbutil.BlockNumberToMessageIndex(s.config().TrackBlockMetadataFrom, s.chainConfig.ArbitrumChainParams.GenesisBlockNum)
 		if err != nil {
 			return err
 		}
 		s.trackBlockMetadataFrom = trackBlockMetadataFrom
 	}
 	if s.config().SyncTillBlock != 0 {
-		syncTillMessage, err := util.BlockNumberToMessageIndex(s.config().SyncTillBlock, s.chainConfig.ArbitrumChainParams.GenesisBlockNum)
+		syncTillMessage, err := arbutil.BlockNumberToMessageIndex(s.config().SyncTillBlock, s.chainConfig.ArbitrumChainParams.GenesisBlockNum)
 		if err != nil {
 			return err
 		}

arbutil/block_message_relation.go

@@ -3,14 +3,18 @@
 
 package arbutil
 
+import "fmt"
+
 // messages are 0-indexed
 type MessageIndex uint64
 
-func BlockNumberToMessageCount(blockNumber uint64, genesisBlockNumber uint64) MessageIndex {
-	return MessageIndex(blockNumber + 1 - genesisBlockNumber)
+func BlockNumberToMessageIndex(blockNum, genesis uint64) (MessageIndex, error) {
+	if blockNum < genesis {
+		return 0, fmt.Errorf("blockNum %d < genesis %d", blockNum, genesis)
+	}
+	return MessageIndex(blockNum - genesis), nil
 }
 
-func MessageCountToBlockNumber(messageCount MessageIndex, genesisBlockNumber uint64) int64 {
-	// #nosec G115
-	return int64(uint64(messageCount)+genesisBlockNumber) - 1
+func MessageIndexToBlockNumber(msgIdx MessageIndex, genesis uint64) uint64 {
+	return uint64(msgIdx) + genesis
 }

cmd/pruning/pruning.go

@@ -206,7 +206,8 @@ func findImportantRoots(ctx context.Context, chainDb ethdb.Database, stack *node
 				return nil, err
 			}
 			if meta.ParentChainBlock <= l1BlockNum {
-				signedBlockNum := arbutil.MessageCountToBlockNumber(meta.MessageCount, genesisNum)
+				// #nosec G115
+				signedBlockNum := int64(arbutil.MessageIndexToBlockNumber(meta.MessageCount, genesisNum)) - 1
 				// #nosec G115
 				blockNum := uint64(signedBlockNum)
 				l2Hash := rawdb.ReadCanonicalHash(chainDb, blockNum)

system_tests/program_test.go

@@ -1909,7 +1909,9 @@ func watFile(name string) string {
 
 func waitForSequencer(t *testing.T, builder *NodeBuilder, block uint64) {
 	t.Helper()
-	msgCount := arbutil.BlockNumberToMessageCount(block, 0)
+	msgIndex, err := arbutil.BlockNumberToMessageIndex(block, 0)
+	Require(t, err)
+	msgCount := msgIndex + 1
 	doUntil(t, 20*time.Millisecond, 500, func() bool {
 		batchCount, err := builder.L2.ConsensusNode.InboxTracker.GetBatchCount()
 		Require(t, err)

util/common.go

@@ -1,26 +1,9 @@
 package util
 
-import (
-	"fmt"
-
-	"github.com/offchainlabs/nitro/arbutil"
-)
-
 func ArrayToSet[T comparable](arr []T) map[T]struct{} {
 	ret := make(map[T]struct{})
 	for _, elem := range arr {
 		ret[elem] = struct{}{}
 	}
 	return ret
 }
-
-func BlockNumberToMessageIndex(blockNum, genesis uint64) (arbutil.MessageIndex, error) {
-	if blockNum < genesis {
-		return 0, fmt.Errorf("blockNum %d < genesis %d", blockNum, genesis)
-	}
-	return arbutil.MessageIndex(blockNum - genesis), nil
-}
-
-func MessageIndexToBlockNumber(msgIdx arbutil.MessageIndex, genesis uint64) uint64 {
-	return uint64(msgIdx) + genesis
-}