feat: disable scroll rpc by default (#329)

frisitano · web-flow · commit 9edd11c066ae · 2025-09-19T10:30:46.000+08:00
* refactor cli args

* clean up
diff --git a/crates/node/Cargo.toml b/crates/node/Cargo.toml
@@ -120,21 +120,8 @@ alloy-rpc-types-eth = { workspace = true }
 [features]
 js-tracer = ["reth-scroll-node/js-tracer", "reth-scroll-rpc/js-tracer"]
 test-utils = [
-    "reth-chainspec/test-utils",
-    "reth-evm/test-utils",
-    "reth-e2e-test-utils",
     "reth-engine-local",
-    "reth-network/test-utils",
-    "reth-node-builder/test-utils",
-    "reth-provider/test-utils",
-    "reth-revm/test-utils",
-    "reth-scroll-node/test-utils",
-    "reth-transaction-pool/test-utils",
     "reth-trie-db/test-utils",
-    "rollup-node-providers/test-utils",
-    "rollup-node-watcher/test-utils",
-    "scroll-db/test-utils",
-    "scroll-engine/test-utils",
     "reth-chainspec/test-utils",
     "reth-evm/test-utils",
     "reth-network/test-utils",
@@ -143,7 +130,6 @@ test-utils = [
     "reth-revm/test-utils",
     "reth-scroll-node/test-utils",
     "reth-transaction-pool/test-utils",
-    "reth-trie-db/test-utils",
     "rollup-node-providers/test-utils",
     "rollup-node-watcher/test-utils",
     "scroll-db/test-utils",
@@ -155,5 +141,4 @@ test-utils = [
     "alloy-rpc-types-engine",
     "scroll-derivation-pipeline",
     "reth-primitives-traits/test-utils",
-    "reth-primitives-traits/test-utils",
 ]
diff --git a/crates/node/src/add_ons/mod.rs b/crates/node/src/add_ons/mod.rs
@@ -129,10 +129,12 @@ where
 
         let (tx, rx) = tokio::sync::oneshot::channel();
         let rollup_node_rpc_ext = RollupNodeRpcExt::<N::Network>::new(rx);
-        rpc_add_ons = rpc_add_ons.extend_rpc_modules(move |ctx| {
-            ctx.modules.merge_configured(rollup_node_rpc_ext.into_rpc())?;
-            Ok(())
-        });
+        if rollup_node_manager_addon.config().rpc_args.enabled {
+            rpc_add_ons = rpc_add_ons.extend_rpc_modules(move |ctx| {
+                ctx.modules.merge_configured(rollup_node_rpc_ext.into_rpc())?;
+                Ok(())
+            });
+        }
 
         let rpc_handle = rpc_add_ons.launch_add_ons_with(ctx.clone(), |_| Ok(())).await?;
         let (rollup_manager_handle, l1_watcher_tx) =
diff --git a/crates/node/src/add_ons/rollup.rs b/crates/node/src/add_ons/rollup.rs
@@ -45,6 +45,11 @@ impl RollupManagerAddOn {
         Self { config, scroll_wire_event }
     }
 
+    /// Returns a reference to the scroll rollup node config.
+    pub const fn config(&self) -> &ScrollRollupNodeConfig {
+        &self.config
+    }
+
     /// Launch the rollup node manager addon.
     pub async fn launch<N: FullNodeComponents, EthApi: EthApiTypes>(
         self,
diff --git a/crates/node/src/args.rs b/crates/node/src/args.rs
@@ -58,7 +58,7 @@ pub struct ScrollRollupNodeConfig {
     pub consensus_args: ConsensusArgs,
     /// Database args
     #[command(flatten)]
-    pub database_args: DatabaseArgs,
+    pub database_args: RollupNodeDatabaseArgs,
     /// Chain orchestrator args.
     #[command(flatten)]
     pub chain_orchestrator_args: ChainOrchestratorArgs,
@@ -76,13 +76,16 @@ pub struct ScrollRollupNodeConfig {
     pub sequencer_args: SequencerArgs,
     /// The network arguments
     #[command(flatten)]
-    pub network_args: NetworkArgs,
+    pub network_args: RollupNodeNetworkArgs,
+    /// The rpc arguments
+    #[command(flatten)]
+    pub rpc_args: RpcArgs,
     /// The signer arguments
     #[command(flatten)]
     pub signer_args: SignerArgs,
     /// The gas price oracle args
     #[command(flatten)]
-    pub gas_price_oracle_args: GasPriceOracleArgs,
+    pub gas_price_oracle_args: RollupNodeGasPriceOracleArgs,
     /// The database connection (not parsed via CLI but hydrated after validation).
     #[arg(skip)]
     pub database: Option<Arc<Database>>,
@@ -127,7 +130,7 @@ impl ScrollRollupNodeConfig {
     ) -> eyre::Result<()> {
         // Instantiate the database
         let db_path = node_config.datadir().db();
-        let database_path = if let Some(database_path) = &self.database_args.path {
+        let database_path = if let Some(database_path) = &self.database_args.rn_db_path {
             database_path.to_string_lossy().to_string()
         } else {
             // append the path using strings as using `join(...)` overwrites "sqlite://"
@@ -408,10 +411,14 @@ impl ScrollRollupNodeConfig {
 
 /// The database arguments.
 #[derive(Debug, Default, Clone, clap::Args)]
-pub struct DatabaseArgs {
+pub struct RollupNodeDatabaseArgs {
     /// Database path
-    #[arg(long)]
-    pub path: Option<PathBuf>,
+    #[arg(
+        long = "rollup-node-db.path",
+        value_name = "DB_PATH",
+        help = "The database path for the rollup node database"
+    )]
+    pub rn_db_path: Option<PathBuf>,
 }
 
 /// The database arguments.
@@ -510,7 +517,7 @@ impl Default for ChainOrchestratorArgs {
 
 /// The network arguments.
 #[derive(Debug, Clone, clap::Args)]
-pub struct NetworkArgs {
+pub struct RollupNodeNetworkArgs {
     /// A bool to represent if new blocks should be bridged from the eth wire protocol to the
     /// scroll wire protocol.
     #[arg(long = "network.bridge")]
@@ -530,7 +537,7 @@ pub struct NetworkArgs {
     pub signer_address: Option<Address>,
 }
 
-impl Default for NetworkArgs {
+impl Default for RollupNodeNetworkArgs {
     fn default() -> Self {
         Self {
             enable_eth_scroll_wire_bridge: true,
@@ -541,7 +548,7 @@ impl Default for NetworkArgs {
     }
 }
 
-impl NetworkArgs {
+impl RollupNodeNetworkArgs {
     /// Get the default authorized signer address for the given chain.
     pub const fn default_authorized_signer(chain: Option<NamedChain>) -> Option<Address> {
         match chain {
@@ -673,6 +680,14 @@ pub struct SignerArgs {
     pub private_key: Option<PrivateKeySigner>,
 }
 
+/// The arguments for the rpc.
+#[derive(Debug, Default, Clone, clap::Args)]
+pub struct RpcArgs {
+    /// A boolean to represent if the rollup node rpc should be enabled.
+    #[arg(long = "rpc.rollup-node", help = "Enable the rollup node RPC namespace")]
+    pub enabled: bool,
+}
+
 impl SignerArgs {
     /// Create a signer based on the configured arguments
     pub async fn signer(
@@ -740,7 +755,7 @@ impl SignerArgs {
 
 /// The arguments for the sequencer.
 #[derive(Debug, Default, Clone, clap::Args)]
-pub struct GasPriceOracleArgs {
+pub struct RollupNodeGasPriceOracleArgs {
     /// Minimum suggested priority fee (tip) in wei, default `100`
     #[arg(long, default_value_t = 100)]
     #[arg(long = "gpo.default-suggest-priority-fee", id = "default_suggest_priority_fee", value_name = "DEFAULT_SUGGEST_PRIORITY_FEE", default_value_t = constants::DEFAULT_SUGGEST_PRIORITY_FEE)]
@@ -773,20 +788,22 @@ mod tests {
     #[test]
     fn test_network_args_default_authorized_signer() {
         // Test Scroll mainnet
-        let mainnet_signer = NetworkArgs::default_authorized_signer(Some(NamedChain::Scroll));
+        let mainnet_signer =
+            RollupNodeNetworkArgs::default_authorized_signer(Some(NamedChain::Scroll));
         assert_eq!(mainnet_signer, Some(constants::SCROLL_MAINNET_SIGNER));
 
         // Test Scroll Sepolia
         let sepolia_signer =
-            NetworkArgs::default_authorized_signer(Some(NamedChain::ScrollSepolia));
+            RollupNodeNetworkArgs::default_authorized_signer(Some(NamedChain::ScrollSepolia));
         assert_eq!(sepolia_signer, Some(constants::SCROLL_SEPOLIA_SIGNER));
 
         // Test other chains
-        let other_signer = NetworkArgs::default_authorized_signer(Some(NamedChain::Mainnet));
+        let other_signer =
+            RollupNodeNetworkArgs::default_authorized_signer(Some(NamedChain::Mainnet));
         assert_eq!(other_signer, None);
 
         // Test None chain
-        let none_signer = NetworkArgs::default_authorized_signer(None);
+        let none_signer = RollupNodeNetworkArgs::default_authorized_signer(None);
         assert_eq!(none_signer, None);
     }
 
@@ -796,11 +813,11 @@ mod tests {
 
         // Test with configured signer
         let network_args =
-            NetworkArgs { signer_address: Some(custom_signer), ..Default::default() };
+            RollupNodeNetworkArgs { signer_address: Some(custom_signer), ..Default::default() };
         assert_eq!(network_args.effective_signer(Some(NamedChain::Scroll)), Some(custom_signer));
 
         // Test without configured signer, fallback to default
-        let network_args_default = NetworkArgs::default();
+        let network_args_default = RollupNodeNetworkArgs::default();
         assert_eq!(
             network_args_default.effective_signer(Some(NamedChain::Scroll)),
             Some(constants::SCROLL_MAINNET_SIGNER)
@@ -818,18 +835,19 @@ mod tests {
             test: false,
             sequencer_args: SequencerArgs { sequencer_enabled: true, ..Default::default() },
             signer_args: SignerArgs { key_file: None, aws_kms_key_id: None, private_key: None },
-            database_args: DatabaseArgs::default(),
+            database_args: RollupNodeDatabaseArgs::default(),
             engine_driver_args: EngineDriverArgs::default(),
             chain_orchestrator_args: ChainOrchestratorArgs::default(),
             l1_provider_args: L1ProviderArgs::default(),
             blob_provider_args: BlobProviderArgs::default(),
-            network_args: NetworkArgs::default(),
-            gas_price_oracle_args: GasPriceOracleArgs::default(),
+            network_args: RollupNodeNetworkArgs::default(),
+            gas_price_oracle_args: RollupNodeGasPriceOracleArgs::default(),
             consensus_args: ConsensusArgs {
                 algorithm: ConsensusAlgorithm::SystemContract,
                 authorized_signer: None,
             },
             database: None,
+            rpc_args: RpcArgs::default(),
         };
 
         let result = config.validate();
@@ -849,18 +867,19 @@ mod tests {
                 aws_kms_key_id: Some("key-id".to_string()),
                 private_key: None,
             },
-            database_args: DatabaseArgs::default(),
+            database_args: RollupNodeDatabaseArgs::default(),
             engine_driver_args: EngineDriverArgs::default(),
             chain_orchestrator_args: ChainOrchestratorArgs::default(),
             l1_provider_args: L1ProviderArgs::default(),
             blob_provider_args: BlobProviderArgs::default(),
-            network_args: NetworkArgs::default(),
-            gas_price_oracle_args: GasPriceOracleArgs::default(),
+            network_args: RollupNodeNetworkArgs::default(),
+            gas_price_oracle_args: RollupNodeGasPriceOracleArgs::default(),
             consensus_args: ConsensusArgs {
                 algorithm: ConsensusAlgorithm::SystemContract,
                 authorized_signer: None,
             },
             database: None,
+            rpc_args: RpcArgs::default(),
         };
 
         let result = config.validate();
@@ -878,15 +897,16 @@ mod tests {
                 aws_kms_key_id: None,
                 private_key: None,
             },
-            database_args: DatabaseArgs::default(),
+            database_args: RollupNodeDatabaseArgs::default(),
             chain_orchestrator_args: ChainOrchestratorArgs::default(),
             engine_driver_args: EngineDriverArgs::default(),
             l1_provider_args: L1ProviderArgs::default(),
             blob_provider_args: BlobProviderArgs::default(),
-            network_args: NetworkArgs::default(),
-            gas_price_oracle_args: GasPriceOracleArgs::default(),
+            network_args: RollupNodeNetworkArgs::default(),
+            gas_price_oracle_args: RollupNodeGasPriceOracleArgs::default(),
             consensus_args: ConsensusArgs::noop(),
             database: None,
+            rpc_args: RpcArgs::default(),
         };
 
         assert!(config.validate().is_ok());
@@ -902,15 +922,16 @@ mod tests {
                 aws_kms_key_id: Some("key-id".to_string()),
                 private_key: None,
             },
-            database_args: DatabaseArgs::default(),
+            database_args: RollupNodeDatabaseArgs::default(),
             engine_driver_args: EngineDriverArgs::default(),
             chain_orchestrator_args: ChainOrchestratorArgs::default(),
             l1_provider_args: L1ProviderArgs::default(),
             blob_provider_args: BlobProviderArgs::default(),
-            network_args: NetworkArgs::default(),
-            gas_price_oracle_args: GasPriceOracleArgs::default(),
+            network_args: RollupNodeNetworkArgs::default(),
+            gas_price_oracle_args: RollupNodeGasPriceOracleArgs::default(),
             consensus_args: ConsensusArgs::noop(),
             database: None,
+            rpc_args: RpcArgs::default(),
         };
 
         assert!(config.validate().is_ok());
@@ -922,15 +943,16 @@ mod tests {
             test: false,
             sequencer_args: SequencerArgs { sequencer_enabled: false, ..Default::default() },
             signer_args: SignerArgs { key_file: None, aws_kms_key_id: None, private_key: None },
-            database_args: DatabaseArgs::default(),
+            database_args: RollupNodeDatabaseArgs::default(),
             engine_driver_args: EngineDriverArgs::default(),
             chain_orchestrator_args: ChainOrchestratorArgs::default(),
             l1_provider_args: L1ProviderArgs::default(),
             blob_provider_args: BlobProviderArgs::default(),
-            network_args: NetworkArgs::default(),
-            gas_price_oracle_args: GasPriceOracleArgs::default(),
+            network_args: RollupNodeNetworkArgs::default(),
+            gas_price_oracle_args: RollupNodeGasPriceOracleArgs::default(),
             consensus_args: ConsensusArgs::noop(),
             database: None,
+            rpc_args: RpcArgs::default(),
         };
 
         assert!(config.validate().is_ok());
diff --git a/crates/node/src/builder/network.rs b/crates/node/src/builder/network.rs
@@ -23,7 +23,7 @@ use scroll_db::{
 use std::{fmt, fmt::Debug, sync::Arc};
 use tracing::{debug, info, trace, warn};
 
-use crate::args::NetworkArgs;
+use crate::args::RollupNodeNetworkArgs;
 
 /// The network builder for Scroll.
 #[derive(Debug)]
@@ -78,7 +78,7 @@ where
         // 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())
+            RollupNodeNetworkArgs::default_authorized_signer(chain_spec.chain().named())
         } else {
             self.signer
         };
diff --git a/crates/node/src/test_utils.rs b/crates/node/src/test_utils.rs
@@ -1,10 +1,10 @@
 //! This crate contains utilities for running end-to-end tests for the scroll reth node.
 
-use crate::{ConsensusArgs, GasPriceOracleArgs};
+use crate::{ConsensusArgs, RollupNodeGasPriceOracleArgs};
 
 use super::{
-    BlobProviderArgs, ChainOrchestratorArgs, DatabaseArgs, EngineDriverArgs, L1ProviderArgs,
-    ScrollRollupNode, ScrollRollupNodeConfig, SequencerArgs,
+    BlobProviderArgs, ChainOrchestratorArgs, EngineDriverArgs, L1ProviderArgs,
+    RollupNodeDatabaseArgs, RpcArgs, ScrollRollupNode, ScrollRollupNodeConfig, SequencerArgs,
 };
 use alloy_primitives::Bytes;
 use reth_chainspec::EthChainSpec;
@@ -141,8 +141,8 @@ pub async fn generate_tx(wallet: Arc<Mutex<Wallet>>) -> Bytes {
 pub fn default_test_scroll_rollup_node_config() -> ScrollRollupNodeConfig {
     ScrollRollupNodeConfig {
         test: true,
-        network_args: crate::args::NetworkArgs::default(),
-        database_args: DatabaseArgs::default(),
+        network_args: crate::args::RollupNodeNetworkArgs::default(),
+        database_args: RollupNodeDatabaseArgs::default(),
         l1_provider_args: L1ProviderArgs::default(),
         engine_driver_args: EngineDriverArgs { sync_at_startup: true },
         chain_orchestrator_args: ChainOrchestratorArgs {
@@ -156,9 +156,10 @@ pub fn default_test_scroll_rollup_node_config() -> ScrollRollupNodeConfig {
         },
         blob_provider_args: BlobProviderArgs { mock: true, ..Default::default() },
         signer_args: Default::default(),
-        gas_price_oracle_args: GasPriceOracleArgs::default(),
+        gas_price_oracle_args: RollupNodeGasPriceOracleArgs::default(),
         consensus_args: ConsensusArgs::noop(),
         database: None,
+        rpc_args: RpcArgs { enabled: true },
     }
 }
 
@@ -173,8 +174,10 @@ pub fn default_test_scroll_rollup_node_config() -> ScrollRollupNodeConfig {
 pub fn default_sequencer_test_scroll_rollup_node_config() -> ScrollRollupNodeConfig {
     ScrollRollupNodeConfig {
         test: true,
-        network_args: crate::args::NetworkArgs::default(),
-        database_args: DatabaseArgs { path: Some(PathBuf::from("sqlite::memory:")) },
+        network_args: crate::args::RollupNodeNetworkArgs::default(),
+        database_args: RollupNodeDatabaseArgs {
+            rn_db_path: Some(PathBuf::from("sqlite::memory:")),
+        },
         l1_provider_args: L1ProviderArgs::default(),
         engine_driver_args: EngineDriverArgs { sync_at_startup: true },
         chain_orchestrator_args: ChainOrchestratorArgs {
@@ -193,8 +196,9 @@ pub fn default_sequencer_test_scroll_rollup_node_config() -> ScrollRollupNodeCon
         },
         blob_provider_args: BlobProviderArgs { mock: true, ..Default::default() },
         signer_args: Default::default(),
-        gas_price_oracle_args: GasPriceOracleArgs::default(),
+        gas_price_oracle_args: RollupNodeGasPriceOracleArgs::default(),
         consensus_args: ConsensusArgs::noop(),
         database: None,
+        rpc_args: RpcArgs { enabled: true },
     }
 }
diff --git a/crates/node/tests/e2e.rs b/crates/node/tests/e2e.rs
diff --git a/crates/node/tests/sync.rs b/crates/node/tests/sync.rs
diff --git a/crates/sequencer/tests/e2e.rs b/crates/sequencer/tests/e2e.rs
