Expose HTLCStats in ChannelDetails

Author: wvanlint

fuzz/src/router.rs

@@ -270,6 +270,8 @@ pub fn do_test<Out: test_logger::Output>(data: &[u8], out: Out) {
 								inbound_htlc_maximum_msat: None,
 								config: None,
 								feerate_sat_per_1000_weight: None,
+								incoming_htlc_stats: None,
+								outgoing_htlc_stats: None,
 							});
 						}
 						Some(&first_hops_vec[..])

lightning/src/ln/channel.rs

@@ -348,15 +348,34 @@ enum HTLCInitiator {
 }
 
 /// An enum gathering stats on pending HTLCs, either inbound or outbound side.
-struct HTLCStats {
-	pending_htlcs: u32,
-	pending_htlcs_value_msat: u64,
-	on_counterparty_tx_dust_exposure_msat: u64,
-	on_holder_tx_dust_exposure_msat: u64,
-	holding_cell_msat: u64,
-	on_holder_tx_holding_cell_htlcs_count: u32, // dust HTLCs *non*-included
+#[derive(Debug, Clone, Copy, PartialEq)]
+pub struct HTLCStats {
+	/// The number of pending HTLC's.
+	pub pending_htlcs: u32,
+	/// The total value of pending HTLC's.
+	pub pending_htlcs_value_msat: u64,
+	/// The total dust exposure for the counterparty.
+	pub on_counterparty_tx_dust_exposure_msat: u64,
+	/// The total dust exposure for the local node.
+	pub on_holder_tx_dust_exposure_msat: u64,
+	/// The total value of pending, outgoing HTLC's being added that are awaiting remote revocation.
+	/// See `ChannelState::AwaitingRemoteRevoke`.
+	pub holding_cell_msat: u64,
+	/// The number of pending, outgoing HTLC's being added that are awaiting remote revocation,
+	/// dust HTLCS not included.
+	/// See `ChannelState::AwaitingRemoteRevoke`.
+	pub on_holder_tx_holding_cell_htlcs_count: u32,
 }
 
+impl_writeable_tlv_based!(HTLCStats, {
+	(0, pending_htlcs, required),
+	(1, pending_htlcs_value_msat, required),
+	(2, on_counterparty_tx_dust_exposure_msat, required),
+	(3, on_holder_tx_dust_exposure_msat, required),
+	(4, holding_cell_msat, required),
+	(5, on_holder_tx_holding_cell_htlcs_count, required),
+});
+
 /// An enum gathering stats on commitment transaction, either local or remote.
 struct CommitmentStats<'a> {
 	tx: CommitmentTransaction, // the transaction info
@@ -2621,7 +2640,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 	}
 
 	/// Returns a HTLCStats about inbound pending htlcs
-	fn get_inbound_pending_htlc_stats(&self, outbound_feerate_update: Option<u32>) -> HTLCStats {
+	pub(super) fn get_inbound_pending_htlc_stats(&self, outbound_feerate_update: Option<u32>) -> HTLCStats {
 		let mut stats = HTLCStats {
 			pending_htlcs: self.pending_inbound_htlcs.len() as u32,
 			pending_htlcs_value_msat: 0,
@@ -2653,7 +2672,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
 	}
 
 	/// Returns a HTLCStats about pending outbound htlcs, *including* pending adds in our holding cell.
-	fn get_outbound_pending_htlc_stats(&self, outbound_feerate_update: Option<u32>) -> HTLCStats {
+	pub(super) fn get_outbound_pending_htlc_stats(&self, outbound_feerate_update: Option<u32>) -> HTLCStats {
 		let mut stats = HTLCStats {
 			pending_htlcs: self.pending_outbound_htlcs.len() as u32,
 			pending_htlcs_value_msat: 0,

lightning/src/ln/channelmanager.rs

@@ -40,7 +40,7 @@ use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, Messa
 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
 // construct one themselves.
 use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
-use crate::ln::channel::{Channel, ChannelError, ChannelUpdateStatus, ShutdownResult, UpdateFulfillCommitFetch};
+use crate::ln::channel::{Channel, ChannelError, ChannelUpdateStatus, HTLCStats, ShutdownResult, UpdateFulfillCommitFetch};
 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
 #[cfg(any(feature = "_test_utils", test))]
 use crate::ln::features::InvoiceFeatures;
@@ -1441,6 +1441,14 @@ pub struct ChannelDetails {
 	///
 	/// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
 	pub config: Option<ChannelConfig>,
+	/// Statistics on pending incoming HTLCs.
+	///
+	/// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.116.
+	pub incoming_htlc_stats: Option<HTLCStats>,
+	/// Statistics on pending outgoing HTLCs.
+	///
+	/// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.116.
+	pub outgoing_htlc_stats: Option<HTLCStats>,
 }
 
 impl ChannelDetails {
@@ -1512,6 +1520,8 @@ impl ChannelDetails {
 			inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
 			inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
 			config: Some(channel.config()),
+			incoming_htlc_stats: Some(channel.get_inbound_pending_htlc_stats(None)),
+			outgoing_htlc_stats: Some(channel.get_outbound_pending_htlc_stats(None)),
 		}
 	}
 }
@@ -7190,6 +7200,8 @@ impl Writeable for ChannelDetails {
 			(35, self.inbound_htlc_maximum_msat, option),
 			(37, user_channel_id_high_opt, option),
 			(39, self.feerate_sat_per_1000_weight, option),
+			(40, self.incoming_htlc_stats, option),
+			(41, self.outgoing_htlc_stats, option),
 		});
 		Ok(())
 	}
@@ -7227,6 +7239,8 @@ impl Readable for ChannelDetails {
 			(35, inbound_htlc_maximum_msat, option),
 			(37, user_channel_id_high_opt, option),
 			(39, feerate_sat_per_1000_weight, option),
+			(40, incoming_htlc_stats, option),
+			(41, outgoing_htlc_stats, option),
 		});
 
 		// `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
@@ -7262,6 +7276,8 @@ impl Readable for ChannelDetails {
 			inbound_htlc_minimum_msat,
 			inbound_htlc_maximum_msat,
 			feerate_sat_per_1000_weight,
+			incoming_htlc_stats,
+			outgoing_htlc_stats,
 		})
 	}
 }

lightning/src/routing/router.rs

@@ -2503,7 +2503,9 @@ mod tests {
 			inbound_htlc_minimum_msat: None,
 			inbound_htlc_maximum_msat: None,
 			config: None,
-			feerate_sat_per_1000_weight: None
+			feerate_sat_per_1000_weight: None,
+			incoming_htlc_stats: None,
+			outgoing_htlc_stats: None,
 		}
 	}
 
@@ -6290,6 +6292,8 @@ pub(crate) mod bench_utils {
 			inbound_htlc_maximum_msat: None,
 			config: None,
 			feerate_sat_per_1000_weight: None,
+			incoming_htlc_stats: None,
+			outgoing_htlc_stats: None,
 		}
 	}