Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,7 +1201,8 @@ pub enum Event {
/// If the recipient or an intermediate node misbehaves and gives us free money, this may
/// overstate the amount paid, though this is unlikely.
///
/// This is only `None` for payments initiated on LDK versions prior to 0.0.103.
/// This is only `None` for payments abandoned but ultimately claimed when using LDK versions
/// prior to 0.3, 0.2.3, or 0.1.10.
///
/// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
fee_paid_msat: Option<u64>,
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8579,7 +8579,7 @@ pub fn test_inconsistent_mpp_params() {
pass_along_path(&nodes[0], path_b, real_amt, hash, Some(payment_secret), event, true, None);

do_claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path_a, path_b], preimage));
expect_payment_sent(&nodes[0], preimage, Some(None), true, true);
expect_payment_sent(&nodes[0], preimage, Some(Some(2000)), true, true);
}

#[xtest(feature = "_externalize_tests")]
Expand Down
7 changes: 7 additions & 0 deletions lightning/src/ln/outbound_payment.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,9 @@ pub(crate) enum PendingOutboundPayment {
/// The total payment amount across all paths, used to be able to issue `PaymentSent` if
/// an HTLC still happens to succeed after we marked the payment as abandoned.
total_msat: Option<u64>,
/// Preserved from `Retryable` so we can still report `fee_paid_msat` if an HTLC succeeds after
/// the payment was abandoned. Added in 0.3.
pending_fee_msat: Option<u64>,

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.

Bug: remove() (line 335) only decrements pending_fee_msat for the Retryable variant, not for Abandoned. This means if an MPP payment is manually abandoned with multiple paths in-flight, and then some paths fail back while others succeed, the fee for the failed paths won't be subtracted — causing PaymentSent::fee_paid_msat to be overstated.

Concrete scenario:

  1. Two-path MPP, path A (fee=100) and path B (fee=200) in-flight → pending_fee_msat = Some(300)
  2. abandon_payment()Abandoned { pending_fee_msat: Some(300) }
  3. Path A fails (intermediate node timeout) → remove() removes session_priv but doesn't decrement fee → pending_fee_msat still Some(300)
  4. Path B succeeds (recipient claims) → PaymentSent { fee_paid_msat: Some(300) } — should be Some(200)

The remove() function at line 348-363 needs an additional branch for Abandoned:

ifletPendingOutboundPayment::Abandoned{refmut pending_fee_msat, ..
} = self{let path = path.expect("Removing a failed payment should always come with a path");ifletSome(fee_msat) = pending_fee_msat.as_mut(){*fee_msat -= path.fee_msat();}}

Note: for the auto-abandon path (in handle_update_fail_htlc), remove() is called beforemark_abandoned(), so the fee is correctly captured. This bug only affects the manual-abandon path and any future failures arriving after auto-abandonment.

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.

},
}

Expand DownExpand Up@@ -252,6 +255,7 @@ impl PendingOutboundPayment {
fn get_pending_fee_msat(&self) -> Option<u64> {
match self {
PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
PendingOutboundPayment::Abandoned { pending_fee_msat, .. } => pending_fee_msat.clone(),
_ => None,
}
}
Expand DownExpand Up@@ -308,6 +312,7 @@ impl PendingOutboundPayment {
_ => new_hash_set(),
};
let total_msat = self.total_msat();
let pending_fee_msat = self.get_pending_fee_msat();
match self {
Self::Retryable { payment_hash, .. } |
Self::InvoiceReceived { payment_hash, .. } |
Expand All@@ -318,6 +323,7 @@ impl PendingOutboundPayment {
payment_hash: *payment_hash,
reason: Some(reason),
total_msat,

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.

curious here if we should be setting this to the sum of the current paths currently in-flight, and not the fixed total msat ?

pending_fee_msat,
};
},
_ => {}
Expand DownExpand Up@@ -2778,6 +2784,7 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
(1, reason, upgradable_option),
(2, payment_hash, required),
(3, total_msat, option),
(5, pending_fee_msat, option),
},
(5, AwaitingInvoice) => {
(0, expiration, required),
Expand Down
30 changes: 30 additions & 0 deletions lightning/src/ln/payment_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2241,6 +2241,36 @@ fn abandoned_send_payment_idempotent() {
claim_payment(&nodes[0], &[&nodes[1]], second_payment_preimage);
}

#[test]
fn abandoned_payment_fulfilled_preserves_fee_paid_msat() {
// Previously, if we abandoned a payment with HTLCs in-flight and the payment eventually
// succeeded, we would set the `Event::PaymentSent::fee_paid_msat` to None, even though we had
// docs guaranteeing that it would always be Some after 0.0.103.
let chanmon_cfgs = create_chanmon_cfgs(3);
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
let nodes = create_network(3, &node_cfgs, &node_chanmgrs);

create_announced_chan_between_nodes(&nodes, 0, 1);
create_announced_chan_between_nodes(&nodes, 1, 2);

let amt_msat = 10_000_000;
let (route, payment_hash, payment_preimage, payment_secret) =
get_route_and_payment_hash!(&nodes[0], nodes[2], amt_msat);
let payment_id = PaymentId(payment_hash.0);
let onion = RecipientOnionFields::secret_only(payment_secret, amt_msat);
nodes[0].node.send_payment_with_route(route, payment_hash, onion, payment_id).unwrap();
check_added_monitors(&nodes[0], 1);

let path: &[&Node] = &[&nodes[1], &nodes[2]];
pass_along_route(&nodes[0], &[path], amt_msat, payment_hash, payment_secret);

nodes[0].node.abandon_payment(payment_id);
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());

claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path], payment_preimage));
}

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,7 +1201,8 @@ pub enum Event {
/// If the recipient or an intermediate node misbehaves and gives us free money, this may
/// overstate the amount paid, though this is unlikely.
///
/// This is only `None` for payments initiated on LDK versions prior to 0.0.103.
/// This is only `None` for payments abandoned but ultimately claimed when using LDK versions
/// prior to 0.3, 0.2.3, or 0.1.10.
///
/// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
fee_paid_msat: Option<u64>,
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8579,7 +8579,7 @@ pub fn test_inconsistent_mpp_params() {
pass_along_path(&nodes[0], path_b, real_amt, hash, Some(payment_secret), event, true, None);

do_claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path_a, path_b], preimage));
expect_payment_sent(&nodes[0], preimage, Some(None), true, true);
expect_payment_sent(&nodes[0], preimage, Some(Some(2000)), true, true);
}

