Expose HTLCStats in ChannelDetails#2349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wvanlint wants to merge 1 commit into from
Closed

Expose HTLCStats in ChannelDetails #2349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions fuzz/src/router.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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[..])
Expand Down
16 changes: 3 additions & 13 deletions lightning/src/ln/channel.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ use crate::ln::features::{ChannelTypeFeatures, InitFeatures};
use crate::ln::msgs;
use crate::ln::msgs::DecodeError;
use crate::ln::script::{self, ShutdownScript};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, HTLCStats, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, htlc_success_tx_weight, htlc_timeout_tx_weight, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor, ClosingTransaction};
use crate::ln::chan_utils;
use crate::ln::onion_utils::HTLCFailReason;
Expand DownExpand Up@@ -347,16 +347,6 @@ enum HTLCInitiator {
RemoteOffered,
}

/// 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
}

/// An enum gathering stats on commitment transaction, either local or remote.
struct CommitmentStats<'a> {
tx: CommitmentTransaction, // the transaction info
Expand DownExpand Up@@ -2621,7 +2611,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,
Expand DownExpand Up@@ -2653,7 +2643,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,
Expand Down
49 changes: 49 additions & 0 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1272,6 +1272,39 @@ pub struct ChannelCounterparty {
pub outbound_htlc_maximum_msat: Option<u64>,
}

/// An enum gathering stats on pending HTLCs, either inbound or outbound side.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct HTLCStats {
/// The number of pending HTLCs.
pub pending_htlcs: u32,
/// The total value of pending HTLCs.
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 HTLCs being held.
///
/// These HTLCs are being held temporarily after sending commitment_signed to discern them
/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
pub holding_cell_msat: u64,
/// The number of pending, outgoing HTLCs being added that are being held,
/// dust HTLCS not included.
///
/// These HTLCs are being held temporarily after sending commitment_signed to discern them
/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
pub on_holder_tx_holding_cell_htlcs_count: u32,
}

impl_writeable_tlv_based!(HTLCStats, {
(0, pending_htlcs, required),
(2, pending_htlcs_value_msat, required),
(4, on_counterparty_tx_dust_exposure_msat, required),
(6, on_holder_tx_dust_exposure_msat, required),
(8, holding_cell_msat, required),
(10, on_holder_tx_holding_cell_htlcs_count, required),
});

/// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
#[derive(Clone, Debug, PartialEq)]
pub struct ChannelDetails {
Expand DownExpand Up@@ -1443,6 +1476,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>,

@tnulltnullJun 12, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the channel module is not public, HTLCStats is currently not exposed. We need to expose the object itself if it is now exposed through ChannelDetails.

@wvanlintwvanlintJun 12, 2023

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved HTLCStats to the channelmanager module for that purpose.

/// 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 {
Expand DownExpand Up@@ -1514,6 +1555,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)),
}
}
}
Expand DownExpand Up@@ -7156,6 +7199,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),
(41, self.incoming_htlc_stats, option),
(43, self.outgoing_htlc_stats, option),
Comment thread
tnull marked this conversation as resolved.
});
Ok(())
}
Expand DownExpand Up@@ -7193,6 +7238,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
Expand DownExpand Up@@ -7228,6 +7275,8 @@ impl Readable for ChannelDetails {
inbound_htlc_minimum_msat,
inbound_htlc_maximum_msat,
feerate_sat_per_1000_weight,
incoming_htlc_stats,
outgoing_htlc_stats,
})
}
}
Expand Down
6 changes: 5 additions & 1 deletion lightning/src/routing/router.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2512,7 +2512,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,
}
}

Expand DownExpand Up@@ -6299,6 +6301,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,
}
}

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Expose HTLCStats in ChannelDetails#2349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wvanlint
wants to merge
1
commit into

from

 Closed


Expose HTLCStats in ChannelDetails
#2349
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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[..])
Expand Down

