Hold times for successful payments - #3801

Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times
Jul 18, 2025
Merged

Hold times for successful payments#3801
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times

Conversation

@joostjager

@joostjagerjoostjager commented May 26, 2025

Copy link
Copy Markdown
Contributor

Apply the hold time reporting mechanism as implemented in #2256 to the success case. Spec in lightning/bolts#1044

@ldk-reviews-bot

ldk-reviews-bot commented May 26, 2025

Copy link
Copy Markdown

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

@joostjagerjoostjager changed the title Successful payment hold timesHold times for successful paymentsMay 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 7 times, most recently from badc803 to e913312CompareMay 27, 2025 09:52
@codecov

codecovBot commented May 27, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 90.03378% with 177 lines in your changes missing coverage. Please review.

Project coverage is 89.13%. Comparing base (9863f29) to head (1994550).
Report is 2 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/channelmanager.rs90.43%86 Missing and 3 partials ⚠️
lightning/src/ln/channel.rs86.69%73 Missing and 14 partials ⚠️
lightning/src/ln/payment_tests.rs97.43%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3801 +/- ##
==========================================
+ Coverage 88.82% 89.13% +0.31% 
==========================================
Files 166 166 Lines 119487 123678 +4191 Branches 119487 123678 +4191 ==========================================
+ Hits 106136 110246 +4110 - Misses 11021 11104 +83 + Partials 2330 2328 -2 

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

@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 8 times, most recently from bace463 to 1c64a50CompareJune 26, 2025 13:52
@joostjager
joostjager marked this pull request as ready for review June 26, 2025 14:16
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjagerjoostjager self-assigned this Jun 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from 233cbfc to f5668f5CompareJune 30, 2025 09:36
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 3rd Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 4th Reminder

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

@joostjager

Copy link
Copy Markdown
ContributorAuthor

Rebased

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 5th Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 1st Reminder

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

@TheBlueMatt
TheBlueMatt self-requested a review July 16, 2025 16:20

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

Not super happy with how much this ended up touching but the hold times parts LGTM. The rustfmt part needs rebase, though, and I'm kinda skeptical of starting a PR with 1423 insertions(+), 570 deletions(-) when the rest of the PR is only 625 insertions(+), 196 deletions(-), seems like the rustfmt part should be separated out if you want to do it first.

let attribution_data = process_fulfill_attribution_data(
attribution_data.as_ref(),
&htlc.prev_hop.incoming_packet_shared_secret,
0,

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.

Ha, saved by the rounding :). Without the rounding this will clearly give away that we're a phantom node. As-is it instead can also be a peer that is within 100ms of us :)

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 am so happy 😅

Comment threadlightning/src/events/mod.rs Outdated
///
/// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
path: Path,
/// The hold times as reported by each hop.

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.

If we're going to expose this we really need to document in more detail what the values represent (100ms chunks where previous hops should encompass later hops' hold times) and how to use it (for deciding which node is slow in scoring, noting that our current scorer does not do this). Also, we should probably include it in PaymentPathFailed too?

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.

Docs added and hold_times exposed outside of tests in PaymentPathFailed.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Needs a rebase now that #3937 landed.

Preparation for reuse of the logic.
Need to store AttributionData as part of the inbound HTLC removal reason
so that it can be used in the upstream UpdateFulfillHTLC message.
Necessary to preserve attribution data when the HTLC is in the holding
cell.
Adds hold time reporting for the final and intermediate nodes.
AttributionData is needed as part of the outbound HTLC outcome when
revoke_and_ack has happened and the AttributionData is decoded to get
the hold times for inclusion in the PaymentPathSuccessful event.
Prepare for inspecting hold times in PaymentPathSuccessful.
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from a6c8603 to 4831900CompareJuly 17, 2025 11:14
@joostjager

joostjager commented Jul 17, 2025

Copy link
Copy Markdown
ContributorAuthor

Comments addressed diff

Hold times are surfaced via the PaymentPathSuccessful event.
Now that fulfill hold times are surfaced in the event always, this
commit follow ups with the failure hold times.

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

LGTM. A few nits but I'm happy to address them post-merge, there's probably a few other things I want to tweak post-merge (at least making the fulfill message passed in owned instead of reference to remove some clones).

}

