From 323366cfd369975159cdccf67dd2beb1014f37ba Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Tue, 17 Oct 2023 16:23:20 +0000 Subject: [PATCH] Update docs on `MonitorEvent::HolderForceClosed` In a96e2fe144383ea6fd670153fb895ee07a3245ef 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. --- lightning/src/chain/channelmonitor.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lightning/src/chain/channelmonitor.rs b/lightning/src/chain/channelmonitor.rs index bd0c1548428..b959ff841d2 100644 --- a/lightning/src/chain/channelmonitor.rs +++ b/lightning/src/chain/channelmonitor.rs @@ -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