op-supervisor: Introduce ChainID type. (#11088)

op-supervisor/metrics/metrics.go

 package metrics
 
 import (
-	"math/big"
-
+	"github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types"
 	"github.com/prometheus/client_golang/prometheus"
 
 	opmetrics "github.com/ethereum-optimism/optimism/op-service/metrics"
@@ -16,11 +15,11 @@ type Metricer interface {
 
 	opmetrics.RPCMetricer
 
-	CacheAdd(chainID *big.Int, label string, cacheSize int, evicted bool)
-	CacheGet(chainID *big.Int, label string, hit bool)
+	CacheAdd(chainID types.ChainID, label string, cacheSize int, evicted bool)
+	CacheGet(chainID types.ChainID, label string, hit bool)
 
-	RecordDBEntryCount(chainID *big.Int, count int64)
-	RecordDBSearchEntriesRead(chainID *big.Int, count int64)
+	RecordDBEntryCount(chainID types.ChainID, count int64)
+	RecordDBSearchEntriesRead(chainID types.ChainID, count int64)
 
 	Document() []opmetrics.DocumentedMetric
 }
@@ -141,7 +140,7 @@ func (m *Metrics) RecordUp() {
 	m.up.Set(1)
 }
 
-func (m *Metrics) CacheAdd(chainID *big.Int, label string, cacheSize int, evicted bool) {
+func (m *Metrics) CacheAdd(chainID types.ChainID, label string, cacheSize int, evicted bool) {
 	chain := chainIDLabel(chainID)
 	m.CacheSizeVec.WithLabelValues(chain, label).Set(float64(cacheSize))
 	if evicted {
@@ -151,7 +150,7 @@ func (m *Metrics) CacheAdd(chainID *big.Int, label string, cacheSize int, evicte
 	}
 }
 
-func (m *Metrics) CacheGet(chainID *big.Int, label string, hit bool) {
+func (m *Metrics) CacheGet(chainID types.ChainID, label string, hit bool) {
 	chain := chainIDLabel(chainID)
 	if hit {
 		m.CacheGetVec.WithLabelValues(chain, label, "true").Inc()
@@ -160,14 +159,14 @@ func (m *Metrics) CacheGet(chainID *big.Int, label string, hit bool) {
 	}
 }
 
-func (m *Metrics) RecordDBEntryCount(chainID *big.Int, count int64) {
+func (m *Metrics) RecordDBEntryCount(chainID types.ChainID, count int64) {
 	m.DBEntryCountVec.WithLabelValues(chainIDLabel(chainID)).Set(float64(count))
 }
 
-func (m *Metrics) RecordDBSearchEntriesRead(chainID *big.Int, count int64) {
+func (m *Metrics) RecordDBSearchEntriesRead(chainID types.ChainID, count int64) {
 	m.DBSearchEntriesReadVec.WithLabelValues(chainIDLabel(chainID)).Observe(float64(count))
 }
 
-func chainIDLabel(chainID *big.Int) string {
-	return chainID.Text(10)
+func chainIDLabel(chainID types.ChainID) string {
+	return chainID.String()
 }

op-supervisor/metrics/noop.go

 package metrics
 
 import (
-	"math/big"
-
 	opmetrics "github.com/ethereum-optimism/optimism/op-service/metrics"
+	"github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types"
 )
 
 type noopMetrics struct {
@@ -17,8 +16,8 @@ func (*noopMetrics) Document() []opmetrics.DocumentedMetric { return nil }
 func (*noopMetrics) RecordInfo(version string) {}
 func (*noopMetrics) RecordUp()                 {}
 
-func (m *noopMetrics) CacheAdd(_ *big.Int, _ string, _ int, _ bool) {}
-func (m *noopMetrics) CacheGet(_ *big.Int, _ string, _ bool)        {}
+func (m *noopMetrics) CacheAdd(_ types.ChainID, _ string, _ int, _ bool) {}
+func (m *noopMetrics) CacheGet(_ types.ChainID, _ string, _ bool)        {}
 
-func (m *noopMetrics) RecordDBEntryCount(_ *big.Int, _ int64)        {}
-func (m *noopMetrics) RecordDBSearchEntriesRead(_ *big.Int, _ int64) {}
+func (m *noopMetrics) RecordDBEntryCount(_ types.ChainID, _ int64)        {}
+func (m *noopMetrics) RecordDBSearchEntriesRead(_ types.ChainID, _ int64) {}

op-supervisor/supervisor/backend/backend.go

@@ -5,7 +5,6 @@ import (
 	"errors"
 	"fmt"
 	"io"
-	"math/big"
 	"sync/atomic"
 	"time"
 
@@ -64,16 +63,16 @@ func NewSupervisorBackend(ctx context.Context, logger log.Logger, m Metrics, cfg
 	}, nil
 }
 
-func createRpcClient(ctx context.Context, logger log.Logger, rpc string) (client.RPC, *big.Int, error) {
+func createRpcClient(ctx context.Context, logger log.Logger, rpc string) (client.RPC, types.ChainID, error) {
 	ethClient, err := dial.DialEthClientWithTimeout(ctx, 10*time.Second, logger, rpc)
 	if err != nil {
-		return nil, nil, fmt.Errorf("failed to connect to rpc %v: %w", rpc, err)
+		return nil, types.ChainID{}, fmt.Errorf("failed to connect to rpc %v: %w", rpc, err)
 	}
 	chainID, err := ethClient.ChainID(ctx)
 	if err != nil {
-		return nil, nil, fmt.Errorf("failed to load chain id for rpc %v: %w", rpc, err)
+		return nil, types.ChainID{}, fmt.Errorf("failed to load chain id for rpc %v: %w", rpc, err)
 	}
-	return client.NewBaseRPCClient(ethClient.Client()), chainID, nil
+	return client.NewBaseRPCClient(ethClient.Client()), types.ChainIDFromBig(chainID), nil
 }
 
 func (su *SupervisorBackend) Start(ctx context.Context) error {

op-supervisor/supervisor/backend/chain_metrics.go

 package backend
 
 import (
-	"math/big"
-
 	"github.com/ethereum-optimism/optimism/op-service/sources/caching"
 	"github.com/ethereum-optimism/optimism/op-supervisor/supervisor/backend/db"
+	"github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types"
 )
 
 type Metrics interface {
-	CacheAdd(chainID *big.Int, label string, cacheSize int, evicted bool)
-	CacheGet(chainID *big.Int, label string, hit bool)
+	CacheAdd(chainID types.ChainID, label string, cacheSize int, evicted bool)
+	CacheGet(chainID types.ChainID, label string, hit bool)
 
-	RecordDBEntryCount(chainID *big.Int, count int64)
-	RecordDBSearchEntriesRead(chainID *big.Int, count int64)
+	RecordDBEntryCount(chainID types.ChainID, count int64)
+	RecordDBSearchEntriesRead(chainID types.ChainID, count int64)
 }
 
 // chainMetrics is an adapter between the metrics API expected by clients that assume there's only a single chain
 // and the actual metrics implementation which requires a chain ID to identify the source chain.
 type chainMetrics struct {
-	chainID  *big.Int
+	chainID  types.ChainID
 	delegate Metrics
 }
 
-func newChainMetrics(chainID *big.Int, delegate Metrics) *chainMetrics {
+func newChainMetrics(chainID types.ChainID, delegate Metrics) *chainMetrics {
 	return &chainMetrics{
 		chainID:  chainID,
 		delegate: delegate,

op-supervisor/supervisor/backend/file_layout.go

@@ -2,12 +2,13 @@ package backend
 
 import (
 	"fmt"
-	"math/big"
 	"os"
 	"path/filepath"
+
+	"github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types"
 )
 
-func prepLogDBPath(chainID *big.Int, datadir string) (string, error) {
+func prepLogDBPath(chainID types.ChainID, datadir string) (string, error) {
 	dir, err := prepChainDir(chainID, datadir)
 	if err != nil {
 		return "", err
@@ -15,8 +16,8 @@ func prepLogDBPath(chainID *big.Int, datadir string) (string, error) {
 	return filepath.Join(dir, "log.db"), nil
 }
 
-func prepChainDir(chainID *big.Int, datadir string) (string, error) {
-	dir := filepath.Join(datadir, chainID.Text(10))
+func prepChainDir(chainID types.ChainID, datadir string) (string, error) {
+	dir := filepath.Join(datadir, chainID.String())
 	if err := os.MkdirAll(dir, 0755); err != nil {
 		return "", fmt.Errorf("failed to create chain directory %v: %w", dir, err)
 	}

op-supervisor/supervisor/backend/file_layout_test.go

@@ -6,14 +6,16 @@ import (
 	"path/filepath"
 	"testing"
 
+	"github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types"
 	"github.com/stretchr/testify/require"
 )
 
 func TestLogDBPath(t *testing.T) {
 	base := t.TempDir()
 	chainIDStr := "42984928492928428424243444"
-	chainID, ok := new(big.Int).SetString(chainIDStr, 10)
+	chainIDBig, ok := new(big.Int).SetString(chainIDStr, 10)
 	require.True(t, ok)
+	chainID := types.ChainIDFromBig(chainIDBig)
 	expected := filepath.Join(base, "subdir", chainIDStr, "log.db")
 	path, err := prepLogDBPath(chainID, filepath.Join(base, "subdir"))
 	require.NoError(t, err)

op-supervisor/supervisor/backend/source/chain.go

@@ -3,14 +3,14 @@ package source
 import (
 	"context"
 	"fmt"
-	"math/big"
 	"time"
 
 	"github.com/ethereum-optimism/optimism/op-service/client"
 	"github.com/ethereum-optimism/optimism/op-service/eth"
 	"github.com/ethereum-optimism/optimism/op-service/sources"
 	"github.com/ethereum-optimism/optimism/op-service/sources/caching"
-	"github.com/ethereum/go-ethereum/core/types"
+	"github.com/ethereum-optimism/optimism/op-supervisor/supervisor/types"
+	ethTypes "github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/log"
 )
 
@@ -31,7 +31,7 @@ type ChainMonitor struct {
 	headMonitor *HeadMonitor
 }
 
-func NewChainMonitor(ctx context.Context, logger log.Logger, m Metrics, chainID *big.Int, rpc string, client client.RPC) (*ChainMonitor, error) {
+func NewChainMonitor(ctx context.Context, logger log.Logger, m Metrics, chainID types.ChainID, rpc string, client client.RPC) (*ChainMonitor, error) {
 	logger = logger.New("chainID", chainID)
 	cl, err := newClient(ctx, logger, m, rpc, client, pollInterval, trustRpc, rpcKind)
 	if err != nil {
@@ -67,7 +67,7 @@ type loggingReceiptProcessor struct {
 	log log.Logger
 }
 
-func (n *loggingReceiptProcessor) ProcessLogs(_ context.Context, block eth.L1BlockRef, rcpts types.Receipts) error {
+func (n *loggingReceiptProcessor) ProcessLogs(_ context.Context, block eth.L1BlockRef, rcpts ethTypes.Receipts) error {
 	n.log.Info("Process unsafe block", "block", block, "rcpts", len(rcpts))
 	return nil
 }

op-supervisor/supervisor/types/types.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"math/big"
 
 	"github.com/holiman/uint256"
 
@@ -87,3 +88,17 @@ const (
 	CrossUnsafe SafetyLevel = "cross-unsafe"
 	Unsafe      SafetyLevel = "unsafe"
 )
+
+type ChainID uint256.Int
+
+func ChainIDFromBig(chainID *big.Int) ChainID {
+	return ChainID(*uint256.MustFromBig(chainID))
+}
+
+func ChainIDFromUInt64(i uint64) ChainID {
+	return ChainID(*uint256.NewInt(i))
+}
+
+func (id ChainID) String() string {
+	return ((*uint256.Int)(&id)).Dec()
+}

op-supervisor/supervisor/types/types_test.go

@@ -2,6 +2,7 @@ package types
 
 import (
 	"encoding/json"
+	"math"
 	"testing"
 
 	"github.com/stretchr/testify/require"
@@ -38,3 +39,23 @@ func FuzzRoundtripIdentifierJSONMarshal(f *testing.F) {
 		require.Equal(t, id.ChainID, dec.ChainID)
 	})
 }
+
+func TestChainID_String(t *testing.T) {
+	tests := []struct {
+		input    ChainID
+		expected string
+	}{
+		{ChainIDFromUInt64(0), "0"},
+		{ChainIDFromUInt64(1), "1"},
+		{ChainIDFromUInt64(871975192374), "871975192374"},
+		{ChainIDFromUInt64(math.MaxInt64), "9223372036854775807"},
+		{ChainID(*uint256.NewInt(math.MaxUint64)), "18446744073709551615"},
+		{ChainID(*uint256.MustFromDecimal("1844674407370955161618446744073709551616")), "1844674407370955161618446744073709551616"},
+	}
+	for _, test := range tests {
+		test := test
+		t.Run(test.expected, func(t *testing.T) {
+			require.Equal(t, test.expected, test.input.String())
+		})
+	}
+}