#[xtest(feature = "_externalize_tests")]
Expand Down
7 changes: 7 additions & 0 deletions lightning/src/ln/outbound_payment.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,9 @@ pub(crate) enum PendingOutboundPayment {
/// The total payment amount across all paths, used to be able to issue `PaymentSent` if
/// an HTLC still happens to succeed after we marked the payment as abandoned.
total_msat: Option<u64>,
/// Preserved from `Retryable` so we can still report `fee_paid_msat` if an HTLC succeeds after
/// the payment was abandoned. Added in 0.3.
pending_fee_msat: Option<u64>,

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.

Bug: remove() (line 335) only decrements pending_fee_msat for the Retryable variant, not for Abandoned. This means if an MPP payment is manually abandoned with multiple paths in-flight, and then some paths fail back while others succeed, the fee for the failed paths won't be subtracted — causing PaymentSent::fee_paid_msat to be overstated.

Concrete scenario:

  1. Two-path MPP, path A (fee=100) and path B (fee=200) in-flight → pending_fee_msat = Some(300)
  2. abandon_payment()Abandoned { pending_fee_msat: Some(300) }
  3. Path A fails (intermediate node timeout) → remove() removes session_priv but doesn't decrement fee → pending_fee_msat still Some(300)
  4. Path B succeeds (recipient claims) → PaymentSent { fee_paid_msat: Some(300) } — should be Some(200)

The remove() function at line 348-363 needs an additional branch for Abandoned:

ifletPendingOutboundPayment::Abandoned{refmut pending_fee_msat, ..
} = self{let path = path.expect("Removing a failed payment should always come with a path");ifletSome(fee_msat) = pending_fee_msat.as_mut(){*fee_msat -= path.fee_msat();}}

Note: for the auto-abandon path (in handle_update_fail_htlc), remove() is called beforemark_abandoned(), so the fee is correctly captured. This bug only affects the manual-abandon path and any future failures arriving after auto-abandonment.

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.

},
}

Expand DownExpand Up@@ -252,6 +255,7 @@ impl PendingOutboundPayment {
fn get_pending_fee_msat(&self) -> Option<u64> {
match self {
PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
PendingOutboundPayment::Abandoned { pending_fee_msat, .. } => pending_fee_msat.clone(),
_ => None,
}
}
Expand DownExpand Up@@ -308,6 +312,7 @@ impl PendingOutboundPayment {
_ => new_hash_set(),
};
let total_msat = self.total_msat();
let pending_fee_msat = self.get_pending_fee_msat();
match self {
Self::Retryable { payment_hash, .. } |
Self::InvoiceReceived { payment_hash, .. } |
Expand All@@ -318,6 +323,7 @@ impl PendingOutboundPayment {
payment_hash: *payment_hash,
reason: Some(reason),
total_msat,

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.

curious here if we should be setting this to the sum of the current paths currently in-flight, and not the fixed total msat ?

pending_fee_msat,
};
},
_ => {}
Expand DownExpand Up@@ -2778,6 +2784,7 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
(1, reason, upgradable_option),
(2, payment_hash, required),
(3, total_msat, option),
(5, pending_fee_msat, option),
},
(5, AwaitingInvoice) => {
(0, expiration, required),
Expand Down
30 changes: 30 additions & 0 deletions lightning/src/ln/payment_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2241,6 +2241,36 @@ fn abandoned_send_payment_idempotent() {
claim_payment(&nodes[0], &[&nodes[1]], second_payment_preimage);
}

#[test]
fn abandoned_payment_fulfilled_preserves_fee_paid_msat() {
// Previously, if we abandoned a payment with HTLCs in-flight and the payment eventually
// succeeded, we would set the `Event::PaymentSent::fee_paid_msat` to None, even though we had
// docs guaranteeing that it would always be Some after 0.0.103.
let chanmon_cfgs = create_chanmon_cfgs(3);
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
let nodes = create_network(3, &node_cfgs, &node_chanmgrs);

create_announced_chan_between_nodes(&nodes, 0, 1);
create_announced_chan_between_nodes(&nodes, 1, 2);

let amt_msat = 10_000_000;
let (route, payment_hash, payment_preimage, payment_secret) =
get_route_and_payment_hash!(&nodes[0], nodes[2], amt_msat);
let payment_id = PaymentId(payment_hash.0);
let onion = RecipientOnionFields::secret_only(payment_secret, amt_msat);
nodes[0].node.send_payment_with_route(route, payment_hash, onion, payment_id).unwrap();
check_added_monitors(&nodes[0], 1);

let path: &[&Node] = &[&nodes[1], &nodes[2]];
pass_along_route(&nodes[0], &[path], amt_msat, payment_hash, payment_secret);

nodes[0].node.abandon_payment(payment_id);
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());

claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path], payment_preimage));
}

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,7 +1201,8 @@ pub enum Event {
/// If the recipient or an intermediate node misbehaves and gives us free money, this may
/// overstate the amount paid, though this is unlikely.
///
/// This is only `None` for payments initiated on LDK versions prior to 0.0.103.
/// This is only `None` for payments abandoned but ultimately claimed when using LDK versions
/// prior to 0.3, 0.2.3, or 0.1.10.
///
/// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
fee_paid_msat: Option<u64>,
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8579,7 +8579,7 @@ pub fn test_inconsistent_mpp_params() {
pass_along_path(&nodes[0], path_b, real_amt, hash, Some(payment_secret), event, true, None);

do_claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path_a, path_b], preimage));
expect_payment_sent(&nodes[0], preimage, Some(None), true, true);
expect_payment_sent(&nodes[0], preimage, Some(Some(2000)), true, true);
}

