Skip to content

Commit 2010abc

Browse files
Update ChannelManager docs
Updates multipe instances of the `ChannelManager` docs related to the previous change that moved the storage of the channels to the `per_peer_state`. This docs update corrects some grammar errors and incorrect information, as well as clarifies documentation that was confusing.
1 parent f535534 commit 2010abc

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

lightning/src/ln/channelmanager.rs

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -767,9 +767,8 @@ where
767767
/// very far in the past, and can only ever be up to two hours in the future.
768768
highest_seen_timestamp: AtomicUsize,
769769

770-
/// The bulk of our storage will eventually be here (message queues and the like). Currently
771-
/// the `per_peer_state` stores our channels on a per-peer basis, as well as the peer's latest
772-
/// features.
770+
/// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
771+
/// basis, as well as the peer's latest features.
773772
///
774773
/// If we are connected to a peer we always at least have an entry here, even if no channels
775774
/// are currently open with that peer.
@@ -1220,7 +1219,7 @@ macro_rules! handle_error {
12201219
#[cfg(any(feature = "_test_utils", test))]
12211220
{
12221221
if per_peer_state.get(&$counterparty_node_id).is_none() {
1223-
// This shouldn't occour in tests unless an unkown counterparty_node_id
1222+
// This shouldn't occur in tests unless an unknown counterparty_node_id
12241223
// has been passed to our message handling functions.
12251224
let expected_error_str = format!("Can't find a peer matching the passed counterparty node_id {}", $counterparty_node_id);
12261225
match err.action {
@@ -2255,7 +2254,8 @@ where
22552254
/// public, and thus should be called whenever the result is going to be passed out in a
22562255
/// [`MessageSendEvent::BroadcastChannelUpdate`] event.
22572256
///
2258-
/// May be called with peer_state already locked!
2257+
/// Note that this function may be called without the `peer_state` corresponding to the passed
2258+
/// channel's counterparty acquired, when the call site has full ownership of the channel.
22592259
fn get_channel_update_for_broadcast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
22602260
if !chan.should_announce() {
22612261
return Err(LightningError {
@@ -2274,7 +2274,8 @@ where
22742274
/// is public (only returning an Err if the channel does not yet have an assigned short_id),
22752275
/// and thus MUST NOT be called unless the recipient of the resulting message has already
22762276
/// provided evidence that they know about the existence of the channel.
2277-
/// May be called with peer_state already locked!
2277+
/// Note that this function may be called without the `peer_state` corresponding to the passed
2278+
/// channel's counterparty acquired, when the call site has full ownership of the channel.
22782279
fn get_channel_update_for_unicast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
22792280
log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
22802281
let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
@@ -3628,7 +3629,7 @@ where
36283629
fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
36293630
#[cfg(any(feature = "_test_utils", test))]
36303631
{
3631-
// Ensure that no peer state channel storage lock is not held when calling this
3632+
// Ensure that the peer state channel storage lock is not held when calling this
36323633
// function.
36333634
// This ensures that future code doesn't introduce a lock_order requirement for
36343635
// `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
@@ -5539,7 +5540,8 @@ where
55395540
/// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
55405541
/// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
55415542
/// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
5542-
/// will randomly be placed first or last in the returned array.
5543+
/// will randomly be placed first or last in the returned array. Note that order will not be
5544+
/// randomized with the `no-std` feature enabled.
55435545
///
55445546
/// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
55455547
/// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among

0 commit comments

Comments
 (0)