fn duration_since_epoch() -> Option<Duration> {
pub(crate) fn duration_since_epoch() -> Option<Duration> {

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.

Its a bit confusing to use this in channelmanager.rs - we already have a ChannelManager::duration_since_epoch that uses the block time if we're built without time access, but also every call to hold_time takes the result of this call as the second argument, so it seems like this should just be inlined into hold_time (dunno if you'd want to rename it after doing so).

(58, self.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

(58, interactive_tx_signing_session, option), // Added in 0.2
(59, minimum_depth_override, option), // Added in 0.2
(60, historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

Comment on lines +13216 to +13217
(55, removed_htlc_attribution_data, optional_vec),
(57, holding_cell_attribution_data, optional_vec),

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.

These could get the added-in tag that exists on the write side too, while we're here.

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Mainly reviewed the diffs since my last LGTM. Nothing blocking 👍

);
check_added_monitors!(nodes[2], 1);
get_htlc_update_msgs!(nodes[2], node_b_id);
// Note that we don't populate fulfill_msg.attribution_data here, which will lead to hold times being

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it's putting the comment on the else, we could move it up a line?

/// milliseconds. So a hop reporting 2 is a hold time that corresponds to roughly 200 milliseconds. As earlier
/// hops hold on to an HTLC for longer, the hold times in the list are expected to decrease. When our peer
/// didn't provide attribution data, the list is empty. The same applies to HTLCs that were resolved onchain.
/// Because of unavailability of hold times, the list may be shorter than the number of hops in the path.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it might be useful to clarify that the hold time at idx 0 corresponds to the hop at path.hops[0], etc

@TheBlueMattTheBlueMatt mentioned this pull request Jul 18, 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

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants

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

Hold times for successful payments - #3801

Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times
Jul 18, 2025
Merged

Hold times for successful payments#3801
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times

Conversation

@joostjager

@joostjagerjoostjager commented May 26, 2025

Copy link
Copy Markdown
Contributor

Apply the hold time reporting mechanism as implemented in #2256 to the success case. Spec in lightning/bolts#1044

@ldk-reviews-bot

ldk-reviews-bot commented May 26, 2025

Copy link
Copy Markdown

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

@joostjagerjoostjager changed the title Successful payment hold timesHold times for successful paymentsMay 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 7 times, most recently from badc803 to e913312CompareMay 27, 2025 09:52
@codecov

codecovBot commented May 27, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 90.03378% with 177 lines in your changes missing coverage. Please review.

Project coverage is 89.13%. Comparing base (9863f29) to head (1994550).
Report is 2 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/channelmanager.rs90.43%86 Missing and 3 partials ⚠️
lightning/src/ln/channel.rs86.69%73 Missing and 14 partials ⚠️
lightning/src/ln/payment_tests.rs97.43%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3801 +/- ##
==========================================
+ Coverage 88.82% 89.13% +0.31% 
==========================================
Files 166 166 Lines 119487 123678 +4191 Branches 119487 123678 +4191 ==========================================
+ Hits 106136 110246 +4110 - Misses 11021 11104 +83 + Partials 2330 2328 -2 

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

@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 8 times, most recently from bace463 to 1c64a50CompareJune 26, 2025 13:52
@joostjager
joostjager marked this pull request as ready for review June 26, 2025 14:16
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjagerjoostjager self-assigned this Jun 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from 233cbfc to f5668f5CompareJune 30, 2025 09:36
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 3rd Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 4th Reminder

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

@joostjager

Copy link
Copy Markdown
ContributorAuthor

Rebased

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 5th Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 1st Reminder

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

@TheBlueMatt
TheBlueMatt self-requested a review July 16, 2025 16:20

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

Not super happy with how much this ended up touching but the hold times parts LGTM. The rustfmt part needs rebase, though, and I'm kinda skeptical of starting a PR with 1423 insertions(+), 570 deletions(-) when the rest of the PR is only 625 insertions(+), 196 deletions(-), seems like the rustfmt part should be separated out if you want to do it first.

let attribution_data = process_fulfill_attribution_data(
attribution_data.as_ref(),
&htlc.prev_hop.incoming_packet_shared_secret,
0,

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.

Ha, saved by the rounding :). Without the rounding this will clearly give away that we're a phantom node. As-is it instead can also be a peer that is within 100ms of us :)

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 am so happy 😅

Comment threadlightning/src/events/mod.rs Outdated
///
/// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
path: Path,
/// The hold times as reported by each hop.

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.

If we're going to expose this we really need to document in more detail what the values represent (100ms chunks where previous hops should encompass later hops' hold times) and how to use it (for deciding which node is slow in scoring, noting that our current scorer does not do this). Also, we should probably include it in PaymentPathFailed too?

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.

Docs added and hold_times exposed outside of tests in PaymentPathFailed.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Needs a rebase now that #3937 landed.

Preparation for reuse of the logic.
Need to store AttributionData as part of the inbound HTLC removal reason
so that it can be used in the upstream UpdateFulfillHTLC message.
Necessary to preserve attribution data when the HTLC is in the holding
cell.
Adds hold time reporting for the final and intermediate nodes.
AttributionData is needed as part of the outbound HTLC outcome when
revoke_and_ack has happened and the AttributionData is decoded to get
the hold times for inclusion in the PaymentPathSuccessful event.
Prepare for inspecting hold times in PaymentPathSuccessful.
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from a6c8603 to 4831900CompareJuly 17, 2025 11:14
@joostjager

joostjager commented Jul 17, 2025

Copy link
Copy Markdown
ContributorAuthor

Comments addressed diff

Hold times are surfaced via the PaymentPathSuccessful event.
Now that fulfill hold times are surfaced in the event always, this
commit follow ups with the failure hold times.

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

LGTM. A few nits but I'm happy to address them post-merge, there's probably a few other things I want to tweak post-merge (at least making the fulfill message passed in owned instead of reference to remove some clones).

}

