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 core::convert::Infallible;
29 //! use lightning::ln::features::OfferFeatures;
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();
40 //! .parse::<Offer>()?
41 //! .request_invoice(vec![42; 64], pubkey)?
42 //! .chain(Network::Testnet)?
43 //! .amount_msats(1000)?
45 //! .payer_note("foo".to_string())
47 //! .sign::<_, Infallible>(|digest| Ok(secp_ctx.sign_schnorr_no_aux_rand(digest, &keys)))
48 //! .expect("failed verifying signature")
49 //! .write(&mut buffer)
55 use bitcoin::blockdata::constants::ChainHash;
56 use bitcoin::network::constants::Network;
57 use bitcoin::secp256k1::{KeyPair, Message, PublicKey, Secp256k1, self};
58 use bitcoin::secp256k1::schnorr::Signature;
59 use core::convert::{Infallible, TryFrom};
61 use crate::sign::EntropySource;
63 use crate::blinded_path::BlindedPath;
64 use crate::ln::PaymentHash;
65 use crate::ln::features::InvoiceRequestFeatures;
66 use crate::ln::inbound_payment::{ExpandedKey, IV_LEN, Nonce};
67 use crate::ln::msgs::DecodeError;
68 use crate::offers::invoice::{BlindedPayInfo, DerivedSigningPubkey, ExplicitSigningPubkey, InvoiceBuilder};
69 use crate::offers::merkle::{SignError, SignatureTlvStream, SignatureTlvStreamRef, self};
70 use crate::offers::offer::{Offer, OfferContents, OfferTlvStream, OfferTlvStreamRef};
71 use crate::offers::parse::{Bolt12ParseError, ParsedMessage, Bolt12SemanticError};
72 use crate::offers::payer::{PayerContents, PayerTlvStream, PayerTlvStreamRef};
73 use crate::offers::signer::{Metadata, MetadataMaterial};
74 use crate::util::ser::{HighZeroBytesDroppedBigSize, SeekReadable, WithoutLength, Writeable, Writer};
75 use crate::util::string::PrintableString;
77 use crate::prelude::*;
79 const SIGNATURE_TAG: &'static str = concat!("lightning", "invoice_request", "signature");
81 pub(super) const IV_BYTES: &[u8; IV_LEN] = b"LDK Invreq ~~~~~";
83 /// Builds an [`InvoiceRequest`] from an [`Offer`] for the "offer to be paid" flow.
85 /// See [module-level documentation] for usage.
87 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
89 /// [module-level documentation]: self
90 pub struct InvoiceRequestBuilder<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> {
92 invoice_request: InvoiceRequestContentsWithoutPayerId,
93 payer_id: Option<PublicKey>,
94 payer_id_strategy: core::marker::PhantomData<P>,
95 secp_ctx: Option<&'b Secp256k1<T>>,
98 /// Indicates how [`InvoiceRequest::payer_id`] will be set.
100 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
101 pub trait PayerIdStrategy {}
103 /// [`InvoiceRequest::payer_id`] will be explicitly set.
105 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
106 pub struct ExplicitPayerId {}
108 /// [`InvoiceRequest::payer_id`] will be derived.
110 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
111 pub struct DerivedPayerId {}
113 impl PayerIdStrategy for ExplicitPayerId {}
114 impl PayerIdStrategy for DerivedPayerId {}
116 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, ExplicitPayerId, T> {
117 pub(super) fn new(offer: &'a Offer, metadata: Vec<u8>, payer_id: PublicKey) -> Self {
120 invoice_request: Self::create_contents(offer, Metadata::Bytes(metadata)),
121 payer_id: Some(payer_id),
122 payer_id_strategy: core::marker::PhantomData,
127 pub(super) fn deriving_metadata<ES: Deref>(
128 offer: &'a Offer, payer_id: PublicKey, expanded_key: &ExpandedKey, entropy_source: ES
129 ) -> Self where ES::Target: EntropySource {
130 let nonce = Nonce::from_entropy_source(entropy_source);
131 let derivation_material = MetadataMaterial::new(nonce, expanded_key, IV_BYTES);
132 let metadata = Metadata::Derived(derivation_material);
135 invoice_request: Self::create_contents(offer, metadata),
136 payer_id: Some(payer_id),
137 payer_id_strategy: core::marker::PhantomData,
143 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, DerivedPayerId, T> {
144 pub(super) fn deriving_payer_id<ES: Deref>(
145 offer: &'a Offer, expanded_key: &ExpandedKey, entropy_source: ES, secp_ctx: &'b Secp256k1<T>
146 ) -> Self where ES::Target: EntropySource {
147 let nonce = Nonce::from_entropy_source(entropy_source);
148 let derivation_material = MetadataMaterial::new(nonce, expanded_key, IV_BYTES);
149 let metadata = Metadata::DerivedSigningPubkey(derivation_material);
152 invoice_request: Self::create_contents(offer, metadata),
154 payer_id_strategy: core::marker::PhantomData,
155 secp_ctx: Some(secp_ctx),
160 impl<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, P, T> {
161 fn create_contents(offer: &Offer, metadata: Metadata) -> InvoiceRequestContentsWithoutPayerId {
162 let offer = offer.contents.clone();
163 InvoiceRequestContentsWithoutPayerId {
164 payer: PayerContents(metadata), offer, chain: None, amount_msats: None,
165 features: InvoiceRequestFeatures::empty(), quantity: None, payer_note: None,
169 /// Sets the [`InvoiceRequest::chain`] of the given [`Network`] for paying an invoice. If not
170 /// called, [`Network::Bitcoin`] is assumed. Errors if the chain for `network` is not supported
173 /// Successive calls to this method will override the previous setting.
174 pub fn chain(mut self, network: Network) -> Result<Self, Bolt12SemanticError> {
175 let chain = ChainHash::using_genesis_block(network);
176 if !self.offer.supports_chain(chain) {
177 return Err(Bolt12SemanticError::UnsupportedChain);
180 self.invoice_request.chain = Some(chain);
184 /// Sets the [`InvoiceRequest::amount_msats`] for paying an invoice. Errors if `amount_msats` is
185 /// not at least the expected invoice amount (i.e., [`Offer::amount`] times [`quantity`]).
187 /// Successive calls to this method will override the previous setting.
189 /// [`quantity`]: Self::quantity
190 pub fn amount_msats(mut self, amount_msats: u64) -> Result<Self, Bolt12SemanticError> {
191 self.invoice_request.offer.check_amount_msats_for_quantity(
192 Some(amount_msats), self.invoice_request.quantity
194 self.invoice_request.amount_msats = Some(amount_msats);
198 /// Sets [`InvoiceRequest::quantity`] of items. If not set, `1` is assumed. Errors if `quantity`
199 /// does not conform to [`Offer::is_valid_quantity`].
201 /// Successive calls to this method will override the previous setting.
202 pub fn quantity(mut self, quantity: u64) -> Result<Self, Bolt12SemanticError> {
203 self.invoice_request.offer.check_quantity(Some(quantity))?;
204 self.invoice_request.quantity = Some(quantity);
208 /// Sets the [`InvoiceRequest::payer_note`].
210 /// Successive calls to this method will override the previous setting.
211 pub fn payer_note(mut self, payer_note: String) -> Self {
212 self.invoice_request.payer_note = Some(payer_note);
216 fn build_with_checks(mut self) -> Result<
217 (UnsignedInvoiceRequest<'a>, Option<KeyPair>, Option<&'b Secp256k1<T>>),
220 #[cfg(feature = "std")] {
221 if self.offer.is_expired() {
222 return Err(Bolt12SemanticError::AlreadyExpired);
226 let chain = self.invoice_request.chain();
227 if !self.offer.supports_chain(chain) {
228 return Err(Bolt12SemanticError::UnsupportedChain);
231 if chain == self.offer.implied_chain() {
232 self.invoice_request.chain = None;
235 if self.offer.amount().is_none() && self.invoice_request.amount_msats.is_none() {
236 return Err(Bolt12SemanticError::MissingAmount);
239 self.invoice_request.offer.check_quantity(self.invoice_request.quantity)?;
240 self.invoice_request.offer.check_amount_msats_for_quantity(
241 self.invoice_request.amount_msats, self.invoice_request.quantity
244 Ok(self.build_without_checks())
247 fn build_without_checks(mut self) ->
248 (UnsignedInvoiceRequest<'a>, Option<KeyPair>, Option<&'b Secp256k1<T>>)
250 // Create the metadata for stateless verification of a Bolt12Invoice.
252 let secp_ctx = self.secp_ctx.clone();
253 if self.invoice_request.payer.0.has_derivation_material() {
254 let mut metadata = core::mem::take(&mut self.invoice_request.payer.0);
256 let mut tlv_stream = self.invoice_request.as_tlv_stream();
257 debug_assert!(tlv_stream.2.payer_id.is_none());
258 tlv_stream.0.metadata = None;
259 if !metadata.derives_keys() {
260 tlv_stream.2.payer_id = self.payer_id.as_ref();
263 let (derived_metadata, derived_keys) = metadata.derive_from(tlv_stream, self.secp_ctx);
264 metadata = derived_metadata;
266 if let Some(keys) = keys {
267 debug_assert!(self.payer_id.is_none());
268 self.payer_id = Some(keys.public_key());
271 self.invoice_request.payer.0 = metadata;
274 debug_assert!(self.invoice_request.payer.0.as_bytes().is_some());
275 debug_assert!(self.payer_id.is_some());
276 let payer_id = self.payer_id.unwrap();
278 let unsigned_invoice = UnsignedInvoiceRequest {
280 invoice_request: InvoiceRequestContents {
281 inner: self.invoice_request,
286 (unsigned_invoice, keys, secp_ctx)
290 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, ExplicitPayerId, T> {
291 /// Builds an unsigned [`InvoiceRequest`] after checking for valid semantics. It can be signed
292 /// by [`UnsignedInvoiceRequest::sign`].
293 pub fn build(self) -> Result<UnsignedInvoiceRequest<'a>, Bolt12SemanticError> {
294 let (unsigned_invoice_request, keys, _) = self.build_with_checks()?;
295 debug_assert!(keys.is_none());
296 Ok(unsigned_invoice_request)
300 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, DerivedPayerId, T> {
301 /// Builds a signed [`InvoiceRequest`] after checking for valid semantics.
302 pub fn build_and_sign(self) -> Result<InvoiceRequest, Bolt12SemanticError> {
303 let (unsigned_invoice_request, keys, secp_ctx) = self.build_with_checks()?;
304 debug_assert!(keys.is_some());
306 let secp_ctx = secp_ctx.unwrap();
307 let keys = keys.unwrap();
308 let invoice_request = unsigned_invoice_request
309 .sign::<_, Infallible>(|digest| Ok(secp_ctx.sign_schnorr_no_aux_rand(digest, &keys)))
316 impl<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, P, T> {
317 fn chain_unchecked(mut self, network: Network) -> Self {
318 let chain = ChainHash::using_genesis_block(network);
319 self.invoice_request.chain = Some(chain);
323 fn amount_msats_unchecked(mut self, amount_msats: u64) -> Self {
324 self.invoice_request.amount_msats = Some(amount_msats);
328 fn features_unchecked(mut self, features: InvoiceRequestFeatures) -> Self {
329 self.invoice_request.features = features;
333 fn quantity_unchecked(mut self, quantity: u64) -> Self {
334 self.invoice_request.quantity = Some(quantity);
338 pub(super) fn build_unchecked(self) -> UnsignedInvoiceRequest<'a> {
339 self.build_without_checks().0
343 /// A semantically valid [`InvoiceRequest`] that hasn't been signed.
344 pub struct UnsignedInvoiceRequest<'a> {
346 invoice_request: InvoiceRequestContents,
349 impl<'a> UnsignedInvoiceRequest<'a> {
350 /// Signs the invoice request using the given function.
352 /// This is not exported to bindings users as functions are not yet mapped.
353 pub fn sign<F, E>(self, sign: F) -> Result<InvoiceRequest, SignError<E>>
355 F: FnOnce(&Message) -> Result<Signature, E>
357 // Use the offer bytes instead of the offer TLV stream as the offer may have contained
358 // unknown TLV records, which are not stored in `OfferContents`.
359 let (payer_tlv_stream, _offer_tlv_stream, invoice_request_tlv_stream) =
360 self.invoice_request.as_tlv_stream();
361 let offer_bytes = WithoutLength(&self.offer.bytes);
362 let unsigned_tlv_stream = (payer_tlv_stream, offer_bytes, invoice_request_tlv_stream);
364 let mut bytes = Vec::new();
365 unsigned_tlv_stream.write(&mut bytes).unwrap();
367 let pubkey = self.invoice_request.payer_id;
368 let signature = merkle::sign_message(sign, SIGNATURE_TAG, &bytes, pubkey)?;
370 // Append the signature TLV record to the bytes.
371 let signature_tlv_stream = SignatureTlvStreamRef {
372 signature: Some(&signature),
374 signature_tlv_stream.write(&mut bytes).unwrap();
378 contents: self.invoice_request,
384 /// An `InvoiceRequest` is a request for a [`Bolt12Invoice`] formulated from an [`Offer`].
386 /// An offer may provide choices such as quantity, amount, chain, features, etc. An invoice request
387 /// specifies these such that its recipient can send an invoice for payment.
389 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
390 /// [`Offer`]: crate::offers::offer::Offer
391 #[derive(Clone, Debug)]
392 #[cfg_attr(test, derive(PartialEq))]
393 pub struct InvoiceRequest {
394 pub(super) bytes: Vec<u8>,
395 pub(super) contents: InvoiceRequestContents,
396 signature: Signature,
399 /// The contents of an [`InvoiceRequest`], which may be shared with an [`Bolt12Invoice`].
401 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
402 #[derive(Clone, Debug)]
403 #[cfg_attr(test, derive(PartialEq))]
404 pub(super) struct InvoiceRequestContents {
405 pub(super) inner: InvoiceRequestContentsWithoutPayerId,
409 #[derive(Clone, Debug)]
410 #[cfg_attr(test, derive(PartialEq))]
411 pub(super) struct InvoiceRequestContentsWithoutPayerId {
412 payer: PayerContents,
413 pub(super) offer: OfferContents,
414 chain: Option<ChainHash>,
415 amount_msats: Option<u64>,
416 features: InvoiceRequestFeatures,
417 quantity: Option<u64>,
418 payer_note: Option<String>,
421 impl InvoiceRequest {
422 /// An unpredictable series of bytes, typically containing information about the derivation of
425 /// [`payer_id`]: Self::payer_id
426 pub fn metadata(&self) -> &[u8] {
427 self.contents.metadata()
430 /// A chain from [`Offer::chains`] that the offer is valid for.
431 pub fn chain(&self) -> ChainHash {
432 self.contents.chain()
435 /// The amount to pay in msats (i.e., the minimum lightning-payable unit for [`chain`]), which
436 /// must be greater than or equal to [`Offer::amount`], converted if necessary.
438 /// [`chain`]: Self::chain
439 pub fn amount_msats(&self) -> Option<u64> {
440 self.contents.inner.amount_msats
443 /// Features pertaining to requesting an invoice.
444 pub fn features(&self) -> &InvoiceRequestFeatures {
445 &self.contents.inner.features
448 /// The quantity of the offer's item conforming to [`Offer::is_valid_quantity`].
449 pub fn quantity(&self) -> Option<u64> {
450 self.contents.inner.quantity
453 /// A possibly transient pubkey used to sign the invoice request.
454 pub fn payer_id(&self) -> PublicKey {
455 self.contents.payer_id
458 /// A payer-provided note which will be seen by the recipient and reflected back in the invoice
460 pub fn payer_note(&self) -> Option<PrintableString> {
461 self.contents.inner.payer_note.as_ref()
462 .map(|payer_note| PrintableString(payer_note.as_str()))
465 /// Signature of the invoice request using [`payer_id`].
467 /// This is not exported to bindings users as Signature is not yet mapped.
469 /// [`payer_id`]: Self::payer_id
470 pub fn signature(&self) -> Signature {
474 /// Creates an [`InvoiceBuilder`] for the request with the given required fields and using the
475 /// [`Duration`] since [`std::time::SystemTime::UNIX_EPOCH`] as the creation time.
477 /// See [`InvoiceRequest::respond_with_no_std`] for further details where the aforementioned
478 /// creation time is used for the `created_at` parameter.
480 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
482 /// [`Duration`]: core::time::Duration
483 #[cfg(feature = "std")]
485 &self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash
486 ) -> Result<InvoiceBuilder<ExplicitSigningPubkey>, Bolt12SemanticError> {
487 let created_at = std::time::SystemTime::now()
488 .duration_since(std::time::SystemTime::UNIX_EPOCH)
489 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
491 self.respond_with_no_std(payment_paths, payment_hash, created_at)
494 /// Creates an [`InvoiceBuilder`] for the request with the given required fields.
496 /// Unless [`InvoiceBuilder::relative_expiry`] is set, the invoice will expire two hours after
497 /// `created_at`, which is used to set [`Bolt12Invoice::created_at`]. Useful for `no-std` builds
498 /// where [`std::time::SystemTime`] is not available.
500 /// The caller is expected to remember the preimage of `payment_hash` in order to claim a payment
503 /// The `payment_paths` parameter is useful for maintaining the payment recipient's privacy. It
504 /// must contain one or more elements ordered from most-preferred to least-preferred, if there's
505 /// a preference. Note, however, that any privacy is lost if a public node id was used for
506 /// [`Offer::signing_pubkey`].
508 /// Errors if the request contains unknown required features.
510 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
512 /// [`Bolt12Invoice::created_at`]: crate::offers::invoice::Bolt12Invoice::created_at
513 pub fn respond_with_no_std(
514 &self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
515 created_at: core::time::Duration
516 ) -> Result<InvoiceBuilder<ExplicitSigningPubkey>, Bolt12SemanticError> {
517 if self.features().requires_unknown_bits() {
518 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
521 InvoiceBuilder::for_offer(self, payment_paths, created_at, payment_hash)
524 /// Creates an [`InvoiceBuilder`] for the request using the given required fields and that uses
525 /// derived signing keys from the originating [`Offer`] to sign the [`Bolt12Invoice`]. Must use
526 /// the same [`ExpandedKey`] as the one used to create the offer.
528 /// See [`InvoiceRequest::respond_with`] for further details.
530 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
532 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
533 #[cfg(feature = "std")]
534 pub fn verify_and_respond_using_derived_keys<T: secp256k1::Signing>(
535 &self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
536 expanded_key: &ExpandedKey, secp_ctx: &Secp256k1<T>
537 ) -> Result<InvoiceBuilder<DerivedSigningPubkey>, Bolt12SemanticError> {
538 let created_at = std::time::SystemTime::now()
539 .duration_since(std::time::SystemTime::UNIX_EPOCH)
540 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
542 self.verify_and_respond_using_derived_keys_no_std(
543 payment_paths, payment_hash, created_at, expanded_key, secp_ctx
547 /// Creates an [`InvoiceBuilder`] for the request using the given required fields and that uses
548 /// derived signing keys from the originating [`Offer`] to sign the [`Bolt12Invoice`]. Must use
549 /// the same [`ExpandedKey`] as the one used to create the offer.
551 /// See [`InvoiceRequest::respond_with_no_std`] for further details.
553 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
555 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
556 pub fn verify_and_respond_using_derived_keys_no_std<T: secp256k1::Signing>(
557 &self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
558 created_at: core::time::Duration, expanded_key: &ExpandedKey, secp_ctx: &Secp256k1<T>
559 ) -> Result<InvoiceBuilder<DerivedSigningPubkey>, Bolt12SemanticError> {
560 if self.features().requires_unknown_bits() {
561 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
564 let keys = match self.verify(expanded_key, secp_ctx) {
565 Err(()) => return Err(Bolt12SemanticError::InvalidMetadata),
566 Ok(None) => return Err(Bolt12SemanticError::InvalidMetadata),
567 Ok(Some(keys)) => keys,
570 InvoiceBuilder::for_offer_using_keys(self, payment_paths, created_at, payment_hash, keys)
573 /// Verifies that the request was for an offer created using the given key. Returns the derived
574 /// keys need to sign an [`Bolt12Invoice`] for the request if they could be extracted from the
577 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
578 pub fn verify<T: secp256k1::Signing>(
579 &self, key: &ExpandedKey, secp_ctx: &Secp256k1<T>
580 ) -> Result<Option<KeyPair>, ()> {
581 self.contents.inner.offer.verify(&self.bytes, key, secp_ctx)
585 fn as_tlv_stream(&self) -> FullInvoiceRequestTlvStreamRef {
586 let (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream) =
587 self.contents.as_tlv_stream();
588 let signature_tlv_stream = SignatureTlvStreamRef {
589 signature: Some(&self.signature),
591 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, signature_tlv_stream)
595 impl InvoiceRequestContents {
596 pub fn metadata(&self) -> &[u8] {
597 self.inner.metadata()
600 pub(super) fn derives_keys(&self) -> bool {
601 self.inner.payer.0.derives_keys()
604 pub(super) fn chain(&self) -> ChainHash {
608 pub(super) fn payer_id(&self) -> PublicKey {
612 pub(super) fn as_tlv_stream(&self) -> PartialInvoiceRequestTlvStreamRef {
613 let (payer, offer, mut invoice_request) = self.inner.as_tlv_stream();
614 invoice_request.payer_id = Some(&self.payer_id);
615 (payer, offer, invoice_request)
619 impl InvoiceRequestContentsWithoutPayerId {
620 pub(super) fn metadata(&self) -> &[u8] {
621 self.payer.0.as_bytes().map(|bytes| bytes.as_slice()).unwrap_or(&[])
624 pub(super) fn chain(&self) -> ChainHash {
625 self.chain.unwrap_or_else(|| self.offer.implied_chain())
628 pub(super) fn as_tlv_stream(&self) -> PartialInvoiceRequestTlvStreamRef {
629 let payer = PayerTlvStreamRef {
630 metadata: self.payer.0.as_bytes(),
633 let offer = self.offer.as_tlv_stream();
636 if self.features == InvoiceRequestFeatures::empty() { None }
637 else { Some(&self.features) }
640 let invoice_request = InvoiceRequestTlvStreamRef {
641 chain: self.chain.as_ref(),
642 amount: self.amount_msats,
644 quantity: self.quantity,
646 payer_note: self.payer_note.as_ref(),
649 (payer, offer, invoice_request)
653 impl Writeable for InvoiceRequest {
654 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
655 WithoutLength(&self.bytes).write(writer)
659 impl Writeable for InvoiceRequestContents {
660 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
661 self.as_tlv_stream().write(writer)
665 /// Valid type range for invoice_request TLV records.
666 pub(super) const INVOICE_REQUEST_TYPES: core::ops::Range<u64> = 80..160;
668 /// TLV record type for [`InvoiceRequest::payer_id`] and [`Refund::payer_id`].
670 /// [`Refund::payer_id`]: crate::offers::refund::Refund::payer_id
671 pub(super) const INVOICE_REQUEST_PAYER_ID_TYPE: u64 = 88;
673 tlv_stream!(InvoiceRequestTlvStream, InvoiceRequestTlvStreamRef, INVOICE_REQUEST_TYPES, {
674 (80, chain: ChainHash),
675 (82, amount: (u64, HighZeroBytesDroppedBigSize)),
676 (84, features: (InvoiceRequestFeatures, WithoutLength)),
677 (86, quantity: (u64, HighZeroBytesDroppedBigSize)),
678 (INVOICE_REQUEST_PAYER_ID_TYPE, payer_id: PublicKey),
679 (89, payer_note: (String, WithoutLength)),
682 type FullInvoiceRequestTlvStream =
683 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, SignatureTlvStream);
686 type FullInvoiceRequestTlvStreamRef<'a> = (
687 PayerTlvStreamRef<'a>,
688 OfferTlvStreamRef<'a>,
689 InvoiceRequestTlvStreamRef<'a>,
690 SignatureTlvStreamRef<'a>,
693 impl SeekReadable for FullInvoiceRequestTlvStream {
694 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
695 let payer = SeekReadable::read(r)?;
696 let offer = SeekReadable::read(r)?;
697 let invoice_request = SeekReadable::read(r)?;
698 let signature = SeekReadable::read(r)?;
700 Ok((payer, offer, invoice_request, signature))
704 type PartialInvoiceRequestTlvStream = (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream);
706 type PartialInvoiceRequestTlvStreamRef<'a> = (
707 PayerTlvStreamRef<'a>,
708 OfferTlvStreamRef<'a>,
709 InvoiceRequestTlvStreamRef<'a>,
712 impl TryFrom<Vec<u8>> for InvoiceRequest {
713 type Error = Bolt12ParseError;
715 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
716 let invoice_request = ParsedMessage::<FullInvoiceRequestTlvStream>::try_from(bytes)?;
717 let ParsedMessage { bytes, tlv_stream } = invoice_request;
719 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream,
720 SignatureTlvStream { signature },
722 let contents = InvoiceRequestContents::try_from(
723 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
726 let signature = match signature {
727 None => return Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
728 Some(signature) => signature,
730 merkle::verify_signature(&signature, SIGNATURE_TAG, &bytes, contents.payer_id)?;
732 Ok(InvoiceRequest { bytes, contents, signature })
736 impl TryFrom<PartialInvoiceRequestTlvStream> for InvoiceRequestContents {
737 type Error = Bolt12SemanticError;
739 fn try_from(tlv_stream: PartialInvoiceRequestTlvStream) -> Result<Self, Self::Error> {
741 PayerTlvStream { metadata },
743 InvoiceRequestTlvStream { chain, amount, features, quantity, payer_id, payer_note },
746 let payer = match metadata {
747 None => return Err(Bolt12SemanticError::MissingPayerMetadata),
748 Some(metadata) => PayerContents(Metadata::Bytes(metadata)),
750 let offer = OfferContents::try_from(offer_tlv_stream)?;
752 if !offer.supports_chain(chain.unwrap_or_else(|| offer.implied_chain())) {
753 return Err(Bolt12SemanticError::UnsupportedChain);
756 if offer.amount().is_none() && amount.is_none() {
757 return Err(Bolt12SemanticError::MissingAmount);
760 offer.check_quantity(quantity)?;
761 offer.check_amount_msats_for_quantity(amount, quantity)?;
763 let features = features.unwrap_or_else(InvoiceRequestFeatures::empty);
765 let payer_id = match payer_id {
766 None => return Err(Bolt12SemanticError::MissingPayerId),
767 Some(payer_id) => payer_id,
770 Ok(InvoiceRequestContents {
771 inner: InvoiceRequestContentsWithoutPayerId {
772 payer, offer, chain, amount_msats: amount, features, quantity, payer_note,
781 use super::{InvoiceRequest, InvoiceRequestTlvStreamRef, SIGNATURE_TAG};
783 use bitcoin::blockdata::constants::ChainHash;
784 use bitcoin::network::constants::Network;
785 use bitcoin::secp256k1::{KeyPair, Secp256k1, SecretKey, self};
786 use core::convert::{Infallible, TryFrom};
787 use core::num::NonZeroU64;
788 #[cfg(feature = "std")]
789 use core::time::Duration;
790 use crate::sign::KeyMaterial;
791 use crate::ln::features::InvoiceRequestFeatures;
792 use crate::ln::inbound_payment::ExpandedKey;
793 use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
794 use crate::offers::invoice::{Bolt12Invoice, SIGNATURE_TAG as INVOICE_SIGNATURE_TAG};
795 use crate::offers::merkle::{SignError, SignatureTlvStreamRef, self};
796 use crate::offers::offer::{Amount, OfferBuilder, OfferTlvStreamRef, Quantity};
797 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
798 use crate::offers::payer::PayerTlvStreamRef;
799 use crate::offers::test_utils::*;
800 use crate::util::ser::{BigSize, Writeable};
801 use crate::util::string::PrintableString;
804 fn builds_invoice_request_with_defaults() {
805 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
808 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
810 .sign(payer_sign).unwrap();
812 let mut buffer = Vec::new();
813 invoice_request.write(&mut buffer).unwrap();
815 assert_eq!(invoice_request.bytes, buffer.as_slice());
816 assert_eq!(invoice_request.metadata(), &[1; 32]);
817 assert_eq!(invoice_request.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
818 assert_eq!(invoice_request.amount_msats(), None);
819 assert_eq!(invoice_request.features(), &InvoiceRequestFeatures::empty());
820 assert_eq!(invoice_request.quantity(), None);
821 assert_eq!(invoice_request.payer_id(), payer_pubkey());
822 assert_eq!(invoice_request.payer_note(), None);
824 merkle::verify_signature(
825 &invoice_request.signature, SIGNATURE_TAG, &invoice_request.bytes, payer_pubkey()
830 invoice_request.as_tlv_stream(),
832 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
838 description: Some(&String::from("foo")),
840 absolute_expiry: None,
844 node_id: Some(&recipient_pubkey()),
846 InvoiceRequestTlvStreamRef {
851 payer_id: Some(&payer_pubkey()),
854 SignatureTlvStreamRef { signature: Some(&invoice_request.signature()) },
858 if let Err(e) = InvoiceRequest::try_from(buffer) {
859 panic!("error parsing invoice request: {:?}", e);
863 #[cfg(feature = "std")]
865 fn builds_invoice_request_from_offer_with_expiration() {
866 let future_expiry = Duration::from_secs(u64::max_value());
867 let past_expiry = Duration::from_secs(0);
869 if let Err(e) = OfferBuilder::new("foo".into(), recipient_pubkey())
871 .absolute_expiry(future_expiry)
873 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
876 panic!("error building invoice_request: {:?}", e);
879 match OfferBuilder::new("foo".into(), recipient_pubkey())
881 .absolute_expiry(past_expiry)
883 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
886 Ok(_) => panic!("expected error"),
887 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
892 fn builds_invoice_request_with_derived_metadata() {
893 let payer_id = payer_pubkey();
894 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
895 let entropy = FixedEntropy {};
896 let secp_ctx = Secp256k1::new();
898 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
901 let invoice_request = offer
902 .request_invoice_deriving_metadata(payer_id, &expanded_key, &entropy)
905 .sign(payer_sign).unwrap();
906 assert_eq!(invoice_request.payer_id(), payer_pubkey());
908 let invoice = invoice_request.respond_with_no_std(payment_paths(), payment_hash(), now())
911 .sign(recipient_sign).unwrap();
912 assert!(invoice.verify(&expanded_key, &secp_ctx));
914 // Fails verification with altered fields
916 payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream,
917 mut invoice_tlv_stream, mut signature_tlv_stream
918 ) = invoice.as_tlv_stream();
919 invoice_request_tlv_stream.amount = Some(2000);
920 invoice_tlv_stream.amount = Some(2000);
923 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
924 let mut bytes = Vec::new();
925 tlv_stream.write(&mut bytes).unwrap();
927 let signature = merkle::sign_message(
928 recipient_sign, INVOICE_SIGNATURE_TAG, &bytes, recipient_pubkey()
930 signature_tlv_stream.signature = Some(&signature);
932 let mut encoded_invoice = bytes;
933 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
935 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
936 assert!(!invoice.verify(&expanded_key, &secp_ctx));
938 // Fails verification with altered metadata
940 mut payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
941 mut signature_tlv_stream
942 ) = invoice.as_tlv_stream();
943 let metadata = payer_tlv_stream.metadata.unwrap().iter().copied().rev().collect();
944 payer_tlv_stream.metadata = Some(&metadata);
947 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
948 let mut bytes = Vec::new();
949 tlv_stream.write(&mut bytes).unwrap();
951 let signature = merkle::sign_message(
952 recipient_sign, INVOICE_SIGNATURE_TAG, &bytes, recipient_pubkey()
954 signature_tlv_stream.signature = Some(&signature);
956 let mut encoded_invoice = bytes;
957 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
959 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
960 assert!(!invoice.verify(&expanded_key, &secp_ctx));
964 fn builds_invoice_request_with_derived_payer_id() {
965 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
966 let entropy = FixedEntropy {};
967 let secp_ctx = Secp256k1::new();
969 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
972 let invoice_request = offer
973 .request_invoice_deriving_payer_id(&expanded_key, &entropy, &secp_ctx)
978 let invoice = invoice_request.respond_with_no_std(payment_paths(), payment_hash(), now())
981 .sign(recipient_sign).unwrap();
982 assert!(invoice.verify(&expanded_key, &secp_ctx));
984 // Fails verification with altered fields
986 payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream,
987 mut invoice_tlv_stream, mut signature_tlv_stream
988 ) = invoice.as_tlv_stream();
989 invoice_request_tlv_stream.amount = Some(2000);
990 invoice_tlv_stream.amount = Some(2000);
993 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
994 let mut bytes = Vec::new();
995 tlv_stream.write(&mut bytes).unwrap();
997 let signature = merkle::sign_message(
998 recipient_sign, INVOICE_SIGNATURE_TAG, &bytes, recipient_pubkey()
1000 signature_tlv_stream.signature = Some(&signature);
1002 let mut encoded_invoice = bytes;
1003 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1005 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1006 assert!(!invoice.verify(&expanded_key, &secp_ctx));
1008 // Fails verification with altered payer id
1010 payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream, invoice_tlv_stream,
1011 mut signature_tlv_stream
1012 ) = invoice.as_tlv_stream();
1013 let payer_id = pubkey(1);
1014 invoice_request_tlv_stream.payer_id = Some(&payer_id);
1017 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1018 let mut bytes = Vec::new();
1019 tlv_stream.write(&mut bytes).unwrap();
1021 let signature = merkle::sign_message(
1022 recipient_sign, INVOICE_SIGNATURE_TAG, &bytes, recipient_pubkey()
1024 signature_tlv_stream.signature = Some(&signature);
1026 let mut encoded_invoice = bytes;
1027 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1029 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1030 assert!(!invoice.verify(&expanded_key, &secp_ctx));
1034 fn builds_invoice_request_with_chain() {
1035 let mainnet = ChainHash::using_genesis_block(Network::Bitcoin);
1036 let testnet = ChainHash::using_genesis_block(Network::Testnet);
1038 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1041 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1042 .chain(Network::Bitcoin).unwrap()
1044 .sign(payer_sign).unwrap();
1045 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1046 assert_eq!(invoice_request.chain(), mainnet);
1047 assert_eq!(tlv_stream.chain, None);
1049 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1051 .chain(Network::Testnet)
1053 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1054 .chain(Network::Testnet).unwrap()
1056 .sign(payer_sign).unwrap();
1057 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1058 assert_eq!(invoice_request.chain(), testnet);
1059 assert_eq!(tlv_stream.chain, Some(&testnet));
1061 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1063 .chain(Network::Bitcoin)
1064 .chain(Network::Testnet)
1066 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1067 .chain(Network::Bitcoin).unwrap()
1069 .sign(payer_sign).unwrap();
1070 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1071 assert_eq!(invoice_request.chain(), mainnet);
1072 assert_eq!(tlv_stream.chain, None);
1074 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1076 .chain(Network::Bitcoin)
1077 .chain(Network::Testnet)
1079 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1080 .chain(Network::Bitcoin).unwrap()
1081 .chain(Network::Testnet).unwrap()
1083 .sign(payer_sign).unwrap();
1084 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1085 assert_eq!(invoice_request.chain(), testnet);
1086 assert_eq!(tlv_stream.chain, Some(&testnet));
1088 match OfferBuilder::new("foo".into(), recipient_pubkey())
1090 .chain(Network::Testnet)
1092 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1093 .chain(Network::Bitcoin)
1095 Ok(_) => panic!("expected error"),
1096 Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
1099 match OfferBuilder::new("foo".into(), recipient_pubkey())
1101 .chain(Network::Testnet)
1103 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1106 Ok(_) => panic!("expected error"),
1107 Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
1112 fn builds_invoice_request_with_amount() {
1113 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1116 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1117 .amount_msats(1000).unwrap()
1119 .sign(payer_sign).unwrap();
1120 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1121 assert_eq!(invoice_request.amount_msats(), Some(1000));
1122 assert_eq!(tlv_stream.amount, Some(1000));
1124 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1127 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1128 .amount_msats(1001).unwrap()
1129 .amount_msats(1000).unwrap()
1131 .sign(payer_sign).unwrap();
1132 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1133 assert_eq!(invoice_request.amount_msats(), Some(1000));
1134 assert_eq!(tlv_stream.amount, Some(1000));
1136 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1139 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1140 .amount_msats(1001).unwrap()
1142 .sign(payer_sign).unwrap();
1143 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1144 assert_eq!(invoice_request.amount_msats(), Some(1001));
1145 assert_eq!(tlv_stream.amount, Some(1001));
1147 match OfferBuilder::new("foo".into(), recipient_pubkey())
1150 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1153 Ok(_) => panic!("expected error"),
1154 Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1157 match OfferBuilder::new("foo".into(), recipient_pubkey())
1159 .supported_quantity(Quantity::Unbounded)
1161 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1162 .quantity(2).unwrap()
1165 Ok(_) => panic!("expected error"),
1166 Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1169 match OfferBuilder::new("foo".into(), recipient_pubkey())
1172 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1173 .amount_msats(MAX_VALUE_MSAT + 1)
1175 Ok(_) => panic!("expected error"),
1176 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1179 match OfferBuilder::new("foo".into(), recipient_pubkey())
1181 .supported_quantity(Quantity::Unbounded)
1183 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1184 .amount_msats(1000).unwrap()
1185 .quantity(2).unwrap()
1188 Ok(_) => panic!("expected error"),
1189 Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1192 match OfferBuilder::new("foo".into(), recipient_pubkey())
1194 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1197 Ok(_) => panic!("expected error"),
1198 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingAmount),
1201 match OfferBuilder::new("foo".into(), recipient_pubkey())
1203 .supported_quantity(Quantity::Unbounded)
1205 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1206 .quantity(u64::max_value()).unwrap()
1209 Ok(_) => panic!("expected error"),
1210 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1215 fn builds_invoice_request_with_features() {
1216 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1219 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1220 .features_unchecked(InvoiceRequestFeatures::unknown())
1222 .sign(payer_sign).unwrap();
1223 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1224 assert_eq!(invoice_request.features(), &InvoiceRequestFeatures::unknown());
1225 assert_eq!(tlv_stream.features, Some(&InvoiceRequestFeatures::unknown()));
1227 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1230 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1231 .features_unchecked(InvoiceRequestFeatures::unknown())
1232 .features_unchecked(InvoiceRequestFeatures::empty())
1234 .sign(payer_sign).unwrap();
1235 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1236 assert_eq!(invoice_request.features(), &InvoiceRequestFeatures::empty());
1237 assert_eq!(tlv_stream.features, None);
1241 fn builds_invoice_request_with_quantity() {
1242 let one = NonZeroU64::new(1).unwrap();
1243 let ten = NonZeroU64::new(10).unwrap();
1245 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1247 .supported_quantity(Quantity::One)
1249 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1251 .sign(payer_sign).unwrap();
1252 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1253 assert_eq!(invoice_request.quantity(), None);
1254 assert_eq!(tlv_stream.quantity, None);
1256 match OfferBuilder::new("foo".into(), recipient_pubkey())
1258 .supported_quantity(Quantity::One)
1260 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1261 .amount_msats(2_000).unwrap()
1264 Ok(_) => panic!("expected error"),
1265 Err(e) => assert_eq!(e, Bolt12SemanticError::UnexpectedQuantity),
1268 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1270 .supported_quantity(Quantity::Bounded(ten))
1272 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1273 .amount_msats(10_000).unwrap()
1274 .quantity(10).unwrap()
1276 .sign(payer_sign).unwrap();
1277 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1278 assert_eq!(invoice_request.amount_msats(), Some(10_000));
1279 assert_eq!(tlv_stream.amount, Some(10_000));
1281 match OfferBuilder::new("foo".into(), recipient_pubkey())
1283 .supported_quantity(Quantity::Bounded(ten))
1285 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1286 .amount_msats(11_000).unwrap()
1289 Ok(_) => panic!("expected error"),
1290 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidQuantity),
1293 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1295 .supported_quantity(Quantity::Unbounded)
1297 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1298 .amount_msats(2_000).unwrap()
1299 .quantity(2).unwrap()
1301 .sign(payer_sign).unwrap();
1302 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1303 assert_eq!(invoice_request.amount_msats(), Some(2_000));
1304 assert_eq!(tlv_stream.amount, Some(2_000));
1306 match OfferBuilder::new("foo".into(), recipient_pubkey())
1308 .supported_quantity(Quantity::Unbounded)
1310 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1313 Ok(_) => panic!("expected error"),
1314 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingQuantity),
1317 match OfferBuilder::new("foo".into(), recipient_pubkey())
1319 .supported_quantity(Quantity::Bounded(one))
1321 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1324 Ok(_) => panic!("expected error"),
1325 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingQuantity),
1330 fn builds_invoice_request_with_payer_note() {
1331 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1334 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1335 .payer_note("bar".into())
1337 .sign(payer_sign).unwrap();
1338 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1339 assert_eq!(invoice_request.payer_note(), Some(PrintableString("bar")));
1340 assert_eq!(tlv_stream.payer_note, Some(&String::from("bar")));
1342 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1345 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1346 .payer_note("bar".into())
1347 .payer_note("baz".into())
1349 .sign(payer_sign).unwrap();
1350 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1351 assert_eq!(invoice_request.payer_note(), Some(PrintableString("baz")));
1352 assert_eq!(tlv_stream.payer_note, Some(&String::from("baz")));
1356 fn fails_signing_invoice_request() {
1357 match OfferBuilder::new("foo".into(), recipient_pubkey())
1360 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1364 Ok(_) => panic!("expected error"),
1365 Err(e) => assert_eq!(e, SignError::Signing(())),
1368 match OfferBuilder::new("foo".into(), recipient_pubkey())
1371 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1373 .sign(recipient_sign)
1375 Ok(_) => panic!("expected error"),
1376 Err(e) => assert_eq!(e, SignError::Verification(secp256k1::Error::InvalidSignature)),
1381 fn fails_responding_with_unknown_required_features() {
1382 match OfferBuilder::new("foo".into(), recipient_pubkey())
1385 .request_invoice(vec![42; 32], payer_pubkey()).unwrap()
1386 .features_unchecked(InvoiceRequestFeatures::unknown())
1388 .sign(payer_sign).unwrap()
1389 .respond_with_no_std(payment_paths(), payment_hash(), now())
1391 Ok(_) => panic!("expected error"),
1392 Err(e) => assert_eq!(e, Bolt12SemanticError::UnknownRequiredFeatures),
1397 fn parses_invoice_request_with_metadata() {
1398 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1401 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1403 .sign(payer_sign).unwrap();
1405 let mut buffer = Vec::new();
1406 invoice_request.write(&mut buffer).unwrap();
1408 if let Err(e) = InvoiceRequest::try_from(buffer) {
1409 panic!("error parsing invoice_request: {:?}", e);
1414 fn parses_invoice_request_with_chain() {
1415 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1418 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1419 .chain(Network::Bitcoin).unwrap()
1421 .sign(payer_sign).unwrap();
1423 let mut buffer = Vec::new();
1424 invoice_request.write(&mut buffer).unwrap();
1426 if let Err(e) = InvoiceRequest::try_from(buffer) {
1427 panic!("error parsing invoice_request: {:?}", e);
1430 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1433 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1434 .chain_unchecked(Network::Testnet)
1436 .sign(payer_sign).unwrap();
1438 let mut buffer = Vec::new();
1439 invoice_request.write(&mut buffer).unwrap();
1441 match InvoiceRequest::try_from(buffer) {
1442 Ok(_) => panic!("expected error"),
1443 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnsupportedChain)),
1448 fn parses_invoice_request_with_amount() {
1449 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1452 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1454 .sign(payer_sign).unwrap();
1456 let mut buffer = Vec::new();
1457 invoice_request.write(&mut buffer).unwrap();
1459 if let Err(e) = InvoiceRequest::try_from(buffer) {
1460 panic!("error parsing invoice_request: {:?}", e);
1463 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1465 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1466 .amount_msats(1000).unwrap()
1468 .sign(payer_sign).unwrap();
1470 let mut buffer = Vec::new();
1471 invoice_request.write(&mut buffer).unwrap();
1473 if let Err(e) = InvoiceRequest::try_from(buffer) {
1474 panic!("error parsing invoice_request: {:?}", e);
1477 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1479 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1481 .sign(payer_sign).unwrap();
1483 let mut buffer = Vec::new();
1484 invoice_request.write(&mut buffer).unwrap();
1486 match InvoiceRequest::try_from(buffer) {
1487 Ok(_) => panic!("expected error"),
1488 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount)),
1491 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1494 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1495 .amount_msats_unchecked(999)
1497 .sign(payer_sign).unwrap();
1499 let mut buffer = Vec::new();
1500 invoice_request.write(&mut buffer).unwrap();
1502 match InvoiceRequest::try_from(buffer) {
1503 Ok(_) => panic!("expected error"),
1504 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InsufficientAmount)),
1507 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1508 .amount(Amount::Currency { iso4217_code: *b"USD", amount: 1000 })
1510 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1512 .sign(payer_sign).unwrap();
1514 let mut buffer = Vec::new();
1515 invoice_request.write(&mut buffer).unwrap();
1517 match InvoiceRequest::try_from(buffer) {
1518 Ok(_) => panic!("expected error"),
1520 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnsupportedCurrency));
1524 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1526 .supported_quantity(Quantity::Unbounded)
1528 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1529 .quantity(u64::max_value()).unwrap()
1531 .sign(payer_sign).unwrap();
1533 let mut buffer = Vec::new();
1534 invoice_request.write(&mut buffer).unwrap();
1536 match InvoiceRequest::try_from(buffer) {
1537 Ok(_) => panic!("expected error"),
1538 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidAmount)),
1543 fn parses_invoice_request_with_quantity() {
1544 let one = NonZeroU64::new(1).unwrap();
1545 let ten = NonZeroU64::new(10).unwrap();
1547 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1549 .supported_quantity(Quantity::One)
1551 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1553 .sign(payer_sign).unwrap();
1555 let mut buffer = Vec::new();
1556 invoice_request.write(&mut buffer).unwrap();
1558 if let Err(e) = InvoiceRequest::try_from(buffer) {
1559 panic!("error parsing invoice_request: {:?}", e);
1562 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1564 .supported_quantity(Quantity::One)
1566 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1567 .amount_msats(2_000).unwrap()
1568 .quantity_unchecked(2)
1570 .sign(payer_sign).unwrap();
1572 let mut buffer = Vec::new();
1573 invoice_request.write(&mut buffer).unwrap();
1575 match InvoiceRequest::try_from(buffer) {
1576 Ok(_) => panic!("expected error"),
1578 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnexpectedQuantity));
1582 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1584 .supported_quantity(Quantity::Bounded(ten))
1586 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1587 .amount_msats(10_000).unwrap()
1588 .quantity(10).unwrap()
1590 .sign(payer_sign).unwrap();
1592 let mut buffer = Vec::new();
1593 invoice_request.write(&mut buffer).unwrap();
1595 if let Err(e) = InvoiceRequest::try_from(buffer) {
1596 panic!("error parsing invoice_request: {:?}", e);
1599 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1601 .supported_quantity(Quantity::Bounded(ten))
1603 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1604 .amount_msats(11_000).unwrap()
1605 .quantity_unchecked(11)
1607 .sign(payer_sign).unwrap();
1609 let mut buffer = Vec::new();
1610 invoice_request.write(&mut buffer).unwrap();
1612 match InvoiceRequest::try_from(buffer) {
1613 Ok(_) => panic!("expected error"),
1614 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidQuantity)),
1617 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1619 .supported_quantity(Quantity::Unbounded)
1621 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1622 .amount_msats(2_000).unwrap()
1623 .quantity(2).unwrap()
1625 .sign(payer_sign).unwrap();
1627 let mut buffer = Vec::new();
1628 invoice_request.write(&mut buffer).unwrap();
1630 if let Err(e) = InvoiceRequest::try_from(buffer) {
1631 panic!("error parsing invoice_request: {:?}", e);
1634 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1636 .supported_quantity(Quantity::Unbounded)
1638 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1640 .sign(payer_sign).unwrap();
1642 let mut buffer = Vec::new();
1643 invoice_request.write(&mut buffer).unwrap();
1645 match InvoiceRequest::try_from(buffer) {
1646 Ok(_) => panic!("expected error"),
1647 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingQuantity)),
1650 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1652 .supported_quantity(Quantity::Bounded(one))
1654 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1656 .sign(payer_sign).unwrap();
1658 let mut buffer = Vec::new();
1659 invoice_request.write(&mut buffer).unwrap();
1661 match InvoiceRequest::try_from(buffer) {
1662 Ok(_) => panic!("expected error"),
1663 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingQuantity)),
1668 fn fails_parsing_invoice_request_without_metadata() {
1669 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
1672 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1674 let mut tlv_stream = unsigned_invoice_request.invoice_request.as_tlv_stream();
1675 tlv_stream.0.metadata = None;
1677 let mut buffer = Vec::new();
1678 tlv_stream.write(&mut buffer).unwrap();
1680 match InvoiceRequest::try_from(buffer) {
1681 Ok(_) => panic!("expected error"),
1683 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerMetadata));
1689 fn fails_parsing_invoice_request_without_payer_id() {
1690 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
1693 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1695 let mut tlv_stream = unsigned_invoice_request.invoice_request.as_tlv_stream();
1696 tlv_stream.2.payer_id = None;
1698 let mut buffer = Vec::new();
1699 tlv_stream.write(&mut buffer).unwrap();
1701 match InvoiceRequest::try_from(buffer) {
1702 Ok(_) => panic!("expected error"),
1703 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerId)),
1708 fn fails_parsing_invoice_request_without_node_id() {
1709 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
1712 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1714 let mut tlv_stream = unsigned_invoice_request.invoice_request.as_tlv_stream();
1715 tlv_stream.1.node_id = None;
1717 let mut buffer = Vec::new();
1718 tlv_stream.write(&mut buffer).unwrap();
1720 match InvoiceRequest::try_from(buffer) {
1721 Ok(_) => panic!("expected error"),
1723 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey));
1729 fn fails_parsing_invoice_request_without_signature() {
1730 let mut buffer = Vec::new();
1731 OfferBuilder::new("foo".into(), recipient_pubkey())
1734 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1737 .write(&mut buffer).unwrap();
1739 match InvoiceRequest::try_from(buffer) {
1740 Ok(_) => panic!("expected error"),
1741 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
1746 fn fails_parsing_invoice_request_with_invalid_signature() {
1747 let mut invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1750 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1752 .sign(payer_sign).unwrap();
1753 let last_signature_byte = invoice_request.bytes.last_mut().unwrap();
1754 *last_signature_byte = last_signature_byte.wrapping_add(1);
1756 let mut buffer = Vec::new();
1757 invoice_request.write(&mut buffer).unwrap();
1759 match InvoiceRequest::try_from(buffer) {
1760 Ok(_) => panic!("expected error"),
1762 assert_eq!(e, Bolt12ParseError::InvalidSignature(secp256k1::Error::InvalidSignature));
1768 fn fails_parsing_invoice_request_with_extra_tlv_records() {
1769 let secp_ctx = Secp256k1::new();
1770 let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
1771 let invoice_request = OfferBuilder::new("foo".into(), keys.public_key())
1774 .request_invoice(vec![1; 32], keys.public_key()).unwrap()
1776 .sign::<_, Infallible>(|digest| Ok(secp_ctx.sign_schnorr_no_aux_rand(digest, &keys)))
1779 let mut encoded_invoice_request = Vec::new();
1780 invoice_request.write(&mut encoded_invoice_request).unwrap();
1781 BigSize(1002).write(&mut encoded_invoice_request).unwrap();
1782 BigSize(32).write(&mut encoded_invoice_request).unwrap();
1783 [42u8; 32].write(&mut encoded_invoice_request).unwrap();
1785 match InvoiceRequest::try_from(encoded_invoice_request) {
1786 Ok(_) => panic!("expected error"),
1787 Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),