#[xtest(feature = "_externalize_tests")]
Expand Down
7 changes: 7 additions & 0 deletions lightning/src/ln/outbound_payment.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,9 @@ pub(crate) enum PendingOutboundPayment {
/// The total payment amount across all paths, used to be able to issue `PaymentSent` if
/// an HTLC still happens to succeed after we marked the payment as abandoned.
total_msat: Option<u64>,
/// Preserved from `Retryable` so we can still report `fee_paid_msat` if an HTLC succeeds after
/// the payment was abandoned. Added in 0.3.
pending_fee_msat: Option<u64>,

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.

Bug: remove() (line 335) only decrements pending_fee_msat for the Retryable variant, not for Abandoned. This means if an MPP payment is manually abandoned with multiple paths in-flight, and then some paths fail back while others succeed, the fee for the failed paths won't be subtracted — causing PaymentSent::fee_paid_msat to be overstated.

Concrete scenario:

  1. Two-path MPP, path A (fee=100) and path B (fee=200) in-flight → pending_fee_msat = Some(300)
  2. abandon_payment()Abandoned { pending_fee_msat: Some(300) }
  3. Path A fails (intermediate node timeout) → remove() removes session_priv but doesn't decrement fee → pending_fee_msat still Some(300)
  4. Path B succeeds (recipient claims) → PaymentSent { fee_paid_msat: Some(300) } — should be Some(200)

The remove() function at line 348-363 needs an additional branch for Abandoned:

ifletPendingOutboundPayment::Abandoned{refmut pending_fee_msat, ..
} = self{let path = path.expect("Removing a failed payment should always come with a path");ifletSome(fee_msat) = pending_fee_msat.as_mut(){*fee_msat -= path.fee_msat();}}

Note: for the auto-abandon path (in handle_update_fail_htlc), remove() is called beforemark_abandoned(), so the fee is correctly captured. This bug only affects the manual-abandon path and any future failures arriving after auto-abandonment.

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.

},
}

Expand DownExpand Up@@ -252,6 +255,7 @@ impl PendingOutboundPayment {
fn get_pending_fee_msat(&self) -> Option<u64> {
match self {
PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
PendingOutboundPayment::Abandoned { pending_fee_msat, .. } => pending_fee_msat.clone(),
_ => None,
}
}
Expand DownExpand Up@@ -308,6 +312,7 @@ impl PendingOutboundPayment {
_ => new_hash_set(),
};
let total_msat = self.total_msat();
let pending_fee_msat = self.get_pending_fee_msat();
match self {
Self::Retryable { payment_hash, .. } |
Self::InvoiceReceived { payment_hash, .. } |
Expand All@@ -318,6 +323,7 @@ impl PendingOutboundPayment {
payment_hash: *payment_hash,
reason: Some(reason),
total_msat,

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.

curious here if we should be setting this to the sum of the current paths currently in-flight, and not the fixed total msat ?

pending_fee_msat,
};
},
_ => {}
Expand DownExpand Up@@ -2778,6 +2784,7 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
(1, reason, upgradable_option),
(2, payment_hash, required),
(3, total_msat, option),
(5, pending_fee_msat, option),
},
(5, AwaitingInvoice) => {
(0, expiration, required),
Expand Down
30 changes: 30 additions & 0 deletions lightning/src/ln/payment_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2241,6 +2241,36 @@ fn abandoned_send_payment_idempotent() {
claim_payment(&nodes[0], &[&nodes[1]], second_payment_preimage);
}

#[test]
fn abandoned_payment_fulfilled_preserves_fee_paid_msat() {
// Previously, if we abandoned a payment with HTLCs in-flight and the payment eventually
// succeeded, we would set the `Event::PaymentSent::fee_paid_msat` to None, even though we had
// docs guaranteeing that it would always be Some after 0.0.103.
let chanmon_cfgs = create_chanmon_cfgs(3);
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
let nodes = create_network(3, &node_cfgs, &node_chanmgrs);

create_announced_chan_between_nodes(&nodes, 0, 1);
create_announced_chan_between_nodes(&nodes, 1, 2);

let amt_msat = 10_000_000;
let (route, payment_hash, payment_preimage, payment_secret) =
get_route_and_payment_hash!(&nodes[0], nodes[2], amt_msat);
let payment_id = PaymentId(payment_hash.0);
let onion = RecipientOnionFields::secret_only(payment_secret, amt_msat);
nodes[0].node.send_payment_with_route(route, payment_hash, onion, payment_id).unwrap();
check_added_monitors(&nodes[0], 1);

let path: &[&Node] = &[&nodes[1], &nodes[2]];
pass_along_route(&nodes[0], &[path], amt_msat, payment_hash, payment_secret);

nodes[0].node.abandon_payment(payment_id);
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());

claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path], payment_preimage));
}

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,7 +1201,8 @@ pub enum Event {
/// If the recipient or an intermediate node misbehaves and gives us free money, this may
/// overstate the amount paid, though this is unlikely.
///
/// This is only `None` for payments initiated on LDK versions prior to 0.0.103.
/// This is only `None` for payments abandoned but ultimately claimed when using LDK versions
/// prior to 0.3, 0.2.3, or 0.1.10.
///
/// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
fee_paid_msat: Option<u64>,
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8579,7 +8579,7 @@ pub fn test_inconsistent_mpp_params() {
pass_along_path(&nodes[0], path_b, real_amt, hash, Some(payment_secret), event, true, None);

do_claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path_a, path_b], preimage));
expect_payment_sent(&nodes[0], preimage, Some(None), true, true);
expect_payment_sent(&nodes[0], preimage, Some(Some(2000)), true, true);
}

