Add docs

matter-labs · Dec 6, 2023 · 63782b8 · 63782b8
1 parent 8bdfdba
commit 63782b8
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/node/actors/bft/src/testonly/ut_harness.rs b/node/actors/bft/src/testonly/ut_harness.rs
@@ -81,6 +81,15 @@ impl UTHarness {
             .unwrap();
     }
 
+    /// Validate protocol liveness in the aftermath of a timeout.
+    ///
+    /// Params refer to the expected values in the next produced `ReplicaPrepare`
+    /// messages for the new iteration.
+    ///
+    /// * `view` - the expected view of the next `ReplicaPrepare`.
+    /// * `high_vote_view` - the expected view of the high vote of the next `ReplicaPrepare`.
+    /// * `high_qc_view` - the expected view of the high qc of the next `ReplicaPrepare`.
+    ///
     pub(crate) async fn check_recovery_after_timeout(
         &mut self,
         view: ViewNumber,