Skip to content

Commit c1a6a3c

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 c3c1050 commit c1a6a3c

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
@@ -524,6 +524,10 @@ pub(super) struct ReestablishResponses {
524524
}
525525

526526
/// The return type of `force_shutdown`
527+
///
528+
/// Contains a (counterparty_node_id, funding_txo, [`ChannelMonitorUpdate`]) tuple
529+
/// followed by a list of HTLCs to fail back in the form of the (source, payment hash, and this
530+
/// channel's counterparty_node_id and channel_id).
527531
pub(crate) type ShutdownResult = (
528532
Option<(PublicKey, OutPoint, ChannelMonitorUpdate)>,
529533
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
@@ -5582,7 +5582,7 @@ where
55825582
}
55835583

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

0 commit comments

Comments
 (0)