16 changes: 3 additions & 13 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ use crate::ln::features::{ChannelTypeFeatures, InitFeatures};
use crate::ln::msgs;
use crate::ln::msgs::DecodeError;
use crate::ln::script::{self, ShutdownScript};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, HTLCStats, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, htlc_success_tx_weight, htlc_timeout_tx_weight, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor, ClosingTransaction};
use crate::ln::chan_utils;
use crate::ln::onion_utils::HTLCFailReason;
Expand DownExpand Up@@ -347,16 +347,6 @@ enum HTLCInitiator {
	RemoteOffered,
}

/// 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
}

/// An enum gathering stats on commitment transaction, either local or remote.
struct CommitmentStats<'a> {
	tx: CommitmentTransaction, // the transaction info
Expand DownExpand Up@@ -2621,7 +2611,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,
Expand DownExpand Up@@ -2653,7 +2643,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,
Expand Down

49 changes: 49 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1272,6 +1272,39 @@ pub struct ChannelCounterparty {
	pub outbound_htlc_maximum_msat: Option<u64>,
}

/// An enum gathering stats on pending HTLCs, either inbound or outbound side.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct HTLCStats {
	/// The number of pending HTLCs.
	pub pending_htlcs: u32,
	/// The total value of pending HTLCs.
	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 HTLCs being held.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub holding_cell_msat: u64,
	/// The number of pending, outgoing HTLCs being added that are being held,
	/// dust HTLCS not included.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub on_holder_tx_holding_cell_htlcs_count: u32,
}

impl_writeable_tlv_based!(HTLCStats, {
	(0, pending_htlcs, required),
	(2, pending_htlcs_value_msat, required),
	(4, on_counterparty_tx_dust_exposure_msat, required),
	(6, on_holder_tx_dust_exposure_msat, required),
	(8, holding_cell_msat, required),
	(10, on_holder_tx_holding_cell_htlcs_count, required),
});

/// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
#[derive(Clone, Debug, PartialEq)]
pub struct ChannelDetails {
Expand DownExpand Up@@ -1443,6 +1476,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>,
@tnulltnullJun 12, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the channel module is not public, HTLCStats is currently not exposed. We need to expose the object itself if it is now exposed through ChannelDetails.
@wvanlintwvanlintJun 12, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved HTLCStats to the channelmanager module for that purpose.
	/// 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 {
Expand DownExpand Up@@ -1514,6 +1555,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)),
 }
	}
}
Expand DownExpand Up@@ -7156,6 +7199,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),
 (41, self.incoming_htlc_stats, option),
 (43, self.outgoing_htlc_stats, option),
Comment thread
tnull marked this conversation as resolved.

 });
 Ok(())
	}
Expand DownExpand Up@@ -7193,6 +7238,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
Expand DownExpand Up@@ -7228,6 +7275,8 @@ impl Readable for ChannelDetails {
 inbound_htlc_minimum_msat,
 inbound_htlc_maximum_msat,
 feerate_sat_per_1000_weight,
 incoming_htlc_stats,
 outgoing_htlc_stats,
 })
	}
}
Expand Down

6 changes: 5 additions & 1 deletion
lightning/src/routing/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2512,7 +2512,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,
 }
	}

Expand DownExpand Up@@ -6299,6 +6301,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,
 }
	}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Expose HTLCStats in ChannelDetails#2349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wvanlint
wants to merge
1
commit into

from

 Closed


Expose HTLCStats in ChannelDetails
#2349
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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[..])
Expand Down

16 changes: 3 additions & 13 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ use crate::ln::features::{ChannelTypeFeatures, InitFeatures};
use crate::ln::msgs;
use crate::ln::msgs::DecodeError;
use crate::ln::script::{self, ShutdownScript};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, HTLCStats, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, htlc_success_tx_weight, htlc_timeout_tx_weight, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor, ClosingTransaction};
use crate::ln::chan_utils;
use crate::ln::onion_utils::HTLCFailReason;
Expand DownExpand Up@@ -347,16 +347,6 @@ enum HTLCInitiator {
	RemoteOffered,
}

/// 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
}

/// An enum gathering stats on commitment transaction, either local or remote.
struct CommitmentStats<'a> {
	tx: CommitmentTransaction, // the transaction info
