ops: integrate op-fetcher

.circleci/config.yml

@@ -124,6 +124,74 @@ jobs:
             cd ops
             go run ./cmd/print_staging_report/main.go
 
+  check-codegen:
+    circleci_ip_ranges: true
+    docker:
+      - image: <<pipeline.parameters.default_docker_image>>
+    steps:
+      - utils/checkout-with-mise
+      - run:
+          name: check-codegen-for-changed-chains
+          command: |
+            set -e
+
+            # Get list of changed files
+            CHANGED_FILES=$(git diff --name-only origin/main... | grep "^superchain/configs/.*\.toml$" || true)
+            if [ -z "$CHANGED_FILES" ]; then
+              echo "No .toml files changed in superchain/configs, skipping codegen check"
+              exit 0
+            fi
+
+            # Extract chain_ids from changed .toml files
+            CHAIN_IDS=""
+            CHAIN_ID_COUNT=0
+            CHANGED_FILE_COUNT=0
+
+            for file in $CHANGED_FILES; do
+              CHANGED_FILE_COUNT=$((CHANGED_FILE_COUNT + 1))
+              # Use yq to extract chain_id from TOML
+              CHAIN_ID=$(yq -p=toml -o=json '.chain_id' "$file" | grep -v "null" | tr -d '"')
+
+              if [ -n "$CHAIN_ID" ]; then
+                if [ -z "$CHAIN_IDS" ]; then
+                  CHAIN_IDS="$CHAIN_ID"
+                else
+                  CHAIN_IDS="$CHAIN_IDS,$CHAIN_ID"
+                fi
+                CHAIN_ID_COUNT=$((CHAIN_ID_COUNT + 1))
+                echo "Found chain_id $CHAIN_ID in $file"
+              fi
+            done
+            echo "Found $CHAIN_ID_COUNT chain_ids in $CHANGED_FILE_COUNT files"
+
+            cd ops
+            if [ "$CHAIN_ID_COUNT" -ne "$CHANGED_FILE_COUNT" ] && [ "$CHANGED_FILE_COUNT" -gt 0 ]; then
+              # This accounts for changes to superchain.toml files
+              echo "Running codegen for all chains\n"
+              go run ./cmd/codegen \
+                --l1-rpc-urls="<< pipeline.parameters.sepolia_rpc_url >>,<< pipeline.parameters.mainnet_rpc_url >>"
+            else
+              echo "Running codegen for the following chain_ids: $CHAIN_IDS\n"
+              go run ./cmd/codegen \
+                --l1-rpc-urls="<< pipeline.parameters.sepolia_rpc_url >>,<< pipeline.parameters.mainnet_rpc_url >>" \
+                --chain-ids="$CHAIN_IDS"
+            fi
+
+            if [ -n "$(git status --porcelain)" ] ; then
+              echo "\n❌ Changes detected after running codegen. Run the following command locally and commit the changes:\n"
+              echo "go run ./cmd/codegen \\"
+              # Show the appropriate command flags based on which mode was run
+              if [ "$CHAIN_ID_COUNT" -ne "$CHANGED_FILE_COUNT" ] && [ "$CHANGED_FILE_COUNT" -gt 0 ]; then
+                echo "  --l1-rpc-urls=\"<urls>\""
+              else
+                echo "  --l1-rpc-urls=\"<urls>\" \\"
+                echo "  --chain-ids=\"$CHAIN_IDS\""
+              fi
+              exit 1
+            else
+              echo "\n✅ All codegen files are up to date"
+            fi
+
 workflows:
   main:
     jobs:
@@ -136,13 +204,12 @@ workflows:
       - run-tool:
           name: check-genesis-integrity
           tool: check_genesis_integrity
-      - run-tool:
+      - check-codegen:
           name: check-codegen
-          tool: codegen
-          check_diff: true
       - run-tool:
           name: check-staging-synced
           tool: sync_staging
+          args: --l1-rpc-urls="<< pipeline.parameters.sepolia_rpc_url >>,<< pipeline.parameters.mainnet_rpc_url >>"
           check_diff: true
       - check-staging-empty:
           name: check-staging-empty
@@ -155,4 +222,3 @@ workflows:
           tool: check_chainlist
       - run-staging-report:
           name: run-staging-report
-

justfile

@@ -47,8 +47,6 @@ print-staging-report: (_run_ops_bin 'print_staging_report')
 
 check-genesis-integrity: (_run_ops_bin 'check_genesis_integrity')
 
-codegen: (_run_ops_bin 'codegen')
-
 create-config SHORTNAME FILENAME:
 	@just _run_ops_bin "create_config" "--shortname {{SHORTNAME}} --state-filename $(realpath {{FILENAME}})"
 