fn duration_since_epoch() -> Option<Duration> {
pub(crate) fn duration_since_epoch() -> Option<Duration> {

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.

Its a bit confusing to use this in channelmanager.rs - we already have a ChannelManager::duration_since_epoch that uses the block time if we're built without time access, but also every call to hold_time takes the result of this call as the second argument, so it seems like this should just be inlined into hold_time (dunno if you'd want to rename it after doing so).

(58, self.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

(58, interactive_tx_signing_session, option), // Added in 0.2
(59, minimum_depth_override, option), // Added in 0.2
(60, historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

Comment on lines +13216 to +13217
(55, removed_htlc_attribution_data, optional_vec),
(57, holding_cell_attribution_data, optional_vec),

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.

These could get the added-in tag that exists on the write side too, while we're here.

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Mainly reviewed the diffs since my last LGTM. Nothing blocking 👍

);
check_added_monitors!(nodes[2], 1);
get_htlc_update_msgs!(nodes[2], node_b_id);
// Note that we don't populate fulfill_msg.attribution_data here, which will lead to hold times being

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it's putting the comment on the else, we could move it up a line?

/// milliseconds. So a hop reporting 2 is a hold time that corresponds to roughly 200 milliseconds. As earlier
/// hops hold on to an HTLC for longer, the hold times in the list are expected to decrease. When our peer
/// didn't provide attribution data, the list is empty. The same applies to HTLCs that were resolved onchain.
/// Because of unavailability of hold times, the list may be shorter than the number of hops in the path.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it might be useful to clarify that the hold time at idx 0 corresponds to the hop at path.hops[0], etc

@TheBlueMattTheBlueMatt mentioned this pull request Jul 18, 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

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants

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

Hold times for successful payments - #3801

Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times
Jul 18, 2025
Merged

Hold times for successful payments#3801
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times

Conversation

@joostjager

@joostjagerjoostjager commented May 26, 2025

Copy link
Copy Markdown
Contributor

Apply the hold time reporting mechanism as implemented in #2256 to the success case. Spec in lightning/bolts#1044

@ldk-reviews-bot

ldk-reviews-bot commented May 26, 2025

Copy link
Copy Markdown

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

@joostjagerjoostjager changed the title Successful payment hold timesHold times for successful paymentsMay 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 7 times, most recently from badc803 to e913312CompareMay 27, 2025 09:52
@codecov

codecovBot commented May 27, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 90.03378% with 177 lines in your changes missing coverage. Please review.

Project coverage is 89.13%. Comparing base (9863f29) to head (1994550).
Report is 2 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/channelmanager.rs90.43%86 Missing and 3 partials ⚠️
lightning/src/ln/channel.rs86.69%73 Missing and 14 partials ⚠️
lightning/src/ln/payment_tests.rs97.43%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3801 +/- ##
==========================================
+ Coverage 88.82% 89.13% +0.31% 
==========================================
Files 166 166 Lines 119487 123678 +4191 Branches 119487 123678 +4191 ==========================================
+ Hits 106136 110246 +4110 - Misses 11021 11104 +83 + Partials 2330 2328 -2 

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

@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 8 times, most recently from bace463 to 1c64a50CompareJune 26, 2025 13:52
@joostjager
joostjager marked this pull request as ready for review June 26, 2025 14:16
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjagerjoostjager self-assigned this Jun 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from 233cbfc to f5668f5CompareJune 30, 2025 09:36
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 3rd Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 4th Reminder

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

@joostjager

Copy link
Copy Markdown
ContributorAuthor

Rebased

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 5th Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 1st Reminder

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

@TheBlueMatt
TheBlueMatt self-requested a review July 16, 2025 16:20

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

Not super happy with how much this ended up touching but the hold times parts LGTM. The rustfmt part needs rebase, though, and I'm kinda skeptical of starting a PR with 1423 insertions(+), 570 deletions(-) when the rest of the PR is only 625 insertions(+), 196 deletions(-), seems like the rustfmt part should be separated out if you want to do it first.

let attribution_data = process_fulfill_attribution_data(
attribution_data.as_ref(),
&htlc.prev_hop.incoming_packet_shared_secret,
0,

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.

Ha, saved by the rounding :). Without the rounding this will clearly give away that we're a phantom node. As-is it instead can also be a peer that is within 100ms of us :)

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 am so happy 😅

Comment threadlightning/src/events/mod.rs Outdated
///
/// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
path: Path,
/// The hold times as reported by each hop.

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.

If we're going to expose this we really need to document in more detail what the values represent (100ms chunks where previous hops should encompass later hops' hold times) and how to use it (for deciding which node is slow in scoring, noting that our current scorer does not do this). Also, we should probably include it in PaymentPathFailed too?

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.

Docs added and hold_times exposed outside of tests in PaymentPathFailed.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Needs a rebase now that #3937 landed.

Preparation for reuse of the logic.
Need to store AttributionData as part of the inbound HTLC removal reason
so that it can be used in the upstream UpdateFulfillHTLC message.
Necessary to preserve attribution data when the HTLC is in the holding
cell.
Adds hold time reporting for the final and intermediate nodes.
AttributionData is needed as part of the outbound HTLC outcome when
revoke_and_ack has happened and the AttributionData is decoded to get
the hold times for inclusion in the PaymentPathSuccessful event.
Prepare for inspecting hold times in PaymentPathSuccessful.
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from a6c8603 to 4831900CompareJuly 17, 2025 11:14
@joostjager

joostjager commented Jul 17, 2025

Copy link
Copy Markdown
ContributorAuthor

Comments addressed diff

Hold times are surfaced via the PaymentPathSuccessful event.
Now that fulfill hold times are surfaced in the event always, this
commit follow ups with the failure hold times.

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

LGTM. A few nits but I'm happy to address them post-merge, there's probably a few other things I want to tweak post-merge (at least making the fulfill message passed in owned instead of reference to remove some clones).

}

