f Add note pertaining Maybe.. balances

Author: tnull

src/balance.rs

@@ -8,6 +8,15 @@ use lightning::ln::{ChannelId, PaymentHash, PaymentPreimage};
 #[derive(Debug, Clone)]
 pub struct BalanceDetails {
 	/// The total balance that we would be able to claim across all our Lightning channels.
+	///
+	/// Note this excludes balances that we are unsure if we are able to claim (e.g., as we are
+	/// waiting for a preimage or for a timeout to expire). These balances will however be included
+	/// as [`MaybePreimageClaimableHTLC`] and
+	/// [`MaybeTimeoutClaimableHTLC`] in [`lightning_balances`].
+	///
+	/// [`MaybePreimageClaimableHTLC`]: LightningBalance::MaybePreimageClaimableHTLC
+	/// [`MaybeTimeoutClaimableHTLC`]: LightningBalance::MaybeTimeoutClaimableHTLC
+	/// [`lightning_balances`]: Self::lightning_balances
 	pub total_lightning_balance_sats: u64,
 	/// A detailed list of all known Lightning balances.
 	pub lightning_balances: Vec<LightningBalance>,