f Add further clarification on spendable balances

Author: tnull

src/balance.rs

@@ -18,7 +18,16 @@ pub struct BalanceDetails {
 	/// [`MaybeTimeoutClaimableHTLC`]: LightningBalance::MaybeTimeoutClaimableHTLC
 	/// [`lightning_balances`]: Self::lightning_balances
 	pub total_lightning_balance_sats: u64,
-	/// A detailed list of all known Lightning balances.
+	/// A detailed list of all known Lightning balances that would be claimable on channel closure.
+	///
+	/// Note that less than the listed amounts are spendable over lightning as further reserve
+	/// restrictions apply. Please refer to [`ChannelDetails::outbound_capacity_msat`] and
+	/// [`ChannelDetails::next_outbound_htlc_limit_msat`] as returned by [`Node::list_channels`]
+	/// for a better approximation of the spendable amounts.
+	///
+	/// [`ChannelDetails::outbound_capacity_msat`]: crate::ChannelDetails::outbound_capacity_msat
+	/// [`ChannelDetails::next_outbound_htlc_limit_msat`]: crate::ChannelDetails::next_outbound_htlc_limit_msat
+	/// [`Node::list_channels`]: crate::Node::list_channels
 	pub lightning_balances: Vec<LightningBalance>,
 }