feat(sequencer): add flag to enable auto start of sequencer on startup (#306)

Author: jonastheis

crates/manager/src/manager/mod.rs

@@ -175,6 +175,7 @@ where
         sequencer: Option<Sequencer<L1MP>>,
         signer: Option<SignerHandle>,
         block_time: Option<u64>,
+        auto_start: bool,
         chain_orchestrator: ChainOrchestrator<CS, <N as BlockDownloaderProvider>::Client, P>,
         l1_v2_message_queue_start_index: u64,
     ) -> (Self, RollupManagerHandle<N>) {
@@ -193,7 +194,11 @@ where
             event_sender: None,
             sequencer,
             signer,
-            block_building_trigger: block_time.map(delayed_interval),
+            block_building_trigger: if auto_start {
+                block_time.map(delayed_interval)
+            } else {
+                None
+            },
             block_time_config: block_time,
         };
         (rnm, RollupManagerHandle::new(handle_tx))

crates/node/src/args.rs

@@ -307,7 +307,7 @@ impl ScrollRollupNodeConfig {
 
         // Construct the Sequencer.
         let chain_config = chain_spec.chain_config();
-        let (sequencer, block_time) = if self.sequencer_args.sequencer_enabled {
+        let (sequencer, block_time, auto_start) = if self.sequencer_args.sequencer_enabled {
             let args = &self.sequencer_args;
             let sequencer = Sequencer::new(
                 Arc::new(l1_messages_provider),
@@ -317,9 +317,9 @@ impl ScrollRollupNodeConfig {
                 0,
                 self.sequencer_args.l1_message_inclusion_mode,
             );
-            (Some(sequencer), (args.block_time != 0).then_some(args.block_time))
+            (Some(sequencer), (args.block_time != 0).then_some(args.block_time), args.auto_start)
         } else {
-            (None, None)
+            (None, None, false)
         };
 
         // Instantiate the signer
@@ -366,6 +366,7 @@ impl ScrollRollupNodeConfig {
             sequencer,
             signer,
             block_time,
+            auto_start,
             chain_orchestrator,
             l1_v2_message_queue_start_index,
         )
@@ -549,6 +550,9 @@ pub struct SequencerArgs {
     /// Enable the scroll block sequencer.
     #[arg(long = "sequencer.enabled", default_value_t = false)]
     pub sequencer_enabled: bool,
+    /// Whether the sequencer should start sequencing automatically on startup.
+    #[arg(long = "sequencer.auto-start", default_value_t = false)]
+    pub auto_start: bool,
     /// The block time for the sequencer.
     #[arg(long = "sequencer.block-time", id = "sequencer_block_time", value_name = "SEQUENCER_BLOCK_TIME", default_value_t = constants::DEFAULT_BLOCK_TIME)]
     pub block_time: u64,

crates/node/src/test_utils.rs

@@ -185,6 +185,7 @@ pub fn default_sequencer_test_scroll_rollup_node_config() -> ScrollRollupNodeCon
         },
         sequencer_args: SequencerArgs {
             sequencer_enabled: true,
+            auto_start: true,
             block_time: 0,
             payload_building_duration: 40,
             fee_recipient: Default::default(),

crates/node/tests/e2e.rs

@@ -62,6 +62,7 @@ async fn can_bridge_l1_messages() -> eyre::Result<()> {
         chain_orchestrator_args: ChainOrchestratorArgs::default(),
         sequencer_args: SequencerArgs {
             sequencer_enabled: true,
+            auto_start: true,
             block_time: 0,
             l1_message_inclusion_mode: L1MessageInclusionMode::BlockDepth(0),
             allow_empty_blocks: true,
@@ -157,6 +158,7 @@ async fn can_sequence_and_gossip_blocks() {
         chain_orchestrator_args: ChainOrchestratorArgs::default(),
         sequencer_args: SequencerArgs {
             sequencer_enabled: true,
+            auto_start: true,
             block_time: 0,
             l1_message_inclusion_mode: L1MessageInclusionMode::BlockDepth(0),
             payload_building_duration: 1000,
@@ -255,6 +257,7 @@ async fn can_penalize_peer_for_invalid_block() {
         engine_driver_args: EngineDriverArgs::default(),
         sequencer_args: SequencerArgs {
             sequencer_enabled: true,
+            auto_start: true,
             block_time: 0,
             l1_message_inclusion_mode: L1MessageInclusionMode::BlockDepth(0),
             payload_building_duration: 1000,

crates/node/tests/sync.rs

@@ -197,6 +197,7 @@ async fn test_should_consolidate_after_optimistic_sync() -> eyre::Result<()> {
         chain_orchestrator_args: ChainOrchestratorArgs::default(),
         sequencer_args: SequencerArgs {
             sequencer_enabled: true,
+            auto_start: true,
             block_time: 0,
             l1_message_inclusion_mode: L1MessageInclusionMode::BlockDepth(0),
             allow_empty_blocks: true,
@@ -445,6 +446,7 @@ async fn test_consolidation() -> eyre::Result<()> {
         chain_orchestrator_args: ChainOrchestratorArgs::default(),
         sequencer_args: SequencerArgs {
             sequencer_enabled: true,
+            auto_start: true,
             block_time: 0,
             l1_message_inclusion_mode: L1MessageInclusionMode::BlockDepth(0),
             allow_empty_blocks: true,
@@ -618,6 +620,7 @@ async fn test_chain_orchestrator_shallow_reorg_with_gap() -> eyre::Result<()> {
         chain_orchestrator_args: ChainOrchestratorArgs::default(),
         sequencer_args: SequencerArgs {
             sequencer_enabled: true,
+            auto_start: true,
             block_time: 0,
             l1_message_inclusion_mode: L1MessageInclusionMode::BlockDepth(0),
             allow_empty_blocks: true,

crates/sequencer/tests/e2e.rs

@@ -502,6 +502,7 @@ async fn can_sequence_blocks_with_private_key_file() -> eyre::Result<()> {
         chain_orchestrator_args: ChainOrchestratorArgs::default(),
         sequencer_args: SequencerArgs {
             sequencer_enabled: true,
+            auto_start: true,
             block_time: 0,
             l1_message_inclusion_mode: L1MessageInclusionMode::BlockDepth(0),
             payload_building_duration: 1000,
@@ -594,6 +595,7 @@ async fn can_sequence_blocks_with_hex_key_file_without_prefix() -> eyre::Result<
         chain_orchestrator_args: ChainOrchestratorArgs::default(),
         sequencer_args: SequencerArgs {
             sequencer_enabled: true,
+            auto_start: true,
             block_time: 0,
             l1_message_inclusion_mode: L1MessageInclusionMode::BlockDepth(0),
             payload_building_duration: 1000,

tests/launch_rollup_node_sequencer.bash

@@ -7,6 +7,7 @@ exec rollup-node node --chain dev --datadir=/l2reth --metrics=0.0.0.0:6060 --net
   --log.stdout.format log-fmt -vvv \
   --test \
   --sequencer.enabled \
+  --sequencer.auto-start \
   --sequencer.block-time 250 \
   --sequencer.payload-building-duration 230 \
   --sequencer.allow-empty-blocks \