#[xtest(feature = "_externalize_tests")]
Expand Down
7 changes: 7 additions & 0 deletions lightning/src/ln/outbound_payment.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,9 @@ pub(crate) enum PendingOutboundPayment {
/// The total payment amount across all paths, used to be able to issue `PaymentSent` if
/// an HTLC still happens to succeed after we marked the payment as abandoned.
total_msat: Option<u64>,
/// Preserved from `Retryable` so we can still report `fee_paid_msat` if an HTLC succeeds after
/// the payment was abandoned. Added in 0.3.
pending_fee_msat: Option<u64>,

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.

Bug: remove() (line 335) only decrements pending_fee_msat for the Retryable variant, not for Abandoned. This means if an MPP payment is manually abandoned with multiple paths in-flight, and then some paths fail back while others succeed, the fee for the failed paths won't be subtracted — causing PaymentSent::fee_paid_msat to be overstated.

Concrete scenario:

  1. Two-path MPP, path A (fee=100) and path B (fee=200) in-flight → pending_fee_msat = Some(300)
  2. abandon_payment()Abandoned { pending_fee_msat: Some(300) }
  3. Path A fails (intermediate node timeout) → remove() removes session_priv but doesn't decrement fee → pending_fee_msat still Some(300)
  4. Path B succeeds (recipient claims) → PaymentSent { fee_paid_msat: Some(300) } — should be Some(200)

The remove() function at line 348-363 needs an additional branch for Abandoned:

ifletPendingOutboundPayment::Abandoned{refmut pending_fee_msat, ..
} = self{let path = path.expect("Removing a failed payment should always come with a path");ifletSome(fee_msat) = pending_fee_msat.as_mut(){*fee_msat -= path.fee_msat();}}

Note: for the auto-abandon path (in handle_update_fail_htlc), remove() is called beforemark_abandoned(), so the fee is correctly captured. This bug only affects the manual-abandon path and any future failures arriving after auto-abandonment.

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.

},
}

Expand DownExpand Up@@ -252,6 +255,7 @@ impl PendingOutboundPayment {
fn get_pending_fee_msat(&self) -> Option<u64> {
match self {
PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
PendingOutboundPayment::Abandoned { pending_fee_msat, .. } => pending_fee_msat.clone(),
_ => None,
}
}
Expand DownExpand Up@@ -308,6 +312,7 @@ impl PendingOutboundPayment {
_ => new_hash_set(),
};
let total_msat = self.total_msat();
let pending_fee_msat = self.get_pending_fee_msat();
match self {
Self::Retryable { payment_hash, .. } |
Self::InvoiceReceived { payment_hash, .. } |
Expand All@@ -318,6 +323,7 @@ impl PendingOutboundPayment {
payment_hash: *payment_hash,
reason: Some(reason),
total_msat,

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.

curious here if we should be setting this to the sum of the current paths currently in-flight, and not the fixed total msat ?

pending_fee_msat,
};
},
_ => {}
Expand DownExpand Up@@ -2778,6 +2784,7 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
(1, reason, upgradable_option),
(2, payment_hash, required),
(3, total_msat, option),
(5, pending_fee_msat, option),
},
(5, AwaitingInvoice) => {
(0, expiration, required),
Expand Down
30 changes: 30 additions & 0 deletions lightning/src/ln/payment_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2241,6 +2241,36 @@ fn abandoned_send_payment_idempotent() {
claim_payment(&nodes[0], &[&nodes[1]], second_payment_preimage);
}

#[test]
fn abandoned_payment_fulfilled_preserves_fee_paid_msat() {
// Previously, if we abandoned a payment with HTLCs in-flight and the payment eventually
// succeeded, we would set the `Event::PaymentSent::fee_paid_msat` to None, even though we had
// docs guaranteeing that it would always be Some after 0.0.103.
let chanmon_cfgs = create_chanmon_cfgs(3);
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
let nodes = create_network(3, &node_cfgs, &node_chanmgrs);

create_announced_chan_between_nodes(&nodes, 0, 1);
create_announced_chan_between_nodes(&nodes, 1, 2);

let amt_msat = 10_000_000;
let (route, payment_hash, payment_preimage, payment_secret) =
get_route_and_payment_hash!(&nodes[0], nodes[2], amt_msat);
let payment_id = PaymentId(payment_hash.0);
let onion = RecipientOnionFields::secret_only(payment_secret, amt_msat);
nodes[0].node.send_payment_with_route(route, payment_hash, onion, payment_id).unwrap();
check_added_monitors(&nodes[0], 1);

let path: &[&Node] = &[&nodes[1], &nodes[2]];
pass_along_route(&nodes[0], &[path], amt_msat, payment_hash, payment_secret);

nodes[0].node.abandon_payment(payment_id);
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());

claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path], payment_preimage));
}

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,7 +1201,8 @@ pub enum Event {
/// If the recipient or an intermediate node misbehaves and gives us free money, this may
/// overstate the amount paid, though this is unlikely.
///
/// This is only `None` for payments initiated on LDK versions prior to 0.0.103.
/// This is only `None` for payments abandoned but ultimately claimed when using LDK versions
/// prior to 0.3, 0.2.3, or 0.1.10.
///
/// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
fee_paid_msat: Option<u64>,
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8579,7 +8579,7 @@ pub fn test_inconsistent_mpp_params() {
pass_along_path(&nodes[0], path_b, real_amt, hash, Some(payment_secret), event, true, None);

do_claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path_a, path_b], preimage));
expect_payment_sent(&nodes[0], preimage, Some(None), true, true);
expect_payment_sent(&nodes[0], preimage, Some(Some(2000)), true, true);
}