fn duration_since_epoch() -> Option<Duration> {
pub(crate) fn duration_since_epoch() -> Option<Duration> {

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.

Its a bit confusing to use this in channelmanager.rs - we already have a ChannelManager::duration_since_epoch that uses the block time if we're built without time access, but also every call to hold_time takes the result of this call as the second argument, so it seems like this should just be inlined into hold_time (dunno if you'd want to rename it after doing so).

(58, self.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

(58, interactive_tx_signing_session, option), // Added in 0.2
(59, minimum_depth_override, option), // Added in 0.2
(60, historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

Comment on lines +13216 to +13217
(55, removed_htlc_attribution_data, optional_vec),
(57, holding_cell_attribution_data, optional_vec),

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.

These could get the added-in tag that exists on the write side too, while we're here.

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Mainly reviewed the diffs since my last LGTM. Nothing blocking 👍

);
check_added_monitors!(nodes[2], 1);
get_htlc_update_msgs!(nodes[2], node_b_id);
// Note that we don't populate fulfill_msg.attribution_data here, which will lead to hold times being

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it's putting the comment on the else, we could move it up a line?

/// milliseconds. So a hop reporting 2 is a hold time that corresponds to roughly 200 milliseconds. As earlier
/// hops hold on to an HTLC for longer, the hold times in the list are expected to decrease. When our peer
/// didn't provide attribution data, the list is empty. The same applies to HTLCs that were resolved onchain.
/// Because of unavailability of hold times, the list may be shorter than the number of hops in the path.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it might be useful to clarify that the hold time at idx 0 corresponds to the hop at path.hops[0], etc

@TheBlueMattTheBlueMatt mentioned this pull request Jul 18, 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

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants

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

Hold times for successful payments - #3801

Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times
Jul 18, 2025
Merged

Hold times for successful payments#3801
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times

Conversation

@joostjager

@joostjagerjoostjager commented May 26, 2025

Copy link
Copy Markdown
Contributor

Apply the hold time reporting mechanism as implemented in #2256 to the success case. Spec in lightning/bolts#1044

@ldk-reviews-bot

ldk-reviews-bot commented May 26, 2025

Copy link
Copy Markdown

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

@joostjagerjoostjager changed the title Successful payment hold timesHold times for successful paymentsMay 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 7 times, most recently from badc803 to e913312CompareMay 27, 2025 09:52
@codecov

codecovBot commented May 27, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 90.03378% with 177 lines in your changes missing coverage. Please review.

Project coverage is 89.13%. Comparing base (9863f29) to head (1994550).
Report is 2 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/channelmanager.rs90.43%86 Missing and 3 partials ⚠️
lightning/src/ln/channel.rs86.69%73 Missing and 14 partials ⚠️
lightning/src/ln/payment_tests.rs97.43%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3801 +/- ##
==========================================
+ Coverage 88.82% 89.13% +0.31% 
==========================================
Files 166 166 Lines 119487 123678 +4191 Branches 119487 123678 +4191 ==========================================
+ Hits 106136 110246 +4110 - Misses 11021 11104 +83 + Partials 2330 2328 -2 

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

@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 8 times, most recently from bace463 to 1c64a50CompareJune 26, 2025 13:52
@joostjager
joostjager marked this pull request as ready for review June 26, 2025 14:16
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjagerjoostjager self-assigned this Jun 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from 233cbfc to f5668f5CompareJune 30, 2025 09:36
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 3rd Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 4th Reminder

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

@joostjager

Copy link
Copy Markdown
ContributorAuthor

Rebased

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 5th Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 1st Reminder

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

@TheBlueMatt
TheBlueMatt self-requested a review July 16, 2025 16:20

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

Not super happy with how much this ended up touching but the hold times parts LGTM. The rustfmt part needs rebase, though, and I'm kinda skeptical of starting a PR with 1423 insertions(+), 570 deletions(-) when the rest of the PR is only 625 insertions(+), 196 deletions(-), seems like the rustfmt part should be separated out if you want to do it first.

let attribution_data = process_fulfill_attribution_data(
attribution_data.as_ref(),
&htlc.prev_hop.incoming_packet_shared_secret,
0,

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.

Ha, saved by the rounding :). Without the rounding this will clearly give away that we're a phantom node. As-is it instead can also be a peer that is within 100ms of us :)

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 am so happy 😅

Comment threadlightning/src/events/mod.rs Outdated
///
/// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
path: Path,
/// The hold times as reported by each hop.

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.

If we're going to expose this we really need to document in more detail what the values represent (100ms chunks where previous hops should encompass later hops' hold times) and how to use it (for deciding which node is slow in scoring, noting that our current scorer does not do this). Also, we should probably include it in PaymentPathFailed too?

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.

Docs added and hold_times exposed outside of tests in PaymentPathFailed.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Needs a rebase now that #3937 landed.

Preparation for reuse of the logic.
Need to store AttributionData as part of the inbound HTLC removal reason
so that it can be used in the upstream UpdateFulfillHTLC message.
Necessary to preserve attribution data when the HTLC is in the holding
cell.
Adds hold time reporting for the final and intermediate nodes.
AttributionData is needed as part of the outbound HTLC outcome when
revoke_and_ack has happened and the AttributionData is decoded to get
the hold times for inclusion in the PaymentPathSuccessful event.
Prepare for inspecting hold times in PaymentPathSuccessful.
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from a6c8603 to 4831900CompareJuly 17, 2025 11:14
@joostjager

joostjager commented Jul 17, 2025

Copy link
Copy Markdown
ContributorAuthor

Comments addressed diff

Hold times are surfaced via the PaymentPathSuccessful event.
Now that fulfill hold times are surfaced in the event always, this
commit follow ups with the failure hold times.

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

LGTM. A few nits but I'm happy to address them post-merge, there's probably a few other things I want to tweak post-merge (at least making the fulfill message passed in owned instead of reference to remove some clones).

}

