Add `ChannelContext::get_commitment_stats` by tankyleo · Pull Request #3682 · lightningdevkit/rust-lightning

tankyleo · 2025-03-24T23:03:34Z

 Add `ChannelContext::get_commitment_stats`
It can be useful to get the stats on a potential commitment transaction
without actually building it. Therefore, this commit splits the stats
calculations from the actual build of a commitment transaction.
This introduces an extra loop over the pending htlcs, but current
network behavior produces very few concurrent htlcs on channels.
Furthermore, each iteration of the loop in the stats calculation is very
cheap.

Requested by @wpaulino in #3641

 Rename `CommitmentTransaction::htlcs` to `nondust_htlcs`

 Remove unnecessary clones of the HTLC-HTLCSource table

 Require all HTLC success states to hold their corresponding preimage
This allows us to DRY the code that calculates the
`value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`.
HTLC success states have held their corresponding preimage since
0.0.105, and the release notes of 0.1 already require users running
0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So
this change is fully compatible with existing upgrade paths to
the yet-to-be-shipped 0.2 release.

ldk-reviews-bot · 2025-03-24T23:03:37Z

👋 Thanks for assigning @wpaulino as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

TheBlueMatt · 2025-03-25T13:23:28Z

Why is this draft?

tankyleo · 2025-03-25T15:14:47Z

Why is this draft?

@TheBlueMatt I don't feel great about the code duplication between get_commitment_stats and build_commitment_transaction. Both functions filter for the non-dust HTLCs, but they do different things with them.

Let me know what you think.

tankyleo · 2025-03-25T16:02:45Z

I'm working on further cleanups now.

tankyleo · 2025-03-25T20:02:45Z

@wpaulino the PR is in a better spot now, let me know what you think.

codecov · 2025-03-27T15:32:41Z

Codecov Report

Attention: Patch coverage is 98.00995% with 4 lines in your changes missing coverage. Please review.

Project coverage is 89.16%. Comparing base (2e435de) to head (71df614).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
lightning/src/ln/chan_utils.rs	86.66%	2 Missing ⚠️
lightning/src/ln/channel.rs	98.77%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #3682 +/- ##
==========================================
- Coverage 89.18% 89.16% -0.03% 
==========================================
Files 155 155 Lines 120796 120861 +65 Branches 120796 120861 +65 ==========================================
+ Hits 107731 107760 +29 - Misses 10415 10446 +31 - Partials 2650 2655 +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tankyleo · 2025-03-27T16:15:58Z

@TheBlueMatt take a look when you can thank you!

TheBlueMatt

Basically LGTM, one nit. Sorry somehow I lost track of this one.

TheBlueMatt

Needs rebase, it seems

tankyleo · 2025-04-04T01:20:46Z

A question for you in an above comment Matt thanks :)

ldk-reviews-bot · 2025-04-07T00:00:11Z

🔔 1st Reminder

Hey @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

wpaulino

LGTM, two minor comments

It can be useful to get the stats on a potential commitment transaction without actually building it. Therefore, this commit splits the stats calculations from the actual build of a commitment transaction. This introduces an extra loop over the pending htlcs when actually building a commitment transaction, but current network behavior produces very few concurrent htlcs on channels. Furthermore, each iteration of the loop in the stats calculation is very cheap. The motivating use case for `build_commitment_stats` is to calculate the balances of the channel parties in order to validate the `funding_contribution_satoshis` field of `splice_init` and `splice_ack` messages without building a full commitment transaction.

This allows us to DRY the code that calculates the `value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`. HTLC success states have held their corresponding preimage since 0.0.105, and the release notes of 0.1 already require users running 0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So this change is fully compatible with existing upgrade paths to the yet-to-be-shipped 0.2 release.

tankyleo · 2025-03-24T23:03:34Z

 Add `ChannelContext::get_commitment_stats`
It can be useful to get the stats on a potential commitment transaction
without actually building it. Therefore, this commit splits the stats
calculations from the actual build of a commitment transaction.
This introduces an extra loop over the pending htlcs, but current
network behavior produces very few concurrent htlcs on channels.
Furthermore, each iteration of the loop in the stats calculation is very
cheap.

