[Custom Transactions] Commitment Transaction & Channel Refactors - #3606

Merged
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder
Mar 25, 2025
Merged

[Custom Transactions] Commitment Transaction & Channel Refactors#3606
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder

Conversation

@tankyleo

@tankyleotankyleo commented Feb 18, 2025

Copy link
Copy Markdown
Contributor

Miscellaneous refactors of CommitmentTranscation and channel in preparation for the upcoming TxBuilder trait. See the commit messages.

@tankyleotankyleo mentioned this pull request Feb 18, 2025
24 tasks
@arik-so

Copy link
Copy Markdown
Contributor

Do you also wanna add the cfg-gate to the CI testing configs?

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Do you also wanna add the cfg-gate to the CI testing configs?

Thank you done

@codecov

codecovBot commented Feb 19, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 97.97297% with 3 lines in your changes missing coverage. Please review.

Project coverage is 89.25%. Comparing base (4c43a5b) to head (1b5bcb0).

Files with missing linesPatch %Lines
lightning/src/ln/channel.rs97.11%2 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3606 +/- ##
==========================================
+ Coverage 89.18% 89.25% +0.06% 
==========================================
Files 155 155 Lines 119274 119206 -68 Branches 119274 119206 -68 ==========================================
+ Hits 106379 106393 +14 + Misses 10290 10223 -67 + Partials 2605 2590 -15 

☔ 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.

Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleotankyleo changed the title [Custom Transactions] Define ChannelParameters, TxBuilder traits[Custom Transactions] Define the TxBuilder traitFeb 20, 2025
@tankyleo

tankyleo commented Feb 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Rebase:

  • Remove the ChannelParameters trait - focus on the basics for now, we can add the bells and whistles later, as needed.
  • Add the trimmed_value_sat parameter to build_commitment_transaction to cover the case where the sum of the trimmed outputs gets added to an ephemeral anchor output.
  • Add ChannelSigner::derive_tx_builder method. For now we specify the exact type to return, can be made generic later.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Notes:

  • First commit defines the API, then second commit demonstrates a full integration of this API into the codebase. This is so that we can have more context for the API discussion, happy to drop it. It does not change the public API, but does require changes to persistence.
  • ChannelContext::build_commitment_transaction sorts the htlcs based on their state,
  • then TxBuilder::build_commitment_transaction sorts the htlcs based on the dust limit.
  • Now we do not tell TxBuilder the trimmed value - TxBuilder decides this - but does it need to let us know the trimmed value? I don't see an immediate need.
  • We now return CommitmentStats, but without the preimages.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@jkczyzjkczyz added the weekly goal Someone wants to land this this week label Feb 27, 2025
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Note that this PR now breaks the public API of CommitmentTransaction.

@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 2 times, most recently from 035e35f to 42d5a79CompareFebruary 27, 2025 21:26
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/chan_utils.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
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 Outdated
Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/chan_utils.rs Outdated
@tankyleo
tankyleo requested a review from wpaulinoMarch 4, 2025 06:40
@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 3 times, most recently from d9c7ba9 to 9a1997aCompareMarch 6, 2025 21:02
@tankyleo

tankyleo commented Mar 6, 2025

Copy link
Copy Markdown
ContributorAuthor

@wpaulino just chatted with @TheBlueMatt offline some takeaways:

  • TxBuilder takes a Vec<HTLCOutputInCommitment>, then channel does a brute force search to populate the output indices. We are ok with the performance.
  • When / if we refactor ChannelTransactionParameters to get rid of all these unwraps, as you suggested, we can include the dust limits in the parameters too, and drop one more field. Does not have to happen before this PR.
  • I will immediately drop the channel_value_satoshis field, and take it from ChannelTransactionParameters.

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase: switch from saturating subs to checked subs, update comments, delete broken test vector.

TheBlueMatt
TheBlueMatt previously approved these changes Mar 14, 2025
The `DirectedChannelTransactionParameters` argument of the
`CommitmentTransaction` constructor already contains the broadcaster,
and the countersignatory public keys, which include the respective
funding keys.
It is therefore not necessary to ask for these funding keys in
additional arguments.
Instead of asking callers to generate the `TxCreationKeys` on every new
commitment before constructing a `CommitmentTransaction`, this commit
lets `CommitmentTransaction` derive the `TxCreationKeys` it will use to
build the raw commitment transaction.
This allows a tighter coupling between the per-commitment keys, and the
corresponding commitment transaction.
As new states are generated, callers now only have to derive new
commitment points; `CommitmentTransaction` takes care of deriving the
per-commitment keys.
This commit also serves to limit the objects in LDK that derive
per-commitment keys according to the LN Specification in preparation
for enabling custom derivations in the future.
Channel objects should not impose a particular per-commitment derivation
scheme on the builders of commitment transactions. This will make it
easier to enable custom derivations in the future.
Instead of building `TxCreationKeys` explicitly, the function
`TrustedCommitmentTransaction::keys` should be used when the keys of the
commitment transaction are needed. We do that in this commit.
The logging for loop in `send_commitment_no_state_update` only iterates
over the non-dust HTLCs. Thus we do not need to create a
`Vec<HTLCOutputInCommitment>` that includes both dust and non-dust
HTLCs, we can grab the `Vec<HTLCOutputInCommitment>` that holds only
non-dust HTLCs directly from `CommitmentTransaction`.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

In case it helps, git diff 4605318 fe0f94c contains the changes from Wilmer's last approval.

Then the fe0f94c to ee8b846 is a rebase on main where I fix some conflicts in channel monitor.

Instead of converting operands to `i64` and checking if the subtractions
overflowed by checking if the `i64` is smaller than zero, we instead
choose to do checked and saturating subtractions on the original
unsigned integers.
There is no need for an if statement if it will always be true.
The fields `feerate_per_kw` and `num_nondust_htlcs` of `CommitmentStats`
can both be accessed directly from the `tx: CommitmentTransaction`
field.
We also take this opportunity to rename the balance fields to make it
extra clear what they refer to.
We choose to include in `CommitmentStats` only fields that will be
calculated or constructed by transaction builders.
The other fields are created by channel, and placed in a new struct
we call `CommitmentData`.
The saturating subtractions used in
`ChannelContext::build_commitment_transaction` are there for a reason;
when the remote party updates the fees, we build the new commitment
transaction before checking whether the remote party has enough balance
to cover the new fee, so we cannot guarantee that the remote party's
balance will be greater than or equal to the sum of the fee and the
anchors.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase from ee8b846 to ff259ba: correct the i64 casts commit message.

@TheBlueMatt
TheBlueMatt removed their request for review March 18, 2025 19:13
value_to_self_msat_offset -= htlc.amount_msat as i64;
},
OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) |
OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

AwaitingRemovedRemoteRevoke isn't a tautology because it is always !include even if generated_by_local.

@tankyleotankyleoMar 24, 2025

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.

I don't think I make any changes to that variant ? As before, always subtract from the offset.

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.

Maybe I'm off on the vocabulary, the tautology to me is the !generated_by_local expression below.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sheesh I was more tired than I thought :(

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.

no problem

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Otherwise lgtm

if msg.htlc_signatures.len() != commitment_stats.num_nondust_htlcs {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_stats.num_nondust_htlcs)));
if msg.htlc_signatures.len() != commitment_data.stats.tx.htlcs().len() {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_data.stats.tx.htlcs().len())));

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

In a followup can we rename htlcs to nondust_htlcs or so? Would add a lot of clarity in a few places.

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.

100%

@TheBlueMatt
TheBlueMatt merged commit 5fe72b5 into lightningdevkit:mainMar 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

weekly goalSomeone wants to land this this week

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@tankyleo@arik-so@TheBlueMatt@wpaulino@jkczyz
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} 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

