Skip to content

Commit

Permalink
f describe param
Browse files Browse the repository at this point in the history
  • Loading branch information
TheBlueMatt committed Jul 28, 2023
1 parent 048f0e1 commit 097fc94
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions lightning/src/ln/functional_test_utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1682,6 +1682,11 @@ macro_rules! commitment_signed_dance {
/// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
/// `revoke_and_ack` response to it.
///
/// An HTLC claim on one channel blocks the RAA channel monitor update for the outbound edge
/// channel until the inbound edge channel preimage monitor update completes. Thus, when checking
/// for channel monitor updates, we need to know if an `update_fulfill_htlc` was included in the
/// the commitment we're exchanging. `includes_claim` provides that information.
///
/// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool, includes_claim: bool) -> Option<MessageSendEvent> {
let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
Expand Down

0 comments on commit 097fc94

Please sign in to comment.