Requested by @wpaulino in #3641

 Rename `CommitmentTransaction::htlcs` to `nondust_htlcs`

 Remove unnecessary clones of the HTLC-HTLCSource table

 Require all HTLC success states to hold their corresponding preimage
This allows us to DRY the code that calculates the
`value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`.
HTLC success states have held their corresponding preimage since
0.0.105, and the release notes of 0.1 already require users running
0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So
this change is fully compatible with existing upgrade paths to
the yet-to-be-shipped 0.2 release.

ldk-reviews-bot · 2025-03-24T23:03:37Z

👋 Thanks for assigning @wpaulino as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

TheBlueMatt · 2025-03-25T13:23:28Z

Why is this draft?

tankyleo · 2025-03-25T15:14:47Z

Why is this draft?

@TheBlueMatt I don't feel great about the code duplication between get_commitment_stats and build_commitment_transaction. Both functions filter for the non-dust HTLCs, but they do different things with them.

Let me know what you think.

tankyleo · 2025-03-25T16:02:45Z

I'm working on further cleanups now.

tankyleo · 2025-03-25T20:02:45Z

@wpaulino the PR is in a better spot now, let me know what you think.

codecov · 2025-03-27T15:32:41Z

Codecov Report

Attention: Patch coverage is 98.00995% with 4 lines in your changes missing coverage. Please review.

Project coverage is 89.16%. Comparing base (2e435de) to head (71df614).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
lightning/src/ln/chan_utils.rs	86.66%	2 Missing ⚠️
lightning/src/ln/channel.rs	98.77%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #3682 +/- ##
==========================================
- Coverage 89.18% 89.16% -0.03% 
==========================================
Files 155 155 Lines 120796 120861 +65 Branches 120796 120861 +65 ==========================================
+ Hits 107731 107760 +29 - Misses 10415 10446 +31 - Partials 2650 2655 +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tankyleo · 2025-03-27T16:15:58Z

@TheBlueMatt take a look when you can thank you!

TheBlueMatt

Basically LGTM, one nit. Sorry somehow I lost track of this one.

TheBlueMatt

Needs rebase, it seems

tankyleo · 2025-04-04T01:20:46Z

A question for you in an above comment Matt thanks :)

ldk-reviews-bot · 2025-04-07T00:00:11Z

🔔 1st Reminder

Hey @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

wpaulino

LGTM, two minor comments

It can be useful to get the stats on a potential commitment transaction without actually building it. Therefore, this commit splits the stats calculations from the actual build of a commitment transaction. This introduces an extra loop over the pending htlcs when actually building a commitment transaction, but current network behavior produces very few concurrent htlcs on channels. Furthermore, each iteration of the loop in the stats calculation is very cheap. The motivating use case for `build_commitment_stats` is to calculate the balances of the channel parties in order to validate the `funding_contribution_satoshis` field of `splice_init` and `splice_ack` messages without building a full commitment transaction.

This allows us to DRY the code that calculates the `value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`. HTLC success states have held their corresponding preimage since 0.0.105, and the release notes of 0.1 already require users running 0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So this change is fully compatible with existing upgrade paths to the yet-to-be-shipped 0.2 release.

tankyleo · 2025-03-24T23:03:34Z

 Add `ChannelContext::get_commitment_stats`
It can be useful to get the stats on a potential commitment transaction
without actually building it. Therefore, this commit splits the stats
calculations from the actual build of a commitment transaction.
This introduces an extra loop over the pending htlcs, but current
network behavior produces very few concurrent htlcs on channels.
Furthermore, each iteration of the loop in the stats calculation is very
cheap.

Requested by @wpaulino in #3641

 Rename `CommitmentTransaction::htlcs` to `nondust_htlcs`

 Remove unnecessary clones of the HTLC-HTLCSource table

 Require all HTLC success states to hold their corresponding preimage
This allows us to DRY the code that calculates the
`value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`.
HTLC success states have held their corresponding preimage since
0.0.105, and the release notes of 0.1 already require users running
0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So
this change is fully compatible with existing upgrade paths to
the yet-to-be-shipped 0.2 release.

ldk-reviews-bot · 2025-03-24T23:03:37Z

👋 Thanks for assigning @wpaulino as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

