Note that abandon_payment does not persist the state update in docs #1907
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
Codecov ReportBase: 90.60% // Head: 91.00% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #1907 +/- ##
==========================================
+ Coverage 90.60% 91.00% +0.39%
==========================================
Files 91 94 +3
Lines 48656 51856 +3200
Branches 48656 51856 +3200
==========================================
+ Hits 44087 47191 +3104
- Misses 4569 4665 +96
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 at Codecov. |
tnull
reviewed
Dec 8, 2022
|
LGTM, feel free to squash. |
wpaulino
reviewed
Dec 9, 2022
dunxen
reviewed
Dec 12, 2022
|
Looks good for squash from my side. |
If a user calls `abandon_payment`, then restarts without freshly persisting the `ChannelManager`, the payment will still be pending on restart. This was unclear from the docs (and the docs seemed to imply otherwise). Because this doesn't materially impact the usability of `abandon_payment` (users shouldn't be called `retry_payment` on an abandoned one anyway), we simply document it. Fixes lightningdevkit#1804.
TheBlueMatt
force-pushed
the
2022-12-abandon-crash-reset
branch
from
9792ca3
to
1969b48
Compare
|
Squashed without further changes, diff from the other day is: $ git diff-tree -U1 cf63c49 1969b48b7
diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
index 0aa89b5dc..29304cadb 100644
--- a/lightning/src/ln/channelmanager.rs
+++ b/lightning/src/ln/channelmanager.rs
@@ -2764,3 +2764,3 @@ impl<M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<M, T, K, F
/// After this method returns, no future calls to [`retry_payment`] for the given `payment_id`
- /// are allowed. If no such event has been generated, an [`Event::PaymentFailed`] event will be
+ /// are allowed. If no [`Event::PaymentFailed`] event had been generated before, one will be
/// generated as soon as there are no remaining pending HTLCs for this payment. |
dunxen
approved these changes
Dec 12, 2022
wpaulino
approved these changes
Dec 12, 2022
tnull
approved these changes
Dec 12, 2022
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.
If a user calls
abandon_payment, then restarts without freshly persisting theChannelManager, the payment will still be pending on restart. This was unclear from the docs (and the docs seemed to imply otherwise). Because this doesn't materially impact the usability ofabandon_payment(users shouldn't be calledretry_paymenton an abandoned one anyway), we simply document it.Fixes #1804.