feat(optimism): Add support for all Superchain configs and enable their usage (#14562)

Co-authored-by: Matthias Seitz <[email protected]>

Author: cakevm

Cargo.lock

@@ -553,6 +553,8 @@ url = { version = "2.3", default-features = false }
 zstd = "0.13"
 byteorder = "1"
 mini-moka = "0.10"
+tar-no-std = { version = "0.3.2", default-features = false }
+miniz_oxide = { version = "0.8.4", default-features = false }
 
 # metrics
 metrics = "0.24.0"

Cargo.toml

@@ -125,6 +125,7 @@ pub enum AnyNode {
 
 impl AnyNode {
     /// Returns the peer id of the node.
+    #[allow(clippy::missing_const_for_fn)]
     pub fn peer_id(&self) -> PeerId {
         match self {
             Self::NodeRecord(record) => record.id,
@@ -135,6 +136,7 @@ impl AnyNode {
     }
 
     /// Returns the full node record if available.
+    #[allow(clippy::missing_const_for_fn)]
     pub fn node_record(&self) -> Option<NodeRecord> {
         match self {
             Self::NodeRecord(record) => Some(*record),

crates/chainspec/res/genesis/base.json

@@ -33,11 +33,17 @@ alloy-hardforks.workspace = true
 # op
 op-alloy-rpc-types.workspace = true
 
-# io
+serde = { workspace = true, optional = true }
 serde_json.workspace = true
 
+# io
+tar-no-std = { workspace = true, optional = true }
+miniz_oxide = { workspace = true, features = ["with-alloc"], optional = true }
+
 # misc
 derive_more.workspace = true
+paste = { workspace = true, optional = true }
+thiserror = { workspace = true, optional = true }
 
 [dev-dependencies]
 reth-chainspec = { workspace = true, features = ["test-utils"] }
@@ -46,6 +52,7 @@ op-alloy-rpc-types.workspace = true
 
 [features]
 default = ["std"]
+superchain-configs = ["miniz_oxide", "paste", "tar-no-std", "thiserror", "thiserror", "dep:serde"]
 std = [
     "alloy-chains/std",
     "alloy-genesis/std",
@@ -61,4 +68,20 @@ std = [
     "derive_more/std",
     "reth-network-peers/std",
     "serde_json/std",
+    "serde?/std",
+    "miniz_oxide?/std",
+    "thiserror?/std",
+]
+serde = [
+    "alloy-chains/serde",
+    "alloy-consensus/serde",
+    "alloy-eips/serde",
+    "alloy-hardforks/serde",
+    "alloy-primitives/serde",
+    "miniz_oxide?/serde",
+    "op-alloy-rpc-types/serde",
+    "reth-ethereum-forks/serde",
+    "reth-optimism-forks/serde",
+    "reth-optimism-primitives/serde",
+    "reth-primitives-traits/serde",
 ]

crates/chainspec/res/genesis/optimism.json

@@ -0,0 +1 @@
+[{"name":"arena-z","environment":"mainnet"},{"name":"arena-z-testnet","environment":"sepolia"},{"name":"automata","environment":"mainnet"},{"name":"base-devnet-0","environment":"sepolia-dev-0"},{"name":"bob","environment":"mainnet"},{"name":"boba","environment":"sepolia"},{"name":"creator-chain-testnet","environment":"sepolia"},{"name":"cyber","environment":"mainnet"},{"name":"cyber","environment":"sepolia"},{"name":"ethernity","environment":"mainnet"},{"name":"ethernity","environment":"sepolia"},{"name":"funki","environment":"mainnet"},{"name":"funki","environment":"sepolia"},{"name":"hashkeychain","environment":"mainnet"},{"name":"ink","environment":"mainnet"},{"name":"ink","environment":"sepolia"},{"name":"lisk","environment":"mainnet"},{"name":"lisk","environment":"sepolia"},{"name":"lyra","environment":"mainnet"},{"name":"metal","environment":"mainnet"},{"name":"metal","environment":"sepolia"},{"name":"mint","environment":"mainnet"},{"name":"mode","environment":"mainnet"},{"name":"mode","environment":"sepolia"},{"name":"oplabs-devnet-0","environment":"sepolia-dev-0"},{"name":"orderly","environment":"mainnet"},{"name":"pivotal","environment":"sepolia"},{"name":"polynomial","environment":"mainnet"},{"name":"race","environment":"mainnet"},{"name":"race","environment":"sepolia"},{"name":"redstone","environment":"mainnet"},{"name":"settlus-mainnet","environment":"mainnet"},{"name":"settlus-sepolia","environment":"sepolia"},{"name":"shape","environment":"mainnet"},{"name":"shape","environment":"sepolia"},{"name":"snax","environment":"mainnet"},{"name":"soneium","environment":"mainnet"},{"name":"soneium-minato","environment":"sepolia"},{"name":"sseed","environment":"mainnet"},{"name":"swan","environment":"mainnet"},{"name":"swell","environment":"mainnet"},{"name":"tbn","environment":"mainnet"},{"name":"tbn","environment":"sepolia"},{"name":"unichain","environment":"mainnet"},{"name":"unichain","environment":"sepolia"},{"name":"worldchain","environment":"mainnet"},{"name":"worldchain","environment":"sepolia"},{"name":"xterio-eth","environment":"mainnet"},{"name":"zora","environment":"mainnet"},{"name":"zora","environment":"sepolia"}]

crates/chainspec/res/genesis/sepolia_base.json

@@ -0,0 +1,140 @@
+#!/usr/bin/env bash
+
+# Usage: ./fetch_superchain_config.sh
+# Switch to the same directory as the script and run it.
+# This will checkout the latest superchain registry commit and create three files.
+# - superchain-configs.tar: A tar archive containing all superchain configs
+# - available-chains.json: A JSON file containing all available chains
+# - ../src/superchain/chain_specs.rs: A Rust file containing all chain specs
+
+# Requires:
+# - MacOS: brew install qpdf zstd yq
+
+SCRIPT_DIR=$(pwd)
+TEMP_DIR=$(mktemp -d)
+
+# Clone the repository and go to the directory
+git clone --depth 1 https://github.com/ethereum-optimism/superchain-registry.git "$TEMP_DIR"
+# shellcheck disable=SC2164
+cd "$TEMP_DIR"
+
+
+DICT_FILE="$TEMP_DIR/superchain/extra/dictionary"
+TARGET_PATH="$TEMP_DIR/result"
+GENESIS_TARGET_PATH="$TARGET_PATH/genesis"
+CONFIGS_TARGET_PATH="$TARGET_PATH/configs"
+
+GENESIS_SRC_DIR="$TEMP_DIR/superchain/extra/genesis"
+CONFIGS_SRC_DIR="$TEMP_DIR/superchain/configs"
+mkdir -p "$GENESIS_TARGET_PATH"
+mkdir -p "$CONFIGS_TARGET_PATH"
+
+echo "Convert TOML files to JSON..."
+# JSON makes the handling in no-std environments easier
+find "$CONFIGS_SRC_DIR" -type f -name "*.toml" | while read -r file; do
+
+    # Compute destination file path
+    REL_PATH="${file#"$CONFIGS_SRC_DIR"/}"
+    DEST_PATH="$CONFIGS_TARGET_PATH/${REL_PATH%.toml}"
+
+    # Ensure destination directory exists
+    mkdir -p "$(dirname "$DEST_PATH")"
+
+    # Convert the toml file to json
+    yq -p toml -o json "$file" > "$DEST_PATH.json"
+done
+
+echo "Extract and compress the genesis files..."
+# We compress the genesis files with zlib-flate to save space and to a compression
+# format that makes it easier to handle them in no-std environments
+find "$GENESIS_SRC_DIR" -type f -name "*.json.zst" | while read -r file; do
+
+    # Compute destination file path
+    REL_PATH="${file#"$GENESIS_SRC_DIR"/}"
+    DEST_PATH="$GENESIS_TARGET_PATH/${REL_PATH%.zst}"
+
+    # Ensure destination directory exists
+    mkdir -p "$(dirname "$DEST_PATH")"
+
+    # Extract the file
+    zstd -q -d -D="$DICT_FILE" "$file" -o "$DEST_PATH"
+
+    # Remove "config" field from genesis files, because it is not consistent populated.
+    # We will add it back in from the chain config file during runtime.
+    # See: https://github.com/ethereum-optimism/superchain-registry/issues/901
+    jq -c 'del(.config)' "$DEST_PATH" > "$DEST_PATH.tmp"
+    mv "$DEST_PATH.tmp" "$DEST_PATH"
+
+    # Compress with zlib-flate and remove the original file
+    zlib-flate -compress < "$DEST_PATH" > "$DEST_PATH.zz"
+    rm "$DEST_PATH"
+
+done
+
+# Save revision
+git rev-parse HEAD > "$TARGET_PATH/superchain_registry_commit"
+git rev-parse HEAD > "$SCRIPT_DIR/superchain_registry_commit"
+
+# Copy the LICENSE file
+cp "$TEMP_DIR/LICENSE" "$TARGET_PATH/LICENSE"
+
+# Set the modification time of all files to 1980-01-01 to ensure the archive is deterministic
+find "$TARGET_PATH" -exec touch -t 198001010000.00 {} +
+
+# shellcheck disable=SC2164
+cd "$TARGET_PATH"
+# Create a tar archive excluding files that are not relevant superchain directory
+# shellcheck disable=SC2035
+COPYFILE_DISABLE=1 tar --no-acls --no-xattrs -cf superchain-configs.tar --exclude "._COMMIT" *
+
+# Move result to the script directory
+mv superchain-configs.tar "$SCRIPT_DIR"
+
+echo "Create available-chains.json..."
+# Create available-chains.json from chainList.json
+# shellcheck disable=SC2002
+JSON_DATA=$(cat "$TEMP_DIR/chainList.json" | jq -r 'sort_by(.parent.chain, .identifier | split("/")[1])')
+
+# Extract network and chain names
+PARENT_CHAINS=$(echo "$JSON_DATA" | jq -r '.[].parent.chain')
+IDENTIFIERS=$(echo "$JSON_DATA" | jq -r '.[].identifier | split("/")[1]')
+# shellcheck disable=SC2206
+PARENT_CHAINS_ARRAY=($PARENT_CHAINS)
+# shellcheck disable=SC2206
+IDENTIFIERS_ARRAY=($IDENTIFIERS)
+
+RESULTS=()
+RESULT_RS="// Generated by fetch_superchain_config.sh\nuse crate::create_chain_spec;\n\n"
+
+echo "Generate available-chains.json and chain_specs.rs..."
+for i in "${!PARENT_CHAINS_ARRAY[@]}"; do
+  NAME="${IDENTIFIERS_ARRAY[$i]}"
+  ENVIRONMENT="${PARENT_CHAINS_ARRAY[$i]}"
+  # Skip Optimism and Base here because it is implemented separately
+  if [ "$NAME" == "op" ] || [ "$NAME" == "base" ]; then
+     continue
+  fi
+
+  # Validate file existence in our target path <environment>/<name>.json.zst
+  FILE_PATH="$GENESIS_TARGET_PATH/${PARENT_CHAINS_ARRAY[$i]}/${IDENTIFIERS_ARRAY[$i]}.json.zz"
+  if [ -f "$FILE_PATH" ]; then
+    RESULTS+=("{\"name\": \"$NAME\", \"environment\": \"$ENVIRONMENT\"}")
+    RESULT_RS+="create_chain_spec!(\"$NAME\", \"$ENVIRONMENT\");\n"
+  else
+    echo "Error: File not found: $FILE_PATH" >&2
+  fi
+done
+
+# Write available-chains.json
+# shellcheck disable=SC2005
+echo "$(printf '%s\n' "${RESULTS[@]}" | jq -c -s 'sort_by(.name, .environment)')" > "$SCRIPT_DIR/available-chains.json"
+
+# Write chain_specs.rs
+echo -e "$RESULT_RS" | sed '${/^$/d;}' > "$SCRIPT_DIR/../src/superchain/chain_specs.rs"
+
+# Clean up
+# shellcheck disable=SC2164
+cd "$TEMP_DIR/../"
+rm -rf "$TEMP_DIR"
+
+echo "Done."