TheBlueMatt · 2025-03-25T13:23:28Z

Why is this draft?

tankyleo · 2025-03-25T15:14:47Z

Why is this draft?

@TheBlueMatt I don't feel great about the code duplication between get_commitment_stats and build_commitment_transaction. Both functions filter for the non-dust HTLCs, but they do different things with them.

Let me know what you think.

tankyleo · 2025-03-25T16:02:45Z

I'm working on further cleanups now.

tankyleo · 2025-03-25T20:02:45Z

@wpaulino the PR is in a better spot now, let me know what you think.

codecov · 2025-03-27T15:32:41Z

Codecov Report

Attention: Patch coverage is 98.00995% with 4 lines in your changes missing coverage. Please review.

Project coverage is 89.16%. Comparing base (2e435de) to head (71df614).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
lightning/src/ln/chan_utils.rs	86.66%	2 Missing ⚠️
lightning/src/ln/channel.rs	98.77%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #3682 +/- ##
==========================================
- Coverage 89.18% 89.16% -0.03% 
==========================================
Files 155 155 Lines 120796 120861 +65 Branches 120796 120861 +65 ==========================================
+ Hits 107731 107760 +29 - Misses 10415 10446 +31 - Partials 2650 2655 +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tankyleo · 2025-03-27T16:15:58Z

@TheBlueMatt take a look when you can thank you!

TheBlueMatt

Basically LGTM, one nit. Sorry somehow I lost track of this one.

TheBlueMatt

Needs rebase, it seems

tankyleo · 2025-04-04T01:20:46Z

A question for you in an above comment Matt thanks :)

ldk-reviews-bot · 2025-04-07T00:00:11Z

🔔 1st Reminder

Hey @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

wpaulino

LGTM, two minor comments

It can be useful to get the stats on a potential commitment transaction without actually building it. Therefore, this commit splits the stats calculations from the actual build of a commitment transaction. This introduces an extra loop over the pending htlcs when actually building a commitment transaction, but current network behavior produces very few concurrent htlcs on channels. Furthermore, each iteration of the loop in the stats calculation is very cheap. The motivating use case for `build_commitment_stats` is to calculate the balances of the channel parties in order to validate the `funding_contribution_satoshis` field of `splice_init` and `splice_ack` messages without building a full commitment transaction.

This allows us to DRY the code that calculates the `value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`. HTLC success states have held their corresponding preimage since 0.0.105, and the release notes of 0.1 already require users running 0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So this change is fully compatible with existing upgrade paths to the yet-to-be-shipped 0.2 release.

tankyleo · 2025-03-24T23:03:34Z

 Add `ChannelContext::get_commitment_stats`
It can be useful to get the stats on a potential commitment transaction
without actually building it. Therefore, this commit splits the stats
calculations from the actual build of a commitment transaction.
This introduces an extra loop over the pending htlcs, but current
network behavior produces very few concurrent htlcs on channels.
Furthermore, each iteration of the loop in the stats calculation is very
cheap.

Requested by @wpaulino in #3641

 Rename `CommitmentTransaction::htlcs` to `nondust_htlcs`

 Remove unnecessary clones of the HTLC-HTLCSource table

 Require all HTLC success states to hold their corresponding preimage
This allows us to DRY the code that calculates the
`value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`.
HTLC success states have held their corresponding preimage since
0.0.105, and the release notes of 0.1 already require users running
0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So
this change is fully compatible with existing upgrade paths to
the yet-to-be-shipped 0.2 release.

ldk-reviews-bot · 2025-03-24T23:03:37Z

👋 Thanks for assigning @wpaulino as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

TheBlueMatt · 2025-03-25T13:23:28Z

Why is this draft?

tankyleo · 2025-03-25T15:14:47Z

Why is this draft?

@TheBlueMatt I don't feel great about the code duplication between get_commitment_stats and build_commitment_transaction. Both functions filter for the non-dust HTLCs, but they do different things with them.

Let me know what you think.

tankyleo · 2025-03-25T16:02:45Z

I'm working on further cleanups now.

tankyleo · 2025-03-25T20:02:45Z

@wpaulino the PR is in a better spot now, let me know what you think.

codecov · 2025-03-27T15:32:41Z