[Custom Transactions] Commitment Transaction & Channel Refactors - #3606

Merged
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder
Mar 25, 2025
Merged

[Custom Transactions] Commitment Transaction & Channel Refactors#3606
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder

Conversation

@tankyleo

@tankyleotankyleo commented Feb 18, 2025

Copy link
Copy Markdown
Contributor

Miscellaneous refactors of CommitmentTranscation and channel in preparation for the upcoming TxBuilder trait. See the commit messages.

@tankyleotankyleo mentioned this pull request Feb 18, 2025
24 tasks
@arik-so

Copy link
Copy Markdown
Contributor

Do you also wanna add the cfg-gate to the CI testing configs?

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Do you also wanna add the cfg-gate to the CI testing configs?

Thank you done

@codecov

codecovBot commented Feb 19, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 97.97297% with 3 lines in your changes missing coverage. Please review.

Project coverage is 89.25%. Comparing base (4c43a5b) to head (1b5bcb0).

Files with missing linesPatch %Lines
lightning/src/ln/channel.rs97.11%2 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3606 +/- ##
==========================================
+ Coverage 89.18% 89.25% +0.06% 
==========================================
Files 155 155 Lines 119274 119206 -68 Branches 119274 119206 -68 ==========================================
+ Hits 106379 106393 +14 + Misses 10290 10223 -67 + Partials 2605 2590 -15 

☔ 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.

Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleotankyleo changed the title [Custom Transactions] Define ChannelParameters, TxBuilder traits[Custom Transactions] Define the TxBuilder traitFeb 20, 2025
@tankyleo

tankyleo commented Feb 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Rebase:

  • Remove the ChannelParameters trait - focus on the basics for now, we can add the bells and whistles later, as needed.
  • Add the trimmed_value_sat parameter to build_commitment_transaction to cover the case where the sum of the trimmed outputs gets added to an ephemeral anchor output.
  • Add ChannelSigner::derive_tx_builder method. For now we specify the exact type to return, can be made generic later.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Notes:

  • First commit defines the API, then second commit demonstrates a full integration of this API into the codebase. This is so that we can have more context for the API discussion, happy to drop it. It does not change the public API, but does require changes to persistence.
  • ChannelContext::build_commitment_transaction sorts the htlcs based on their state,
  • then TxBuilder::build_commitment_transaction sorts the htlcs based on the dust limit.
  • Now we do not tell TxBuilder the trimmed value - TxBuilder decides this - but does it need to let us know the trimmed value? I don't see an immediate need.
  • We now return CommitmentStats, but without the preimages.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@jkczyzjkczyz added the weekly goal Someone wants to land this this week label Feb 27, 2025
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Note that this PR now breaks the public API of CommitmentTransaction.

@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 2 times, most recently from 035e35f to 42d5a79CompareFebruary 27, 2025 21:26
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/chan_utils.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
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 Outdated
Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/chan_utils.rs Outdated
@tankyleo
tankyleo requested a review from wpaulinoMarch 4, 2025 06:40
@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 3 times, most recently from d9c7ba9 to 9a1997aCompareMarch 6, 2025 21:02
@tankyleo

tankyleo commented Mar 6, 2025

Copy link
Copy Markdown
ContributorAuthor

@wpaulino just chatted with @TheBlueMatt offline some takeaways:

  • TxBuilder takes a Vec<HTLCOutputInCommitment>, then channel does a brute force search to populate the output indices. We are ok with the performance.
  • When / if we refactor ChannelTransactionParameters to get rid of all these unwraps, as you suggested, we can include the dust limits in the parameters too, and drop one more field. Does not have to happen before this PR.
  • I will immediately drop the channel_value_satoshis field, and take it from ChannelTransactionParameters.

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase: switch from saturating subs to checked subs, update comments, delete broken test vector.

TheBlueMatt
TheBlueMatt previously approved these changes Mar 14, 2025
The `DirectedChannelTransactionParameters` argument of the
`CommitmentTransaction` constructor already contains the broadcaster,
and the countersignatory public keys, which include the respective
funding keys.
It is therefore not necessary to ask for these funding keys in
additional arguments.
Instead of asking callers to generate the `TxCreationKeys` on every new
commitment before constructing a `CommitmentTransaction`, this commit
lets `CommitmentTransaction` derive the `TxCreationKeys` it will use to
build the raw commitment transaction.
This allows a tighter coupling between the per-commitment keys, and the
corresponding commitment transaction.
As new states are generated, callers now only have to derive new
commitment points; `CommitmentTransaction` takes care of deriving the
per-commitment keys.
This commit also serves to limit the objects in LDK that derive
per-commitment keys according to the LN Specification in preparation
for enabling custom derivations in the future.
Channel objects should not impose a particular per-commitment derivation
scheme on the builders of commitment transactions. This will make it
easier to enable custom derivations in the future.
Instead of building `TxCreationKeys` explicitly, the function
`TrustedCommitmentTransaction::keys` should be used when the keys of the
commitment transaction are needed. We do that in this commit.
The logging for loop in `send_commitment_no_state_update` only iterates
over the non-dust HTLCs. Thus we do not need to create a
`Vec<HTLCOutputInCommitment>` that includes both dust and non-dust
HTLCs, we can grab the `Vec<HTLCOutputInCommitment>` that holds only
non-dust HTLCs directly from `CommitmentTransaction`.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

In case it helps, git diff 4605318 fe0f94c contains the changes from Wilmer's last approval.

Then the fe0f94c to ee8b846 is a rebase on main where I fix some conflicts in channel monitor.

Instead of converting operands to `i64` and checking if the subtractions
overflowed by checking if the `i64` is smaller than zero, we instead
choose to do checked and saturating subtractions on the original
unsigned integers.
There is no need for an if statement if it will always be true.
The fields `feerate_per_kw` and `num_nondust_htlcs` of `CommitmentStats`
can both be accessed directly from the `tx: CommitmentTransaction`
field.
We also take this opportunity to rename the balance fields to make it
extra clear what they refer to.
We choose to include in `CommitmentStats` only fields that will be
calculated or constructed by transaction builders.
The other fields are created by channel, and placed in a new struct
we call `CommitmentData`.
The saturating subtractions used in
`ChannelContext::build_commitment_transaction` are there for a reason;
when the remote party updates the fees, we build the new commitment
transaction before checking whether the remote party has enough balance
to cover the new fee, so we cannot guarantee that the remote party's
balance will be greater than or equal to the sum of the fee and the
anchors.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase from ee8b846 to ff259ba: correct the i64 casts commit message.

@TheBlueMatt
TheBlueMatt removed their request for review March 18, 2025 19:13
value_to_self_msat_offset -= htlc.amount_msat as i64;
},
OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) |
OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

AwaitingRemovedRemoteRevoke isn't a tautology because it is always !include even if generated_by_local.

@tankyleotankyleoMar 24, 2025

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.

I don't think I make any changes to that variant ? As before, always subtract from the offset.

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.

Maybe I'm off on the vocabulary, the tautology to me is the !generated_by_local expression below.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sheesh I was more tired than I thought :(

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.

no problem

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Otherwise lgtm

if msg.htlc_signatures.len() != commitment_stats.num_nondust_htlcs {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_stats.num_nondust_htlcs)));
if msg.htlc_signatures.len() != commitment_data.stats.tx.htlcs().len() {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_data.stats.tx.htlcs().len())));

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

In a followup can we rename htlcs to nondust_htlcs or so? Would add a lot of clarity in a few places.

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.

100%

@TheBlueMatt
TheBlueMatt merged commit 5fe72b5 into lightningdevkit:mainMar 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

weekly goalSomeone wants to land this this week

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

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

[Custom Transactions] Commitment Transaction & Channel Refactors - #3606

Merged
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder
Mar 25, 2025
Merged