Expand DownExpand Up@@ -2621,7 +2611,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,
Expand DownExpand Up@@ -2653,7 +2643,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,
Expand Down

49 changes: 49 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1272,6 +1272,39 @@ pub struct ChannelCounterparty {
	pub outbound_htlc_maximum_msat: Option<u64>,
}

/// An enum gathering stats on pending HTLCs, either inbound or outbound side.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct HTLCStats {
	/// The number of pending HTLCs.
	pub pending_htlcs: u32,
	/// The total value of pending HTLCs.
	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 HTLCs being held.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub holding_cell_msat: u64,
	/// The number of pending, outgoing HTLCs being added that are being held,
	/// dust HTLCS not included.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub on_holder_tx_holding_cell_htlcs_count: u32,
}

impl_writeable_tlv_based!(HTLCStats, {
	(0, pending_htlcs, required),
	(2, pending_htlcs_value_msat, required),
	(4, on_counterparty_tx_dust_exposure_msat, required),
	(6, on_holder_tx_dust_exposure_msat, required),
	(8, holding_cell_msat, required),
	(10, on_holder_tx_holding_cell_htlcs_count, required),
});

/// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
#[derive(Clone, Debug, PartialEq)]
pub struct ChannelDetails {
Expand DownExpand Up@@ -1443,6 +1476,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>,
@tnulltnullJun 12, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the channel module is not public, HTLCStats is currently not exposed. We need to expose the object itself if it is now exposed through ChannelDetails.
@wvanlintwvanlintJun 12, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved HTLCStats to the channelmanager module for that purpose.
	/// 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 {
Expand DownExpand Up@@ -1514,6 +1555,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)),
 }
	}
}
Expand DownExpand Up@@ -7156,6 +7199,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),
 (41, self.incoming_htlc_stats, option),
 (43, self.outgoing_htlc_stats, option),
Comment thread
tnull marked this conversation as resolved.

 });
 Ok(())
	}
Expand DownExpand Up@@ -7193,6 +7238,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
Expand DownExpand Up@@ -7228,6 +7275,8 @@ impl Readable for ChannelDetails {
 inbound_htlc_minimum_msat,
 inbound_htlc_maximum_msat,
 feerate_sat_per_1000_weight,
 incoming_htlc_stats,
 outgoing_htlc_stats,
 })
	}
}
Expand Down

6 changes: 5 additions & 1 deletion
lightning/src/routing/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2512,7 +2512,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,
 }
	}

Expand DownExpand Up@@ -6299,6 +6301,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,
 }
	}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Expose HTLCStats in ChannelDetails#2349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wvanlint
wants to merge
1
commit into

from

 Closed


Expose HTLCStats in ChannelDetails
#2349
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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[..])
Expand Down

16 changes: 3 additions & 13 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ use crate::ln::features::{ChannelTypeFeatures, InitFeatures};
use crate::ln::msgs;
use crate::ln::msgs::DecodeError;
use crate::ln::script::{self, ShutdownScript};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, HTLCStats, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, htlc_success_tx_weight, htlc_timeout_tx_weight, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor, ClosingTransaction};
use crate::ln::chan_utils;
use crate::ln::onion_utils::HTLCFailReason;
Expand DownExpand Up@@ -347,16 +347,6 @@ enum HTLCInitiator {
	RemoteOffered,
}

/// 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
}

/// An enum gathering stats on commitment transaction, either local or remote.
struct CommitmentStats<'a> {
	tx: CommitmentTransaction, // the transaction info
Expand DownExpand Up@@ -2621,7 +2611,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,
Expand DownExpand Up@@ -2653,7 +2643,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,
Expand Down

49 changes: 49 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1272,6 +1272,39 @@ pub struct ChannelCounterparty {
	pub outbound_htlc_maximum_msat: Option<u64>,
}

/// An enum gathering stats on pending HTLCs, either inbound or outbound side.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct HTLCStats {
	/// The number of pending HTLCs.
	pub pending_htlcs: u32,
	/// The total value of pending HTLCs.
	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 HTLCs being held.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub holding_cell_msat: u64,
	/// The number of pending, outgoing HTLCs being added that are being held,
	/// dust HTLCS not included.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub on_holder_tx_holding_cell_htlcs_count: u32,
}