Codecov Report

Attention: Patch coverage is 98.00995% with 4 lines in your changes missing coverage. Please review.

Project coverage is 89.16%. Comparing base (2e435de) to head (71df614).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
lightning/src/ln/chan_utils.rs	86.66%	2 Missing ⚠️
lightning/src/ln/channel.rs	98.77%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #3682 +/- ##
==========================================
- Coverage 89.18% 89.16% -0.03% 
==========================================
Files 155 155 Lines 120796 120861 +65 Branches 120796 120861 +65 ==========================================
+ Hits 107731 107760 +29 - Misses 10415 10446 +31 - Partials 2650 2655 +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tankyleo · 2025-03-27T16:15:58Z

@TheBlueMatt take a look when you can thank you!

TheBlueMatt

Basically LGTM, one nit. Sorry somehow I lost track of this one.

TheBlueMatt

Needs rebase, it seems

tankyleo · 2025-04-04T01:20:46Z

A question for you in an above comment Matt thanks :)

ldk-reviews-bot · 2025-04-07T00:00:11Z

🔔 1st Reminder

Hey @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

wpaulino

LGTM, two minor comments

It can be useful to get the stats on a potential commitment transaction without actually building it. Therefore, this commit splits the stats calculations from the actual build of a commitment transaction. This introduces an extra loop over the pending htlcs when actually building a commitment transaction, but current network behavior produces very few concurrent htlcs on channels. Furthermore, each iteration of the loop in the stats calculation is very cheap. The motivating use case for `build_commitment_stats` is to calculate the balances of the channel parties in order to validate the `funding_contribution_satoshis` field of `splice_init` and `splice_ack` messages without building a full commitment transaction.

This allows us to DRY the code that calculates the `value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`. HTLC success states have held their corresponding preimage since 0.0.105, and the release notes of 0.1 already require users running 0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So this change is fully compatible with existing upgrade paths to the yet-to-be-shipped 0.2 release.

tankyleo · 2025-03-24T23:03:34Z

 Add `ChannelContext::get_commitment_stats`
It can be useful to get the stats on a potential commitment transaction
without actually building it. Therefore, this commit splits the stats
calculations from the actual build of a commitment transaction.
This introduces an extra loop over the pending htlcs, but current
network behavior produces very few concurrent htlcs on channels.
Furthermore, each iteration of the loop in the stats calculation is very
cheap.

Requested by @wpaulino in #3641

 Rename `CommitmentTransaction::htlcs` to `nondust_htlcs`

 Remove unnecessary clones of the HTLC-HTLCSource table

 Require all HTLC success states to hold their corresponding preimage
This allows us to DRY the code that calculates the
`value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`.
HTLC success states have held their corresponding preimage since
0.0.105, and the release notes of 0.1 already require users running
0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So
this change is fully compatible with existing upgrade paths to
the yet-to-be-shipped 0.2 release.

ldk-reviews-bot · 2025-03-24T23:03:37Z

👋 Thanks for assigning @wpaulino as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

TheBlueMatt · 2025-03-25T13:23:28Z

Why is this draft?

tankyleo · 2025-03-25T15:14:47Z

Why is this draft?

@TheBlueMatt I don't feel great about the code duplication between get_commitment_stats and build_commitment_transaction. Both functions filter for the non-dust HTLCs, but they do different things with them.

Let me know what you think.

tankyleo · 2025-03-25T16:02:45Z

I'm working on further cleanups now.

tankyleo · 2025-03-25T20:02:45Z

@wpaulino the PR is in a better spot now, let me know what you think.

codecov · 2025-03-27T15:32:41Z

Codecov Report

Attention: Patch coverage is 98.00995% with 4 lines in your changes missing coverage. Please review.

Project coverage is 89.16%. Comparing base (2e435de) to head (71df614).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
lightning/src/ln/chan_utils.rs	86.66%	2 Missing ⚠️
lightning/src/ln/channel.rs	98.77%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #3682 +/- ##
==========================================
- Coverage 89.18% 89.16% -0.03% 
==========================================
Files 155 155 Lines 120796 120861 +65 Branches 120796 120861 +65 ==========================================
+ Hits 107731 107760 +29 - Misses 10415 10446 +31 - Partials 2650 2655 +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tankyleo · 2025-03-27T16:15:58Z

