Skip to content

Commit c31f1ce

Browse files
committed
Add short descriptions to probing tests
1 parent 3571c5e commit c31f1ce

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

tests/probing_tests.rs

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,8 @@ fn print_probing_perfomance(observers: &[&Node], all_nodes: &[&Node]) {
253253
println!();
254254
}
255255

256-
/// Test change of locked_msat amount
256+
/// Verifies that `locked_msat` increases when a probe is dispatched and returns
257+
/// to zero once the probe resolves (succeeds or fails).
257258
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
258259
async fn probe_budget_increments_and_decrements() {
259260
let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
@@ -308,8 +309,11 @@ async fn probe_budget_increments_and_decrements() {
308309
node_c.stop().unwrap();
309310
}
310311

311-
/// Test that probing stops if the upper locked in flight probe limit is reached.
312-
/// Uses a slow probing interval (3s) so we can capture baseline capacity before the first probe.
312+
/// Verifies that no new probes are dispatched once the in-flight budget is exhausted.
313+
///
314+
/// Exhaustion is triggered by stopping the intermediate node (B) while a probe HTLC
315+
/// is in-flight, preventing resolution and keeping the budget locked. After B restarts
316+
/// the HTLC fails, the budget clears, and probing resumes.
313317
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
314318
async fn exhausted_probe_budget_blocks_new_probes() {
315319
let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();
@@ -424,7 +428,9 @@ async fn exhausted_probe_budget_blocks_new_probes() {
424428
node_c.stop().unwrap();
425429
}
426430

427-
/// Strategies perfomance test
431+
/// Builds a random mesh of nodes, runs `RandomStrategy` and `HighDegreeStrategy`
432+
/// probers alongside payment rounds, then prints scorer liquidity estimates to
433+
/// compare probing coverage.
428434
#[tokio::test(flavor = "multi_thread", worker_threads = 2)]
429435
async fn probing_strategies_perfomance() {
430436
let (bitcoind, electrsd) = setup_bitcoind_and_electrsd();

0 commit comments

Comments
 (0)