Skip to content

Commit 63217bc

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 0f2c4c0 commit 63217bc

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
@@ -527,6 +527,10 @@ pub(super) struct ReestablishResponses {
527527
}
528528

529529
/// The return type of `force_shutdown`
530+
///
531+
/// Contains a (counterparty_node_id, funding_txo, [`ChannelMonitorUpdate`]) tuple
532+
/// followed by a list of HTLCs to fail back in the form of the (source, payment hash, and this
533+
/// channel's counterparty_node_id and channel_id).
530534
pub(crate) type ShutdownResult = (
531535
Option<(PublicKey, OutPoint, ChannelMonitorUpdate)>,
532536
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
@@ -5695,7 +5695,7 @@ where
56955695
}
56965696

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

0 commit comments

Comments
 (0)