@TheBlueMatt take a look when you can thank you!

TheBlueMatt

Basically LGTM, one nit. Sorry somehow I lost track of this one.

TheBlueMatt

Needs rebase, it seems

tankyleo · 2025-04-04T01:20:46Z

A question for you in an above comment Matt thanks :)

ldk-reviews-bot · 2025-04-07T00:00:11Z

🔔 1st Reminder

Hey @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

wpaulino

LGTM, two minor comments

It can be useful to get the stats on a potential commitment transaction without actually building it. Therefore, this commit splits the stats calculations from the actual build of a commitment transaction. This introduces an extra loop over the pending htlcs when actually building a commitment transaction, but current network behavior produces very few concurrent htlcs on channels. Furthermore, each iteration of the loop in the stats calculation is very cheap. The motivating use case for `build_commitment_stats` is to calculate the balances of the channel parties in order to validate the `funding_contribution_satoshis` field of `splice_init` and `splice_ack` messages without building a full commitment transaction.

This allows us to DRY the code that calculates the `value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`. HTLC success states have held their corresponding preimage since 0.0.105, and the release notes of 0.1 already require users running 0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So this change is fully compatible with existing upgrade paths to the yet-to-be-shipped 0.2 release.

tankyleo · 2025-03-24T23:03:34Z

 Add `ChannelContext::get_commitment_stats`
It can be useful to get the stats on a potential commitment transaction
without actually building it. Therefore, this commit splits the stats
calculations from the actual build of a commitment transaction.
This introduces an extra loop over the pending htlcs, but current
network behavior produces very few concurrent htlcs on channels.
Furthermore, each iteration of the loop in the stats calculation is very
cheap.

Requested by @wpaulino in #3641

 Rename `CommitmentTransaction::htlcs` to `nondust_htlcs`

 Remove unnecessary clones of the HTLC-HTLCSource table

 Require all HTLC success states to hold their corresponding preimage
This allows us to DRY the code that calculates the
`value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`.
HTLC success states have held their corresponding preimage since
0.0.105, and the release notes of 0.1 already require users running
0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So
this change is fully compatible with existing upgrade paths to
the yet-to-be-shipped 0.2 release.

ldk-reviews-bot · 2025-03-24T23:03:37Z

👋 Thanks for assigning @wpaulino as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

TheBlueMatt · 2025-03-25T13:23:28Z

Why is this draft?

tankyleo · 2025-03-25T15:14:47Z

Why is this draft?

@TheBlueMatt I don't feel great about the code duplication between get_commitment_stats and build_commitment_transaction. Both functions filter for the non-dust HTLCs, but they do different things with them.

Let me know what you think.

tankyleo · 2025-03-25T16:02:45Z

I'm working on further cleanups now.

tankyleo · 2025-03-25T20:02:45Z

@wpaulino the PR is in a better spot now, let me know what you think.

codecov · 2025-03-27T15:32:41Z

Codecov Report

Attention: Patch coverage is 98.00995% with 4 lines in your changes missing coverage. Please review.

Project coverage is 89.16%. Comparing base (2e435de) to head (71df614).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
lightning/src/ln/chan_utils.rs	86.66%	2 Missing ⚠️
lightning/src/ln/channel.rs	98.77%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #3682 +/- ##
==========================================
- Coverage 89.18% 89.16% -0.03% 
==========================================
Files 155 155 Lines 120796 120861 +65 Branches 120796 120861 +65 ==========================================
+ Hits 107731 107760 +29 - Misses 10415 10446 +31 - Partials 2650 2655 +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tankyleo · 2025-03-27T16:15:58Z

@TheBlueMatt take a look when you can thank you!

TheBlueMatt

Basically LGTM, one nit. Sorry somehow I lost track of this one.

TheBlueMatt

Needs rebase, it seems

tankyleo · 2025-04-04T01:20:46Z

A question for you in an above comment Matt thanks :)

ldk-reviews-bot · 2025-04-07T00:00:11Z

🔔 1st Reminder

Hey @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

wpaulino

LGTM, two minor comments