[Custom Transactions] Commitment Transaction & Channel Refactors#3606
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder

Conversation

@tankyleo

@tankyleotankyleo commented Feb 18, 2025

Copy link
Copy Markdown
Contributor

Miscellaneous refactors of CommitmentTranscation and channel in preparation for the upcoming TxBuilder trait. See the commit messages.

@tankyleotankyleo mentioned this pull request Feb 18, 2025
24 tasks
@arik-so

Copy link
Copy Markdown
Contributor

Do you also wanna add the cfg-gate to the CI testing configs?

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Do you also wanna add the cfg-gate to the CI testing configs?

Thank you done

@codecov

codecovBot commented Feb 19, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 97.97297% with 3 lines in your changes missing coverage. Please review.

Project coverage is 89.25%. Comparing base (4c43a5b) to head (1b5bcb0).

Files with missing linesPatch %Lines
lightning/src/ln/channel.rs97.11%2 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3606 +/- ##
==========================================
+ Coverage 89.18% 89.25% +0.06% 
==========================================
Files 155 155 Lines 119274 119206 -68 Branches 119274 119206 -68 ==========================================
+ Hits 106379 106393 +14 + Misses 10290 10223 -67 + Partials 2605 2590 -15 

☔ 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.

Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleotankyleo changed the title [Custom Transactions] Define ChannelParameters, TxBuilder traits[Custom Transactions] Define the TxBuilder traitFeb 20, 2025
@tankyleo

tankyleo commented Feb 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Rebase:

  • Remove the ChannelParameters trait - focus on the basics for now, we can add the bells and whistles later, as needed.
  • Add the trimmed_value_sat parameter to build_commitment_transaction to cover the case where the sum of the trimmed outputs gets added to an ephemeral anchor output.
  • Add ChannelSigner::derive_tx_builder method. For now we specify the exact type to return, can be made generic later.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Notes:

  • First commit defines the API, then second commit demonstrates a full integration of this API into the codebase. This is so that we can have more context for the API discussion, happy to drop it. It does not change the public API, but does require changes to persistence.
  • ChannelContext::build_commitment_transaction sorts the htlcs based on their state,
  • then TxBuilder::build_commitment_transaction sorts the htlcs based on the dust limit.
  • Now we do not tell TxBuilder the trimmed value - TxBuilder decides this - but does it need to let us know the trimmed value? I don't see an immediate need.
  • We now return CommitmentStats, but without the preimages.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@jkczyzjkczyz added the weekly goal Someone wants to land this this week label Feb 27, 2025
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Note that this PR now breaks the public API of CommitmentTransaction.

@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 2 times, most recently from 035e35f to 42d5a79CompareFebruary 27, 2025 21:26
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/chan_utils.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
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 Outdated
Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/chan_utils.rs Outdated
@tankyleo
tankyleo requested a review from wpaulinoMarch 4, 2025 06:40
@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 3 times, most recently from d9c7ba9 to 9a1997aCompareMarch 6, 2025 21:02
@tankyleo

tankyleo commented Mar 6, 2025

Copy link
Copy Markdown
ContributorAuthor

@wpaulino just chatted with @TheBlueMatt offline some takeaways:

  • TxBuilder takes a Vec<HTLCOutputInCommitment>, then channel does a brute force search to populate the output indices. We are ok with the performance.
  • When / if we refactor ChannelTransactionParameters to get rid of all these unwraps, as you suggested, we can include the dust limits in the parameters too, and drop one more field. Does not have to happen before this PR.
  • I will immediately drop the channel_value_satoshis field, and take it from ChannelTransactionParameters.

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase: switch from saturating subs to checked subs, update comments, delete broken test vector.

TheBlueMatt
TheBlueMatt previously approved these changes Mar 14, 2025
The `DirectedChannelTransactionParameters` argument of the
`CommitmentTransaction` constructor already contains the broadcaster,
and the countersignatory public keys, which include the respective
funding keys.
It is therefore not necessary to ask for these funding keys in
additional arguments.
Instead of asking callers to generate the `TxCreationKeys` on every new
commitment before constructing a `CommitmentTransaction`, this commit
lets `CommitmentTransaction` derive the `TxCreationKeys` it will use to
build the raw commitment transaction.
This allows a tighter coupling between the per-commitment keys, and the
corresponding commitment transaction.
As new states are generated, callers now only have to derive new
commitment points; `CommitmentTransaction` takes care of deriving the
per-commitment keys.
This commit also serves to limit the objects in LDK that derive
per-commitment keys according to the LN Specification in preparation
for enabling custom derivations in the future.
Channel objects should not impose a particular per-commitment derivation
scheme on the builders of commitment transactions. This will make it
easier to enable custom derivations in the future.
Instead of building `TxCreationKeys` explicitly, the function
`TrustedCommitmentTransaction::keys` should be used when the keys of the
commitment transaction are needed. We do that in this commit.
The logging for loop in `send_commitment_no_state_update` only iterates
over the non-dust HTLCs. Thus we do not need to create a
`Vec<HTLCOutputInCommitment>` that includes both dust and non-dust
HTLCs, we can grab the `Vec<HTLCOutputInCommitment>` that holds only
non-dust HTLCs directly from `CommitmentTransaction`.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

In case it helps, git diff 4605318 fe0f94c contains the changes from Wilmer's last approval.

Then the fe0f94c to ee8b846 is a rebase on main where I fix some conflicts in channel monitor.

Instead of converting operands to `i64` and checking if the subtractions
overflowed by checking if the `i64` is smaller than zero, we instead
choose to do checked and saturating subtractions on the original
unsigned integers.
There is no need for an if statement if it will always be true.
The fields `feerate_per_kw` and `num_nondust_htlcs` of `CommitmentStats`
can both be accessed directly from the `tx: CommitmentTransaction`
field.
We also take this opportunity to rename the balance fields to make it
extra clear what they refer to.
We choose to include in `CommitmentStats` only fields that will be
calculated or constructed by transaction builders.
The other fields are created by channel, and placed in a new struct
we call `CommitmentData`.
The saturating subtractions used in
`ChannelContext::build_commitment_transaction` are there for a reason;
when the remote party updates the fees, we build the new commitment
transaction before checking whether the remote party has enough balance
to cover the new fee, so we cannot guarantee that the remote party's
balance will be greater than or equal to the sum of the fee and the
anchors.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase from ee8b846 to ff259ba: correct the i64 casts commit message.

@TheBlueMatt
TheBlueMatt removed their request for review March 18, 2025 19:13
value_to_self_msat_offset -= htlc.amount_msat as i64;
},
OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) |
OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

AwaitingRemovedRemoteRevoke isn't a tautology because it is always !include even if generated_by_local.

@tankyleotankyleoMar 24, 2025

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.

I don't think I make any changes to that variant ? As before, always subtract from the offset.

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.

Maybe I'm off on the vocabulary, the tautology to me is the !generated_by_local expression below.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sheesh I was more tired than I thought :(

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.

no problem

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Otherwise lgtm

if msg.htlc_signatures.len() != commitment_stats.num_nondust_htlcs {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_stats.num_nondust_htlcs)));
if msg.htlc_signatures.len() != commitment_data.stats.tx.htlcs().len() {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_data.stats.tx.htlcs().len())));

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

In a followup can we rename htlcs to nondust_htlcs or so? Would add a lot of clarity in a few places.

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.

100%

@TheBlueMatt
TheBlueMatt merged commit 5fe72b5 into lightningdevkit:mainMar 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

weekly goalSomeone wants to land this this week

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

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

[Custom Transactions] Commitment Transaction & Channel Refactors - #3606

Merged
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder
Mar 25, 2025
Merged

[Custom Transactions] Commitment Transaction & Channel Refactors#3606
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder

Conversation

@tankyleo

@tankyleotankyleo commented Feb 18, 2025