fn duration_since_epoch() -> Option<Duration> {
pub(crate) fn duration_since_epoch() -> Option<Duration> {

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.

Its a bit confusing to use this in channelmanager.rs - we already have a ChannelManager::duration_since_epoch that uses the block time if we're built without time access, but also every call to hold_time takes the result of this call as the second argument, so it seems like this should just be inlined into hold_time (dunno if you'd want to rename it after doing so).

(58, self.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

(58, interactive_tx_signing_session, option), // Added in 0.2
(59, minimum_depth_override, option), // Added in 0.2
(60, historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

Comment on lines +13216 to +13217
(55, removed_htlc_attribution_data, optional_vec),
(57, holding_cell_attribution_data, optional_vec),

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.

These could get the added-in tag that exists on the write side too, while we're here.

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Mainly reviewed the diffs since my last LGTM. Nothing blocking 👍

);
check_added_monitors!(nodes[2], 1);
get_htlc_update_msgs!(nodes[2], node_b_id);
// Note that we don't populate fulfill_msg.attribution_data here, which will lead to hold times being

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it's putting the comment on the else, we could move it up a line?

/// milliseconds. So a hop reporting 2 is a hold time that corresponds to roughly 200 milliseconds. As earlier
/// hops hold on to an HTLC for longer, the hold times in the list are expected to decrease. When our peer
/// didn't provide attribution data, the list is empty. The same applies to HTLCs that were resolved onchain.
/// Because of unavailability of hold times, the list may be shorter than the number of hops in the path.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it might be useful to clarify that the hold time at idx 0 corresponds to the hop at path.hops[0], etc

@TheBlueMattTheBlueMatt mentioned this pull request Jul 18, 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

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants

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

Hold times for successful payments - #3801

Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times
Jul 18, 2025
Merged

Hold times for successful payments#3801
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times

Conversation

@joostjager

@joostjagerjoostjager commented May 26, 2025

Copy link
Copy Markdown
Contributor

Apply the hold time reporting mechanism as implemented in #2256 to the success case. Spec in lightning/bolts#1044

@ldk-reviews-bot

ldk-reviews-bot commented May 26, 2025

Copy link
Copy Markdown

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

@joostjagerjoostjager changed the title Successful payment hold timesHold times for successful paymentsMay 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 7 times, most recently from badc803 to e913312CompareMay 27, 2025 09:52
@codecov

codecovBot commented May 27, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 90.03378% with 177 lines in your changes missing coverage. Please review.

Project coverage is 89.13%. Comparing base (9863f29) to head (1994550).
Report is 2 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/channelmanager.rs90.43%86 Missing and 3 partials ⚠️
lightning/src/ln/channel.rs86.69%73 Missing and 14 partials ⚠️
lightning/src/ln/payment_tests.rs97.43%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3801 +/- ##
==========================================
+ Coverage 88.82% 89.13% +0.31% 
==========================================
Files 166 166 Lines 119487 123678 +4191 Branches 119487 123678 +4191 ==========================================
+ Hits 106136 110246 +4110 - Misses 11021 11104 +83 + Partials 2330 2328 -2 

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

@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 8 times, most recently from bace463 to 1c64a50CompareJune 26, 2025 13:52
@joostjager
joostjager marked this pull request as ready for review June 26, 2025 14:16
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjagerjoostjager self-assigned this Jun 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from 233cbfc to f5668f5CompareJune 30, 2025 09:36
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 3rd Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 4th Reminder

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

@joostjager

Copy link
Copy Markdown
ContributorAuthor

Rebased

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 5th Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 1st Reminder

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

@TheBlueMatt
TheBlueMatt self-requested a review July 16, 2025 16:20

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

Not super happy with how much this ended up touching but the hold times parts LGTM. The rustfmt part needs rebase, though, and I'm kinda skeptical of starting a PR with 1423 insertions(+), 570 deletions(-) when the rest of the PR is only 625 insertions(+), 196 deletions(-), seems like the rustfmt part should be separated out if you want to do it first.

let attribution_data = process_fulfill_attribution_data(
attribution_data.as_ref(),
&htlc.prev_hop.incoming_packet_shared_secret,
0,

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.

Ha, saved by the rounding :). Without the rounding this will clearly give away that we're a phantom node. As-is it instead can also be a peer that is within 100ms of us :)

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 am so happy 😅

Comment threadlightning/src/events/mod.rs Outdated
///
/// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
path: Path,
/// The hold times as reported by each hop.

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.

If we're going to expose this we really need to document in more detail what the values represent (100ms chunks where previous hops should encompass later hops' hold times) and how to use it (for deciding which node is slow in scoring, noting that our current scorer does not do this). Also, we should probably include it in PaymentPathFailed too?

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.

Docs added and hold_times exposed outside of tests in PaymentPathFailed.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Needs a rebase now that #3937 landed.

Preparation for reuse of the logic.
Need to store AttributionData as part of the inbound HTLC removal reason
so that it can be used in the upstream UpdateFulfillHTLC message.
Necessary to preserve attribution data when the HTLC is in the holding
cell.
Adds hold time reporting for the final and intermediate nodes.
AttributionData is needed as part of the outbound HTLC outcome when
revoke_and_ack has happened and the AttributionData is decoded to get
the hold times for inclusion in the PaymentPathSuccessful event.
Prepare for inspecting hold times in PaymentPathSuccessful.
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from a6c8603 to 4831900CompareJuly 17, 2025 11:14
@joostjager

joostjager commented Jul 17, 2025

Copy link
Copy Markdown
ContributorAuthor

Comments addressed diff

Hold times are surfaced via the PaymentPathSuccessful event.
Now that fulfill hold times are surfaced in the event always, this
commit follow ups with the failure hold times.

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

LGTM. A few nits but I'm happy to address them post-merge, there's probably a few other things I want to tweak post-merge (at least making the fulfill message passed in owned instead of reference to remove some clones).

}

