1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Data structures and encoding for `invoice_request` messages.
12 //! An [`InvoiceRequest`] can be built from a parsed [`Offer`] as an "offer to be paid". It is
13 //! typically constructed by a customer and sent to the merchant who had published the corresponding
14 //! offer. The recipient of the request responds with a [`Bolt12Invoice`].
16 //! For an "offer for money" (e.g., refund, ATM withdrawal), where an offer doesn't exist as a
17 //! precursor, see [`Refund`].
19 //! [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
20 //! [`Refund`]: crate::offers::refund::Refund
23 //! extern crate bitcoin;
24 //! extern crate lightning;
26 //! use bitcoin::network::constants::Network;
27 //! use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, SecretKey};
28 //! use lightning::ln::features::OfferFeatures;
29 //! use lightning::offers::invoice_request::UnsignedInvoiceRequest;
30 //! use lightning::offers::offer::Offer;
31 //! use lightning::util::ser::Writeable;
33 //! # fn parse() -> Result<(), lightning::offers::parse::Bolt12ParseError> {
34 //! let secp_ctx = Secp256k1::new();
35 //! let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32])?);
36 //! let pubkey = PublicKey::from(keys);
37 //! let mut buffer = Vec::new();
39 //! # use lightning::offers::invoice_request::{ExplicitPayerId, InvoiceRequestBuilder};
40 //! # <InvoiceRequestBuilder<ExplicitPayerId, _>>::from(
42 //! .parse::<Offer>()?
43 //! .request_invoice(vec![42; 64], pubkey)?
45 //! .chain(Network::Testnet)?
46 //! .amount_msats(1000)?
48 //! .payer_note("foo".to_string())
50 //! .sign(|message: &UnsignedInvoiceRequest|
51 //! Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
53 //! .expect("failed verifying signature")
54 //! .write(&mut buffer)
60 use bitcoin::blockdata::constants::ChainHash;
61 use bitcoin::network::constants::Network;
62 use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, self};
63 use bitcoin::secp256k1::schnorr::Signature;
65 use crate::sign::EntropySource;
67 use crate::blinded_path::BlindedPath;
68 use crate::ln::PaymentHash;
69 use crate::ln::channelmanager::PaymentId;
70 use crate::ln::features::InvoiceRequestFeatures;
71 use crate::ln::inbound_payment::{ExpandedKey, IV_LEN, Nonce};
72 use crate::ln::msgs::DecodeError;
73 use crate::offers::invoice::BlindedPayInfo;
74 use crate::offers::merkle::{SignError, SignFn, SignatureTlvStream, SignatureTlvStreamRef, TaggedHash, self};
75 use crate::offers::offer::{Offer, OfferContents, OfferId, OfferTlvStream, OfferTlvStreamRef};
76 use crate::offers::parse::{Bolt12ParseError, ParsedMessage, Bolt12SemanticError};
77 use crate::offers::payer::{PayerContents, PayerTlvStream, PayerTlvStreamRef};
78 use crate::offers::signer::{Metadata, MetadataMaterial};
79 use crate::util::ser::{HighZeroBytesDroppedBigSize, Readable, SeekReadable, WithoutLength, Writeable, Writer};
80 use crate::util::string::{PrintableString, UntrustedString};
82 #[cfg(not(c_bindings))]
84 crate::offers::invoice::{DerivedSigningPubkey, ExplicitSigningPubkey, InvoiceBuilder},
88 crate::offers::invoice::{InvoiceWithDerivedSigningPubkeyBuilder, InvoiceWithExplicitSigningPubkeyBuilder},
91 #[allow(unused_imports)]
92 use crate::prelude::*;
94 /// Tag for the hash function used when signing an [`InvoiceRequest`]'s merkle root.
95 pub const SIGNATURE_TAG: &'static str = concat!("lightning", "invoice_request", "signature");
97 pub(super) const IV_BYTES: &[u8; IV_LEN] = b"LDK Invreq ~~~~~";
99 /// Builds an [`InvoiceRequest`] from an [`Offer`] for the "offer to be paid" flow.
101 /// See [module-level documentation] for usage.
103 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
105 /// [module-level documentation]: self
106 pub struct InvoiceRequestBuilder<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> {
108 invoice_request: InvoiceRequestContentsWithoutPayerId,
109 payer_id: Option<PublicKey>,
110 payer_id_strategy: core::marker::PhantomData<P>,
111 secp_ctx: Option<&'b Secp256k1<T>>,
114 /// Builds an [`InvoiceRequest`] from an [`Offer`] for the "offer to be paid" flow.
116 /// See [module-level documentation] for usage.
118 /// [module-level documentation]: self
120 pub struct InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b> {
122 invoice_request: InvoiceRequestContentsWithoutPayerId,
123 payer_id: Option<PublicKey>,
124 payer_id_strategy: core::marker::PhantomData<ExplicitPayerId>,
125 secp_ctx: Option<&'b Secp256k1<secp256k1::All>>,
128 /// Builds an [`InvoiceRequest`] from an [`Offer`] for the "offer to be paid" flow.
130 /// See [module-level documentation] for usage.
132 /// [module-level documentation]: self
134 pub struct InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b> {
136 invoice_request: InvoiceRequestContentsWithoutPayerId,
137 payer_id: Option<PublicKey>,
138 payer_id_strategy: core::marker::PhantomData<DerivedPayerId>,
139 secp_ctx: Option<&'b Secp256k1<secp256k1::All>>,
142 /// Indicates how [`InvoiceRequest::payer_id`] will be set.
144 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
145 pub trait PayerIdStrategy {}
147 /// [`InvoiceRequest::payer_id`] will be explicitly set.
149 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
150 pub struct ExplicitPayerId {}
152 /// [`InvoiceRequest::payer_id`] will be derived.
154 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
155 pub struct DerivedPayerId {}
157 impl PayerIdStrategy for ExplicitPayerId {}
158 impl PayerIdStrategy for DerivedPayerId {}
160 macro_rules! invoice_request_explicit_payer_id_builder_methods { ($self: ident, $self_type: ty) => {
161 #[cfg_attr(c_bindings, allow(dead_code))]
162 pub(super) fn new(offer: &'a Offer, metadata: Vec<u8>, payer_id: PublicKey) -> Self {
165 invoice_request: Self::create_contents(offer, Metadata::Bytes(metadata)),
166 payer_id: Some(payer_id),
167 payer_id_strategy: core::marker::PhantomData,
172 #[cfg_attr(c_bindings, allow(dead_code))]
173 pub(super) fn deriving_metadata<ES: Deref>(
174 offer: &'a Offer, payer_id: PublicKey, expanded_key: &ExpandedKey, entropy_source: ES,
175 payment_id: PaymentId,
176 ) -> Self where ES::Target: EntropySource {
177 let nonce = Nonce::from_entropy_source(entropy_source);
178 let payment_id = Some(payment_id);
179 let derivation_material = MetadataMaterial::new(nonce, expanded_key, IV_BYTES, payment_id);
180 let metadata = Metadata::Derived(derivation_material);
183 invoice_request: Self::create_contents(offer, metadata),
184 payer_id: Some(payer_id),
185 payer_id_strategy: core::marker::PhantomData,
190 /// Builds an unsigned [`InvoiceRequest`] after checking for valid semantics. It can be signed
191 /// by [`UnsignedInvoiceRequest::sign`].
192 pub fn build($self: $self_type) -> Result<UnsignedInvoiceRequest, Bolt12SemanticError> {
193 let (unsigned_invoice_request, keys, _) = $self.build_with_checks()?;
194 debug_assert!(keys.is_none());
195 Ok(unsigned_invoice_request)
199 macro_rules! invoice_request_derived_payer_id_builder_methods { (
200 $self: ident, $self_type: ty, $secp_context: ty
202 #[cfg_attr(c_bindings, allow(dead_code))]
203 pub(super) fn deriving_payer_id<ES: Deref>(
204 offer: &'a Offer, expanded_key: &ExpandedKey, entropy_source: ES,
205 secp_ctx: &'b Secp256k1<$secp_context>, payment_id: PaymentId
206 ) -> Self where ES::Target: EntropySource {
207 let nonce = Nonce::from_entropy_source(entropy_source);
208 let payment_id = Some(payment_id);
209 let derivation_material = MetadataMaterial::new(nonce, expanded_key, IV_BYTES, payment_id);
210 let metadata = Metadata::DerivedSigningPubkey(derivation_material);
213 invoice_request: Self::create_contents(offer, metadata),
215 payer_id_strategy: core::marker::PhantomData,
216 secp_ctx: Some(secp_ctx),
220 /// Builds a signed [`InvoiceRequest`] after checking for valid semantics.
221 pub fn build_and_sign($self: $self_type) -> Result<InvoiceRequest, Bolt12SemanticError> {
222 let (unsigned_invoice_request, keys, secp_ctx) = $self.build_with_checks()?;
224 let mut unsigned_invoice_request = unsigned_invoice_request;
225 debug_assert!(keys.is_some());
227 let secp_ctx = secp_ctx.unwrap();
228 let keys = keys.unwrap();
229 let invoice_request = unsigned_invoice_request
230 .sign(|message: &UnsignedInvoiceRequest|
231 Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
238 macro_rules! invoice_request_builder_methods { (
239 $self: ident, $self_type: ty, $return_type: ty, $return_value: expr, $secp_context: ty $(, $self_mut: tt)?
241 #[cfg_attr(c_bindings, allow(dead_code))]
242 fn create_contents(offer: &Offer, metadata: Metadata) -> InvoiceRequestContentsWithoutPayerId {
243 let offer = offer.contents.clone();
244 InvoiceRequestContentsWithoutPayerId {
245 payer: PayerContents(metadata), offer, chain: None, amount_msats: None,
246 features: InvoiceRequestFeatures::empty(), quantity: None, payer_note: None,
250 /// Sets the [`InvoiceRequest::chain`] of the given [`Network`] for paying an invoice. If not
251 /// called, [`Network::Bitcoin`] is assumed. Errors if the chain for `network` is not supported
254 /// Successive calls to this method will override the previous setting.
255 pub fn chain($self: $self_type, network: Network) -> Result<$return_type, Bolt12SemanticError> {
256 $self.chain_hash(ChainHash::using_genesis_block(network))
259 /// Sets the [`InvoiceRequest::chain`] for paying an invoice. If not called, the chain hash of
260 /// [`Network::Bitcoin`] is assumed. Errors if the chain for `network` is not supported by the
263 /// Successive calls to this method will override the previous setting.
264 pub(crate) fn chain_hash($($self_mut)* $self: $self_type, chain: ChainHash) -> Result<$return_type, Bolt12SemanticError> {
265 if !$self.offer.supports_chain(chain) {
266 return Err(Bolt12SemanticError::UnsupportedChain);
269 $self.invoice_request.chain = Some(chain);
273 /// Sets the [`InvoiceRequest::amount_msats`] for paying an invoice. Errors if `amount_msats` is
274 /// not at least the expected invoice amount (i.e., [`Offer::amount`] times [`quantity`]).
276 /// Successive calls to this method will override the previous setting.
278 /// [`quantity`]: Self::quantity
279 pub fn amount_msats($($self_mut)* $self: $self_type, amount_msats: u64) -> Result<$return_type, Bolt12SemanticError> {
280 $self.invoice_request.offer.check_amount_msats_for_quantity(
281 Some(amount_msats), $self.invoice_request.quantity
283 $self.invoice_request.amount_msats = Some(amount_msats);
287 /// Sets [`InvoiceRequest::quantity`] of items. If not set, `1` is assumed. Errors if `quantity`
288 /// does not conform to [`Offer::is_valid_quantity`].
290 /// Successive calls to this method will override the previous setting.
291 pub fn quantity($($self_mut)* $self: $self_type, quantity: u64) -> Result<$return_type, Bolt12SemanticError> {
292 $self.invoice_request.offer.check_quantity(Some(quantity))?;
293 $self.invoice_request.quantity = Some(quantity);
297 /// Sets the [`InvoiceRequest::payer_note`].
299 /// Successive calls to this method will override the previous setting.
300 pub fn payer_note($($self_mut)* $self: $self_type, payer_note: String) -> $return_type {
301 $self.invoice_request.payer_note = Some(payer_note);
305 fn build_with_checks($($self_mut)* $self: $self_type) -> Result<
306 (UnsignedInvoiceRequest, Option<KeyPair>, Option<&'b Secp256k1<$secp_context>>),
309 #[cfg(feature = "std")] {
310 if $self.offer.is_expired() {
311 return Err(Bolt12SemanticError::AlreadyExpired);
315 let chain = $self.invoice_request.chain();
316 if !$self.offer.supports_chain(chain) {
317 return Err(Bolt12SemanticError::UnsupportedChain);
320 if chain == $self.offer.implied_chain() {
321 $self.invoice_request.chain = None;
324 if $self.offer.amount().is_none() && $self.invoice_request.amount_msats.is_none() {
325 return Err(Bolt12SemanticError::MissingAmount);
328 $self.invoice_request.offer.check_quantity($self.invoice_request.quantity)?;
329 $self.invoice_request.offer.check_amount_msats_for_quantity(
330 $self.invoice_request.amount_msats, $self.invoice_request.quantity
333 Ok($self.build_without_checks())
336 fn build_without_checks($($self_mut)* $self: $self_type) ->
337 (UnsignedInvoiceRequest, Option<KeyPair>, Option<&'b Secp256k1<$secp_context>>)
339 // Create the metadata for stateless verification of a Bolt12Invoice.
341 let secp_ctx = $self.secp_ctx.clone();
342 if $self.invoice_request.payer.0.has_derivation_material() {
343 let mut metadata = core::mem::take(&mut $self.invoice_request.payer.0);
345 let mut tlv_stream = $self.invoice_request.as_tlv_stream();
346 debug_assert!(tlv_stream.2.payer_id.is_none());
347 tlv_stream.0.metadata = None;
348 if !metadata.derives_payer_keys() {
349 tlv_stream.2.payer_id = $self.payer_id.as_ref();
352 let (derived_metadata, derived_keys) = metadata.derive_from(tlv_stream, $self.secp_ctx);
353 metadata = derived_metadata;
355 if let Some(keys) = keys {
356 debug_assert!($self.payer_id.is_none());
357 $self.payer_id = Some(keys.public_key());
360 $self.invoice_request.payer.0 = metadata;
363 debug_assert!($self.invoice_request.payer.0.as_bytes().is_some());
364 debug_assert!($self.payer_id.is_some());
365 let payer_id = $self.payer_id.unwrap();
367 let invoice_request = InvoiceRequestContents {
368 #[cfg(not(c_bindings))]
369 inner: $self.invoice_request,
371 inner: $self.invoice_request.clone(),
374 let unsigned_invoice_request = UnsignedInvoiceRequest::new($self.offer, invoice_request);
376 (unsigned_invoice_request, keys, secp_ctx)
381 macro_rules! invoice_request_builder_test_methods { (
382 $self: ident, $self_type: ty, $return_type: ty, $return_value: expr $(, $self_mut: tt)?
384 #[cfg_attr(c_bindings, allow(dead_code))]
385 fn chain_unchecked($($self_mut)* $self: $self_type, network: Network) -> $return_type {
386 let chain = ChainHash::using_genesis_block(network);
387 $self.invoice_request.chain = Some(chain);
391 #[cfg_attr(c_bindings, allow(dead_code))]
392 fn amount_msats_unchecked($($self_mut)* $self: $self_type, amount_msats: u64) -> $return_type {
393 $self.invoice_request.amount_msats = Some(amount_msats);
397 #[cfg_attr(c_bindings, allow(dead_code))]
398 fn features_unchecked($($self_mut)* $self: $self_type, features: InvoiceRequestFeatures) -> $return_type {
399 $self.invoice_request.features = features;
403 #[cfg_attr(c_bindings, allow(dead_code))]
404 fn quantity_unchecked($($self_mut)* $self: $self_type, quantity: u64) -> $return_type {
405 $self.invoice_request.quantity = Some(quantity);
409 #[cfg_attr(c_bindings, allow(dead_code))]
410 pub(super) fn build_unchecked($self: $self_type) -> UnsignedInvoiceRequest {
411 $self.build_without_checks().0
415 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, ExplicitPayerId, T> {
416 invoice_request_explicit_payer_id_builder_methods!(self, Self);
419 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, DerivedPayerId, T> {
420 invoice_request_derived_payer_id_builder_methods!(self, Self, T);
423 impl<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, P, T> {
424 invoice_request_builder_methods!(self, Self, Self, self, T, mut);
427 invoice_request_builder_test_methods!(self, Self, Self, self, mut);
430 #[cfg(all(c_bindings, not(test)))]
431 impl<'a, 'b> InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b> {
432 invoice_request_explicit_payer_id_builder_methods!(self, &mut Self);
433 invoice_request_builder_methods!(self, &mut Self, (), (), secp256k1::All);
436 #[cfg(all(c_bindings, test))]
437 impl<'a, 'b> InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b> {
438 invoice_request_explicit_payer_id_builder_methods!(self, &mut Self);
439 invoice_request_builder_methods!(self, &mut Self, &mut Self, self, secp256k1::All);
440 invoice_request_builder_test_methods!(self, &mut Self, &mut Self, self);
443 #[cfg(all(c_bindings, not(test)))]
444 impl<'a, 'b> InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b> {
445 invoice_request_derived_payer_id_builder_methods!(self, &mut Self, secp256k1::All);
446 invoice_request_builder_methods!(self, &mut Self, (), (), secp256k1::All);
449 #[cfg(all(c_bindings, test))]
450 impl<'a, 'b> InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b> {
451 invoice_request_derived_payer_id_builder_methods!(self, &mut Self, secp256k1::All);
452 invoice_request_builder_methods!(self, &mut Self, &mut Self, self, secp256k1::All);
453 invoice_request_builder_test_methods!(self, &mut Self, &mut Self, self);
457 impl<'a, 'b> From<InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b>>
458 for InvoiceRequestBuilder<'a, 'b, ExplicitPayerId, secp256k1::All> {
459 fn from(builder: InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b>) -> Self {
460 let InvoiceRequestWithExplicitPayerIdBuilder {
461 offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
465 offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
471 impl<'a, 'b> From<InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b>>
472 for InvoiceRequestBuilder<'a, 'b, DerivedPayerId, secp256k1::All> {
473 fn from(builder: InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b>) -> Self {
474 let InvoiceRequestWithDerivedPayerIdBuilder {
475 offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
479 offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
484 /// A semantically valid [`InvoiceRequest`] that hasn't been signed.
488 /// This is serialized as a TLV stream, which includes TLV records from the originating message. As
489 /// such, it may include unknown, odd TLV records.
490 pub struct UnsignedInvoiceRequest {
492 contents: InvoiceRequestContents,
493 tagged_hash: TaggedHash,
496 /// A function for signing an [`UnsignedInvoiceRequest`].
497 pub trait SignInvoiceRequestFn {
498 /// Signs a [`TaggedHash`] computed over the merkle root of `message`'s TLV stream.
499 fn sign_invoice_request(&self, message: &UnsignedInvoiceRequest) -> Result<Signature, ()>;
502 impl<F> SignInvoiceRequestFn for F
504 F: Fn(&UnsignedInvoiceRequest) -> Result<Signature, ()>,
506 fn sign_invoice_request(&self, message: &UnsignedInvoiceRequest) -> Result<Signature, ()> {
511 impl<F> SignFn<UnsignedInvoiceRequest> for F
513 F: SignInvoiceRequestFn,
515 fn sign(&self, message: &UnsignedInvoiceRequest) -> Result<Signature, ()> {
516 self.sign_invoice_request(message)
520 impl UnsignedInvoiceRequest {
521 fn new(offer: &Offer, contents: InvoiceRequestContents) -> Self {
522 // Use the offer bytes instead of the offer TLV stream as the offer may have contained
523 // unknown TLV records, which are not stored in `OfferContents`.
524 let (payer_tlv_stream, _offer_tlv_stream, invoice_request_tlv_stream) =
525 contents.as_tlv_stream();
526 let offer_bytes = WithoutLength(&offer.bytes);
527 let unsigned_tlv_stream = (payer_tlv_stream, offer_bytes, invoice_request_tlv_stream);
529 let mut bytes = Vec::new();
530 unsigned_tlv_stream.write(&mut bytes).unwrap();
532 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
534 Self { bytes, contents, tagged_hash }
537 /// Returns the [`TaggedHash`] of the invoice to sign.
538 pub fn tagged_hash(&self) -> &TaggedHash {
543 macro_rules! unsigned_invoice_request_sign_method { (
544 $self: ident, $self_type: ty $(, $self_mut: tt)?
546 /// Signs the [`TaggedHash`] of the invoice request using the given function.
548 /// Note: The hash computation may have included unknown, odd TLV records.
549 pub fn sign<F: SignInvoiceRequestFn>(
550 $($self_mut)* $self: $self_type, sign: F
551 ) -> Result<InvoiceRequest, SignError> {
552 let pubkey = $self.contents.payer_id;
553 let signature = merkle::sign_message(sign, &$self, pubkey)?;
555 // Append the signature TLV record to the bytes.
556 let signature_tlv_stream = SignatureTlvStreamRef {
557 signature: Some(&signature),
559 signature_tlv_stream.write(&mut $self.bytes).unwrap();
562 #[cfg(not(c_bindings))]
565 bytes: $self.bytes.clone(),
566 #[cfg(not(c_bindings))]
567 contents: $self.contents,
569 contents: $self.contents.clone(),
575 #[cfg(not(c_bindings))]
576 impl UnsignedInvoiceRequest {
577 unsigned_invoice_request_sign_method!(self, Self, mut);
581 impl UnsignedInvoiceRequest {
582 unsigned_invoice_request_sign_method!(self, &mut Self);
585 impl AsRef<TaggedHash> for UnsignedInvoiceRequest {
586 fn as_ref(&self) -> &TaggedHash {
591 /// An `InvoiceRequest` is a request for a [`Bolt12Invoice`] formulated from an [`Offer`].
593 /// An offer may provide choices such as quantity, amount, chain, features, etc. An invoice request
594 /// specifies these such that its recipient can send an invoice for payment.
596 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
597 /// [`Offer`]: crate::offers::offer::Offer
598 #[derive(Clone, Debug)]
599 #[cfg_attr(test, derive(PartialEq))]
600 pub struct InvoiceRequest {
601 pub(super) bytes: Vec<u8>,
602 pub(super) contents: InvoiceRequestContents,
603 signature: Signature,
606 /// An [`InvoiceRequest`] that has been verified by [`InvoiceRequest::verify`] and exposes different
607 /// ways to respond depending on whether the signing keys were derived.
608 #[derive(Clone, Debug)]
609 pub struct VerifiedInvoiceRequest {
610 /// The identifier of the [`Offer`] for which the [`InvoiceRequest`] was made.
611 pub offer_id: OfferId,
613 /// The verified request.
614 inner: InvoiceRequest,
616 /// Keys used for signing a [`Bolt12Invoice`] if they can be derived.
618 /// If `Some`, must call [`respond_using_derived_keys`] when responding. Otherwise, call
619 /// [`respond_with`].
621 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
622 /// [`respond_using_derived_keys`]: Self::respond_using_derived_keys
623 /// [`respond_with`]: Self::respond_with
624 pub keys: Option<KeyPair>,
627 /// The contents of an [`InvoiceRequest`], which may be shared with an [`Bolt12Invoice`].
629 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
630 #[derive(Clone, Debug)]
631 #[cfg_attr(test, derive(PartialEq))]
632 pub(super) struct InvoiceRequestContents {
633 pub(super) inner: InvoiceRequestContentsWithoutPayerId,
637 #[derive(Clone, Debug)]
638 #[cfg_attr(test, derive(PartialEq))]
639 pub(super) struct InvoiceRequestContentsWithoutPayerId {
640 payer: PayerContents,
641 pub(super) offer: OfferContents,
642 chain: Option<ChainHash>,
643 amount_msats: Option<u64>,
644 features: InvoiceRequestFeatures,
645 quantity: Option<u64>,
646 payer_note: Option<String>,
649 macro_rules! invoice_request_accessors { ($self: ident, $contents: expr) => {
650 /// An unpredictable series of bytes, typically containing information about the derivation of
653 /// [`payer_id`]: Self::payer_id
654 pub fn payer_metadata(&$self) -> &[u8] {
658 /// A chain from [`Offer::chains`] that the offer is valid for.
659 pub fn chain(&$self) -> ChainHash {
663 /// The amount to pay in msats (i.e., the minimum lightning-payable unit for [`chain`]), which
664 /// must be greater than or equal to [`Offer::amount`], converted if necessary.
666 /// [`chain`]: Self::chain
667 pub fn amount_msats(&$self) -> Option<u64> {
668 $contents.amount_msats()
671 /// Features pertaining to requesting an invoice.
672 pub fn invoice_request_features(&$self) -> &InvoiceRequestFeatures {
673 &$contents.features()
676 /// The quantity of the offer's item conforming to [`Offer::is_valid_quantity`].
677 pub fn quantity(&$self) -> Option<u64> {
681 /// A possibly transient pubkey used to sign the invoice request.
682 pub fn payer_id(&$self) -> PublicKey {
686 /// A payer-provided note which will be seen by the recipient and reflected back in the invoice
688 pub fn payer_note(&$self) -> Option<PrintableString> {
689 $contents.payer_note()
693 impl UnsignedInvoiceRequest {
694 offer_accessors!(self, self.contents.inner.offer);
695 invoice_request_accessors!(self, self.contents);
698 macro_rules! invoice_request_respond_with_explicit_signing_pubkey_methods { (
699 $self: ident, $contents: expr, $builder: ty
701 /// Creates an [`InvoiceBuilder`] for the request with the given required fields and using the
702 /// [`Duration`] since [`std::time::SystemTime::UNIX_EPOCH`] as the creation time.
704 /// See [`InvoiceRequest::respond_with_no_std`] for further details where the aforementioned
705 /// creation time is used for the `created_at` parameter.
707 /// [`Duration`]: core::time::Duration
708 #[cfg(feature = "std")]
710 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash
711 ) -> Result<$builder, Bolt12SemanticError> {
712 let created_at = std::time::SystemTime::now()
713 .duration_since(std::time::SystemTime::UNIX_EPOCH)
714 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
716 $contents.respond_with_no_std(payment_paths, payment_hash, created_at)
719 /// Creates an [`InvoiceBuilder`] for the request with the given required fields.
721 /// Unless [`InvoiceBuilder::relative_expiry`] is set, the invoice will expire two hours after
722 /// `created_at`, which is used to set [`Bolt12Invoice::created_at`]. Useful for `no-std` builds
723 /// where [`std::time::SystemTime`] is not available.
725 /// The caller is expected to remember the preimage of `payment_hash` in order to claim a payment
728 /// The `payment_paths` parameter is useful for maintaining the payment recipient's privacy. It
729 /// must contain one or more elements ordered from most-preferred to least-preferred, if there's
730 /// a preference. Note, however, that any privacy is lost if a public node id was used for
731 /// [`Offer::signing_pubkey`].
733 /// Errors if the request contains unknown required features.
737 /// If the originating [`Offer`] was created using [`OfferBuilder::deriving_signing_pubkey`],
738 /// then use [`InvoiceRequest::verify`] and [`VerifiedInvoiceRequest`] methods instead.
740 /// [`Bolt12Invoice::created_at`]: crate::offers::invoice::Bolt12Invoice::created_at
741 /// [`OfferBuilder::deriving_signing_pubkey`]: crate::offers::offer::OfferBuilder::deriving_signing_pubkey
742 pub fn respond_with_no_std(
743 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
744 created_at: core::time::Duration
745 ) -> Result<$builder, Bolt12SemanticError> {
746 if $contents.invoice_request_features().requires_unknown_bits() {
747 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
750 let signing_pubkey = match $contents.contents.inner.offer.signing_pubkey() {
751 Some(signing_pubkey) => signing_pubkey,
752 None => return Err(Bolt12SemanticError::MissingSigningPubkey),
755 <$builder>::for_offer(&$contents, payment_paths, created_at, payment_hash, signing_pubkey)
760 pub(super) fn respond_with_no_std_using_signing_pubkey(
761 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
762 created_at: core::time::Duration, signing_pubkey: PublicKey
763 ) -> Result<$builder, Bolt12SemanticError> {
764 debug_assert!($contents.contents.inner.offer.signing_pubkey().is_none());
766 if $contents.invoice_request_features().requires_unknown_bits() {
767 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
770 <$builder>::for_offer(&$contents, payment_paths, created_at, payment_hash, signing_pubkey)
774 macro_rules! invoice_request_verify_method { ($self: ident, $self_type: ty) => {
775 /// Verifies that the request was for an offer created using the given key. Returns the verified
776 /// request which contains the derived keys needed to sign a [`Bolt12Invoice`] for the request
777 /// if they could be extracted from the metadata.
779 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
781 #[cfg(not(c_bindings))]
782 T: secp256k1::Signing
784 $self: $self_type, key: &ExpandedKey,
785 #[cfg(not(c_bindings))]
786 secp_ctx: &Secp256k1<T>,
788 secp_ctx: &Secp256k1<secp256k1::All>,
789 ) -> Result<VerifiedInvoiceRequest, ()> {
790 let (offer_id, keys) = $self.contents.inner.offer.verify(&$self.bytes, key, secp_ctx)?;
791 Ok(VerifiedInvoiceRequest {
793 #[cfg(not(c_bindings))]
796 inner: $self.clone(),
803 #[cfg(not(c_bindings))]
804 impl InvoiceRequest {
805 offer_accessors!(self, self.contents.inner.offer);
806 invoice_request_accessors!(self, self.contents);
807 invoice_request_respond_with_explicit_signing_pubkey_methods!(self, self, InvoiceBuilder<ExplicitSigningPubkey>);
808 invoice_request_verify_method!(self, Self);
812 impl InvoiceRequest {
813 offer_accessors!(self, self.contents.inner.offer);
814 invoice_request_accessors!(self, self.contents);
815 invoice_request_respond_with_explicit_signing_pubkey_methods!(self, self, InvoiceWithExplicitSigningPubkeyBuilder);
816 invoice_request_verify_method!(self, &Self);
819 impl InvoiceRequest {
820 /// Signature of the invoice request using [`payer_id`].
822 /// [`payer_id`]: Self::payer_id
823 pub fn signature(&self) -> Signature {
827 pub(crate) fn as_tlv_stream(&self) -> FullInvoiceRequestTlvStreamRef {
828 let (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream) =
829 self.contents.as_tlv_stream();
830 let signature_tlv_stream = SignatureTlvStreamRef {
831 signature: Some(&self.signature),
833 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, signature_tlv_stream)
837 macro_rules! invoice_request_respond_with_derived_signing_pubkey_methods { (
838 $self: ident, $contents: expr, $builder: ty
840 /// Creates an [`InvoiceBuilder`] for the request using the given required fields and that uses
841 /// derived signing keys from the originating [`Offer`] to sign the [`Bolt12Invoice`]. Must use
842 /// the same [`ExpandedKey`] as the one used to create the offer.
844 /// See [`InvoiceRequest::respond_with`] for further details.
846 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
847 #[cfg(feature = "std")]
848 pub fn respond_using_derived_keys(
849 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash
850 ) -> Result<$builder, Bolt12SemanticError> {
851 let created_at = std::time::SystemTime::now()
852 .duration_since(std::time::SystemTime::UNIX_EPOCH)
853 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
855 $self.respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at)
858 /// Creates an [`InvoiceBuilder`] for the request using the given required fields and that uses
859 /// derived signing keys from the originating [`Offer`] to sign the [`Bolt12Invoice`]. Must use
860 /// the same [`ExpandedKey`] as the one used to create the offer.
862 /// See [`InvoiceRequest::respond_with_no_std`] for further details.
864 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
865 pub fn respond_using_derived_keys_no_std(
866 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
867 created_at: core::time::Duration
868 ) -> Result<$builder, Bolt12SemanticError> {
869 if $self.inner.invoice_request_features().requires_unknown_bits() {
870 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
873 let keys = match $self.keys {
874 None => return Err(Bolt12SemanticError::InvalidMetadata),
878 match $contents.contents.inner.offer.signing_pubkey() {
879 Some(signing_pubkey) => debug_assert_eq!(signing_pubkey, keys.public_key()),
880 None => return Err(Bolt12SemanticError::MissingSigningPubkey),
883 <$builder>::for_offer_using_keys(
884 &$self.inner, payment_paths, created_at, payment_hash, keys
889 impl VerifiedInvoiceRequest {
890 offer_accessors!(self, self.inner.contents.inner.offer);
891 invoice_request_accessors!(self, self.inner.contents);
892 #[cfg(not(c_bindings))]
893 invoice_request_respond_with_explicit_signing_pubkey_methods!(self, self.inner, InvoiceBuilder<ExplicitSigningPubkey>);
895 invoice_request_respond_with_explicit_signing_pubkey_methods!(self, self.inner, InvoiceWithExplicitSigningPubkeyBuilder);
896 #[cfg(not(c_bindings))]
897 invoice_request_respond_with_derived_signing_pubkey_methods!(self, self.inner, InvoiceBuilder<DerivedSigningPubkey>);
899 invoice_request_respond_with_derived_signing_pubkey_methods!(self, self.inner, InvoiceWithDerivedSigningPubkeyBuilder);
901 pub(crate) fn fields(&self) -> InvoiceRequestFields {
902 let InvoiceRequestContents {
904 inner: InvoiceRequestContentsWithoutPayerId {
905 payer: _, offer: _, chain: _, amount_msats, features, quantity, payer_note
907 } = &self.inner.contents;
909 InvoiceRequestFields {
911 amount_msats: *amount_msats,
912 features: features.clone(),
914 payer_note_truncated: payer_note.clone()
915 .map(|mut s| { s.truncate(PAYER_NOTE_LIMIT); UntrustedString(s) }),
920 impl InvoiceRequestContents {
921 pub(super) fn metadata(&self) -> &[u8] {
922 self.inner.metadata()
925 pub(super) fn derives_keys(&self) -> bool {
926 self.inner.payer.0.derives_payer_keys()
929 pub(super) fn chain(&self) -> ChainHash {
933 pub(super) fn amount_msats(&self) -> Option<u64> {
934 self.inner.amount_msats
937 pub(super) fn features(&self) -> &InvoiceRequestFeatures {
941 pub(super) fn quantity(&self) -> Option<u64> {
945 pub(super) fn payer_id(&self) -> PublicKey {
949 pub(super) fn payer_note(&self) -> Option<PrintableString> {
950 self.inner.payer_note.as_ref()
951 .map(|payer_note| PrintableString(payer_note.as_str()))
954 pub(super) fn as_tlv_stream(&self) -> PartialInvoiceRequestTlvStreamRef {
955 let (payer, offer, mut invoice_request) = self.inner.as_tlv_stream();
956 invoice_request.payer_id = Some(&self.payer_id);
957 (payer, offer, invoice_request)
961 impl InvoiceRequestContentsWithoutPayerId {
962 pub(super) fn metadata(&self) -> &[u8] {
963 self.payer.0.as_bytes().map(|bytes| bytes.as_slice()).unwrap_or(&[])
966 pub(super) fn chain(&self) -> ChainHash {
967 self.chain.unwrap_or_else(|| self.offer.implied_chain())
970 pub(super) fn as_tlv_stream(&self) -> PartialInvoiceRequestTlvStreamRef {
971 let payer = PayerTlvStreamRef {
972 metadata: self.payer.0.as_bytes(),
975 let offer = self.offer.as_tlv_stream();
978 if self.features == InvoiceRequestFeatures::empty() { None }
979 else { Some(&self.features) }
982 let invoice_request = InvoiceRequestTlvStreamRef {
983 chain: self.chain.as_ref(),
984 amount: self.amount_msats,
986 quantity: self.quantity,
988 payer_note: self.payer_note.as_ref(),
992 (payer, offer, invoice_request)
996 impl Writeable for UnsignedInvoiceRequest {
997 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
998 WithoutLength(&self.bytes).write(writer)
1002 impl Writeable for InvoiceRequest {
1003 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1004 WithoutLength(&self.bytes).write(writer)
1008 impl Writeable for InvoiceRequestContents {
1009 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1010 self.as_tlv_stream().write(writer)
1014 /// Valid type range for invoice_request TLV records.
1015 pub(super) const INVOICE_REQUEST_TYPES: core::ops::Range<u64> = 80..160;
1017 /// TLV record type for [`InvoiceRequest::payer_id`] and [`Refund::payer_id`].
1019 /// [`Refund::payer_id`]: crate::offers::refund::Refund::payer_id
1020 pub(super) const INVOICE_REQUEST_PAYER_ID_TYPE: u64 = 88;
1022 // This TLV stream is used for both InvoiceRequest and Refund, but not all TLV records are valid for
1023 // InvoiceRequest as noted below.
1024 tlv_stream!(InvoiceRequestTlvStream, InvoiceRequestTlvStreamRef, INVOICE_REQUEST_TYPES, {
1025 (80, chain: ChainHash),
1026 (82, amount: (u64, HighZeroBytesDroppedBigSize)),
1027 (84, features: (InvoiceRequestFeatures, WithoutLength)),
1028 (86, quantity: (u64, HighZeroBytesDroppedBigSize)),
1029 (INVOICE_REQUEST_PAYER_ID_TYPE, payer_id: PublicKey),
1030 (89, payer_note: (String, WithoutLength)),
1031 // Only used for Refund since the onion message of an InvoiceRequest has a reply path.
1032 (90, paths: (Vec<BlindedPath>, WithoutLength)),
1035 type FullInvoiceRequestTlvStream =
1036 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, SignatureTlvStream);
1038 type FullInvoiceRequestTlvStreamRef<'a> = (
1039 PayerTlvStreamRef<'a>,
1040 OfferTlvStreamRef<'a>,
1041 InvoiceRequestTlvStreamRef<'a>,
1042 SignatureTlvStreamRef<'a>,
1045 impl SeekReadable for FullInvoiceRequestTlvStream {
1046 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1047 let payer = SeekReadable::read(r)?;
1048 let offer = SeekReadable::read(r)?;
1049 let invoice_request = SeekReadable::read(r)?;
1050 let signature = SeekReadable::read(r)?;
1052 Ok((payer, offer, invoice_request, signature))
1056 type PartialInvoiceRequestTlvStream = (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream);
1058 type PartialInvoiceRequestTlvStreamRef<'a> = (
1059 PayerTlvStreamRef<'a>,
1060 OfferTlvStreamRef<'a>,
1061 InvoiceRequestTlvStreamRef<'a>,
1064 impl TryFrom<Vec<u8>> for UnsignedInvoiceRequest {
1065 type Error = Bolt12ParseError;
1067 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1068 let invoice_request = ParsedMessage::<PartialInvoiceRequestTlvStream>::try_from(bytes)?;
1069 let ParsedMessage { bytes, tlv_stream } = invoice_request;
1071 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream,
1073 let contents = InvoiceRequestContents::try_from(
1074 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1077 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
1079 Ok(UnsignedInvoiceRequest { bytes, contents, tagged_hash })
1083 impl TryFrom<Vec<u8>> for InvoiceRequest {
1084 type Error = Bolt12ParseError;
1086 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1087 let invoice_request = ParsedMessage::<FullInvoiceRequestTlvStream>::try_from(bytes)?;
1088 let ParsedMessage { bytes, tlv_stream } = invoice_request;
1090 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream,
1091 SignatureTlvStream { signature },
1093 let contents = InvoiceRequestContents::try_from(
1094 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1097 let signature = match signature {
1098 None => return Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
1099 Some(signature) => signature,
1101 let message = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
1102 merkle::verify_signature(&signature, &message, contents.payer_id)?;
1104 Ok(InvoiceRequest { bytes, contents, signature })
1108 impl TryFrom<PartialInvoiceRequestTlvStream> for InvoiceRequestContents {
1109 type Error = Bolt12SemanticError;
1111 fn try_from(tlv_stream: PartialInvoiceRequestTlvStream) -> Result<Self, Self::Error> {
1113 PayerTlvStream { metadata },
1115 InvoiceRequestTlvStream {
1116 chain, amount, features, quantity, payer_id, payer_note, paths,
1120 let payer = match metadata {
1121 None => return Err(Bolt12SemanticError::MissingPayerMetadata),
1122 Some(metadata) => PayerContents(Metadata::Bytes(metadata)),
1124 let offer = OfferContents::try_from(offer_tlv_stream)?;
1126 if !offer.supports_chain(chain.unwrap_or_else(|| offer.implied_chain())) {
1127 return Err(Bolt12SemanticError::UnsupportedChain);
1130 if offer.amount().is_none() && amount.is_none() {
1131 return Err(Bolt12SemanticError::MissingAmount);
1134 offer.check_quantity(quantity)?;
1135 offer.check_amount_msats_for_quantity(amount, quantity)?;
1137 let features = features.unwrap_or_else(InvoiceRequestFeatures::empty);
1139 let payer_id = match payer_id {
1140 None => return Err(Bolt12SemanticError::MissingPayerId),
1141 Some(payer_id) => payer_id,
1144 if paths.is_some() {
1145 return Err(Bolt12SemanticError::UnexpectedPaths);
1148 Ok(InvoiceRequestContents {
1149 inner: InvoiceRequestContentsWithoutPayerId {
1150 payer, offer, chain, amount_msats: amount, features, quantity, payer_note,
1157 /// Fields sent in an [`InvoiceRequest`] message to include in [`PaymentContext::Bolt12Offer`].
1159 /// [`PaymentContext::Bolt12Offer`]: crate::blinded_path::payment::PaymentContext::Bolt12Offer
1160 #[derive(Clone, Debug, Eq, PartialEq)]
1161 pub struct InvoiceRequestFields {
1162 /// A possibly transient pubkey used to sign the invoice request.
1163 pub payer_id: PublicKey,
1165 /// The amount to pay in msats (i.e., the minimum lightning-payable unit for [`chain`]), which
1166 /// must be greater than or equal to [`Offer::amount`], converted if necessary.
1168 /// [`chain`]: InvoiceRequest::chain
1169 pub amount_msats: Option<u64>,
1171 /// Features pertaining to requesting an invoice.
1172 pub features: InvoiceRequestFeatures,
1174 /// The quantity of the offer's item conforming to [`Offer::is_valid_quantity`].
1175 pub quantity: Option<u64>,
1177 /// A payer-provided note which will be seen by the recipient and reflected back in the invoice
1178 /// response. Truncated to [`PAYER_NOTE_LIMIT`] characters.
1179 pub payer_note_truncated: Option<UntrustedString>,
1182 /// The maximum number of characters included in [`InvoiceRequestFields::payer_note_truncated`].
1183 pub const PAYER_NOTE_LIMIT: usize = 512;
1185 impl Writeable for InvoiceRequestFields {
1186 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1187 write_tlv_fields!(writer, {
1188 (0, self.payer_id, required),
1189 (2, self.amount_msats.map(|v| HighZeroBytesDroppedBigSize(v)), option),
1190 (4, WithoutLength(&self.features), required),
1191 (6, self.quantity.map(|v| HighZeroBytesDroppedBigSize(v)), option),
1192 (8, self.payer_note_truncated.as_ref().map(|s| WithoutLength(&s.0)), option),
1198 impl Readable for InvoiceRequestFields {
1199 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
1200 _init_and_read_len_prefixed_tlv_fields!(reader, {
1201 (0, payer_id, required),
1202 (2, amount_msats, (option, encoding: (u64, HighZeroBytesDroppedBigSize))),
1203 (4, features, (option, encoding: (InvoiceRequestFeatures, WithoutLength))),
1204 (6, quantity, (option, encoding: (u64, HighZeroBytesDroppedBigSize))),
1205 (8, payer_note_truncated, (option, encoding: (String, WithoutLength))),
1207 let features = features.unwrap_or(InvoiceRequestFeatures::empty());
1209 Ok(InvoiceRequestFields {
1210 payer_id: payer_id.0.unwrap(), amount_msats, features, quantity,
1211 payer_note_truncated: payer_note_truncated.map(|s| UntrustedString(s)),
1218 use super::{InvoiceRequest, InvoiceRequestFields, InvoiceRequestTlvStreamRef, PAYER_NOTE_LIMIT, SIGNATURE_TAG, UnsignedInvoiceRequest};
1220 use bitcoin::blockdata::constants::ChainHash;
1221 use bitcoin::network::constants::Network;
1222 use bitcoin::secp256k1::{KeyPair, Secp256k1, SecretKey, self};
1223 use core::num::NonZeroU64;
1224 #[cfg(feature = "std")]
1225 use core::time::Duration;
1226 use crate::sign::KeyMaterial;
1227 use crate::ln::channelmanager::PaymentId;
1228 use crate::ln::features::{InvoiceRequestFeatures, OfferFeatures};
1229 use crate::ln::inbound_payment::ExpandedKey;
1230 use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
1231 use crate::offers::invoice::{Bolt12Invoice, SIGNATURE_TAG as INVOICE_SIGNATURE_TAG};
1232 use crate::offers::merkle::{SignError, SignatureTlvStreamRef, TaggedHash, self};
1233 use crate::offers::offer::{Amount, OfferTlvStreamRef, Quantity};
1234 #[cfg(not(c_bindings))]
1236 crate::offers::offer::OfferBuilder,
1240 crate::offers::offer::OfferWithExplicitMetadataBuilder as OfferBuilder,
1242 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
1243 use crate::offers::payer::PayerTlvStreamRef;
1244 use crate::offers::test_utils::*;
1245 use crate::util::ser::{BigSize, Readable, Writeable};
1246 use crate::util::string::{PrintableString, UntrustedString};
1249 fn builds_invoice_request_with_defaults() {
1250 let unsigned_invoice_request = OfferBuilder::new(recipient_pubkey())
1253 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1256 let mut unsigned_invoice_request = unsigned_invoice_request;
1258 let mut buffer = Vec::new();
1259 unsigned_invoice_request.write(&mut buffer).unwrap();
1261 assert_eq!(unsigned_invoice_request.bytes, buffer.as_slice());
1262 assert_eq!(unsigned_invoice_request.payer_metadata(), &[1; 32]);
1263 assert_eq!(unsigned_invoice_request.chains(), vec![ChainHash::using_genesis_block(Network::Bitcoin)]);
1264 assert_eq!(unsigned_invoice_request.metadata(), None);
1265 assert_eq!(unsigned_invoice_request.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1266 assert_eq!(unsigned_invoice_request.description(), Some(PrintableString("")));
1267 assert_eq!(unsigned_invoice_request.offer_features(), &OfferFeatures::empty());
1268 assert_eq!(unsigned_invoice_request.absolute_expiry(), None);
1269 assert_eq!(unsigned_invoice_request.paths(), &[]);
1270 assert_eq!(unsigned_invoice_request.issuer(), None);
1271 assert_eq!(unsigned_invoice_request.supported_quantity(), Quantity::One);
1272 assert_eq!(unsigned_invoice_request.signing_pubkey(), Some(recipient_pubkey()));
1273 assert_eq!(unsigned_invoice_request.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1274 assert_eq!(unsigned_invoice_request.amount_msats(), None);
1275 assert_eq!(unsigned_invoice_request.invoice_request_features(), &InvoiceRequestFeatures::empty());
1276 assert_eq!(unsigned_invoice_request.quantity(), None);
1277 assert_eq!(unsigned_invoice_request.payer_id(), payer_pubkey());
1278 assert_eq!(unsigned_invoice_request.payer_note(), None);
1280 match UnsignedInvoiceRequest::try_from(buffer) {
1281 Err(e) => panic!("error parsing unsigned invoice request: {:?}", e),
1283 assert_eq!(parsed.bytes, unsigned_invoice_request.bytes);
1284 assert_eq!(parsed.tagged_hash, unsigned_invoice_request.tagged_hash);
1288 let invoice_request = unsigned_invoice_request.sign(payer_sign).unwrap();
1290 let mut buffer = Vec::new();
1291 invoice_request.write(&mut buffer).unwrap();
1293 assert_eq!(invoice_request.bytes, buffer.as_slice());
1294 assert_eq!(invoice_request.payer_metadata(), &[1; 32]);
1295 assert_eq!(invoice_request.chains(), vec![ChainHash::using_genesis_block(Network::Bitcoin)]);
1296 assert_eq!(invoice_request.metadata(), None);
1297 assert_eq!(invoice_request.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1298 assert_eq!(invoice_request.description(), Some(PrintableString("")));
1299 assert_eq!(invoice_request.offer_features(), &OfferFeatures::empty());
1300 assert_eq!(invoice_request.absolute_expiry(), None);
1301 assert_eq!(invoice_request.paths(), &[]);
1302 assert_eq!(invoice_request.issuer(), None);
1303 assert_eq!(invoice_request.supported_quantity(), Quantity::One);
1304 assert_eq!(invoice_request.signing_pubkey(), Some(recipient_pubkey()));
1305 assert_eq!(invoice_request.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1306 assert_eq!(invoice_request.amount_msats(), None);
1307 assert_eq!(invoice_request.invoice_request_features(), &InvoiceRequestFeatures::empty());
1308 assert_eq!(invoice_request.quantity(), None);
1309 assert_eq!(invoice_request.payer_id(), payer_pubkey());
1310 assert_eq!(invoice_request.payer_note(), None);
1312 let message = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &invoice_request.bytes);
1313 assert!(merkle::verify_signature(&invoice_request.signature, &message, payer_pubkey()).is_ok());
1316 invoice_request.as_tlv_stream(),
1318 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1324 description: Some(&String::from("")),
1326 absolute_expiry: None,
1330 node_id: Some(&recipient_pubkey()),
1332 InvoiceRequestTlvStreamRef {
1337 payer_id: Some(&payer_pubkey()),
1341 SignatureTlvStreamRef { signature: Some(&invoice_request.signature()) },
1345 if let Err(e) = InvoiceRequest::try_from(buffer) {
1346 panic!("error parsing invoice request: {:?}", e);
1350 #[cfg(feature = "std")]
1352 fn builds_invoice_request_from_offer_with_expiration() {
1353 let future_expiry = Duration::from_secs(u64::max_value());
1354 let past_expiry = Duration::from_secs(0);
1356 if let Err(e) = OfferBuilder::new(recipient_pubkey())
1358 .absolute_expiry(future_expiry)
1360 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1363 panic!("error building invoice_request: {:?}", e);
1366 match OfferBuilder::new(recipient_pubkey())
1368 .absolute_expiry(past_expiry)
1370 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1373 Ok(_) => panic!("expected error"),
1374 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1379 fn builds_invoice_request_with_derived_metadata() {
1380 let payer_id = payer_pubkey();
1381 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1382 let entropy = FixedEntropy {};
1383 let secp_ctx = Secp256k1::new();
1384 let payment_id = PaymentId([1; 32]);
1386 let offer = OfferBuilder::new(recipient_pubkey())
1389 let invoice_request = offer
1390 .request_invoice_deriving_metadata(payer_id, &expanded_key, &entropy, payment_id)
1393 .sign(payer_sign).unwrap();
1394 assert_eq!(invoice_request.payer_id(), payer_pubkey());
1396 let invoice = invoice_request.respond_with_no_std(payment_paths(), payment_hash(), now())
1399 .sign(recipient_sign).unwrap();
1400 match invoice.verify(&expanded_key, &secp_ctx) {
1401 Ok(payment_id) => assert_eq!(payment_id, PaymentId([1; 32])),
1402 Err(()) => panic!("verification failed"),
1405 // Fails verification with altered fields
1407 payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream,
1408 mut invoice_tlv_stream, mut signature_tlv_stream
1409 ) = invoice.as_tlv_stream();
1410 invoice_request_tlv_stream.amount = Some(2000);
1411 invoice_tlv_stream.amount = Some(2000);
1414 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1415 let mut bytes = Vec::new();
1416 tlv_stream.write(&mut bytes).unwrap();
1418 let message = TaggedHash::from_valid_tlv_stream_bytes(INVOICE_SIGNATURE_TAG, &bytes);
1419 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1420 signature_tlv_stream.signature = Some(&signature);
1422 let mut encoded_invoice = bytes;
1423 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1425 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1426 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1428 // Fails verification with altered metadata
1430 mut payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1431 mut signature_tlv_stream
1432 ) = invoice.as_tlv_stream();
1433 let metadata = payer_tlv_stream.metadata.unwrap().iter().copied().rev().collect();
1434 payer_tlv_stream.metadata = Some(&metadata);
1437 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1438 let mut bytes = Vec::new();
1439 tlv_stream.write(&mut bytes).unwrap();
1441 let message = TaggedHash::from_valid_tlv_stream_bytes(INVOICE_SIGNATURE_TAG, &bytes);
1442 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1443 signature_tlv_stream.signature = Some(&signature);
1445 let mut encoded_invoice = bytes;
1446 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1448 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1449 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1453 fn builds_invoice_request_with_derived_payer_id() {
1454 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1455 let entropy = FixedEntropy {};
1456 let secp_ctx = Secp256k1::new();
1457 let payment_id = PaymentId([1; 32]);
1459 let offer = OfferBuilder::new(recipient_pubkey())
1462 let invoice_request = offer
1463 .request_invoice_deriving_payer_id(&expanded_key, &entropy, &secp_ctx, payment_id)
1468 let invoice = invoice_request.respond_with_no_std(payment_paths(), payment_hash(), now())
1471 .sign(recipient_sign).unwrap();
1472 match invoice.verify(&expanded_key, &secp_ctx) {
1473 Ok(payment_id) => assert_eq!(payment_id, PaymentId([1; 32])),
1474 Err(()) => panic!("verification failed"),
1477 // Fails verification with altered fields
1479 payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream,
1480 mut invoice_tlv_stream, mut signature_tlv_stream
1481 ) = invoice.as_tlv_stream();
1482 invoice_request_tlv_stream.amount = Some(2000);
1483 invoice_tlv_stream.amount = Some(2000);
1486 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1487 let mut bytes = Vec::new();
1488 tlv_stream.write(&mut bytes).unwrap();
1490 let message = TaggedHash::from_valid_tlv_stream_bytes(INVOICE_SIGNATURE_TAG, &bytes);
1491 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1492 signature_tlv_stream.signature = Some(&signature);
1494 let mut encoded_invoice = bytes;
1495 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1497 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1498 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1500 // Fails verification with altered payer id
1502 payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream, invoice_tlv_stream,
1503 mut signature_tlv_stream
1504 ) = invoice.as_tlv_stream();
1505 let payer_id = pubkey(1);
1506 invoice_request_tlv_stream.payer_id = Some(&payer_id);
1509 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1510 let mut bytes = Vec::new();
1511 tlv_stream.write(&mut bytes).unwrap();
1513 let message = TaggedHash::from_valid_tlv_stream_bytes(INVOICE_SIGNATURE_TAG, &bytes);
1514 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1515 signature_tlv_stream.signature = Some(&signature);
1517 let mut encoded_invoice = bytes;
1518 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1520 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1521 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1525 fn builds_invoice_request_with_chain() {
1526 let mainnet = ChainHash::using_genesis_block(Network::Bitcoin);
1527 let testnet = ChainHash::using_genesis_block(Network::Testnet);
1529 let invoice_request = OfferBuilder::new(recipient_pubkey())
1532 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1533 .chain(Network::Bitcoin).unwrap()
1535 .sign(payer_sign).unwrap();
1536 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1537 assert_eq!(invoice_request.chain(), mainnet);
1538 assert_eq!(tlv_stream.chain, None);
1540 let invoice_request = OfferBuilder::new(recipient_pubkey())
1542 .chain(Network::Testnet)
1544 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1545 .chain(Network::Testnet).unwrap()
1547 .sign(payer_sign).unwrap();
1548 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1549 assert_eq!(invoice_request.chain(), testnet);
1550 assert_eq!(tlv_stream.chain, Some(&testnet));
1552 let invoice_request = OfferBuilder::new(recipient_pubkey())
1554 .chain(Network::Bitcoin)
1555 .chain(Network::Testnet)
1557 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1558 .chain(Network::Bitcoin).unwrap()
1560 .sign(payer_sign).unwrap();
1561 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1562 assert_eq!(invoice_request.chain(), mainnet);
1563 assert_eq!(tlv_stream.chain, None);
1565 let invoice_request = OfferBuilder::new(recipient_pubkey())
1567 .chain(Network::Bitcoin)
1568 .chain(Network::Testnet)
1570 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1571 .chain(Network::Bitcoin).unwrap()
1572 .chain(Network::Testnet).unwrap()
1574 .sign(payer_sign).unwrap();
1575 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1576 assert_eq!(invoice_request.chain(), testnet);
1577 assert_eq!(tlv_stream.chain, Some(&testnet));
1579 match OfferBuilder::new(recipient_pubkey())
1581 .chain(Network::Testnet)
1583 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1584 .chain(Network::Bitcoin)
1586 Ok(_) => panic!("expected error"),
1587 Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
1590 match OfferBuilder::new(recipient_pubkey())
1592 .chain(Network::Testnet)
1594 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1597 Ok(_) => panic!("expected error"),
1598 Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
1603 fn builds_invoice_request_with_amount() {
1604 let invoice_request = OfferBuilder::new(recipient_pubkey())
1607 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1608 .amount_msats(1000).unwrap()
1610 .sign(payer_sign).unwrap();
1611 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1612 assert_eq!(invoice_request.amount_msats(), Some(1000));
1613 assert_eq!(tlv_stream.amount, Some(1000));
1615 let invoice_request = OfferBuilder::new(recipient_pubkey())
1618 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1619 .amount_msats(1001).unwrap()
1620 .amount_msats(1000).unwrap()
1622 .sign(payer_sign).unwrap();
1623 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1624 assert_eq!(invoice_request.amount_msats(), Some(1000));
1625 assert_eq!(tlv_stream.amount, Some(1000));
1627 let invoice_request = OfferBuilder::new(recipient_pubkey())
1630 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1631 .amount_msats(1001).unwrap()
1633 .sign(payer_sign).unwrap();
1634 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1635 assert_eq!(invoice_request.amount_msats(), Some(1001));
1636 assert_eq!(tlv_stream.amount, Some(1001));
1638 match OfferBuilder::new(recipient_pubkey())
1641 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1644 Ok(_) => panic!("expected error"),
1645 Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1648 match OfferBuilder::new(recipient_pubkey())
1650 .supported_quantity(Quantity::Unbounded)
1652 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1653 .quantity(2).unwrap()
1656 Ok(_) => panic!("expected error"),
1657 Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1660 match OfferBuilder::new(recipient_pubkey())
1663 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1664 .amount_msats(MAX_VALUE_MSAT + 1)
1666 Ok(_) => panic!("expected error"),
1667 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1670 match OfferBuilder::new(recipient_pubkey())
1672 .supported_quantity(Quantity::Unbounded)
1674 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1675 .amount_msats(1000).unwrap()
1676 .quantity(2).unwrap()
1679 Ok(_) => panic!("expected error"),
1680 Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1683 match OfferBuilder::new(recipient_pubkey())
1685 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1688 Ok(_) => panic!("expected error"),
1689 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingAmount),
1692 match OfferBuilder::new(recipient_pubkey())
1694 .supported_quantity(Quantity::Unbounded)
1696 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1697 .quantity(u64::max_value()).unwrap()
1700 Ok(_) => panic!("expected error"),
1701 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1706 fn builds_invoice_request_with_features() {
1707 let invoice_request = OfferBuilder::new(recipient_pubkey())
1710 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1711 .features_unchecked(InvoiceRequestFeatures::unknown())
1713 .sign(payer_sign).unwrap();
1714 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1715 assert_eq!(invoice_request.invoice_request_features(), &InvoiceRequestFeatures::unknown());
1716 assert_eq!(tlv_stream.features, Some(&InvoiceRequestFeatures::unknown()));
1718 let invoice_request = OfferBuilder::new(recipient_pubkey())
1721 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1722 .features_unchecked(InvoiceRequestFeatures::unknown())
1723 .features_unchecked(InvoiceRequestFeatures::empty())
1725 .sign(payer_sign).unwrap();
1726 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1727 assert_eq!(invoice_request.invoice_request_features(), &InvoiceRequestFeatures::empty());
1728 assert_eq!(tlv_stream.features, None);
1732 fn builds_invoice_request_with_quantity() {
1733 let one = NonZeroU64::new(1).unwrap();
1734 let ten = NonZeroU64::new(10).unwrap();
1736 let invoice_request = OfferBuilder::new(recipient_pubkey())
1738 .supported_quantity(Quantity::One)
1740 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1742 .sign(payer_sign).unwrap();
1743 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1744 assert_eq!(invoice_request.quantity(), None);
1745 assert_eq!(tlv_stream.quantity, None);
1747 match OfferBuilder::new(recipient_pubkey())
1749 .supported_quantity(Quantity::One)
1751 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1752 .amount_msats(2_000).unwrap()
1755 Ok(_) => panic!("expected error"),
1756 Err(e) => assert_eq!(e, Bolt12SemanticError::UnexpectedQuantity),
1759 let invoice_request = OfferBuilder::new(recipient_pubkey())
1761 .supported_quantity(Quantity::Bounded(ten))
1763 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1764 .amount_msats(10_000).unwrap()
1765 .quantity(10).unwrap()
1767 .sign(payer_sign).unwrap();
1768 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1769 assert_eq!(invoice_request.amount_msats(), Some(10_000));
1770 assert_eq!(tlv_stream.amount, Some(10_000));
1772 match OfferBuilder::new(recipient_pubkey())
1774 .supported_quantity(Quantity::Bounded(ten))
1776 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1777 .amount_msats(11_000).unwrap()
1780 Ok(_) => panic!("expected error"),
1781 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidQuantity),
1784 let invoice_request = OfferBuilder::new(recipient_pubkey())
1786 .supported_quantity(Quantity::Unbounded)
1788 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1789 .amount_msats(2_000).unwrap()
1790 .quantity(2).unwrap()
1792 .sign(payer_sign).unwrap();
1793 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1794 assert_eq!(invoice_request.amount_msats(), Some(2_000));
1795 assert_eq!(tlv_stream.amount, Some(2_000));
1797 match OfferBuilder::new(recipient_pubkey())
1799 .supported_quantity(Quantity::Unbounded)
1801 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1804 Ok(_) => panic!("expected error"),
1805 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingQuantity),
1808 match OfferBuilder::new(recipient_pubkey())
1810 .supported_quantity(Quantity::Bounded(one))
1812 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1815 Ok(_) => panic!("expected error"),
1816 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingQuantity),
1821 fn builds_invoice_request_with_payer_note() {
1822 let invoice_request = OfferBuilder::new(recipient_pubkey())
1825 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1826 .payer_note("bar".into())
1828 .sign(payer_sign).unwrap();
1829 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1830 assert_eq!(invoice_request.payer_note(), Some(PrintableString("bar")));
1831 assert_eq!(tlv_stream.payer_note, Some(&String::from("bar")));
1833 let invoice_request = OfferBuilder::new(recipient_pubkey())
1836 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1837 .payer_note("bar".into())
1838 .payer_note("baz".into())
1840 .sign(payer_sign).unwrap();
1841 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1842 assert_eq!(invoice_request.payer_note(), Some(PrintableString("baz")));
1843 assert_eq!(tlv_stream.payer_note, Some(&String::from("baz")));
1847 fn fails_signing_invoice_request() {
1848 match OfferBuilder::new(recipient_pubkey())
1851 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1855 Ok(_) => panic!("expected error"),
1856 Err(e) => assert_eq!(e, SignError::Signing),
1859 match OfferBuilder::new(recipient_pubkey())
1862 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1864 .sign(recipient_sign)
1866 Ok(_) => panic!("expected error"),
1867 Err(e) => assert_eq!(e, SignError::Verification(secp256k1::Error::InvalidSignature)),
1872 fn fails_responding_with_unknown_required_features() {
1873 match OfferBuilder::new(recipient_pubkey())
1876 .request_invoice(vec![42; 32], payer_pubkey()).unwrap()
1877 .features_unchecked(InvoiceRequestFeatures::unknown())
1879 .sign(payer_sign).unwrap()
1880 .respond_with_no_std(payment_paths(), payment_hash(), now())
1882 Ok(_) => panic!("expected error"),
1883 Err(e) => assert_eq!(e, Bolt12SemanticError::UnknownRequiredFeatures),
1888 fn parses_invoice_request_with_metadata() {
1889 let invoice_request = OfferBuilder::new(recipient_pubkey())
1892 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1894 .sign(payer_sign).unwrap();
1896 let mut buffer = Vec::new();
1897 invoice_request.write(&mut buffer).unwrap();
1899 if let Err(e) = InvoiceRequest::try_from(buffer) {
1900 panic!("error parsing invoice_request: {:?}", e);
1905 fn parses_invoice_request_with_chain() {
1906 let invoice_request = OfferBuilder::new(recipient_pubkey())
1909 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1910 .chain(Network::Bitcoin).unwrap()
1912 .sign(payer_sign).unwrap();
1914 let mut buffer = Vec::new();
1915 invoice_request.write(&mut buffer).unwrap();
1917 if let Err(e) = InvoiceRequest::try_from(buffer) {
1918 panic!("error parsing invoice_request: {:?}", e);
1921 let invoice_request = OfferBuilder::new(recipient_pubkey())
1924 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1925 .chain_unchecked(Network::Testnet)
1927 .sign(payer_sign).unwrap();
1929 let mut buffer = Vec::new();
1930 invoice_request.write(&mut buffer).unwrap();
1932 match InvoiceRequest::try_from(buffer) {
1933 Ok(_) => panic!("expected error"),
1934 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnsupportedChain)),
1939 fn parses_invoice_request_with_amount() {
1940 let invoice_request = OfferBuilder::new(recipient_pubkey())
1943 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1945 .sign(payer_sign).unwrap();
1947 let mut buffer = Vec::new();
1948 invoice_request.write(&mut buffer).unwrap();
1950 if let Err(e) = InvoiceRequest::try_from(buffer) {
1951 panic!("error parsing invoice_request: {:?}", e);
1954 let invoice_request = OfferBuilder::new(recipient_pubkey())
1956 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1957 .amount_msats(1000).unwrap()
1959 .sign(payer_sign).unwrap();
1961 let mut buffer = Vec::new();
1962 invoice_request.write(&mut buffer).unwrap();
1964 if let Err(e) = InvoiceRequest::try_from(buffer) {
1965 panic!("error parsing invoice_request: {:?}", e);
1968 let invoice_request = OfferBuilder::new(recipient_pubkey())
1970 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1972 .sign(payer_sign).unwrap();
1974 let mut buffer = Vec::new();
1975 invoice_request.write(&mut buffer).unwrap();
1977 match InvoiceRequest::try_from(buffer) {
1978 Ok(_) => panic!("expected error"),
1979 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount)),
1982 let invoice_request = OfferBuilder::new(recipient_pubkey())
1985 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1986 .amount_msats_unchecked(999)
1988 .sign(payer_sign).unwrap();
1990 let mut buffer = Vec::new();
1991 invoice_request.write(&mut buffer).unwrap();
1993 match InvoiceRequest::try_from(buffer) {
1994 Ok(_) => panic!("expected error"),
1995 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InsufficientAmount)),
1998 let invoice_request = OfferBuilder::new(recipient_pubkey())
1999 .description("foo".to_string())
2000 .amount(Amount::Currency { iso4217_code: *b"USD", amount: 1000 })
2002 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2004 .sign(payer_sign).unwrap();
2006 let mut buffer = Vec::new();
2007 invoice_request.write(&mut buffer).unwrap();
2009 match InvoiceRequest::try_from(buffer) {
2010 Ok(_) => panic!("expected error"),
2012 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnsupportedCurrency));
2016 let invoice_request = OfferBuilder::new(recipient_pubkey())
2018 .supported_quantity(Quantity::Unbounded)
2020 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2021 .quantity(u64::max_value()).unwrap()
2023 .sign(payer_sign).unwrap();
2025 let mut buffer = Vec::new();
2026 invoice_request.write(&mut buffer).unwrap();
2028 match InvoiceRequest::try_from(buffer) {
2029 Ok(_) => panic!("expected error"),
2030 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidAmount)),
2035 fn parses_invoice_request_with_quantity() {
2036 let one = NonZeroU64::new(1).unwrap();
2037 let ten = NonZeroU64::new(10).unwrap();
2039 let invoice_request = OfferBuilder::new(recipient_pubkey())
2041 .supported_quantity(Quantity::One)
2043 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2045 .sign(payer_sign).unwrap();
2047 let mut buffer = Vec::new();
2048 invoice_request.write(&mut buffer).unwrap();
2050 if let Err(e) = InvoiceRequest::try_from(buffer) {
2051 panic!("error parsing invoice_request: {:?}", e);
2054 let invoice_request = OfferBuilder::new(recipient_pubkey())
2056 .supported_quantity(Quantity::One)
2058 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2059 .amount_msats(2_000).unwrap()
2060 .quantity_unchecked(2)
2062 .sign(payer_sign).unwrap();
2064 let mut buffer = Vec::new();
2065 invoice_request.write(&mut buffer).unwrap();
2067 match InvoiceRequest::try_from(buffer) {
2068 Ok(_) => panic!("expected error"),
2070 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnexpectedQuantity));
2074 let invoice_request = OfferBuilder::new(recipient_pubkey())
2076 .supported_quantity(Quantity::Bounded(ten))
2078 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2079 .amount_msats(10_000).unwrap()
2080 .quantity(10).unwrap()
2082 .sign(payer_sign).unwrap();
2084 let mut buffer = Vec::new();
2085 invoice_request.write(&mut buffer).unwrap();
2087 if let Err(e) = InvoiceRequest::try_from(buffer) {
2088 panic!("error parsing invoice_request: {:?}", e);
2091 let invoice_request = OfferBuilder::new(recipient_pubkey())
2093 .supported_quantity(Quantity::Bounded(ten))
2095 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2096 .amount_msats(11_000).unwrap()
2097 .quantity_unchecked(11)
2099 .sign(payer_sign).unwrap();
2101 let mut buffer = Vec::new();
2102 invoice_request.write(&mut buffer).unwrap();
2104 match InvoiceRequest::try_from(buffer) {
2105 Ok(_) => panic!("expected error"),
2106 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidQuantity)),
2109 let invoice_request = OfferBuilder::new(recipient_pubkey())
2111 .supported_quantity(Quantity::Unbounded)
2113 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2114 .amount_msats(2_000).unwrap()
2115 .quantity(2).unwrap()
2117 .sign(payer_sign).unwrap();
2119 let mut buffer = Vec::new();
2120 invoice_request.write(&mut buffer).unwrap();
2122 if let Err(e) = InvoiceRequest::try_from(buffer) {
2123 panic!("error parsing invoice_request: {:?}", e);
2126 let invoice_request = OfferBuilder::new(recipient_pubkey())
2128 .supported_quantity(Quantity::Unbounded)
2130 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2132 .sign(payer_sign).unwrap();
2134 let mut buffer = Vec::new();
2135 invoice_request.write(&mut buffer).unwrap();
2137 match InvoiceRequest::try_from(buffer) {
2138 Ok(_) => panic!("expected error"),
2139 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingQuantity)),
2142 let invoice_request = OfferBuilder::new(recipient_pubkey())
2144 .supported_quantity(Quantity::Bounded(one))
2146 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2148 .sign(payer_sign).unwrap();
2150 let mut buffer = Vec::new();
2151 invoice_request.write(&mut buffer).unwrap();
2153 match InvoiceRequest::try_from(buffer) {
2154 Ok(_) => panic!("expected error"),
2155 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingQuantity)),
2160 fn fails_parsing_invoice_request_without_metadata() {
2161 let offer = OfferBuilder::new(recipient_pubkey())
2164 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2166 let mut tlv_stream = unsigned_invoice_request.contents.as_tlv_stream();
2167 tlv_stream.0.metadata = None;
2169 let mut buffer = Vec::new();
2170 tlv_stream.write(&mut buffer).unwrap();
2172 match InvoiceRequest::try_from(buffer) {
2173 Ok(_) => panic!("expected error"),
2175 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerMetadata));
2181 fn fails_parsing_invoice_request_without_payer_id() {
2182 let offer = OfferBuilder::new(recipient_pubkey())
2185 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2187 let mut tlv_stream = unsigned_invoice_request.contents.as_tlv_stream();
2188 tlv_stream.2.payer_id = None;
2190 let mut buffer = Vec::new();
2191 tlv_stream.write(&mut buffer).unwrap();
2193 match InvoiceRequest::try_from(buffer) {
2194 Ok(_) => panic!("expected error"),
2195 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerId)),
2200 fn fails_parsing_invoice_request_without_node_id() {
2201 let offer = OfferBuilder::new(recipient_pubkey())
2204 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2206 let mut tlv_stream = unsigned_invoice_request.contents.as_tlv_stream();
2207 tlv_stream.1.node_id = None;
2209 let mut buffer = Vec::new();
2210 tlv_stream.write(&mut buffer).unwrap();
2212 match InvoiceRequest::try_from(buffer) {
2213 Ok(_) => panic!("expected error"),
2215 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey));
2221 fn fails_parsing_invoice_request_without_signature() {
2222 let mut buffer = Vec::new();
2223 OfferBuilder::new(recipient_pubkey())
2226 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2229 .write(&mut buffer).unwrap();
2231 match InvoiceRequest::try_from(buffer) {
2232 Ok(_) => panic!("expected error"),
2233 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
2238 fn fails_parsing_invoice_request_with_invalid_signature() {
2239 let mut invoice_request = OfferBuilder::new(recipient_pubkey())
2242 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2244 .sign(payer_sign).unwrap();
2245 let last_signature_byte = invoice_request.bytes.last_mut().unwrap();
2246 *last_signature_byte = last_signature_byte.wrapping_add(1);
2248 let mut buffer = Vec::new();
2249 invoice_request.write(&mut buffer).unwrap();
2251 match InvoiceRequest::try_from(buffer) {
2252 Ok(_) => panic!("expected error"),
2254 assert_eq!(e, Bolt12ParseError::InvalidSignature(secp256k1::Error::InvalidSignature));
2260 fn fails_parsing_invoice_request_with_extra_tlv_records() {
2261 let secp_ctx = Secp256k1::new();
2262 let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
2263 let invoice_request = OfferBuilder::new(keys.public_key())
2266 .request_invoice(vec![1; 32], keys.public_key()).unwrap()
2268 .sign(|message: &UnsignedInvoiceRequest|
2269 Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
2273 let mut encoded_invoice_request = Vec::new();
2274 invoice_request.write(&mut encoded_invoice_request).unwrap();
2275 BigSize(1002).write(&mut encoded_invoice_request).unwrap();
2276 BigSize(32).write(&mut encoded_invoice_request).unwrap();
2277 [42u8; 32].write(&mut encoded_invoice_request).unwrap();
2279 match InvoiceRequest::try_from(encoded_invoice_request) {
2280 Ok(_) => panic!("expected error"),
2281 Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),
2286 fn copies_verified_invoice_request_fields() {
2287 let node_id = recipient_pubkey();
2288 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
2289 let entropy = FixedEntropy {};
2290 let secp_ctx = Secp256k1::new();
2293 use crate::offers::offer::OfferWithDerivedMetadataBuilder as OfferBuilder;
2294 let offer = OfferBuilder
2295 ::deriving_signing_pubkey(node_id, &expanded_key, &entropy, &secp_ctx)
2296 .chain(Network::Testnet)
2298 .supported_quantity(Quantity::Unbounded)
2300 assert_eq!(offer.signing_pubkey(), Some(node_id));
2302 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2303 .chain(Network::Testnet).unwrap()
2304 .amount_msats(1001).unwrap()
2305 .quantity(1).unwrap()
2306 .payer_note("0".repeat(PAYER_NOTE_LIMIT * 2))
2308 .sign(payer_sign).unwrap();
2309 match invoice_request.verify(&expanded_key, &secp_ctx) {
2310 Ok(invoice_request) => {
2311 let fields = invoice_request.fields();
2312 assert_eq!(invoice_request.offer_id, offer.id());
2315 InvoiceRequestFields {
2316 payer_id: payer_pubkey(),
2317 amount_msats: Some(1001),
2318 features: InvoiceRequestFeatures::empty(),
2320 payer_note_truncated: Some(UntrustedString("0".repeat(PAYER_NOTE_LIMIT))),
2324 let mut buffer = Vec::new();
2325 fields.write(&mut buffer).unwrap();
2327 let deserialized_fields: InvoiceRequestFields =
2328 Readable::read(&mut buffer.as_slice()).unwrap();
2329 assert_eq!(deserialized_fields, fields);
2331 Err(_) => panic!("unexpected error"),