Ignore late failures for successful payments - #1065
Open
thesimplekid wants to merge 1 commit into
Open
Conversation
rust-lightning documents that PaymentFailed can arrive after PaymentSent in rare cases. In that ordering, the failure must be ignored and the payment must be treated as successful: https://github.com/lightningdevkit/rust-lightning/blob/9174965af9437196c527a9aa0df36bbcf050c8bb/lightning/src/events/mod.rs#L1230-L1233 Keep succeeded outbound Lightning records monotonic and suppress the contradictory user-facing PaymentFailed event. Cover both BOLT11 and BOLT12 on the persistence-backed store path. Developed with assistance from OpenAI Codex.
|
I've assigned @tnull as a reviewer! |
joostjager
reviewed
Aug 20, 2026
Comment on lines
1457
to
1501
| @@ -1477,6 +1470,32 @@ where | |||
| }, | |||
| }; | |||
|
|
|||
| // LDK may emit `PaymentFailed` after `PaymentSent` in exceedingly rare cases. | |||
| // The payment-store update above preserves success in that case; re-read the | |||
| // resulting state so we also avoid surfacing a contradictory public event. | |||
| match self.payment_store.get(&payment_id).await { | |||
| Ok(Some(payment)) if payment.status == PaymentStatus::Succeeded => { | |||
| log_info!( | |||
| self.logger, | |||
| "Ignoring late payment failure for already-succeeded payment with ID {}.", | |||
| payment_id | |||
| ); | |||
| return Ok(()); | |||
| }, | |||
| Ok(_) => {}, | |||
| Err(e) => { | |||
| log_error!(self.logger, "Failed to access payment store: {}", e); | |||
| return Err(ReplayEvent()); | |||
| }, | |||
| } | |||
|
|
|||
| log_info!( | |||
| self.logger, | |||
| "Failed to send payment with ID {} due to {:?}.", | |||
| payment_id, | |||
| reason | |||
| ); | |||
|
|
|||
| let event = Event::PaymentFailed { payment_id, payment_hash, reason }; | |||
| match self.event_queue.add_event(event).await { | |||
| Ok(_) => return Ok(()), | |||
Contributor
There was a problem hiding this comment.
This is again related to the split-brain situation with persistence, but can the initial payment store write fail after LDK accepts the payment? PaymentSent then accepts Ok(NotFound) and emits success, so a replayed late failure could escape this check after restart.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
rust-lightning documents that PaymentFailed can arrive after PaymentSent in rare cases. In that ordering, the failure must be ignored and the payment must be treated as successful:
https://github.com/lightningdevkit/rust-lightning/blob/9174965af9437196c527a9aa0df36bbcf050c8bb/lightning/src/events/mod.rs#L1230-L1233
Keep succeeded outbound Lightning records monotonic and suppress the contradictory user-facing PaymentFailed event. Cover both BOLT11 and BOLT12 on the persistence-backed store path.
Developed with assistance from OpenAI Codex.