feat: integrate l2geth in docker-compose e2e tests (#227)

* feat: integrate l2geth in docker-compose e2e tests

* support local genesis

* address comments

* fix CI

* update scripts

* increase log level

* update gas limits

* update reth commit

* cargo.lock

* fix compile errors

* add initial test

* fix lint

* launch l2geth sequencer and read active signer from L1

* launch l2geth follower

* fix issue with custom genesis where fields are missing and mixed up

* adjust chain id to arbitrary number to avoid conflict with named chain

* rollup node follower can follow chain produced by l2geth sequencer

* configure rollup node sequencer correctly and connect to other nodes

* add health check for l1-node to make sure it is fully set up before l2 nodes start

* refactor DockerComposeEnv and add more convenience functions for tests to control sequencer. RN sequencer and l2geth sequencer start without producing blocks automatically.

* fix CI

* remove todos

* avoid building Docker image when only Docker integration test changes

---------

Co-authored-by: colinlyguo <[email protected]>
Co-authored-by: jonastheis <[email protected]>

Author: 3 people

Cargo.lock

@@ -123,7 +123,7 @@ alloy-consensus = { version = "1.0.13", default-features = false }
 alloy-eips = { version = "1.0.13", default-features = false }
 alloy-json-rpc = { version = "1.0.13", default-features = false }
 alloy-network = { version = "1.0.13", default-features = false }
-alloy-primitives = { version = "1.2.0", default-features = false }
+alloy-primitives = { version = "1.3.1", default-features = false }
 alloy-provider = { version = "1.0.13", default-features = false }
 alloy-rpc-client = { version = "1.0.13", default-features = false }
 alloy-rpc-types-engine = { version = "1.0.13", default-features = false }
@@ -185,7 +185,7 @@ scroll-wire = { path = "crates/scroll-wire" }
 scroll-migration = { path = "crates/database/migration" }
 
 # misc
-arbitrary = { version = "1.4", default-features = false }
+arbitrary = { version = "1.4", default-features = false, features = ["derive"] }
 async-trait = "0.1"
 auto_impl = "1.2"
 bitvec = { version = "1.0", default-features = false }

Cargo.toml

@@ -0,0 +1,51 @@
+FROM rust:1.88.0 AS chef
+
+ARG CARGO_FEATURES=""
+
+# Install basic packages
+RUN apt-get update && apt-get -y upgrade && apt-get install -y libclang-dev pkg-config
+RUN cargo install cargo-chef --locked --version  0.1.71
+
+FROM chef AS planner
+WORKDIR /app
+
+COPY . .
+# Hacky: Replace tests with dummy stub to avoid workspace member issues of top-level Cargo.toml.
+# This is needed because within the Docker integration tests we don't need the tests crate 
+# and want to avoid rebuilding it on every change.
+RUN mkdir -p tests/src && \
+    echo '[package]' > tests/Cargo.toml && \
+    echo 'name = "tests"' >> tests/Cargo.toml && \
+    echo 'version = "0.0.1"' >> tests/Cargo.toml && \
+    echo 'edition = "2021"' >> tests/Cargo.toml && \
+    echo '' >> tests/Cargo.toml && \
+    echo '[lib]' >> tests/Cargo.toml && \
+    echo 'name = "tests"' >> tests/Cargo.toml && \
+    echo 'path = "src/lib.rs"' >> tests/Cargo.toml && \
+    echo 'pub fn dummy() {}' > tests/src/lib.rs
+RUN --mount=type=cache,target=/usr/local/cargo/registry \
+    cargo chef prepare --recipe-path /recipe.json
+
+FROM chef AS builder
+WORKDIR /app
+COPY --from=planner /recipe.json recipe.json
+RUN --mount=type=cache,target=/usr/local/cargo/registry \
+    cargo chef cook --release --recipe-path recipe.json
+
+COPY . .
+RUN --mount=type=cache,target=/usr/local/cargo/registry \
+    cargo build ${CARGO_FEATURES:+--features $CARGO_FEATURES} --release --target-dir=/app-target
+
+# Release
+FROM debian:bookworm-slim
+
+RUN apt-get update && apt-get install -y --no-install-recommends ca-certificates curl sqlite3 && \
+    rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+COPY --from=builder /app-target/release/rollup-node /bin/
+
+EXPOSE 30303 30303/udp 9001 8545 8546
+
+ENTRYPOINT ["rollup-node"]

Dockerfile.test

@@ -0,0 +1,14 @@
+# exclude everything
+*
+
+# include source files
+!/bin
+!/crates
+!/testing
+!book.toml
+!Cargo.lock
+!Cargo.toml
+!Cross.toml
+!deny.toml
+!Makefile
+

Dockerfile.test.dockerignore

@@ -211,6 +211,8 @@ impl ScrollRollupNodeConfig {
             db.insert_genesis_block(genesis_hash)
                 .await
                 .expect("failed to insert genesis block (custom chain)");
+
+            tracing::info!(target: "scroll::node::args", ?genesis_hash, "Overwriting genesis hash for custom chain");
         }
 
         // Wrap the database in an Arc

crates/node/src/args.rs

@@ -1322,9 +1322,10 @@ async fn test_custom_genesis_block_production_and_propagation() -> eyre::Result<
                     "l1MessageQueueAddress": "0x0d7E906BD9cAFa154b048cFa766Cc1E54E39AF9B",
                     "l1MessageQueueV2Address": "0x000000000000000000000000000000000003dead",
                     "scrollChainAddress": "0x000000000000000000000000000000000003dead",
-                    "l2SystemConfigAddress": "0x000000000000000000000000000000000003dead",
+                    "l2SystemConfigAddress": "0x0000000000000000000000000000000dddd3dead",
+                    "systemContractAddress": "0x110000000000000000000000000000000003dead",
                     "numL1MessagesPerBlock": 10,
-                    "l1MessageQueueV2DeploymentBlock": 12345
+                    "startL1Block": 12345
                 }
             }
         },