fn duration_since_epoch() -> Option<Duration> {
pub(crate) fn duration_since_epoch() -> Option<Duration> {

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.

Its a bit confusing to use this in channelmanager.rs - we already have a ChannelManager::duration_since_epoch that uses the block time if we're built without time access, but also every call to hold_time takes the result of this call as the second argument, so it seems like this should just be inlined into hold_time (dunno if you'd want to rename it after doing so).

(58, self.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

(58, interactive_tx_signing_session, option), // Added in 0.2
(59, minimum_depth_override, option), // Added in 0.2
(60, historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

Comment on lines +13216 to +13217
(55, removed_htlc_attribution_data, optional_vec),
(57, holding_cell_attribution_data, optional_vec),

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.

These could get the added-in tag that exists on the write side too, while we're here.

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Mainly reviewed the diffs since my last LGTM. Nothing blocking 👍

);
check_added_monitors!(nodes[2], 1);
get_htlc_update_msgs!(nodes[2], node_b_id);
// Note that we don't populate fulfill_msg.attribution_data here, which will lead to hold times being

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it's putting the comment on the else, we could move it up a line?

/// milliseconds. So a hop reporting 2 is a hold time that corresponds to roughly 200 milliseconds. As earlier
/// hops hold on to an HTLC for longer, the hold times in the list are expected to decrease. When our peer
/// didn't provide attribution data, the list is empty. The same applies to HTLCs that were resolved onchain.
/// Because of unavailability of hold times, the list may be shorter than the number of hops in the path.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it might be useful to clarify that the hold time at idx 0 corresponds to the hop at path.hops[0], etc

@TheBlueMattTheBlueMatt mentioned this pull request Jul 18, 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

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants

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

Hold times for successful payments - #3801

Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times
Jul 18, 2025
Merged

Hold times for successful payments#3801
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times

Conversation

@joostjager

@joostjagerjoostjager commented May 26, 2025

Copy link
Copy Markdown
Contributor

Apply the hold time reporting mechanism as implemented in #2256 to the success case. Spec in lightning/bolts#1044

@ldk-reviews-bot

ldk-reviews-bot commented May 26, 2025

Copy link
Copy Markdown

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

@joostjagerjoostjager changed the title Successful payment hold timesHold times for successful paymentsMay 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 7 times, most recently from badc803 to e913312CompareMay 27, 2025 09:52
@codecov

codecovBot commented May 27, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 90.03378% with 177 lines in your changes missing coverage. Please review.

Project coverage is 89.13%. Comparing base (9863f29) to head (1994550).
Report is 2 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/channelmanager.rs90.43%86 Missing and 3 partials ⚠️
lightning/src/ln/channel.rs86.69%73 Missing and 14 partials ⚠️
lightning/src/ln/payment_tests.rs97.43%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3801 +/- ##
==========================================
+ Coverage 88.82% 89.13% +0.31% 
==========================================
Files 166 166 Lines 119487 123678 +4191 Branches 119487 123678 +4191 ==========================================
+ Hits 106136 110246 +4110 - Misses 11021 11104 +83 + Partials 2330 2328 -2 

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

@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 8 times, most recently from bace463 to 1c64a50CompareJune 26, 2025 13:52
@joostjager
joostjager marked this pull request as ready for review June 26, 2025 14:16
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjagerjoostjager self-assigned this Jun 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from 233cbfc to f5668f5CompareJune 30, 2025 09:36
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 3rd Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 4th Reminder

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

@joostjager

Copy link
Copy Markdown
ContributorAuthor

Rebased

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 5th Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 1st Reminder

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

@TheBlueMatt
TheBlueMatt self-requested a review July 16, 2025 16:20

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

Not super happy with how much this ended up touching but the hold times parts LGTM. The rustfmt part needs rebase, though, and I'm kinda skeptical of starting a PR with 1423 insertions(+), 570 deletions(-) when the rest of the PR is only 625 insertions(+), 196 deletions(-), seems like the rustfmt part should be separated out if you want to do it first.

let attribution_data = process_fulfill_attribution_data(
attribution_data.as_ref(),
&htlc.prev_hop.incoming_packet_shared_secret,
0,

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.

Ha, saved by the rounding :). Without the rounding this will clearly give away that we're a phantom node. As-is it instead can also be a peer that is within 100ms of us :)

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 am so happy 😅

Comment threadlightning/src/events/mod.rs Outdated
///
/// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
path: Path,
/// The hold times as reported by each hop.

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.

If we're going to expose this we really need to document in more detail what the values represent (100ms chunks where previous hops should encompass later hops' hold times) and how to use it (for deciding which node is slow in scoring, noting that our current scorer does not do this). Also, we should probably include it in PaymentPathFailed too?

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.

Docs added and hold_times exposed outside of tests in PaymentPathFailed.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Needs a rebase now that #3937 landed.

Preparation for reuse of the logic.
Need to store AttributionData as part of the inbound HTLC removal reason
so that it can be used in the upstream UpdateFulfillHTLC message.
Necessary to preserve attribution data when the HTLC is in the holding
cell.
Adds hold time reporting for the final and intermediate nodes.
AttributionData is needed as part of the outbound HTLC outcome when
revoke_and_ack has happened and the AttributionData is decoded to get
the hold times for inclusion in the PaymentPathSuccessful event.
Prepare for inspecting hold times in PaymentPathSuccessful.
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from a6c8603 to 4831900CompareJuly 17, 2025 11:14
@joostjager

joostjager commented Jul 17, 2025

Copy link
Copy Markdown
ContributorAuthor

Comments addressed diff

Hold times are surfaced via the PaymentPathSuccessful event.
Now that fulfill hold times are surfaced in the event always, this
commit follow ups with the failure hold times.

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

LGTM. A few nits but I'm happy to address them post-merge, there's probably a few other things I want to tweak post-merge (at least making the fulfill message passed in owned instead of reference to remove some clones).

}

