Document restart function

EspressoSystems · Aug 12, 2024 · 3baddea · 3baddea
1 parent 6f623e6
commit 3baddea
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/sequencer/src/context.rs b/sequencer/src/context.rs
@@ -346,6 +346,7 @@ impl<N: ConnectedNetwork<PubKey>, P: SequencerPersistence, Ver: StaticVersionTyp
     }
 }
 
+#[allow(clippy::too_many_arguments)]
 async fn handle_events<Ver: StaticVersionType>(
     node_id: u64,
     mut events: impl Stream<Item = Event<SeqTypes>> + Unpin,

diff --git a/sequencer/src/restart_tests.rs b/sequencer/src/restart_tests.rs
@@ -506,6 +506,11 @@ impl TestNetwork {
         .unwrap();
     }
 
+    /// Restart indicated number of DA and non-DA nodes.
+    ///
+    /// If possible (less than a quorum of nodes have been stopped), check that remaining nodes can
+    /// still make progress without the restarted nodes. In any case, check that the network as a
+    /// whole makes progress once the restarted nodes are back online.
     async fn restart(&mut self, da_nodes: usize, regular_nodes: usize) {
         tracing::info!(da_nodes, regular_nodes, "shutting down some nodes");
         join_all(