It can be useful to get the stats on a potential commitment transaction without actually building it. Therefore, this commit splits the stats calculations from the actual build of a commitment transaction. This introduces an extra loop over the pending htlcs when actually building a commitment transaction, but current network behavior produces very few concurrent htlcs on channels. Furthermore, each iteration of the loop in the stats calculation is very cheap. The motivating use case for `build_commitment_stats` is to calculate the balances of the channel parties in order to validate the `funding_contribution_satoshis` field of `splice_init` and `splice_ack` messages without building a full commitment transaction.

This allows us to DRY the code that calculates the `value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`. HTLC success states have held their corresponding preimage since 0.0.105, and the release notes of 0.1 already require users running 0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So this change is fully compatible with existing upgrade paths to the yet-to-be-shipped 0.2 release.

tankyleo · 2025-03-24T23:03:34Z

 Add `ChannelContext::get_commitment_stats`
It can be useful to get the stats on a potential commitment transaction
without actually building it. Therefore, this commit splits the stats
calculations from the actual build of a commitment transaction.
This introduces an extra loop over the pending htlcs, but current
network behavior produces very few concurrent htlcs on channels.
Furthermore, each iteration of the loop in the stats calculation is very
cheap.

Requested by @wpaulino in #3641

 Rename `CommitmentTransaction::htlcs` to `nondust_htlcs`

 Remove unnecessary clones of the HTLC-HTLCSource table

 Require all HTLC success states to hold their corresponding preimage
This allows us to DRY the code that calculates the
`value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`.
HTLC success states have held their corresponding preimage since
0.0.105, and the release notes of 0.1 already require users running
0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So
this change is fully compatible with existing upgrade paths to
the yet-to-be-shipped 0.2 release.

ldk-reviews-bot · 2025-03-24T23:03:37Z

👋 Thanks for assigning @wpaulino as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

TheBlueMatt · 2025-03-25T13:23:28Z

Why is this draft?

tankyleo · 2025-03-25T15:14:47Z

Why is this draft?

@TheBlueMatt I don't feel great about the code duplication between get_commitment_stats and build_commitment_transaction. Both functions filter for the non-dust HTLCs, but they do different things with them.

Let me know what you think.

tankyleo · 2025-03-25T16:02:45Z

I'm working on further cleanups now.

tankyleo · 2025-03-25T20:02:45Z

@wpaulino the PR is in a better spot now, let me know what you think.

codecov · 2025-03-27T15:32:41Z

Codecov Report

Attention: Patch coverage is 98.00995% with 4 lines in your changes missing coverage. Please review.

Project coverage is 89.16%. Comparing base (2e435de) to head (71df614).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
lightning/src/ln/chan_utils.rs	86.66%	2 Missing ⚠️
lightning/src/ln/channel.rs	98.77%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #3682 +/- ##
==========================================
- Coverage 89.18% 89.16% -0.03% 
==========================================
Files 155 155 Lines 120796 120861 +65 Branches 120796 120861 +65 ==========================================
+ Hits 107731 107760 +29 - Misses 10415 10446 +31 - Partials 2650 2655 +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tankyleo · 2025-03-27T16:15:58Z

@TheBlueMatt take a look when you can thank you!

TheBlueMatt

Basically LGTM, one nit. Sorry somehow I lost track of this one.

TheBlueMatt

Needs rebase, it seems

tankyleo · 2025-04-04T01:20:46Z

A question for you in an above comment Matt thanks :)

ldk-reviews-bot · 2025-04-07T00:00:11Z

🔔 1st Reminder

Hey @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

wpaulino

LGTM, two minor comments

It can be useful to get the stats on a potential commitment transaction without actually building it. Therefore, this commit splits the stats calculations from the actual build of a commitment transaction. This introduces an extra loop over the pending htlcs when actually building a commitment transaction, but current network behavior produces very few concurrent htlcs on channels. Furthermore, each iteration of the loop in the stats calculation is very cheap. The motivating use case for `build_commitment_stats` is to calculate the balances of the channel parties in order to validate the `funding_contribution_satoshis` field of `splice_init` and `splice_ack` messages without building a full commitment transaction.