Copy link
Copy Markdown
Contributor

Miscellaneous refactors of CommitmentTranscation and channel in preparation for the upcoming TxBuilder trait. See the commit messages.

@tankyleotankyleo mentioned this pull request Feb 18, 2025
24 tasks
@arik-so

Copy link
Copy Markdown
Contributor

Do you also wanna add the cfg-gate to the CI testing configs?

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Do you also wanna add the cfg-gate to the CI testing configs?

Thank you done

@codecov

codecovBot commented Feb 19, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 97.97297% with 3 lines in your changes missing coverage. Please review.

Project coverage is 89.25%. Comparing base (4c43a5b) to head (1b5bcb0).

Files with missing linesPatch %Lines
lightning/src/ln/channel.rs97.11%2 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3606 +/- ##
==========================================
+ Coverage 89.18% 89.25% +0.06% 
==========================================
Files 155 155 Lines 119274 119206 -68 Branches 119274 119206 -68 ==========================================
+ Hits 106379 106393 +14 + Misses 10290 10223 -67 + Partials 2605 2590 -15 

☔ 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.

Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleotankyleo changed the title [Custom Transactions] Define ChannelParameters, TxBuilder traits[Custom Transactions] Define the TxBuilder traitFeb 20, 2025
@tankyleo

tankyleo commented Feb 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Rebase:

  • Remove the ChannelParameters trait - focus on the basics for now, we can add the bells and whistles later, as needed.
  • Add the trimmed_value_sat parameter to build_commitment_transaction to cover the case where the sum of the trimmed outputs gets added to an ephemeral anchor output.
  • Add ChannelSigner::derive_tx_builder method. For now we specify the exact type to return, can be made generic later.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Notes:

  • First commit defines the API, then second commit demonstrates a full integration of this API into the codebase. This is so that we can have more context for the API discussion, happy to drop it. It does not change the public API, but does require changes to persistence.
  • ChannelContext::build_commitment_transaction sorts the htlcs based on their state,
  • then TxBuilder::build_commitment_transaction sorts the htlcs based on the dust limit.
  • Now we do not tell TxBuilder the trimmed value - TxBuilder decides this - but does it need to let us know the trimmed value? I don't see an immediate need.
  • We now return CommitmentStats, but without the preimages.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@jkczyzjkczyz added the weekly goal Someone wants to land this this week label Feb 27, 2025
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Note that this PR now breaks the public API of CommitmentTransaction.

@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 2 times, most recently from 035e35f to 42d5a79CompareFebruary 27, 2025 21:26
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/chan_utils.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
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 Outdated
Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/chan_utils.rs Outdated
@tankyleo
tankyleo requested a review from wpaulinoMarch 4, 2025 06:40
@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 3 times, most recently from d9c7ba9 to 9a1997aCompareMarch 6, 2025 21:02
@tankyleo

tankyleo commented Mar 6, 2025

Copy link
Copy Markdown
ContributorAuthor

@wpaulino just chatted with @TheBlueMatt offline some takeaways:

  • TxBuilder takes a Vec<HTLCOutputInCommitment>, then channel does a brute force search to populate the output indices. We are ok with the performance.
  • When / if we refactor ChannelTransactionParameters to get rid of all these unwraps, as you suggested, we can include the dust limits in the parameters too, and drop one more field. Does not have to happen before this PR.
  • I will immediately drop the channel_value_satoshis field, and take it from ChannelTransactionParameters.

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase: switch from saturating subs to checked subs, update comments, delete broken test vector.

TheBlueMatt
TheBlueMatt previously approved these changes Mar 14, 2025
The `DirectedChannelTransactionParameters` argument of the
`CommitmentTransaction` constructor already contains the broadcaster,
and the countersignatory public keys, which include the respective
funding keys.
It is therefore not necessary to ask for these funding keys in
additional arguments.
Instead of asking callers to generate the `TxCreationKeys` on every new
commitment before constructing a `CommitmentTransaction`, this commit
lets `CommitmentTransaction` derive the `TxCreationKeys` it will use to
build the raw commitment transaction.
This allows a tighter coupling between the per-commitment keys, and the
corresponding commitment transaction.
As new states are generated, callers now only have to derive new
commitment points; `CommitmentTransaction` takes care of deriving the
per-commitment keys.
This commit also serves to limit the objects in LDK that derive
per-commitment keys according to the LN Specification in preparation
for enabling custom derivations in the future.
Channel objects should not impose a particular per-commitment derivation
scheme on the builders of commitment transactions. This will make it
easier to enable custom derivations in the future.
Instead of building `TxCreationKeys` explicitly, the function
`TrustedCommitmentTransaction::keys` should be used when the keys of the
commitment transaction are needed. We do that in this commit.
The logging for loop in `send_commitment_no_state_update` only iterates
over the non-dust HTLCs. Thus we do not need to create a
`Vec<HTLCOutputInCommitment>` that includes both dust and non-dust
HTLCs, we can grab the `Vec<HTLCOutputInCommitment>` that holds only
non-dust HTLCs directly from `CommitmentTransaction`.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

In case it helps, git diff 4605318 fe0f94c contains the changes from Wilmer's last approval.

Then the fe0f94c to ee8b846 is a rebase on main where I fix some conflicts in channel monitor.

Instead of converting operands to `i64` and checking if the subtractions
overflowed by checking if the `i64` is smaller than zero, we instead
choose to do checked and saturating subtractions on the original
unsigned integers.
There is no need for an if statement if it will always be true.
The fields `feerate_per_kw` and `num_nondust_htlcs` of `CommitmentStats`
can both be accessed directly from the `tx: CommitmentTransaction`
field.
We also take this opportunity to rename the balance fields to make it
extra clear what they refer to.
We choose to include in `CommitmentStats` only fields that will be
calculated or constructed by transaction builders.
The other fields are created by channel, and placed in a new struct
we call `CommitmentData`.
The saturating subtractions used in
`ChannelContext::build_commitment_transaction` are there for a reason;
when the remote party updates the fees, we build the new commitment
transaction before checking whether the remote party has enough balance
to cover the new fee, so we cannot guarantee that the remote party's
balance will be greater than or equal to the sum of the fee and the
anchors.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase from ee8b846 to ff259ba: correct the i64 casts commit message.

@TheBlueMatt
TheBlueMatt removed their request for review March 18, 2025 19:13
value_to_self_msat_offset -= htlc.amount_msat as i64;
},
OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) |
OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

AwaitingRemovedRemoteRevoke isn't a tautology because it is always !include even if generated_by_local.

@tankyleotankyleoMar 24, 2025

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.

I don't think I make any changes to that variant ? As before, always subtract from the offset.

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.

Maybe I'm off on the vocabulary, the tautology to me is the !generated_by_local expression below.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sheesh I was more tired than I thought :(

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.

no problem

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Otherwise lgtm

if msg.htlc_signatures.len() != commitment_stats.num_nondust_htlcs {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_stats.num_nondust_htlcs)));
if msg.htlc_signatures.len() != commitment_data.stats.tx.htlcs().len() {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_data.stats.tx.htlcs().len())));

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

In a followup can we rename htlcs to nondust_htlcs or so? Would add a lot of clarity in a few places.

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.

100%

@TheBlueMatt
TheBlueMatt merged commit 5fe72b5 into lightningdevkit:mainMar 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

weekly goalSomeone wants to land this this week

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@tankyleo@arik-so@TheBlueMatt@wpaulino@jkczyz
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } 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

[Custom Transactions] Commitment Transaction & Channel Refactors - #3606

Merged
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder
Mar 25, 2025
Merged

[Custom Transactions] Commitment Transaction & Channel Refactors#3606
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder

Conversation

@tankyleo

@tankyleotankyleo commented Feb 18, 2025

Copy link
Copy Markdown
Contributor

