Skip to content

Expose a failure reason in PaymentFailed - #2142

Merged
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure
Apr 11, 2023
Merged

Expose a failure reason in PaymentFailed#2142
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#2095. Adds a new public enum PaymentFailureReason and a new field on Event::PaymentFailed to communicate why the payment failed completely.

@alecchendevalecchendev left a comment

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.

Some things I’m considering changing right now if anyone wants to give some feedback:

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@codecov-commenter

codecov-commenter commented Apr 1, 2023

Copy link
Copy Markdown

Codecov Report

Patch coverage: 80.00% and project coverage change: +0.24 🎉

Comparison is base (f30dc85) 91.38% compared to head (23c7064) 91.62%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2142 +/- ##
==========================================
+ Coverage 91.38% 91.62% +0.24% 
==========================================
Files 102 102 Lines 50288 52337 +2049 Branches 50288 52337 +2049 ==========================================
+ Hits 45954 47954 +2000 - Misses 4334 4383 +49 
Impacted FilesCoverage Δ
lightning/src/ln/channelmanager.rs92.38% <ø> (+3.02%)⬆️
lightning/src/events/mod.rs33.76% <37.50%> (+0.07%)⬆️
lightning/src/ln/outbound_payment.rs90.01% <77.77%> (-0.68%)⬇️
lightning/src/ln/functional_test_utils.rs92.47% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs98.25% <100.00%> (ø)
lightning/src/ln/onion_route_tests.rs98.48% <100.00%> (+<0.01%)⬆️
lightning/src/ln/payment_tests.rs97.45% <100.00%> (+<0.01%)⬆️

... and 9 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

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

This looks great, thanks!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@TheBlueMattTheBlueMatt added this to the 0.0.115 milestone Apr 3, 2023
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 387d455 to 0383f8bCompareApril 4, 2023 03:41
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Squashed to pass CI and because it was getting messy to read all the fixups since I was changing/merging enum variants and had to undo work from previous commits.

@alecchendev
alecchendev marked this pull request as ready for review April 4, 2023 03:48
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
@alecchendev

alecchendev commented Apr 4, 2023

Copy link
Copy Markdown
ContributorAuthor

Separating my fixup commits so they're easier to squash later even though it'll fail CI how they currently are.

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 4e7731d to 3b11ebbCompareApril 5, 2023 19:58
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 3b11ebb to caf991bCompareApril 5, 2023 21:21

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

Looking good!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@valentinewallace

Copy link
Copy Markdown
Contributor

Feel free to squash!

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from caf991b to 7cf9094CompareApril 7, 2023 01:09

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

LGTM after squash

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 207a3d4 to 17e8d4bCompareApril 7, 2023 18:26
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased and fixed 2 lines for CI - payment_tests.rs line 2924 (the change here doesn't really relate to this PR, don't really know what's normal to do here) and 2959

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Oops that was just fixed in #2170.

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 17e8d4b to 4ba183dCompareApril 7, 2023 18:46
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased again so it's not showing the overlapping change :)

Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment on lines 835 to 829
log_error!(logger, "Failed to send along path due to error: {:?}", e);
if let APIError::MonitorUpdateInProgress = e { continue }

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.

Not a big deal, but ideally we shouldn't log_error if we get APIError::MonitorUpdateInProgress, because it's not an error (🙄). Could conditionally log or move the current log to after the continue

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.

ah thanks

Comment threadlightning/src/ln/outbound_payment.rs Outdated
PaymentFailureReason::RetriesExhausted
};
let _ = payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment
payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment

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.

Can remove the comment

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 508d860 to 5251b39CompareApril 10, 2023 20:15

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

LGTM after squash