This allows us to DRY the code that calculates the `value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`. HTLC success states have held their corresponding preimage since 0.0.105, and the release notes of 0.1 already require users running 0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So this change is fully compatible with existing upgrade paths to the yet-to-be-shipped 0.2 release.

tankyleo · 2025-03-24T23:03:34Z

 Add `ChannelContext::get_commitment_stats`
It can be useful to get the stats on a potential commitment transaction
without actually building it. Therefore, this commit splits the stats
calculations from the actual build of a commitment transaction.
This introduces an extra loop over the pending htlcs, but current
network behavior produces very few concurrent htlcs on channels.
Furthermore, each iteration of the loop in the stats calculation is very
cheap.

Requested by @wpaulino in #3641

 Rename `CommitmentTransaction::htlcs` to `nondust_htlcs`

 Remove unnecessary clones of the HTLC-HTLCSource table

 Require all HTLC success states to hold their corresponding preimage
This allows us to DRY the code that calculates the
`value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`.
HTLC success states have held their corresponding preimage since
0.0.105, and the release notes of 0.1 already require users running
0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So
this change is fully compatible with existing upgrade paths to
the yet-to-be-shipped 0.2 release.

ldk-reviews-bot · 2025-03-24T23:03:37Z

👋 Thanks for assigning @wpaulino as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

TheBlueMatt · 2025-03-25T13:23:28Z

Why is this draft?

tankyleo · 2025-03-25T15:14:47Z

Why is this draft?

@TheBlueMatt I don't feel great about the code duplication between get_commitment_stats and build_commitment_transaction. Both functions filter for the non-dust HTLCs, but they do different things with them.

Let me know what you think.

tankyleo · 2025-03-25T16:02:45Z

I'm working on further cleanups now.

tankyleo · 2025-03-25T20:02:45Z

@wpaulino the PR is in a better spot now, let me know what you think.

codecov · 2025-03-27T15:32:41Z

Codecov Report

Attention: Patch coverage is 98.00995% with 4 lines in your changes missing coverage. Please review.

Project coverage is 89.16%. Comparing base (2e435de) to head (71df614).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
lightning/src/ln/chan_utils.rs	86.66%	2 Missing ⚠️
lightning/src/ln/channel.rs	98.77%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #3682 +/- ##
==========================================
- Coverage 89.18% 89.16% -0.03% 
==========================================
Files 155 155 Lines 120796 120861 +65 Branches 120796 120861 +65 ==========================================
+ Hits 107731 107760 +29 - Misses 10415 10446 +31 - Partials 2650 2655 +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tankyleo · 2025-03-27T16:15:58Z

@TheBlueMatt take a look when you can thank you!

TheBlueMatt

Basically LGTM, one nit. Sorry somehow I lost track of this one.

TheBlueMatt

Needs rebase, it seems

tankyleo · 2025-04-04T01:20:46Z

A question for you in an above comment Matt thanks :)

ldk-reviews-bot · 2025-04-07T00:00:11Z

🔔 1st Reminder

Hey @wpaulino! This PR has been waiting for your review.
Please take a look when you have a chance. If you're unable to review, please let us know so we can find another reviewer.

wpaulino

LGTM, two minor comments

It can be useful to get the stats on a potential commitment transaction without actually building it. Therefore, this commit splits the stats calculations from the actual build of a commitment transaction. This introduces an extra loop over the pending htlcs when actually building a commitment transaction, but current network behavior produces very few concurrent htlcs on channels. Furthermore, each iteration of the loop in the stats calculation is very cheap. The motivating use case for `build_commitment_stats` is to calculate the balances of the channel parties in order to validate the `funding_contribution_satoshis` field of `splice_init` and `splice_ack` messages without building a full commitment transaction.

This allows us to DRY the code that calculates the `value_to_self_msat_offset` in `ChannelContext::build_commitment_stats`. HTLC success states have held their corresponding preimage since 0.0.105, and the release notes of 0.1 already require users running 0.0.123 and earlier to resolve their HTLCs before upgrading to 0.1. So this change is fully compatible with existing upgrade paths to the yet-to-be-shipped 0.2 release.

ldk-reviews-bot requested a review from TheBlueMatt March 24, 2025 23:14

tankyleo force-pushed the commitment-stats-less-duplication branch 2 times, most recently from 0af1b43 to 31300c3Compare March 25, 2025 04:01

