Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 480
Include a PaymentContext in PaymentPurpose#2970
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
7e085c5
Refactor handling of InvoiceRequest
jkczyz e239c92
Refactor handling of Bolt12Invoice
jkczyz 01814dc
Implement Eq and Hash for Bolt12Invoice
jkczyz 12c3a24
Return the invoice when requesting a refund
jkczyz c881538
Add PaymentContext to payment::ReceiveTlvs
jkczyz 9be364f
Pass PaymentContext through HTLC processing
jkczyz b9970ff
Define an OfferId for BOLT 12 Offers
jkczyz ac6d4cb
Include OfferId in VerifiedInvoiceRequest
jkczyz 48d9245
Include Offer context in blinded payment paths
jkczyz 09ce1b5
Include Refund context in blinded payment paths
jkczyz e74f243
Rename InvoicePayment to Bolt11InvoicePayment
jkczyz ef3ec8f
Add PaymentPurpose::is_keysend utility method
jkczyz 54ca54d
BOLT 12 variants of PaymentPurpose
jkczyz 0c52ea2
Use BOLT 12 PaymentPurpose variants
jkczyz b06b2c7
Test for PaymentContext in offers_tests.rs
jkczyz 8367e02
Include InvoiceRequest fields in PaymentContext
jkczyz 478911d
Update PaymentPurpose's payment_preimage docs
jkczyz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -12,6 +12,8 @@ use crate::ln::channelmanager::CounterpartyForwardingInfo; | ||
| use crate::ln::features::BlindedHopFeatures; | ||
| use crate::ln::msgs::DecodeError; | ||
| use crate::offers::invoice::BlindedPayInfo; | ||
| use crate::offers::invoice_request::InvoiceRequestFields; | ||
| use crate::offers::offer::OfferId; | ||
| use crate::util::ser::{HighZeroBytesDroppedBigSize, Readable, Writeable, Writer}; | ||
| #[allow(unused_imports)] | ||
| @@ -53,6 +55,8 @@ pub struct ReceiveTlvs { | ||
| pub payment_secret: PaymentSecret, | ||
| /// Constraints for the receiver of this payment. | ||
| pub payment_constraints: PaymentConstraints, | ||
| /// Context for the receiver of this payment. | ||
| pub payment_context: PaymentContext, | ||
| } | ||
| /// Data to construct a [`BlindedHop`] for sending a payment over. | ||
| @@ -97,6 +101,66 @@ pub struct PaymentConstraints { | ||
| pub htlc_minimum_msat: u64, | ||
| } | ||
| /// The context of an inbound payment, which is included in a [`BlindedPath`] via [`ReceiveTlvs`] | ||
| /// and surfaced in [`PaymentPurpose`]. | ||
| /// | ||
| /// [`BlindedPath`]: crate::blinded_path::BlindedPath | ||
| /// [`PaymentPurpose`]: crate::events::PaymentPurpose | ||
| #[derive(Clone, Debug, Eq, PartialEq)] | ||
| pub enum PaymentContext { | ||
| /// The payment context was unknown. | ||
| Unknown(UnknownPaymentContext), | ||
| /// The payment was made for an invoice requested from a BOLT 12 [`Offer`]. | ||
| /// | ||
| /// [`Offer`]: crate::offers::offer::Offer | ||
| Bolt12Offer(Bolt12OfferContext), | ||
TheBlueMatt marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| /// The payment was made for an invoice sent for a BOLT 12 [`Refund`]. | ||
| /// | ||
| /// [`Refund`]: crate::offers::refund::Refund | ||
| Bolt12Refund(Bolt12RefundContext), | ||
| } | ||
| // Used when writing PaymentContext in Event::PaymentClaimable to avoid cloning. | ||
tnull marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| pub(crate) enum PaymentContextRef<'a> { | ||
| Bolt12Offer(&'a Bolt12OfferContext), | ||
| Bolt12Refund(&'a Bolt12RefundContext), | ||
| } | ||
| /// An unknown payment context. | ||
| #[derive(Clone, Debug, Eq, PartialEq)] | ||
| pub struct UnknownPaymentContext(()); | ||
| /// The context of a payment made for an invoice requested from a BOLT 12 [`Offer`]. | ||
| /// | ||
| /// [`Offer`]: crate::offers::offer::Offer | ||
| #[derive(Clone, Debug, Eq, PartialEq)] | ||
| pub struct Bolt12OfferContext { | ||
| /// The identifier of the [`Offer`]. | ||
| /// | ||
| /// [`Offer`]: crate::offers::offer::Offer | ||
| pub offer_id: OfferId, | ||
| /// Fields from an [`InvoiceRequest`] sent for a [`Bolt12Invoice`]. | ||
| /// | ||
| /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest | ||
| /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice | ||
| pub invoice_request: InvoiceRequestFields, | ||
| } | ||
| /// The context of a payment made for an invoice sent for a BOLT 12 [`Refund`]. | ||
| /// | ||
| /// [`Refund`]: crate::offers::refund::Refund | ||
| #[derive(Clone, Debug, Eq, PartialEq)] | ||
| pub struct Bolt12RefundContext {} | ||
tnull marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| impl PaymentContext { | ||
| pub(crate) fn unknown() -> Self { | ||
| PaymentContext::Unknown(UnknownPaymentContext(())) | ||
| } | ||
| } | ||
| impl TryFrom<CounterpartyForwardingInfo> for PaymentRelay { | ||
| type Error = (); | ||
| @@ -137,7 +201,8 @@ impl Writeable for ReceiveTlvs { | ||
| fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> { | ||
| encode_tlv_stream!(w, { | ||
| (12, self.payment_constraints, required), | ||
| (65536, self.payment_secret, required) | ||
| (65536, self.payment_secret, required), | ||
| (65537, self.payment_context, required) | ||
| }); | ||
| Ok(()) | ||
| } | ||
| @@ -163,11 +228,14 @@ impl Readable for BlindedPaymentTlvs { | ||
| (12, payment_constraints, required), | ||
| (14, features, option), | ||
| (65536, payment_secret, option), | ||
| (65537, payment_context, (default_value, PaymentContext::unknown())), | ||
| }); | ||
| let _padding: Option<utils::Padding> = _padding; | ||
| if let Some(short_channel_id) = scid { | ||
| if payment_secret.is_some() { return Err(DecodeError::InvalidValue) } | ||
| if payment_secret.is_some() { | ||
| return Err(DecodeError::InvalidValue) | ||
| } | ||
| Ok(BlindedPaymentTlvs::Forward(ForwardTlvs { | ||
| short_channel_id, | ||
| payment_relay: payment_relay.ok_or(DecodeError::InvalidValue)?, | ||
| @@ -179,6 +247,7 @@ impl Readable for BlindedPaymentTlvs { | ||
| Ok(BlindedPaymentTlvs::Receive(ReceiveTlvs { | ||
| payment_secret: payment_secret.ok_or(DecodeError::InvalidValue)?, | ||
| payment_constraints: payment_constraints.0.unwrap(), | ||
| payment_context: payment_context.0.unwrap(), | ||
| })) | ||
| } | ||
| } | ||
| @@ -309,10 +378,53 @@ impl Readable for PaymentConstraints { | ||
| } | ||
| } | ||
| impl_writeable_tlv_based_enum!(PaymentContext, | ||
| ; | ||
| (0, Unknown), | ||
| (1, Bolt12Offer), | ||
| (2, Bolt12Refund), | ||
| ); | ||
| impl<'a> Writeable for PaymentContextRef<'a> { | ||
| fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> { | ||
| match self { | ||
| PaymentContextRef::Bolt12Offer(context) => { | ||
| 1u8.write(w)?; | ||
| context.write(w)?; | ||
| }, | ||
| PaymentContextRef::Bolt12Refund(context) => { | ||
| 2u8.write(w)?; | ||
| context.write(w)?; | ||
| }, | ||
| } | ||
| Ok(()) | ||
| } | ||
| } | ||
| impl Writeable for UnknownPaymentContext { | ||
| fn write<W: Writer>(&self, _w: &mut W) -> Result<(), io::Error> { | ||
| Ok(()) | ||
| } | ||
| } | ||
| impl Readable for UnknownPaymentContext { | ||
| fn read<R: io::Read>(_r: &mut R) -> Result<Self, DecodeError> { | ||
| Ok(UnknownPaymentContext(())) | ||
| } | ||
| } | ||
| impl_writeable_tlv_based!(Bolt12OfferContext, { | ||
| (0, offer_id, required), | ||
| (2, invoice_request, required), | ||
| }); | ||
| impl_writeable_tlv_based!(Bolt12RefundContext, {}); | ||
| #[cfg(test)] | ||
| mod tests { | ||
| use bitcoin::secp256k1::PublicKey; | ||
| use crate::blinded_path::payment::{ForwardNode, ForwardTlvs, ReceiveTlvs, PaymentConstraints, PaymentRelay}; | ||
| use crate::blinded_path::payment::{ForwardNode, ForwardTlvs, ReceiveTlvs, PaymentConstraints, PaymentContext, PaymentRelay}; | ||
| use crate::ln::PaymentSecret; | ||
| use crate::ln::features::BlindedHopFeatures; | ||
| use crate::ln::functional_test_utils::TEST_FINAL_CLTV; | ||
| @@ -361,6 +473,7 @@ mod tests { | ||
| max_cltv_expiry: 0, | ||
| htlc_minimum_msat: 1, | ||
| }, | ||
| payment_context: PaymentContext::unknown(), | ||
| }; | ||
| let htlc_maximum_msat = 100_000; | ||
| let blinded_payinfo = super::compute_payinfo(&intermediate_nodes[..], &recv_tlvs, htlc_maximum_msat, 12).unwrap(); | ||
| @@ -379,6 +492,7 @@ mod tests { | ||
| max_cltv_expiry: 0, | ||
| htlc_minimum_msat: 1, | ||
| }, | ||
| payment_context: PaymentContext::unknown(), | ||
| }; | ||
| let blinded_payinfo = super::compute_payinfo(&[], &recv_tlvs, 4242, TEST_FINAL_CLTV as u16).unwrap(); | ||
| assert_eq!(blinded_payinfo.fee_base_msat, 0); | ||
| @@ -432,6 +546,7 @@ mod tests { | ||
| max_cltv_expiry: 0, | ||
| htlc_minimum_msat: 3, | ||
| }, | ||
| payment_context: PaymentContext::unknown(), | ||
| }; | ||
| let htlc_maximum_msat = 100_000; | ||
| let blinded_payinfo = super::compute_payinfo(&intermediate_nodes[..], &recv_tlvs, htlc_maximum_msat, TEST_FINAL_CLTV as u16).unwrap(); | ||
| @@ -482,6 +597,7 @@ mod tests { | ||
| max_cltv_expiry: 0, | ||
| htlc_minimum_msat: 1, | ||
| }, | ||
| payment_context: PaymentContext::unknown(), | ||
| }; | ||
| let htlc_minimum_msat = 3798; | ||
| assert!(super::compute_payinfo(&intermediate_nodes[..], &recv_tlvs, htlc_minimum_msat - 1, TEST_FINAL_CLTV as u16).is_err()); | ||
| @@ -536,6 +652,7 @@ mod tests { | ||
| max_cltv_expiry: 0, | ||
| htlc_minimum_msat: 1, | ||
| }, | ||
| payment_context: PaymentContext::unknown(), | ||
| }; | ||
| let blinded_payinfo = super::compute_payinfo(&intermediate_nodes[..], &recv_tlvs, 10_000, TEST_FINAL_CLTV as u16).unwrap(); | ||
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this need to be an enum? If its only going to be a BOLT12 thing it seems like overkill, though if we ever end up with a BOLT13 we'd need it? Or is it also intended to have a refund variant and that's why?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, possibly for refunds and future / alternative payment protocols / extensions. Hard to say for sure, but could need a
Bolt12Subscription, for instance. Maybe static invoices (for offline receive) unless we are able to obtain a sender-includedInvoiceRequestfor use here.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wouldn't that just be repeated payments for the same
OfferId?I believe the current thinking is the
InvoiceRequestwill be copied into the HTLC onion.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's certainly possible. But who knows what the spec will ultimately look like. In general, it seems better to allow expanding the number of variants than adding increasingly more
Optionfields for future uses. The latter may require the user to figure out how to interpret it.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea, hard to balance future uses at the serialization layer vs complexifying the API today for it. I wonder if we can't make the API simpler (ie expose just a struct) but at the serialization layer do something smarter?