fn duration_since_epoch() -> Option<Duration> {
pub(crate) fn duration_since_epoch() -> Option<Duration> {

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.

Its a bit confusing to use this in channelmanager.rs - we already have a ChannelManager::duration_since_epoch that uses the block time if we're built without time access, but also every call to hold_time takes the result of this call as the second argument, so it seems like this should just be inlined into hold_time (dunno if you'd want to rename it after doing so).

(58, self.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

(58, interactive_tx_signing_session, option), // Added in 0.2
(59, minimum_depth_override, option), // Added in 0.2
(60, historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

Comment on lines +13216 to +13217
(55, removed_htlc_attribution_data, optional_vec),
(57, holding_cell_attribution_data, optional_vec),

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.

These could get the added-in tag that exists on the write side too, while we're here.

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Mainly reviewed the diffs since my last LGTM. Nothing blocking 👍

);
check_added_monitors!(nodes[2], 1);
get_htlc_update_msgs!(nodes[2], node_b_id);
// Note that we don't populate fulfill_msg.attribution_data here, which will lead to hold times being

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it's putting the comment on the else, we could move it up a line?

/// milliseconds. So a hop reporting 2 is a hold time that corresponds to roughly 200 milliseconds. As earlier
/// hops hold on to an HTLC for longer, the hold times in the list are expected to decrease. When our peer
/// didn't provide attribution data, the list is empty. The same applies to HTLCs that were resolved onchain.
/// Because of unavailability of hold times, the list may be shorter than the number of hops in the path.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it might be useful to clarify that the hold time at idx 0 corresponds to the hop at path.hops[0], etc

@TheBlueMattTheBlueMatt mentioned this pull request Jul 18, 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

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants

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

Hold times for successful payments - #3801

Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times
Jul 18, 2025
Merged

Hold times for successful payments#3801
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times

Conversation

@joostjager

@joostjagerjoostjager commented May 26, 2025

Copy link
Copy Markdown
Contributor

Apply the hold time reporting mechanism as implemented in #2256 to the success case. Spec in lightning/bolts#1044

@ldk-reviews-bot

ldk-reviews-bot commented May 26, 2025

Copy link
Copy Markdown

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

@joostjagerjoostjager changed the title Successful payment hold timesHold times for successful paymentsMay 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 7 times, most recently from badc803 to e913312CompareMay 27, 2025 09:52
@codecov

codecovBot commented May 27, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 90.03378% with 177 lines in your changes missing coverage. Please review.

Project coverage is 89.13%. Comparing base (9863f29) to head (1994550).
Report is 2 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/channelmanager.rs90.43%86 Missing and 3 partials ⚠️
lightning/src/ln/channel.rs86.69%73 Missing and 14 partials ⚠️
lightning/src/ln/payment_tests.rs97.43%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3801 +/- ##
==========================================
+ Coverage 88.82% 89.13% +0.31% 
==========================================
Files 166 166 Lines 119487 123678 +4191 Branches 119487 123678 +4191 ==========================================
+ Hits 106136 110246 +4110 - Misses 11021 11104 +83 + Partials 2330 2328 -2 

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

@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 8 times, most recently from bace463 to 1c64a50CompareJune 26, 2025 13:52
@joostjager
joostjager marked this pull request as ready for review June 26, 2025 14:16
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjagerjoostjager self-assigned this Jun 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from 233cbfc to f5668f5CompareJune 30, 2025 09:36
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 3rd Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 4th Reminder

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

@joostjager

Copy link
Copy Markdown
ContributorAuthor

Rebased

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 5th Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 1st Reminder

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

@TheBlueMatt
TheBlueMatt self-requested a review July 16, 2025 16:20

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

Not super happy with how much this ended up touching but the hold times parts LGTM. The rustfmt part needs rebase, though, and I'm kinda skeptical of starting a PR with 1423 insertions(+), 570 deletions(-) when the rest of the PR is only 625 insertions(+), 196 deletions(-), seems like the rustfmt part should be separated out if you want to do it first.

let attribution_data = process_fulfill_attribution_data(
attribution_data.as_ref(),
&htlc.prev_hop.incoming_packet_shared_secret,
0,

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.

Ha, saved by the rounding :). Without the rounding this will clearly give away that we're a phantom node. As-is it instead can also be a peer that is within 100ms of us :)

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 am so happy 😅

Comment threadlightning/src/events/mod.rs Outdated
///
/// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
path: Path,
/// The hold times as reported by each hop.

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.

If we're going to expose this we really need to document in more detail what the values represent (100ms chunks where previous hops should encompass later hops' hold times) and how to use it (for deciding which node is slow in scoring, noting that our current scorer does not do this). Also, we should probably include it in PaymentPathFailed too?

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.

Docs added and hold_times exposed outside of tests in PaymentPathFailed.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Needs a rebase now that #3937 landed.

Preparation for reuse of the logic.
Need to store AttributionData as part of the inbound HTLC removal reason
so that it can be used in the upstream UpdateFulfillHTLC message.
Necessary to preserve attribution data when the HTLC is in the holding
cell.
Adds hold time reporting for the final and intermediate nodes.
AttributionData is needed as part of the outbound HTLC outcome when
revoke_and_ack has happened and the AttributionData is decoded to get
the hold times for inclusion in the PaymentPathSuccessful event.
Prepare for inspecting hold times in PaymentPathSuccessful.
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from a6c8603 to 4831900CompareJuly 17, 2025 11:14
@joostjager

joostjager commented Jul 17, 2025

Copy link
Copy Markdown
ContributorAuthor

Comments addressed diff

Hold times are surfaced via the PaymentPathSuccessful event.
Now that fulfill hold times are surfaced in the event always, this
commit follow ups with the failure hold times.

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

LGTM. A few nits but I'm happy to address them post-merge, there's probably a few other things I want to tweak post-merge (at least making the fulfill message passed in owned instead of reference to remove some clones).

}

