Persist MPP resolution status in wallet file. #9083
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
SomberNight
reviewed
Jun 7, 2024
Comment on lines
-172
to
-176
| class RecvMPPResolution(Enum): | ||
| WAITING = enum.auto() | ||
| EXPIRED = enum.auto() | ||
| ACCEPTED = enum.auto() | ||
| FAILED = enum.auto() |
There was a problem hiding this comment.
We should add a comment here about these values being persisted in the wallet file, and hence being sensitive to changes. As in:
electrum/electrum/lnchannel.py
Lines 77 to 79 in 02a9ab8
Btw, like with the channel states, we could potentially persist them by name instead of value. It only matters if we end up changing this enum, and how often. The ChannelState enum has been changed several times and hence in that case it was quite helpful to use the names.
ecdsa
force-pushed
the
persist_mpp_status
branch
2 times, most recently
from
e83a981
to
04de266
Compare
SomberNight
reviewed
Jun 7, 2024
| mpp_status = self.received_mpp_htlcs[payment_key] | ||
| self.received_mpp_htlcs[payment_key] = mpp_status._replace(resolution=resolution) | ||
| mpp_status = self.received_mpp_htlcs[payment_key.hex()] | ||
| self.logger.info(f'set_mpp_resolution {resolution.name} {len(mpp_status.htlc_set)}') |
There was a problem hiding this comment.
Log line not very useful in non-trivial scenarios. It should also contain the payment_key or the payment_hash, or sth ~id-like.
Same goes for other log lines touched.
SomberNight
reviewed
Jun 7, 2024
| if not mpp_status: | ||
| return int(time.time()) | ||
| return min([_htlc.timestamp for scid, _htlc in mpp_status.htlc_set]) | ||
|
|
||
| def maybe_cleanup_forwarding( | ||
| def maybe_cleanup_mpp( |
There was a problem hiding this comment.
What about channels that get closed, do we also want to clean-up the received_mpp_htlcs dict for those?
If we accept a MPP and we forward the payment (trampoline or swap), we need to persist the payment accepted status, or we might wrongly release htlcs on the next restart. lnworker.received_mpp_htlcs used to be cleaned up in maybe_cleanup_forwarding, which only applies to forwarded payments. However, since we now persist this dict, we need to clean it up also in the case of payments received by us. This part of maybe_cleanup_forwarding has been migrated to lnworker.maybe_cleanup_mpp
ecdsa
force-pushed
the
persist_mpp_status
branch
from
04de266
to
7e38237
Compare
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 we accept a MPP and we forward the payment (trampoline or swap), we need to persist the payment accepted status, or we might wrongly release htlcs on the next restart.
lnworker.received_mpp_htlcs used to be cleaned up in maybe_cleanup_forwarding, which only applies to forwarded payments. However, since we now persist this dict, we need to clean it up also in the case of payments received by us. This part of maybe_cleanup_forwarding has been migrated to lnworker.maybe_cleanup_mpp