This includes adding a reason to `PendingOutboundPayment::Abandoned` and
using that reason when pushing an `Event::PaymentFailed`.
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 5251b39 to 23c7064CompareApril 10, 2023 22:14
@valentinewallace
valentinewallace merged commit 157af6e into lightningdevkit:mainApr 11, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes"
API Updates
===========
* The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107).
* Attempting to claim an un-expired payment on a channel which has closed no
longer fails. The expiry time of payments is exposed via
`PaymentClaimable::claim_deadline` (lightningdevkit#2148).
* `payment_metadata` is now supported in `Invoice` deserialization, sending,
and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127).
* `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142).
* BOLT12 messages now support stateless generation and validation (lightningdevkit#1989).
* The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161).
* Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138).
* `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085).
* A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098).
* `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136).
* `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079).
* `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094).
* `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023).
* The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206).
Backwards Compatibility
=======================
* Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no
longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139).
* `Event::PaymentPathFailed::retry` was removed and will always be `None` for
payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063).
* `Route`s and `PaymentParameters` with blinded path information will not be
readable on prior versions of LDK. Such objects are not currently constructed
by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146).
* Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a
`ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is
in general unsupported, and included here only for completeness.
Bug Fixes
=========
* Fixed a case where `process_events_async` may `poll` a `Future` which has
already completed (lightningdevkit#2081).
* Fixed deserialization of `u16` arrays. This bug may have previously corrupted
the historical buckets in a `ProbabilisticScorer`. Users relying on the
historical buckets may wish to wipe their scorer on upgrade to remove corrupt
data rather than waiting on it to decay (lightningdevkit#2191).
* The `process_events_async` task is now `Send` and can thus be polled on a
multi-threaded runtime (lightningdevkit#2199).
* Fixed a missing macro export causing
`impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091).
* Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187)
* Fix an issue where the `background-processor` would not wake when a
`ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090).
* Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145).
* `Router` calls from the `ChannelManager` now call `find_route_with_id` rather
than `find_route`, as was intended and described in the API (lightningdevkit#2092).
* Ensure `process_events_async` always exits if any sleep future returns true,
not just if all sleep futures repeatedly return true (lightningdevkit#2145).
* `channel_update` messages no longer set the disable bit unless the peer has
been disconnected for some time. This should resolve cases where channels are
disabled for extended periods of time (lightningdevkit#2198).
* We no longer remove CLN nodes from the network graph for violating the BOLT
spec in some cases after failing to pay through them (lightningdevkit#2220).
* Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172).
* `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114)
* Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158).
Security
========
* Transaction re-broadcasting is now substantially more aggressive, including a
new regular rebroadcast feature called on a timer from the
`background-processor` or from `ChainMonitor::rebroadcast_pending_claims`.
This should substantially increase transaction confirmation reliability
without relying on downstream `TransactionBroadcaster` implementations for
rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208).
* Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a
privacy vulnerability which allows an intermediate node on the path to
discover the final destination for a payment (lightningdevkit#2062).
In total, this release features 110 files changed, 11928 insertions, 6368
deletions in 215 commits from 21 authors, in alphabetical order:
* Advait
* Alan Cohen
* Alec Chen
* Allan Douglas R. de Oliveira
* Arik Sosman
* Elias Rohrer
* Evan Feenstra
* Jeffrey Czyz
* John Cantrell
* Lucas Soriano del Pino
* Marc Tyndel
* Matt Corallo
* Paul Miller
* Steven
* Steven Williamson
* Steven Zhao
* Tony Giorgio
* Valentine Wallace
* Wilmer Paulino
* benthecarman
* munjesi
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expose a failure reason in PaymentFailure

4 participants

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

Expose a failure reason in PaymentFailed - #2142

Merged
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure
Apr 11, 2023
Merged

Expose a failure reason in PaymentFailed#2142
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#2095. Adds a new public enum PaymentFailureReason and a new field on Event::PaymentFailed to communicate why the payment failed completely.

@alecchendevalecchendev left a comment

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.

Some things I’m considering changing right now if anyone wants to give some feedback:

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@codecov-commenter

codecov-commenter commented Apr 1, 2023

Copy link
Copy Markdown

Codecov Report

Patch coverage: 80.00% and project coverage change: +0.24 🎉

Comparison is base (f30dc85) 91.38% compared to head (23c7064) 91.62%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2142 +/- ##
==========================================
+ Coverage 91.38% 91.62% +0.24% 
==========================================
Files 102 102 Lines 50288 52337 +2049 Branches 50288 52337 +2049 ==========================================
+ Hits 45954 47954 +2000 - Misses 4334 4383 +49 
Impacted FilesCoverage Δ
lightning/src/ln/channelmanager.rs92.38% <ø> (+3.02%)⬆️
lightning/src/events/mod.rs33.76% <37.50%> (+0.07%)⬆️
lightning/src/ln/outbound_payment.rs90.01% <77.77%> (-0.68%)⬇️
lightning/src/ln/functional_test_utils.rs92.47% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs98.25% <100.00%> (ø)
lightning/src/ln/onion_route_tests.rs98.48% <100.00%> (+<0.01%)⬆️
lightning/src/ln/payment_tests.rs97.45% <100.00%> (+<0.01%)⬆️

... and 9 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

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

This looks great, thanks!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@TheBlueMattTheBlueMatt added this to the 0.0.115 milestone Apr 3, 2023
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 387d455 to 0383f8bCompareApril 4, 2023 03:41
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Squashed to pass CI and because it was getting messy to read all the fixups since I was changing/merging enum variants and had to undo work from previous commits.

@alecchendev
alecchendev marked this pull request as ready for review April 4, 2023 03:48
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
@alecchendev

alecchendev commented Apr 4, 2023

Copy link
Copy Markdown
ContributorAuthor

Separating my fixup commits so they're easier to squash later even though it'll fail CI how they currently are.

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 4e7731d to 3b11ebbCompareApril 5, 2023 19:58
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 3b11ebb to caf991bCompareApril 5, 2023 21:21

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

Looking good!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@valentinewallace

Copy link
Copy Markdown
Contributor

Feel free to squash!

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from caf991b to 7cf9094CompareApril 7, 2023 01:09

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

LGTM after squash

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 207a3d4 to 17e8d4bCompareApril 7, 2023 18:26
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased and fixed 2 lines for CI - payment_tests.rs line 2924 (the change here doesn't really relate to this PR, don't really know what's normal to do here) and 2959

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Oops that was just fixed in #2170.

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 17e8d4b to 4ba183dCompareApril 7, 2023 18:46
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased again so it's not showing the overlapping change :)

Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment on lines 835 to 829
log_error!(logger, "Failed to send along path due to error: {:?}", e);
if let APIError::MonitorUpdateInProgress = e { continue }

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.

Not a big deal, but ideally we shouldn't log_error if we get APIError::MonitorUpdateInProgress, because it's not an error (🙄). Could conditionally log or move the current log to after the continue

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.

ah thanks

Comment threadlightning/src/ln/outbound_payment.rs Outdated
PaymentFailureReason::RetriesExhausted
};
let _ = payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment
payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment

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.

Can remove the comment

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 508d860 to 5251b39CompareApril 10, 2023 20:15

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

LGTM after squash

This includes adding a reason to `PendingOutboundPayment::Abandoned` and
using that reason when pushing an `Event::PaymentFailed`.
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 5251b39 to 23c7064CompareApril 10, 2023 22:14
@valentinewallace
valentinewallace merged commit 157af6e into lightningdevkit:mainApr 11, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes"
API Updates
===========
* The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107).
* Attempting to claim an un-expired payment on a channel which has closed no
longer fails. The expiry time of payments is exposed via
`PaymentClaimable::claim_deadline` (lightningdevkit#2148).
* `payment_metadata` is now supported in `Invoice` deserialization, sending,
and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127).
* `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142).
* BOLT12 messages now support stateless generation and validation (lightningdevkit#1989).
* The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161).
* Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138).
* `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085).
* A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098).
* `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136).
* `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079).
* `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094).
* `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023).
* The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206).
Backwards Compatibility
=======================
* Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no
longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139).
* `Event::PaymentPathFailed::retry` was removed and will always be `None` for
payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063).
* `Route`s and `PaymentParameters` with blinded path information will not be
readable on prior versions of LDK. Such objects are not currently constructed
by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146).
* Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a
`ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is
in general unsupported, and included here only for completeness.
Bug Fixes
=========
* Fixed a case where `process_events_async` may `poll` a `Future` which has
already completed (lightningdevkit#2081).
* Fixed deserialization of `u16` arrays. This bug may have previously corrupted
the historical buckets in a `ProbabilisticScorer`. Users relying on the
historical buckets may wish to wipe their scorer on upgrade to remove corrupt
data rather than waiting on it to decay (lightningdevkit#2191).
* The `process_events_async` task is now `Send` and can thus be polled on a
multi-threaded runtime (lightningdevkit#2199).
* Fixed a missing macro export causing
`impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091).
* Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187)
* Fix an issue where the `background-processor` would not wake when a
`ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090).
* Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145).
* `Router` calls from the `ChannelManager` now call `find_route_with_id` rather
than `find_route`, as was intended and described in the API (lightningdevkit#2092).
* Ensure `process_events_async` always exits if any sleep future returns true,
not just if all sleep futures repeatedly return true (lightningdevkit#2145).
* `channel_update` messages no longer set the disable bit unless the peer has
been disconnected for some time. This should resolve cases where channels are
disabled for extended periods of time (lightningdevkit#2198).
* We no longer remove CLN nodes from the network graph for violating the BOLT
spec in some cases after failing to pay through them (lightningdevkit#2220).
* Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172).
* `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114)
* Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158).
Security
========
* Transaction re-broadcasting is now substantially more aggressive, including a
new regular rebroadcast feature called on a timer from the
`background-processor` or from `ChainMonitor::rebroadcast_pending_claims`.
This should substantially increase transaction confirmation reliability
without relying on downstream `TransactionBroadcaster` implementations for
rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208).
* Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a
privacy vulnerability which allows an intermediate node on the path to
discover the final destination for a payment (lightningdevkit#2062).
In total, this release features 110 files changed, 11928 insertions, 6368
deletions in 215 commits from 21 authors, in alphabetical order:
* Advait
* Alan Cohen
* Alec Chen
* Allan Douglas R. de Oliveira
* Arik Sosman
* Elias Rohrer
* Evan Feenstra
* Jeffrey Czyz
* John Cantrell
* Lucas Soriano del Pino
* Marc Tyndel
* Matt Corallo
* Paul Miller
* Steven
* Steven Williamson
* Steven Zhao
* Tony Giorgio
* Valentine Wallace
* Wilmer Paulino
* benthecarman
* munjesi
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expose a failure reason in PaymentFailure

4 participants

@alecchendev@codecov-commenter@valentinewallace@TheBlueMatt
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Expose a failure reason in `PaymentFailed` by alecchendev · Pull Request #2142 · lightningdevkit/rust-lightning · GitHub
Skip to content

Expose a failure reason in PaymentFailed - #2142

Merged
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure
Apr 11, 2023
Merged

Expose a failure reason in PaymentFailed#2142
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#2095. Adds a new public enum PaymentFailureReason and a new field on Event::PaymentFailed to communicate why the payment failed completely.

@alecchendevalecchendev left a comment

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.

Some things I’m considering changing right now if anyone wants to give some feedback:

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@codecov-commenter

codecov-commenter commented Apr 1, 2023

Copy link
Copy Markdown

Codecov Report

Patch coverage: 80.00% and project coverage change: +0.24 🎉

Comparison is base (f30dc85) 91.38% compared to head (23c7064) 91.62%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2142 +/- ##
==========================================
+ Coverage 91.38% 91.62% +0.24% 
==========================================
Files 102 102 Lines 50288 52337 +2049 Branches 50288 52337 +2049 ==========================================
+ Hits 45954 47954 +2000 - Misses 4334 4383 +49 
Impacted FilesCoverage Δ
lightning/src/ln/channelmanager.rs92.38% <ø> (+3.02%)⬆️
lightning/src/events/mod.rs33.76% <37.50%> (+0.07%)⬆️
lightning/src/ln/outbound_payment.rs90.01% <77.77%> (-0.68%)⬇️
lightning/src/ln/functional_test_utils.rs92.47% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs98.25% <100.00%> (ø)
lightning/src/ln/onion_route_tests.rs98.48% <100.00%> (+<0.01%)⬆️
lightning/src/ln/payment_tests.rs97.45% <100.00%> (+<0.01%)⬆️

... and 9 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

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

This looks great, thanks!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@TheBlueMattTheBlueMatt added this to the 0.0.115 milestone Apr 3, 2023
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 387d455 to 0383f8bCompareApril 4, 2023 03:41
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Squashed to pass CI and because it was getting messy to read all the fixups since I was changing/merging enum variants and had to undo work from previous commits.

@alecchendev
alecchendev marked this pull request as ready for review April 4, 2023 03:48
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
@alecchendev

alecchendev commented Apr 4, 2023

Copy link
Copy Markdown
ContributorAuthor

Separating my fixup commits so they're easier to squash later even though it'll fail CI how they currently are.

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 4e7731d to 3b11ebbCompareApril 5, 2023 19:58
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 3b11ebb to caf991bCompareApril 5, 2023 21:21

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

Looking good!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@valentinewallace

Copy link
Copy Markdown
Contributor

Feel free to squash!

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from caf991b to 7cf9094CompareApril 7, 2023 01:09

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

LGTM after squash

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 207a3d4 to 17e8d4bCompareApril 7, 2023 18:26
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased and fixed 2 lines for CI - payment_tests.rs line 2924 (the change here doesn't really relate to this PR, don't really know what's normal to do here) and 2959

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Oops that was just fixed in #2170.

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 17e8d4b to 4ba183dCompareApril 7, 2023 18:46
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased again so it's not showing the overlapping change :)

Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment on lines 835 to 829
log_error!(logger, "Failed to send along path due to error: {:?}", e);
if let APIError::MonitorUpdateInProgress = e { continue }

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.

Not a big deal, but ideally we shouldn't log_error if we get APIError::MonitorUpdateInProgress, because it's not an error (🙄). Could conditionally log or move the current log to after the continue

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.

ah thanks

Comment threadlightning/src/ln/outbound_payment.rs Outdated
PaymentFailureReason::RetriesExhausted
};
let _ = payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment
payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment

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.

Can remove the comment

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 508d860 to 5251b39CompareApril 10, 2023 20:15

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

LGTM after squash

This includes adding a reason to `PendingOutboundPayment::Abandoned` and
using that reason when pushing an `Event::PaymentFailed`.
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 5251b39 to 23c7064CompareApril 10, 2023 22:14
@valentinewallace
valentinewallace merged commit 157af6e into lightningdevkit:mainApr 11, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes"
API Updates
===========
* The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107).
* Attempting to claim an un-expired payment on a channel which has closed no
longer fails. The expiry time of payments is exposed via
`PaymentClaimable::claim_deadline` (lightningdevkit#2148).
* `payment_metadata` is now supported in `Invoice` deserialization, sending,
and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127).
* `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142).
* BOLT12 messages now support stateless generation and validation (lightningdevkit#1989).
* The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161).
* Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138).
* `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085).
* A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098).
* `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136).
* `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079).
* `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094).
* `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023).
* The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206).
Backwards Compatibility
=======================
* Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no
longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139).
* `Event::PaymentPathFailed::retry` was removed and will always be `None` for
payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063).
* `Route`s and `PaymentParameters` with blinded path information will not be
readable on prior versions of LDK. Such objects are not currently constructed
by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146).
* Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a
`ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is
in general unsupported, and included here only for completeness.
Bug Fixes
=========
* Fixed a case where `process_events_async` may `poll` a `Future` which has
already completed (lightningdevkit#2081).
* Fixed deserialization of `u16` arrays. This bug may have previously corrupted
the historical buckets in a `ProbabilisticScorer`. Users relying on the
historical buckets may wish to wipe their scorer on upgrade to remove corrupt
data rather than waiting on it to decay (lightningdevkit#2191).
* The `process_events_async` task is now `Send` and can thus be polled on a
multi-threaded runtime (lightningdevkit#2199).
* Fixed a missing macro export causing
`impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091).
* Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187)
* Fix an issue where the `background-processor` would not wake when a
`ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090).
* Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145).
* `Router` calls from the `ChannelManager` now call `find_route_with_id` rather
than `find_route`, as was intended and described in the API (lightningdevkit#2092).
* Ensure `process_events_async` always exits if any sleep future returns true,
not just if all sleep futures repeatedly return true (lightningdevkit#2145).
* `channel_update` messages no longer set the disable bit unless the peer has
been disconnected for some time. This should resolve cases where channels are
disabled for extended periods of time (lightningdevkit#2198).
* We no longer remove CLN nodes from the network graph for violating the BOLT
spec in some cases after failing to pay through them (lightningdevkit#2220).
* Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172).
* `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114)
* Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158).
Security
========
* Transaction re-broadcasting is now substantially more aggressive, including a
new regular rebroadcast feature called on a timer from the
`background-processor` or from `ChainMonitor::rebroadcast_pending_claims`.
This should substantially increase transaction confirmation reliability
without relying on downstream `TransactionBroadcaster` implementations for
rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208).
* Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a
privacy vulnerability which allows an intermediate node on the path to
discover the final destination for a payment (lightningdevkit#2062).
In total, this release features 110 files changed, 11928 insertions, 6368
deletions in 215 commits from 21 authors, in alphabetical order:
* Advait
* Alan Cohen
* Alec Chen
* Allan Douglas R. de Oliveira
* Arik Sosman
* Elias Rohrer
* Evan Feenstra
* Jeffrey Czyz
* John Cantrell
* Lucas Soriano del Pino
* Marc Tyndel
* Matt Corallo
* Paul Miller
* Steven
* Steven Williamson
* Steven Zhao
* Tony Giorgio
* Valentine Wallace
* Wilmer Paulino
* benthecarman
* munjesi
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expose a failure reason in PaymentFailure

4 participants

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

Expose a failure reason in PaymentFailed - #2142

Merged
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure
Apr 11, 2023
Merged

Expose a failure reason in PaymentFailed#2142
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#2095. Adds a new public enum PaymentFailureReason and a new field on Event::PaymentFailed to communicate why the payment failed completely.

@alecchendevalecchendev left a comment

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.

Some things I’m considering changing right now if anyone wants to give some feedback:

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@codecov-commenter

codecov-commenter commented Apr 1, 2023

Copy link
Copy Markdown

Codecov Report

Patch coverage: 80.00% and project coverage change: +0.24 🎉

Comparison is base (f30dc85) 91.38% compared to head (23c7064) 91.62%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2142 +/- ##
==========================================
+ Coverage 91.38% 91.62% +0.24% 
==========================================
Files 102 102 Lines 50288 52337 +2049 Branches 50288 52337 +2049 ==========================================
+ Hits 45954 47954 +2000 - Misses 4334 4383 +49 
Impacted FilesCoverage Δ
lightning/src/ln/channelmanager.rs92.38% <ø> (+3.02%)⬆️
lightning/src/events/mod.rs33.76% <37.50%> (+0.07%)⬆️
lightning/src/ln/outbound_payment.rs90.01% <77.77%> (-0.68%)⬇️
lightning/src/ln/functional_test_utils.rs92.47% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs98.25% <100.00%> (ø)
lightning/src/ln/onion_route_tests.rs98.48% <100.00%> (+<0.01%)⬆️
lightning/src/ln/payment_tests.rs97.45% <100.00%> (+<0.01%)⬆️

... and 9 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

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

This looks great, thanks!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@TheBlueMattTheBlueMatt added this to the 0.0.115 milestone Apr 3, 2023
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 387d455 to 0383f8bCompareApril 4, 2023 03:41
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Squashed to pass CI and because it was getting messy to read all the fixups since I was changing/merging enum variants and had to undo work from previous commits.

@alecchendev
alecchendev marked this pull request as ready for review April 4, 2023 03:48
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
@alecchendev

alecchendev commented Apr 4, 2023

Copy link
Copy Markdown
ContributorAuthor

Separating my fixup commits so they're easier to squash later even though it'll fail CI how they currently are.

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 4e7731d to 3b11ebbCompareApril 5, 2023 19:58
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 3b11ebb to caf991bCompareApril 5, 2023 21:21

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

Looking good!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@valentinewallace

Copy link
Copy Markdown
Contributor

Feel free to squash!

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from caf991b to 7cf9094CompareApril 7, 2023 01:09

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

LGTM after squash

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 207a3d4 to 17e8d4bCompareApril 7, 2023 18:26
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased and fixed 2 lines for CI - payment_tests.rs line 2924 (the change here doesn't really relate to this PR, don't really know what's normal to do here) and 2959

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Oops that was just fixed in #2170.

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 17e8d4b to 4ba183dCompareApril 7, 2023 18:46
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased again so it's not showing the overlapping change :)

Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment on lines 835 to 829
log_error!(logger, "Failed to send along path due to error: {:?}", e);
if let APIError::MonitorUpdateInProgress = e { continue }

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.

Not a big deal, but ideally we shouldn't log_error if we get APIError::MonitorUpdateInProgress, because it's not an error (🙄). Could conditionally log or move the current log to after the continue

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.

ah thanks

Comment threadlightning/src/ln/outbound_payment.rs Outdated
PaymentFailureReason::RetriesExhausted
};
let _ = payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment
payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment

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.

Can remove the comment

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 508d860 to 5251b39CompareApril 10, 2023 20:15

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

LGTM after squash

This includes adding a reason to `PendingOutboundPayment::Abandoned` and
using that reason when pushing an `Event::PaymentFailed`.
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 5251b39 to 23c7064CompareApril 10, 2023 22:14
@valentinewallace
valentinewallace merged commit 157af6e into lightningdevkit:mainApr 11, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes"
API Updates
===========
* The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107).
* Attempting to claim an un-expired payment on a channel which has closed no
longer fails. The expiry time of payments is exposed via
`PaymentClaimable::claim_deadline` (lightningdevkit#2148).
* `payment_metadata` is now supported in `Invoice` deserialization, sending,
and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127).
* `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142).
* BOLT12 messages now support stateless generation and validation (lightningdevkit#1989).
* The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161).
* Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138).
* `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085).
* A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098).
* `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136).
* `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079).
* `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094).
* `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023).
* The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206).
Backwards Compatibility
=======================
* Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no
longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139).
* `Event::PaymentPathFailed::retry` was removed and will always be `None` for
payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063).
* `Route`s and `PaymentParameters` with blinded path information will not be
readable on prior versions of LDK. Such objects are not currently constructed
by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146).
* Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a
`ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is
in general unsupported, and included here only for completeness.
Bug Fixes
=========
* Fixed a case where `process_events_async` may `poll` a `Future` which has
already completed (lightningdevkit#2081).
* Fixed deserialization of `u16` arrays. This bug may have previously corrupted
the historical buckets in a `ProbabilisticScorer`. Users relying on the
historical buckets may wish to wipe their scorer on upgrade to remove corrupt
data rather than waiting on it to decay (lightningdevkit#2191).
* The `process_events_async` task is now `Send` and can thus be polled on a
multi-threaded runtime (lightningdevkit#2199).
* Fixed a missing macro export causing
`impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091).
* Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187)
* Fix an issue where the `background-processor` would not wake when a
`ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090).
* Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145).
* `Router` calls from the `ChannelManager` now call `find_route_with_id` rather
than `find_route`, as was intended and described in the API (lightningdevkit#2092).
* Ensure `process_events_async` always exits if any sleep future returns true,
not just if all sleep futures repeatedly return true (lightningdevkit#2145).
* `channel_update` messages no longer set the disable bit unless the peer has
been disconnected for some time. This should resolve cases where channels are
disabled for extended periods of time (lightningdevkit#2198).
* We no longer remove CLN nodes from the network graph for violating the BOLT
spec in some cases after failing to pay through them (lightningdevkit#2220).
* Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172).
* `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114)
* Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158).
Security
========
* Transaction re-broadcasting is now substantially more aggressive, including a
new regular rebroadcast feature called on a timer from the
`background-processor` or from `ChainMonitor::rebroadcast_pending_claims`.
This should substantially increase transaction confirmation reliability
without relying on downstream `TransactionBroadcaster` implementations for
rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208).
* Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a
privacy vulnerability which allows an intermediate node on the path to
discover the final destination for a payment (lightningdevkit#2062).
In total, this release features 110 files changed, 11928 insertions, 6368
deletions in 215 commits from 21 authors, in alphabetical order:
* Advait
* Alan Cohen
* Alec Chen
* Allan Douglas R. de Oliveira
* Arik Sosman
* Elias Rohrer
* Evan Feenstra
* Jeffrey Czyz
* John Cantrell
* Lucas Soriano del Pino
* Marc Tyndel
* Matt Corallo
* Paul Miller
* Steven
* Steven Williamson
* Steven Zhao
* Tony Giorgio
* Valentine Wallace
* Wilmer Paulino
* benthecarman
* munjesi
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expose a failure reason in PaymentFailure

4 participants

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

Expose a failure reason in PaymentFailed - #2142

Merged
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure
Apr 11, 2023
Merged

Expose a failure reason in PaymentFailed#2142
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#2095. Adds a new public enum PaymentFailureReason and a new field on Event::PaymentFailed to communicate why the payment failed completely.

@alecchendevalecchendev left a comment

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.

Some things I’m considering changing right now if anyone wants to give some feedback:

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@codecov-commenter

codecov-commenter commented Apr 1, 2023

Copy link
Copy Markdown

Codecov Report

Patch coverage: 80.00% and project coverage change: +0.24 🎉

Comparison is base (f30dc85) 91.38% compared to head (23c7064) 91.62%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2142 +/- ##
==========================================
+ Coverage 91.38% 91.62% +0.24% 
==========================================
Files 102 102 Lines 50288 52337 +2049 Branches 50288 52337 +2049 ==========================================
+ Hits 45954 47954 +2000 - Misses 4334 4383 +49 
Impacted FilesCoverage Δ
lightning/src/ln/channelmanager.rs92.38% <ø> (+3.02%)⬆️
lightning/src/events/mod.rs33.76% <37.50%> (+0.07%)⬆️
lightning/src/ln/outbound_payment.rs90.01% <77.77%> (-0.68%)⬇️
lightning/src/ln/functional_test_utils.rs92.47% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs98.25% <100.00%> (ø)
lightning/src/ln/onion_route_tests.rs98.48% <100.00%> (+<0.01%)⬆️
lightning/src/ln/payment_tests.rs97.45% <100.00%> (+<0.01%)⬆️

... and 9 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

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

This looks great, thanks!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@TheBlueMattTheBlueMatt added this to the 0.0.115 milestone Apr 3, 2023
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 387d455 to 0383f8bCompareApril 4, 2023 03:41
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Squashed to pass CI and because it was getting messy to read all the fixups since I was changing/merging enum variants and had to undo work from previous commits.

@alecchendev
alecchendev marked this pull request as ready for review April 4, 2023 03:48
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
@alecchendev

alecchendev commented Apr 4, 2023

Copy link
Copy Markdown
ContributorAuthor

Separating my fixup commits so they're easier to squash later even though it'll fail CI how they currently are.

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 4e7731d to 3b11ebbCompareApril 5, 2023 19:58
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 3b11ebb to caf991bCompareApril 5, 2023 21:21

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

Looking good!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@valentinewallace

Copy link
Copy Markdown
Contributor

Feel free to squash!

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from caf991b to 7cf9094CompareApril 7, 2023 01:09

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

LGTM after squash

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 207a3d4 to 17e8d4bCompareApril 7, 2023 18:26
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased and fixed 2 lines for CI - payment_tests.rs line 2924 (the change here doesn't really relate to this PR, don't really know what's normal to do here) and 2959

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Oops that was just fixed in #2170.

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 17e8d4b to 4ba183dCompareApril 7, 2023 18:46
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased again so it's not showing the overlapping change :)

Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment on lines 835 to 829
log_error!(logger, "Failed to send along path due to error: {:?}", e);
if let APIError::MonitorUpdateInProgress = e { continue }

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.

Not a big deal, but ideally we shouldn't log_error if we get APIError::MonitorUpdateInProgress, because it's not an error (🙄). Could conditionally log or move the current log to after the continue

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.

ah thanks

Comment threadlightning/src/ln/outbound_payment.rs Outdated
PaymentFailureReason::RetriesExhausted
};
let _ = payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment
payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment

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.

Can remove the comment

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 508d860 to 5251b39CompareApril 10, 2023 20:15

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

LGTM after squash

This includes adding a reason to `PendingOutboundPayment::Abandoned` and
using that reason when pushing an `Event::PaymentFailed`.
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 5251b39 to 23c7064CompareApril 10, 2023 22:14
@valentinewallace
valentinewallace merged commit 157af6e into lightningdevkit:mainApr 11, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes"
API Updates
===========
* The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107).
* Attempting to claim an un-expired payment on a channel which has closed no
longer fails. The expiry time of payments is exposed via
`PaymentClaimable::claim_deadline` (lightningdevkit#2148).
* `payment_metadata` is now supported in `Invoice` deserialization, sending,
and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127).
* `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142).
* BOLT12 messages now support stateless generation and validation (lightningdevkit#1989).
* The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161).
* Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138).
* `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085).
* A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098).
* `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136).
* `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079).
* `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094).
* `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023).
* The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206).
Backwards Compatibility
=======================
* Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no
longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139).
* `Event::PaymentPathFailed::retry` was removed and will always be `None` for
payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063).
* `Route`s and `PaymentParameters` with blinded path information will not be
readable on prior versions of LDK. Such objects are not currently constructed
by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146).
* Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a
`ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is
in general unsupported, and included here only for completeness.
Bug Fixes
=========
* Fixed a case where `process_events_async` may `poll` a `Future` which has
already completed (lightningdevkit#2081).
* Fixed deserialization of `u16` arrays. This bug may have previously corrupted
the historical buckets in a `ProbabilisticScorer`. Users relying on the
historical buckets may wish to wipe their scorer on upgrade to remove corrupt
data rather than waiting on it to decay (lightningdevkit#2191).
* The `process_events_async` task is now `Send` and can thus be polled on a
multi-threaded runtime (lightningdevkit#2199).
* Fixed a missing macro export causing
`impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091).
* Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187)
* Fix an issue where the `background-processor` would not wake when a
`ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090).
* Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145).
* `Router` calls from the `ChannelManager` now call `find_route_with_id` rather
than `find_route`, as was intended and described in the API (lightningdevkit#2092).
* Ensure `process_events_async` always exits if any sleep future returns true,
not just if all sleep futures repeatedly return true (lightningdevkit#2145).
* `channel_update` messages no longer set the disable bit unless the peer has
been disconnected for some time. This should resolve cases where channels are
disabled for extended periods of time (lightningdevkit#2198).
* We no longer remove CLN nodes from the network graph for violating the BOLT
spec in some cases after failing to pay through them (lightningdevkit#2220).
* Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172).
* `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114)
* Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158).
Security
========
* Transaction re-broadcasting is now substantially more aggressive, including a
new regular rebroadcast feature called on a timer from the
`background-processor` or from `ChainMonitor::rebroadcast_pending_claims`.
This should substantially increase transaction confirmation reliability
without relying on downstream `TransactionBroadcaster` implementations for
rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208).
* Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a
privacy vulnerability which allows an intermediate node on the path to
discover the final destination for a payment (lightningdevkit#2062).
In total, this release features 110 files changed, 11928 insertions, 6368
deletions in 215 commits from 21 authors, in alphabetical order:
* Advait
* Alan Cohen
* Alec Chen
* Allan Douglas R. de Oliveira
* Arik Sosman
* Elias Rohrer
* Evan Feenstra
* Jeffrey Czyz
* John Cantrell
* Lucas Soriano del Pino
* Marc Tyndel
* Matt Corallo
* Paul Miller
* Steven
* Steven Williamson
* Steven Zhao
* Tony Giorgio
* Valentine Wallace
* Wilmer Paulino
* benthecarman
* munjesi
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expose a failure reason in PaymentFailure

4 participants

@alecchendev@codecov-commenter@valentinewallace@TheBlueMatt
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Expose a failure reason in `PaymentFailed` by alecchendev · Pull Request #2142 · lightningdevkit/rust-lightning · GitHub
Skip to content

Expose a failure reason in PaymentFailed - #2142

Merged
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure
Apr 11, 2023
Merged

Expose a failure reason in PaymentFailed#2142
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#2095. Adds a new public enum PaymentFailureReason and a new field on Event::PaymentFailed to communicate why the payment failed completely.

@alecchendevalecchendev left a comment

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.

Some things I’m considering changing right now if anyone wants to give some feedback:

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@codecov-commenter

codecov-commenter commented Apr 1, 2023

Copy link
Copy Markdown

Codecov Report

Patch coverage: 80.00% and project coverage change: +0.24 🎉

Comparison is base (f30dc85) 91.38% compared to head (23c7064) 91.62%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2142 +/- ##
==========================================
+ Coverage 91.38% 91.62% +0.24% 
==========================================
Files 102 102 Lines 50288 52337 +2049 Branches 50288 52337 +2049 ==========================================
+ Hits 45954 47954 +2000 - Misses 4334 4383 +49 
Impacted FilesCoverage Δ
lightning/src/ln/channelmanager.rs92.38% <ø> (+3.02%)⬆️
lightning/src/events/mod.rs33.76% <37.50%> (+0.07%)⬆️
lightning/src/ln/outbound_payment.rs90.01% <77.77%> (-0.68%)⬇️
lightning/src/ln/functional_test_utils.rs92.47% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs98.25% <100.00%> (ø)
lightning/src/ln/onion_route_tests.rs98.48% <100.00%> (+<0.01%)⬆️
lightning/src/ln/payment_tests.rs97.45% <100.00%> (+<0.01%)⬆️

... and 9 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

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

This looks great, thanks!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@TheBlueMattTheBlueMatt added this to the 0.0.115 milestone Apr 3, 2023
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 387d455 to 0383f8bCompareApril 4, 2023 03:41
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Squashed to pass CI and because it was getting messy to read all the fixups since I was changing/merging enum variants and had to undo work from previous commits.

@alecchendev
alecchendev marked this pull request as ready for review April 4, 2023 03:48
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
@alecchendev

alecchendev commented Apr 4, 2023

Copy link
Copy Markdown
ContributorAuthor

Separating my fixup commits so they're easier to squash later even though it'll fail CI how they currently are.

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 4e7731d to 3b11ebbCompareApril 5, 2023 19:58
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 3b11ebb to caf991bCompareApril 5, 2023 21:21

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

Looking good!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@valentinewallace

Copy link
Copy Markdown
Contributor

Feel free to squash!

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from caf991b to 7cf9094CompareApril 7, 2023 01:09

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

LGTM after squash

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 207a3d4 to 17e8d4bCompareApril 7, 2023 18:26
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased and fixed 2 lines for CI - payment_tests.rs line 2924 (the change here doesn't really relate to this PR, don't really know what's normal to do here) and 2959

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Oops that was just fixed in #2170.

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 17e8d4b to 4ba183dCompareApril 7, 2023 18:46
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased again so it's not showing the overlapping change :)

Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment on lines 835 to 829
log_error!(logger, "Failed to send along path due to error: {:?}", e);
if let APIError::MonitorUpdateInProgress = e { continue }

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.

Not a big deal, but ideally we shouldn't log_error if we get APIError::MonitorUpdateInProgress, because it's not an error (🙄). Could conditionally log or move the current log to after the continue

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.

ah thanks

Comment threadlightning/src/ln/outbound_payment.rs Outdated
PaymentFailureReason::RetriesExhausted
};
let _ = payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment
payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment

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.

Can remove the comment

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 508d860 to 5251b39CompareApril 10, 2023 20:15

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

LGTM after squash

This includes adding a reason to `PendingOutboundPayment::Abandoned` and
using that reason when pushing an `Event::PaymentFailed`.
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 5251b39 to 23c7064CompareApril 10, 2023 22:14
@valentinewallace
valentinewallace merged commit 157af6e into lightningdevkit:mainApr 11, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes"
API Updates
===========
* The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107).
* Attempting to claim an un-expired payment on a channel which has closed no
longer fails. The expiry time of payments is exposed via
`PaymentClaimable::claim_deadline` (lightningdevkit#2148).
* `payment_metadata` is now supported in `Invoice` deserialization, sending,
and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127).
* `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142).
* BOLT12 messages now support stateless generation and validation (lightningdevkit#1989).
* The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161).
* Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138).
* `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085).
* A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098).
* `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136).
* `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079).
* `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094).
* `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023).
* The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206).
Backwards Compatibility
=======================
* Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no
longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139).
* `Event::PaymentPathFailed::retry` was removed and will always be `None` for
payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063).
* `Route`s and `PaymentParameters` with blinded path information will not be
readable on prior versions of LDK. Such objects are not currently constructed
by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146).
* Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a
`ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is
in general unsupported, and included here only for completeness.
Bug Fixes
=========
* Fixed a case where `process_events_async` may `poll` a `Future` which has
already completed (lightningdevkit#2081).
* Fixed deserialization of `u16` arrays. This bug may have previously corrupted
the historical buckets in a `ProbabilisticScorer`. Users relying on the
historical buckets may wish to wipe their scorer on upgrade to remove corrupt
data rather than waiting on it to decay (lightningdevkit#2191).
* The `process_events_async` task is now `Send` and can thus be polled on a
multi-threaded runtime (lightningdevkit#2199).
* Fixed a missing macro export causing
`impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091).
* Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187)
* Fix an issue where the `background-processor` would not wake when a
`ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090).
* Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145).
* `Router` calls from the `ChannelManager` now call `find_route_with_id` rather
than `find_route`, as was intended and described in the API (lightningdevkit#2092).
* Ensure `process_events_async` always exits if any sleep future returns true,
not just if all sleep futures repeatedly return true (lightningdevkit#2145).
* `channel_update` messages no longer set the disable bit unless the peer has
been disconnected for some time. This should resolve cases where channels are
disabled for extended periods of time (lightningdevkit#2198).
* We no longer remove CLN nodes from the network graph for violating the BOLT
spec in some cases after failing to pay through them (lightningdevkit#2220).
* Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172).
* `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114)
* Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158).
Security
========
* Transaction re-broadcasting is now substantially more aggressive, including a
new regular rebroadcast feature called on a timer from the
`background-processor` or from `ChainMonitor::rebroadcast_pending_claims`.
This should substantially increase transaction confirmation reliability
without relying on downstream `TransactionBroadcaster` implementations for
rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208).
* Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a
privacy vulnerability which allows an intermediate node on the path to
discover the final destination for a payment (lightningdevkit#2062).
In total, this release features 110 files changed, 11928 insertions, 6368
deletions in 215 commits from 21 authors, in alphabetical order:
* Advait
* Alan Cohen
* Alec Chen
* Allan Douglas R. de Oliveira
* Arik Sosman
* Elias Rohrer
* Evan Feenstra
* Jeffrey Czyz
* John Cantrell
* Lucas Soriano del Pino
* Marc Tyndel
* Matt Corallo
* Paul Miller
* Steven
* Steven Williamson
* Steven Zhao
* Tony Giorgio
* Valentine Wallace
* Wilmer Paulino
* benthecarman
* munjesi
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expose a failure reason in PaymentFailure

4 participants

@alecchendev@codecov-commenter@valentinewallace@TheBlueMatt
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Expose a failure reason in `PaymentFailed` by alecchendev · Pull Request #2142 · lightningdevkit/rust-lightning · GitHub
Skip to content

Expose a failure reason in PaymentFailed - #2142

Merged
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure
Apr 11, 2023
Merged

Expose a failure reason in PaymentFailed#2142
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#2095. Adds a new public enum PaymentFailureReason and a new field on Event::PaymentFailed to communicate why the payment failed completely.

@alecchendevalecchendev left a comment

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.

Some things I’m considering changing right now if anyone wants to give some feedback:

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@codecov-commenter

codecov-commenter commented Apr 1, 2023

Copy link
Copy Markdown

Codecov Report

Patch coverage: 80.00% and project coverage change: +0.24 🎉

Comparison is base (f30dc85) 91.38% compared to head (23c7064) 91.62%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2142 +/- ##
==========================================
+ Coverage 91.38% 91.62% +0.24% 
==========================================
Files 102 102 Lines 50288 52337 +2049 Branches 50288 52337 +2049 ==========================================
+ Hits 45954 47954 +2000 - Misses 4334 4383 +49 
Impacted FilesCoverage Δ
lightning/src/ln/channelmanager.rs92.38% <ø> (+3.02%)⬆️
lightning/src/events/mod.rs33.76% <37.50%> (+0.07%)⬆️
lightning/src/ln/outbound_payment.rs90.01% <77.77%> (-0.68%)⬇️
lightning/src/ln/functional_test_utils.rs92.47% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs98.25% <100.00%> (ø)
lightning/src/ln/onion_route_tests.rs98.48% <100.00%> (+<0.01%)⬆️
lightning/src/ln/payment_tests.rs97.45% <100.00%> (+<0.01%)⬆️

... and 9 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

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

This looks great, thanks!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@TheBlueMattTheBlueMatt added this to the 0.0.115 milestone Apr 3, 2023
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 387d455 to 0383f8bCompareApril 4, 2023 03:41
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Squashed to pass CI and because it was getting messy to read all the fixups since I was changing/merging enum variants and had to undo work from previous commits.

@alecchendev
alecchendev marked this pull request as ready for review April 4, 2023 03:48
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
@alecchendev

alecchendev commented Apr 4, 2023

Copy link
Copy Markdown
ContributorAuthor

Separating my fixup commits so they're easier to squash later even though it'll fail CI how they currently are.

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 4e7731d to 3b11ebbCompareApril 5, 2023 19:58
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 3b11ebb to caf991bCompareApril 5, 2023 21:21

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

Looking good!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@valentinewallace

Copy link
Copy Markdown
Contributor

Feel free to squash!

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from caf991b to 7cf9094CompareApril 7, 2023 01:09

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

LGTM after squash

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 207a3d4 to 17e8d4bCompareApril 7, 2023 18:26
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased and fixed 2 lines for CI - payment_tests.rs line 2924 (the change here doesn't really relate to this PR, don't really know what's normal to do here) and 2959

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Oops that was just fixed in #2170.

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 17e8d4b to 4ba183dCompareApril 7, 2023 18:46
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased again so it's not showing the overlapping change :)

Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment on lines 835 to 829
log_error!(logger, "Failed to send along path due to error: {:?}", e);
if let APIError::MonitorUpdateInProgress = e { continue }

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.

Not a big deal, but ideally we shouldn't log_error if we get APIError::MonitorUpdateInProgress, because it's not an error (🙄). Could conditionally log or move the current log to after the continue

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.

ah thanks

Comment threadlightning/src/ln/outbound_payment.rs Outdated
PaymentFailureReason::RetriesExhausted
};
let _ = payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment
payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment

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.

Can remove the comment

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 508d860 to 5251b39CompareApril 10, 2023 20:15

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

LGTM after squash

This includes adding a reason to `PendingOutboundPayment::Abandoned` and
using that reason when pushing an `Event::PaymentFailed`.
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 5251b39 to 23c7064CompareApril 10, 2023 22:14
@valentinewallace
valentinewallace merged commit 157af6e into lightningdevkit:mainApr 11, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes"
API Updates
===========
* The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107).
* Attempting to claim an un-expired payment on a channel which has closed no
longer fails. The expiry time of payments is exposed via
`PaymentClaimable::claim_deadline` (lightningdevkit#2148).
* `payment_metadata` is now supported in `Invoice` deserialization, sending,
and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127).
* `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142).
* BOLT12 messages now support stateless generation and validation (lightningdevkit#1989).
* The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161).
* Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138).
* `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085).
* A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098).
* `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136).
* `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079).
* `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094).
* `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023).
* The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206).
Backwards Compatibility
=======================
* Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no
longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139).
* `Event::PaymentPathFailed::retry` was removed and will always be `None` for
payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063).
* `Route`s and `PaymentParameters` with blinded path information will not be
readable on prior versions of LDK. Such objects are not currently constructed
by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146).
* Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a
`ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is
in general unsupported, and included here only for completeness.
Bug Fixes
=========
* Fixed a case where `process_events_async` may `poll` a `Future` which has
already completed (lightningdevkit#2081).
* Fixed deserialization of `u16` arrays. This bug may have previously corrupted
the historical buckets in a `ProbabilisticScorer`. Users relying on the
historical buckets may wish to wipe their scorer on upgrade to remove corrupt
data rather than waiting on it to decay (lightningdevkit#2191).
* The `process_events_async` task is now `Send` and can thus be polled on a
multi-threaded runtime (lightningdevkit#2199).
* Fixed a missing macro export causing
`impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091).
* Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187)
* Fix an issue where the `background-processor` would not wake when a
`ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090).
* Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145).
* `Router` calls from the `ChannelManager` now call `find_route_with_id` rather
than `find_route`, as was intended and described in the API (lightningdevkit#2092).
* Ensure `process_events_async` always exits if any sleep future returns true,
not just if all sleep futures repeatedly return true (lightningdevkit#2145).
* `channel_update` messages no longer set the disable bit unless the peer has
been disconnected for some time. This should resolve cases where channels are
disabled for extended periods of time (lightningdevkit#2198).
* We no longer remove CLN nodes from the network graph for violating the BOLT
spec in some cases after failing to pay through them (lightningdevkit#2220).
* Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172).
* `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114)
* Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158).
Security
========
* Transaction re-broadcasting is now substantially more aggressive, including a
new regular rebroadcast feature called on a timer from the
`background-processor` or from `ChainMonitor::rebroadcast_pending_claims`.
This should substantially increase transaction confirmation reliability
without relying on downstream `TransactionBroadcaster` implementations for
rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208).
* Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a
privacy vulnerability which allows an intermediate node on the path to
discover the final destination for a payment (lightningdevkit#2062).
In total, this release features 110 files changed, 11928 insertions, 6368
deletions in 215 commits from 21 authors, in alphabetical order:
* Advait
* Alan Cohen
* Alec Chen
* Allan Douglas R. de Oliveira
* Arik Sosman
* Elias Rohrer
* Evan Feenstra
* Jeffrey Czyz
* John Cantrell
* Lucas Soriano del Pino
* Marc Tyndel
* Matt Corallo
* Paul Miller
* Steven
* Steven Williamson
* Steven Zhao
* Tony Giorgio
* Valentine Wallace
* Wilmer Paulino
* benthecarman
* munjesi
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expose a failure reason in PaymentFailure

4 participants

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

Expose a failure reason in PaymentFailed - #2142

Merged
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure
Apr 11, 2023
Merged

Expose a failure reason in PaymentFailed#2142
valentinewallace merged 2 commits into
lightningdevkit:mainfrom
alecchendev:2023-03-expose-fail-reason-in-payment-failure

Conversation

@alecchendev

Copy link
Copy Markdown
Contributor

Closes#2095. Adds a new public enum PaymentFailureReason and a new field on Event::PaymentFailed to communicate why the payment failed completely.

@alecchendevalecchendev left a comment

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.

Some things I’m considering changing right now if anyone wants to give some feedback:

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@codecov-commenter

codecov-commenter commented Apr 1, 2023

Copy link
Copy Markdown

Codecov Report

Patch coverage: 80.00% and project coverage change: +0.24 🎉

Comparison is base (f30dc85) 91.38% compared to head (23c7064) 91.62%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files
@@ Coverage Diff @@## main #2142 +/- ##
==========================================
+ Coverage 91.38% 91.62% +0.24% 
==========================================
Files 102 102 Lines 50288 52337 +2049 Branches 50288 52337 +2049 ==========================================
+ Hits 45954 47954 +2000 - Misses 4334 4383 +49 
Impacted FilesCoverage Δ
lightning/src/ln/channelmanager.rs92.38% <ø> (+3.02%)⬆️
lightning/src/events/mod.rs33.76% <37.50%> (+0.07%)⬆️
lightning/src/ln/outbound_payment.rs90.01% <77.77%> (-0.68%)⬇️
lightning/src/ln/functional_test_utils.rs92.47% <100.00%> (+0.01%)⬆️
lightning/src/ln/functional_tests.rs98.25% <100.00%> (ø)
lightning/src/ln/onion_route_tests.rs98.48% <100.00%> (+<0.01%)⬆️
lightning/src/ln/payment_tests.rs97.45% <100.00%> (+<0.01%)⬆️

... and 9 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

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

This looks great, thanks!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@TheBlueMattTheBlueMatt added this to the 0.0.115 milestone Apr 3, 2023
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 387d455 to 0383f8bCompareApril 4, 2023 03:41
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Squashed to pass CI and because it was getting messy to read all the fixups since I was changing/merging enum variants and had to undo work from previous commits.

@alecchendev
alecchendev marked this pull request as ready for review April 4, 2023 03:48
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
@alecchendev

alecchendev commented Apr 4, 2023

Copy link
Copy Markdown
ContributorAuthor

Separating my fixup commits so they're easier to squash later even though it'll fail CI how they currently are.

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 4e7731d to 3b11ebbCompareApril 5, 2023 19:58
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 3b11ebb to caf991bCompareApril 5, 2023 21:21

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

Looking good!

Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/events/mod.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
@valentinewallace

Copy link
Copy Markdown
Contributor

Feel free to squash!

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from caf991b to 7cf9094CompareApril 7, 2023 01:09

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

LGTM after squash

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch 3 times, most recently from 207a3d4 to 17e8d4bCompareApril 7, 2023 18:26
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased and fixed 2 lines for CI - payment_tests.rs line 2924 (the change here doesn't really relate to this PR, don't really know what's normal to do here) and 2959

@TheBlueMatt

Copy link
Copy Markdown
Collaborator

Oops that was just fixed in #2170.

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 17e8d4b to 4ba183dCompareApril 7, 2023 18:46
@alecchendev

Copy link
Copy Markdown
ContributorAuthor

Rebased again so it's not showing the overlapping change :)

Comment threadlightning/src/ln/outbound_payment.rs
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment threadlightning/src/ln/outbound_payment.rs Outdated
Comment on lines 835 to 829
log_error!(logger, "Failed to send along path due to error: {:?}", e);
if let APIError::MonitorUpdateInProgress = e { continue }

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.

Not a big deal, but ideally we shouldn't log_error if we get APIError::MonitorUpdateInProgress, because it's not an error (🙄). Could conditionally log or move the current log to after the continue

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.

ah thanks

Comment threadlightning/src/ln/outbound_payment.rs Outdated
PaymentFailureReason::RetriesExhausted
};
let _ = payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment
payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment

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.

Can remove the comment

@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 508d860 to 5251b39CompareApril 10, 2023 20:15

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

LGTM after squash

This includes adding a reason to `PendingOutboundPayment::Abandoned` and
using that reason when pushing an `Event::PaymentFailed`.
@alecchendev
alecchendevforce-pushed the 2023-03-expose-fail-reason-in-payment-failure branch from 5251b39 to 23c7064CompareApril 10, 2023 22:14
@valentinewallace
valentinewallace merged commit 157af6e into lightningdevkit:mainApr 11, 2023
PXplod pushed a commit to bitlightlabs/rust-lightning that referenced this pull request Sep 30, 2024
0.0.115 - Apr 24, 2023 - "Rebroadcast the Bugfixes"
API Updates
===========
* The MSRV of the main LDK crates has been increased to 1.48 (lightningdevkit#2107).
* Attempting to claim an un-expired payment on a channel which has closed no
longer fails. The expiry time of payments is exposed via
`PaymentClaimable::claim_deadline` (lightningdevkit#2148).
* `payment_metadata` is now supported in `Invoice` deserialization, sending,
and receiving (via a new `RecipientOnionFields` struct) (lightningdevkit#2139, lightningdevkit#2127).
* `Event::PaymentFailed` now exposes a failure reason (lightningdevkit#2142).
* BOLT12 messages now support stateless generation and validation (lightningdevkit#1989).
* The `NetworkGraph` is now pruned of stale data after RGS processing (lightningdevkit#2161).
* Max inbound HTLCs in-flight can be changed in the handshake config (lightningdevkit#2138).
* `lightning-transaction-sync` feature `esplora-async-https` was added (lightningdevkit#2085).
* A `ChannelPending` event is now emitted after the initial handshake (lightningdevkit#2098).
* `PaymentForwarded::outbound_amount_forwarded_msat` was added (lightningdevkit#2136).
* `ChannelManager::list_channels_by_counterparty` was added (lightningdevkit#2079).
* `ChannelDetails::feerate_sat_per_1000_weight` was added (lightningdevkit#2094).
* `Invoice::fallback_addresses` was added to fetch `bitcoin` types (lightningdevkit#2023).
* The offer/refund description is now exposed in `Invoice{,Request}` (lightningdevkit#2206).
Backwards Compatibility
=======================
* Payments sent with the legacy `*_with_route` methods on LDK 0.0.115+ will no
longer be retryable via the LDK 0.0.114- `retry_payment` method (lightningdevkit#2139).
* `Event::PaymentPathFailed::retry` was removed and will always be `None` for
payments initiated on 0.0.115 which fail on an earlier version (lightningdevkit#2063).
* `Route`s and `PaymentParameters` with blinded path information will not be
readable on prior versions of LDK. Such objects are not currently constructed
by LDK, but may be when processing BOLT12 data in a coming release (lightningdevkit#2146).
* Providing `ChannelMonitorUpdate`s generated by LDK 0.0.115 to a
`ChannelMonitor` on 0.0.114 or before may panic (lightningdevkit#2059). Note that this is
in general unsupported, and included here only for completeness.
Bug Fixes
=========
* Fixed a case where `process_events_async` may `poll` a `Future` which has
already completed (lightningdevkit#2081).
* Fixed deserialization of `u16` arrays. This bug may have previously corrupted
the historical buckets in a `ProbabilisticScorer`. Users relying on the
historical buckets may wish to wipe their scorer on upgrade to remove corrupt
data rather than waiting on it to decay (lightningdevkit#2191).
* The `process_events_async` task is now `Send` and can thus be polled on a
multi-threaded runtime (lightningdevkit#2199).
* Fixed a missing macro export causing
`impl_writeable_tlv_based_enum{,_upgradable}` calls to not compile (lightningdevkit#2091).
* Fixed compilation of `lightning-invoice` with both `no-std` and serde (lightningdevkit#2187)
* Fix an issue where the `background-processor` would not wake when a
`ChannelMonitorUpdate` completed asynchronously, causing delays (lightningdevkit#2090).
* Fix an issue where `process_events_async` would exit immediately (lightningdevkit#2145).
* `Router` calls from the `ChannelManager` now call `find_route_with_id` rather
than `find_route`, as was intended and described in the API (lightningdevkit#2092).
* Ensure `process_events_async` always exits if any sleep future returns true,
not just if all sleep futures repeatedly return true (lightningdevkit#2145).
* `channel_update` messages no longer set the disable bit unless the peer has
been disconnected for some time. This should resolve cases where channels are
disabled for extended periods of time (lightningdevkit#2198).
* We no longer remove CLN nodes from the network graph for violating the BOLT
spec in some cases after failing to pay through them (lightningdevkit#2220).
* Fixed a debug assertion which may panic under heavy load (lightningdevkit#2172).
* `CounterpartyForceClosed::peer_msg` is now wrapped in UntrustedString (lightningdevkit#2114)
* Fixed a potential deadlock in `funding_transaction_generated` (lightningdevkit#2158).
Security
========
* Transaction re-broadcasting is now substantially more aggressive, including a
new regular rebroadcast feature called on a timer from the
`background-processor` or from `ChainMonitor::rebroadcast_pending_claims`.
This should substantially increase transaction confirmation reliability
without relying on downstream `TransactionBroadcaster` implementations for
rebroadcasting (lightningdevkit#2203, lightningdevkit#2205, lightningdevkit#2208).
* Implemented the changes from BOLT PRs lightningdevkit#1031, lightningdevkit#1032, and lightningdevkit#1040 which resolve a
privacy vulnerability which allows an intermediate node on the path to
discover the final destination for a payment (lightningdevkit#2062).
In total, this release features 110 files changed, 11928 insertions, 6368
deletions in 215 commits from 21 authors, in alphabetical order:
* Advait
* Alan Cohen
* Alec Chen
* Allan Douglas R. de Oliveira
* Arik Sosman
* Elias Rohrer
* Evan Feenstra
* Jeffrey Czyz
* John Cantrell
* Lucas Soriano del Pino
* Marc Tyndel
* Matt Corallo
* Paul Miller
* Steven
* Steven Williamson
* Steven Zhao
* Tony Giorgio
* Valentine Wallace
* Wilmer Paulino
* benthecarman
* munjesi
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expose a failure reason in PaymentFailure

4 participants

@alecchendev@codecov-commenter@valentinewallace@TheBlueMatt