Add docs to `commitment_signed_dance_return_raa`
What the developer wrote
Authored by elnosh
Add docs to `commitment_signed_dance_return_raa`
What changed, and why it matters
This commit only adds explanatory documentation comments to an existing internal test helper function. No code behavior was changed, so it cannot introduce or fix a security issue on its own.
No security action needed; this is a documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff adds a Rust doc comment to commitment_signed_dance_return_raa in lightning/src/ln/functional_test_utils.rs, describing that it runs the commitment_signed dance and returns the recipient’s revoke_and_ack. There are no logic, signature, or state changes.
Changed components
lightning/src/ln/functional_test_utils.rsInspect captured patch +4 / −0
diff --git a/lightning/src/ln/functional_test_utils.rs b/lightning/src/ln/functional_test_utils.rs
index 3460d30..7fbf72a 100644
--- a/lightning/src/ln/functional_test_utils.rs
+++ b/lightning/src/ln/functional_test_utils.rs
@@ -2670,6 +2670,10 @@ pub fn do_main_commitment_signed_dance(
(extra_msg_option, bs_revoke_and_ack)
}
+/// Runs the commitment_signed dance by delivering the commitment_signed and handling the
+/// responding `revoke_and_ack` and `commitment_signed`.
+///
+/// Returns the recipient's `revoke_and_ack`.
pub fn commitment_signed_dance_return_raa(
node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>,
commitment_signed: &Vec<msgs::CommitmentSigned>, fail_backwards: bool,
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.