Merge pull request #6453 from ethereum-optimism/aj/more-cannon-inputs

op-challenger: Add cannon-server and cannon-snapshot-freq flag

op-challenger/cmd/main_test.go

@@ -16,6 +16,7 @@ var (
 	l1EthRpc                = "http://example.com:8545"
 	gameAddressValue        = "0xaa00000000000000000000000000000000000000"
 	cannonBin               = "./bin/cannon"
+	cannonServer            = "./bin/op-program"
 	cannonPreState          = "./pre.json"
 	cannonDatadir           = "./test_data"
 	cannonL2                = "http://example.com:9545"
@@ -153,6 +154,21 @@ func TestCannonBin(t *testing.T) {
 	})
 }
 
+func TestCannonServer(t *testing.T) {
+	t.Run("NotRequiredForAlphabetTrace", func(t *testing.T) {
+		configForArgs(t, addRequiredArgsExcept(config.TraceTypeAlphabet, "--cannon-server"))
+	})
+
+	t.Run("Required", func(t *testing.T) {
+		verifyArgsInvalid(t, "flag cannon-server is required", addRequiredArgsExcept(config.TraceTypeCannon, "--cannon-server"))
+	})
+
+	t.Run("Valid", func(t *testing.T) {
+		cfg := configForArgs(t, addRequiredArgsExcept(config.TraceTypeCannon, "--cannon-server", "--cannon-server=./op-program"))
+		require.Equal(t, "./op-program", cfg.CannonServer)
+	})
+}
+
 func TestCannonAbsolutePrestate(t *testing.T) {
 	t.Run("NotRequiredForAlphabetTrace", func(t *testing.T) {
 		configForArgs(t, addRequiredArgsExcept(config.TraceTypeAlphabet, "--cannon-prestate"))
@@ -198,6 +214,18 @@ func TestCannonL2(t *testing.T) {
 	})
 }
 
+func TestCannonSnapshotFreq(t *testing.T) {
+	t.Run("UsesDefault", func(t *testing.T) {
+		cfg := configForArgs(t, addRequiredArgs(config.TraceTypeCannon))
+		require.Equal(t, config.DefaultCannonSnapshotFreq, cfg.CannonSnapshotFreq)
+	})
+
+	t.Run("Valid", func(t *testing.T) {
+		cfg := configForArgs(t, addRequiredArgs(config.TraceTypeCannon, "--cannon-snapshot-freq=1234"))
+		require.Equal(t, uint(1234), cfg.CannonSnapshotFreq)
+	})
+}
+
 func verifyArgsInvalid(t *testing.T, messageContains string, cliArgs []string) {
 	_, _, err := runWithArgs(cliArgs)
 	require.ErrorContains(t, err, messageContains)
@@ -246,6 +274,7 @@ func requiredArgs(traceType config.TraceType) map[string]string {
 		args["--alphabet"] = alphabetTrace
 	case config.TraceTypeCannon:
 		args["--cannon-bin"] = cannonBin
+		args["--cannon-server"] = cannonServer
 		args["--cannon-prestate"] = cannonPreState
 		args["--cannon-datadir"] = cannonDatadir
 		args["--cannon-l2"] = cannonL2

op-challenger/config/config.go

@@ -13,10 +13,12 @@ var (
 	ErrMissingCannonDatadir          = errors.New("missing cannon datadir")
 	ErrMissingCannonL2               = errors.New("missing cannon L2")
 	ErrMissingCannonBin              = errors.New("missing cannon bin")
+	ErrMissingCannonServer           = errors.New("missing cannon server")
 	ErrMissingCannonAbsolutePreState = errors.New("missing cannon absolute pre-state")
 	ErrMissingAlphabetTrace          = errors.New("missing alphabet trace")
 	ErrMissingL1EthRPC               = errors.New("missing l1 eth rpc url")
 	ErrMissingGameAddress            = errors.New("missing game address")
+	ErrMissingCannonSnapshotFreq     = errors.New("missing cannon snapshot freq")
 )
 
 type TraceType string
@@ -50,6 +52,8 @@ func ValidTraceType(value TraceType) bool {
 	return false
 }
 
+const DefaultCannonSnapshotFreq = uint(10_000)
+
 // Config is a well typed config that is parsed from the CLI params.
 // This also contains config options for auxiliary services.
 // It is used to initialize the challenger.
@@ -66,9 +70,11 @@ type Config struct {
 
 	// Specific to the cannon trace provider
 	CannonBin              string // Path to the cannon executable to run when generating trace data
+	CannonServer           string // Path to the op-program executable that provides the pre-image oracle server
 	CannonAbsolutePreState string // File to load the absolute pre-state for Cannon traces from
 	CannonDatadir          string // Cannon Data Directory
 	CannonL2               string // L2 RPC Url
+	CannonSnapshotFreq     uint   // Frequency of snapshots to create when executing cannon (in VM instructions)
 
 	TxMgrConfig txmgr.CLIConfig
 }
@@ -90,6 +96,8 @@ func NewConfig(
 		TraceType: traceType,
 
 		TxMgrConfig: txmgr.NewCLIConfig(l1EthRpc),
+
+		CannonSnapshotFreq: DefaultCannonSnapshotFreq,
 	}
 }
 
@@ -107,6 +115,9 @@ func (c Config) Check() error {
 		if c.CannonBin == "" {
 			return ErrMissingCannonBin
 		}
+		if c.CannonServer == "" {
+			return ErrMissingCannonServer
+		}
 		if c.CannonAbsolutePreState == "" {
 			return ErrMissingCannonAbsolutePreState
 		}
@@ -116,6 +127,9 @@ func (c Config) Check() error {
 		if c.CannonL2 == "" {
 			return ErrMissingCannonL2
 		}
+		if c.CannonSnapshotFreq == 0 {
+			return ErrMissingCannonSnapshotFreq
+		}
 	}
 	if c.TraceType == TraceTypeAlphabet && c.AlphabetTrace == "" {
 		return ErrMissingAlphabetTrace

op-challenger/config/config_test.go

@@ -13,6 +13,7 @@ var (
 	validGameAddress           = common.HexToAddress("0x7bdd3b028C4796eF0EAf07d11394d0d9d8c24139")
 	validAlphabetTrace         = "abcdefgh"
 	validCannonBin             = "./bin/cannon"
+	validCannonOpProgramBin    = "./bin/op-program"
 	validCannonAbsolutPreState = "pre.json"
 	validCannonDatadir         = "/tmp/cannon"
 	validCannonL2              = "http://localhost:9545"
@@ -27,6 +28,7 @@ func validConfig(traceType TraceType) Config {
 		cfg.AlphabetTrace = validAlphabetTrace
 	case TraceTypeCannon:
 		cfg.CannonBin = validCannonBin
+		cfg.CannonServer = validCannonOpProgramBin
 		cfg.CannonAbsolutePreState = validCannonAbsolutPreState
 		cfg.CannonDatadir = validCannonDatadir
 		cfg.CannonL2 = validCannonL2
@@ -77,6 +79,12 @@ func TestCannonBinRequired(t *testing.T) {
 	require.ErrorIs(t, config.Check(), ErrMissingCannonBin)
 }
 
+func TestCannonServerRequired(t *testing.T) {
+	config := validConfig(TraceTypeCannon)
+	config.CannonServer = ""
+	require.ErrorIs(t, config.Check(), ErrMissingCannonServer)
+}
+
 func TestCannonAbsolutePreStateRequired(t *testing.T) {
 	config := validConfig(TraceTypeCannon)
 	config.CannonAbsolutePreState = ""
@@ -94,3 +102,11 @@ func TestCannonL2Required(t *testing.T) {
 	config.CannonL2 = ""
 	require.ErrorIs(t, config.Check(), ErrMissingCannonL2)
 }
+
+func TestCannonSnapshotFreq(t *testing.T) {
+	t.Run("MustNotBeZero", func(t *testing.T) {
+		cfg := validConfig(TraceTypeCannon)
+		cfg.CannonSnapshotFreq = 0
+		require.ErrorIs(t, cfg.Check(), ErrMissingCannonSnapshotFreq)
+	})
+}

op-challenger/flags/flags.go

@@ -63,6 +63,11 @@ var (
 		Usage:   "Path to cannon executable to use when generating trace data (cannon trace type only)",
 		EnvVars: prefixEnvVars("CANNON_BIN"),
 	}
+	CannonServerFlag = &cli.StringFlag{
+		Name:    "cannon-server",
+		Usage:   "Path to executable to use as pre-image oracle server when generating trace data (cannon trace type only)",
+		EnvVars: prefixEnvVars("CANNON_SERVER"),
+	}
 	CannonPreStateFlag = &cli.StringFlag{
 		Name:    "cannon-prestate",
 		Usage:   "Path to absolute prestate to use when generating trace data (cannon trace type only)",
@@ -78,6 +83,12 @@ var (
 		Usage:   "L2 Address of L2 JSON-RPC endpoint to use (eth and debug namespace required)  (cannon trace type only)",
 		EnvVars: prefixEnvVars("CANNON_L2"),
 	}
+	CannonSnapshotFreqFlag = &cli.UintFlag{
+		Name:    "cannon-snapshot-freq",
+		Usage:   "Frequency of cannon snapshots to generate in VM steps (cannon trace type only)",
+		EnvVars: prefixEnvVars("CANNON_SNAPSHOT_FREQ"),
+		Value:   config.DefaultCannonSnapshotFreq,
+	}
 )
 
 // requiredFlags are checked by [CheckRequired]
@@ -93,9 +104,11 @@ var requiredFlags = []cli.Flag{
 var optionalFlags = []cli.Flag{
 	AlphabetFlag,
 	CannonBinFlag,
+	CannonServerFlag,
 	CannonPreStateFlag,
 	CannonDatadirFlag,
 	CannonL2Flag,
+	CannonSnapshotFreqFlag,
 }
 
 func init() {
@@ -120,6 +133,9 @@ func CheckRequired(ctx *cli.Context) error {
 		if !ctx.IsSet(CannonBinFlag.Name) {
 			return fmt.Errorf("flag %s is required", CannonBinFlag.Name)
 		}
+		if !ctx.IsSet(CannonServerFlag.Name) {
+			return fmt.Errorf("flag %s is required", CannonServerFlag.Name)
+		}
 		if !ctx.IsSet(CannonPreStateFlag.Name) {
 			return fmt.Errorf("flag %s is required", CannonPreStateFlag.Name)
 		}
@@ -160,9 +176,11 @@ func NewConfigFromCLI(ctx *cli.Context) (*config.Config, error) {
 		GameAddress:             dgfAddress,
 		AlphabetTrace:           ctx.String(AlphabetFlag.Name),
 		CannonBin:               ctx.String(CannonBinFlag.Name),
+		CannonServer:            ctx.String(CannonServerFlag.Name),
 		CannonAbsolutePreState:  ctx.String(CannonPreStateFlag.Name),
 		CannonDatadir:           ctx.String(CannonDatadirFlag.Name),
 		CannonL2:                ctx.String(CannonL2Flag.Name),
+		CannonSnapshotFreq:      ctx.Uint(CannonSnapshotFreqFlag.Name),
 		AgreeWithProposedOutput: ctx.Bool(AgreeWithProposedOutputFlag.Name),
 		GameDepth:               ctx.Int(GameDepthFlag.Name),
 		TxMgrConfig:             txMgrConfig,