Skip to content

Commit bf19607

Browse files
committed
f internal docs
1 parent 2c8e001 commit bf19607

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5126,7 +5126,9 @@ where
51265126
}
51275127
}
51285128

5129-
/// Gets the current [`channel_update`] for the given channel. This first checks if the channel is
5129+
/// Gets the current [`channel_update`] for the given channel (as well as our and our
5130+
/// counterparty's [`NodeId`], which is needed for the
5131+
/// [`MessageSendEvent::BroadcastChannelUpdate`]). This first checks if the channel is
51305132
/// public, and thus should be called whenever the result is going to be passed out in a
51315133
/// [`MessageSendEvent::BroadcastChannelUpdate`] event.
51325134
///
@@ -5160,10 +5162,11 @@ where
51605162
self.get_channel_update_for_unicast(chan)
51615163
}
51625164

5163-
/// Gets the current [`channel_update`] for the given channel. This does not check if the channel
5164-
/// is public (only returning an `Err` if the channel does not yet have an assigned SCID),
5165-
/// and thus MUST NOT be called unless the recipient of the resulting message has already
5166-
/// provided evidence that they know about the existence of the channel.
5165+
/// Gets the current [`channel_update`] for the given channel (as well as our and our
5166+
/// counterparty's [`NodeId`]). This does not check if the channel is public (only returning an
5167+
/// `Err` if the channel does not yet have an assigned SCID), and thus MUST NOT be called
5168+
/// unless the recipient of the resulting message has already provided evidence that they know
5169+
/// about the existence of the channel.
51675170
///
51685171
/// Note that through [`internal_closing_signed`], this function is called without the
51695172
/// `peer_state` corresponding to the channel's counterparty locked, as the channel been

0 commit comments

Comments
 (0)