Skip to content

Commit bad2efb

Browse files
committed
Minor doc nits on the new coop close reason variants
1 parent 8d9d099 commit bad2efb

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

lightning/src/events/mod.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,11 +184,16 @@ pub enum ClosureReason {
184184
HolderForceClosed,
185185
/// The channel was closed after negotiating a cooperative close and we've now broadcasted
186186
/// the cooperative close transaction. Note the shutdown may have been initiated by us.
187+
///
188+
/// This was only set in versions of LDK prior to 0.0.122.
187189
// Can be removed once we disallow downgrading to 0.0.121
188190
LegacyCooperativeClosure,
189191
/// The channel was closed after negotiating a cooperative close and we've now broadcasted
190192
/// the cooperative close transaction. This indicates that the shutdown was initiated by our
191193
/// counterparty.
194+
///
195+
/// In rare cases where we initiated closure immediately prior to shutting down without
196+
/// persisting, this value may be provided for channels we initiated closure for.
192197
CounterpartyInitiatedCooperativeClosure,
193198
/// The channel was closed after negotiating a cooperative close and we've now broadcasted
194199
/// the cooperative close transaction. This indicates that the shutdown was initiated by us.

0 commit comments

Comments
 (0)