Merge branch 'develop' into aj/fpp-allow-new-named-configs

.circleci/config.yml

@@ -1275,6 +1275,9 @@ workflows:
       - go-lint:
           name: op-proposer-lint
           module: op-proposer
+      - go-lint:
+          name: op-challenger-lint
+          module: op-challenger
       - go-lint:
           name: op-program-lint
           module: op-program
@@ -1300,6 +1303,9 @@ workflows:
       - go-test:
           name: op-proposer-tests
           module: op-proposer
+      - go-test:
+          name: op-challenger-tests
+          module: op-challenger
       - go-test:
           name: op-program-tests
           module: op-program
@@ -1322,6 +1328,7 @@ workflows:
             - op-e2e-lint
             - op-node-lint
             - op-proposer-lint
+            - op-challenger-lint
             - op-program-lint
             - op-service-lint
             - op-batcher-tests
@@ -1329,6 +1336,7 @@ workflows:
             - op-chain-ops-tests
             - op-node-tests
             - op-proposer-tests
+            - op-challenger-tests
             - op-program-tests
             - op-service-tests
             - op-e2e-WS-tests
@@ -1389,6 +1397,20 @@ workflows:
           context:
             - oplabs-gcr
           platforms: "linux/amd64,linux/arm64"
+      - docker-build:
+          name: op-challenger-docker-build
+          docker_file: op-challenger/Dockerfile
+          docker_name: op-challenger
+          docker_tags: <<pipeline.git.revision>>,<<pipeline.git.branch>>
+          docker_context: .
+      - docker-publish:
+          name: op-challenger-docker-publish
+          docker_file: op-challenger/Dockerfile
+          docker_name: op-challenger
+          docker_tags: <<pipeline.git.revision>>,<<pipeline.git.branch>>
+          context:
+            - oplabs-gcr
+          platforms: "linux/amd64,linux/arm64"
       - docker-build:
           name: op-heartbeat-docker-build
           docker_file: op-heartbeat/Dockerfile
@@ -1431,6 +1453,7 @@ workflows:
             - op-node-docker-build
             - op-batcher-docker-build
             - op-proposer-docker-build
+            - op-challenger-docker-build
       - hive-test:
           name: hive-test-p2p
           version: <<pipeline.git.revision>>
@@ -1439,6 +1462,7 @@ workflows:
             - op-node-docker-build
             - op-batcher-docker-build
             - op-proposer-docker-build
+            - op-challenger-docker-build
       - hive-test:
           name: hive-test-l1ops
           version: <<pipeline.git.revision>>
@@ -1447,6 +1471,7 @@ workflows:
             - op-node-docker-build
             - op-batcher-docker-build
             - op-proposer-docker-build
+            - op-challenger-docker-build
   release:
     jobs:
       - hold:
@@ -1504,6 +1529,22 @@ workflows:
             - oplabs-gcr-release
           requires:
             - hold
+      - docker-release:
+          name: op-challenger-docker-release
+          filters:
+            tags:
+              only: /^op-challenger\/v.*/
+            branches:
+              ignore: /.*/
+          docker_file: op-challenger/Dockerfile
+          docker_name: op-challenger
+          docker_tags: <<pipeline.git.revision>>,<<pipeline.git.branch>>
+          docker_context: .
+          platforms: "linux/amd64,linux/arm64"
+          context:
+            - oplabs-gcr-release
+          requires:
+            - hold
       - docker-build:
           name: op-migrate-docker-release
           filters:

Makefile

@@ -40,6 +40,10 @@ op-proposer:
 	make -C ./op-proposer op-proposer
 .PHONY: op-proposer
 
+op-challenger:
+	make -C ./op-challenger op-challenger
+.PHONY: op-challenger
+
 op-program:
 	make -C ./op-program op-program
 .PHONY: op-program

op-challenger/.gitignore

+bin

op-challenger/Dockerfile

