Skip to content

Commit a2f0154

Browse files
committed
f - Expand ChainMonitor::block_connected docs
1 parent 6c09eb7 commit a2f0154

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

lightning/src/ln/channelmonitor.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -242,8 +242,10 @@ impl<ChanSigner: ChannelKeys, T: Deref, F: Deref, L: Deref> ChainMonitor<Key, Ch
242242
F::Target: FeeEstimator,
243243
L::Target: Logger,
244244
{
245-
/// Delegates to [`ChannelMonitor::block_connected`] for each watched channel. Any HTLCs that
246-
/// were resolved on chain will be retuned by [`chain::Watch::release_pending_htlc_updates`].
245+
/// Dispatches to per-channel monitors, which are responsible for updating their on-chain view
246+
/// of a channel and reacting accordingly based on transactions in the connected block. See
247+
/// [`ChannelMonitor::block_connected`] for details. Any HTLCs that were resolved on chain will
248+
/// be retuned by [`chain::Watch::release_pending_htlc_updates`].
247249
///
248250
/// [`ChannelMonitor::block_connected`]: struct.ChannelMonitor.html#method.block_connected
249251
/// [`chain::Watch::release_pending_htlc_updates`]: ../../chain/trait.Watch.html#tymethod.release_pending_htlc_updates
@@ -264,7 +266,9 @@ impl<ChanSigner: ChannelKeys, T: Deref, F: Deref, L: Deref> ChainMonitor<Key, Ch
264266
}
265267
}
266268

267-
/// Delegates to [`ChannelMonitor::block_disconnected`] for each watched channel.
269+
/// Dispatches to per-channel monitors, which are responsible for updating their on-chain view
270+
/// of a channel based on the disconnected block. See [`ChannelMonitor::block_disconnected`] for
271+
/// details.
268272
///
269273
/// [`ChannelMonitor::block_disconnected`]: struct.ChannelMonitor.html#method.block_disconnected
270274
pub fn block_disconnected(&self, header: &BlockHeader, disconnected_height: u32) {

0 commit comments

Comments
 (0)