@@ -767,9 +767,8 @@ where
767
767
/// very far in the past, and can only ever be up to two hours in the future.
768
768
highest_seen_timestamp : AtomicUsize ,
769
769
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.
773
772
///
774
773
/// If we are connected to a peer we always at least have an entry here, even if no channels
775
774
/// are currently open with that peer.
@@ -1250,7 +1249,7 @@ macro_rules! handle_error {
1250
1249
#[ cfg( any( feature = "_test_utils" , test) ) ]
1251
1250
{
1252
1251
if per_peer_state. get( & $counterparty_node_id) . is_none( ) {
1253
- // This shouldn't occour in tests unless an unkown counterparty_node_id
1252
+ // This shouldn't occur in tests unless an unknown counterparty_node_id
1254
1253
// has been passed to our message handling functions.
1255
1254
let expected_error_str = format!( "Can't find a peer matching the passed counterparty node_id {}" , $counterparty_node_id) ;
1256
1255
match err. action {
@@ -2313,7 +2312,8 @@ where
2313
2312
/// public, and thus should be called whenever the result is going to be passed out in a
2314
2313
/// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2315
2314
///
2316
- /// May be called with peer_state already locked!
2315
+ /// Note that this function may be called without the `peer_state` corresponding to the passed
2316
+ /// channel's counterparty acquired, when the call site has full ownership of the channel.
2317
2317
fn get_channel_update_for_broadcast ( & self , chan : & Channel < <SP :: Target as SignerProvider >:: Signer > ) -> Result < msgs:: ChannelUpdate , LightningError > {
2318
2318
if !chan. should_announce ( ) {
2319
2319
return Err ( LightningError {
@@ -2332,7 +2332,8 @@ where
2332
2332
/// is public (only returning an Err if the channel does not yet have an assigned short_id),
2333
2333
/// and thus MUST NOT be called unless the recipient of the resulting message has already
2334
2334
/// provided evidence that they know about the existence of the channel.
2335
- /// May be called with peer_state already locked!
2335
+ /// Note that this function may be called without the `peer_state` corresponding to the passed
2336
+ /// channel's counterparty acquired, when the call site has full ownership of the channel.
2336
2337
fn get_channel_update_for_unicast ( & self , chan : & Channel < <SP :: Target as SignerProvider >:: Signer > ) -> Result < msgs:: ChannelUpdate , LightningError > {
2337
2338
log_trace ! ( self . logger, "Attempting to generate channel update for channel {}" , log_bytes!( chan. channel_id( ) ) ) ;
2338
2339
let short_channel_id = match chan. get_short_channel_id ( ) . or ( chan. latest_inbound_scid_alias ( ) ) {
@@ -3712,7 +3713,7 @@ where
3712
3713
fn fail_htlc_backwards_internal ( & self , source : & HTLCSource , payment_hash : & PaymentHash , onion_error : & HTLCFailReason , destination : HTLCDestination ) {
3713
3714
#[ cfg( any( feature = "_test_utils" , test) ) ]
3714
3715
{
3715
- // Ensure that no peer state channel storage lock is not held when calling this
3716
+ // Ensure that the peer state channel storage lock is not held when calling this
3716
3717
// function.
3717
3718
// This ensures that future code doesn't introduce a lock_order requirement for
3718
3719
// `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
@@ -5629,7 +5630,8 @@ where
5629
5630
/// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
5630
5631
/// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
5631
5632
/// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
5632
- /// will randomly be placed first or last in the returned array.
5633
+ /// will randomly be placed first or last in the returned array. Note that order will not be
5634
+ /// randomized with the `no-std` feature enabled.
5633
5635
///
5634
5636
/// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
5635
5637
/// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
0 commit comments