Skip to content

Commit 323366c

Browse files
committed
Update docs on MonitorEvent::HolderForceClosed
In a96e2fe we renamed `MonitorEvent::CommitmentTxConfirmed` to `HolderForceClosed` to better document what actually happened. However, we failed to update the documentation on the type, which we do here. Pointed out by @yellowred.
1 parent 9de51f0 commit 323366c

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

lightning/src/chain/channelmonitor.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,8 @@ pub enum MonitorEvent {
132132
/// A monitor event containing an HTLCUpdate.
133133
HTLCEvent(HTLCUpdate),
134134

135-
/// A monitor event that the Channel's commitment transaction was confirmed.
135+
/// Indicates we broadcasted the channel's latest commitment transaction and thus closed the
136+
/// channel.
136137
HolderForceClosed(OutPoint),
137138

138139
/// Indicates a [`ChannelMonitor`] update has completed. See

0 commit comments

Comments
 (0)