Skip to content

Commit 134f2cb

Browse files
committed
Some minor comment/doc tweaks in new monitor update blocking code
A few nits that came up in review to make the docs clearer, but not anything super critical.
1 parent 32eb894 commit 134f2cb

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

lightning/src/ln/channel.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -433,6 +433,10 @@ pub(super) struct ReestablishResponses {
433433
}
434434

435435
/// The return type of `force_shutdown`
436+
///
437+
/// Contains a (counterparty_node_id, funding_txo, [`ChannelMonitorUpdate`]) tuple
438+
/// followed by a list of HTLCs to fail back in the form of the (source, payment hash, and this
439+
/// channel's counterparty_node_id and channel_id).
436440
pub(crate) type ShutdownResult = (
437441
Option<(PublicKey, OutPoint, ChannelMonitorUpdate)>,
438442
Vec<(HTLCSource, PaymentHash, PublicKey, [u8; 32])>

lightning/src/ln/channelmanager.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5448,7 +5448,7 @@ where
54485448
}
54495449

54505450
/// Checks whether [`ChannelMonitorUpdate`]s generated by the receipt of a remote
5451-
/// [`msgs::RevokeAndACK`] should be held for the given channel until some other event
5451+
/// [`msgs::RevokeAndACK`] should be held for the given channel until some other action
54525452
/// completes. Note that this needs to happen in the same [`PeerState`] mutex as any release of
54535453
/// the [`ChannelMonitorUpdate`] in question.
54545454
fn raa_monitor_updates_held(&self,
@@ -6132,7 +6132,7 @@ where
61326132
/// When something which was blocking a channel from updating its [`ChannelMonitor`] (e.g. an
61336133
/// [`Event`] being handled) completes, this should be called to restore the channel to normal
61346134
/// operation. It will double-check that nothing *else* is also blocking the same channel from
6135-
/// making progress and then any blocked [`ChannelMonitorUpdate`]s fly.
6135+
/// making progress and then let any blocked [`ChannelMonitorUpdate`]s fly.
61366136
fn handle_monitor_update_release(&self, counterparty_node_id: PublicKey, channel_funding_outpoint: OutPoint, mut completed_blocker: Option<RAAMonitorUpdateBlockingAction>) {
61376137
let mut errors = Vec::new();
61386138
loop {

0 commit comments

Comments
 (0)