Merge pull request #7003 from ethereum-optimism/refcell/delete-caller

fix(op-challenger): Combine Fault Caller and Loader Components

op-challenger/fault/agent.go

@@ -19,9 +19,13 @@ type Responder interface {
 	Step(ctx context.Context, stepData types.StepCallData) error
 }
 
+type ClaimLoader interface {
+	FetchClaims(ctx context.Context) ([]types.Claim, error)
+}
+
 type Agent struct {
 	solver                  *solver.Solver
-	loader                  Loader
+	loader                  ClaimLoader
 	responder               Responder
 	updater                 types.OracleUpdater
 	maxDepth                int
@@ -29,7 +33,7 @@ type Agent struct {
 	log                     log.Logger
 }
 
-func NewAgent(loader Loader, maxDepth int, trace types.TraceProvider, responder Responder, updater types.OracleUpdater, agreeWithProposedOutput bool, log log.Logger) *Agent {
+func NewAgent(loader ClaimLoader, maxDepth int, trace types.TraceProvider, responder Responder, updater types.OracleUpdater, agreeWithProposedOutput bool, log log.Logger) *Agent {
 	return &Agent{
 		solver:                  solver.NewSolver(maxDepth, trace),
 		loader:                  loader,

op-challenger/fault/caller.go

-package fault
-
-import (
-	"context"
-	"math/big"
-
-	"github.com/ethereum-optimism/optimism/op-bindings/bindings"
-	"github.com/ethereum-optimism/optimism/op-challenger/fault/types"
-	"github.com/ethereum/go-ethereum/accounts/abi/bind"
-	"github.com/ethereum/go-ethereum/common"
-)
-
-type FaultDisputeGameCaller interface {
-	Status(opts *bind.CallOpts) (uint8, error)
-	ClaimDataLen(opts *bind.CallOpts) (*big.Int, error)
-}
-
-type FaultCaller struct {
-	contract FaultDisputeGameCaller
-}
-
-func NewFaultCaller(caller FaultDisputeGameCaller) *FaultCaller {
-	return &FaultCaller{
-		caller,
-	}
-}
-
-func NewFaultCallerFromBindings(fdgAddr common.Address, client bind.ContractCaller) (*FaultCaller, error) {
-	caller, err := bindings.NewFaultDisputeGameCaller(fdgAddr, client)
-	if err != nil {
-		return nil, err
-	}
-	return &FaultCaller{
-		caller,
-	}, nil
-}
-
-// GetGameStatus returns the current game status.
-// 0: In Progress
-// 1: Challenger Won
-// 2: Defender Won
-func (fc *FaultCaller) GetGameStatus(ctx context.Context) (types.GameStatus, error) {
-	status, err := fc.contract.Status(&bind.CallOpts{Context: ctx})
-	return types.GameStatus(status), err
-}
-
-// GetClaimCount returns the number of claims in the game.
-func (fc *FaultCaller) GetClaimCount(ctx context.Context) (uint64, error) {
-	count, err := fc.contract.ClaimDataLen(&bind.CallOpts{Context: ctx})
-	if err != nil {
-		return 0, err
-	}
-	return count.Uint64(), nil
-}

op-challenger/fault/caller_test.go

-package fault
-
-import (
-	"context"
-	"errors"
-	"math/big"
-	"testing"
-
-	"github.com/ethereum-optimism/optimism/op-challenger/fault/types"
-	"github.com/ethereum/go-ethereum/accounts/abi/bind"
-	"github.com/stretchr/testify/require"
-)
-
-var (
-	errMock = errors.New("mock error")
-)
-
-type mockFaultDisputeGameCaller struct {
-	status    uint8
-	errStatus bool
-
-	claimDataLen    *big.Int
-	errClaimDataLen bool
-}
-
-func (m *mockFaultDisputeGameCaller) Status(opts *bind.CallOpts) (uint8, error) {
-	if m.errStatus {
-		return 0, errMock
-	}
-	return m.status, nil
-}
-
-func (m *mockFaultDisputeGameCaller) ClaimDataLen(opts *bind.CallOpts) (*big.Int, error) {
-	if m.errClaimDataLen {
-		return nil, errMock
-	}
-	return m.claimDataLen, nil
-}
-
-func TestFaultCaller_GetGameStatus(t *testing.T) {
-	tests := []struct {
-		name           string
-		caller         FaultDisputeGameCaller
-		expectedStatus types.GameStatus
-		expectedErr    error
-	}{
-		{
-			name: "success",
-			caller: &mockFaultDisputeGameCaller{
-				status: 1,
-			},
-			expectedStatus: types.GameStatusChallengerWon,
-			expectedErr:    nil,
-		},
-		{
-			name: "error",
-			caller: &mockFaultDisputeGameCaller{
-				errStatus: true,
-			},
-			expectedStatus: 0,
-			expectedErr:    errMock,
-		},
-	}
-
-	for _, test := range tests {
-		t.Run(test.name, func(t *testing.T) {
-			fc := NewFaultCaller(test.caller)
-			status, err := fc.GetGameStatus(context.Background())
-			require.Equal(t, test.expectedStatus, status)
-			require.Equal(t, test.expectedErr, err)
-		})
-	}
-}
-
-func TestFaultCaller_GetClaimCount(t *testing.T) {
-	tests := []struct {
-		name                 string
-		caller               FaultDisputeGameCaller
-		expectedClaimDataLen uint64
-		expectedErr          error
-	}{
-		{
-			name: "success",
-			caller: &mockFaultDisputeGameCaller{
-				claimDataLen: big.NewInt(1),
-			},
-			expectedClaimDataLen: 1,
-			expectedErr:          nil,
-		},
-		{
-			name: "error",
-			caller: &mockFaultDisputeGameCaller{
-				errClaimDataLen: true,
-			},
-			expectedClaimDataLen: 0,
-			expectedErr:          errMock,
-		},
-	}
-
-	for _, test := range tests {
-		t.Run(test.name, func(t *testing.T) {
-			fc := NewFaultCaller(test.caller)
-			claimDataLen, err := fc.GetClaimCount(context.Background())
-			require.Equal(t, test.expectedClaimDataLen, claimDataLen)
-			require.Equal(t, test.expectedErr, err)
-		})
-	}
-}

op-challenger/fault/factory_test.go

@@ -6,10 +6,10 @@ import (
 	"math/big"
 	"testing"
 
-	"github.com/ethereum/go-ethereum/accounts/abi/bind"
+	"github.com/ethereum-optimism/optimism/op-challenger/fault/types"
 
+	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
-
 	"github.com/stretchr/testify/require"
 )
 
@@ -144,6 +144,9 @@ func newMockMinimalDisputeGameFactoryCaller(count uint64, gameCountErr bool, ind
 		games:        generateMockGames(count),
 	}
 }
+func (m *mockMinimalDisputeGameFactoryCaller) Status(opts *bind.CallOpts) (uint8, error) {
+	return uint8(types.GameStatusInProgress), nil
+}
 
 func (m *mockMinimalDisputeGameFactoryCaller) GameCount(opts *bind.CallOpts) (*big.Int, error) {
 	if m.gameCountErr {

op-challenger/fault/loader.go

@@ -4,8 +4,11 @@ import (
 	"context"
 	"math/big"
 
+	"github.com/ethereum-optimism/optimism/op-bindings/bindings"
 	"github.com/ethereum-optimism/optimism/op-challenger/fault/types"
+
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
+	"github.com/ethereum/go-ethereum/common"
 )
 
 // MinimalFaultDisputeGameCaller is a minimal interface around [bindings.FaultDisputeGameCaller].
@@ -18,18 +21,12 @@ type MinimalFaultDisputeGameCaller interface {
 		Position    *big.Int
 		Clock       *big.Int
 	}, error)
+	Status(opts *bind.CallOpts) (uint8, error)
 	ClaimDataLen(opts *bind.CallOpts) (*big.Int, error)
 	MAXGAMEDEPTH(opts *bind.CallOpts) (*big.Int, error)
 	ABSOLUTEPRESTATE(opts *bind.CallOpts) ([32]byte, error)
 }
 
-// Loader is a minimal interface for loading onchain [Claim] data.
-type Loader interface {
-	FetchClaims(ctx context.Context) ([]types.Claim, error)
-	FetchGameDepth(ctx context.Context) (uint64, error)
-	FetchAbsolutePrestateHash(ctx context.Context) ([]byte, error)
-}
-
 // loader pulls in fault dispute game claim data periodically and over subscriptions.
 type loader struct {
 	caller MinimalFaultDisputeGameCaller
@@ -42,6 +39,30 @@ func NewLoader(caller MinimalFaultDisputeGameCaller) *loader {
 	}
 }
 
+// NewLoaderFromBindings creates a new [loader] from a [bindings.FaultDisputeGameCaller].
+func NewLoaderFromBindings(fdgAddr common.Address, client bind.ContractCaller) (*loader, error) {
+	caller, err := bindings.NewFaultDisputeGameCaller(fdgAddr, client)
+	if err != nil {
+		return nil, err
+	}
+	return NewLoader(caller), nil
+}
+
+// GetGameStatus returns the current game status.
+func (l *loader) GetGameStatus(ctx context.Context) (types.GameStatus, error) {
+	status, err := l.caller.Status(&bind.CallOpts{Context: ctx})
+	return types.GameStatus(status), err
+}
+
+// GetClaimCount returns the number of claims in the game.
+func (l *loader) GetClaimCount(ctx context.Context) (uint64, error) {
+	count, err := l.caller.ClaimDataLen(&bind.CallOpts{Context: ctx})
+	if err != nil {
+		return 0, err
+	}
+	return count.Uint64(), nil
+}
+
 // FetchGameDepth fetches the game depth from the fault dispute game.
 func (l *loader) FetchGameDepth(ctx context.Context) (uint64, error) {
 	callOpts := bind.CallOpts{

op-challenger/fault/loader_test.go

@@ -18,15 +18,171 @@ var (
 	mockClaimLenError     = fmt.Errorf("claim len errored")
 	mockMaxGameDepthError = fmt.Errorf("max game depth errored")
 	mockPrestateError     = fmt.Errorf("prestate errored")
+	mockStatusError       = fmt.Errorf("status errored")
 )
 
+// TestLoader_GetGameStatus tests fetching the game status.
+func TestLoader_GetGameStatus(t *testing.T) {
+	tests := []struct {
+		name          string
+		status        uint8
+		expectedError bool
+	}{
+		{
+			name:   "challenger won status",
+			status: uint8(types.GameStatusChallengerWon),
+		},
+		{
+			name:   "defender won status",
+			status: uint8(types.GameStatusDefenderWon),
+		},
+		{
+			name:   "in progress status",
+			status: uint8(types.GameStatusInProgress),
+		},
+		{
+			name:          "error bubbled up",
+			expectedError: true,
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			mockCaller := newMockCaller()
+			mockCaller.status = test.status
+			mockCaller.statusError = test.expectedError
+			loader := NewLoader(mockCaller)
+			status, err := loader.GetGameStatus(context.Background())
+			if test.expectedError {
+				require.ErrorIs(t, err, mockStatusError)
+			} else {
+				require.NoError(t, err)
+				require.Equal(t, types.GameStatus(test.status), status)
+			}
+		})
+	}
+}
+
+// TestLoader_FetchGameDepth tests fetching the game depth.
+func TestLoader_FetchGameDepth(t *testing.T) {
+	t.Run("Succeeds", func(t *testing.T) {
+		mockCaller := newMockCaller()
+		mockCaller.maxGameDepth = 10
+		loader := NewLoader(mockCaller)
+		depth, err := loader.FetchGameDepth(context.Background())
+		require.NoError(t, err)
+		require.Equal(t, uint64(10), depth)
+	})
+
+	t.Run("Errors", func(t *testing.T) {
+		mockCaller := newMockCaller()
+		mockCaller.maxGameDepthError = true
+		loader := NewLoader(mockCaller)
+		depth, err := loader.FetchGameDepth(context.Background())
+		require.ErrorIs(t, mockMaxGameDepthError, err)
+		require.Equal(t, depth, uint64(0))
+	})
+}
+
+// TestLoader_FetchAbsolutePrestateHash tests fetching the absolute prestate hash.
+func TestLoader_FetchAbsolutePrestateHash(t *testing.T) {
+	t.Run("Succeeds", func(t *testing.T) {
+		mockCaller := newMockCaller()
+		loader := NewLoader(mockCaller)
+		prestate, err := loader.FetchAbsolutePrestateHash(context.Background())
+		require.NoError(t, err)
+		require.ElementsMatch(t, common.HexToHash("0xdEad"), prestate)
+	})
+
+	t.Run("Errors", func(t *testing.T) {
+		mockCaller := newMockCaller()
+		mockCaller.prestateError = true
+		loader := NewLoader(mockCaller)
+		prestate, err := loader.FetchAbsolutePrestateHash(context.Background())
+		require.Error(t, err)
+		require.ElementsMatch(t, common.Hash{}, prestate)
+	})
+}
+
+// TestLoader_FetchClaims tests fetching claims.
+func TestLoader_FetchClaims(t *testing.T) {
+	t.Run("Succeeds", func(t *testing.T) {
+		mockCaller := newMockCaller()
+		expectedClaims := mockCaller.returnClaims
+		loader := NewLoader(mockCaller)
+		claims, err := loader.FetchClaims(context.Background())
+		require.NoError(t, err)
+		require.ElementsMatch(t, []types.Claim{
+			{
+				ClaimData: types.ClaimData{
+					Value:    expectedClaims[0].Claim,
+					Position: types.NewPositionFromGIndex(expectedClaims[0].Position.Uint64()),
+				},
+				Parent: types.ClaimData{
+					Value:    expectedClaims[0].Claim,
+					Position: types.NewPositionFromGIndex(expectedClaims[0].Position.Uint64()),
+				},
+				Countered:     false,
+				Clock:         uint64(0),
+				ContractIndex: 0,
+			},
+			{
+				ClaimData: types.ClaimData{
+					Value:    expectedClaims[1].Claim,
+					Position: types.NewPositionFromGIndex(expectedClaims[1].Position.Uint64()),
+				},
+				Parent: types.ClaimData{
+					Value:    expectedClaims[0].Claim,
+					Position: types.NewPositionFromGIndex(expectedClaims[1].Position.Uint64()),
+				},
+				Countered:     false,
+				Clock:         uint64(0),
+				ContractIndex: 1,
+			},
+			{
+				ClaimData: types.ClaimData{
+					Value:    expectedClaims[2].Claim,
+					Position: types.NewPositionFromGIndex(expectedClaims[2].Position.Uint64()),
+				},
+				Parent: types.ClaimData{
+					Value:    expectedClaims[0].Claim,
+					Position: types.NewPositionFromGIndex(expectedClaims[2].Position.Uint64()),
+				},
+				Countered:     false,
+				Clock:         uint64(0),
+				ContractIndex: 2,
+			},
+		}, claims)
+	})
+
+	t.Run("Claim Data Errors", func(t *testing.T) {
+		mockCaller := newMockCaller()
+		mockCaller.claimDataError = true
+		loader := NewLoader(mockCaller)
+		claims, err := loader.FetchClaims(context.Background())
+		require.ErrorIs(t, err, mockClaimDataError)
+		require.Empty(t, claims)
+	})
+
+	t.Run("Claim Len Errors", func(t *testing.T) {
+		mockCaller := newMockCaller()
+		mockCaller.claimLenError = true
+		loader := NewLoader(mockCaller)
+		claims, err := loader.FetchClaims(context.Background())
+		require.ErrorIs(t, err, mockClaimLenError)
+		require.Empty(t, claims)
+	})
+}
+
 type mockCaller struct {
 	claimDataError    bool
 	claimLenError     bool
 	maxGameDepthError bool
 	prestateError     bool
+	statusError       bool
 	maxGameDepth      uint64
 	currentIndex      uint64
+	status            uint8
 	returnClaims      []struct {
 		ParentIndex uint32
 		Countered   bool
@@ -88,6 +244,13 @@ func (m *mockCaller) ClaimData(opts *bind.CallOpts, arg0 *big.Int) (struct {
 	return returnClaim, nil
 }
 
+func (m *mockCaller) Status(opts *bind.CallOpts) (uint8, error) {
+	if m.statusError {
+		return 0, mockStatusError
+	}
+	return m.status, nil
+}
+
 func (m *mockCaller) ClaimDataLen(opts *bind.CallOpts) (*big.Int, error) {
 	if m.claimLenError {
 		return big.NewInt(0), mockClaimLenError
@@ -108,116 +271,3 @@ func (m *mockCaller) ABSOLUTEPRESTATE(opts *bind.CallOpts) ([32]byte, error) {
 	}
 	return common.HexToHash("0xdEad"), nil
 }
-
-// TestLoader_FetchGameDepth tests [loader.FetchGameDepth].
-func TestLoader_FetchGameDepth(t *testing.T) {
-	t.Run("Succeeds", func(t *testing.T) {
-		mockCaller := newMockCaller()
-		mockCaller.maxGameDepth = 10
-		loader := NewLoader(mockCaller)
-		depth, err := loader.FetchGameDepth(context.Background())
-		require.NoError(t, err)
-		require.Equal(t, uint64(10), depth)
-	})
-
-	t.Run("Errors", func(t *testing.T) {
-		mockCaller := newMockCaller()
-		mockCaller.maxGameDepthError = true
-		loader := NewLoader(mockCaller)
-		depth, err := loader.FetchGameDepth(context.Background())
-		require.ErrorIs(t, mockMaxGameDepthError, err)
-		require.Equal(t, depth, uint64(0))
-	})
-}
-
-// TestLoader_FetchAbsolutePrestateHash tests the [loader.FetchAbsolutePrestateHash] function.
-func TestLoader_FetchAbsolutePrestateHash(t *testing.T) {
-	t.Run("Succeeds", func(t *testing.T) {
-		mockCaller := newMockCaller()
-		loader := NewLoader(mockCaller)
-		prestate, err := loader.FetchAbsolutePrestateHash(context.Background())
-		require.NoError(t, err)
-		require.ElementsMatch(t, common.HexToHash("0xdEad"), prestate)
-	})
-
-	t.Run("Errors", func(t *testing.T) {
-		mockCaller := newMockCaller()
-		mockCaller.prestateError = true
-		loader := NewLoader(mockCaller)
-		prestate, err := loader.FetchAbsolutePrestateHash(context.Background())
-		require.Error(t, err)
-		require.ElementsMatch(t, common.Hash{}, prestate)
-	})
-}
-
-// TestLoader_FetchClaims_Succeeds tests [loader.FetchClaims].
-func TestLoader_FetchClaims_Succeeds(t *testing.T) {
-	mockCaller := newMockCaller()
-	expectedClaims := mockCaller.returnClaims
-	loader := NewLoader(mockCaller)
-	claims, err := loader.FetchClaims(context.Background())
-	require.NoError(t, err)
-	require.ElementsMatch(t, []types.Claim{
-		{
-			ClaimData: types.ClaimData{
-				Value:    expectedClaims[0].Claim,
-				Position: types.NewPositionFromGIndex(expectedClaims[0].Position.Uint64()),
-			},
-			Parent: types.ClaimData{
-				Value:    expectedClaims[0].Claim,
-				Position: types.NewPositionFromGIndex(expectedClaims[0].Position.Uint64()),
-			},
-			Countered:     false,
-			Clock:         uint64(0),
-			ContractIndex: 0,
-		},
-		{
-			ClaimData: types.ClaimData{
-				Value:    expectedClaims[1].Claim,
-				Position: types.NewPositionFromGIndex(expectedClaims[1].Position.Uint64()),
-			},
-			Parent: types.ClaimData{
-				Value:    expectedClaims[0].Claim,
-				Position: types.NewPositionFromGIndex(expectedClaims[1].Position.Uint64()),
-			},
-			Countered:     false,
-			Clock:         uint64(0),
-			ContractIndex: 1,
-		},
-		{
-			ClaimData: types.ClaimData{
-				Value:    expectedClaims[2].Claim,
-				Position: types.NewPositionFromGIndex(expectedClaims[2].Position.Uint64()),
-			},
-			Parent: types.ClaimData{
-				Value:    expectedClaims[0].Claim,
-				Position: types.NewPositionFromGIndex(expectedClaims[2].Position.Uint64()),
-			},
-			Countered:     false,
-			Clock:         uint64(0),
-			ContractIndex: 2,
-		},
-	}, claims)
-}
-
-// TestLoader_FetchClaims_ClaimDataErrors tests [loader.FetchClaims]
-// when the claim fetcher [ClaimData] function call errors.
-func TestLoader_FetchClaims_ClaimDataErrors(t *testing.T) {
-	mockCaller := newMockCaller()
-	mockCaller.claimDataError = true
-	loader := NewLoader(mockCaller)
-	claims, err := loader.FetchClaims(context.Background())
-	require.ErrorIs(t, err, mockClaimDataError)
-	require.Empty(t, claims)
-}
-
-// TestLoader_FetchClaims_ClaimLenErrors tests [loader.FetchClaims]
-// when the claim fetcher [ClaimDataLen] function call errors.
-func TestLoader_FetchClaims_ClaimLenErrors(t *testing.T) {
-	mockCaller := newMockCaller()
-	mockCaller.claimLenError = true
-	loader := NewLoader(mockCaller)
-	claims, err := loader.FetchClaims(context.Background())
-	require.ErrorIs(t, err, mockClaimLenError)
-	require.Empty(t, claims)
-}

op-challenger/fault/player.go

@@ -27,7 +27,7 @@ type GameInfo interface {
 type GamePlayer struct {
 	agent                   Actor
 	agreeWithProposedOutput bool
-	caller                  GameInfo
+	loader                  GameInfo
 	logger                  log.Logger
 
 	completed bool
@@ -84,15 +84,10 @@ func NewGamePlayer(
 		return nil, fmt.Errorf("failed to create the responder: %w", err)
 	}
 
-	caller, err := NewFaultCallerFromBindings(addr, client)
-	if err != nil {
-		return nil, fmt.Errorf("failed to bind the fault contract: %w", err)
-	}
-
 	return &GamePlayer{
 		agent:                   NewAgent(loader, int(gameDepth), provider, responder, updater, cfg.AgreeWithProposedOutput, logger),
 		agreeWithProposedOutput: cfg.AgreeWithProposedOutput,
-		caller:                  caller,
+		loader:                  loader,
 		logger:                  logger,
 	}, nil
 }
@@ -107,7 +102,7 @@ func (g *GamePlayer) ProgressGame(ctx context.Context) bool {
 	if err := g.agent.Act(ctx); err != nil {
 		g.logger.Error("Error when acting on game", "err", err)
 	}
-	if status, err := g.caller.GetGameStatus(ctx); err != nil {
+	if status, err := g.loader.GetGameStatus(ctx); err != nil {
 		g.logger.Warn("Unable to retrieve game status", "err", err)
 	} else {
 		g.logGameStatus(ctx, status)
@@ -119,7 +114,7 @@ func (g *GamePlayer) ProgressGame(ctx context.Context) bool {
 
 func (g *GamePlayer) logGameStatus(ctx context.Context, status types.GameStatus) {
 	if status == types.GameStatusInProgress {
-		claimCount, err := g.caller.GetClaimCount(ctx)
+		claimCount, err := g.loader.GetClaimCount(ctx)
 		if err != nil {
 			g.logger.Error("Failed to get claim count for in progress game", "err", err)
 			return

op-challenger/fault/player_test.go

@@ -115,7 +115,7 @@ func setupProgressGameTest(t *testing.T, agreeWithProposedRoot bool) (*testlog.C
 	game := &GamePlayer{
 		agent:                   gameState,
 		agreeWithProposedOutput: agreeWithProposedRoot,
-		caller:                  gameState,
+		loader:                  gameState,
 		logger:                  logger,
 	}
 	return handler, game, gameState

op-challenger/fault/service.go

@@ -19,13 +19,16 @@ import (
 	"github.com/ethereum/go-ethereum/log"
 )
 
-// Service provides a clean interface for the challenger to interact
-// with the fault package.
+// Service exposes top-level fault dispute game challenger functionality.
 type Service interface {
 	// MonitorGame monitors the fault dispute game and attempts to progress it.
 	MonitorGame(context.Context) error
 }
 
+type Loader interface {
+	FetchAbsolutePrestateHash(ctx context.Context) ([]byte, error)
+}
+
 type service struct {
 	logger  log.Logger
 	metrics metrics.Metricer