From bad2efb73c4c458799e4d7792ff3ca4caa85f0ef Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Mon, 5 Feb 2024 23:47:36 +0000 Subject: [PATCH] Minor doc nits on the new coop close reason variants --- lightning/src/events/mod.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lightning/src/events/mod.rs b/lightning/src/events/mod.rs index 3bc70014f..d08d3c5ac 100644 --- a/lightning/src/events/mod.rs +++ b/lightning/src/events/mod.rs @@ -184,11 +184,16 @@ pub enum ClosureReason { HolderForceClosed, /// The channel was closed after negotiating a cooperative close and we've now broadcasted /// the cooperative close transaction. Note the shutdown may have been initiated by us. + /// + /// This was only set in versions of LDK prior to 0.0.122. // Can be removed once we disallow downgrading to 0.0.121 LegacyCooperativeClosure, /// The channel was closed after negotiating a cooperative close and we've now broadcasted /// the cooperative close transaction. This indicates that the shutdown was initiated by our /// counterparty. + /// + /// In rare cases where we initiated closure immediately prior to shutting down without + /// persisting, this value may be provided for channels we initiated closure for. CounterpartyInitiatedCooperativeClosure, /// The channel was closed after negotiating a cooperative close and we've now broadcasted /// the cooperative close transaction. This indicates that the shutdown was initiated by us. -- 2.39.5