Expose a failure reason in PaymentFailed
#2142
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alecchendev
commented
Apr 1, 2023
Codecov ReportPatch coverage:
📣 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
... 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. |
alecchendev
force-pushed
the
2023-03-expose-fail-reason-in-payment-failure
branch
3 times, most recently
from
387d455 to
0383f8b
Compare
|
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. |
|
Separating my fixup commits so they're easier to squash later even though it'll fail CI how they currently are. |
alecchendev
force-pushed
the
2023-03-expose-fail-reason-in-payment-failure
branch
from
fa682d4 to
a58bfa6
Compare
TheBlueMatt
reviewed
Apr 5, 2023
alecchendev
force-pushed
the
2023-03-expose-fail-reason-in-payment-failure
branch
from
4e7731d to
3b11ebb
Compare
alecchendev
force-pushed
the
2023-03-expose-fail-reason-in-payment-failure
branch
from
3b11ebb to
caf991b
Compare
|
Feel free to squash! |
alecchendev
force-pushed
the
2023-03-expose-fail-reason-in-payment-failure
branch
from
caf991b to
7cf9094
Compare
alecchendev
force-pushed
the
2023-03-expose-fail-reason-in-payment-failure
branch
3 times, most recently
from
207a3d4 to
17e8d4b
Compare
|
Rebased and fixed 2 lines for CI - |
|
Oops that was just fixed in #2170. |
alecchendev
force-pushed
the
2023-03-expose-fail-reason-in-payment-failure
branch
from
17e8d4b to
4ba183d
Compare
|
Rebased again so it's not showing the overlapping change :) |
TheBlueMatt
reviewed
Apr 7, 2023
lightning/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 } |
There was a problem hiding this comment.
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
lightning/src/ln/outbound_payment.rs
Outdated
| @@ -1232,7 +1226,7 @@ impl OutboundPayments { | |||
| } else { | |||
| 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 | |||
There was a problem hiding this comment.
Can remove the comment
alecchendev
force-pushed
the
2023-03-expose-fail-reason-in-payment-failure
branch
from
508d860 to
5251b39
Compare
This includes adding a reason to `PendingOutboundPayment::Abandoned` and using that reason when pushing an `Event::PaymentFailed`.
alecchendev
force-pushed
the
2023-03-expose-fail-reason-in-payment-failure
branch
from
5251b39 to
23c7064
Compare
TheBlueMatt
approved these changes
Apr 11, 2023
valentinewallace
approved these changes
Apr 11, 2023
k0k0ne
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #2095. Adds a new public enum
PaymentFailureReasonand a new field onEvent::PaymentFailedto communicate why the payment failed completely.