Document when optional fields of ClosedChannelDetails can be None

Author: f3r10

src/closed_channel.rs

@@ -29,10 +29,16 @@ pub struct ClosedChannelDetails {
 	/// The node ID of the channel's counterparty.
 	pub counterparty_node_id: PublicKey,
 	/// The channel's funding transaction outpoint.
+	///
+	/// Will be `None` if the channel was closed before a funding transaction was established.
 	pub funding_txo: Option<OutPoint>,
 	/// The channel's capacity in satoshis.
+	///
+	/// Will be `None` if the channel was closed before the capacity was known.
 	pub channel_capacity_sats: Option<u64>,
 	/// Our local balance in millisatoshis at the time of channel closure.
+	///
+	/// Will be `None` if the local balance was not available at the time of closure.
 	pub last_local_balance_msat: Option<u64>,
 	/// Indicates whether we initiated the channel opening.
 	///
@@ -44,6 +50,9 @@ pub struct ClosedChannelDetails {
 	/// This will be `false` for channels opened prior to this field being tracked.
 	pub is_announced: bool,
 	/// The reason for the channel closure.
+	///
+	/// Will be `None` if the closure reason could not be decoded, e.g., if it was written by a
+	/// future version of LDK Node using a closure reason variant not yet known to this version.
 	pub closure_reason: Option<ClosureReason>,
 	/// The timestamp, in seconds since start of the UNIX epoch, when the channel was closed.
 	pub closed_at: u64,