mise.toml

@@ -3,6 +3,7 @@
 # Core dependencies
 go = "1.23.1"
 just = "1.37.0"
+yq = "4.44.5"
 
 # Go dependencies
 "go:gotest.tools/gotestsum" = "1.12.0"

ops/cmd/codegen/main.go

@@ -3,28 +3,105 @@ package main
 import (
 	"fmt"
 	"os"
+	"strconv"
+	"strings"
 
+	"github.com/ethereum-optimism/optimism/op-fetcher/pkg/fetcher/fetch/script"
+	"github.com/ethereum-optimism/superchain-registry/ops/internal/config"
 	"github.com/ethereum-optimism/superchain-registry/ops/internal/manage"
 	"github.com/ethereum-optimism/superchain-registry/ops/internal/output"
 	"github.com/ethereum-optimism/superchain-registry/ops/internal/paths"
+	"github.com/ethereum/go-ethereum/log"
+	"github.com/urfave/cli/v2"
+)
+
+var (
+	L1RPCURLsFlag = &cli.StringFlag{
+		Name:     "l1-rpc-urls",
+		Usage:    "comma-separated list of L1 RPC URLs (only need multiple if fetching from multiple superchains)",
+		EnvVars:  []string{"L1_RPC_URLS"},
+		Required: true,
+	}
+	ChainIDFlag = &cli.StringFlag{
+		Name:  "chain-ids",
+		Usage: "comma-separated list of l2 chainIds to update (optional, fetches all chains if not provided)",
+	}
+	SuperchainsFlag = &cli.StringFlag{
+		Name:  "superchains",
+		Usage: "comma-separated list of superchains to update (cannot provide both chain-ids and superchains flags, default to all superchains if not provided)",
+	}
 )
 
 func main() {
-	if err := mainErr(); err != nil {
-		output.WriteNotOK("application error: %v", err)
+	app := &cli.App{
+		Name:  "codegen",
+		Usage: "uses op-fetcher to fetch onchain config data for chain(s) in the superchain-registry, then propagates the data to codegen files",
+		Flags: []cli.Flag{
+			L1RPCURLsFlag,
+			ChainIDFlag,
+			SuperchainsFlag,
+		},
+		Action: CodegenCLI,
+	}
+	if err := app.Run(os.Args); err != nil {
+		output.WriteStderr("%v", err)
 		os.Exit(1)
 	}
 }
 
-func mainErr() error {
+func CodegenCLI(cliCtx *cli.Context) error {
+	l1RpcUrls := strings.Split(cliCtx.String("l1-rpc-urls"), ",")
+	chainIdStr := cliCtx.String("chain-ids")
+	superchainsStr := cliCtx.String("superchains")
+	if chainIdStr != "" && superchainsStr != "" {
+		return fmt.Errorf("cannot provide both chain-ids and superchains flags")
+	}
+
+	var superchains []config.Superchain
+	if superchainsStr != "" {
+		superchainStrs := strings.Split(superchainsStr, ",")
+		for _, superchainStr := range superchainStrs {
+			superchainStr = strings.TrimSpace(superchainStr)
+			superchain, err := config.ParseSuperchain(superchainStr)
+			if err != nil {
+				return err
+			}
+			superchains = append(superchains, superchain)
+		}
+	}
+
+	var chainIds []uint64
+	if chainIdStr != "" {
+		chainIdStrs := strings.Split(chainIdStr, ",")
+		// Convert each string to uint64
+		for _, idStr := range chainIdStrs {
+			idStr = strings.TrimSpace(idStr)
+			id, err := strconv.ParseUint(idStr, 10, 64)
+			if err != nil {
+				return fmt.Errorf("invalid chain ID '%s': %w", idStr, err)
+			}
+			chainIds = append(chainIds, id)
+		}
+	}
+
+	lgr := log.NewLogger(log.NewTerminalHandlerWithLevel(os.Stderr, log.LevelInfo, false))
 	wd, err := paths.FindRepoRoot()
 	if err != nil {
 		return fmt.Errorf("failed to get working directory: %w", err)
 	}
 
-	if err := manage.GenAllCode(wd); err != nil {
-		return fmt.Errorf("error generating code: %w", err)
+	var onchainCfgs map[uint64]script.ChainConfig
+	ctx := cliCtx.Context
+	onchainCfgs, err = manage.FetchChains(ctx, lgr, wd, l1RpcUrls, chainIds, superchains)
+	if err != nil {
+		return fmt.Errorf("error fetching onchain configs: %w", err)
+	}
+	syncer, err := manage.NewCodegenSyncer(lgr, wd, onchainCfgs)
+	if err != nil {
+		return fmt.Errorf("error creating codegen syncer: %w", err)
+	}
+	if err := syncer.SyncAll(); err != nil {
+		return fmt.Errorf("error syncing codegen: %w", err)
 	}
-
 	return nil
 }

ops/cmd/sync_staging/main.go

@@ -5,10 +5,13 @@ import (
 	"fmt"
 	"os"
 	"path"
+	"strings"
 
+	"github.com/ethereum-optimism/superchain-registry/ops/internal/config"
 	"github.com/ethereum-optimism/superchain-registry/ops/internal/manage"
 	"github.com/ethereum-optimism/superchain-registry/ops/internal/output"
 	"github.com/ethereum-optimism/superchain-registry/ops/internal/paths"
+	"github.com/ethereum/go-ethereum/log"
 	"github.com/urfave/cli/v2"
 )
 
@@ -21,6 +24,11 @@ var (
 		Name:  "preserve-input",
 		Usage: "Skip cleanup of staging directory.",
 	}
+	FlagL1RPCURLs = &cli.StringFlag{
+		Name:     "l1-rpc-urls",
+		Usage:    "Comma-separated list of L1 RPC URLs",
+		Required: true,
+	}
 )
 
 func main() {
@@ -30,6 +38,7 @@ func main() {
 		Flags: []cli.Flag{
 			FlagCheck,
 			FlagPreserveInput,
+			FlagL1RPCURLs,
 		},
 		Action: action,
 	}
@@ -96,8 +105,20 @@ func action(cliCtx *cli.Context) error {
 
 	output.WriteOK("wrote genesis files")
 
-	if err := manage.GenAllCode(wd); err != nil {
-		return fmt.Errorf("failed to generate code: %w", err)
+	// Codegen
+	lgr := log.NewLogger(log.NewTerminalHandlerWithLevel(os.Stderr, log.LevelInfo, false))
+	l1RpcUrls := strings.Split(cliCtx.String("l1-rpc-urls"), ",")
+	ctx := cliCtx.Context
+	onchainCfgs, err := manage.FetchChains(ctx, lgr, wd, l1RpcUrls, []uint64{chainCfg.ChainID}, []config.Superchain{})
+	if err != nil {
+		return fmt.Errorf("error fetching onchain configs: %w", err)
+	}
+	syncer, err := manage.NewCodegenSyncer(lgr, wd, onchainCfgs)
+	if err != nil {
+		return fmt.Errorf("error creating codegen syncer: %w", err)
+	}
+	if err := syncer.SyncAll(); err != nil {
+		return fmt.Errorf("error syncing codegen: %w", err)
 	}
 
 	if !noCleanup {

ops/go.mod

@@ -4,7 +4,7 @@ go 1.23.1
 
 require (
 	github.com/BurntSushi/toml v1.4.0
-	github.com/ethereum-optimism/optimism v1.13.1-0.20250402215013-5391bf29692d
+	github.com/ethereum-optimism/optimism v1.12.3-0.20250402215013-5391bf29692d
 	github.com/ethereum/go-ethereum v1.15.3
 	github.com/lmittmann/w3 v0.17.8
 	github.com/stretchr/testify v1.10.0
@@ -15,6 +15,7 @@ require (
 	github.com/ethereum-optimism/superchain-registry/validation v0.0.0-20250314162817-2c60e5723c64
 	github.com/google/go-github/v68 v68.0.0
 	github.com/klauspost/compress v1.18.0
+	golang.org/x/sync v0.10.0
 )
 
 require (
@@ -74,7 +75,6 @@ require (
 	github.com/yusufpapurcu/wmi v1.2.3 // indirect
 	golang.org/x/crypto v0.32.0 // indirect
 	golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c // indirect
-	golang.org/x/sync v0.10.0 // indirect
 	golang.org/x/sys v0.29.0 // indirect
 	golang.org/x/term v0.28.0 // indirect
 	golang.org/x/time v0.10.0 // indirect

ops/go.sum

@@ -87,8 +87,8 @@ github.com/ethereum-optimism/go-ethereum-hdwallet v0.1.3 h1:RWHKLhCrQThMfch+QJ1Z
 github.com/ethereum-optimism/go-ethereum-hdwallet v0.1.3/go.mod h1:QziizLAiF0KqyLdNJYD7O5cpDlaFMNZzlxYNcWsJUxs=
 github.com/ethereum-optimism/op-geth v1.101503.2-rc.5.0.20250401164435-02dfe8692a3c h1:2uU1Jx+wuqGtWR/qsZrmB+jfR+/hslowPS11bvBAda4=
 github.com/ethereum-optimism/op-geth v1.101503.2-rc.5.0.20250401164435-02dfe8692a3c/go.mod h1:QUo3fn+45vWqJWzJW+rIzRHUV7NmhhHLPdI87mAn1M8=
-github.com/ethereum-optimism/optimism v1.13.1-0.20250402215013-5391bf29692d h1:SWUqPFKjoh3WfAG2HaKNjwkwzxJ3Jm/ssvYQAF6AbY0=
-github.com/ethereum-optimism/optimism v1.13.1-0.20250402215013-5391bf29692d/go.mod h1:Pf1bUvfjbot5RyCmsfPKFR0kcBCT/HZvSlISRtB1+KE=
+github.com/ethereum-optimism/optimism v1.12.3-0.20250402215013-5391bf29692d h1:UGWjnYcPm7e0AOWZGyKhgBj+67oq8ZRrJYYu4Kfh7uw=
+github.com/ethereum-optimism/optimism v1.12.3-0.20250402215013-5391bf29692d/go.mod h1:Pf1bUvfjbot5RyCmsfPKFR0kcBCT/HZvSlISRtB1+KE=
 github.com/ethereum-optimism/superchain-registry/validation v0.0.0-20250314162817-2c60e5723c64 h1:teDhU4h4ryaE8rSBl+vJJiwKHjxdnnHPkKZ9iNr2R8k=
 github.com/ethereum-optimism/superchain-registry/validation v0.0.0-20250314162817-2c60e5723c64/go.mod h1:NZ816PzLU1TLv1RdAvYAb6KWOj4Zm5aInT0YpDVml2Y=
 github.com/ethereum/c-kzg-4844 v1.0.0 h1:0X1LBXxaEtYD9xsyj9B9ctQEZIpnvVDeoBx8aHEwTNA=

ops/internal/config/address.go

@@ -1,6 +1,7 @@
 package config
 
 import (
+	"encoding/json"
 	"fmt"
 
 	"github.com/ethereum/go-ethereum/common"
@@ -19,20 +20,7 @@ func (a *ChecksummedAddress) UnmarshalTOML(data any) error {
 		return fmt.Errorf("expected a string, got %T", data)
 	}
 
-	if len(dataStr) != 42 {
-		return fmt.Errorf("invalid address: %s", dataStr)
-	}
-
-	if !common.IsHexAddress(dataStr) {
-		return fmt.Errorf("invalid address: %s", dataStr)
-	}
-
-	addr := common.HexToAddress(dataStr)
-	if addr.Hex() != dataStr {
-		return fmt.Errorf("invalid checksummed address: %s", dataStr)
-	}
-	*a = ChecksummedAddress(addr)
-	return nil
+	return a.parseAddress(dataStr)
 }
 
 func (a ChecksummedAddress) MarshalTOML() ([]byte, error) {
@@ -43,6 +31,43 @@ func (a ChecksummedAddress) String() string {
 	return common.Address(a).Hex()
 }
 
-func (a ChecksummedAddress) MarshalJSON() ([]byte, error) {
-	return []byte(fmt.Sprintf(`"%s"`, common.Address(a).Hex())), nil
+func (a *ChecksummedAddress) UnmarshalJSON(data []byte) error {
+	var dataStr string
+	if err := json.Unmarshal(data, &dataStr); err != nil {
+		return fmt.Errorf("failed to unmarshal ChecksummedAddress: %w", err)
+	}
+
+	return a.parseAddress(dataStr)
+}
+
+func (a *ChecksummedAddress) MarshalJSON() ([]byte, error) {
+	if common.Address(*a) == (common.Address{}) {
+		// Return null for zero addresses so it doesn't pollute the json output
+		return []byte("null"), nil
+	}
+	return []byte(fmt.Sprintf(`"%s"`, common.Address(*a).Hex())), nil
+}
+
+// Helper function for validating and parsing Ethereum addresses
+func (a *ChecksummedAddress) parseAddress(addrStr string) error {
+	// Validate length
+	if len(addrStr) != 42 {
+		return fmt.Errorf("invalid address length: %s", addrStr)
+	}
+
+	// Validate hex format
+	if !common.IsHexAddress(addrStr) {
+		return fmt.Errorf("invalid hex address: %s", addrStr)
+	}
+
+	// Convert to checksummed address
+	addr := common.HexToAddress(addrStr)
+
+	// Validate that the address is properly checksummed
+	if addr.Hex() != addrStr {
+		return fmt.Errorf("invalid checksummed address: %s", addrStr)
+	}
+
+	*a = ChecksummedAddress(addr)
+	return nil
 }