feat: op-reth

.github/workflows/integration.yml

@@ -18,12 +18,13 @@ concurrency:
 
 jobs:
   test:
-    name: test (${{ matrix.partition }}/${{ strategy.job-total }})
+    name: test (${{ matrix.network }} | ${{ matrix.partition }}/${{ strategy.job-total }})
     runs-on:
       group: Reth
     strategy:
       matrix:
         partition: [1, 2]
+        network: ["ethereum", "optimism"]
     timeout-minutes: 60
     steps:
       - uses: actions/checkout@v4
@@ -37,7 +38,8 @@ jobs:
       - name: Run tests
         run: |
           cargo nextest run \
-            --locked --all-features --workspace --exclude examples --exclude ef-tests \
+            --locked --features "jemalloc-prof,${{ matrix.network }}" \
+            --workspace --exclude examples --exclude ef-tests \
             --partition hash:${{ matrix.partition }}/${{ strategy.job-total }} \
             -E 'kind(test)'
 

.github/workflows/unit.yml

@@ -18,12 +18,13 @@ concurrency:
 
 jobs:
   test:
-    name: tests (${{ matrix.partition }}/${{ strategy.job-total }})
+    name: tests (${{ matrix.network }} | ${{ matrix.partition }}/${{ strategy.job-total }})
     runs-on:
       group: Reth
     strategy:
       matrix:
         partition: [1, 2]
+        network: ["ethereum", "optimism"]
     timeout-minutes: 30
     steps:
       - uses: actions/checkout@v4
@@ -35,7 +36,8 @@ jobs:
       - name: Run tests
         run: |
           cargo nextest run \
-            --locked --all-features --workspace --exclude examples --exclude ef-tests  \
+            --locked --features "jemalloc-prof,${{ matrix.network }}" \
+            --workspace --exclude examples --exclude ef-tests \
             --partition hash:${{ matrix.partition }}/${{ strategy.job-total }} \
             -E "kind(lib) | kind(bin) | kind(proc-macro)"
 
@@ -63,17 +65,21 @@ jobs:
       - run: cargo nextest run --release -p ef-tests --features ef-tests
 
   doc:
-    name: doc tests
+    name: doc tests (${{ matrix.network }})
     runs-on:
       group: Reth
     timeout-minutes: 30
+    strategy:
+      matrix:
+        network: ["ethereum", "optimism"]
     steps:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@stable
       - uses: Swatinem/rust-cache@v2
         with:
           cache-on-failure: true
-      - run: cargo test --doc --workspace --all-features
+      - name: Run doctests
+        run: cargo test --doc --all --features "jemalloc-prof,${{ matrix.network }}"
 
   unit-success:
     name: unit success

bin/reth/Cargo.toml

@@ -119,6 +119,21 @@ min-warn-logs = ["tracing/release_max_level_warn"]
 min-info-logs = ["tracing/release_max_level_info"]
 min-debug-logs = ["tracing/release_max_level_debug"]
 min-trace-logs = ["tracing/release_max_level_trace"]
+optimism = [
+  "reth-primitives/optimism",
+  "reth-revm/optimism",
+  "reth-interfaces/optimism",
+  "reth-rpc/optimism",
+  "reth-rpc-engine-api/optimism",
+  "reth-transaction-pool/optimism",
+  "reth-provider/optimism",
+  "reth-beacon-consensus/optimism",
+  "reth-basic-payload-builder/optimism",
+  "reth-network/optimism",
+  "reth-network-api/optimism"
+]
+# no-op feature flag for switching between the `optimism` and default functionality in CI matrices
+ethereum = []
 
 [build-dependencies]
 vergen = { version = "8.0.0", features = ["build", "cargo", "git", "gitcl"] }

bin/reth/src/args/mod.rs

@@ -43,6 +43,12 @@ pub use dev_args::DevArgs;
 mod pruning_args;
 pub use pruning_args::PruningArgs;
 
+/// RollupArgs for configuring the op-reth rollup
+#[cfg(feature = "optimism")]
+mod rollup_args;
+#[cfg(feature = "optimism")]
+pub use rollup_args::RollupArgs;
+
 pub mod utils;
 
 pub mod types;

bin/reth/src/args/payload_builder_args.rs