impl_writeable_tlv_based!(HTLCStats, {
	(0, pending_htlcs, required),
	(2, pending_htlcs_value_msat, required),
	(4, on_counterparty_tx_dust_exposure_msat, required),
	(6, on_holder_tx_dust_exposure_msat, required),
	(8, holding_cell_msat, required),
	(10, on_holder_tx_holding_cell_htlcs_count, required),
});

/// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
#[derive(Clone, Debug, PartialEq)]
pub struct ChannelDetails {
Expand DownExpand Up@@ -1443,6 +1476,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>,
@tnulltnullJun 12, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the channel module is not public, HTLCStats is currently not exposed. We need to expose the object itself if it is now exposed through ChannelDetails.
@wvanlintwvanlintJun 12, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved HTLCStats to the channelmanager module for that purpose.
	/// 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 {
Expand DownExpand Up@@ -1514,6 +1555,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)),
 }
	}
}
Expand DownExpand Up@@ -7156,6 +7199,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),
 (41, self.incoming_htlc_stats, option),
 (43, self.outgoing_htlc_stats, option),
Comment thread
tnull marked this conversation as resolved.

 });
 Ok(())
	}
Expand DownExpand Up@@ -7193,6 +7238,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
Expand DownExpand Up@@ -7228,6 +7275,8 @@ impl Readable for ChannelDetails {
 inbound_htlc_minimum_msat,
 inbound_htlc_maximum_msat,
 feerate_sat_per_1000_weight,
 incoming_htlc_stats,
 outgoing_htlc_stats,
 })
	}
}
Expand Down

6 changes: 5 additions & 1 deletion
lightning/src/routing/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2512,7 +2512,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,
 }
	}

Expand DownExpand Up@@ -6299,6 +6301,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,
 }
	}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Expose HTLCStats in ChannelDetails#2349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wvanlint
wants to merge
1
commit into

from

 Closed


Expose HTLCStats in ChannelDetails
#2349
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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[..])
Expand Down

16 changes: 3 additions & 13 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ use crate::ln::features::{ChannelTypeFeatures, InitFeatures};
use crate::ln::msgs;
use crate::ln::msgs::DecodeError;
use crate::ln::script::{self, ShutdownScript};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, HTLCStats, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, htlc_success_tx_weight, htlc_timeout_tx_weight, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor, ClosingTransaction};
use crate::ln::chan_utils;
use crate::ln::onion_utils::HTLCFailReason;
Expand DownExpand Up@@ -347,16 +347,6 @@ enum HTLCInitiator {
	RemoteOffered,
}

/// 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
}

/// An enum gathering stats on commitment transaction, either local or remote.
struct CommitmentStats<'a> {
	tx: CommitmentTransaction, // the transaction info
Expand DownExpand Up@@ -2621,7 +2611,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,
Expand DownExpand Up@@ -2653,7 +2643,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,
Expand Down

49 changes: 49 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1272,6 +1272,39 @@ pub struct ChannelCounterparty {
	pub outbound_htlc_maximum_msat: Option<u64>,
}

/// An enum gathering stats on pending HTLCs, either inbound or outbound side.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct HTLCStats {
	/// The number of pending HTLCs.
	pub pending_htlcs: u32,
	/// The total value of pending HTLCs.
	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 HTLCs being held.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub holding_cell_msat: u64,
	/// The number of pending, outgoing HTLCs being added that are being held,
	/// dust HTLCS not included.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub on_holder_tx_holding_cell_htlcs_count: u32,
}

impl_writeable_tlv_based!(HTLCStats, {
	(0, pending_htlcs, required),
	(2, pending_htlcs_value_msat, required),
	(4, on_counterparty_tx_dust_exposure_msat, required),
	(6, on_holder_tx_dust_exposure_msat, required),
	(8, holding_cell_msat, required),
	(10, on_holder_tx_holding_cell_htlcs_count, required),
});

/// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
#[derive(Clone, Debug, PartialEq)]
pub struct ChannelDetails {
Expand DownExpand Up@@ -1443,6 +1476,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>,
@tnulltnullJun 12, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the channel module is not public, HTLCStats is currently not exposed. We need to expose the object itself if it is now exposed through ChannelDetails.
@wvanlintwvanlintJun 12, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved HTLCStats to the channelmanager module for that purpose.
	/// 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 {
Expand DownExpand Up@@ -1514,6 +1555,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)),
 }
	}
}
Expand DownExpand Up@@ -7156,6 +7199,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),
 (41, self.incoming_htlc_stats, option),
 (43, self.outgoing_htlc_stats, option),
Comment thread
tnull marked this conversation as resolved.

 });
 Ok(())
	}
Expand DownExpand Up@@ -7193,6 +7238,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
Expand DownExpand Up@@ -7228,6 +7275,8 @@ impl Readable for ChannelDetails {
 inbound_htlc_minimum_msat,
 inbound_htlc_maximum_msat,
 feerate_sat_per_1000_weight,
 incoming_htlc_stats,
 outgoing_htlc_stats,
 })
	}
}
Expand Down

6 changes: 5 additions & 1 deletion
lightning/src/routing/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2512,7 +2512,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,
 }
	}

Expand DownExpand Up@@ -6299,6 +6301,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,
 }
	}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Expose HTLCStats in ChannelDetails#2349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wvanlint
wants to merge
1
commit into

from

 Closed


Expose HTLCStats in ChannelDetails
#2349
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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[..])
Expand Down

16 changes: 3 additions & 13 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ use crate::ln::features::{ChannelTypeFeatures, InitFeatures};
use crate::ln::msgs;
use crate::ln::msgs::DecodeError;
use crate::ln::script::{self, ShutdownScript};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, HTLCStats, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, htlc_success_tx_weight, htlc_timeout_tx_weight, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor, ClosingTransaction};
use crate::ln::chan_utils;
use crate::ln::onion_utils::HTLCFailReason;
Expand DownExpand Up@@ -347,16 +347,6 @@ enum HTLCInitiator {
	RemoteOffered,
}

/// 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
}

/// An enum gathering stats on commitment transaction, either local or remote.
struct CommitmentStats<'a> {
	tx: CommitmentTransaction, // the transaction info
Expand DownExpand Up@@ -2621,7 +2611,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,
Expand DownExpand Up@@ -2653,7 +2643,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,
Expand Down

49 changes: 49 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1272,6 +1272,39 @@ pub struct ChannelCounterparty {
	pub outbound_htlc_maximum_msat: Option<u64>,
}

/// An enum gathering stats on pending HTLCs, either inbound or outbound side.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct HTLCStats {
	/// The number of pending HTLCs.
	pub pending_htlcs: u32,
	/// The total value of pending HTLCs.
	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 HTLCs being held.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub holding_cell_msat: u64,
	/// The number of pending, outgoing HTLCs being added that are being held,
	/// dust HTLCS not included.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub on_holder_tx_holding_cell_htlcs_count: u32,
}

impl_writeable_tlv_based!(HTLCStats, {
	(0, pending_htlcs, required),
	(2, pending_htlcs_value_msat, required),
	(4, on_counterparty_tx_dust_exposure_msat, required),
	(6, on_holder_tx_dust_exposure_msat, required),
	(8, holding_cell_msat, required),
	(10, on_holder_tx_holding_cell_htlcs_count, required),
});

/// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
#[derive(Clone, Debug, PartialEq)]
pub struct ChannelDetails {
Expand DownExpand Up@@ -1443,6 +1476,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>,
@tnulltnullJun 12, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the channel module is not public, HTLCStats is currently not exposed. We need to expose the object itself if it is now exposed through ChannelDetails.
@wvanlintwvanlintJun 12, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved HTLCStats to the channelmanager module for that purpose.
	/// 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 {
Expand DownExpand Up@@ -1514,6 +1555,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)),
 }
	}
}
Expand DownExpand Up@@ -7156,6 +7199,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),
 (41, self.incoming_htlc_stats, option),
 (43, self.outgoing_htlc_stats, option),