#[xtest(feature = "_externalize_tests")]
Expand Down
7 changes: 7 additions & 0 deletions lightning/src/ln/outbound_payment.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,9 @@ pub(crate) enum PendingOutboundPayment {
/// The total payment amount across all paths, used to be able to issue `PaymentSent` if
/// an HTLC still happens to succeed after we marked the payment as abandoned.
total_msat: Option<u64>,
/// Preserved from `Retryable` so we can still report `fee_paid_msat` if an HTLC succeeds after
/// the payment was abandoned. Added in 0.3.
pending_fee_msat: Option<u64>,

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.

Bug: remove() (line 335) only decrements pending_fee_msat for the Retryable variant, not for Abandoned. This means if an MPP payment is manually abandoned with multiple paths in-flight, and then some paths fail back while others succeed, the fee for the failed paths won't be subtracted — causing PaymentSent::fee_paid_msat to be overstated.

Concrete scenario:

  1. Two-path MPP, path A (fee=100) and path B (fee=200) in-flight → pending_fee_msat = Some(300)
  2. abandon_payment()Abandoned { pending_fee_msat: Some(300) }
  3. Path A fails (intermediate node timeout) → remove() removes session_priv but doesn't decrement fee → pending_fee_msat still Some(300)
  4. Path B succeeds (recipient claims) → PaymentSent { fee_paid_msat: Some(300) } — should be Some(200)

The remove() function at line 348-363 needs an additional branch for Abandoned:

ifletPendingOutboundPayment::Abandoned{refmut pending_fee_msat, ..
} = self{let path = path.expect("Removing a failed payment should always come with a path");ifletSome(fee_msat) = pending_fee_msat.as_mut(){*fee_msat -= path.fee_msat();}}

Note: for the auto-abandon path (in handle_update_fail_htlc), remove() is called beforemark_abandoned(), so the fee is correctly captured. This bug only affects the manual-abandon path and any future failures arriving after auto-abandonment.

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.

},
}

Expand DownExpand Up@@ -252,6 +255,7 @@ impl PendingOutboundPayment {
fn get_pending_fee_msat(&self) -> Option<u64> {
match self {
PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
PendingOutboundPayment::Abandoned { pending_fee_msat, .. } => pending_fee_msat.clone(),
_ => None,
}
}
Expand DownExpand Up@@ -308,6 +312,7 @@ impl PendingOutboundPayment {
_ => new_hash_set(),
};
let total_msat = self.total_msat();
let pending_fee_msat = self.get_pending_fee_msat();
match self {
Self::Retryable { payment_hash, .. } |
Self::InvoiceReceived { payment_hash, .. } |
Expand All@@ -318,6 +323,7 @@ impl PendingOutboundPayment {
payment_hash: *payment_hash,
reason: Some(reason),
total_msat,

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.

curious here if we should be setting this to the sum of the current paths currently in-flight, and not the fixed total msat ?

pending_fee_msat,
};
},
_ => {}
Expand DownExpand Up@@ -2778,6 +2784,7 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
(1, reason, upgradable_option),
(2, payment_hash, required),
(3, total_msat, option),
(5, pending_fee_msat, option),
},
(5, AwaitingInvoice) => {
(0, expiration, required),
Expand Down
30 changes: 30 additions & 0 deletions lightning/src/ln/payment_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2241,6 +2241,36 @@ fn abandoned_send_payment_idempotent() {
claim_payment(&nodes[0], &[&nodes[1]], second_payment_preimage);
}

#[test]
fn abandoned_payment_fulfilled_preserves_fee_paid_msat() {
// Previously, if we abandoned a payment with HTLCs in-flight and the payment eventually
// succeeded, we would set the `Event::PaymentSent::fee_paid_msat` to None, even though we had
// docs guaranteeing that it would always be Some after 0.0.103.
let chanmon_cfgs = create_chanmon_cfgs(3);
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
let nodes = create_network(3, &node_cfgs, &node_chanmgrs);

create_announced_chan_between_nodes(&nodes, 0, 1);
create_announced_chan_between_nodes(&nodes, 1, 2);

let amt_msat = 10_000_000;
let (route, payment_hash, payment_preimage, payment_secret) =
get_route_and_payment_hash!(&nodes[0], nodes[2], amt_msat);
let payment_id = PaymentId(payment_hash.0);
let onion = RecipientOnionFields::secret_only(payment_secret, amt_msat);
nodes[0].node.send_payment_with_route(route, payment_hash, onion, payment_id).unwrap();
check_added_monitors(&nodes[0], 1);

let path: &[&Node] = &[&nodes[1], &nodes[2]];
pass_along_route(&nodes[0], &[path], amt_msat, payment_hash, payment_secret);

nodes[0].node.abandon_payment(payment_id);
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());

claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path], payment_preimage));
}

