Merge pull request #6951 from ethereum-optimism/refcell/remove-old-cannon-dirs

feat(op-challenger): Game Player and Cannon Cleanup

op-challenger/fault/cannon/provider.go

@@ -118,6 +118,10 @@ func (p *CannonTraceProvider) AbsolutePreState(ctx context.Context) ([]byte, err
 	return state.EncodeWitness(), nil
 }
 
+func (p *CannonTraceProvider) Cleanup() error {
+	return os.RemoveAll(p.dir)
+}
+
 // loadProof will attempt to load or generate the proof data at the specified index
 // If the requested index is beyond the end of the actual trace it is extended with no-op instructions.
 func (p *CannonTraceProvider) loadProof(ctx context.Context, i uint64) (*proofData, error) {

op-challenger/fault/cannon/provider_test.go

@@ -204,6 +204,14 @@ func TestUseGameSpecificSubdir(t *testing.T) {
 	require.Equal(t, filepath.Join(dataDir, gameDirName), provider.dir, "should use game specific subdir")
 }
 
+func TestCleanup(t *testing.T) {
+	dataDir, prestate := setupTestData(t)
+	provider, _ := setupWithTestData(t, dataDir, prestate)
+	require.NoError(t, provider.Cleanup())
+	_, err := os.Stat(dataDir)
+	require.ErrorIs(t, err, os.ErrNotExist)
+}
+
 func setupPreState(t *testing.T, dataDir string, filename string) {
 	srcDir := filepath.Join("test_data")
 	path := filepath.Join(srcDir, filename)

op-challenger/fault/player.go

@@ -29,6 +29,7 @@ type GamePlayer struct {
 	agreeWithProposedOutput bool
 	caller                  GameInfo
 	logger                  log.Logger
+	cleanup                 func() error
 }
 
 func NewGamePlayer(
@@ -54,18 +55,22 @@ func NewGamePlayer(
 
 	var provider types.TraceProvider
 	var updater types.OracleUpdater
+	var cleanup func() error
 	switch cfg.TraceType {
 	case config.TraceTypeCannon:
-		provider, err = cannon.NewTraceProvider(ctx, logger, cfg, client, addr)
+		cannonProvider, err := cannon.NewTraceProvider(ctx, logger, cfg, client, addr)
 		if err != nil {
 			return nil, fmt.Errorf("create cannon trace provider: %w", err)
 		}
+		cleanup = cannonProvider.Cleanup
+		provider = cannonProvider
 		updater, err = cannon.NewOracleUpdater(ctx, logger, txMgr, addr, client)
 		if err != nil {
 			return nil, fmt.Errorf("failed to create the cannon updater: %w", err)
 		}
 	case config.TraceTypeAlphabet:
 		provider = alphabet.NewTraceProvider(cfg.AlphabetTrace, gameDepth)
+		cleanup = func() error { return nil }
 		updater = alphabet.NewOracleUpdater(logger)
 	default:
 		return nil, fmt.Errorf("unsupported trace type: %v", cfg.TraceType)
@@ -90,6 +95,7 @@ func NewGamePlayer(
 		agreeWithProposedOutput: cfg.AgreeWithProposedOutput,
 		caller:                  caller,
 		logger:                  logger,
+		cleanup:                 cleanup,
 	}, nil
 }
 
@@ -129,3 +135,7 @@ func (g *GamePlayer) logGameStatus(ctx context.Context, status types.GameStatus)
 		g.logger.Error("Game lost", "status", status)
 	}
 }
+
+func (g *GamePlayer) Cleanup() error {
+	return g.cleanup()
+}

op-challenger/fault/player_test.go

@@ -27,6 +27,24 @@ func TestProgressGame_LogErrorFromAct(t *testing.T) {
 	require.Equal(t, uint64(1), msg.GetContextValue("claims"))
 }
 
+func TestCleanup(t *testing.T) {
+	t.Run("default cleanup", func(t *testing.T) {
+		game := &GamePlayer{
+			cleanup: func() error { return nil },
+		}
+		require.NoError(t, game.Cleanup())
+	})
+
+	t.Run("cleanup bubbles up error", func(t *testing.T) {
+		err := errors.New("wassie")
+		game := &GamePlayer{
+			cleanup: func() error { return err },
+		}
+		require.Error(t, err, game.Cleanup())
+	})
+
+}
+
 func TestProgressGame_LogGameStatus(t *testing.T) {
 	tests := []struct {
 		name            string