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>(
48 //! |message| Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
50 //! .expect("failed verifying signature")
51 //! .write(&mut buffer)
57 use bitcoin::blockdata::constants::ChainHash;
58 use bitcoin::network::constants::Network;
59 use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, self};
60 use bitcoin::secp256k1::schnorr::Signature;
61 use core::convert::{AsRef, Infallible, TryFrom};
63 use crate::sign::EntropySource;
65 use crate::blinded_path::BlindedPath;
66 use crate::ln::PaymentHash;
67 use crate::ln::features::InvoiceRequestFeatures;
68 use crate::ln::inbound_payment::{ExpandedKey, IV_LEN, Nonce};
69 use crate::ln::msgs::DecodeError;
70 use crate::offers::invoice::{BlindedPayInfo, DerivedSigningPubkey, ExplicitSigningPubkey, InvoiceBuilder};
71 use crate::offers::merkle::{SignError, SignatureTlvStream, SignatureTlvStreamRef, TaggedHash, self};
72 use crate::offers::offer::{Offer, OfferContents, OfferTlvStream, OfferTlvStreamRef};
73 use crate::offers::parse::{Bolt12ParseError, ParsedMessage, Bolt12SemanticError};
74 use crate::offers::payer::{PayerContents, PayerTlvStream, PayerTlvStreamRef};
75 use crate::offers::signer::{Metadata, MetadataMaterial};
76 use crate::util::ser::{HighZeroBytesDroppedBigSize, SeekReadable, WithoutLength, Writeable, Writer};
77 use crate::util::string::PrintableString;
79 use crate::prelude::*;
81 /// Tag for the hash function used when signing an [`InvoiceRequest`]'s merkle root.
82 pub const SIGNATURE_TAG: &'static str = concat!("lightning", "invoice_request", "signature");
84 pub(super) const IV_BYTES: &[u8; IV_LEN] = b"LDK Invreq ~~~~~";
86 /// Builds an [`InvoiceRequest`] from an [`Offer`] for the "offer to be paid" flow.
88 /// See [module-level documentation] for usage.
90 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
92 /// [module-level documentation]: self
93 pub struct InvoiceRequestBuilder<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> {
95 invoice_request: InvoiceRequestContentsWithoutPayerId,
96 payer_id: Option<PublicKey>,
97 payer_id_strategy: core::marker::PhantomData<P>,
98 secp_ctx: Option<&'b Secp256k1<T>>,
101 /// Indicates how [`InvoiceRequest::payer_id`] will be set.
103 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
104 pub trait PayerIdStrategy {}
106 /// [`InvoiceRequest::payer_id`] will be explicitly set.
108 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
109 pub struct ExplicitPayerId {}
111 /// [`InvoiceRequest::payer_id`] will be derived.
113 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
114 pub struct DerivedPayerId {}
116 impl PayerIdStrategy for ExplicitPayerId {}
117 impl PayerIdStrategy for DerivedPayerId {}
119 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, ExplicitPayerId, T> {
120 pub(super) fn new(offer: &'a Offer, metadata: Vec<u8>, payer_id: PublicKey) -> Self {
123 invoice_request: Self::create_contents(offer, Metadata::Bytes(metadata)),
124 payer_id: Some(payer_id),
125 payer_id_strategy: core::marker::PhantomData,
130 pub(super) fn deriving_metadata<ES: Deref>(
131 offer: &'a Offer, payer_id: PublicKey, expanded_key: &ExpandedKey, entropy_source: ES
132 ) -> Self where ES::Target: EntropySource {
133 let nonce = Nonce::from_entropy_source(entropy_source);
134 let derivation_material = MetadataMaterial::new(nonce, expanded_key, IV_BYTES);
135 let metadata = Metadata::Derived(derivation_material);
138 invoice_request: Self::create_contents(offer, metadata),
139 payer_id: Some(payer_id),
140 payer_id_strategy: core::marker::PhantomData,
146 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, DerivedPayerId, T> {
147 pub(super) fn deriving_payer_id<ES: Deref>(
148 offer: &'a Offer, expanded_key: &ExpandedKey, entropy_source: ES, secp_ctx: &'b Secp256k1<T>
149 ) -> Self where ES::Target: EntropySource {
150 let nonce = Nonce::from_entropy_source(entropy_source);
151 let derivation_material = MetadataMaterial::new(nonce, expanded_key, IV_BYTES);
152 let metadata = Metadata::DerivedSigningPubkey(derivation_material);
155 invoice_request: Self::create_contents(offer, metadata),
157 payer_id_strategy: core::marker::PhantomData,
158 secp_ctx: Some(secp_ctx),
163 impl<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, P, T> {
164 fn create_contents(offer: &Offer, metadata: Metadata) -> InvoiceRequestContentsWithoutPayerId {
165 let offer = offer.contents.clone();
166 InvoiceRequestContentsWithoutPayerId {
167 payer: PayerContents(metadata), offer, chain: None, amount_msats: None,
168 features: InvoiceRequestFeatures::empty(), quantity: None, payer_note: None,
172 /// Sets the [`InvoiceRequest::chain`] of the given [`Network`] for paying an invoice. If not
173 /// called, [`Network::Bitcoin`] is assumed. Errors if the chain for `network` is not supported
176 /// Successive calls to this method will override the previous setting.
177 pub fn chain(mut self, network: Network) -> Result<Self, Bolt12SemanticError> {
178 let chain = ChainHash::using_genesis_block(network);
179 if !self.offer.supports_chain(chain) {
180 return Err(Bolt12SemanticError::UnsupportedChain);
183 self.invoice_request.chain = Some(chain);
187 /// Sets the [`InvoiceRequest::amount_msats`] for paying an invoice. Errors if `amount_msats` is
188 /// not at least the expected invoice amount (i.e., [`Offer::amount`] times [`quantity`]).
190 /// Successive calls to this method will override the previous setting.
192 /// [`quantity`]: Self::quantity
193 pub fn amount_msats(mut self, amount_msats: u64) -> Result<Self, Bolt12SemanticError> {
194 self.invoice_request.offer.check_amount_msats_for_quantity(
195 Some(amount_msats), self.invoice_request.quantity
197 self.invoice_request.amount_msats = Some(amount_msats);
201 /// Sets [`InvoiceRequest::quantity`] of items. If not set, `1` is assumed. Errors if `quantity`
202 /// does not conform to [`Offer::is_valid_quantity`].
204 /// Successive calls to this method will override the previous setting.
205 pub fn quantity(mut self, quantity: u64) -> Result<Self, Bolt12SemanticError> {
206 self.invoice_request.offer.check_quantity(Some(quantity))?;
207 self.invoice_request.quantity = Some(quantity);
211 /// Sets the [`InvoiceRequest::payer_note`].
213 /// Successive calls to this method will override the previous setting.
214 pub fn payer_note(mut self, payer_note: String) -> Self {
215 self.invoice_request.payer_note = Some(payer_note);
219 fn build_with_checks(mut self) -> Result<
220 (UnsignedInvoiceRequest, Option<KeyPair>, Option<&'b Secp256k1<T>>),
223 #[cfg(feature = "std")] {
224 if self.offer.is_expired() {
225 return Err(Bolt12SemanticError::AlreadyExpired);
229 let chain = self.invoice_request.chain();
230 if !self.offer.supports_chain(chain) {
231 return Err(Bolt12SemanticError::UnsupportedChain);
234 if chain == self.offer.implied_chain() {
235 self.invoice_request.chain = None;
238 if self.offer.amount().is_none() && self.invoice_request.amount_msats.is_none() {
239 return Err(Bolt12SemanticError::MissingAmount);
242 self.invoice_request.offer.check_quantity(self.invoice_request.quantity)?;
243 self.invoice_request.offer.check_amount_msats_for_quantity(
244 self.invoice_request.amount_msats, self.invoice_request.quantity
247 Ok(self.build_without_checks())
250 fn build_without_checks(mut self) ->
251 (UnsignedInvoiceRequest, Option<KeyPair>, Option<&'b Secp256k1<T>>)
253 // Create the metadata for stateless verification of a Bolt12Invoice.
255 let secp_ctx = self.secp_ctx.clone();
256 if self.invoice_request.payer.0.has_derivation_material() {
257 let mut metadata = core::mem::take(&mut self.invoice_request.payer.0);
259 let mut tlv_stream = self.invoice_request.as_tlv_stream();
260 debug_assert!(tlv_stream.2.payer_id.is_none());
261 tlv_stream.0.metadata = None;
262 if !metadata.derives_keys() {
263 tlv_stream.2.payer_id = self.payer_id.as_ref();
266 let (derived_metadata, derived_keys) = metadata.derive_from(tlv_stream, self.secp_ctx);
267 metadata = derived_metadata;
269 if let Some(keys) = keys {
270 debug_assert!(self.payer_id.is_none());
271 self.payer_id = Some(keys.public_key());
274 self.invoice_request.payer.0 = metadata;
277 debug_assert!(self.invoice_request.payer.0.as_bytes().is_some());
278 debug_assert!(self.payer_id.is_some());
279 let payer_id = self.payer_id.unwrap();
281 let invoice_request = InvoiceRequestContents {
282 inner: self.invoice_request,
285 let unsigned_invoice_request = UnsignedInvoiceRequest::new(self.offer, invoice_request);
287 (unsigned_invoice_request, keys, secp_ctx)
291 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, ExplicitPayerId, T> {
292 /// Builds an unsigned [`InvoiceRequest`] after checking for valid semantics. It can be signed
293 /// by [`UnsignedInvoiceRequest::sign`].
294 pub fn build(self) -> Result<UnsignedInvoiceRequest, Bolt12SemanticError> {
295 let (unsigned_invoice_request, keys, _) = self.build_with_checks()?;
296 debug_assert!(keys.is_none());
297 Ok(unsigned_invoice_request)
301 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, DerivedPayerId, T> {
302 /// Builds a signed [`InvoiceRequest`] after checking for valid semantics.
303 pub fn build_and_sign(self) -> Result<InvoiceRequest, Bolt12SemanticError> {
304 let (unsigned_invoice_request, keys, secp_ctx) = self.build_with_checks()?;
305 debug_assert!(keys.is_some());
307 let secp_ctx = secp_ctx.unwrap();
308 let keys = keys.unwrap();
309 let invoice_request = unsigned_invoice_request
310 .sign::<_, Infallible>(
311 |message| Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
319 impl<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, P, T> {
320 fn chain_unchecked(mut self, network: Network) -> Self {
321 let chain = ChainHash::using_genesis_block(network);
322 self.invoice_request.chain = Some(chain);
326 fn amount_msats_unchecked(mut self, amount_msats: u64) -> Self {
327 self.invoice_request.amount_msats = Some(amount_msats);
331 fn features_unchecked(mut self, features: InvoiceRequestFeatures) -> Self {
332 self.invoice_request.features = features;
336 fn quantity_unchecked(mut self, quantity: u64) -> Self {
337 self.invoice_request.quantity = Some(quantity);
341 pub(super) fn build_unchecked(self) -> UnsignedInvoiceRequest {
342 self.build_without_checks().0
346 /// A semantically valid [`InvoiceRequest`] that hasn't been signed.
347 pub struct UnsignedInvoiceRequest {
349 invoice_request: InvoiceRequestContents,
350 tagged_hash: TaggedHash,
353 impl UnsignedInvoiceRequest {
354 fn new(offer: &Offer, invoice_request: InvoiceRequestContents) -> Self {
355 // Use the offer bytes instead of the offer TLV stream as the offer may have contained
356 // unknown TLV records, which are not stored in `OfferContents`.
357 let (payer_tlv_stream, _offer_tlv_stream, invoice_request_tlv_stream) =
358 invoice_request.as_tlv_stream();
359 let offer_bytes = WithoutLength(&offer.bytes);
360 let unsigned_tlv_stream = (payer_tlv_stream, offer_bytes, invoice_request_tlv_stream);
362 let mut bytes = Vec::new();
363 unsigned_tlv_stream.write(&mut bytes).unwrap();
365 let tagged_hash = TaggedHash::new(SIGNATURE_TAG, &bytes);
367 Self { bytes, invoice_request, tagged_hash }
370 /// Signs the invoice request using the given function.
372 /// This is not exported to bindings users as functions are not yet mapped.
373 pub fn sign<F, E>(mut self, sign: F) -> Result<InvoiceRequest, SignError<E>>
375 F: FnOnce(&Self) -> Result<Signature, E>
377 let pubkey = self.invoice_request.payer_id;
378 let signature = merkle::sign_message(sign, &self, pubkey)?;
380 // Append the signature TLV record to the bytes.
381 let signature_tlv_stream = SignatureTlvStreamRef {
382 signature: Some(&signature),
384 signature_tlv_stream.write(&mut self.bytes).unwrap();
388 contents: self.invoice_request,
394 impl AsRef<TaggedHash> for UnsignedInvoiceRequest {
395 fn as_ref(&self) -> &TaggedHash {
400 /// An `InvoiceRequest` is a request for a [`Bolt12Invoice`] formulated from an [`Offer`].
402 /// An offer may provide choices such as quantity, amount, chain, features, etc. An invoice request
403 /// specifies these such that its recipient can send an invoice for payment.
405 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
406 /// [`Offer`]: crate::offers::offer::Offer
407 #[derive(Clone, Debug)]
408 #[cfg_attr(test, derive(PartialEq))]
409 pub struct InvoiceRequest {
410 pub(super) bytes: Vec<u8>,
411 pub(super) contents: InvoiceRequestContents,
412 signature: Signature,
415 /// The contents of an [`InvoiceRequest`], which may be shared with an [`Bolt12Invoice`].
417 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
418 #[derive(Clone, Debug)]
419 #[cfg_attr(test, derive(PartialEq))]
420 pub(super) struct InvoiceRequestContents {
421 pub(super) inner: InvoiceRequestContentsWithoutPayerId,
425 #[derive(Clone, Debug)]
426 #[cfg_attr(test, derive(PartialEq))]
427 pub(super) struct InvoiceRequestContentsWithoutPayerId {
428 payer: PayerContents,
429 pub(super) offer: OfferContents,
430 chain: Option<ChainHash>,
431 amount_msats: Option<u64>,
432 features: InvoiceRequestFeatures,
433 quantity: Option<u64>,
434 payer_note: Option<String>,
437 impl InvoiceRequest {
438 /// An unpredictable series of bytes, typically containing information about the derivation of
441 /// [`payer_id`]: Self::payer_id
442 pub fn metadata(&self) -> &[u8] {
443 self.contents.metadata()
446 /// A chain from [`Offer::chains`] that the offer is valid for.
447 pub fn chain(&self) -> ChainHash {
448 self.contents.chain()
451 /// The amount to pay in msats (i.e., the minimum lightning-payable unit for [`chain`]), which
452 /// must be greater than or equal to [`Offer::amount`], converted if necessary.
454 /// [`chain`]: Self::chain
455 pub fn amount_msats(&self) -> Option<u64> {
456 self.contents.inner.amount_msats
459 /// Features pertaining to requesting an invoice.
460 pub fn features(&self) -> &InvoiceRequestFeatures {
461 &self.contents.inner.features
464 /// The quantity of the offer's item conforming to [`Offer::is_valid_quantity`].
465 pub fn quantity(&self) -> Option<u64> {
466 self.contents.inner.quantity
469 /// A possibly transient pubkey used to sign the invoice request.
470 pub fn payer_id(&self) -> PublicKey {
471 self.contents.payer_id
474 /// A payer-provided note which will be seen by the recipient and reflected back in the invoice
476 pub fn payer_note(&self) -> Option<PrintableString> {
477 self.contents.inner.payer_note.as_ref()
478 .map(|payer_note| PrintableString(payer_note.as_str()))
481 /// Signature of the invoice request using [`payer_id`].
483 /// [`payer_id`]: Self::payer_id
484 pub fn signature(&self) -> Signature {
488 /// Creates an [`InvoiceBuilder`] for the request with the given required fields and using the
489 /// [`Duration`] since [`std::time::SystemTime::UNIX_EPOCH`] as the creation time.
491 /// See [`InvoiceRequest::respond_with_no_std`] for further details where the aforementioned
492 /// creation time is used for the `created_at` parameter.
494 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
496 /// [`Duration`]: core::time::Duration
497 #[cfg(feature = "std")]
499 &self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash
500 ) -> Result<InvoiceBuilder<ExplicitSigningPubkey>, Bolt12SemanticError> {
501 let created_at = std::time::SystemTime::now()
502 .duration_since(std::time::SystemTime::UNIX_EPOCH)
503 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
505 self.respond_with_no_std(payment_paths, payment_hash, created_at)
508 /// Creates an [`InvoiceBuilder`] for the request with the given required fields.
510 /// Unless [`InvoiceBuilder::relative_expiry`] is set, the invoice will expire two hours after
511 /// `created_at`, which is used to set [`Bolt12Invoice::created_at`]. Useful for `no-std` builds
512 /// where [`std::time::SystemTime`] is not available.
514 /// The caller is expected to remember the preimage of `payment_hash` in order to claim a payment
517 /// The `payment_paths` parameter is useful for maintaining the payment recipient's privacy. It
518 /// must contain one or more elements ordered from most-preferred to least-preferred, if there's
519 /// a preference. Note, however, that any privacy is lost if a public node id was used for
520 /// [`Offer::signing_pubkey`].
522 /// Errors if the request contains unknown required features.
524 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
526 /// [`Bolt12Invoice::created_at`]: crate::offers::invoice::Bolt12Invoice::created_at
527 pub fn respond_with_no_std(
528 &self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
529 created_at: core::time::Duration
530 ) -> Result<InvoiceBuilder<ExplicitSigningPubkey>, Bolt12SemanticError> {
531 if self.features().requires_unknown_bits() {
532 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
535 InvoiceBuilder::for_offer(self, payment_paths, created_at, payment_hash)
538 /// Creates an [`InvoiceBuilder`] for the request using the given required fields and that uses
539 /// derived signing keys from the originating [`Offer`] to sign the [`Bolt12Invoice`]. Must use
540 /// the same [`ExpandedKey`] as the one used to create the offer.
542 /// See [`InvoiceRequest::respond_with`] for further details.
544 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
546 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
547 #[cfg(feature = "std")]
548 pub fn verify_and_respond_using_derived_keys<T: secp256k1::Signing>(
549 &self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
550 expanded_key: &ExpandedKey, secp_ctx: &Secp256k1<T>
551 ) -> Result<InvoiceBuilder<DerivedSigningPubkey>, Bolt12SemanticError> {
552 let created_at = std::time::SystemTime::now()
553 .duration_since(std::time::SystemTime::UNIX_EPOCH)
554 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
556 self.verify_and_respond_using_derived_keys_no_std(
557 payment_paths, payment_hash, created_at, expanded_key, secp_ctx
561 /// Creates an [`InvoiceBuilder`] for the request using the given required fields and that uses
562 /// derived signing keys from the originating [`Offer`] to sign the [`Bolt12Invoice`]. Must use
563 /// the same [`ExpandedKey`] as the one used to create the offer.
565 /// See [`InvoiceRequest::respond_with_no_std`] for further details.
567 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
569 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
570 pub fn verify_and_respond_using_derived_keys_no_std<T: secp256k1::Signing>(
571 &self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
572 created_at: core::time::Duration, expanded_key: &ExpandedKey, secp_ctx: &Secp256k1<T>
573 ) -> Result<InvoiceBuilder<DerivedSigningPubkey>, Bolt12SemanticError> {
574 if self.features().requires_unknown_bits() {
575 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
578 let keys = match self.verify(expanded_key, secp_ctx) {
579 Err(()) => return Err(Bolt12SemanticError::InvalidMetadata),
580 Ok(None) => return Err(Bolt12SemanticError::InvalidMetadata),
581 Ok(Some(keys)) => keys,
584 InvoiceBuilder::for_offer_using_keys(self, payment_paths, created_at, payment_hash, keys)
587 /// Verifies that the request was for an offer created using the given key. Returns the derived
588 /// keys need to sign an [`Bolt12Invoice`] for the request if they could be extracted from the
591 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
592 pub fn verify<T: secp256k1::Signing>(
593 &self, key: &ExpandedKey, secp_ctx: &Secp256k1<T>
594 ) -> Result<Option<KeyPair>, ()> {
595 self.contents.inner.offer.verify(&self.bytes, key, secp_ctx)
599 fn as_tlv_stream(&self) -> FullInvoiceRequestTlvStreamRef {
600 let (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream) =
601 self.contents.as_tlv_stream();
602 let signature_tlv_stream = SignatureTlvStreamRef {
603 signature: Some(&self.signature),
605 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, signature_tlv_stream)
609 impl InvoiceRequestContents {
610 pub(super) fn metadata(&self) -> &[u8] {
611 self.inner.metadata()
614 pub(super) fn derives_keys(&self) -> bool {
615 self.inner.payer.0.derives_keys()
618 pub(super) fn chain(&self) -> ChainHash {
622 pub(super) fn payer_id(&self) -> PublicKey {
626 pub(super) fn as_tlv_stream(&self) -> PartialInvoiceRequestTlvStreamRef {
627 let (payer, offer, mut invoice_request) = self.inner.as_tlv_stream();
628 invoice_request.payer_id = Some(&self.payer_id);
629 (payer, offer, invoice_request)
633 impl InvoiceRequestContentsWithoutPayerId {
634 pub(super) fn metadata(&self) -> &[u8] {
635 self.payer.0.as_bytes().map(|bytes| bytes.as_slice()).unwrap_or(&[])
638 pub(super) fn chain(&self) -> ChainHash {
639 self.chain.unwrap_or_else(|| self.offer.implied_chain())
642 pub(super) fn as_tlv_stream(&self) -> PartialInvoiceRequestTlvStreamRef {
643 let payer = PayerTlvStreamRef {
644 metadata: self.payer.0.as_bytes(),
647 let offer = self.offer.as_tlv_stream();
650 if self.features == InvoiceRequestFeatures::empty() { None }
651 else { Some(&self.features) }
654 let invoice_request = InvoiceRequestTlvStreamRef {
655 chain: self.chain.as_ref(),
656 amount: self.amount_msats,
658 quantity: self.quantity,
660 payer_note: self.payer_note.as_ref(),
663 (payer, offer, invoice_request)
667 impl Writeable for InvoiceRequest {
668 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
669 WithoutLength(&self.bytes).write(writer)
673 impl Writeable for InvoiceRequestContents {
674 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
675 self.as_tlv_stream().write(writer)
679 /// Valid type range for invoice_request TLV records.
680 pub(super) const INVOICE_REQUEST_TYPES: core::ops::Range<u64> = 80..160;
682 /// TLV record type for [`InvoiceRequest::payer_id`] and [`Refund::payer_id`].
684 /// [`Refund::payer_id`]: crate::offers::refund::Refund::payer_id
685 pub(super) const INVOICE_REQUEST_PAYER_ID_TYPE: u64 = 88;
687 tlv_stream!(InvoiceRequestTlvStream, InvoiceRequestTlvStreamRef, INVOICE_REQUEST_TYPES, {
688 (80, chain: ChainHash),
689 (82, amount: (u64, HighZeroBytesDroppedBigSize)),
690 (84, features: (InvoiceRequestFeatures, WithoutLength)),
691 (86, quantity: (u64, HighZeroBytesDroppedBigSize)),
692 (INVOICE_REQUEST_PAYER_ID_TYPE, payer_id: PublicKey),
693 (89, payer_note: (String, WithoutLength)),
696 type FullInvoiceRequestTlvStream =
697 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, SignatureTlvStream);
700 type FullInvoiceRequestTlvStreamRef<'a> = (
701 PayerTlvStreamRef<'a>,
702 OfferTlvStreamRef<'a>,
703 InvoiceRequestTlvStreamRef<'a>,
704 SignatureTlvStreamRef<'a>,
707 impl SeekReadable for FullInvoiceRequestTlvStream {
708 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
709 let payer = SeekReadable::read(r)?;
710 let offer = SeekReadable::read(r)?;
711 let invoice_request = SeekReadable::read(r)?;
712 let signature = SeekReadable::read(r)?;
714 Ok((payer, offer, invoice_request, signature))
718 type PartialInvoiceRequestTlvStream = (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream);
720 type PartialInvoiceRequestTlvStreamRef<'a> = (
721 PayerTlvStreamRef<'a>,
722 OfferTlvStreamRef<'a>,
723 InvoiceRequestTlvStreamRef<'a>,
726 impl TryFrom<Vec<u8>> for InvoiceRequest {
727 type Error = Bolt12ParseError;
729 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
730 let invoice_request = ParsedMessage::<FullInvoiceRequestTlvStream>::try_from(bytes)?;
731 let ParsedMessage { bytes, tlv_stream } = invoice_request;
733 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream,
734 SignatureTlvStream { signature },
736 let contents = InvoiceRequestContents::try_from(
737 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
740 let signature = match signature {
741 None => return Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
742 Some(signature) => signature,
744 merkle::verify_signature(&signature, SIGNATURE_TAG, &bytes, contents.payer_id)?;
746 Ok(InvoiceRequest { bytes, contents, signature })
750 impl TryFrom<PartialInvoiceRequestTlvStream> for InvoiceRequestContents {
751 type Error = Bolt12SemanticError;
753 fn try_from(tlv_stream: PartialInvoiceRequestTlvStream) -> Result<Self, Self::Error> {
755 PayerTlvStream { metadata },
757 InvoiceRequestTlvStream { chain, amount, features, quantity, payer_id, payer_note },
760 let payer = match metadata {
761 None => return Err(Bolt12SemanticError::MissingPayerMetadata),
762 Some(metadata) => PayerContents(Metadata::Bytes(metadata)),
764 let offer = OfferContents::try_from(offer_tlv_stream)?;
766 if !offer.supports_chain(chain.unwrap_or_else(|| offer.implied_chain())) {
767 return Err(Bolt12SemanticError::UnsupportedChain);
770 if offer.amount().is_none() && amount.is_none() {
771 return Err(Bolt12SemanticError::MissingAmount);
774 offer.check_quantity(quantity)?;
775 offer.check_amount_msats_for_quantity(amount, quantity)?;
777 let features = features.unwrap_or_else(InvoiceRequestFeatures::empty);
779 let payer_id = match payer_id {
780 None => return Err(Bolt12SemanticError::MissingPayerId),
781 Some(payer_id) => payer_id,
784 Ok(InvoiceRequestContents {
785 inner: InvoiceRequestContentsWithoutPayerId {
786 payer, offer, chain, amount_msats: amount, features, quantity, payer_note,
795 use super::{InvoiceRequest, InvoiceRequestTlvStreamRef, SIGNATURE_TAG};
797 use bitcoin::blockdata::constants::ChainHash;
798 use bitcoin::network::constants::Network;
799 use bitcoin::secp256k1::{KeyPair, Secp256k1, SecretKey, self};
800 use core::convert::{Infallible, TryFrom};
801 use core::num::NonZeroU64;
802 #[cfg(feature = "std")]
803 use core::time::Duration;
804 use crate::sign::KeyMaterial;
805 use crate::ln::features::InvoiceRequestFeatures;
806 use crate::ln::inbound_payment::ExpandedKey;
807 use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
808 use crate::offers::invoice::{Bolt12Invoice, SIGNATURE_TAG as INVOICE_SIGNATURE_TAG};
809 use crate::offers::merkle::{SignError, SignatureTlvStreamRef, TaggedHash, self};
810 use crate::offers::offer::{Amount, OfferBuilder, OfferTlvStreamRef, Quantity};
811 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
812 use crate::offers::payer::PayerTlvStreamRef;
813 use crate::offers::test_utils::*;
814 use crate::util::ser::{BigSize, Writeable};
815 use crate::util::string::PrintableString;
818 fn builds_invoice_request_with_defaults() {
819 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
822 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
824 .sign(payer_sign).unwrap();
826 let mut buffer = Vec::new();
827 invoice_request.write(&mut buffer).unwrap();
829 assert_eq!(invoice_request.bytes, buffer.as_slice());
830 assert_eq!(invoice_request.metadata(), &[1; 32]);
831 assert_eq!(invoice_request.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
832 assert_eq!(invoice_request.amount_msats(), None);
833 assert_eq!(invoice_request.features(), &InvoiceRequestFeatures::empty());
834 assert_eq!(invoice_request.quantity(), None);
835 assert_eq!(invoice_request.payer_id(), payer_pubkey());
836 assert_eq!(invoice_request.payer_note(), None);
838 merkle::verify_signature(
839 &invoice_request.signature, SIGNATURE_TAG, &invoice_request.bytes, payer_pubkey()
844 invoice_request.as_tlv_stream(),
846 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
852 description: Some(&String::from("foo")),
854 absolute_expiry: None,
858 node_id: Some(&recipient_pubkey()),
860 InvoiceRequestTlvStreamRef {
865 payer_id: Some(&payer_pubkey()),
868 SignatureTlvStreamRef { signature: Some(&invoice_request.signature()) },
872 if let Err(e) = InvoiceRequest::try_from(buffer) {
873 panic!("error parsing invoice request: {:?}", e);
877 #[cfg(feature = "std")]
879 fn builds_invoice_request_from_offer_with_expiration() {
880 let future_expiry = Duration::from_secs(u64::max_value());
881 let past_expiry = Duration::from_secs(0);
883 if let Err(e) = OfferBuilder::new("foo".into(), recipient_pubkey())
885 .absolute_expiry(future_expiry)
887 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
890 panic!("error building invoice_request: {:?}", e);
893 match OfferBuilder::new("foo".into(), recipient_pubkey())
895 .absolute_expiry(past_expiry)
897 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
900 Ok(_) => panic!("expected error"),
901 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
906 fn builds_invoice_request_with_derived_metadata() {
907 let payer_id = payer_pubkey();
908 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
909 let entropy = FixedEntropy {};
910 let secp_ctx = Secp256k1::new();
912 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
915 let invoice_request = offer
916 .request_invoice_deriving_metadata(payer_id, &expanded_key, &entropy)
919 .sign(payer_sign).unwrap();
920 assert_eq!(invoice_request.payer_id(), payer_pubkey());
922 let invoice = invoice_request.respond_with_no_std(payment_paths(), payment_hash(), now())
925 .sign(recipient_sign).unwrap();
926 assert!(invoice.verify(&expanded_key, &secp_ctx));
928 // Fails verification with altered fields
930 payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream,
931 mut invoice_tlv_stream, mut signature_tlv_stream
932 ) = invoice.as_tlv_stream();
933 invoice_request_tlv_stream.amount = Some(2000);
934 invoice_tlv_stream.amount = Some(2000);
937 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
938 let mut bytes = Vec::new();
939 tlv_stream.write(&mut bytes).unwrap();
941 let message = TaggedHash::new(INVOICE_SIGNATURE_TAG, &bytes);
942 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
943 signature_tlv_stream.signature = Some(&signature);
945 let mut encoded_invoice = bytes;
946 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
948 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
949 assert!(!invoice.verify(&expanded_key, &secp_ctx));
951 // Fails verification with altered metadata
953 mut payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
954 mut signature_tlv_stream
955 ) = invoice.as_tlv_stream();
956 let metadata = payer_tlv_stream.metadata.unwrap().iter().copied().rev().collect();
957 payer_tlv_stream.metadata = Some(&metadata);
960 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
961 let mut bytes = Vec::new();
962 tlv_stream.write(&mut bytes).unwrap();
964 let message = TaggedHash::new(INVOICE_SIGNATURE_TAG, &bytes);
965 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
966 signature_tlv_stream.signature = Some(&signature);
968 let mut encoded_invoice = bytes;
969 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
971 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
972 assert!(!invoice.verify(&expanded_key, &secp_ctx));
976 fn builds_invoice_request_with_derived_payer_id() {
977 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
978 let entropy = FixedEntropy {};
979 let secp_ctx = Secp256k1::new();
981 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
984 let invoice_request = offer
985 .request_invoice_deriving_payer_id(&expanded_key, &entropy, &secp_ctx)
990 let invoice = invoice_request.respond_with_no_std(payment_paths(), payment_hash(), now())
993 .sign(recipient_sign).unwrap();
994 assert!(invoice.verify(&expanded_key, &secp_ctx));
996 // Fails verification with altered fields
998 payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream,
999 mut invoice_tlv_stream, mut signature_tlv_stream
1000 ) = invoice.as_tlv_stream();
1001 invoice_request_tlv_stream.amount = Some(2000);
1002 invoice_tlv_stream.amount = Some(2000);
1005 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1006 let mut bytes = Vec::new();
1007 tlv_stream.write(&mut bytes).unwrap();
1009 let message = TaggedHash::new(INVOICE_SIGNATURE_TAG, &bytes);
1010 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1011 signature_tlv_stream.signature = Some(&signature);
1013 let mut encoded_invoice = bytes;
1014 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1016 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1017 assert!(!invoice.verify(&expanded_key, &secp_ctx));
1019 // Fails verification with altered payer id
1021 payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream, invoice_tlv_stream,
1022 mut signature_tlv_stream
1023 ) = invoice.as_tlv_stream();
1024 let payer_id = pubkey(1);
1025 invoice_request_tlv_stream.payer_id = Some(&payer_id);
1028 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1029 let mut bytes = Vec::new();
1030 tlv_stream.write(&mut bytes).unwrap();
1032 let message = TaggedHash::new(INVOICE_SIGNATURE_TAG, &bytes);
1033 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1034 signature_tlv_stream.signature = Some(&signature);
1036 let mut encoded_invoice = bytes;
1037 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1039 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1040 assert!(!invoice.verify(&expanded_key, &secp_ctx));
1044 fn builds_invoice_request_with_chain() {
1045 let mainnet = ChainHash::using_genesis_block(Network::Bitcoin);
1046 let testnet = ChainHash::using_genesis_block(Network::Testnet);
1048 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1051 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1052 .chain(Network::Bitcoin).unwrap()
1054 .sign(payer_sign).unwrap();
1055 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1056 assert_eq!(invoice_request.chain(), mainnet);
1057 assert_eq!(tlv_stream.chain, None);
1059 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1061 .chain(Network::Testnet)
1063 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1064 .chain(Network::Testnet).unwrap()
1066 .sign(payer_sign).unwrap();
1067 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1068 assert_eq!(invoice_request.chain(), testnet);
1069 assert_eq!(tlv_stream.chain, Some(&testnet));
1071 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1073 .chain(Network::Bitcoin)
1074 .chain(Network::Testnet)
1076 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1077 .chain(Network::Bitcoin).unwrap()
1079 .sign(payer_sign).unwrap();
1080 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1081 assert_eq!(invoice_request.chain(), mainnet);
1082 assert_eq!(tlv_stream.chain, None);
1084 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1086 .chain(Network::Bitcoin)
1087 .chain(Network::Testnet)
1089 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1090 .chain(Network::Bitcoin).unwrap()
1091 .chain(Network::Testnet).unwrap()
1093 .sign(payer_sign).unwrap();
1094 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1095 assert_eq!(invoice_request.chain(), testnet);
1096 assert_eq!(tlv_stream.chain, Some(&testnet));
1098 match OfferBuilder::new("foo".into(), recipient_pubkey())
1100 .chain(Network::Testnet)
1102 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1103 .chain(Network::Bitcoin)
1105 Ok(_) => panic!("expected error"),
1106 Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
1109 match OfferBuilder::new("foo".into(), recipient_pubkey())
1111 .chain(Network::Testnet)
1113 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1116 Ok(_) => panic!("expected error"),
1117 Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
1122 fn builds_invoice_request_with_amount() {
1123 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1126 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1127 .amount_msats(1000).unwrap()
1129 .sign(payer_sign).unwrap();
1130 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1131 assert_eq!(invoice_request.amount_msats(), Some(1000));
1132 assert_eq!(tlv_stream.amount, Some(1000));
1134 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1137 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1138 .amount_msats(1001).unwrap()
1139 .amount_msats(1000).unwrap()
1141 .sign(payer_sign).unwrap();
1142 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1143 assert_eq!(invoice_request.amount_msats(), Some(1000));
1144 assert_eq!(tlv_stream.amount, Some(1000));
1146 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1149 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1150 .amount_msats(1001).unwrap()
1152 .sign(payer_sign).unwrap();
1153 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1154 assert_eq!(invoice_request.amount_msats(), Some(1001));
1155 assert_eq!(tlv_stream.amount, Some(1001));
1157 match OfferBuilder::new("foo".into(), recipient_pubkey())
1160 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1163 Ok(_) => panic!("expected error"),
1164 Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1167 match OfferBuilder::new("foo".into(), recipient_pubkey())
1169 .supported_quantity(Quantity::Unbounded)
1171 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1172 .quantity(2).unwrap()
1175 Ok(_) => panic!("expected error"),
1176 Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1179 match OfferBuilder::new("foo".into(), recipient_pubkey())
1182 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1183 .amount_msats(MAX_VALUE_MSAT + 1)
1185 Ok(_) => panic!("expected error"),
1186 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1189 match OfferBuilder::new("foo".into(), recipient_pubkey())
1191 .supported_quantity(Quantity::Unbounded)
1193 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1194 .amount_msats(1000).unwrap()
1195 .quantity(2).unwrap()
1198 Ok(_) => panic!("expected error"),
1199 Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1202 match OfferBuilder::new("foo".into(), recipient_pubkey())
1204 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1207 Ok(_) => panic!("expected error"),
1208 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingAmount),
1211 match OfferBuilder::new("foo".into(), recipient_pubkey())
1213 .supported_quantity(Quantity::Unbounded)
1215 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1216 .quantity(u64::max_value()).unwrap()
1219 Ok(_) => panic!("expected error"),
1220 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1225 fn builds_invoice_request_with_features() {
1226 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1229 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1230 .features_unchecked(InvoiceRequestFeatures::unknown())
1232 .sign(payer_sign).unwrap();
1233 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1234 assert_eq!(invoice_request.features(), &InvoiceRequestFeatures::unknown());
1235 assert_eq!(tlv_stream.features, Some(&InvoiceRequestFeatures::unknown()));
1237 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1240 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1241 .features_unchecked(InvoiceRequestFeatures::unknown())
1242 .features_unchecked(InvoiceRequestFeatures::empty())
1244 .sign(payer_sign).unwrap();
1245 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1246 assert_eq!(invoice_request.features(), &InvoiceRequestFeatures::empty());
1247 assert_eq!(tlv_stream.features, None);
1251 fn builds_invoice_request_with_quantity() {
1252 let one = NonZeroU64::new(1).unwrap();
1253 let ten = NonZeroU64::new(10).unwrap();
1255 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1257 .supported_quantity(Quantity::One)
1259 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1261 .sign(payer_sign).unwrap();
1262 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1263 assert_eq!(invoice_request.quantity(), None);
1264 assert_eq!(tlv_stream.quantity, None);
1266 match OfferBuilder::new("foo".into(), recipient_pubkey())
1268 .supported_quantity(Quantity::One)
1270 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1271 .amount_msats(2_000).unwrap()
1274 Ok(_) => panic!("expected error"),
1275 Err(e) => assert_eq!(e, Bolt12SemanticError::UnexpectedQuantity),
1278 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1280 .supported_quantity(Quantity::Bounded(ten))
1282 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1283 .amount_msats(10_000).unwrap()
1284 .quantity(10).unwrap()
1286 .sign(payer_sign).unwrap();
1287 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1288 assert_eq!(invoice_request.amount_msats(), Some(10_000));
1289 assert_eq!(tlv_stream.amount, Some(10_000));
1291 match OfferBuilder::new("foo".into(), recipient_pubkey())
1293 .supported_quantity(Quantity::Bounded(ten))
1295 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1296 .amount_msats(11_000).unwrap()
1299 Ok(_) => panic!("expected error"),
1300 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidQuantity),
1303 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1305 .supported_quantity(Quantity::Unbounded)
1307 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1308 .amount_msats(2_000).unwrap()
1309 .quantity(2).unwrap()
1311 .sign(payer_sign).unwrap();
1312 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1313 assert_eq!(invoice_request.amount_msats(), Some(2_000));
1314 assert_eq!(tlv_stream.amount, Some(2_000));
1316 match OfferBuilder::new("foo".into(), recipient_pubkey())
1318 .supported_quantity(Quantity::Unbounded)
1320 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1323 Ok(_) => panic!("expected error"),
1324 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingQuantity),
1327 match OfferBuilder::new("foo".into(), recipient_pubkey())
1329 .supported_quantity(Quantity::Bounded(one))
1331 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1334 Ok(_) => panic!("expected error"),
1335 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingQuantity),
1340 fn builds_invoice_request_with_payer_note() {
1341 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1344 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1345 .payer_note("bar".into())
1347 .sign(payer_sign).unwrap();
1348 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1349 assert_eq!(invoice_request.payer_note(), Some(PrintableString("bar")));
1350 assert_eq!(tlv_stream.payer_note, Some(&String::from("bar")));
1352 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1355 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1356 .payer_note("bar".into())
1357 .payer_note("baz".into())
1359 .sign(payer_sign).unwrap();
1360 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1361 assert_eq!(invoice_request.payer_note(), Some(PrintableString("baz")));
1362 assert_eq!(tlv_stream.payer_note, Some(&String::from("baz")));
1366 fn fails_signing_invoice_request() {
1367 match OfferBuilder::new("foo".into(), recipient_pubkey())
1370 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1374 Ok(_) => panic!("expected error"),
1375 Err(e) => assert_eq!(e, SignError::Signing(())),
1378 match OfferBuilder::new("foo".into(), recipient_pubkey())
1381 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1383 .sign(recipient_sign)
1385 Ok(_) => panic!("expected error"),
1386 Err(e) => assert_eq!(e, SignError::Verification(secp256k1::Error::InvalidSignature)),
1391 fn fails_responding_with_unknown_required_features() {
1392 match OfferBuilder::new("foo".into(), recipient_pubkey())
1395 .request_invoice(vec![42; 32], payer_pubkey()).unwrap()
1396 .features_unchecked(InvoiceRequestFeatures::unknown())
1398 .sign(payer_sign).unwrap()
1399 .respond_with_no_std(payment_paths(), payment_hash(), now())
1401 Ok(_) => panic!("expected error"),
1402 Err(e) => assert_eq!(e, Bolt12SemanticError::UnknownRequiredFeatures),
1407 fn parses_invoice_request_with_metadata() {
1408 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1411 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1413 .sign(payer_sign).unwrap();
1415 let mut buffer = Vec::new();
1416 invoice_request.write(&mut buffer).unwrap();
1418 if let Err(e) = InvoiceRequest::try_from(buffer) {
1419 panic!("error parsing invoice_request: {:?}", e);
1424 fn parses_invoice_request_with_chain() {
1425 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1428 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1429 .chain(Network::Bitcoin).unwrap()
1431 .sign(payer_sign).unwrap();
1433 let mut buffer = Vec::new();
1434 invoice_request.write(&mut buffer).unwrap();
1436 if let Err(e) = InvoiceRequest::try_from(buffer) {
1437 panic!("error parsing invoice_request: {:?}", e);
1440 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1443 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1444 .chain_unchecked(Network::Testnet)
1446 .sign(payer_sign).unwrap();
1448 let mut buffer = Vec::new();
1449 invoice_request.write(&mut buffer).unwrap();
1451 match InvoiceRequest::try_from(buffer) {
1452 Ok(_) => panic!("expected error"),
1453 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnsupportedChain)),
1458 fn parses_invoice_request_with_amount() {
1459 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1462 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1464 .sign(payer_sign).unwrap();
1466 let mut buffer = Vec::new();
1467 invoice_request.write(&mut buffer).unwrap();
1469 if let Err(e) = InvoiceRequest::try_from(buffer) {
1470 panic!("error parsing invoice_request: {:?}", e);
1473 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1475 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1476 .amount_msats(1000).unwrap()
1478 .sign(payer_sign).unwrap();
1480 let mut buffer = Vec::new();
1481 invoice_request.write(&mut buffer).unwrap();
1483 if let Err(e) = InvoiceRequest::try_from(buffer) {
1484 panic!("error parsing invoice_request: {:?}", e);
1487 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1489 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1491 .sign(payer_sign).unwrap();
1493 let mut buffer = Vec::new();
1494 invoice_request.write(&mut buffer).unwrap();
1496 match InvoiceRequest::try_from(buffer) {
1497 Ok(_) => panic!("expected error"),
1498 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount)),
1501 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1504 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1505 .amount_msats_unchecked(999)
1507 .sign(payer_sign).unwrap();
1509 let mut buffer = Vec::new();
1510 invoice_request.write(&mut buffer).unwrap();
1512 match InvoiceRequest::try_from(buffer) {
1513 Ok(_) => panic!("expected error"),
1514 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InsufficientAmount)),
1517 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1518 .amount(Amount::Currency { iso4217_code: *b"USD", amount: 1000 })
1520 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1522 .sign(payer_sign).unwrap();
1524 let mut buffer = Vec::new();
1525 invoice_request.write(&mut buffer).unwrap();
1527 match InvoiceRequest::try_from(buffer) {
1528 Ok(_) => panic!("expected error"),
1530 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnsupportedCurrency));
1534 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1536 .supported_quantity(Quantity::Unbounded)
1538 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1539 .quantity(u64::max_value()).unwrap()
1541 .sign(payer_sign).unwrap();
1543 let mut buffer = Vec::new();
1544 invoice_request.write(&mut buffer).unwrap();
1546 match InvoiceRequest::try_from(buffer) {
1547 Ok(_) => panic!("expected error"),
1548 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidAmount)),
1553 fn parses_invoice_request_with_quantity() {
1554 let one = NonZeroU64::new(1).unwrap();
1555 let ten = NonZeroU64::new(10).unwrap();
1557 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1559 .supported_quantity(Quantity::One)
1561 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1563 .sign(payer_sign).unwrap();
1565 let mut buffer = Vec::new();
1566 invoice_request.write(&mut buffer).unwrap();
1568 if let Err(e) = InvoiceRequest::try_from(buffer) {
1569 panic!("error parsing invoice_request: {:?}", e);
1572 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1574 .supported_quantity(Quantity::One)
1576 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1577 .amount_msats(2_000).unwrap()
1578 .quantity_unchecked(2)
1580 .sign(payer_sign).unwrap();
1582 let mut buffer = Vec::new();
1583 invoice_request.write(&mut buffer).unwrap();
1585 match InvoiceRequest::try_from(buffer) {
1586 Ok(_) => panic!("expected error"),
1588 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnexpectedQuantity));
1592 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1594 .supported_quantity(Quantity::Bounded(ten))
1596 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1597 .amount_msats(10_000).unwrap()
1598 .quantity(10).unwrap()
1600 .sign(payer_sign).unwrap();
1602 let mut buffer = Vec::new();
1603 invoice_request.write(&mut buffer).unwrap();
1605 if let Err(e) = InvoiceRequest::try_from(buffer) {
1606 panic!("error parsing invoice_request: {:?}", e);
1609 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1611 .supported_quantity(Quantity::Bounded(ten))
1613 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1614 .amount_msats(11_000).unwrap()
1615 .quantity_unchecked(11)
1617 .sign(payer_sign).unwrap();
1619 let mut buffer = Vec::new();
1620 invoice_request.write(&mut buffer).unwrap();
1622 match InvoiceRequest::try_from(buffer) {
1623 Ok(_) => panic!("expected error"),
1624 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidQuantity)),
1627 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1629 .supported_quantity(Quantity::Unbounded)
1631 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1632 .amount_msats(2_000).unwrap()
1633 .quantity(2).unwrap()
1635 .sign(payer_sign).unwrap();
1637 let mut buffer = Vec::new();
1638 invoice_request.write(&mut buffer).unwrap();
1640 if let Err(e) = InvoiceRequest::try_from(buffer) {
1641 panic!("error parsing invoice_request: {:?}", e);
1644 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1646 .supported_quantity(Quantity::Unbounded)
1648 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1650 .sign(payer_sign).unwrap();
1652 let mut buffer = Vec::new();
1653 invoice_request.write(&mut buffer).unwrap();
1655 match InvoiceRequest::try_from(buffer) {
1656 Ok(_) => panic!("expected error"),
1657 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingQuantity)),
1660 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1662 .supported_quantity(Quantity::Bounded(one))
1664 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1666 .sign(payer_sign).unwrap();
1668 let mut buffer = Vec::new();
1669 invoice_request.write(&mut buffer).unwrap();
1671 match InvoiceRequest::try_from(buffer) {
1672 Ok(_) => panic!("expected error"),
1673 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingQuantity)),
1678 fn fails_parsing_invoice_request_without_metadata() {
1679 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
1682 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1684 let mut tlv_stream = unsigned_invoice_request.invoice_request.as_tlv_stream();
1685 tlv_stream.0.metadata = None;
1687 let mut buffer = Vec::new();
1688 tlv_stream.write(&mut buffer).unwrap();
1690 match InvoiceRequest::try_from(buffer) {
1691 Ok(_) => panic!("expected error"),
1693 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerMetadata));
1699 fn fails_parsing_invoice_request_without_payer_id() {
1700 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
1703 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1705 let mut tlv_stream = unsigned_invoice_request.invoice_request.as_tlv_stream();
1706 tlv_stream.2.payer_id = None;
1708 let mut buffer = Vec::new();
1709 tlv_stream.write(&mut buffer).unwrap();
1711 match InvoiceRequest::try_from(buffer) {
1712 Ok(_) => panic!("expected error"),
1713 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerId)),
1718 fn fails_parsing_invoice_request_without_node_id() {
1719 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
1722 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1724 let mut tlv_stream = unsigned_invoice_request.invoice_request.as_tlv_stream();
1725 tlv_stream.1.node_id = None;
1727 let mut buffer = Vec::new();
1728 tlv_stream.write(&mut buffer).unwrap();
1730 match InvoiceRequest::try_from(buffer) {
1731 Ok(_) => panic!("expected error"),
1733 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey));
1739 fn fails_parsing_invoice_request_without_signature() {
1740 let mut buffer = Vec::new();
1741 OfferBuilder::new("foo".into(), recipient_pubkey())
1744 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1747 .write(&mut buffer).unwrap();
1749 match InvoiceRequest::try_from(buffer) {
1750 Ok(_) => panic!("expected error"),
1751 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
1756 fn fails_parsing_invoice_request_with_invalid_signature() {
1757 let mut invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1760 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1762 .sign(payer_sign).unwrap();
1763 let last_signature_byte = invoice_request.bytes.last_mut().unwrap();
1764 *last_signature_byte = last_signature_byte.wrapping_add(1);
1766 let mut buffer = Vec::new();
1767 invoice_request.write(&mut buffer).unwrap();
1769 match InvoiceRequest::try_from(buffer) {
1770 Ok(_) => panic!("expected error"),
1772 assert_eq!(e, Bolt12ParseError::InvalidSignature(secp256k1::Error::InvalidSignature));
1778 fn fails_parsing_invoice_request_with_extra_tlv_records() {
1779 let secp_ctx = Secp256k1::new();
1780 let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
1781 let invoice_request = OfferBuilder::new("foo".into(), keys.public_key())
1784 .request_invoice(vec![1; 32], keys.public_key()).unwrap()
1786 .sign::<_, Infallible>(
1787 |message| Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
1791 let mut encoded_invoice_request = Vec::new();
1792 invoice_request.write(&mut encoded_invoice_request).unwrap();
1793 BigSize(1002).write(&mut encoded_invoice_request).unwrap();
1794 BigSize(32).write(&mut encoded_invoice_request).unwrap();
1795 [42u8; 32].write(&mut encoded_invoice_request).unwrap();
1797 match InvoiceRequest::try_from(encoded_invoice_request) {
1798 Ok(_) => panic!("expected error"),
1799 Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),