Comment thread
tnull marked this conversation as resolved.

 });
 Ok(())
	}
Expand DownExpand Up@@ -7193,6 +7238,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
Expand DownExpand Up@@ -7228,6 +7275,8 @@ impl Readable for ChannelDetails {
 inbound_htlc_minimum_msat,
 inbound_htlc_maximum_msat,
 feerate_sat_per_1000_weight,
 incoming_htlc_stats,
 outgoing_htlc_stats,
 })
	}
}
Expand Down

6 changes: 5 additions & 1 deletion
lightning/src/routing/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2512,7 +2512,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,
 }
	}

Expand DownExpand Up@@ -6299,6 +6301,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,
 }
	}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Expose HTLCStats in ChannelDetails#2349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wvanlint
wants to merge
1
commit into

from

 Closed


Expose HTLCStats in ChannelDetails
#2349
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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[..])
Expand Down

16 changes: 3 additions & 13 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ use crate::ln::features::{ChannelTypeFeatures, InitFeatures};
use crate::ln::msgs;
use crate::ln::msgs::DecodeError;
use crate::ln::script::{self, ShutdownScript};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, HTLCStats, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, htlc_success_tx_weight, htlc_timeout_tx_weight, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor, ClosingTransaction};
use crate::ln::chan_utils;
use crate::ln::onion_utils::HTLCFailReason;
Expand DownExpand Up@@ -347,16 +347,6 @@ enum HTLCInitiator {
	RemoteOffered,
}

/// 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
}

/// An enum gathering stats on commitment transaction, either local or remote.
struct CommitmentStats<'a> {
	tx: CommitmentTransaction, // the transaction info
Expand DownExpand Up@@ -2621,7 +2611,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,
Expand DownExpand Up@@ -2653,7 +2643,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,
Expand Down

49 changes: 49 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1272,6 +1272,39 @@ pub struct ChannelCounterparty {
	pub outbound_htlc_maximum_msat: Option<u64>,
}

/// An enum gathering stats on pending HTLCs, either inbound or outbound side.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct HTLCStats {
	/// The number of pending HTLCs.
	pub pending_htlcs: u32,
	/// The total value of pending HTLCs.
	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 HTLCs being held.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub holding_cell_msat: u64,
	/// The number of pending, outgoing HTLCs being added that are being held,
	/// dust HTLCS not included.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub on_holder_tx_holding_cell_htlcs_count: u32,
}

impl_writeable_tlv_based!(HTLCStats, {
	(0, pending_htlcs, required),
	(2, pending_htlcs_value_msat, required),
	(4, on_counterparty_tx_dust_exposure_msat, required),
	(6, on_holder_tx_dust_exposure_msat, required),
	(8, holding_cell_msat, required),
	(10, on_holder_tx_holding_cell_htlcs_count, required),
});

/// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
#[derive(Clone, Debug, PartialEq)]
pub struct ChannelDetails {
Expand DownExpand Up@@ -1443,6 +1476,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>,
@tnulltnullJun 12, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the channel module is not public, HTLCStats is currently not exposed. We need to expose the object itself if it is now exposed through ChannelDetails.
@wvanlintwvanlintJun 12, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved HTLCStats to the channelmanager module for that purpose.
	/// 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 {
Expand DownExpand Up@@ -1514,6 +1555,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)),
 }
	}
}
Expand DownExpand Up@@ -7156,6 +7199,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),
 (41, self.incoming_htlc_stats, option),
 (43, self.outgoing_htlc_stats, option),
Comment thread
tnull marked this conversation as resolved.

 });
 Ok(())
	}
Expand DownExpand Up@@ -7193,6 +7238,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
Expand DownExpand Up@@ -7228,6 +7275,8 @@ impl Readable for ChannelDetails {
 inbound_htlc_minimum_msat,
 inbound_htlc_maximum_msat,
 feerate_sat_per_1000_weight,
 incoming_htlc_stats,
 outgoing_htlc_stats,
 })
	}
}
Expand Down