Miscellaneous refactors of CommitmentTranscation and channel in preparation for the upcoming TxBuilder trait. See the commit messages.

@tankyleotankyleo mentioned this pull request Feb 18, 2025
24 tasks
@arik-so

Copy link
Copy Markdown
Contributor

Do you also wanna add the cfg-gate to the CI testing configs?

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Do you also wanna add the cfg-gate to the CI testing configs?

Thank you done

@codecov

codecovBot commented Feb 19, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 97.97297% with 3 lines in your changes missing coverage. Please review.

Project coverage is 89.25%. Comparing base (4c43a5b) to head (1b5bcb0).

Files with missing linesPatch %Lines
lightning/src/ln/channel.rs97.11%2 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3606 +/- ##
==========================================
+ Coverage 89.18% 89.25% +0.06% 
==========================================
Files 155 155 Lines 119274 119206 -68 Branches 119274 119206 -68 ==========================================
+ Hits 106379 106393 +14 + Misses 10290 10223 -67 + Partials 2605 2590 -15 

☔ 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.

Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleotankyleo changed the title [Custom Transactions] Define ChannelParameters, TxBuilder traits[Custom Transactions] Define the TxBuilder traitFeb 20, 2025
@tankyleo

tankyleo commented Feb 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Rebase:

  • Remove the ChannelParameters trait - focus on the basics for now, we can add the bells and whistles later, as needed.
  • Add the trimmed_value_sat parameter to build_commitment_transaction to cover the case where the sum of the trimmed outputs gets added to an ephemeral anchor output.
  • Add ChannelSigner::derive_tx_builder method. For now we specify the exact type to return, can be made generic later.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Notes:

  • First commit defines the API, then second commit demonstrates a full integration of this API into the codebase. This is so that we can have more context for the API discussion, happy to drop it. It does not change the public API, but does require changes to persistence.
  • ChannelContext::build_commitment_transaction sorts the htlcs based on their state,
  • then TxBuilder::build_commitment_transaction sorts the htlcs based on the dust limit.
  • Now we do not tell TxBuilder the trimmed value - TxBuilder decides this - but does it need to let us know the trimmed value? I don't see an immediate need.
  • We now return CommitmentStats, but without the preimages.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@jkczyzjkczyz added the weekly goal Someone wants to land this this week label Feb 27, 2025
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Note that this PR now breaks the public API of CommitmentTransaction.

@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 2 times, most recently from 035e35f to 42d5a79CompareFebruary 27, 2025 21:26
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/chan_utils.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
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 Outdated
Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/chan_utils.rs Outdated
@tankyleo
tankyleo requested a review from wpaulinoMarch 4, 2025 06:40
@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 3 times, most recently from d9c7ba9 to 9a1997aCompareMarch 6, 2025 21:02
@tankyleo

tankyleo commented Mar 6, 2025

Copy link
Copy Markdown
ContributorAuthor

@wpaulino just chatted with @TheBlueMatt offline some takeaways:

  • TxBuilder takes a Vec<HTLCOutputInCommitment>, then channel does a brute force search to populate the output indices. We are ok with the performance.
  • When / if we refactor ChannelTransactionParameters to get rid of all these unwraps, as you suggested, we can include the dust limits in the parameters too, and drop one more field. Does not have to happen before this PR.
  • I will immediately drop the channel_value_satoshis field, and take it from ChannelTransactionParameters.

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase: switch from saturating subs to checked subs, update comments, delete broken test vector.

TheBlueMatt
TheBlueMatt previously approved these changes Mar 14, 2025
The `DirectedChannelTransactionParameters` argument of the
`CommitmentTransaction` constructor already contains the broadcaster,
and the countersignatory public keys, which include the respective
funding keys.
It is therefore not necessary to ask for these funding keys in
additional arguments.
Instead of asking callers to generate the `TxCreationKeys` on every new
commitment before constructing a `CommitmentTransaction`, this commit
lets `CommitmentTransaction` derive the `TxCreationKeys` it will use to
build the raw commitment transaction.
This allows a tighter coupling between the per-commitment keys, and the
corresponding commitment transaction.
As new states are generated, callers now only have to derive new
commitment points; `CommitmentTransaction` takes care of deriving the
per-commitment keys.
This commit also serves to limit the objects in LDK that derive
per-commitment keys according to the LN Specification in preparation
for enabling custom derivations in the future.
Channel objects should not impose a particular per-commitment derivation
scheme on the builders of commitment transactions. This will make it
easier to enable custom derivations in the future.
Instead of building `TxCreationKeys` explicitly, the function
`TrustedCommitmentTransaction::keys` should be used when the keys of the
commitment transaction are needed. We do that in this commit.
The logging for loop in `send_commitment_no_state_update` only iterates
over the non-dust HTLCs. Thus we do not need to create a
`Vec<HTLCOutputInCommitment>` that includes both dust and non-dust
HTLCs, we can grab the `Vec<HTLCOutputInCommitment>` that holds only
non-dust HTLCs directly from `CommitmentTransaction`.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

In case it helps, git diff 4605318 fe0f94c contains the changes from Wilmer's last approval.

Then the fe0f94c to ee8b846 is a rebase on main where I fix some conflicts in channel monitor.

Instead of converting operands to `i64` and checking if the subtractions
overflowed by checking if the `i64` is smaller than zero, we instead
choose to do checked and saturating subtractions on the original
unsigned integers.
There is no need for an if statement if it will always be true.
The fields `feerate_per_kw` and `num_nondust_htlcs` of `CommitmentStats`
can both be accessed directly from the `tx: CommitmentTransaction`
field.
We also take this opportunity to rename the balance fields to make it
extra clear what they refer to.
We choose to include in `CommitmentStats` only fields that will be
calculated or constructed by transaction builders.
The other fields are created by channel, and placed in a new struct
we call `CommitmentData`.
The saturating subtractions used in
`ChannelContext::build_commitment_transaction` are there for a reason;
when the remote party updates the fees, we build the new commitment
transaction before checking whether the remote party has enough balance
to cover the new fee, so we cannot guarantee that the remote party's
balance will be greater than or equal to the sum of the fee and the
anchors.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase from ee8b846 to ff259ba: correct the i64 casts commit message.

@TheBlueMatt
TheBlueMatt removed their request for review March 18, 2025 19:13
value_to_self_msat_offset -= htlc.amount_msat as i64;
},
OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) |
OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

AwaitingRemovedRemoteRevoke isn't a tautology because it is always !include even if generated_by_local.

@tankyleotankyleoMar 24, 2025

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.

I don't think I make any changes to that variant ? As before, always subtract from the offset.

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.

Maybe I'm off on the vocabulary, the tautology to me is the !generated_by_local expression below.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sheesh I was more tired than I thought :(

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.

no problem

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Otherwise lgtm

if msg.htlc_signatures.len() != commitment_stats.num_nondust_htlcs {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_stats.num_nondust_htlcs)));
if msg.htlc_signatures.len() != commitment_data.stats.tx.htlcs().len() {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_data.stats.tx.htlcs().len())));

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

In a followup can we rename htlcs to nondust_htlcs or so? Would add a lot of clarity in a few places.

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.

100%

@TheBlueMatt
TheBlueMatt merged commit 5fe72b5 into lightningdevkit:mainMar 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

weekly goalSomeone wants to land this this week

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

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

[Custom Transactions] Commitment Transaction & Channel Refactors - #3606

Merged
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder
Mar 25, 2025
Merged

[Custom Transactions] Commitment Transaction & Channel Refactors#3606
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder

Conversation

@tankyleo

@tankyleotankyleo commented Feb 18, 2025

Copy link
Copy Markdown
Contributor

Miscellaneous refactors of CommitmentTranscation and channel in preparation for the upcoming TxBuilder trait. See the commit messages.