crates/node/tests/e2e.rs

@@ -96,27 +96,59 @@ impl NodeConfig {
             return Ok(Self::from_named_chain(named_chain));
         }
 
+        // Note: It is important to make sure the chain id is not a named chain accidentally.
+        //       For example, a custom `chain id=1337` will be treated as a named chain as it
+        //       matches the dev chain. https://github.com/scroll-tech/rollup-node/issues/303
         // If not a named chain, extract the configuration from the chain spec
         let config = chain_spec.chain_config();
 
         let genesis = chain_spec.genesis();
-        let l1_message_queue_v2_deployment_block = genesis
+
+        // let l1_message_queue_v2_deployment_block = genesis
+        //     .config
+        //     .extra_fields
+        //     .get("scroll")
+        //     .and_then(|scroll| scroll.get("l1Config"))
+        //     .and_then(|l1_config| l1_config.get("l1MessageQueueV2DeploymentBlock"))
+        //     .and_then(|v| v.as_u64())
+        //     .ok_or_else(|| eyre::eyre!("Invalid or missing 'l1MessageQueueV2DeploymentBlock'"))?;
+
+        let start_l1_block = genesis
             .config
             .extra_fields
             .get("scroll")
             .and_then(|scroll| scroll.get("l1Config"))
-            .and_then(|l1_config| l1_config.get("l1MessageQueueV2DeploymentBlock"))
+            .and_then(|l1_config| l1_config.get("startL1Block"))
             .and_then(|v| v.as_u64())
-            .ok_or_else(|| eyre::eyre!("Invalid or missing 'l1MessageQueueV2DeploymentBlock'"))?;
+            .ok_or_else(|| eyre::eyre!("Invalid or missing 'startL1Block'"))?;
+
+        let system_contract_address = genesis
+            .config
+            .extra_fields
+            .get("scroll")
+            .and_then(|scroll| scroll.get("l1Config"))
+            .and_then(|l1_config| l1_config.get("systemContractAddress"))
+            .and_then(|v| v.as_str())
+            .and_then(|s| s.parse().ok())
+            .ok_or_else(|| eyre::eyre!("Invalid or missing 'systemContractAddress'"))?;
+
+        // TODO:
+        // - config.l1_config.l2_system_config_address is not used here.
+        // - start_l1_block is not present currently in the config.
+        // - system_contract_address is not extracted from the config in https://github.com/scroll-tech/reth/blob/scroll/crates/scroll/chainspec/src/genesis.rs#L20
+        // - do we need: l1_message_queue_v2_deployment_block? maybe instead we could use
+        //   v2_message_queue_starting_index
+        // - ultimately we want to make sure all relevant config is extracted from `ScrollChainInfo`
+        //   and not partially here. see https://github.com/scroll-tech/rollup-node/issues/303
 
         Ok(Self {
             address_book: ScrollAddressBook {
                 rollup_node_contract_address: config.l1_config.scroll_chain_address,
                 v1_message_queue_address: config.l1_config.l1_message_queue_address,
                 v2_message_queue_address: config.l1_config.l1_message_queue_v2_address,
-                system_contract_address: config.l1_config.l2_system_config_address,
+                system_contract_address,
             },
-            start_l1_block: l1_message_queue_v2_deployment_block,
+            start_l1_block,
         })
     }
 