6 changes: 5 additions & 1 deletion
lightning/src/routing/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2512,7 +2512,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,
 }
	}

Expand DownExpand Up@@ -6299,6 +6301,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,
 }
	}

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Expose HTLCStats in ChannelDetails#2349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Closed

wvanlint
wants to merge
1
commit into

from

 Closed


Expose HTLCStats in ChannelDetails
#2349
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
fuzz/src/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -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[..])
Expand Down

16 changes: 3 additions & 13 deletions
lightning/src/ln/channel.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ use crate::ln::features::{ChannelTypeFeatures, InitFeatures};
use crate::ln::msgs;
use crate::ln::msgs::DecodeError;
use crate::ln::script::{self, ShutdownScript};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, HTLCStats, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
use crate::ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, htlc_success_tx_weight, htlc_timeout_tx_weight, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor, ClosingTransaction};
use crate::ln::chan_utils;
use crate::ln::onion_utils::HTLCFailReason;
Expand DownExpand Up@@ -347,16 +347,6 @@ enum HTLCInitiator {
	RemoteOffered,
}

/// 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
}

/// An enum gathering stats on commitment transaction, either local or remote.
struct CommitmentStats<'a> {
	tx: CommitmentTransaction, // the transaction info
Expand DownExpand Up@@ -2621,7 +2611,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,
Expand DownExpand Up@@ -2653,7 +2643,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,
Expand Down

49 changes: 49 additions & 0 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1272,6 +1272,39 @@ pub struct ChannelCounterparty {
	pub outbound_htlc_maximum_msat: Option<u64>,
}

/// An enum gathering stats on pending HTLCs, either inbound or outbound side.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct HTLCStats {
	/// The number of pending HTLCs.
	pub pending_htlcs: u32,
	/// The total value of pending HTLCs.
	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 HTLCs being held.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub holding_cell_msat: u64,
	/// The number of pending, outgoing HTLCs being added that are being held,
	/// dust HTLCS not included.
	///
	/// These HTLCs are being held temporarily after sending commitment_signed to discern them
	/// from HTLCs implicitly included in the counterparty's revoke_and_ack.
	pub on_holder_tx_holding_cell_htlcs_count: u32,
}

impl_writeable_tlv_based!(HTLCStats, {
	(0, pending_htlcs, required),
	(2, pending_htlcs_value_msat, required),
	(4, on_counterparty_tx_dust_exposure_msat, required),
	(6, on_holder_tx_dust_exposure_msat, required),
	(8, holding_cell_msat, required),
	(10, on_holder_tx_holding_cell_htlcs_count, required),
});

/// Details of a channel, as returned by [`ChannelManager::list_channels`] and [`ChannelManager::list_usable_channels`]
#[derive(Clone, Debug, PartialEq)]
pub struct ChannelDetails {
Expand DownExpand Up@@ -1443,6 +1476,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>,
@tnulltnullJun 12, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the channel module is not public, HTLCStats is currently not exposed. We need to expose the object itself if it is now exposed through ChannelDetails.
@wvanlintwvanlintJun 12, 2023

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved HTLCStats to the channelmanager module for that purpose.
	/// 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 {
Expand DownExpand Up@@ -1514,6 +1555,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)),
 }
	}
}
Expand DownExpand Up@@ -7156,6 +7199,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),
 (41, self.incoming_htlc_stats, option),
 (43, self.outgoing_htlc_stats, option),
Comment thread
tnull marked this conversation as resolved.

 });
 Ok(())
	}
Expand DownExpand Up@@ -7193,6 +7238,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
Expand DownExpand Up@@ -7228,6 +7275,8 @@ impl Readable for ChannelDetails {
 inbound_htlc_minimum_msat,
 inbound_htlc_maximum_msat,
 feerate_sat_per_1000_weight,
 incoming_htlc_stats,
 outgoing_htlc_stats,
 })
	}
}
Expand Down

6 changes: 5 additions & 1 deletion
lightning/src/routing/router.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2512,7 +2512,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,
 }
	}

Expand DownExpand Up@@ -6299,6 +6301,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,
 }
	}

Expand Down