@tankyleotankyleo mentioned this pull request Feb 18, 2025
24 tasks
@arik-so

Copy link
Copy Markdown
Contributor

Do you also wanna add the cfg-gate to the CI testing configs?

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Do you also wanna add the cfg-gate to the CI testing configs?

Thank you done

@codecov

codecovBot commented Feb 19, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 97.97297% with 3 lines in your changes missing coverage. Please review.

Project coverage is 89.25%. Comparing base (4c43a5b) to head (1b5bcb0).

Files with missing linesPatch %Lines
lightning/src/ln/channel.rs97.11%2 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3606 +/- ##
==========================================
+ Coverage 89.18% 89.25% +0.06% 
==========================================
Files 155 155 Lines 119274 119206 -68 Branches 119274 119206 -68 ==========================================
+ Hits 106379 106393 +14 + Misses 10290 10223 -67 + Partials 2605 2590 -15 

☔ 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.

Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleotankyleo changed the title [Custom Transactions] Define ChannelParameters, TxBuilder traits[Custom Transactions] Define the TxBuilder traitFeb 20, 2025
@tankyleo

tankyleo commented Feb 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Rebase:

  • Remove the ChannelParameters trait - focus on the basics for now, we can add the bells and whistles later, as needed.
  • Add the trimmed_value_sat parameter to build_commitment_transaction to cover the case where the sum of the trimmed outputs gets added to an ephemeral anchor output.
  • Add ChannelSigner::derive_tx_builder method. For now we specify the exact type to return, can be made generic later.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Notes:

  • First commit defines the API, then second commit demonstrates a full integration of this API into the codebase. This is so that we can have more context for the API discussion, happy to drop it. It does not change the public API, but does require changes to persistence.
  • ChannelContext::build_commitment_transaction sorts the htlcs based on their state,
  • then TxBuilder::build_commitment_transaction sorts the htlcs based on the dust limit.
  • Now we do not tell TxBuilder the trimmed value - TxBuilder decides this - but does it need to let us know the trimmed value? I don't see an immediate need.
  • We now return CommitmentStats, but without the preimages.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@jkczyzjkczyz added the weekly goal Someone wants to land this this week label Feb 27, 2025
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Note that this PR now breaks the public API of CommitmentTransaction.

@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 2 times, most recently from 035e35f to 42d5a79CompareFebruary 27, 2025 21:26
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/chan_utils.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
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 Outdated
Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/chan_utils.rs Outdated
@tankyleo
tankyleo requested a review from wpaulinoMarch 4, 2025 06:40
@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 3 times, most recently from d9c7ba9 to 9a1997aCompareMarch 6, 2025 21:02
@tankyleo

tankyleo commented Mar 6, 2025

Copy link
Copy Markdown
ContributorAuthor

@wpaulino just chatted with @TheBlueMatt offline some takeaways:

  • TxBuilder takes a Vec<HTLCOutputInCommitment>, then channel does a brute force search to populate the output indices. We are ok with the performance.
  • When / if we refactor ChannelTransactionParameters to get rid of all these unwraps, as you suggested, we can include the dust limits in the parameters too, and drop one more field. Does not have to happen before this PR.
  • I will immediately drop the channel_value_satoshis field, and take it from ChannelTransactionParameters.

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase: switch from saturating subs to checked subs, update comments, delete broken test vector.

TheBlueMatt
TheBlueMatt previously approved these changes Mar 14, 2025
The `DirectedChannelTransactionParameters` argument of the
`CommitmentTransaction` constructor already contains the broadcaster,
and the countersignatory public keys, which include the respective
funding keys.
It is therefore not necessary to ask for these funding keys in
additional arguments.
Instead of asking callers to generate the `TxCreationKeys` on every new
commitment before constructing a `CommitmentTransaction`, this commit
lets `CommitmentTransaction` derive the `TxCreationKeys` it will use to
build the raw commitment transaction.
This allows a tighter coupling between the per-commitment keys, and the
corresponding commitment transaction.
As new states are generated, callers now only have to derive new
commitment points; `CommitmentTransaction` takes care of deriving the
per-commitment keys.
This commit also serves to limit the objects in LDK that derive
per-commitment keys according to the LN Specification in preparation
for enabling custom derivations in the future.
Channel objects should not impose a particular per-commitment derivation
scheme on the builders of commitment transactions. This will make it
easier to enable custom derivations in the future.
Instead of building `TxCreationKeys` explicitly, the function
`TrustedCommitmentTransaction::keys` should be used when the keys of the
commitment transaction are needed. We do that in this commit.
The logging for loop in `send_commitment_no_state_update` only iterates
over the non-dust HTLCs. Thus we do not need to create a
`Vec<HTLCOutputInCommitment>` that includes both dust and non-dust
HTLCs, we can grab the `Vec<HTLCOutputInCommitment>` that holds only
non-dust HTLCs directly from `CommitmentTransaction`.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

In case it helps, git diff 4605318 fe0f94c contains the changes from Wilmer's last approval.

Then the fe0f94c to ee8b846 is a rebase on main where I fix some conflicts in channel monitor.

Instead of converting operands to `i64` and checking if the subtractions
overflowed by checking if the `i64` is smaller than zero, we instead
choose to do checked and saturating subtractions on the original
unsigned integers.
There is no need for an if statement if it will always be true.
The fields `feerate_per_kw` and `num_nondust_htlcs` of `CommitmentStats`
can both be accessed directly from the `tx: CommitmentTransaction`
field.
We also take this opportunity to rename the balance fields to make it
extra clear what they refer to.
We choose to include in `CommitmentStats` only fields that will be
calculated or constructed by transaction builders.
The other fields are created by channel, and placed in a new struct
we call `CommitmentData`.
The saturating subtractions used in
`ChannelContext::build_commitment_transaction` are there for a reason;
when the remote party updates the fees, we build the new commitment
transaction before checking whether the remote party has enough balance
to cover the new fee, so we cannot guarantee that the remote party's
balance will be greater than or equal to the sum of the fee and the
anchors.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase from ee8b846 to ff259ba: correct the i64 casts commit message.

@TheBlueMatt
TheBlueMatt removed their request for review March 18, 2025 19:13
value_to_self_msat_offset -= htlc.amount_msat as i64;
},
OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) |
OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

AwaitingRemovedRemoteRevoke isn't a tautology because it is always !include even if generated_by_local.

@tankyleotankyleoMar 24, 2025

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.

I don't think I make any changes to that variant ? As before, always subtract from the offset.

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.

Maybe I'm off on the vocabulary, the tautology to me is the !generated_by_local expression below.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sheesh I was more tired than I thought :(

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.

no problem

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Otherwise lgtm

if msg.htlc_signatures.len() != commitment_stats.num_nondust_htlcs {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_stats.num_nondust_htlcs)));
if msg.htlc_signatures.len() != commitment_data.stats.tx.htlcs().len() {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_data.stats.tx.htlcs().len())));

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

In a followup can we rename htlcs to nondust_htlcs or so? Would add a lot of clarity in a few places.

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.

100%

@TheBlueMatt
TheBlueMatt merged commit 5fe72b5 into lightningdevkit:mainMar 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

weekly goalSomeone wants to land this this week

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

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

[Custom Transactions] Commitment Transaction & Channel Refactors - #3606

Merged
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder
Mar 25, 2025
Merged

[Custom Transactions] Commitment Transaction & Channel Refactors#3606
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder

Conversation

@tankyleo

@tankyleotankyleo commented Feb 18, 2025

Copy link
Copy Markdown
Contributor

Miscellaneous refactors of CommitmentTranscation and channel in preparation for the upcoming TxBuilder trait. See the commit messages.

@tankyleotankyleo mentioned this pull request Feb 18, 2025
24 tasks
@arik-so