+FROM --platform=$BUILDPLATFORM golang:1.19.0-alpine3.15 as builder
+
+ARG VERSION=v0.0.0
+
+RUN apk add --no-cache make gcc musl-dev linux-headers git jq bash
+
+# build op-challenger with the shared go.mod & go.sum files
+COPY ./op-challenger /app/op-challenger
+COPY ./op-bindings /app/op-bindings
+COPY ./op-node /app/op-node
+COPY ./op-service /app/op-service
+COPY ./op-signer /app/op-signer
+COPY ./go.mod /app/go.mod
+COPY ./go.sum /app/go.sum
+COPY ./.git /app/.git
+
+WORKDIR /app/op-challenger
+
+RUN go mod download
+
+ARG TARGETOS TARGETARCH
+
+RUN make op-challenger VERSION="$VERSION" GOOS=$TARGETOS GOARCH=$TARGETARCH
+
+FROM alpine:3.15
+
+COPY --from=builder /app/op-challenger/bin/op-challenger /usr/local/bin
+
+CMD ["op-challenger"]

op-challenger/Makefile

+GITCOMMIT := $(shell git rev-parse HEAD)
+GITDATE := $(shell git show -s --format='%ct')
+VERSION := v0.0.0
+
+LDFLAGSSTRING +=-X main.GitCommit=$(GITCOMMIT)
+LDFLAGSSTRING +=-X main.GitDate=$(GITDATE)
+LDFLAGSSTRING +=-X main.Version=$(VERSION)
+LDFLAGS := -ldflags "$(LDFLAGSSTRING)"
+
+op-challenger:
+	env GO111MODULE=on GOOS=$(TARGETOS) GOARCH=$(TARGETARCH) go build -v $(LDFLAGS) -o ./bin/op-challenger ./cmd
+
+clean:
+	rm bin/op-challenger
+
+test:
+	go test -v ./...
+
+lint:
+	golangci-lint run -E goimports,sqlclosecheck,bodyclose,asciicheck,misspell,errorlint -e "errors.As" -e "errors.Is"
+
+.PHONY: \
+	clean \
+	op-challenger \
+	test \
+	lint

op-challenger/README.md

+# op-challenger
+
+The `op-challenger` is a modular **op-stack** challenge agent
+written in golang for dispute games including, but not limited to, attestation games, fault
+games, and validity games. To learn more about dispute games, visit the
+[dispute game specs](../specs/dispute-game.md).
+
+## Quickstart
+
+First, clone this repo. Then, run `make`, which will build all required targets.
+Alternatively, run `make devnet` to bring up the [devnet](../ops-bedrock/devnet-up.sh)
+which deploys the [mock dispute game contracts](./contracts) as well as an
+`op-challenger` instance.
+
+Alternatively, you can build the `op-challenger` binary locally using the pre-configured
+[Makefile](./Makefile) target by running `make build`, and then running `./op-challenger --help`
+to see a list of available options.
+
+## Usage
+
+`op-challenger` is configurable via command line flags and environment variables. The help menu
+shows the available config options and can be accessed by running `./op-challenger --help`.
+
+Note that there are many global options, but the most important ones are:
+
+- `OP_CHALLENGER_L1_ETH_RPC`: An L1 Ethereum RPC URL
+- `OP_CHALLENGER_ROLLUP_RPC`: A Rollup Node RPC URL
+- `OP_CHALLENGER_L2OO_ADDRESS`: The L2OutputOracle Contract Address
+- `OP_CHALLENGER_DGF_ADDRESS`: Dispute Game Factory Contract Address
+
+Here is a reduced output from running `./op-challenger --help`:
+
+```bash
+NAME:
+   op-challenger - Modular Challenger Agent
+USAGE:
+   main [global options] command [command options] [arguments...]
+VERSION:
+   1.0.0
+DESCRIPTION:
+   A modular op-stack challenge agent for output dispute games written in golang.
+COMMANDS:
+   help, h  Shows a list of commands or help for one command
+GLOBAL OPTIONS:
+   --l1-eth-rpc value                      HTTP provider URL for L1. [$OP_CHALLENGER_L1_ETH_RPC]
+   --rollup-rpc value                      HTTP provider URL for the rollup node. [$OP_CHALLENGER_ROLLUP_RPC]
+   --l2oo-address value                    Address of the L2OutputOracle contract. [$OP_CHALLENGER_L2OO_ADDRESS]
+   --dgf-address value                     Address of the DisputeGameFactory contract. [$OP_CHALLENGER_DGF_ADDRESS]
+   ...
+   --help, -h                              show help
+   --version, -v                           print the version
+```
+
+