tankyleo marked this pull request as draft March 25, 2025 04:08

tankyleo force-pushed the commitment-stats-less-duplication branch from d6b1f51 to c540347Compare March 25, 2025 19:52

tankyleo marked this pull request as ready for review March 25, 2025 19:59

wpaulino reviewed Mar 25, 2025
View reviewed changes

Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated

tankyleo force-pushed the commitment-stats-less-duplication branch from c540347 to c9b30cbCompare March 26, 2025 00:06

tankyleo requested a review from wpaulino March 26, 2025 03:12

tankyleo force-pushed the commitment-stats-less-duplication branch 3 times, most recently from e637050 to 4d6bf13Compare March 26, 2025 17:40

wpaulino reviewed Mar 26, 2025
View reviewed changes

Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs

tankyleo force-pushed the commitment-stats-less-duplication branch 3 times, most recently from 5a212d8 to d682615Compare March 27, 2025 15:24

tankyleo force-pushed the commitment-stats-less-duplication branch from d682615 to 6f80f99Compare March 27, 2025 16:14

TheBlueMatt reviewed Mar 28, 2025
View reviewed changes

Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated

tankyleo mentioned this pull request Mar 29, 2025
Remove exclusive reference and generic from CommitmentTransaction API #3689
Merged

tankyleo force-pushed the commitment-stats-less-duplication branch 2 times, most recently from a6c6eac to 71df614Compare April 1, 2025 17:47

tankyleo requested a review from TheBlueMatt April 1, 2025 17:48

TheBlueMatt reviewed Apr 2, 2025
View reviewed changes

Comment threadlightning/src/ln/channel.rs Outdated

tankyleo requested review from TheBlueMatt and wpaulino April 2, 2025 21:28

wpaulino reviewed Apr 2, 2025
View reviewed changes

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated

TheBlueMatt reviewed Apr 3, 2025
View reviewed changes

tankyleo force-pushed the commitment-stats-less-duplication branch from 6d8fb6e to 793d4d2Compare April 3, 2025 18:58

tankyleo requested a review from TheBlueMatt April 3, 2025 22:18

TheBlueMatt removed their request for review April 4, 2025 12:38

tankyleo force-pushed the commitment-stats-less-duplication branch from 0c7bab6 to 285f1b9Compare April 4, 2025 20:57

tankyleo requested a review from wpaulino April 4, 2025 21:02

tankyleo commented Apr 4, 2025
View reviewed changes

Comment threadlightning/src/ln/channel.rs Outdated

wpaulino reviewed Apr 7, 2025
View reviewed changes

Comment threadlightning/src/ln/channel.rs Outdated

tankyleo force-pushed the commitment-stats-less-duplication branch from 285f1b9 to 39f11e6Compare April 8, 2025 00:19

tankyleo requested a review from wpaulino April 8, 2025 00:20

tankyleo force-pushed the commitment-stats-less-duplication branch from 39f11e6 to 107619eCompare April 8, 2025 15:40

wpaulino reviewed Apr 8, 2025
View reviewed changes

Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/channel.rs Outdated

wpaulino requested a review from TheBlueMatt April 8, 2025 17:17

tankyleo added 3 commits April 8, 2025 17:33

Rename CommitmentTransaction::htlcs to nondust_htlcs
48fd1db

Remove unnecessary clones of the HTLC-HTLCSource table
28dc94a

tankyleo force-pushed the commitment-stats-less-duplication branch from 186a320 to fb69869Compare April 8, 2025 17:38

tankyleo force-pushed the commitment-stats-less-duplication branch from fb69869 to 671c4b0Compare April 8, 2025 18:04

TheBlueMatt approved these changes Apr 8, 2025
View reviewed changes

TheBlueMatt requested a review from wpaulino April 8, 2025 19:58

wpaulino approved these changes Apr 8, 2025
View reviewed changes

wpaulino merged commit ef0fcab into lightningdevkit:mainApr 9, 2025

tankyleo mentioned this pull request Mar 29, 2025
Custom Transactions Tracking Issue #3603
Open
24 tasks

tankyleo deleted the commitment-stats-less-duplication branch April 11, 2025 15:38