Copy link
Copy Markdown
Contributor

Do you also wanna add the cfg-gate to the CI testing configs?

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Do you also wanna add the cfg-gate to the CI testing configs?

Thank you done

@codecov

codecovBot commented Feb 19, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 97.97297% with 3 lines in your changes missing coverage. Please review.

Project coverage is 89.25%. Comparing base (4c43a5b) to head (1b5bcb0).

Files with missing linesPatch %Lines
lightning/src/ln/channel.rs97.11%2 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3606 +/- ##
==========================================
+ Coverage 89.18% 89.25% +0.06% 
==========================================
Files 155 155 Lines 119274 119206 -68 Branches 119274 119206 -68 ==========================================
+ Hits 106379 106393 +14 + Misses 10290 10223 -67 + Partials 2605 2590 -15 

☔ 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.

Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleotankyleo changed the title [Custom Transactions] Define ChannelParameters, TxBuilder traits[Custom Transactions] Define the TxBuilder traitFeb 20, 2025
@tankyleo

tankyleo commented Feb 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Rebase:

  • Remove the ChannelParameters trait - focus on the basics for now, we can add the bells and whistles later, as needed.
  • Add the trimmed_value_sat parameter to build_commitment_transaction to cover the case where the sum of the trimmed outputs gets added to an ephemeral anchor output.
  • Add ChannelSigner::derive_tx_builder method. For now we specify the exact type to return, can be made generic later.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Notes:

  • First commit defines the API, then second commit demonstrates a full integration of this API into the codebase. This is so that we can have more context for the API discussion, happy to drop it. It does not change the public API, but does require changes to persistence.
  • ChannelContext::build_commitment_transaction sorts the htlcs based on their state,
  • then TxBuilder::build_commitment_transaction sorts the htlcs based on the dust limit.
  • Now we do not tell TxBuilder the trimmed value - TxBuilder decides this - but does it need to let us know the trimmed value? I don't see an immediate need.
  • We now return CommitmentStats, but without the preimages.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@jkczyzjkczyz added the weekly goal Someone wants to land this this week label Feb 27, 2025
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Note that this PR now breaks the public API of CommitmentTransaction.

@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 2 times, most recently from 035e35f to 42d5a79CompareFebruary 27, 2025 21:26
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/chan_utils.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
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 Outdated
Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/chan_utils.rs Outdated
@tankyleo
tankyleo requested a review from wpaulinoMarch 4, 2025 06:40
@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 3 times, most recently from d9c7ba9 to 9a1997aCompareMarch 6, 2025 21:02
@tankyleo

tankyleo commented Mar 6, 2025

Copy link
Copy Markdown
ContributorAuthor

@wpaulino just chatted with @TheBlueMatt offline some takeaways:

  • TxBuilder takes a Vec<HTLCOutputInCommitment>, then channel does a brute force search to populate the output indices. We are ok with the performance.
  • When / if we refactor ChannelTransactionParameters to get rid of all these unwraps, as you suggested, we can include the dust limits in the parameters too, and drop one more field. Does not have to happen before this PR.
  • I will immediately drop the channel_value_satoshis field, and take it from ChannelTransactionParameters.

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase: switch from saturating subs to checked subs, update comments, delete broken test vector.

TheBlueMatt
TheBlueMatt previously approved these changes Mar 14, 2025
The `DirectedChannelTransactionParameters` argument of the
`CommitmentTransaction` constructor already contains the broadcaster,
and the countersignatory public keys, which include the respective
funding keys.
It is therefore not necessary to ask for these funding keys in
additional arguments.
Instead of asking callers to generate the `TxCreationKeys` on every new
commitment before constructing a `CommitmentTransaction`, this commit
lets `CommitmentTransaction` derive the `TxCreationKeys` it will use to
build the raw commitment transaction.
This allows a tighter coupling between the per-commitment keys, and the
corresponding commitment transaction.
As new states are generated, callers now only have to derive new
commitment points; `CommitmentTransaction` takes care of deriving the
per-commitment keys.
This commit also serves to limit the objects in LDK that derive
per-commitment keys according to the LN Specification in preparation
for enabling custom derivations in the future.
Channel objects should not impose a particular per-commitment derivation
scheme on the builders of commitment transactions. This will make it
easier to enable custom derivations in the future.
Instead of building `TxCreationKeys` explicitly, the function
`TrustedCommitmentTransaction::keys` should be used when the keys of the
commitment transaction are needed. We do that in this commit.
The logging for loop in `send_commitment_no_state_update` only iterates
over the non-dust HTLCs. Thus we do not need to create a
`Vec<HTLCOutputInCommitment>` that includes both dust and non-dust
HTLCs, we can grab the `Vec<HTLCOutputInCommitment>` that holds only
non-dust HTLCs directly from `CommitmentTransaction`.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

In case it helps, git diff 4605318 fe0f94c contains the changes from Wilmer's last approval.

Then the fe0f94c to ee8b846 is a rebase on main where I fix some conflicts in channel monitor.

Instead of converting operands to `i64` and checking if the subtractions
overflowed by checking if the `i64` is smaller than zero, we instead
choose to do checked and saturating subtractions on the original
unsigned integers.
There is no need for an if statement if it will always be true.
The fields `feerate_per_kw` and `num_nondust_htlcs` of `CommitmentStats`
can both be accessed directly from the `tx: CommitmentTransaction`
field.
We also take this opportunity to rename the balance fields to make it
extra clear what they refer to.
We choose to include in `CommitmentStats` only fields that will be
calculated or constructed by transaction builders.
The other fields are created by channel, and placed in a new struct
we call `CommitmentData`.
The saturating subtractions used in
`ChannelContext::build_commitment_transaction` are there for a reason;
when the remote party updates the fees, we build the new commitment
transaction before checking whether the remote party has enough balance
to cover the new fee, so we cannot guarantee that the remote party's
balance will be greater than or equal to the sum of the fee and the
anchors.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase from ee8b846 to ff259ba: correct the i64 casts commit message.

@TheBlueMatt
TheBlueMatt removed their request for review March 18, 2025 19:13
value_to_self_msat_offset -= htlc.amount_msat as i64;
},
OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) |
OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

AwaitingRemovedRemoteRevoke isn't a tautology because it is always !include even if generated_by_local.

@tankyleotankyleoMar 24, 2025

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.

I don't think I make any changes to that variant ? As before, always subtract from the offset.

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.

Maybe I'm off on the vocabulary, the tautology to me is the !generated_by_local expression below.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sheesh I was more tired than I thought :(

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.

no problem

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Otherwise lgtm

if msg.htlc_signatures.len() != commitment_stats.num_nondust_htlcs {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_stats.num_nondust_htlcs)));
if msg.htlc_signatures.len() != commitment_data.stats.tx.htlcs().len() {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_data.stats.tx.htlcs().len())));

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

In a followup can we rename htlcs to nondust_htlcs or so? Would add a lot of clarity in a few places.

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.

100%

@TheBlueMatt
TheBlueMatt merged commit 5fe72b5 into lightningdevkit:mainMar 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

weekly goalSomeone wants to land this this week

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

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

[Custom Transactions] Commitment Transaction & Channel Refactors - #3606

Merged
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder
Mar 25, 2025
Merged

[Custom Transactions] Commitment Transaction & Channel Refactors#3606
TheBlueMatt merged 10 commits into
lightningdevkit:mainfrom
tankyleo:25-02-tx-builder

Conversation

@tankyleo

@tankyleotankyleo commented Feb 18, 2025

Copy link
Copy Markdown
Contributor

Miscellaneous refactors of CommitmentTranscation and channel in preparation for the upcoming TxBuilder trait. See the commit messages.

@tankyleotankyleo mentioned this pull request Feb 18, 2025
24 tasks
@arik-so

