Add forwards-compatibility logic in LocalHTLCFailureReason ser#4099
Merged
wpaulino merged 1 commit intolightningdevkit:mainfrom Sep 22, 2025
Merged
Conversation
We recently created a `LocalHTLCFailureReason` enum to cover detailed reasons why an HTLC may have failed, in excess of the on-the-wire failure encoding. Sadly, when we did so we introduced a serialization format which isn't particularly conducive to introducing new failure reasons in the future. Luckily, `LocalHTLCFailureReason` already has logic that works for forwards-compatibility - it can be converted to, and from, the on-the-wire error codes. Thus, here, we take advantage of that, writing both the on-the-wire error code as well as a code for the specific case. If we don't recognize the specific case on deserialization, we'll fall back to the default case for the on-the-wire code we've written. We also, of course, include a length-prefixed TLV stream to allow for additional fields in the future. Fixes lightningdevkit#4087
|
👋 I see @tankyleo was un-assigned. |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4099 +/- ##
=======================================
Coverage 88.71% 88.71%
=======================================
Files 176 176
Lines 132778 132794 +16
Branches 132778 132794 +16
=======================================
+ Hits 117790 117806 +16
+ Misses 12304 12301 -3
- Partials 2684 2687 +3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
wpaulino
approved these changes
Sep 22, 2025
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.
We recently created a
LocalHTLCFailureReasonenum to cover detailed reasons why an HTLC may have failed, in excess of the on-the-wire failure encoding.Sadly, when we did so we introduced a serialization format which isn't particularly conducive to introducing new failure reasons in the future. Luckily,
LocalHTLCFailureReasonalready has logic that works for forwards-compatibility - it can be converted to, and from, the on-the-wire error codes.Thus, here, we take advantage of that, writing both the on-the-wire error code as well as a code for the specific case. If we don't recognize the specific case on deserialization, we'll fall back to the default case for the on-the-wire code we've written.
We also, of course, include a length-prefixed TLV stream to allow for additional fields in the future.
Fixes #4087