crates/primitives/src/node/config.rs

@@ -17,3 +17,6 @@ tokio = { workspace = true, features = ["rt", "time"] }
 eyre = { workspace = true }
 getrandom = { workspace = true }
 tracing = { workspace = true }
+reth-tracing = { workspace = true }
+serde = { workspace = true }
+serde_json = "1.0"

tests/Cargo.toml

@@ -1,51 +1,91 @@
-version: '3.8'
-
 services:
+  l1-node:
+    image: ghcr.io/foundry-rs/foundry:latest
+    container_name: l1-node
+    entrypoint: [ "bash", "/launch_l1.bash" ]
+    ports:
+      - "8544:8545"
+    volumes:
+      - ./launch_l1.bash:/launch_l1.bash:ro
+    healthcheck:
+      test: ["CMD", "bash", "-c", "[ \"$(cast storage 0x55B150d210356452e4E79cCb6B778b4e1B167091 0x67 --rpc-url http://localhost:8545)\" = \"0x000000000000000000000000b674ff99cca262c99d3eab5b32796a99188543da\" ]"]
+      interval: 3s
+      timeout: 10s
+      retries: 30
+      start_period: 0s
+
   rollup-node-sequencer:
     build:
       context: ../
-      dockerfile: Dockerfile
+      dockerfile: Dockerfile.test
     container_name: rollup-node-sequencer
     entrypoint: ["bash", "/launch_rollup_node_sequencer.bash"]
     environment:
-      - ENV=dev
       - RUST_LOG=info
     ports:
       - "8545:8545"   # JSON-RPC
-      - "8546:8546"   # WebSocket
       - "6060:6060"   # Metrics
     volumes:
       - ./launch_rollup_node_sequencer.bash:/launch_rollup_node_sequencer.bash:ro
-      - ./discovery-secret:/l2reth/discovery-secret:ro
+      - ./l2reth-genesis-e2e.json:/l2reth/l2reth-genesis-e2e.json:ro
       - l2reth-sequencer:/l2reth
-    networks:
-      - test-scroll-network
+    depends_on:
+      l1-node:
+        condition: service_healthy
 
   rollup-node-follower:
     build:
       context: ../
-      dockerfile: Dockerfile
+      dockerfile: Dockerfile.test
     container_name: rollup-node-follower
     entrypoint: ["bash", "/launch_rollup_node_follower.bash"]
     environment:
-      - ENV=dev
       - RUST_LOG=info
     ports:
-      - "8547:8545"   # JSON-RPC
-      - "8548:8546"   # WebSocket
+      - "8546:8545"   # JSON-RPC
       - "6061:6060"   # Metrics
     volumes:
       - ./launch_rollup_node_follower.bash:/launch_rollup_node_follower.bash:ro
+      - ./l2reth-genesis-e2e.json:/l2reth/l2reth-genesis-e2e.json:ro
       - l2reth-follower:/l2reth
-    networks:
-      - test-scroll-network
     depends_on:
-      - rollup-node-sequencer
+      l1-node:
+        condition: service_healthy
 
-networks:
-  test-scroll-network:
-    driver: bridge
+  l2geth-sequencer:
+    image: scrolltech/l2geth:scroll-v5.9.4
+    platform: linux/amd64
+    container_name: l2geth-sequencer
+    entrypoint: ["bash", "/launch_l2geth.bash"]
+    ports:
+      - "8547:8545"    # JSON-RPC
+      - "6062:6060"    # Metrics
+    volumes:
+      - ./l2geth-genesis-e2e.json:/l2geth-genesis-e2e.json:ro
+      - ./launch_l2geth_sequencer.bash:/launch_l2geth.bash:ro
+      - l2geth-sequencer:/l2geth
+    depends_on:
+      l1-node:
+        condition: service_healthy
+    
+  l2geth-follower:
+    image: scrolltech/l2geth:scroll-v5.9.4
+    platform: linux/amd64
+    container_name: l2geth-follower
+    entrypoint: ["bash", "/launch_l2geth.bash"]
+    ports:
+      - "8548:8545"    # JSON-RPC
+      - "6063:6060"    # Metrics
+    volumes:
+      - ./l2geth-genesis-e2e.json:/l2geth-genesis-e2e.json:ro
+      - ./launch_l2geth_follower.bash:/launch_l2geth.bash:ro
+      - l2geth-follower:/l2geth
+    depends_on:
+      l1-node:
+        condition: service_healthy
 
 volumes:
   l2reth-sequencer:
   l2reth-follower:
+  l2geth-sequencer:
+  l2geth-follower: