Skip to content

Commit

Permalink
Update docs on MonitorEvent::HolderForceClosed
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
TheBlueMatt committed Oct 20, 2023
1 parent 9de51f0 commit 323366c
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion lightning/src/chain/channelmonitor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,8 @@ pub enum MonitorEvent {
/// A monitor event containing an HTLCUpdate.
HTLCEvent(HTLCUpdate),

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

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

0 comments on commit 323366c

Please sign in to comment.