#[derive(PartialEq)]
enum InterceptTest {
Forward,
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,7 +1201,8 @@ pub enum Event {
/// If the recipient or an intermediate node misbehaves and gives us free money, this may
/// overstate the amount paid, though this is unlikely.
///
/// This is only `None` for payments initiated on LDK versions prior to 0.0.103.
/// This is only `None` for payments abandoned but ultimately claimed when using LDK versions
/// prior to 0.3, 0.2.3, or 0.1.10.
///
/// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
fee_paid_msat: Option<u64>,
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8579,7 +8579,7 @@ pub fn test_inconsistent_mpp_params() {
pass_along_path(&nodes[0], path_b, real_amt, hash, Some(payment_secret), event, true, None);

do_claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path_a, path_b], preimage));
expect_payment_sent(&nodes[0], preimage, Some(None), true, true);
expect_payment_sent(&nodes[0], preimage, Some(Some(2000)), true, true);
}

#[xtest(feature = "_externalize_tests")]
Expand Down
7 changes: 7 additions & 0 deletions lightning/src/ln/outbound_payment.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,9 @@ pub(crate) enum PendingOutboundPayment {
/// The total payment amount across all paths, used to be able to issue `PaymentSent` if
/// an HTLC still happens to succeed after we marked the payment as abandoned.
total_msat: Option<u64>,
/// Preserved from `Retryable` so we can still report `fee_paid_msat` if an HTLC succeeds after
/// the payment was abandoned. Added in 0.3.
pending_fee_msat: Option<u64>,

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.

Bug: remove() (line 335) only decrements pending_fee_msat for the Retryable variant, not for Abandoned. This means if an MPP payment is manually abandoned with multiple paths in-flight, and then some paths fail back while others succeed, the fee for the failed paths won't be subtracted — causing PaymentSent::fee_paid_msat to be overstated.

Concrete scenario:

  1. Two-path MPP, path A (fee=100) and path B (fee=200) in-flight → pending_fee_msat = Some(300)
  2. abandon_payment()Abandoned { pending_fee_msat: Some(300) }
  3. Path A fails (intermediate node timeout) → remove() removes session_priv but doesn't decrement fee → pending_fee_msat still Some(300)
  4. Path B succeeds (recipient claims) → PaymentSent { fee_paid_msat: Some(300) } — should be Some(200)

The remove() function at line 348-363 needs an additional branch for Abandoned:

ifletPendingOutboundPayment::Abandoned{refmut pending_fee_msat, ..
} = self{let path = path.expect("Removing a failed payment should always come with a path");ifletSome(fee_msat) = pending_fee_msat.as_mut(){*fee_msat -= path.fee_msat();}}

Note: for the auto-abandon path (in handle_update_fail_htlc), remove() is called beforemark_abandoned(), so the fee is correctly captured. This bug only affects the manual-abandon path and any future failures arriving after auto-abandonment.

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.

},
}

Expand DownExpand Up@@ -252,6 +255,7 @@ impl PendingOutboundPayment {
fn get_pending_fee_msat(&self) -> Option<u64> {
match self {
PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
PendingOutboundPayment::Abandoned { pending_fee_msat, .. } => pending_fee_msat.clone(),
_ => None,
}
}
Expand DownExpand Up@@ -308,6 +312,7 @@ impl PendingOutboundPayment {
_ => new_hash_set(),
};
let total_msat = self.total_msat();
let pending_fee_msat = self.get_pending_fee_msat();
match self {
Self::Retryable { payment_hash, .. } |
Self::InvoiceReceived { payment_hash, .. } |
Expand All@@ -318,6 +323,7 @@ impl PendingOutboundPayment {
payment_hash: *payment_hash,
reason: Some(reason),
total_msat,

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.

curious here if we should be setting this to the sum of the current paths currently in-flight, and not the fixed total msat ?

pending_fee_msat,
};
},
_ => {}
Expand DownExpand Up@@ -2778,6 +2784,7 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
(1, reason, upgradable_option),
(2, payment_hash, required),
(3, total_msat, option),
(5, pending_fee_msat, option),
},
(5, AwaitingInvoice) => {
(0, expiration, required),
Expand Down
30 changes: 30 additions & 0 deletions lightning/src/ln/payment_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2241,6 +2241,36 @@ fn abandoned_send_payment_idempotent() {
claim_payment(&nodes[0], &[&nodes[1]], second_payment_preimage);
}

#[test]
fn abandoned_payment_fulfilled_preserves_fee_paid_msat() {
// Previously, if we abandoned a payment with HTLCs in-flight and the payment eventually
// succeeded, we would set the `Event::PaymentSent::fee_paid_msat` to None, even though we had
// docs guaranteeing that it would always be Some after 0.0.103.
let chanmon_cfgs = create_chanmon_cfgs(3);
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
let nodes = create_network(3, &node_cfgs, &node_chanmgrs);

create_announced_chan_between_nodes(&nodes, 0, 1);
create_announced_chan_between_nodes(&nodes, 1, 2);

let amt_msat = 10_000_000;
let (route, payment_hash, payment_preimage, payment_secret) =
get_route_and_payment_hash!(&nodes[0], nodes[2], amt_msat);
let payment_id = PaymentId(payment_hash.0);
let onion = RecipientOnionFields::secret_only(payment_secret, amt_msat);
nodes[0].node.send_payment_with_route(route, payment_hash, onion, payment_id).unwrap();
check_added_monitors(&nodes[0], 1);

let path: &[&Node] = &[&nodes[1], &nodes[2]];
pass_along_route(&nodes[0], &[path], amt_msat, payment_hash, payment_secret);

nodes[0].node.abandon_payment(payment_id);
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());

claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path], payment_preimage));
}

