feat: converge on a single database for both rollup node and eth networking (#318)

frisitano · web-flow · commit 3d400f782080 · 2025-09-12T17:02:01.000+08:00
* converge on a single database for both rollup node and eth networking

* clean up
diff --git a/crates/node/src/args.rs b/crates/node/src/args.rs
@@ -18,9 +18,11 @@ use aws_sdk_kms::config::BehaviorVersion;
 use reth_chainspec::EthChainSpec;
 use reth_network::NetworkProtocols;
 use reth_network_api::FullNetwork;
-use reth_node_builder::rpc::RethRpcServerHandles;
+use reth_node_builder::{rpc::RethRpcServerHandles, NodeConfig as RethNodeConfig};
 use reth_node_core::primitives::BlockHeader;
-use reth_scroll_chainspec::{ChainConfig, ScrollChainConfig, SCROLL_FEE_VAULT_ADDRESS};
+use reth_scroll_chainspec::{
+    ChainConfig, ScrollChainConfig, ScrollChainSpec, SCROLL_FEE_VAULT_ADDRESS,
+};
 use reth_scroll_node::ScrollNetworkPrimitives;
 use rollup_node_chain_orchestrator::ChainOrchestrator;
 use rollup_node_manager::{
@@ -79,6 +81,9 @@ pub struct ScrollRollupNodeConfig {
     /// The gas price oracle args
     #[command(flatten)]
     pub gas_price_oracle_args: GasPriceOracleArgs,
+    /// The database connection (not parsed via CLI but hydrated after validation).
+    #[arg(skip)]
+    pub database: Option<Arc<Database>>,
 }
 
 impl ScrollRollupNodeConfig {
@@ -112,6 +117,26 @@ impl ScrollRollupNodeConfig {
 
         Ok(())
     }
+
+    /// Hydrate the config by initializing the database connection.
+    pub async fn hydrate(
+        &mut self,
+        node_config: RethNodeConfig<ScrollChainSpec>,
+    ) -> eyre::Result<()> {
+        // Instantiate the database
+        let db_path = node_config.datadir().db();
+        let database_path = if let Some(database_path) = &self.database_args.path {
+            database_path.to_string_lossy().to_string()
+        } else {
+            // append the path using strings as using `join(...)` overwrites "sqlite://"
+            // if the path is absolute.
+            let path = db_path.join("scroll.db?mode=rwc");
+            "sqlite://".to_string() + &*path.to_string_lossy()
+        };
+        let db = Database::new(&database_path).await?;
+        self.database = Some(Arc::new(db));
+        Ok(())
+    }
 }
 
 impl ScrollRollupNodeConfig {
@@ -175,17 +200,8 @@ impl ScrollRollupNodeConfig {
             .expect("failed to create payload provider");
         let l2_provider = Arc::new(l2_provider);
 
-        // Instantiate the database
-        let db_path = ctx.datadir;
-        let database_path = if let Some(database_path) = self.database_args.path {
-            database_path.to_string_lossy().to_string()
-        } else {
-            // append the path using strings as using `join(...)` overwrites "sqlite://"
-            // if the path is absolute.
-            let path = db_path.join("scroll.db?mode=rwc");
-            "sqlite://".to_string() + &*path.to_string_lossy()
-        };
-        let db = Database::new(&database_path).await?;
+        // Fetch the database from the hydrated config.
+        let db = self.database.clone().expect("should hydrate config before build");
 
         // Run the database migrations
         if let Some(named) = chain_spec.chain().named() {
@@ -215,9 +231,6 @@ impl ScrollRollupNodeConfig {
             tracing::info!(target: "scroll::node::args", ?genesis_hash, "Overwriting genesis hash for custom chain");
         }
 
-        // Wrap the database in an Arc
-        let db = Arc::new(db);
-
         let chain_spec_fcs = || {
             ForkchoiceState::head_from_chain_spec(chain_spec.clone())
                 .expect("failed to derive forkchoice state from chain spec")
@@ -787,6 +800,7 @@ mod tests {
                 algorithm: ConsensusAlgorithm::SystemContract,
                 authorized_signer: None,
             },
+            database: None,
         };
 
         let result = config.validate();
@@ -817,6 +831,7 @@ mod tests {
                 algorithm: ConsensusAlgorithm::SystemContract,
                 authorized_signer: None,
             },
+            database: None,
         };
 
         let result = config.validate();
@@ -842,6 +857,7 @@ mod tests {
             network_args: NetworkArgs::default(),
             gas_price_oracle_args: GasPriceOracleArgs::default(),
             consensus_args: ConsensusArgs::noop(),
+            database: None,
         };
 
         assert!(config.validate().is_ok());
@@ -865,6 +881,7 @@ mod tests {
             network_args: NetworkArgs::default(),
             gas_price_oracle_args: GasPriceOracleArgs::default(),
             consensus_args: ConsensusArgs::noop(),
+            database: None,
         };
 
         assert!(config.validate().is_ok());
@@ -884,6 +901,7 @@ mod tests {
             network_args: NetworkArgs::default(),
             gas_price_oracle_args: GasPriceOracleArgs::default(),
             consensus_args: ConsensusArgs::noop(),
+            database: None,
         };
 
         assert!(config.validate().is_ok());
diff --git a/crates/node/src/builder/network.rs b/crates/node/src/builder/network.rs
@@ -17,30 +17,26 @@ use reth_transaction_pool::{PoolTransaction, TransactionPool};
 use rollup_node_signer::SignatureAsBytes;
 use scroll_alloy_hardforks::ScrollHardforks;
 use scroll_db::{Database, DatabaseOperations};
-use std::{fmt, fmt::Debug, path::PathBuf, sync::Arc};
+use std::{fmt, fmt::Debug, sync::Arc};
 use tracing::{debug, info, trace, warn};
 
 use crate::args::NetworkArgs;
 
 /// The network builder for Scroll.
-#[derive(Debug, Default)]
+#[derive(Debug)]
 pub struct ScrollNetworkBuilder {
     /// Additional `RLPx` sub-protocols to be added to the network.
     scroll_sub_protocols: RlpxSubProtocols,
     /// A reference to the rollup-node `Database`.
-    rollup_node_db_path: Option<PathBuf>,
+    rollup_node_db: Arc<Database>,
     /// The address for which we should persist and serve signatures for.
     signer: Option<Address>,
 }
 
 impl ScrollNetworkBuilder {
-    /// Create a new [`ScrollNetworkBuilder`] with default configuration.
-    pub fn new() -> Self {
-        Self {
-            scroll_sub_protocols: RlpxSubProtocols::default(),
-            rollup_node_db_path: None,
-            signer: None,
-        }
+    /// Create a new [`ScrollNetworkBuilder`] with provided rollup node database.
+    pub fn new(rollup_node_db: Arc<Database>) -> Self {
+        Self { scroll_sub_protocols: RlpxSubProtocols::default(), rollup_node_db, signer: None }
     }
 
     /// Add a scroll sub-protocol to the network builder.
@@ -49,12 +45,6 @@ impl ScrollNetworkBuilder {
         self
     }
 
-    /// Add a scroll sub-protocol to the network builder.
-    pub fn with_database_path(mut self, db_path: Option<PathBuf>) -> Self {
-        self.rollup_node_db_path = db_path;
-        self
-    }
-
     /// Set the signer for which we will persist and serve signatures if included in block header
     /// extra data field.
     pub const fn with_signer(mut self, signer: Option<Address>) -> Self {
@@ -82,29 +72,23 @@ where
         ctx: &BuilderContext<Node>,
         pool: Pool,
     ) -> eyre::Result<Self::Network> {
-        // initialize the rollup node database.
-        let db_path = ctx.config().datadir().db();
-        let database_path = if let Some(database_path) = self.rollup_node_db_path {
-            database_path.to_string_lossy().to_string()
-        } else {
-            // append the path using strings as using `join(...)` overwrites "sqlite://"
-            // if the path is absolute.
-            let path = db_path.join("scroll.db?mode=rwc");
-            "sqlite://".to_string() + &*path.to_string_lossy()
-        };
-        let db = Arc::new(Database::new(&database_path).await?);
-
         // get the header transform.
         let chain_spec = ctx.chain_spec();
         let authorized_signer = if self.signer.is_none() {
             NetworkArgs::default_authorized_signer(chain_spec.chain().named())
         } else {
             self.signer
         };
-        let transform =
-            ScrollHeaderTransform::new(chain_spec.clone(), db.clone(), authorized_signer);
-        let request_transform =
-            ScrollRequestHeaderTransform::new(chain_spec, db.clone(), authorized_signer);
+        let transform = ScrollHeaderTransform::new(
+            chain_spec.clone(),
+            self.rollup_node_db.clone(),
+            authorized_signer,
+        );
+        let request_transform = ScrollRequestHeaderTransform::new(
+            chain_spec,
+            self.rollup_node_db.clone(),
+            authorized_signer,
+        );
 
         // set the network mode to work.
         let config = ctx.network_config()?;
diff --git a/crates/node/src/main.rs b/crates/node/src/main.rs
@@ -20,8 +20,9 @@ fn main() {
     if let Err(err) = Cli::<ScrollChainSpecParser, ScrollRollupNodeConfig>::parse().run(
         |builder, args| async move {
             info!(target: "reth::cli", "Launching node");
+            let config = builder.config().clone();
             let handle = builder
-                .node(ScrollRollupNode::new(args))
+                .node(ScrollRollupNode::new(args, config).await)
                 .launch_with_fn(|builder| {
                     info!(target: "reth::cli", config = ?builder.config().chain.config, "Running with config");
 
diff --git a/crates/node/src/node.rs b/crates/node/src/node.rs
@@ -8,8 +8,9 @@ use reth_network::protocol::IntoRlpxSubProtocol;
 use reth_node_api::NodeTypes;
 use reth_node_builder::{
     components::{BasicPayloadServiceBuilder, ComponentsBuilder},
-    FullNodeTypes, Node, NodeAdapter, NodeComponentsBuilder,
+    FullNodeTypes, Node, NodeAdapter, NodeComponentsBuilder, NodeConfig,
 };
+use reth_scroll_chainspec::ScrollChainSpec;
 use reth_scroll_node::{
     ScrollConsensusBuilder, ScrollExecutorBuilder, ScrollNode, ScrollPayloadBuilderBuilder,
     ScrollPoolBuilder,
@@ -27,11 +28,19 @@ pub struct ScrollRollupNode {
 
 impl ScrollRollupNode {
     /// Create a new instance of [`ScrollRollupNode`].
-    pub fn new(config: ScrollRollupNodeConfig) -> Self {
+    pub async fn new(
+        mut config: ScrollRollupNodeConfig,
+        node_config: NodeConfig<ScrollChainSpec>,
+    ) -> Self {
         config
             .validate()
             .map_err(|e| eyre::eyre!("Configuration validation failed: {}", e))
             .expect("Configuration validation failed");
+        config
+            .hydrate(node_config)
+            .await
+            .map_err(|e| eyre::eyre!("Configuration hydration failed: {}", e))
+            .expect("Configuration hydration failed");
 
         Self { config, scroll_wire_events: Arc::new(Mutex::new(None)) }
     }
@@ -69,10 +78,11 @@ where
                 block_da_size_limit: Some(constants::DEFAULT_PAYLOAD_SIZE_LIMIT),
             }))
             .network(
-                ScrollNetworkBuilder::new()
-                    .with_sub_protocol(scroll_wire_handler.into_rlpx_sub_protocol())
-                    .with_database_path(self.config.database_args.path.clone())
-                    .with_signer(self.config.network_args.signer_address),
+                ScrollNetworkBuilder::new(
+                    self.config.database.clone().expect("database is set via hydration"),
+                )
+                .with_sub_protocol(scroll_wire_handler.into_rlpx_sub_protocol())
+                .with_signer(self.config.network_args.signer_address),
             )
     }
 
diff --git a/crates/node/src/test_utils.rs b/crates/node/src/test_utils.rs
@@ -82,9 +82,10 @@ where
 
         let span = span!(Level::INFO, "node", idx);
         let _enter = span.enter();
-        let node = ScrollRollupNode::new(scroll_node_config.clone());
-        let NodeHandle { node, node_exit_future: _ } = NodeBuilder::new(node_config.clone())
-            .testing_node(exec.clone())
+        let testing_node = NodeBuilder::new(node_config.clone()).testing_node(exec.clone());
+        let testing_config = testing_node.config().clone();
+        let node = ScrollRollupNode::new(scroll_node_config.clone(), testing_config).await;
+        let NodeHandle { node, node_exit_future: _ } = testing_node
             .with_types_and_provider::<ScrollRollupNode, BlockchainProvider<_>>()
             .with_components(node.components_builder())
             .with_add_ons(node.add_ons())
@@ -161,6 +162,7 @@ pub fn default_test_scroll_rollup_node_config() -> ScrollRollupNodeConfig {
         signer_args: Default::default(),
         gas_price_oracle_args: GasPriceOracleArgs::default(),
         consensus_args: ConsensusArgs::noop(),
+        database: None,
     }
 }
 
@@ -199,5 +201,6 @@ pub fn default_sequencer_test_scroll_rollup_node_config() -> ScrollRollupNodeCon
         signer_args: Default::default(),
         gas_price_oracle_args: GasPriceOracleArgs::default(),
         consensus_args: ConsensusArgs::noop(),
+        database: None,
     }
 }
diff --git a/crates/node/tests/e2e.rs b/crates/node/tests/e2e.rs
@@ -75,6 +75,7 @@ async fn can_bridge_l1_messages() -> eyre::Result<()> {
         signer_args: Default::default(),
         gas_price_oracle_args: GasPriceOracleArgs::default(),
         consensus_args: ConsensusArgs::noop(),
+        database: None,
     };
     let (mut nodes, _tasks, _wallet) = setup_engine(node_args, 1, chain_spec, false, false).await?;
     let node = nodes.pop().unwrap();
@@ -173,6 +174,7 @@ async fn can_sequence_and_gossip_blocks() {
         signer_args: Default::default(),
         gas_price_oracle_args: GasPriceOracleArgs::default(),
         consensus_args: ConsensusArgs::noop(),
+        database: None,
     };
 
     let (nodes, _tasks, wallet) =
@@ -274,6 +276,7 @@ async fn can_penalize_peer_for_invalid_block() {
         gas_price_oracle_args: GasPriceOracleArgs::default(),
         consensus_args: ConsensusArgs::noop(),
         chain_orchestrator_args: ChainOrchestratorArgs::default(),
+        database: None,
     };
 
     let (nodes, _tasks, _) =
@@ -828,12 +831,12 @@ async fn graceful_shutdown_consolidates_most_recent_batch_on_startup() -> eyre::
     let mut config = default_test_scroll_rollup_node_config();
     let path = node.inner.config.datadir().db().join("scroll.db?mode=rwc");
     let path = PathBuf::from("sqlite://".to_string() + &*path.to_string_lossy());
-    config.database_args.path = Some(path.clone());
     config.beacon_provider_args.url = Some(
         "http://dummy:8545"
             .parse()
             .expect("valid url that will not be used as test batches use calldata"),
     );
+    config.hydrate(node.inner.config.clone()).await?;
 
     let (_, events) = ScrollWireProtocolHandler::new(ScrollWireConfig::new(true));
     let (rnm, handle, l1_notification_tx) = config
diff --git a/crates/node/tests/sync.rs b/crates/node/tests/sync.rs
@@ -73,6 +73,7 @@ async fn test_should_consolidate_to_block_15k() -> eyre::Result<()> {
         signer_args: Default::default(),
         gas_price_oracle_args: GasPriceOracleArgs::default(),
         consensus_args: ConsensusArgs::noop(),
+        database: None,
     };
 
     let chain_spec = (*SCROLL_SEPOLIA).clone();
@@ -212,6 +213,7 @@ async fn test_should_consolidate_after_optimistic_sync() -> eyre::Result<()> {
         signer_args: Default::default(),
         gas_price_oracle_args: GasPriceOracleArgs::default(),
         consensus_args: ConsensusArgs::noop(),
+        database: None,
     };
 
     // Create the chain spec for scroll dev with Feynman activated and a test genesis.
@@ -462,6 +464,7 @@ async fn test_consolidation() -> eyre::Result<()> {
         signer_args: Default::default(),
         gas_price_oracle_args: GasPriceOracleArgs::default(),
         consensus_args: ConsensusArgs::noop(),
+        database: None,
     };
 
     // Create the chain spec for scroll dev with Feynman activated and a test genesis.
@@ -636,6 +639,7 @@ async fn test_chain_orchestrator_shallow_reorg_with_gap() -> eyre::Result<()> {
         signer_args: Default::default(),
         gas_price_oracle_args: GasPriceOracleArgs::default(),
         consensus_args: ConsensusArgs::noop(),
+        database: None,
     };
 
     // Create the chain spec for scroll dev with Feynman activated and a test genesis.
diff --git a/crates/sequencer/tests/e2e.rs b/crates/sequencer/tests/e2e.rs
@@ -520,6 +520,7 @@ async fn can_sequence_blocks_with_private_key_file() -> eyre::Result<()> {
         },
         gas_price_oracle_args: GasPriceOracleArgs::default(),
         consensus_args: ConsensusArgs::noop(),
+        database: None,
     };
 
     let (nodes, _tasks, wallet) =
@@ -613,6 +614,7 @@ async fn can_sequence_blocks_with_hex_key_file_without_prefix() -> eyre::Result<
         },
         gas_price_oracle_args: GasPriceOracleArgs::default(),
         consensus_args: ConsensusArgs::noop(),
+        database: None,
     };
 
     let (nodes, _tasks, wallet) =
