f add ClosureReason::CounterpartyCoopClosedPrefundedChannel

Author: dunxen

lightning/src/events/mod.rs

@@ -113,7 +113,7 @@ impl_writeable_tlv_based_enum_upgradable!(PathFailure,
 );
 
 #[derive(Clone, Debug, PartialEq, Eq)]
-/// The reason the channel was closed. See individual variants more details.
+/// The reason the channel was closed. See individual variants for more details.
 pub enum ClosureReason {
 	/// Closure generated from receiving a peer error message.
 	///
@@ -164,7 +164,10 @@ pub enum ClosureReason {
 	///
 	/// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
 	/// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
-	OutdatedChannelManager
+	OutdatedChannelManager,
+	/// The counterparty requested a cooperative close of a channel that had not established
+	/// a funding transaction yet. The channel has been immediately closed.
+	CounterpartyCoopClosedPrefundedChannel,
 }
 
 impl core::fmt::Display for ClosureReason {
@@ -184,6 +187,7 @@ impl core::fmt::Display for ClosureReason {
 			},
 			ClosureReason::DisconnectedPeer => f.write_str("the peer disconnected prior to the channel being funded"),
 			ClosureReason::OutdatedChannelManager => f.write_str("the ChannelManager read from disk was stale compared to ChannelMonitor(s)"),
+			ClosureReason::CounterpartyCoopClosedPrefundedChannel => f.write_str("the peer requested the prefunded channel be closed"),
 		}
 	}
 }
@@ -197,6 +201,7 @@ impl_writeable_tlv_based_enum_upgradable!(ClosureReason,
 	(8, ProcessingError) => { (1, err, required) },
 	(10, DisconnectedPeer) => {},
 	(12, OutdatedChannelManager) => {},
+	(13, CounterpartyCoopClosedPrefundedChannel) => {},
 );
 
 /// Intended destination of a failed HTLC as indicated in [`Event::HTLCHandlingFailed`].

lightning/src/ln/channelmanager.rs

@@ -5518,15 +5518,17 @@ where
 				})?;
 			let mut peer_state_lock = peer_state_mutex.lock().unwrap();
 			let peer_state = &mut *peer_state_lock;
+			// TODO(dunxen): Fix this duplication when we switch to a single map with enums as per
+			// https://github.com/lightningdevkit/rust-lightning/issues/2422
 			if let hash_map::Entry::Occupied(chan_entry) = peer_state.outbound_v1_channel_by_id.entry(msg.channel_id.clone()) {
-				log_error!(self.logger, "Force-closing channel {}", log_bytes!(&msg.channel_id[..]));
-				self.issue_channel_close_events(&chan_entry.get().context, ClosureReason::HolderForceClosed);
+				log_error!(self.logger, "Immediately closing prefunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", log_bytes!(&msg.channel_id[..]));
+				self.issue_channel_close_events(&chan_entry.get().context, ClosureReason::CounterpartyCoopClosedPrefundedChannel);
 				let mut chan = remove_channel!(self, chan_entry);
 				self.finish_force_close_channel(chan.context.force_shutdown(false));
 				return Ok(());
 			} else if let hash_map::Entry::Occupied(chan_entry) = peer_state.inbound_v1_channel_by_id.entry(msg.channel_id.clone()) {
-				log_error!(self.logger, "Force-closing channel {}", log_bytes!(&msg.channel_id[..]));
-				self.issue_channel_close_events(&chan_entry.get().context, ClosureReason::HolderForceClosed);
+				log_error!(self.logger, "Immediately closing prefunded channel {} as peer asked to cooperatively shut it down (which is unnecessary)", log_bytes!(&msg.channel_id[..]));
+				self.issue_channel_close_events(&chan_entry.get().context, ClosureReason::CounterpartyCoopClosedPrefundedChannel);
 				let mut chan = remove_channel!(self, chan_entry);
 				self.finish_force_close_channel(chan.context.force_shutdown(false));
 				return Ok(());