fn duration_since_epoch() -> Option<Duration> {
pub(crate) fn duration_since_epoch() -> Option<Duration> {

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.

Its a bit confusing to use this in channelmanager.rs - we already have a ChannelManager::duration_since_epoch that uses the block time if we're built without time access, but also every call to hold_time takes the result of this call as the second argument, so it seems like this should just be inlined into hold_time (dunno if you'd want to rename it after doing so).

(58, self.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

(58, interactive_tx_signing_session, option), // Added in 0.2
(59, minimum_depth_override, option), // Added in 0.2
(60, historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

Comment on lines +13216 to +13217
(55, removed_htlc_attribution_data, optional_vec),
(57, holding_cell_attribution_data, optional_vec),

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.

These could get the added-in tag that exists on the write side too, while we're here.

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Mainly reviewed the diffs since my last LGTM. Nothing blocking 👍

);
check_added_monitors!(nodes[2], 1);
get_htlc_update_msgs!(nodes[2], node_b_id);
// Note that we don't populate fulfill_msg.attribution_data here, which will lead to hold times being

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it's putting the comment on the else, we could move it up a line?

/// milliseconds. So a hop reporting 2 is a hold time that corresponds to roughly 200 milliseconds. As earlier
/// hops hold on to an HTLC for longer, the hold times in the list are expected to decrease. When our peer
/// didn't provide attribution data, the list is empty. The same applies to HTLCs that were resolved onchain.
/// Because of unavailability of hold times, the list may be shorter than the number of hops in the path.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it might be useful to clarify that the hold time at idx 0 corresponds to the hop at path.hops[0], etc

@TheBlueMattTheBlueMatt mentioned this pull request Jul 18, 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

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants

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

Hold times for successful payments - #3801

Merged
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times
Jul 18, 2025
Merged

Hold times for successful payments#3801
TheBlueMatt merged 11 commits into
lightningdevkit:mainfrom
joostjager:fulfill-hold-times

Conversation

@joostjager

@joostjagerjoostjager commented May 26, 2025

Copy link
Copy Markdown
Contributor

Apply the hold time reporting mechanism as implemented in #2256 to the success case. Spec in lightning/bolts#1044

@ldk-reviews-bot

ldk-reviews-bot commented May 26, 2025

Copy link
Copy Markdown

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

@joostjagerjoostjager changed the title Successful payment hold timesHold times for successful paymentsMay 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 7 times, most recently from badc803 to e913312CompareMay 27, 2025 09:52
@codecov

codecovBot commented May 27, 2025

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 90.03378% with 177 lines in your changes missing coverage. Please review.

Project coverage is 89.13%. Comparing base (9863f29) to head (1994550).
Report is 2 commits behind head on main.

Files with missing linesPatch %Lines
lightning/src/ln/channelmanager.rs90.43%86 Missing and 3 partials ⚠️
lightning/src/ln/channel.rs86.69%73 Missing and 14 partials ⚠️
lightning/src/ln/payment_tests.rs97.43%1 Missing ⚠️
Additional details and impacted files
@@ Coverage Diff @@## main #3801 +/- ##
==========================================
+ Coverage 88.82% 89.13% +0.31% 
==========================================
Files 166 166 Lines 119487 123678 +4191 Branches 119487 123678 +4191 ==========================================
+ Hits 106136 110246 +4110 - Misses 11021 11104 +83 + Partials 2330 2328 -2 

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

@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 8 times, most recently from bace463 to 1c64a50CompareJune 26, 2025 13:52
@joostjager
joostjager marked this pull request as ready for review June 26, 2025 14:16
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjager
joostjager marked this pull request as draft June 26, 2025 14:17
@joostjagerjoostjager self-assigned this Jun 26, 2025
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from 233cbfc to f5668f5CompareJune 30, 2025 09:36
@ldk-reviews-bot

Copy link
Copy Markdown

🔔 3rd Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 4th Reminder

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

@joostjager

Copy link
Copy Markdown
ContributorAuthor

Rebased

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 5th Reminder

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

@ldk-reviews-bot

Copy link
Copy Markdown

🔔 1st Reminder

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

@TheBlueMatt
TheBlueMatt self-requested a review July 16, 2025 16:20

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

Not super happy with how much this ended up touching but the hold times parts LGTM. The rustfmt part needs rebase, though, and I'm kinda skeptical of starting a PR with 1423 insertions(+), 570 deletions(-) when the rest of the PR is only 625 insertions(+), 196 deletions(-), seems like the rustfmt part should be separated out if you want to do it first.

let attribution_data = process_fulfill_attribution_data(
attribution_data.as_ref(),
&htlc.prev_hop.incoming_packet_shared_secret,
0,

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.

Ha, saved by the rounding :). Without the rounding this will clearly give away that we're a phantom node. As-is it instead can also be a peer that is within 100ms of us :)

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 am so happy 😅

Comment threadlightning/src/events/mod.rs Outdated
///
/// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
path: Path,
/// The hold times as reported by each hop.

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.

If we're going to expose this we really need to document in more detail what the values represent (100ms chunks where previous hops should encompass later hops' hold times) and how to use it (for deciding which node is slow in scoring, noting that our current scorer does not do this). Also, we should probably include it in PaymentPathFailed too?

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.

Docs added and hold_times exposed outside of tests in PaymentPathFailed.

@tnulltnull left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Needs a rebase now that #3937 landed.

Preparation for reuse of the logic.
Need to store AttributionData as part of the inbound HTLC removal reason
so that it can be used in the upstream UpdateFulfillHTLC message.
Necessary to preserve attribution data when the HTLC is in the holding
cell.
Adds hold time reporting for the final and intermediate nodes.
AttributionData is needed as part of the outbound HTLC outcome when
revoke_and_ack has happened and the AttributionData is decoded to get
the hold times for inclusion in the PaymentPathSuccessful event.
Prepare for inspecting hold times in PaymentPathSuccessful.
@joostjager
joostjagerforce-pushed the fulfill-hold-times branch 2 times, most recently from a6c8603 to 4831900CompareJuly 17, 2025 11:14
@joostjager

joostjager commented Jul 17, 2025

Copy link
Copy Markdown
ContributorAuthor

Comments addressed diff

Hold times are surfaced via the PaymentPathSuccessful event.
Now that fulfill hold times are surfaced in the event always, this
commit follow ups with the failure hold times.

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

LGTM. A few nits but I'm happy to address them post-merge, there's probably a few other things I want to tweak post-merge (at least making the fulfill message passed in owned instead of reference to remove some clones).

}

fn duration_since_epoch() -> Option<Duration> {
pub(crate) fn duration_since_epoch() -> Option<Duration> {

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.

Its a bit confusing to use this in channelmanager.rs - we already have a ChannelManager::duration_since_epoch that uses the block time if we're built without time access, but also every call to hold_time takes the result of this call as the second argument, so it seems like this should just be inlined into hold_time (dunno if you'd want to rename it after doing so).

(58, self.interactive_tx_signing_session, option), // Added in 0.2
(59, self.funding.minimum_depth_override, option), // Added in 0.2
(60, self.context.historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

(58, interactive_tx_signing_session, option), // Added in 0.2
(59, minimum_depth_override, option), // Added in 0.2
(60, historical_scids, optional_vec), // Added in 0.2
(61, fulfill_attribution_data, optional_vec),

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.

Needs an Added in tag.

Comment on lines +13216 to +13217
(55, removed_htlc_attribution_data, optional_vec),
(57, holding_cell_attribution_data, optional_vec),

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.

These could get the added-in tag that exists on the write side too, while we're here.

@valentinewallacevalentinewallace left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Mainly reviewed the diffs since my last LGTM. Nothing blocking 👍

);
check_added_monitors!(nodes[2], 1);
get_htlc_update_msgs!(nodes[2], node_b_id);
// Note that we don't populate fulfill_msg.attribution_data here, which will lead to hold times being

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it's putting the comment on the else, we could move it up a line?

/// milliseconds. So a hop reporting 2 is a hold time that corresponds to roughly 200 milliseconds. As earlier
/// hops hold on to an HTLC for longer, the hold times in the list are expected to decrease. When our peer
/// didn't provide attribution data, the list is empty. The same applies to HTLCs that were resolved onchain.
/// Because of unavailability of hold times, the list may be shorter than the number of hops in the path.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think it might be useful to clarify that the hold time at idx 0 corresponds to the hop at path.hops[0], etc

@TheBlueMattTheBlueMatt mentioned this pull request Jul 18, 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

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants

@joostjager@ldk-reviews-bot@valentinewallace@tnull@TheBlueMatt