@@ -36,6 +36,18 @@ pub struct PayloadBuilderArgs {
     /// Maximum number of tasks to spawn for building a payload.
     #[arg(long = "builder.max-tasks", help_heading = "Builder", default_value = "3", value_parser = RangedU64ValueParser::<usize>::new().range(1..))]
     pub max_payload_tasks: usize,
+
+    /// By default the pending block equals the latest block
+    /// to save resources and not leak txs from the tx-pool,
+    /// this flag enables computing of the pending block
+    /// from the tx-pool instead.
+    ///
+    /// If `compute_pending_block` is not enabled, the payload builder
+    /// will use the payload attributes from the latest block. Note
+    /// that this flag is not yet functional.
+    #[cfg(feature = "optimism")]
+    #[arg(long = "rollup.compute-pending-block")]
+    pub compute_pending_block: bool,
 }
 
 impl PayloadBuilderConfig for PayloadBuilderArgs {
@@ -58,6 +70,11 @@ impl PayloadBuilderConfig for PayloadBuilderArgs {
     fn max_payload_tasks(&self) -> usize {
         self.max_payload_tasks
     }
+
+    #[cfg(feature = "optimism")]
+    fn compute_pending_block(&self) -> bool {
+        self.compute_pending_block
+    }
 }
 
 #[derive(Clone, Debug, Default)]

bin/reth/src/args/rollup_args.rs

@@ -0,0 +1,19 @@
+//! clap [Args](clap::Args) for op-reth rollup configuration
+
+/// Parameters for rollup configuration
+#[derive(Debug, clap::Args)]
+#[command(next_help_heading = "Rollup")]
+pub struct RollupArgs {
+    /// HTTP endpoint for the sequencer mempool
+    #[arg(long = "rollup.sequencer-http", value_name = "HTTP_URL")]
+    pub sequencer_http: Option<String>,
+
+    /// Disable transaction pool gossip
+    #[arg(long = "rollup.disable-tx-pool-gossip")]
+    pub disable_txpool_gossip: bool,
+
+    /// Enable walkback to genesis on startup. This is useful for re-validating the existing DB
+    /// prior to beginning normal syncing.
+    #[arg(long = "rollup.enable-genesis-walkback")]
+    pub enable_genesis_walkback: bool,
+}

bin/reth/src/args/utils.rs

@@ -12,6 +12,9 @@ use std::{
     time::Duration,
 };
 
+#[cfg(feature = "optimism")]
+use reth_primitives::{BASE_GOERLI, BASE_MAINNET};
+
 /// Helper to parse a [Duration] from seconds
 pub fn parse_duration_from_secs(arg: &str) -> eyre::Result<Duration, std::num::ParseIntError> {
     let seconds = arg.parse()?;
@@ -27,6 +30,10 @@ pub fn chain_spec_value_parser(s: &str) -> eyre::Result<Arc<ChainSpec>, eyre::Er
         "sepolia" => SEPOLIA.clone(),
         "holesky" => HOLESKY.clone(),
         "dev" => DEV.clone(),
+        #[cfg(feature = "optimism")]
+        "base-goerli" => BASE_GOERLI.clone(),
+        #[cfg(feature = "optimism")]
+        "base" => BASE_MAINNET.clone(),
         _ => {
             let raw = fs::read_to_string(PathBuf::from(shellexpand::full(s)?.into_owned()))?;
             serde_json::from_str(&raw)?
@@ -46,6 +53,10 @@ pub fn genesis_value_parser(s: &str) -> eyre::Result<Arc<ChainSpec>, eyre::Error
         "sepolia" => SEPOLIA.clone(),
         "holesky" => HOLESKY.clone(),
         "dev" => DEV.clone(),
+        #[cfg(feature = "optimism")]
+        "base-goerli" => BASE_GOERLI.clone(),
+        #[cfg(feature = "optimism")]
+        "base" => BASE_MAINNET.clone(),
         _ => {
             // try to read json from path first
             let mut raw =
@@ -156,6 +167,15 @@ mod tests {
     use secp256k1::rand::thread_rng;
     use std::collections::HashMap;
 
+    #[cfg(feature = "optimism")]
+    #[test]
+    fn parse_optimism_chain_spec() {
+        for chain in ["base-goerli", "base"] {
+            chain_spec_value_parser(chain).unwrap();
+            genesis_value_parser(chain).unwrap();
+        }
+    }
+
     #[test]
     fn parse_known_chain_spec() {
         for chain in ["mainnet", "sepolia", "goerli", "holesky"] {

bin/reth/src/cli/config.rs

@@ -97,4 +97,8 @@ pub trait PayloadBuilderConfig {
 
     /// Maximum number of tasks to spawn for building a payload.
     fn max_payload_tasks(&self) -> usize;
+
+    /// Returns whether or not to construct the pending block.
+    #[cfg(feature = "optimism")]
+    fn compute_pending_block(&self) -> bool;
 }

bin/reth/src/cli/ext.rs

@@ -101,17 +101,33 @@ pub trait RethNodeCommandConfig: fmt::Debug {
         Conf: PayloadBuilderConfig,
         Reth: RethNodeComponents,
     {
-        let payload_generator = BasicPayloadJobGenerator::new(
+        let payload_job_config = BasicPayloadJobGeneratorConfig::default()
+            .interval(conf.interval())
+            .deadline(conf.deadline())
+            .max_payload_tasks(conf.max_payload_tasks())
+            .extradata(conf.extradata_rlp_bytes())
+            .max_gas_limit(conf.max_gas_limit());
+
+        #[cfg(feature = "optimism")]
+        let payload_job_config =
+            payload_job_config.compute_pending_block(conf.compute_pending_block());
+
+        // The default payload builder is implemented on the unit type.
+        #[cfg(not(feature = "optimism"))]
+        #[allow(clippy::let_unit_value)]
+        let payload_builder = ();
+
+        // Optimism's payload builder is impelmented on the OptimismPayloadBuilder type.
+        #[cfg(feature = "optimism")]
+        let payload_builder = reth_basic_payload_builder::OptimismPayloadBuilder;
+
+        let payload_generator = BasicPayloadJobGenerator::with_builder(
             components.provider(),
             components.pool(),
             components.task_executor(),
-            BasicPayloadJobGeneratorConfig::default()
-                .interval(conf.interval())
-                .deadline(conf.deadline())
-                .max_payload_tasks(conf.max_payload_tasks())
-                .extradata(conf.extradata_rlp_bytes())
-                .max_gas_limit(conf.max_gas_limit()),
+            payload_job_config,
             components.chain_spec(),
+            payload_builder,
         );
         let (payload_service, payload_builder) = PayloadBuilderService::new(payload_generator);
 

bin/reth/src/debug_cmd/build_block.rs

@@ -245,12 +245,17 @@ impl Command {
             suggested_fee_recipient: self.suggested_fee_recipient,
             // TODO: add support for withdrawals
             withdrawals: None,
+            #[cfg(feature = "optimism")]
+            optimism_payload_attributes: reth_rpc_types::engine::OptimismPayloadAttributes::default(
+            ),
         };
         let payload_config = PayloadConfig::new(
             Arc::clone(&best_block),
             Bytes::default(),
-            PayloadBuilderAttributes::new(best_block.hash, payload_attrs),
+            PayloadBuilderAttributes::try_new(best_block.hash, payload_attrs)?,
             self.chain.clone(),
+            #[cfg(feature = "optimism")]
+            true,
         );
         let args = BuildArguments::new(
             blockchain_db.clone(),

bin/reth/src/lib.rs

@@ -15,6 +15,9 @@
 //!   calls to the logging component is made.
 //! - `min-debug-logs`: Disables all logs below `debug` level.
 //! - `min-trace-logs`: Disables all logs below `trace` level.
+//! - `optimism`: Enables [OP-Stack](https://stack.optimism.io/) support for the node. Note that
+//!   this breaks compatibility with the Ethereum mainnet as a new deposit transaction type is
+//!   introduced as well as gas cost changes.
 
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/paradigmxyz/reth/main/assets/reth-docs.png",

bin/reth/src/main.rs

@@ -4,9 +4,6 @@
 static ALLOC: jemallocator::Jemalloc = jemallocator::Jemalloc;
 
 fn main() {
-    // ensure we have the correct features enabled
-    reth::primitives::ensure_ethereum!();
-
     if let Err(err) = reth::cli::run() {
         eprintln!("Error: {err:?}");
         std::process::exit(1);