Copy link
Copy Markdown
Contributor

Do you also wanna add the cfg-gate to the CI testing configs?

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Do you also wanna add the cfg-gate to the CI testing configs?

Thank you done

@codecov

codecovBot commented Feb 19, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 97.97297% with 3 lines in your changes missing coverage. Please review.

Project coverage is 89.25%. Comparing base (4c43a5b) to head (1b5bcb0).

Files with missing linesPatch %Lines
lightning/src/ln/channel.rs97.11%2 Missing and 1 partial ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3606 +/- ##
==========================================
+ Coverage 89.18% 89.25% +0.06% 
==========================================
Files 155 155 Lines 119274 119206 -68 Branches 119274 119206 -68 ==========================================
+ Hits 106379 106393 +14 + Misses 10290 10223 -67 + Partials 2605 2590 -15 

☔ 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.

Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleotankyleo changed the title [Custom Transactions] Define ChannelParameters, TxBuilder traits[Custom Transactions] Define the TxBuilder traitFeb 20, 2025
@tankyleo

tankyleo commented Feb 20, 2025

Copy link
Copy Markdown
ContributorAuthor

Rebase:

  • Remove the ChannelParameters trait - focus on the basics for now, we can add the bells and whistles later, as needed.
  • Add the trimmed_value_sat parameter to build_commitment_transaction to cover the case where the sum of the trimmed outputs gets added to an ephemeral anchor output.
  • Add ChannelSigner::derive_tx_builder method. For now we specify the exact type to return, can be made generic later.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Notes:

  • First commit defines the API, then second commit demonstrates a full integration of this API into the codebase. This is so that we can have more context for the API discussion, happy to drop it. It does not change the public API, but does require changes to persistence.
  • ChannelContext::build_commitment_transaction sorts the htlcs based on their state,
  • then TxBuilder::build_commitment_transaction sorts the htlcs based on the dust limit.
  • Now we do not tell TxBuilder the trimmed value - TxBuilder decides this - but does it need to let us know the trimmed value? I don't see an immediate need.
  • We now return CommitmentStats, but without the preimages.

Comment threadlightning/src/sign/tx_builder.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/sign/tx_builder.rs Outdated
@jkczyzjkczyz added the weekly goal Someone wants to land this this week label Feb 27, 2025
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Note that this PR now breaks the public API of CommitmentTransaction.

@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 2 times, most recently from 035e35f to 42d5a79CompareFebruary 27, 2025 21:26
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/channel.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
Comment threadlightning/src/ln/chan_utils.rs Outdated
Comment threadlightning/src/chain/channelmonitor.rs Outdated
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 Outdated
Comment threadlightning/src/ln/channel.rs
Comment threadlightning/src/ln/chan_utils.rs Outdated
@tankyleo
tankyleo requested a review from wpaulinoMarch 4, 2025 06:40
@tankyleo
tankyleoforce-pushed the 25-02-tx-builder branch 3 times, most recently from d9c7ba9 to 9a1997aCompareMarch 6, 2025 21:02
@tankyleo

tankyleo commented Mar 6, 2025

Copy link
Copy Markdown
ContributorAuthor

@wpaulino just chatted with @TheBlueMatt offline some takeaways:

  • TxBuilder takes a Vec<HTLCOutputInCommitment>, then channel does a brute force search to populate the output indices. We are ok with the performance.
  • When / if we refactor ChannelTransactionParameters to get rid of all these unwraps, as you suggested, we can include the dust limits in the parameters too, and drop one more field. Does not have to happen before this PR.
  • I will immediately drop the channel_value_satoshis field, and take it from ChannelTransactionParameters.

@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase: switch from saturating subs to checked subs, update comments, delete broken test vector.

TheBlueMatt
TheBlueMatt previously approved these changes Mar 14, 2025
The `DirectedChannelTransactionParameters` argument of the
`CommitmentTransaction` constructor already contains the broadcaster,
and the countersignatory public keys, which include the respective
funding keys.
It is therefore not necessary to ask for these funding keys in
additional arguments.
Instead of asking callers to generate the `TxCreationKeys` on every new
commitment before constructing a `CommitmentTransaction`, this commit
lets `CommitmentTransaction` derive the `TxCreationKeys` it will use to
build the raw commitment transaction.
This allows a tighter coupling between the per-commitment keys, and the
corresponding commitment transaction.
As new states are generated, callers now only have to derive new
commitment points; `CommitmentTransaction` takes care of deriving the
per-commitment keys.
This commit also serves to limit the objects in LDK that derive
per-commitment keys according to the LN Specification in preparation
for enabling custom derivations in the future.
Channel objects should not impose a particular per-commitment derivation
scheme on the builders of commitment transactions. This will make it
easier to enable custom derivations in the future.
Instead of building `TxCreationKeys` explicitly, the function
`TrustedCommitmentTransaction::keys` should be used when the keys of the
commitment transaction are needed. We do that in this commit.
The logging for loop in `send_commitment_no_state_update` only iterates
over the non-dust HTLCs. Thus we do not need to create a
`Vec<HTLCOutputInCommitment>` that includes both dust and non-dust
HTLCs, we can grab the `Vec<HTLCOutputInCommitment>` that holds only
non-dust HTLCs directly from `CommitmentTransaction`.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

In case it helps, git diff 4605318 fe0f94c contains the changes from Wilmer's last approval.

Then the fe0f94c to ee8b846 is a rebase on main where I fix some conflicts in channel monitor.

Instead of converting operands to `i64` and checking if the subtractions
overflowed by checking if the `i64` is smaller than zero, we instead
choose to do checked and saturating subtractions on the original
unsigned integers.
There is no need for an if statement if it will always be true.
The fields `feerate_per_kw` and `num_nondust_htlcs` of `CommitmentStats`
can both be accessed directly from the `tx: CommitmentTransaction`
field.
We also take this opportunity to rename the balance fields to make it
extra clear what they refer to.
We choose to include in `CommitmentStats` only fields that will be
calculated or constructed by transaction builders.
The other fields are created by channel, and placed in a new struct
we call `CommitmentData`.
The saturating subtractions used in
`ChannelContext::build_commitment_transaction` are there for a reason;
when the remote party updates the fees, we build the new commitment
transaction before checking whether the remote party has enough balance
to cover the new fee, so we cannot guarantee that the remote party's
balance will be greater than or equal to the sum of the fee and the
anchors.
@tankyleo

Copy link
Copy Markdown
ContributorAuthor

Rebase from ee8b846 to ff259ba: correct the i64 casts commit message.

@TheBlueMatt
TheBlueMatt removed their request for review March 18, 2025 19:13
value_to_self_msat_offset -= htlc.amount_msat as i64;
},
OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) |
OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

AwaitingRemovedRemoteRevoke isn't a tautology because it is always !include even if generated_by_local.

@tankyleotankyleoMar 24, 2025

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.

I don't think I make any changes to that variant ? As before, always subtract from the offset.

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.

Maybe I'm off on the vocabulary, the tautology to me is the !generated_by_local expression below.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sheesh I was more tired than I thought :(

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.

no problem

@TheBlueMattTheBlueMatt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Otherwise lgtm

if msg.htlc_signatures.len() != commitment_stats.num_nondust_htlcs {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_stats.num_nondust_htlcs)));
if msg.htlc_signatures.len() != commitment_data.stats.tx.htlcs().len() {
return Err(ChannelError::close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_data.stats.tx.htlcs().len())));

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

In a followup can we rename htlcs to nondust_htlcs or so? Would add a lot of clarity in a few places.

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.

100%

@TheBlueMatt
TheBlueMatt merged commit 5fe72b5 into lightningdevkit:mainMar 25, 2025
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

weekly goalSomeone wants to land this this week

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@tankyleo@arik-so@TheBlueMatt@wpaulino@jkczyz