#[derive(PartialEq)]
enum InterceptTest {
Forward,
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,7 +1201,8 @@ pub enum Event {
/// If the recipient or an intermediate node misbehaves and gives us free money, this may
/// overstate the amount paid, though this is unlikely.
///
/// This is only `None` for payments initiated on LDK versions prior to 0.0.103.
/// This is only `None` for payments abandoned but ultimately claimed when using LDK versions
/// prior to 0.3, 0.2.3, or 0.1.10.
///
/// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
fee_paid_msat: Option<u64>,
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8579,7 +8579,7 @@ pub fn test_inconsistent_mpp_params() {
pass_along_path(&nodes[0], path_b, real_amt, hash, Some(payment_secret), event, true, None);

do_claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path_a, path_b], preimage));
expect_payment_sent(&nodes[0], preimage, Some(None), true, true);
expect_payment_sent(&nodes[0], preimage, Some(Some(2000)), true, true);
}

#[xtest(feature = "_externalize_tests")]
Expand Down
7 changes: 7 additions & 0 deletions lightning/src/ln/outbound_payment.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,9 @@ pub(crate) enum PendingOutboundPayment {
/// The total payment amount across all paths, used to be able to issue `PaymentSent` if
/// an HTLC still happens to succeed after we marked the payment as abandoned.
total_msat: Option<u64>,
/// Preserved from `Retryable` so we can still report `fee_paid_msat` if an HTLC succeeds after
/// the payment was abandoned. Added in 0.3.
pending_fee_msat: Option<u64>,

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.

Bug: remove() (line 335) only decrements pending_fee_msat for the Retryable variant, not for Abandoned. This means if an MPP payment is manually abandoned with multiple paths in-flight, and then some paths fail back while others succeed, the fee for the failed paths won't be subtracted — causing PaymentSent::fee_paid_msat to be overstated.

Concrete scenario:

  1. Two-path MPP, path A (fee=100) and path B (fee=200) in-flight → pending_fee_msat = Some(300)
  2. abandon_payment()Abandoned { pending_fee_msat: Some(300) }
  3. Path A fails (intermediate node timeout) → remove() removes session_priv but doesn't decrement fee → pending_fee_msat still Some(300)
  4. Path B succeeds (recipient claims) → PaymentSent { fee_paid_msat: Some(300) } — should be Some(200)

The remove() function at line 348-363 needs an additional branch for Abandoned:

ifletPendingOutboundPayment::Abandoned{refmut pending_fee_msat, ..
} = self{let path = path.expect("Removing a failed payment should always come with a path");ifletSome(fee_msat) = pending_fee_msat.as_mut(){*fee_msat -= path.fee_msat();}}

Note: for the auto-abandon path (in handle_update_fail_htlc), remove() is called beforemark_abandoned(), so the fee is correctly captured. This bug only affects the manual-abandon path and any future failures arriving after auto-abandonment.

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.

},
}

Expand DownExpand Up@@ -252,6 +255,7 @@ impl PendingOutboundPayment {
fn get_pending_fee_msat(&self) -> Option<u64> {
match self {
PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
PendingOutboundPayment::Abandoned { pending_fee_msat, .. } => pending_fee_msat.clone(),
_ => None,
}
}
Expand DownExpand Up@@ -308,6 +312,7 @@ impl PendingOutboundPayment {
_ => new_hash_set(),
};
let total_msat = self.total_msat();
let pending_fee_msat = self.get_pending_fee_msat();
match self {
Self::Retryable { payment_hash, .. } |
Self::InvoiceReceived { payment_hash, .. } |
Expand All@@ -318,6 +323,7 @@ impl PendingOutboundPayment {
payment_hash: *payment_hash,
reason: Some(reason),
total_msat,

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.

curious here if we should be setting this to the sum of the current paths currently in-flight, and not the fixed total msat ?

pending_fee_msat,
};
},
_ => {}
Expand DownExpand Up@@ -2778,6 +2784,7 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
(1, reason, upgradable_option),
(2, payment_hash, required),
(3, total_msat, option),
(5, pending_fee_msat, option),
},
(5, AwaitingInvoice) => {
(0, expiration, required),
Expand Down
30 changes: 30 additions & 0 deletions lightning/src/ln/payment_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2241,6 +2241,36 @@ fn abandoned_send_payment_idempotent() {
claim_payment(&nodes[0], &[&nodes[1]], second_payment_preimage);
}

#[test]
fn abandoned_payment_fulfilled_preserves_fee_paid_msat() {
// Previously, if we abandoned a payment with HTLCs in-flight and the payment eventually
// succeeded, we would set the `Event::PaymentSent::fee_paid_msat` to None, even though we had
// docs guaranteeing that it would always be Some after 0.0.103.
let chanmon_cfgs = create_chanmon_cfgs(3);
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
let nodes = create_network(3, &node_cfgs, &node_chanmgrs);

create_announced_chan_between_nodes(&nodes, 0, 1);
create_announced_chan_between_nodes(&nodes, 1, 2);

let amt_msat = 10_000_000;
let (route, payment_hash, payment_preimage, payment_secret) =
get_route_and_payment_hash!(&nodes[0], nodes[2], amt_msat);
let payment_id = PaymentId(payment_hash.0);
let onion = RecipientOnionFields::secret_only(payment_secret, amt_msat);
nodes[0].node.send_payment_with_route(route, payment_hash, onion, payment_id).unwrap();
check_added_monitors(&nodes[0], 1);

let path: &[&Node] = &[&nodes[1], &nodes[2]];
pass_along_route(&nodes[0], &[path], amt_msat, payment_hash, payment_secret);

nodes[0].node.abandon_payment(payment_id);
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());

claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path], payment_preimage));
}

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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion lightning/src/events/mod.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -1201,7 +1201,8 @@ pub enum Event {
/// If the recipient or an intermediate node misbehaves and gives us free money, this may
/// overstate the amount paid, though this is unlikely.
///
/// This is only `None` for payments initiated on LDK versions prior to 0.0.103.
/// This is only `None` for payments abandoned but ultimately claimed when using LDK versions
/// prior to 0.3, 0.2.3, or 0.1.10.
///
/// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
fee_paid_msat: Option<u64>,
Expand Down
2 changes: 1 addition & 1 deletion lightning/src/ln/functional_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -8579,7 +8579,7 @@ pub fn test_inconsistent_mpp_params() {
pass_along_path(&nodes[0], path_b, real_amt, hash, Some(payment_secret), event, true, None);

do_claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path_a, path_b], preimage));
expect_payment_sent(&nodes[0], preimage, Some(None), true, true);
expect_payment_sent(&nodes[0], preimage, Some(Some(2000)), true, true);
}