op-challenger/cmd/main.go

+package main
+
+import (
+	"os"
+
+	flags "github.com/ethereum-optimism/optimism/op-challenger/flags"
+
+	log "github.com/ethereum/go-ethereum/log"
+	cli "github.com/urfave/cli"
+
+	oplog "github.com/ethereum-optimism/optimism/op-service/log"
+)
+
+const Version = "0.1.0"
+
+func main() {
+	oplog.SetupDefaults()
+
+	app := cli.NewApp()
+	app.Flags = flags.Flags
+	app.Version = Version
+	app.Name = "op-challenger"
+	app.Usage = "Challenge invalid L2OutputOracle outputs"
+	app.Description = "A modular op-stack challenge agent for dispute games written in golang."
+
+	app.Action = func(ctx *cli.Context) error {
+		log.Debug("Challenger not implemented...")
+		return nil
+	}
+	err := app.Run(os.Args)
+	if err != nil {
+		log.Crit("Application failed", "message", err)
+	}
+}

op-challenger/flags/flags.go

+package flags
+
+import (
+	"fmt"
+
+	"github.com/urfave/cli"
+
+	opservice "github.com/ethereum-optimism/optimism/op-service"
+	oplog "github.com/ethereum-optimism/optimism/op-service/log"
+	opmetrics "github.com/ethereum-optimism/optimism/op-service/metrics"
+	oppprof "github.com/ethereum-optimism/optimism/op-service/pprof"
+	oprpc "github.com/ethereum-optimism/optimism/op-service/rpc"
+	txmgr "github.com/ethereum-optimism/optimism/op-service/txmgr"
+)
+
+const envVarPrefix = "OP_CHALLENGER"
+
+var (
+	// Required Flags
+	L1EthRpcFlag = cli.StringFlag{
+		Name:   "l1-eth-rpc",
+		Usage:  "HTTP provider URL for L1.",
+		EnvVar: opservice.PrefixEnvVar(envVarPrefix, "L1_ETH_RPC"),
+	}
+	RollupRpcFlag = cli.StringFlag{
+		Name:   "rollup-rpc",
+		Usage:  "HTTP provider URL for the rollup node.",
+		EnvVar: opservice.PrefixEnvVar(envVarPrefix, "ROLLUP_RPC"),
+	}
+	L2OOAddressFlag = cli.StringFlag{
+		Name:   "l2oo-address",
+		Usage:  "Address of the L2OutputOracle contract.",
+		EnvVar: opservice.PrefixEnvVar(envVarPrefix, "L2OO_ADDRESS"),
+	}
+	DGFAddressFlag = cli.StringFlag{
+		Name:   "dgf-address",
+		Usage:  "Address of the DisputeGameFactory contract.",
+		EnvVar: opservice.PrefixEnvVar(envVarPrefix, "DGF_ADDRESS"),
+	}
+)
+
+// requiredFlags are checked by [CheckRequired]
+var requiredFlags = []cli.Flag{
+	L1EthRpcFlag,
+	RollupRpcFlag,
+	L2OOAddressFlag,
+	DGFAddressFlag,
+}
+
+// optionalFlags is a list of unchecked cli flags
+var optionalFlags = []cli.Flag{}
+
+func init() {
+	optionalFlags = append(optionalFlags, oprpc.CLIFlags(envVarPrefix)...)
+	optionalFlags = append(optionalFlags, oplog.CLIFlags(envVarPrefix)...)
+	optionalFlags = append(optionalFlags, opmetrics.CLIFlags(envVarPrefix)...)
+	optionalFlags = append(optionalFlags, oppprof.CLIFlags(envVarPrefix)...)
+	optionalFlags = append(optionalFlags, txmgr.CLIFlags(envVarPrefix)...)
+
+	Flags = append(requiredFlags, optionalFlags...)
+}
+
+// Flags contains the list of configuration options available to the binary.
+var Flags []cli.Flag
+
+func CheckRequired(ctx *cli.Context) error {
+	for _, f := range requiredFlags {
+		if !ctx.GlobalIsSet(f.GetName()) {
+			return fmt.Errorf("flag %s is required", f.GetName())
+		}
+	}
+	return nil
+}