1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Data structures and encoding for `invoice_request` messages.
12 //! An [`InvoiceRequest`] can be built from a parsed [`Offer`] as an "offer to be paid". It is
13 //! typically constructed by a customer and sent to the merchant who had published the corresponding
14 //! offer. The recipient of the request responds with a [`Bolt12Invoice`].
16 //! For an "offer for money" (e.g., refund, ATM withdrawal), where an offer doesn't exist as a
17 //! precursor, see [`Refund`].
19 //! [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
20 //! [`Refund`]: crate::offers::refund::Refund
23 //! extern crate bitcoin;
24 //! extern crate lightning;
26 //! use bitcoin::network::constants::Network;
27 //! use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, SecretKey};
28 //! use lightning::ln::features::OfferFeatures;
29 //! use lightning::offers::invoice_request::UnsignedInvoiceRequest;
30 //! use lightning::offers::offer::Offer;
31 //! use lightning::util::ser::Writeable;
33 //! # fn parse() -> Result<(), lightning::offers::parse::Bolt12ParseError> {
34 //! let secp_ctx = Secp256k1::new();
35 //! let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32])?);
36 //! let pubkey = PublicKey::from(keys);
37 //! let mut buffer = Vec::new();
39 //! # use lightning::offers::invoice_request::{ExplicitPayerId, InvoiceRequestBuilder};
40 //! # <InvoiceRequestBuilder<ExplicitPayerId, _>>::from(
42 //! .parse::<Offer>()?
43 //! .request_invoice(vec![42; 64], pubkey)?
45 //! .chain(Network::Testnet)?
46 //! .amount_msats(1000)?
48 //! .payer_note("foo".to_string())
50 //! .sign(|message: &UnsignedInvoiceRequest|
51 //! Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
53 //! .expect("failed verifying signature")
54 //! .write(&mut buffer)
60 use bitcoin::blockdata::constants::ChainHash;
61 use bitcoin::network::constants::Network;
62 use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, self};
63 use bitcoin::secp256k1::schnorr::Signature;
65 use crate::sign::EntropySource;
67 use crate::blinded_path::BlindedPath;
68 use crate::ln::PaymentHash;
69 use crate::ln::channelmanager::PaymentId;
70 use crate::ln::features::InvoiceRequestFeatures;
71 use crate::ln::inbound_payment::{ExpandedKey, IV_LEN, Nonce};
72 use crate::ln::msgs::DecodeError;
73 use crate::offers::invoice::BlindedPayInfo;
74 use crate::offers::merkle::{SignError, SignFn, SignatureTlvStream, SignatureTlvStreamRef, TaggedHash, self};
75 use crate::offers::offer::{Offer, OfferContents, OfferId, OfferTlvStream, OfferTlvStreamRef};
76 use crate::offers::parse::{Bolt12ParseError, ParsedMessage, Bolt12SemanticError};
77 use crate::offers::payer::{PayerContents, PayerTlvStream, PayerTlvStreamRef};
78 use crate::offers::signer::{Metadata, MetadataMaterial};
79 use crate::util::ser::{HighZeroBytesDroppedBigSize, Readable, SeekReadable, WithoutLength, Writeable, Writer};
80 use crate::util::string::{PrintableString, UntrustedString};
82 #[cfg(not(c_bindings))]
84 crate::offers::invoice::{DerivedSigningPubkey, ExplicitSigningPubkey, InvoiceBuilder},
88 crate::offers::invoice::{InvoiceWithDerivedSigningPubkeyBuilder, InvoiceWithExplicitSigningPubkeyBuilder},
91 #[allow(unused_imports)]
92 use crate::prelude::*;
94 /// Tag for the hash function used when signing an [`InvoiceRequest`]'s merkle root.
95 pub const SIGNATURE_TAG: &'static str = concat!("lightning", "invoice_request", "signature");
97 pub(super) const IV_BYTES: &[u8; IV_LEN] = b"LDK Invreq ~~~~~";
99 /// Builds an [`InvoiceRequest`] from an [`Offer`] for the "offer to be paid" flow.
101 /// See [module-level documentation] for usage.
103 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
105 /// [module-level documentation]: self
106 pub struct InvoiceRequestBuilder<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> {
108 invoice_request: InvoiceRequestContentsWithoutPayerId,
109 payer_id: Option<PublicKey>,
110 payer_id_strategy: core::marker::PhantomData<P>,
111 secp_ctx: Option<&'b Secp256k1<T>>,
114 /// Builds an [`InvoiceRequest`] from an [`Offer`] for the "offer to be paid" flow.
116 /// See [module-level documentation] for usage.
118 /// [module-level documentation]: self
120 pub struct InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b> {
122 invoice_request: InvoiceRequestContentsWithoutPayerId,
123 payer_id: Option<PublicKey>,
124 payer_id_strategy: core::marker::PhantomData<ExplicitPayerId>,
125 secp_ctx: Option<&'b Secp256k1<secp256k1::All>>,
128 /// Builds an [`InvoiceRequest`] from an [`Offer`] for the "offer to be paid" flow.
130 /// See [module-level documentation] for usage.
132 /// [module-level documentation]: self
134 pub struct InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b> {
136 invoice_request: InvoiceRequestContentsWithoutPayerId,
137 payer_id: Option<PublicKey>,
138 payer_id_strategy: core::marker::PhantomData<DerivedPayerId>,
139 secp_ctx: Option<&'b Secp256k1<secp256k1::All>>,
142 /// Indicates how [`InvoiceRequest::payer_id`] will be set.
144 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
145 pub trait PayerIdStrategy {}
147 /// [`InvoiceRequest::payer_id`] will be explicitly set.
149 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
150 pub struct ExplicitPayerId {}
152 /// [`InvoiceRequest::payer_id`] will be derived.
154 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
155 pub struct DerivedPayerId {}
157 impl PayerIdStrategy for ExplicitPayerId {}
158 impl PayerIdStrategy for DerivedPayerId {}
160 macro_rules! invoice_request_explicit_payer_id_builder_methods { ($self: ident, $self_type: ty) => {
161 #[cfg_attr(c_bindings, allow(dead_code))]
162 pub(super) fn new(offer: &'a Offer, metadata: Vec<u8>, payer_id: PublicKey) -> Self {
165 invoice_request: Self::create_contents(offer, Metadata::Bytes(metadata)),
166 payer_id: Some(payer_id),
167 payer_id_strategy: core::marker::PhantomData,
172 #[cfg_attr(c_bindings, allow(dead_code))]
173 pub(super) fn deriving_metadata<ES: Deref>(
174 offer: &'a Offer, payer_id: PublicKey, expanded_key: &ExpandedKey, entropy_source: ES,
175 payment_id: PaymentId,
176 ) -> Self where ES::Target: EntropySource {
177 let nonce = Nonce::from_entropy_source(entropy_source);
178 let payment_id = Some(payment_id);
179 let derivation_material = MetadataMaterial::new(nonce, expanded_key, IV_BYTES, payment_id);
180 let metadata = Metadata::Derived(derivation_material);
183 invoice_request: Self::create_contents(offer, metadata),
184 payer_id: Some(payer_id),
185 payer_id_strategy: core::marker::PhantomData,
190 /// Builds an unsigned [`InvoiceRequest`] after checking for valid semantics. It can be signed
191 /// by [`UnsignedInvoiceRequest::sign`].
192 pub fn build($self: $self_type) -> Result<UnsignedInvoiceRequest, Bolt12SemanticError> {
193 let (unsigned_invoice_request, keys, _) = $self.build_with_checks()?;
194 debug_assert!(keys.is_none());
195 Ok(unsigned_invoice_request)
199 macro_rules! invoice_request_derived_payer_id_builder_methods { (
200 $self: ident, $self_type: ty, $secp_context: ty
202 #[cfg_attr(c_bindings, allow(dead_code))]
203 pub(super) fn deriving_payer_id<ES: Deref>(
204 offer: &'a Offer, expanded_key: &ExpandedKey, entropy_source: ES,
205 secp_ctx: &'b Secp256k1<$secp_context>, payment_id: PaymentId
206 ) -> Self where ES::Target: EntropySource {
207 let nonce = Nonce::from_entropy_source(entropy_source);
208 let payment_id = Some(payment_id);
209 let derivation_material = MetadataMaterial::new(nonce, expanded_key, IV_BYTES, payment_id);
210 let metadata = Metadata::DerivedSigningPubkey(derivation_material);
213 invoice_request: Self::create_contents(offer, metadata),
215 payer_id_strategy: core::marker::PhantomData,
216 secp_ctx: Some(secp_ctx),
220 /// Builds a signed [`InvoiceRequest`] after checking for valid semantics.
221 pub fn build_and_sign($self: $self_type) -> Result<InvoiceRequest, Bolt12SemanticError> {
222 let (unsigned_invoice_request, keys, secp_ctx) = $self.build_with_checks()?;
224 let mut unsigned_invoice_request = unsigned_invoice_request;
225 debug_assert!(keys.is_some());
227 let secp_ctx = secp_ctx.unwrap();
228 let keys = keys.unwrap();
229 let invoice_request = unsigned_invoice_request
230 .sign(|message: &UnsignedInvoiceRequest|
231 Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
238 macro_rules! invoice_request_builder_methods { (
239 $self: ident, $self_type: ty, $return_type: ty, $return_value: expr, $secp_context: ty $(, $self_mut: tt)?
241 #[cfg_attr(c_bindings, allow(dead_code))]
242 fn create_contents(offer: &Offer, metadata: Metadata) -> InvoiceRequestContentsWithoutPayerId {
243 let offer = offer.contents.clone();
244 InvoiceRequestContentsWithoutPayerId {
245 payer: PayerContents(metadata), offer, chain: None, amount_msats: None,
246 features: InvoiceRequestFeatures::empty(), quantity: None, payer_note: None,
250 /// Sets the [`InvoiceRequest::chain`] of the given [`Network`] for paying an invoice. If not
251 /// called, [`Network::Bitcoin`] is assumed. Errors if the chain for `network` is not supported
254 /// Successive calls to this method will override the previous setting.
255 pub fn chain($self: $self_type, network: Network) -> Result<$return_type, Bolt12SemanticError> {
256 $self.chain_hash(ChainHash::using_genesis_block(network))
259 /// Sets the [`InvoiceRequest::chain`] for paying an invoice. If not called, the chain hash of
260 /// [`Network::Bitcoin`] is assumed. Errors if the chain for `network` is not supported by the
263 /// Successive calls to this method will override the previous setting.
264 pub(crate) fn chain_hash($($self_mut)* $self: $self_type, chain: ChainHash) -> Result<$return_type, Bolt12SemanticError> {
265 if !$self.offer.supports_chain(chain) {
266 return Err(Bolt12SemanticError::UnsupportedChain);
269 $self.invoice_request.chain = Some(chain);
273 /// Sets the [`InvoiceRequest::amount_msats`] for paying an invoice. Errors if `amount_msats` is
274 /// not at least the expected invoice amount (i.e., [`Offer::amount`] times [`quantity`]).
276 /// Successive calls to this method will override the previous setting.
278 /// [`quantity`]: Self::quantity
279 pub fn amount_msats($($self_mut)* $self: $self_type, amount_msats: u64) -> Result<$return_type, Bolt12SemanticError> {
280 $self.invoice_request.offer.check_amount_msats_for_quantity(
281 Some(amount_msats), $self.invoice_request.quantity
283 $self.invoice_request.amount_msats = Some(amount_msats);
287 /// Sets [`InvoiceRequest::quantity`] of items. If not set, `1` is assumed. Errors if `quantity`
288 /// does not conform to [`Offer::is_valid_quantity`].
290 /// Successive calls to this method will override the previous setting.
291 pub fn quantity($($self_mut)* $self: $self_type, quantity: u64) -> Result<$return_type, Bolt12SemanticError> {
292 $self.invoice_request.offer.check_quantity(Some(quantity))?;
293 $self.invoice_request.quantity = Some(quantity);
297 /// Sets the [`InvoiceRequest::payer_note`].
299 /// Successive calls to this method will override the previous setting.
300 pub fn payer_note($($self_mut)* $self: $self_type, payer_note: String) -> $return_type {
301 $self.invoice_request.payer_note = Some(payer_note);
305 fn build_with_checks($($self_mut)* $self: $self_type) -> Result<
306 (UnsignedInvoiceRequest, Option<KeyPair>, Option<&'b Secp256k1<$secp_context>>),
309 #[cfg(feature = "std")] {
310 if $self.offer.is_expired() {
311 return Err(Bolt12SemanticError::AlreadyExpired);
315 let chain = $self.invoice_request.chain();
316 if !$self.offer.supports_chain(chain) {
317 return Err(Bolt12SemanticError::UnsupportedChain);
320 if chain == $self.offer.implied_chain() {
321 $self.invoice_request.chain = None;
324 if $self.offer.amount().is_none() && $self.invoice_request.amount_msats.is_none() {
325 return Err(Bolt12SemanticError::MissingAmount);
328 $self.invoice_request.offer.check_quantity($self.invoice_request.quantity)?;
329 $self.invoice_request.offer.check_amount_msats_for_quantity(
330 $self.invoice_request.amount_msats, $self.invoice_request.quantity
333 Ok($self.build_without_checks())
336 fn build_without_checks($($self_mut)* $self: $self_type) ->
337 (UnsignedInvoiceRequest, Option<KeyPair>, Option<&'b Secp256k1<$secp_context>>)
339 // Create the metadata for stateless verification of a Bolt12Invoice.
341 let secp_ctx = $self.secp_ctx.clone();
342 if $self.invoice_request.payer.0.has_derivation_material() {
343 let mut metadata = core::mem::take(&mut $self.invoice_request.payer.0);
345 let mut tlv_stream = $self.invoice_request.as_tlv_stream();
346 debug_assert!(tlv_stream.2.payer_id.is_none());
347 tlv_stream.0.metadata = None;
348 if !metadata.derives_payer_keys() {
349 tlv_stream.2.payer_id = $self.payer_id.as_ref();
352 let (derived_metadata, derived_keys) = metadata.derive_from(tlv_stream, $self.secp_ctx);
353 metadata = derived_metadata;
355 if let Some(keys) = keys {
356 debug_assert!($self.payer_id.is_none());
357 $self.payer_id = Some(keys.public_key());
360 $self.invoice_request.payer.0 = metadata;
363 debug_assert!($self.invoice_request.payer.0.as_bytes().is_some());
364 debug_assert!($self.payer_id.is_some());
365 let payer_id = $self.payer_id.unwrap();
367 let invoice_request = InvoiceRequestContents {
368 #[cfg(not(c_bindings))]
369 inner: $self.invoice_request,
371 inner: $self.invoice_request.clone(),
374 let unsigned_invoice_request = UnsignedInvoiceRequest::new($self.offer, invoice_request);
376 (unsigned_invoice_request, keys, secp_ctx)
381 macro_rules! invoice_request_builder_test_methods { (
382 $self: ident, $self_type: ty, $return_type: ty, $return_value: expr $(, $self_mut: tt)?
384 #[cfg_attr(c_bindings, allow(dead_code))]
385 fn chain_unchecked($($self_mut)* $self: $self_type, network: Network) -> $return_type {
386 let chain = ChainHash::using_genesis_block(network);
387 $self.invoice_request.chain = Some(chain);
391 #[cfg_attr(c_bindings, allow(dead_code))]
392 fn amount_msats_unchecked($($self_mut)* $self: $self_type, amount_msats: u64) -> $return_type {
393 $self.invoice_request.amount_msats = Some(amount_msats);
397 #[cfg_attr(c_bindings, allow(dead_code))]
398 fn features_unchecked($($self_mut)* $self: $self_type, features: InvoiceRequestFeatures) -> $return_type {
399 $self.invoice_request.features = features;
403 #[cfg_attr(c_bindings, allow(dead_code))]
404 fn quantity_unchecked($($self_mut)* $self: $self_type, quantity: u64) -> $return_type {
405 $self.invoice_request.quantity = Some(quantity);
409 #[cfg_attr(c_bindings, allow(dead_code))]
410 pub(super) fn build_unchecked($self: $self_type) -> UnsignedInvoiceRequest {
411 $self.build_without_checks().0
415 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, ExplicitPayerId, T> {
416 invoice_request_explicit_payer_id_builder_methods!(self, Self);
419 impl<'a, 'b, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, DerivedPayerId, T> {
420 invoice_request_derived_payer_id_builder_methods!(self, Self, T);
423 impl<'a, 'b, P: PayerIdStrategy, T: secp256k1::Signing> InvoiceRequestBuilder<'a, 'b, P, T> {
424 invoice_request_builder_methods!(self, Self, Self, self, T, mut);
427 invoice_request_builder_test_methods!(self, Self, Self, self, mut);
430 #[cfg(all(c_bindings, not(test)))]
431 impl<'a, 'b> InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b> {
432 invoice_request_explicit_payer_id_builder_methods!(self, &mut Self);
433 invoice_request_builder_methods!(self, &mut Self, (), (), secp256k1::All);
436 #[cfg(all(c_bindings, test))]
437 impl<'a, 'b> InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b> {
438 invoice_request_explicit_payer_id_builder_methods!(self, &mut Self);
439 invoice_request_builder_methods!(self, &mut Self, &mut Self, self, secp256k1::All);
440 invoice_request_builder_test_methods!(self, &mut Self, &mut Self, self);
443 #[cfg(all(c_bindings, not(test)))]
444 impl<'a, 'b> InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b> {
445 invoice_request_derived_payer_id_builder_methods!(self, &mut Self, secp256k1::All);
446 invoice_request_builder_methods!(self, &mut Self, (), (), secp256k1::All);
449 #[cfg(all(c_bindings, test))]
450 impl<'a, 'b> InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b> {
451 invoice_request_derived_payer_id_builder_methods!(self, &mut Self, secp256k1::All);
452 invoice_request_builder_methods!(self, &mut Self, &mut Self, self, secp256k1::All);
453 invoice_request_builder_test_methods!(self, &mut Self, &mut Self, self);
457 impl<'a, 'b> From<InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b>>
458 for InvoiceRequestBuilder<'a, 'b, ExplicitPayerId, secp256k1::All> {
459 fn from(builder: InvoiceRequestWithExplicitPayerIdBuilder<'a, 'b>) -> Self {
460 let InvoiceRequestWithExplicitPayerIdBuilder {
461 offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
465 offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
471 impl<'a, 'b> From<InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b>>
472 for InvoiceRequestBuilder<'a, 'b, DerivedPayerId, secp256k1::All> {
473 fn from(builder: InvoiceRequestWithDerivedPayerIdBuilder<'a, 'b>) -> Self {
474 let InvoiceRequestWithDerivedPayerIdBuilder {
475 offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
479 offer, invoice_request, payer_id, payer_id_strategy, secp_ctx,
484 /// A semantically valid [`InvoiceRequest`] that hasn't been signed.
488 /// This is serialized as a TLV stream, which includes TLV records from the originating message. As
489 /// such, it may include unknown, odd TLV records.
490 pub struct UnsignedInvoiceRequest {
492 contents: InvoiceRequestContents,
493 tagged_hash: TaggedHash,
496 /// A function for signing an [`UnsignedInvoiceRequest`].
497 pub trait SignInvoiceRequestFn {
498 /// Signs a [`TaggedHash`] computed over the merkle root of `message`'s TLV stream.
499 fn sign_invoice_request(&self, message: &UnsignedInvoiceRequest) -> Result<Signature, ()>;
502 impl<F> SignInvoiceRequestFn for F
504 F: Fn(&UnsignedInvoiceRequest) -> Result<Signature, ()>,
506 fn sign_invoice_request(&self, message: &UnsignedInvoiceRequest) -> Result<Signature, ()> {
511 impl<F> SignFn<UnsignedInvoiceRequest> for F
513 F: SignInvoiceRequestFn,
515 fn sign(&self, message: &UnsignedInvoiceRequest) -> Result<Signature, ()> {
516 self.sign_invoice_request(message)
520 impl UnsignedInvoiceRequest {
521 fn new(offer: &Offer, contents: InvoiceRequestContents) -> Self {
522 // Use the offer bytes instead of the offer TLV stream as the offer may have contained
523 // unknown TLV records, which are not stored in `OfferContents`.
524 let (payer_tlv_stream, _offer_tlv_stream, invoice_request_tlv_stream) =
525 contents.as_tlv_stream();
526 let offer_bytes = WithoutLength(&offer.bytes);
527 let unsigned_tlv_stream = (payer_tlv_stream, offer_bytes, invoice_request_tlv_stream);
529 let mut bytes = Vec::new();
530 unsigned_tlv_stream.write(&mut bytes).unwrap();
532 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
534 Self { bytes, contents, tagged_hash }
537 /// Returns the [`TaggedHash`] of the invoice to sign.
538 pub fn tagged_hash(&self) -> &TaggedHash {
543 macro_rules! unsigned_invoice_request_sign_method { (
544 $self: ident, $self_type: ty $(, $self_mut: tt)?
546 /// Signs the [`TaggedHash`] of the invoice request using the given function.
548 /// Note: The hash computation may have included unknown, odd TLV records.
549 pub fn sign<F: SignInvoiceRequestFn>(
550 $($self_mut)* $self: $self_type, sign: F
551 ) -> Result<InvoiceRequest, SignError> {
552 let pubkey = $self.contents.payer_id;
553 let signature = merkle::sign_message(sign, &$self, pubkey)?;
555 // Append the signature TLV record to the bytes.
556 let signature_tlv_stream = SignatureTlvStreamRef {
557 signature: Some(&signature),
559 signature_tlv_stream.write(&mut $self.bytes).unwrap();
562 #[cfg(not(c_bindings))]
565 bytes: $self.bytes.clone(),
566 #[cfg(not(c_bindings))]
567 contents: $self.contents,
569 contents: $self.contents.clone(),
575 #[cfg(not(c_bindings))]
576 impl UnsignedInvoiceRequest {
577 unsigned_invoice_request_sign_method!(self, Self, mut);
581 impl UnsignedInvoiceRequest {
582 unsigned_invoice_request_sign_method!(self, &mut Self);
585 impl AsRef<TaggedHash> for UnsignedInvoiceRequest {
586 fn as_ref(&self) -> &TaggedHash {
591 /// An `InvoiceRequest` is a request for a [`Bolt12Invoice`] formulated from an [`Offer`].
593 /// An offer may provide choices such as quantity, amount, chain, features, etc. An invoice request
594 /// specifies these such that its recipient can send an invoice for payment.
596 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
597 /// [`Offer`]: crate::offers::offer::Offer
598 #[derive(Clone, Debug)]
599 #[cfg_attr(test, derive(PartialEq))]
600 pub struct InvoiceRequest {
601 pub(super) bytes: Vec<u8>,
602 pub(super) contents: InvoiceRequestContents,
603 signature: Signature,
606 /// An [`InvoiceRequest`] that has been verified by [`InvoiceRequest::verify`] and exposes different
607 /// ways to respond depending on whether the signing keys were derived.
608 #[derive(Clone, Debug)]
609 pub struct VerifiedInvoiceRequest {
610 /// The identifier of the [`Offer`] for which the [`InvoiceRequest`] was made.
611 pub offer_id: OfferId,
613 /// The verified request.
614 inner: InvoiceRequest,
616 /// Keys used for signing a [`Bolt12Invoice`] if they can be derived.
618 /// If `Some`, must call [`respond_using_derived_keys`] when responding. Otherwise, call
619 /// [`respond_with`].
621 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
622 /// [`respond_using_derived_keys`]: Self::respond_using_derived_keys
623 /// [`respond_with`]: Self::respond_with
624 pub keys: Option<KeyPair>,
627 /// The contents of an [`InvoiceRequest`], which may be shared with an [`Bolt12Invoice`].
629 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
630 #[derive(Clone, Debug)]
631 #[cfg_attr(test, derive(PartialEq))]
632 pub(super) struct InvoiceRequestContents {
633 pub(super) inner: InvoiceRequestContentsWithoutPayerId,
637 #[derive(Clone, Debug)]
638 #[cfg_attr(test, derive(PartialEq))]
639 pub(super) struct InvoiceRequestContentsWithoutPayerId {
640 payer: PayerContents,
641 pub(super) offer: OfferContents,
642 chain: Option<ChainHash>,
643 amount_msats: Option<u64>,
644 features: InvoiceRequestFeatures,
645 quantity: Option<u64>,
646 payer_note: Option<String>,
649 macro_rules! invoice_request_accessors { ($self: ident, $contents: expr) => {
650 /// An unpredictable series of bytes, typically containing information about the derivation of
653 /// [`payer_id`]: Self::payer_id
654 pub fn payer_metadata(&$self) -> &[u8] {
658 /// A chain from [`Offer::chains`] that the offer is valid for.
659 pub fn chain(&$self) -> ChainHash {
663 /// The amount to pay in msats (i.e., the minimum lightning-payable unit for [`chain`]), which
664 /// must be greater than or equal to [`Offer::amount`], converted if necessary.
666 /// [`chain`]: Self::chain
667 pub fn amount_msats(&$self) -> Option<u64> {
668 $contents.amount_msats()
671 /// Features pertaining to requesting an invoice.
672 pub fn invoice_request_features(&$self) -> &InvoiceRequestFeatures {
673 &$contents.features()
676 /// The quantity of the offer's item conforming to [`Offer::is_valid_quantity`].
677 pub fn quantity(&$self) -> Option<u64> {
681 /// A possibly transient pubkey used to sign the invoice request.
682 pub fn payer_id(&$self) -> PublicKey {
686 /// A payer-provided note which will be seen by the recipient and reflected back in the invoice
688 pub fn payer_note(&$self) -> Option<PrintableString> {
689 $contents.payer_note()
693 impl UnsignedInvoiceRequest {
694 offer_accessors!(self, self.contents.inner.offer);
695 invoice_request_accessors!(self, self.contents);
698 macro_rules! invoice_request_respond_with_explicit_signing_pubkey_methods { (
699 $self: ident, $contents: expr, $builder: ty
701 /// Creates an [`InvoiceBuilder`] for the request with the given required fields and using the
702 /// [`Duration`] since [`std::time::SystemTime::UNIX_EPOCH`] as the creation time.
704 /// See [`InvoiceRequest::respond_with_no_std`] for further details where the aforementioned
705 /// creation time is used for the `created_at` parameter.
707 /// [`Duration`]: core::time::Duration
708 #[cfg(feature = "std")]
710 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash
711 ) -> Result<$builder, Bolt12SemanticError> {
712 let created_at = std::time::SystemTime::now()
713 .duration_since(std::time::SystemTime::UNIX_EPOCH)
714 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
716 $contents.respond_with_no_std(payment_paths, payment_hash, created_at)
719 /// Creates an [`InvoiceBuilder`] for the request with the given required fields.
721 /// Unless [`InvoiceBuilder::relative_expiry`] is set, the invoice will expire two hours after
722 /// `created_at`, which is used to set [`Bolt12Invoice::created_at`]. Useful for `no-std` builds
723 /// where [`std::time::SystemTime`] is not available.
725 /// The caller is expected to remember the preimage of `payment_hash` in order to claim a payment
728 /// The `payment_paths` parameter is useful for maintaining the payment recipient's privacy. It
729 /// must contain one or more elements ordered from most-preferred to least-preferred, if there's
730 /// a preference. Note, however, that any privacy is lost if a public node id was used for
731 /// [`Offer::signing_pubkey`].
733 /// Errors if the request contains unknown required features.
737 /// If the originating [`Offer`] was created using [`OfferBuilder::deriving_signing_pubkey`],
738 /// then use [`InvoiceRequest::verify`] and [`VerifiedInvoiceRequest`] methods instead.
740 /// [`Bolt12Invoice::created_at`]: crate::offers::invoice::Bolt12Invoice::created_at
741 /// [`OfferBuilder::deriving_signing_pubkey`]: crate::offers::offer::OfferBuilder::deriving_signing_pubkey
742 pub fn respond_with_no_std(
743 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
744 created_at: core::time::Duration
745 ) -> Result<$builder, Bolt12SemanticError> {
746 if $contents.invoice_request_features().requires_unknown_bits() {
747 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
750 <$builder>::for_offer(&$contents, payment_paths, created_at, payment_hash)
754 macro_rules! invoice_request_verify_method { ($self: ident, $self_type: ty) => {
755 /// Verifies that the request was for an offer created using the given key. Returns the verified
756 /// request which contains the derived keys needed to sign a [`Bolt12Invoice`] for the request
757 /// if they could be extracted from the metadata.
759 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
761 #[cfg(not(c_bindings))]
762 T: secp256k1::Signing
764 $self: $self_type, key: &ExpandedKey,
765 #[cfg(not(c_bindings))]
766 secp_ctx: &Secp256k1<T>,
768 secp_ctx: &Secp256k1<secp256k1::All>,
769 ) -> Result<VerifiedInvoiceRequest, ()> {
770 let (offer_id, keys) = $self.contents.inner.offer.verify(&$self.bytes, key, secp_ctx)?;
771 Ok(VerifiedInvoiceRequest {
773 #[cfg(not(c_bindings))]
776 inner: $self.clone(),
783 #[cfg(not(c_bindings))]
784 impl InvoiceRequest {
785 offer_accessors!(self, self.contents.inner.offer);
786 invoice_request_accessors!(self, self.contents);
787 invoice_request_respond_with_explicit_signing_pubkey_methods!(self, self, InvoiceBuilder<ExplicitSigningPubkey>);
788 invoice_request_verify_method!(self, Self);
792 impl InvoiceRequest {
793 offer_accessors!(self, self.contents.inner.offer);
794 invoice_request_accessors!(self, self.contents);
795 invoice_request_respond_with_explicit_signing_pubkey_methods!(self, self, InvoiceWithExplicitSigningPubkeyBuilder);
796 invoice_request_verify_method!(self, &Self);
799 impl InvoiceRequest {
800 /// Signature of the invoice request using [`payer_id`].
802 /// [`payer_id`]: Self::payer_id
803 pub fn signature(&self) -> Signature {
807 pub(crate) fn as_tlv_stream(&self) -> FullInvoiceRequestTlvStreamRef {
808 let (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream) =
809 self.contents.as_tlv_stream();
810 let signature_tlv_stream = SignatureTlvStreamRef {
811 signature: Some(&self.signature),
813 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, signature_tlv_stream)
817 macro_rules! invoice_request_respond_with_derived_signing_pubkey_methods { (
818 $self: ident, $contents: expr, $builder: ty
820 /// Creates an [`InvoiceBuilder`] for the request using the given required fields and that uses
821 /// derived signing keys from the originating [`Offer`] to sign the [`Bolt12Invoice`]. Must use
822 /// the same [`ExpandedKey`] as the one used to create the offer.
824 /// See [`InvoiceRequest::respond_with`] for further details.
826 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
827 #[cfg(feature = "std")]
828 pub fn respond_using_derived_keys(
829 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash
830 ) -> Result<$builder, Bolt12SemanticError> {
831 let created_at = std::time::SystemTime::now()
832 .duration_since(std::time::SystemTime::UNIX_EPOCH)
833 .expect("SystemTime::now() should come after SystemTime::UNIX_EPOCH");
835 $self.respond_using_derived_keys_no_std(payment_paths, payment_hash, created_at)
838 /// Creates an [`InvoiceBuilder`] for the request using the given required fields and that uses
839 /// derived signing keys from the originating [`Offer`] to sign the [`Bolt12Invoice`]. Must use
840 /// the same [`ExpandedKey`] as the one used to create the offer.
842 /// See [`InvoiceRequest::respond_with_no_std`] for further details.
844 /// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
845 pub fn respond_using_derived_keys_no_std(
846 &$self, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, payment_hash: PaymentHash,
847 created_at: core::time::Duration
848 ) -> Result<$builder, Bolt12SemanticError> {
849 if $self.inner.invoice_request_features().requires_unknown_bits() {
850 return Err(Bolt12SemanticError::UnknownRequiredFeatures);
853 let keys = match $self.keys {
854 None => return Err(Bolt12SemanticError::InvalidMetadata),
858 <$builder>::for_offer_using_keys(
859 &$self.inner, payment_paths, created_at, payment_hash, keys
864 impl VerifiedInvoiceRequest {
865 offer_accessors!(self, self.inner.contents.inner.offer);
866 invoice_request_accessors!(self, self.inner.contents);
867 #[cfg(not(c_bindings))]
868 invoice_request_respond_with_explicit_signing_pubkey_methods!(self, self.inner, InvoiceBuilder<ExplicitSigningPubkey>);
870 invoice_request_respond_with_explicit_signing_pubkey_methods!(self, self.inner, InvoiceWithExplicitSigningPubkeyBuilder);
871 #[cfg(not(c_bindings))]
872 invoice_request_respond_with_derived_signing_pubkey_methods!(self, self.inner, InvoiceBuilder<DerivedSigningPubkey>);
874 invoice_request_respond_with_derived_signing_pubkey_methods!(self, self.inner, InvoiceWithDerivedSigningPubkeyBuilder);
876 pub(crate) fn fields(&self) -> InvoiceRequestFields {
877 let InvoiceRequestContents {
879 inner: InvoiceRequestContentsWithoutPayerId {
880 payer: _, offer: _, chain: _, amount_msats, features, quantity, payer_note
882 } = &self.inner.contents;
884 InvoiceRequestFields {
886 amount_msats: *amount_msats,
887 features: features.clone(),
889 payer_note_truncated: payer_note.clone()
890 .map(|mut s| { s.truncate(PAYER_NOTE_LIMIT); UntrustedString(s) }),
895 impl InvoiceRequestContents {
896 pub(super) fn metadata(&self) -> &[u8] {
897 self.inner.metadata()
900 pub(super) fn derives_keys(&self) -> bool {
901 self.inner.payer.0.derives_payer_keys()
904 pub(super) fn chain(&self) -> ChainHash {
908 pub(super) fn amount_msats(&self) -> Option<u64> {
909 self.inner.amount_msats
912 pub(super) fn features(&self) -> &InvoiceRequestFeatures {
916 pub(super) fn quantity(&self) -> Option<u64> {
920 pub(super) fn payer_id(&self) -> PublicKey {
924 pub(super) fn payer_note(&self) -> Option<PrintableString> {
925 self.inner.payer_note.as_ref()
926 .map(|payer_note| PrintableString(payer_note.as_str()))
929 pub(super) fn as_tlv_stream(&self) -> PartialInvoiceRequestTlvStreamRef {
930 let (payer, offer, mut invoice_request) = self.inner.as_tlv_stream();
931 invoice_request.payer_id = Some(&self.payer_id);
932 (payer, offer, invoice_request)
936 impl InvoiceRequestContentsWithoutPayerId {
937 pub(super) fn metadata(&self) -> &[u8] {
938 self.payer.0.as_bytes().map(|bytes| bytes.as_slice()).unwrap_or(&[])
941 pub(super) fn chain(&self) -> ChainHash {
942 self.chain.unwrap_or_else(|| self.offer.implied_chain())
945 pub(super) fn as_tlv_stream(&self) -> PartialInvoiceRequestTlvStreamRef {
946 let payer = PayerTlvStreamRef {
947 metadata: self.payer.0.as_bytes(),
950 let offer = self.offer.as_tlv_stream();
953 if self.features == InvoiceRequestFeatures::empty() { None }
954 else { Some(&self.features) }
957 let invoice_request = InvoiceRequestTlvStreamRef {
958 chain: self.chain.as_ref(),
959 amount: self.amount_msats,
961 quantity: self.quantity,
963 payer_note: self.payer_note.as_ref(),
966 (payer, offer, invoice_request)
970 impl Writeable for UnsignedInvoiceRequest {
971 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
972 WithoutLength(&self.bytes).write(writer)
976 impl Writeable for InvoiceRequest {
977 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
978 WithoutLength(&self.bytes).write(writer)
982 impl Writeable for InvoiceRequestContents {
983 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
984 self.as_tlv_stream().write(writer)
988 /// Valid type range for invoice_request TLV records.
989 pub(super) const INVOICE_REQUEST_TYPES: core::ops::Range<u64> = 80..160;
991 /// TLV record type for [`InvoiceRequest::payer_id`] and [`Refund::payer_id`].
993 /// [`Refund::payer_id`]: crate::offers::refund::Refund::payer_id
994 pub(super) const INVOICE_REQUEST_PAYER_ID_TYPE: u64 = 88;
996 tlv_stream!(InvoiceRequestTlvStream, InvoiceRequestTlvStreamRef, INVOICE_REQUEST_TYPES, {
997 (80, chain: ChainHash),
998 (82, amount: (u64, HighZeroBytesDroppedBigSize)),
999 (84, features: (InvoiceRequestFeatures, WithoutLength)),
1000 (86, quantity: (u64, HighZeroBytesDroppedBigSize)),
1001 (INVOICE_REQUEST_PAYER_ID_TYPE, payer_id: PublicKey),
1002 (89, payer_note: (String, WithoutLength)),
1005 type FullInvoiceRequestTlvStream =
1006 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, SignatureTlvStream);
1008 type FullInvoiceRequestTlvStreamRef<'a> = (
1009 PayerTlvStreamRef<'a>,
1010 OfferTlvStreamRef<'a>,
1011 InvoiceRequestTlvStreamRef<'a>,
1012 SignatureTlvStreamRef<'a>,
1015 impl SeekReadable for FullInvoiceRequestTlvStream {
1016 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1017 let payer = SeekReadable::read(r)?;
1018 let offer = SeekReadable::read(r)?;
1019 let invoice_request = SeekReadable::read(r)?;
1020 let signature = SeekReadable::read(r)?;
1022 Ok((payer, offer, invoice_request, signature))
1026 type PartialInvoiceRequestTlvStream = (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream);
1028 type PartialInvoiceRequestTlvStreamRef<'a> = (
1029 PayerTlvStreamRef<'a>,
1030 OfferTlvStreamRef<'a>,
1031 InvoiceRequestTlvStreamRef<'a>,
1034 impl TryFrom<Vec<u8>> for UnsignedInvoiceRequest {
1035 type Error = Bolt12ParseError;
1037 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1038 let invoice_request = ParsedMessage::<PartialInvoiceRequestTlvStream>::try_from(bytes)?;
1039 let ParsedMessage { bytes, tlv_stream } = invoice_request;
1041 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream,
1043 let contents = InvoiceRequestContents::try_from(
1044 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1047 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
1049 Ok(UnsignedInvoiceRequest { bytes, contents, tagged_hash })
1053 impl TryFrom<Vec<u8>> for InvoiceRequest {
1054 type Error = Bolt12ParseError;
1056 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1057 let invoice_request = ParsedMessage::<FullInvoiceRequestTlvStream>::try_from(bytes)?;
1058 let ParsedMessage { bytes, tlv_stream } = invoice_request;
1060 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream,
1061 SignatureTlvStream { signature },
1063 let contents = InvoiceRequestContents::try_from(
1064 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1067 let signature = match signature {
1068 None => return Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
1069 Some(signature) => signature,
1071 let message = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
1072 merkle::verify_signature(&signature, &message, contents.payer_id)?;
1074 Ok(InvoiceRequest { bytes, contents, signature })
1078 impl TryFrom<PartialInvoiceRequestTlvStream> for InvoiceRequestContents {
1079 type Error = Bolt12SemanticError;
1081 fn try_from(tlv_stream: PartialInvoiceRequestTlvStream) -> Result<Self, Self::Error> {
1083 PayerTlvStream { metadata },
1085 InvoiceRequestTlvStream { chain, amount, features, quantity, payer_id, payer_note },
1088 let payer = match metadata {
1089 None => return Err(Bolt12SemanticError::MissingPayerMetadata),
1090 Some(metadata) => PayerContents(Metadata::Bytes(metadata)),
1092 let offer = OfferContents::try_from(offer_tlv_stream)?;
1094 if !offer.supports_chain(chain.unwrap_or_else(|| offer.implied_chain())) {
1095 return Err(Bolt12SemanticError::UnsupportedChain);
1098 if offer.amount().is_none() && amount.is_none() {
1099 return Err(Bolt12SemanticError::MissingAmount);
1102 offer.check_quantity(quantity)?;
1103 offer.check_amount_msats_for_quantity(amount, quantity)?;
1105 let features = features.unwrap_or_else(InvoiceRequestFeatures::empty);
1107 let payer_id = match payer_id {
1108 None => return Err(Bolt12SemanticError::MissingPayerId),
1109 Some(payer_id) => payer_id,
1112 Ok(InvoiceRequestContents {
1113 inner: InvoiceRequestContentsWithoutPayerId {
1114 payer, offer, chain, amount_msats: amount, features, quantity, payer_note,
1121 /// Fields sent in an [`InvoiceRequest`] message to include in [`PaymentContext::Bolt12Offer`].
1123 /// [`PaymentContext::Bolt12Offer`]: crate::blinded_path::payment::PaymentContext::Bolt12Offer
1124 #[derive(Clone, Debug, Eq, PartialEq)]
1125 pub struct InvoiceRequestFields {
1126 /// A possibly transient pubkey used to sign the invoice request.
1127 pub payer_id: PublicKey,
1129 /// The amount to pay in msats (i.e., the minimum lightning-payable unit for [`chain`]), which
1130 /// must be greater than or equal to [`Offer::amount`], converted if necessary.
1132 /// [`chain`]: InvoiceRequest::chain
1133 pub amount_msats: Option<u64>,
1135 /// Features pertaining to requesting an invoice.
1136 pub features: InvoiceRequestFeatures,
1138 /// The quantity of the offer's item conforming to [`Offer::is_valid_quantity`].
1139 pub quantity: Option<u64>,
1141 /// A payer-provided note which will be seen by the recipient and reflected back in the invoice
1142 /// response. Truncated to [`PAYER_NOTE_LIMIT`] characters.
1143 pub payer_note_truncated: Option<UntrustedString>,
1146 /// The maximum number of characters included in [`InvoiceRequestFields::payer_note_truncated`].
1147 pub const PAYER_NOTE_LIMIT: usize = 512;
1149 impl Writeable for InvoiceRequestFields {
1150 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1151 write_tlv_fields!(writer, {
1152 (0, self.payer_id, required),
1153 (2, self.amount_msats.map(|v| HighZeroBytesDroppedBigSize(v)), option),
1154 (4, WithoutLength(&self.features), required),
1155 (6, self.quantity.map(|v| HighZeroBytesDroppedBigSize(v)), option),
1156 (8, self.payer_note_truncated.as_ref().map(|s| WithoutLength(&s.0)), option),
1162 impl Readable for InvoiceRequestFields {
1163 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
1164 _init_and_read_len_prefixed_tlv_fields!(reader, {
1165 (0, payer_id, required),
1166 (2, amount_msats, (option, encoding: (u64, HighZeroBytesDroppedBigSize))),
1167 (4, features, (option, encoding: (InvoiceRequestFeatures, WithoutLength))),
1168 (6, quantity, (option, encoding: (u64, HighZeroBytesDroppedBigSize))),
1169 (8, payer_note_truncated, (option, encoding: (String, WithoutLength))),
1171 let features = features.unwrap_or(InvoiceRequestFeatures::empty());
1173 Ok(InvoiceRequestFields {
1174 payer_id: payer_id.0.unwrap(), amount_msats, features, quantity,
1175 payer_note_truncated: payer_note_truncated.map(|s| UntrustedString(s)),
1182 use super::{InvoiceRequest, InvoiceRequestFields, InvoiceRequestTlvStreamRef, PAYER_NOTE_LIMIT, SIGNATURE_TAG, UnsignedInvoiceRequest};
1184 use bitcoin::blockdata::constants::ChainHash;
1185 use bitcoin::network::constants::Network;
1186 use bitcoin::secp256k1::{KeyPair, Secp256k1, SecretKey, self};
1187 use core::num::NonZeroU64;
1188 #[cfg(feature = "std")]
1189 use core::time::Duration;
1190 use crate::sign::KeyMaterial;
1191 use crate::ln::channelmanager::PaymentId;
1192 use crate::ln::features::{InvoiceRequestFeatures, OfferFeatures};
1193 use crate::ln::inbound_payment::ExpandedKey;
1194 use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
1195 use crate::offers::invoice::{Bolt12Invoice, SIGNATURE_TAG as INVOICE_SIGNATURE_TAG};
1196 use crate::offers::merkle::{SignError, SignatureTlvStreamRef, TaggedHash, self};
1197 use crate::offers::offer::{Amount, OfferTlvStreamRef, Quantity};
1198 #[cfg(not(c_bindings))]
1200 crate::offers::offer::OfferBuilder,
1204 crate::offers::offer::OfferWithExplicitMetadataBuilder as OfferBuilder,
1206 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
1207 use crate::offers::payer::PayerTlvStreamRef;
1208 use crate::offers::test_utils::*;
1209 use crate::util::ser::{BigSize, Readable, Writeable};
1210 use crate::util::string::{PrintableString, UntrustedString};
1213 fn builds_invoice_request_with_defaults() {
1214 let unsigned_invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1217 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1220 let mut unsigned_invoice_request = unsigned_invoice_request;
1222 let mut buffer = Vec::new();
1223 unsigned_invoice_request.write(&mut buffer).unwrap();
1225 assert_eq!(unsigned_invoice_request.bytes, buffer.as_slice());
1226 assert_eq!(unsigned_invoice_request.payer_metadata(), &[1; 32]);
1227 assert_eq!(unsigned_invoice_request.chains(), vec![ChainHash::using_genesis_block(Network::Bitcoin)]);
1228 assert_eq!(unsigned_invoice_request.metadata(), None);
1229 assert_eq!(unsigned_invoice_request.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1230 assert_eq!(unsigned_invoice_request.description(), PrintableString("foo"));
1231 assert_eq!(unsigned_invoice_request.offer_features(), &OfferFeatures::empty());
1232 assert_eq!(unsigned_invoice_request.absolute_expiry(), None);
1233 assert_eq!(unsigned_invoice_request.paths(), &[]);
1234 assert_eq!(unsigned_invoice_request.issuer(), None);
1235 assert_eq!(unsigned_invoice_request.supported_quantity(), Quantity::One);
1236 assert_eq!(unsigned_invoice_request.signing_pubkey(), recipient_pubkey());
1237 assert_eq!(unsigned_invoice_request.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1238 assert_eq!(unsigned_invoice_request.amount_msats(), None);
1239 assert_eq!(unsigned_invoice_request.invoice_request_features(), &InvoiceRequestFeatures::empty());
1240 assert_eq!(unsigned_invoice_request.quantity(), None);
1241 assert_eq!(unsigned_invoice_request.payer_id(), payer_pubkey());
1242 assert_eq!(unsigned_invoice_request.payer_note(), None);
1244 match UnsignedInvoiceRequest::try_from(buffer) {
1245 Err(e) => panic!("error parsing unsigned invoice request: {:?}", e),
1247 assert_eq!(parsed.bytes, unsigned_invoice_request.bytes);
1248 assert_eq!(parsed.tagged_hash, unsigned_invoice_request.tagged_hash);
1252 let invoice_request = unsigned_invoice_request.sign(payer_sign).unwrap();
1254 let mut buffer = Vec::new();
1255 invoice_request.write(&mut buffer).unwrap();
1257 assert_eq!(invoice_request.bytes, buffer.as_slice());
1258 assert_eq!(invoice_request.payer_metadata(), &[1; 32]);
1259 assert_eq!(invoice_request.chains(), vec![ChainHash::using_genesis_block(Network::Bitcoin)]);
1260 assert_eq!(invoice_request.metadata(), None);
1261 assert_eq!(invoice_request.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1262 assert_eq!(invoice_request.description(), PrintableString("foo"));
1263 assert_eq!(invoice_request.offer_features(), &OfferFeatures::empty());
1264 assert_eq!(invoice_request.absolute_expiry(), None);
1265 assert_eq!(invoice_request.paths(), &[]);
1266 assert_eq!(invoice_request.issuer(), None);
1267 assert_eq!(invoice_request.supported_quantity(), Quantity::One);
1268 assert_eq!(invoice_request.signing_pubkey(), recipient_pubkey());
1269 assert_eq!(invoice_request.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1270 assert_eq!(invoice_request.amount_msats(), None);
1271 assert_eq!(invoice_request.invoice_request_features(), &InvoiceRequestFeatures::empty());
1272 assert_eq!(invoice_request.quantity(), None);
1273 assert_eq!(invoice_request.payer_id(), payer_pubkey());
1274 assert_eq!(invoice_request.payer_note(), None);
1276 let message = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &invoice_request.bytes);
1277 assert!(merkle::verify_signature(&invoice_request.signature, &message, payer_pubkey()).is_ok());
1280 invoice_request.as_tlv_stream(),
1282 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1288 description: Some(&String::from("foo")),
1290 absolute_expiry: None,
1294 node_id: Some(&recipient_pubkey()),
1296 InvoiceRequestTlvStreamRef {
1301 payer_id: Some(&payer_pubkey()),
1304 SignatureTlvStreamRef { signature: Some(&invoice_request.signature()) },
1308 if let Err(e) = InvoiceRequest::try_from(buffer) {
1309 panic!("error parsing invoice request: {:?}", e);
1313 #[cfg(feature = "std")]
1315 fn builds_invoice_request_from_offer_with_expiration() {
1316 let future_expiry = Duration::from_secs(u64::max_value());
1317 let past_expiry = Duration::from_secs(0);
1319 if let Err(e) = OfferBuilder::new("foo".into(), recipient_pubkey())
1321 .absolute_expiry(future_expiry)
1323 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1326 panic!("error building invoice_request: {:?}", e);
1329 match OfferBuilder::new("foo".into(), recipient_pubkey())
1331 .absolute_expiry(past_expiry)
1333 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1336 Ok(_) => panic!("expected error"),
1337 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1342 fn builds_invoice_request_with_derived_metadata() {
1343 let payer_id = payer_pubkey();
1344 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1345 let entropy = FixedEntropy {};
1346 let secp_ctx = Secp256k1::new();
1347 let payment_id = PaymentId([1; 32]);
1349 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
1352 let invoice_request = offer
1353 .request_invoice_deriving_metadata(payer_id, &expanded_key, &entropy, payment_id)
1356 .sign(payer_sign).unwrap();
1357 assert_eq!(invoice_request.payer_id(), payer_pubkey());
1359 let invoice = invoice_request.respond_with_no_std(payment_paths(), payment_hash(), now())
1362 .sign(recipient_sign).unwrap();
1363 match invoice.verify(&expanded_key, &secp_ctx) {
1364 Ok(payment_id) => assert_eq!(payment_id, PaymentId([1; 32])),
1365 Err(()) => panic!("verification failed"),
1368 // Fails verification with altered fields
1370 payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream,
1371 mut invoice_tlv_stream, mut signature_tlv_stream
1372 ) = invoice.as_tlv_stream();
1373 invoice_request_tlv_stream.amount = Some(2000);
1374 invoice_tlv_stream.amount = Some(2000);
1377 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1378 let mut bytes = Vec::new();
1379 tlv_stream.write(&mut bytes).unwrap();
1381 let message = TaggedHash::from_valid_tlv_stream_bytes(INVOICE_SIGNATURE_TAG, &bytes);
1382 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1383 signature_tlv_stream.signature = Some(&signature);
1385 let mut encoded_invoice = bytes;
1386 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1388 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1389 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1391 // Fails verification with altered metadata
1393 mut payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1394 mut signature_tlv_stream
1395 ) = invoice.as_tlv_stream();
1396 let metadata = payer_tlv_stream.metadata.unwrap().iter().copied().rev().collect();
1397 payer_tlv_stream.metadata = Some(&metadata);
1400 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1401 let mut bytes = Vec::new();
1402 tlv_stream.write(&mut bytes).unwrap();
1404 let message = TaggedHash::from_valid_tlv_stream_bytes(INVOICE_SIGNATURE_TAG, &bytes);
1405 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1406 signature_tlv_stream.signature = Some(&signature);
1408 let mut encoded_invoice = bytes;
1409 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1411 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1412 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1416 fn builds_invoice_request_with_derived_payer_id() {
1417 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1418 let entropy = FixedEntropy {};
1419 let secp_ctx = Secp256k1::new();
1420 let payment_id = PaymentId([1; 32]);
1422 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
1425 let invoice_request = offer
1426 .request_invoice_deriving_payer_id(&expanded_key, &entropy, &secp_ctx, payment_id)
1431 let invoice = invoice_request.respond_with_no_std(payment_paths(), payment_hash(), now())
1434 .sign(recipient_sign).unwrap();
1435 match invoice.verify(&expanded_key, &secp_ctx) {
1436 Ok(payment_id) => assert_eq!(payment_id, PaymentId([1; 32])),
1437 Err(()) => panic!("verification failed"),
1440 // Fails verification with altered fields
1442 payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream,
1443 mut invoice_tlv_stream, mut signature_tlv_stream
1444 ) = invoice.as_tlv_stream();
1445 invoice_request_tlv_stream.amount = Some(2000);
1446 invoice_tlv_stream.amount = Some(2000);
1449 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1450 let mut bytes = Vec::new();
1451 tlv_stream.write(&mut bytes).unwrap();
1453 let message = TaggedHash::from_valid_tlv_stream_bytes(INVOICE_SIGNATURE_TAG, &bytes);
1454 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1455 signature_tlv_stream.signature = Some(&signature);
1457 let mut encoded_invoice = bytes;
1458 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1460 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1461 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1463 // Fails verification with altered payer id
1465 payer_tlv_stream, offer_tlv_stream, mut invoice_request_tlv_stream, invoice_tlv_stream,
1466 mut signature_tlv_stream
1467 ) = invoice.as_tlv_stream();
1468 let payer_id = pubkey(1);
1469 invoice_request_tlv_stream.payer_id = Some(&payer_id);
1472 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream);
1473 let mut bytes = Vec::new();
1474 tlv_stream.write(&mut bytes).unwrap();
1476 let message = TaggedHash::from_valid_tlv_stream_bytes(INVOICE_SIGNATURE_TAG, &bytes);
1477 let signature = merkle::sign_message(recipient_sign, &message, recipient_pubkey()).unwrap();
1478 signature_tlv_stream.signature = Some(&signature);
1480 let mut encoded_invoice = bytes;
1481 signature_tlv_stream.write(&mut encoded_invoice).unwrap();
1483 let invoice = Bolt12Invoice::try_from(encoded_invoice).unwrap();
1484 assert!(invoice.verify(&expanded_key, &secp_ctx).is_err());
1488 fn builds_invoice_request_with_chain() {
1489 let mainnet = ChainHash::using_genesis_block(Network::Bitcoin);
1490 let testnet = ChainHash::using_genesis_block(Network::Testnet);
1492 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1495 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1496 .chain(Network::Bitcoin).unwrap()
1498 .sign(payer_sign).unwrap();
1499 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1500 assert_eq!(invoice_request.chain(), mainnet);
1501 assert_eq!(tlv_stream.chain, None);
1503 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1505 .chain(Network::Testnet)
1507 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1508 .chain(Network::Testnet).unwrap()
1510 .sign(payer_sign).unwrap();
1511 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1512 assert_eq!(invoice_request.chain(), testnet);
1513 assert_eq!(tlv_stream.chain, Some(&testnet));
1515 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1517 .chain(Network::Bitcoin)
1518 .chain(Network::Testnet)
1520 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1521 .chain(Network::Bitcoin).unwrap()
1523 .sign(payer_sign).unwrap();
1524 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1525 assert_eq!(invoice_request.chain(), mainnet);
1526 assert_eq!(tlv_stream.chain, None);
1528 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1530 .chain(Network::Bitcoin)
1531 .chain(Network::Testnet)
1533 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1534 .chain(Network::Bitcoin).unwrap()
1535 .chain(Network::Testnet).unwrap()
1537 .sign(payer_sign).unwrap();
1538 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1539 assert_eq!(invoice_request.chain(), testnet);
1540 assert_eq!(tlv_stream.chain, Some(&testnet));
1542 match OfferBuilder::new("foo".into(), recipient_pubkey())
1544 .chain(Network::Testnet)
1546 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1547 .chain(Network::Bitcoin)
1549 Ok(_) => panic!("expected error"),
1550 Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
1553 match OfferBuilder::new("foo".into(), recipient_pubkey())
1555 .chain(Network::Testnet)
1557 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1560 Ok(_) => panic!("expected error"),
1561 Err(e) => assert_eq!(e, Bolt12SemanticError::UnsupportedChain),
1566 fn builds_invoice_request_with_amount() {
1567 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1570 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1571 .amount_msats(1000).unwrap()
1573 .sign(payer_sign).unwrap();
1574 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1575 assert_eq!(invoice_request.amount_msats(), Some(1000));
1576 assert_eq!(tlv_stream.amount, Some(1000));
1578 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1581 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1582 .amount_msats(1001).unwrap()
1583 .amount_msats(1000).unwrap()
1585 .sign(payer_sign).unwrap();
1586 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1587 assert_eq!(invoice_request.amount_msats(), Some(1000));
1588 assert_eq!(tlv_stream.amount, Some(1000));
1590 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1593 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1594 .amount_msats(1001).unwrap()
1596 .sign(payer_sign).unwrap();
1597 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1598 assert_eq!(invoice_request.amount_msats(), Some(1001));
1599 assert_eq!(tlv_stream.amount, Some(1001));
1601 match OfferBuilder::new("foo".into(), recipient_pubkey())
1604 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1607 Ok(_) => panic!("expected error"),
1608 Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1611 match OfferBuilder::new("foo".into(), recipient_pubkey())
1613 .supported_quantity(Quantity::Unbounded)
1615 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1616 .quantity(2).unwrap()
1619 Ok(_) => panic!("expected error"),
1620 Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1623 match OfferBuilder::new("foo".into(), recipient_pubkey())
1626 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1627 .amount_msats(MAX_VALUE_MSAT + 1)
1629 Ok(_) => panic!("expected error"),
1630 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1633 match OfferBuilder::new("foo".into(), recipient_pubkey())
1635 .supported_quantity(Quantity::Unbounded)
1637 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1638 .amount_msats(1000).unwrap()
1639 .quantity(2).unwrap()
1642 Ok(_) => panic!("expected error"),
1643 Err(e) => assert_eq!(e, Bolt12SemanticError::InsufficientAmount),
1646 match OfferBuilder::new("foo".into(), recipient_pubkey())
1648 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1651 Ok(_) => panic!("expected error"),
1652 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingAmount),
1655 match OfferBuilder::new("foo".into(), recipient_pubkey())
1657 .supported_quantity(Quantity::Unbounded)
1659 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1660 .quantity(u64::max_value()).unwrap()
1663 Ok(_) => panic!("expected error"),
1664 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1669 fn builds_invoice_request_with_features() {
1670 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1673 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1674 .features_unchecked(InvoiceRequestFeatures::unknown())
1676 .sign(payer_sign).unwrap();
1677 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1678 assert_eq!(invoice_request.invoice_request_features(), &InvoiceRequestFeatures::unknown());
1679 assert_eq!(tlv_stream.features, Some(&InvoiceRequestFeatures::unknown()));
1681 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1684 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1685 .features_unchecked(InvoiceRequestFeatures::unknown())
1686 .features_unchecked(InvoiceRequestFeatures::empty())
1688 .sign(payer_sign).unwrap();
1689 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1690 assert_eq!(invoice_request.invoice_request_features(), &InvoiceRequestFeatures::empty());
1691 assert_eq!(tlv_stream.features, None);
1695 fn builds_invoice_request_with_quantity() {
1696 let one = NonZeroU64::new(1).unwrap();
1697 let ten = NonZeroU64::new(10).unwrap();
1699 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1701 .supported_quantity(Quantity::One)
1703 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1705 .sign(payer_sign).unwrap();
1706 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1707 assert_eq!(invoice_request.quantity(), None);
1708 assert_eq!(tlv_stream.quantity, None);
1710 match OfferBuilder::new("foo".into(), recipient_pubkey())
1712 .supported_quantity(Quantity::One)
1714 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1715 .amount_msats(2_000).unwrap()
1718 Ok(_) => panic!("expected error"),
1719 Err(e) => assert_eq!(e, Bolt12SemanticError::UnexpectedQuantity),
1722 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1724 .supported_quantity(Quantity::Bounded(ten))
1726 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1727 .amount_msats(10_000).unwrap()
1728 .quantity(10).unwrap()
1730 .sign(payer_sign).unwrap();
1731 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1732 assert_eq!(invoice_request.amount_msats(), Some(10_000));
1733 assert_eq!(tlv_stream.amount, Some(10_000));
1735 match OfferBuilder::new("foo".into(), recipient_pubkey())
1737 .supported_quantity(Quantity::Bounded(ten))
1739 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1740 .amount_msats(11_000).unwrap()
1743 Ok(_) => panic!("expected error"),
1744 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidQuantity),
1747 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1749 .supported_quantity(Quantity::Unbounded)
1751 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1752 .amount_msats(2_000).unwrap()
1753 .quantity(2).unwrap()
1755 .sign(payer_sign).unwrap();
1756 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1757 assert_eq!(invoice_request.amount_msats(), Some(2_000));
1758 assert_eq!(tlv_stream.amount, Some(2_000));
1760 match OfferBuilder::new("foo".into(), recipient_pubkey())
1762 .supported_quantity(Quantity::Unbounded)
1764 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1767 Ok(_) => panic!("expected error"),
1768 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingQuantity),
1771 match OfferBuilder::new("foo".into(), recipient_pubkey())
1773 .supported_quantity(Quantity::Bounded(one))
1775 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1778 Ok(_) => panic!("expected error"),
1779 Err(e) => assert_eq!(e, Bolt12SemanticError::MissingQuantity),
1784 fn builds_invoice_request_with_payer_note() {
1785 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1788 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1789 .payer_note("bar".into())
1791 .sign(payer_sign).unwrap();
1792 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1793 assert_eq!(invoice_request.payer_note(), Some(PrintableString("bar")));
1794 assert_eq!(tlv_stream.payer_note, Some(&String::from("bar")));
1796 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1799 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1800 .payer_note("bar".into())
1801 .payer_note("baz".into())
1803 .sign(payer_sign).unwrap();
1804 let (_, _, tlv_stream, _) = invoice_request.as_tlv_stream();
1805 assert_eq!(invoice_request.payer_note(), Some(PrintableString("baz")));
1806 assert_eq!(tlv_stream.payer_note, Some(&String::from("baz")));
1810 fn fails_signing_invoice_request() {
1811 match OfferBuilder::new("foo".into(), recipient_pubkey())
1814 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1818 Ok(_) => panic!("expected error"),
1819 Err(e) => assert_eq!(e, SignError::Signing),
1822 match OfferBuilder::new("foo".into(), recipient_pubkey())
1825 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1827 .sign(recipient_sign)
1829 Ok(_) => panic!("expected error"),
1830 Err(e) => assert_eq!(e, SignError::Verification(secp256k1::Error::InvalidSignature)),
1835 fn fails_responding_with_unknown_required_features() {
1836 match OfferBuilder::new("foo".into(), recipient_pubkey())
1839 .request_invoice(vec![42; 32], payer_pubkey()).unwrap()
1840 .features_unchecked(InvoiceRequestFeatures::unknown())
1842 .sign(payer_sign).unwrap()
1843 .respond_with_no_std(payment_paths(), payment_hash(), now())
1845 Ok(_) => panic!("expected error"),
1846 Err(e) => assert_eq!(e, Bolt12SemanticError::UnknownRequiredFeatures),
1851 fn parses_invoice_request_with_metadata() {
1852 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1855 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1857 .sign(payer_sign).unwrap();
1859 let mut buffer = Vec::new();
1860 invoice_request.write(&mut buffer).unwrap();
1862 if let Err(e) = InvoiceRequest::try_from(buffer) {
1863 panic!("error parsing invoice_request: {:?}", e);
1868 fn parses_invoice_request_with_chain() {
1869 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1872 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1873 .chain(Network::Bitcoin).unwrap()
1875 .sign(payer_sign).unwrap();
1877 let mut buffer = Vec::new();
1878 invoice_request.write(&mut buffer).unwrap();
1880 if let Err(e) = InvoiceRequest::try_from(buffer) {
1881 panic!("error parsing invoice_request: {:?}", e);
1884 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1887 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1888 .chain_unchecked(Network::Testnet)
1890 .sign(payer_sign).unwrap();
1892 let mut buffer = Vec::new();
1893 invoice_request.write(&mut buffer).unwrap();
1895 match InvoiceRequest::try_from(buffer) {
1896 Ok(_) => panic!("expected error"),
1897 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnsupportedChain)),
1902 fn parses_invoice_request_with_amount() {
1903 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1906 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1908 .sign(payer_sign).unwrap();
1910 let mut buffer = Vec::new();
1911 invoice_request.write(&mut buffer).unwrap();
1913 if let Err(e) = InvoiceRequest::try_from(buffer) {
1914 panic!("error parsing invoice_request: {:?}", e);
1917 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1919 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1920 .amount_msats(1000).unwrap()
1922 .sign(payer_sign).unwrap();
1924 let mut buffer = Vec::new();
1925 invoice_request.write(&mut buffer).unwrap();
1927 if let Err(e) = InvoiceRequest::try_from(buffer) {
1928 panic!("error parsing invoice_request: {:?}", e);
1931 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1933 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1935 .sign(payer_sign).unwrap();
1937 let mut buffer = Vec::new();
1938 invoice_request.write(&mut buffer).unwrap();
1940 match InvoiceRequest::try_from(buffer) {
1941 Ok(_) => panic!("expected error"),
1942 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount)),
1945 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1948 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1949 .amount_msats_unchecked(999)
1951 .sign(payer_sign).unwrap();
1953 let mut buffer = Vec::new();
1954 invoice_request.write(&mut buffer).unwrap();
1956 match InvoiceRequest::try_from(buffer) {
1957 Ok(_) => panic!("expected error"),
1958 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InsufficientAmount)),
1961 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1962 .amount(Amount::Currency { iso4217_code: *b"USD", amount: 1000 })
1964 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1966 .sign(payer_sign).unwrap();
1968 let mut buffer = Vec::new();
1969 invoice_request.write(&mut buffer).unwrap();
1971 match InvoiceRequest::try_from(buffer) {
1972 Ok(_) => panic!("expected error"),
1974 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnsupportedCurrency));
1978 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
1980 .supported_quantity(Quantity::Unbounded)
1982 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1983 .quantity(u64::max_value()).unwrap()
1985 .sign(payer_sign).unwrap();
1987 let mut buffer = Vec::new();
1988 invoice_request.write(&mut buffer).unwrap();
1990 match InvoiceRequest::try_from(buffer) {
1991 Ok(_) => panic!("expected error"),
1992 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidAmount)),
1997 fn parses_invoice_request_with_quantity() {
1998 let one = NonZeroU64::new(1).unwrap();
1999 let ten = NonZeroU64::new(10).unwrap();
2001 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2003 .supported_quantity(Quantity::One)
2005 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2007 .sign(payer_sign).unwrap();
2009 let mut buffer = Vec::new();
2010 invoice_request.write(&mut buffer).unwrap();
2012 if let Err(e) = InvoiceRequest::try_from(buffer) {
2013 panic!("error parsing invoice_request: {:?}", e);
2016 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2018 .supported_quantity(Quantity::One)
2020 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2021 .amount_msats(2_000).unwrap()
2022 .quantity_unchecked(2)
2024 .sign(payer_sign).unwrap();
2026 let mut buffer = Vec::new();
2027 invoice_request.write(&mut buffer).unwrap();
2029 match InvoiceRequest::try_from(buffer) {
2030 Ok(_) => panic!("expected error"),
2032 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::UnexpectedQuantity));
2036 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2038 .supported_quantity(Quantity::Bounded(ten))
2040 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2041 .amount_msats(10_000).unwrap()
2042 .quantity(10).unwrap()
2044 .sign(payer_sign).unwrap();
2046 let mut buffer = Vec::new();
2047 invoice_request.write(&mut buffer).unwrap();
2049 if let Err(e) = InvoiceRequest::try_from(buffer) {
2050 panic!("error parsing invoice_request: {:?}", e);
2053 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2055 .supported_quantity(Quantity::Bounded(ten))
2057 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2058 .amount_msats(11_000).unwrap()
2059 .quantity_unchecked(11)
2061 .sign(payer_sign).unwrap();
2063 let mut buffer = Vec::new();
2064 invoice_request.write(&mut buffer).unwrap();
2066 match InvoiceRequest::try_from(buffer) {
2067 Ok(_) => panic!("expected error"),
2068 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidQuantity)),
2071 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2073 .supported_quantity(Quantity::Unbounded)
2075 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2076 .amount_msats(2_000).unwrap()
2077 .quantity(2).unwrap()
2079 .sign(payer_sign).unwrap();
2081 let mut buffer = Vec::new();
2082 invoice_request.write(&mut buffer).unwrap();
2084 if let Err(e) = InvoiceRequest::try_from(buffer) {
2085 panic!("error parsing invoice_request: {:?}", e);
2088 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2090 .supported_quantity(Quantity::Unbounded)
2092 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2094 .sign(payer_sign).unwrap();
2096 let mut buffer = Vec::new();
2097 invoice_request.write(&mut buffer).unwrap();
2099 match InvoiceRequest::try_from(buffer) {
2100 Ok(_) => panic!("expected error"),
2101 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingQuantity)),
2104 let invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2106 .supported_quantity(Quantity::Bounded(one))
2108 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2110 .sign(payer_sign).unwrap();
2112 let mut buffer = Vec::new();
2113 invoice_request.write(&mut buffer).unwrap();
2115 match InvoiceRequest::try_from(buffer) {
2116 Ok(_) => panic!("expected error"),
2117 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingQuantity)),
2122 fn fails_parsing_invoice_request_without_metadata() {
2123 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
2126 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2128 let mut tlv_stream = unsigned_invoice_request.contents.as_tlv_stream();
2129 tlv_stream.0.metadata = None;
2131 let mut buffer = Vec::new();
2132 tlv_stream.write(&mut buffer).unwrap();
2134 match InvoiceRequest::try_from(buffer) {
2135 Ok(_) => panic!("expected error"),
2137 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerMetadata));
2143 fn fails_parsing_invoice_request_without_payer_id() {
2144 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
2147 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2149 let mut tlv_stream = unsigned_invoice_request.contents.as_tlv_stream();
2150 tlv_stream.2.payer_id = None;
2152 let mut buffer = Vec::new();
2153 tlv_stream.write(&mut buffer).unwrap();
2155 match InvoiceRequest::try_from(buffer) {
2156 Ok(_) => panic!("expected error"),
2157 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPayerId)),
2162 fn fails_parsing_invoice_request_without_node_id() {
2163 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
2166 let unsigned_invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2168 let mut tlv_stream = unsigned_invoice_request.contents.as_tlv_stream();
2169 tlv_stream.1.node_id = None;
2171 let mut buffer = Vec::new();
2172 tlv_stream.write(&mut buffer).unwrap();
2174 match InvoiceRequest::try_from(buffer) {
2175 Ok(_) => panic!("expected error"),
2177 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey));
2183 fn fails_parsing_invoice_request_without_signature() {
2184 let mut buffer = Vec::new();
2185 OfferBuilder::new("foo".into(), recipient_pubkey())
2188 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2191 .write(&mut buffer).unwrap();
2193 match InvoiceRequest::try_from(buffer) {
2194 Ok(_) => panic!("expected error"),
2195 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
2200 fn fails_parsing_invoice_request_with_invalid_signature() {
2201 let mut invoice_request = OfferBuilder::new("foo".into(), recipient_pubkey())
2204 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2206 .sign(payer_sign).unwrap();
2207 let last_signature_byte = invoice_request.bytes.last_mut().unwrap();
2208 *last_signature_byte = last_signature_byte.wrapping_add(1);
2210 let mut buffer = Vec::new();
2211 invoice_request.write(&mut buffer).unwrap();
2213 match InvoiceRequest::try_from(buffer) {
2214 Ok(_) => panic!("expected error"),
2216 assert_eq!(e, Bolt12ParseError::InvalidSignature(secp256k1::Error::InvalidSignature));
2222 fn fails_parsing_invoice_request_with_extra_tlv_records() {
2223 let secp_ctx = Secp256k1::new();
2224 let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
2225 let invoice_request = OfferBuilder::new("foo".into(), keys.public_key())
2228 .request_invoice(vec![1; 32], keys.public_key()).unwrap()
2230 .sign(|message: &UnsignedInvoiceRequest|
2231 Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
2235 let mut encoded_invoice_request = Vec::new();
2236 invoice_request.write(&mut encoded_invoice_request).unwrap();
2237 BigSize(1002).write(&mut encoded_invoice_request).unwrap();
2238 BigSize(32).write(&mut encoded_invoice_request).unwrap();
2239 [42u8; 32].write(&mut encoded_invoice_request).unwrap();
2241 match InvoiceRequest::try_from(encoded_invoice_request) {
2242 Ok(_) => panic!("expected error"),
2243 Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),
2248 fn copies_verified_invoice_request_fields() {
2249 let desc = "foo".to_string();
2250 let node_id = recipient_pubkey();
2251 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
2252 let entropy = FixedEntropy {};
2253 let secp_ctx = Secp256k1::new();
2256 use crate::offers::offer::OfferWithDerivedMetadataBuilder as OfferBuilder;
2257 let offer = OfferBuilder
2258 ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
2259 .chain(Network::Testnet)
2261 .supported_quantity(Quantity::Unbounded)
2263 assert_eq!(offer.signing_pubkey(), node_id);
2265 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2266 .chain(Network::Testnet).unwrap()
2267 .amount_msats(1001).unwrap()
2268 .quantity(1).unwrap()
2269 .payer_note("0".repeat(PAYER_NOTE_LIMIT * 2))
2271 .sign(payer_sign).unwrap();
2272 match invoice_request.verify(&expanded_key, &secp_ctx) {
2273 Ok(invoice_request) => {
2274 let fields = invoice_request.fields();
2275 assert_eq!(invoice_request.offer_id, offer.id());
2278 InvoiceRequestFields {
2279 payer_id: payer_pubkey(),
2280 amount_msats: Some(1001),
2281 features: InvoiceRequestFeatures::empty(),
2283 payer_note_truncated: Some(UntrustedString("0".repeat(PAYER_NOTE_LIMIT))),
2287 let mut buffer = Vec::new();
2288 fields.write(&mut buffer).unwrap();
2290 let deserialized_fields: InvoiceRequestFields =
2291 Readable::read(&mut buffer.as_slice()).unwrap();
2292 assert_eq!(deserialized_fields, fields);
2294 Err(_) => panic!("unexpected error"),