#[xtest(feature = "_externalize_tests")]
Expand Down
7 changes: 7 additions & 0 deletions lightning/src/ln/outbound_payment.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -164,6 +164,9 @@ pub(crate) enum PendingOutboundPayment {
/// The total payment amount across all paths, used to be able to issue `PaymentSent` if
/// an HTLC still happens to succeed after we marked the payment as abandoned.
total_msat: Option<u64>,
/// Preserved from `Retryable` so we can still report `fee_paid_msat` if an HTLC succeeds after
/// the payment was abandoned. Added in 0.3.
pending_fee_msat: Option<u64>,

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.

Bug: remove() (line 335) only decrements pending_fee_msat for the Retryable variant, not for Abandoned. This means if an MPP payment is manually abandoned with multiple paths in-flight, and then some paths fail back while others succeed, the fee for the failed paths won't be subtracted — causing PaymentSent::fee_paid_msat to be overstated.

Concrete scenario:

  1. Two-path MPP, path A (fee=100) and path B (fee=200) in-flight → pending_fee_msat = Some(300)
  2. abandon_payment()Abandoned { pending_fee_msat: Some(300) }
  3. Path A fails (intermediate node timeout) → remove() removes session_priv but doesn't decrement fee → pending_fee_msat still Some(300)
  4. Path B succeeds (recipient claims) → PaymentSent { fee_paid_msat: Some(300) } — should be Some(200)

The remove() function at line 348-363 needs an additional branch for Abandoned:

ifletPendingOutboundPayment::Abandoned{refmut pending_fee_msat, ..
} = self{let path = path.expect("Removing a failed payment should always come with a path");ifletSome(fee_msat) = pending_fee_msat.as_mut(){*fee_msat -= path.fee_msat();}}

Note: for the auto-abandon path (in handle_update_fail_htlc), remove() is called beforemark_abandoned(), so the fee is correctly captured. This bug only affects the manual-abandon path and any future failures arriving after auto-abandonment.

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.

},
}

Expand DownExpand Up@@ -252,6 +255,7 @@ impl PendingOutboundPayment {
fn get_pending_fee_msat(&self) -> Option<u64> {
match self {
PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
PendingOutboundPayment::Abandoned { pending_fee_msat, .. } => pending_fee_msat.clone(),
_ => None,
}
}
Expand DownExpand Up@@ -308,6 +312,7 @@ impl PendingOutboundPayment {
_ => new_hash_set(),
};
let total_msat = self.total_msat();
let pending_fee_msat = self.get_pending_fee_msat();
match self {
Self::Retryable { payment_hash, .. } |
Self::InvoiceReceived { payment_hash, .. } |
Expand All@@ -318,6 +323,7 @@ impl PendingOutboundPayment {
payment_hash: *payment_hash,
reason: Some(reason),
total_msat,

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.

curious here if we should be setting this to the sum of the current paths currently in-flight, and not the fixed total msat ?

pending_fee_msat,
};
},
_ => {}
Expand DownExpand Up@@ -2778,6 +2784,7 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
(1, reason, upgradable_option),
(2, payment_hash, required),
(3, total_msat, option),
(5, pending_fee_msat, option),
},
(5, AwaitingInvoice) => {
(0, expiration, required),
Expand Down
30 changes: 30 additions & 0 deletions lightning/src/ln/payment_tests.rs
Original file line numberDiff line numberDiff line change
Expand Up@@ -2241,6 +2241,36 @@ fn abandoned_send_payment_idempotent() {
claim_payment(&nodes[0], &[&nodes[1]], second_payment_preimage);
}

#[test]
fn abandoned_payment_fulfilled_preserves_fee_paid_msat() {
// Previously, if we abandoned a payment with HTLCs in-flight and the payment eventually
// succeeded, we would set the `Event::PaymentSent::fee_paid_msat` to None, even though we had
// docs guaranteeing that it would always be Some after 0.0.103.
let chanmon_cfgs = create_chanmon_cfgs(3);
let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
let nodes = create_network(3, &node_cfgs, &node_chanmgrs);

create_announced_chan_between_nodes(&nodes, 0, 1);
create_announced_chan_between_nodes(&nodes, 1, 2);

let amt_msat = 10_000_000;
let (route, payment_hash, payment_preimage, payment_secret) =
get_route_and_payment_hash!(&nodes[0], nodes[2], amt_msat);
let payment_id = PaymentId(payment_hash.0);
let onion = RecipientOnionFields::secret_only(payment_secret, amt_msat);
nodes[0].node.send_payment_with_route(route, payment_hash, onion, payment_id).unwrap();
check_added_monitors(&nodes[0], 1);

let path: &[&Node] = &[&nodes[1], &nodes[2]];
pass_along_route(&nodes[0], &[path], amt_msat, payment_hash, payment_secret);

nodes[0].node.abandon_payment(payment_id);
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());

claim_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[path], payment_preimage));
}

#[derive(PartialEq)]
enum InterceptTest {
Forward,
Expand Down