Handle feature-less BOLT 11 invoices #687
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
We were not handling correctly feature-less invoices, which are spec-compliant. We do reject invoices that don't have `var_onion_optin`, but the check happens later. Instead, we currently throw a `NullPointerException`. The way we are checking requirements in the `init` block requires lazy-init properties, otherwise the object initialization will fail before any logic can happen. Also, as per the spec, the feature tag must be skipped if there are no features enabled.
pm47
commented
Jul 15, 2024
|
|
||
| val fallbackAddress: String? = tags.find { it is TaggedField.FallbackAddress }?.run { (this as TaggedField.FallbackAddress).toAddress(prefix) } | ||
|
|
||
| override val features: Features = tags.find { it is TaggedField.Features }.run { Features((this as TaggedField.Features).bits) } | ||
| override val features: Features get() = tags.filterIsInstance<TaggedField.Features>().firstOrNull()?.run { Features(this.bits) } ?: Features.empty |
| @@ -55,7 +55,7 @@ data class Bolt11Invoice( | |||
| require(description != null || descriptionHash != null) { "there must be exactly one description tag or one description hash tag" } | |||
| } | |||
|
|
|||
| override fun isExpired(currentTimestampSeconds: Long): Boolean = when (expirySeconds) { | |||
| override fun isExpired(currentTimestampSeconds: Long): Boolean = when (val expirySeconds = expirySeconds) { | |||
There was a problem hiding this comment.
Unfortunately we can't smart cast lazy properties.
| data5.addAll(encoded) | ||
| } | ||
| tags | ||
| .filterNot { it is TaggedField.Features && it.bits.isEmpty() } |
There was a problem hiding this comment.
Skip the features tag entirely when they are no enabled features.
| @@ -498,10 +499,12 @@ class Bolt11InvoiceTestsCommon : LightningTestSuite() { | |||
| assertEquals(pr1.paymentSecret, pr.paymentSecret) | |||
|
|
|||
| // An invoice without the payment secret feature should be rejected | |||
| assertTrue(Bolt11Invoice.read("lnbc40n1pw9qjvwpp5qq3w2ln6krepcslqszkrsfzwy49y0407hvks30ec6pu9s07jur3sdpstfshq5n9v9jzucm0d5s8vmm5v5s8qmmnwssyj3p6yqenwdencqzysxqrrss7ju0s4dwx6w8a95a9p2xc5vudl09gjl0w2n02sjrvffde632nxwh2l4w35nqepj4j5njhh4z65wyfc724yj6dn9wajvajfn5j7em6wsq2elakl").isFailure) | |||
| assertIs<Try.Failure<Throwable>>((Bolt11Invoice.read("lnbc40n1pw9qjvwpp5qq3w2ln6krepcslqszkrsfzwy49y0407hvks30ec6pu9s07jur3sdpstfshq5n9v9jzucm0d5s8vmm5v5s8qmmnwssyj3p6yqenwdencqzysxqrrss7ju0s4dwx6w8a95a9p2xc5vudl09gjl0w2n02sjrvffde632nxwh2l4w35nqepj4j5njhh4z65wyfc724yj6dn9wajvajfn5j7em6wsq2elakl"))) | |||
There was a problem hiding this comment.
This test and the following one were actually throwing a NullPointerException.
t-bast
approved these changes
Jul 15, 2024
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.
We were not handling correctly feature-less invoices, which are spec-compliant. We do reject invoices that don't have
var_onion_optin, but the check happens later. Instead, we currently throw aNullPointerException.The way we are checking requirements in the
initblock requires lazy-init properties, otherwise the object initialization will fail before any logic can happen.Also, as per the spec, the feature tag must be skipped at serialization if there are no features enabled.