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` messages.
12 //! A [`Bolt12Invoice`] can be built from a parsed [`InvoiceRequest`] for the "offer to be paid"
13 //! flow or from a [`Refund`] as an "offer for money" flow. The expected recipient of the payment
14 //! then sends the invoice to the intended payer, who will then pay it.
16 //! The payment recipient must include a [`PaymentHash`], so as to reveal the preimage upon payment
17 //! receipt, and one or more [`BlindedPath`]s for the payer to use when sending the payment.
20 //! extern crate bitcoin;
21 //! extern crate lightning;
23 //! use bitcoin::hashes::Hash;
24 //! use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, SecretKey};
25 //! use core::convert::TryFrom;
26 //! use lightning::offers::invoice::UnsignedBolt12Invoice;
27 //! use lightning::offers::invoice_request::InvoiceRequest;
28 //! use lightning::offers::refund::Refund;
29 //! use lightning::util::ser::Writeable;
31 //! # use lightning::ln::PaymentHash;
32 //! # use lightning::offers::invoice::{BlindedPayInfo, ExplicitSigningPubkey, InvoiceBuilder};
33 //! # use lightning::blinded_path::BlindedPath;
35 //! # fn create_payment_paths() -> Vec<(BlindedPayInfo, BlindedPath)> { unimplemented!() }
36 //! # fn create_payment_hash() -> PaymentHash { unimplemented!() }
38 //! # fn parse_invoice_request(bytes: Vec<u8>) -> Result<(), lightning::offers::parse::Bolt12ParseError> {
39 //! let payment_paths = create_payment_paths();
40 //! let payment_hash = create_payment_hash();
41 //! let secp_ctx = Secp256k1::new();
42 //! let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32])?);
43 //! let pubkey = PublicKey::from(keys);
44 //! let wpubkey_hash = bitcoin::key::PublicKey::new(pubkey).wpubkey_hash().unwrap();
45 //! let mut buffer = Vec::new();
47 //! // Invoice for the "offer to be paid" flow.
48 //! # <InvoiceBuilder<ExplicitSigningPubkey>>::from(
49 //! InvoiceRequest::try_from(bytes)?
50 #![cfg_attr(feature = "std", doc = "
51 .respond_with(payment_paths, payment_hash)?
53 #![cfg_attr(not(feature = "std"), doc = "
54 .respond_with_no_std(payment_paths, payment_hash, core::time::Duration::from_secs(0))?
57 //! .relative_expiry(3600)
59 //! .fallback_v0_p2wpkh(&wpubkey_hash)
61 //! .sign(|message: &UnsignedBolt12Invoice|
62 //! Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
64 //! .expect("failed verifying signature")
65 //! .write(&mut buffer)
70 //! # fn parse_refund(bytes: Vec<u8>) -> Result<(), lightning::offers::parse::Bolt12ParseError> {
71 //! # let payment_paths = create_payment_paths();
72 //! # let payment_hash = create_payment_hash();
73 //! # let secp_ctx = Secp256k1::new();
74 //! # let keys = KeyPair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32])?);
75 //! # let pubkey = PublicKey::from(keys);
76 //! # let wpubkey_hash = bitcoin::key::PublicKey::new(pubkey).wpubkey_hash().unwrap();
77 //! # let mut buffer = Vec::new();
79 //! // Invoice for the "offer for money" flow.
80 //! # <InvoiceBuilder<ExplicitSigningPubkey>>::from(
82 //! .parse::<Refund>()?
83 #![cfg_attr(feature = "std", doc = "
84 .respond_with(payment_paths, payment_hash, pubkey)?
86 #![cfg_attr(not(feature = "std"), doc = "
87 .respond_with_no_std(payment_paths, payment_hash, pubkey, core::time::Duration::from_secs(0))?
90 //! .relative_expiry(3600)
92 //! .fallback_v0_p2wpkh(&wpubkey_hash)
94 //! .sign(|message: &UnsignedBolt12Invoice|
95 //! Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
97 //! .expect("failed verifying signature")
98 //! .write(&mut buffer)
105 use bitcoin::blockdata::constants::ChainHash;
106 use bitcoin::hash_types::{WPubkeyHash, WScriptHash};
107 use bitcoin::network::constants::Network;
108 use bitcoin::secp256k1::{KeyPair, PublicKey, Secp256k1, self};
109 use bitcoin::secp256k1::schnorr::Signature;
110 use bitcoin::address::{Address, Payload, WitnessProgram, WitnessVersion};
111 use bitcoin::key::TweakedPublicKey;
112 use core::time::Duration;
113 use core::hash::{Hash, Hasher};
115 use crate::blinded_path::BlindedPath;
116 use crate::ln::PaymentHash;
117 use crate::ln::channelmanager::PaymentId;
118 use crate::ln::features::{BlindedHopFeatures, Bolt12InvoiceFeatures, InvoiceRequestFeatures, OfferFeatures};
119 use crate::ln::inbound_payment::ExpandedKey;
120 use crate::ln::msgs::DecodeError;
121 use crate::offers::invoice_request::{INVOICE_REQUEST_PAYER_ID_TYPE, INVOICE_REQUEST_TYPES, IV_BYTES as INVOICE_REQUEST_IV_BYTES, InvoiceRequest, InvoiceRequestContents, InvoiceRequestTlvStream, InvoiceRequestTlvStreamRef};
122 use crate::offers::merkle::{SignError, SignFn, SignatureTlvStream, SignatureTlvStreamRef, TaggedHash, TlvStream, WithoutSignatures, self};
123 use crate::offers::offer::{Amount, OFFER_TYPES, OfferTlvStream, OfferTlvStreamRef, Quantity};
124 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError, ParsedMessage};
125 use crate::offers::payer::{PAYER_METADATA_TYPE, PayerTlvStream, PayerTlvStreamRef};
126 use crate::offers::refund::{IV_BYTES as REFUND_IV_BYTES, Refund, RefundContents};
127 use crate::offers::signer;
128 use crate::util::ser::{HighZeroBytesDroppedBigSize, Iterable, SeekReadable, WithoutLength, Writeable, Writer};
129 use crate::util::string::PrintableString;
131 #[allow(unused_imports)]
132 use crate::prelude::*;
134 #[cfg(feature = "std")]
135 use std::time::SystemTime;
137 pub(crate) const DEFAULT_RELATIVE_EXPIRY: Duration = Duration::from_secs(7200);
139 /// Tag for the hash function used when signing a [`Bolt12Invoice`]'s merkle root.
140 pub const SIGNATURE_TAG: &'static str = concat!("lightning", "invoice", "signature");
142 /// Builds a [`Bolt12Invoice`] from either:
143 /// - an [`InvoiceRequest`] for the "offer to be paid" flow or
144 /// - a [`Refund`] for the "offer for money" flow.
146 /// See [module-level documentation] for usage.
148 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
150 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
151 /// [`Refund`]: crate::offers::refund::Refund
152 /// [module-level documentation]: self
153 pub struct InvoiceBuilder<'a, S: SigningPubkeyStrategy> {
154 invreq_bytes: &'a Vec<u8>,
155 invoice: InvoiceContents,
156 signing_pubkey_strategy: S,
159 /// Builds a [`Bolt12Invoice`] from either:
160 /// - an [`InvoiceRequest`] for the "offer to be paid" flow or
161 /// - a [`Refund`] for the "offer for money" flow.
163 /// See [module-level documentation] for usage.
165 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
166 /// [`Refund`]: crate::offers::refund::Refund
167 /// [module-level documentation]: self
169 pub struct InvoiceWithExplicitSigningPubkeyBuilder<'a> {
170 invreq_bytes: &'a Vec<u8>,
171 invoice: InvoiceContents,
172 signing_pubkey_strategy: ExplicitSigningPubkey,
175 /// Builds a [`Bolt12Invoice`] from either:
176 /// - an [`InvoiceRequest`] for the "offer to be paid" flow or
177 /// - a [`Refund`] for the "offer for money" flow.
179 /// See [module-level documentation] for usage.
181 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
182 /// [`Refund`]: crate::offers::refund::Refund
183 /// [module-level documentation]: self
185 pub struct InvoiceWithDerivedSigningPubkeyBuilder<'a> {
186 invreq_bytes: &'a Vec<u8>,
187 invoice: InvoiceContents,
188 signing_pubkey_strategy: DerivedSigningPubkey,
191 /// Indicates how [`Bolt12Invoice::signing_pubkey`] was set.
193 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
194 pub trait SigningPubkeyStrategy {}
196 /// [`Bolt12Invoice::signing_pubkey`] was explicitly set.
198 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
199 pub struct ExplicitSigningPubkey {}
201 /// [`Bolt12Invoice::signing_pubkey`] was derived.
203 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
204 pub struct DerivedSigningPubkey(KeyPair);
206 impl SigningPubkeyStrategy for ExplicitSigningPubkey {}
207 impl SigningPubkeyStrategy for DerivedSigningPubkey {}
209 macro_rules! invoice_explicit_signing_pubkey_builder_methods { ($self: ident, $self_type: ty) => {
210 #[cfg_attr(c_bindings, allow(dead_code))]
211 pub(super) fn for_offer(
212 invoice_request: &'a InvoiceRequest, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
213 created_at: Duration, payment_hash: PaymentHash
214 ) -> Result<Self, Bolt12SemanticError> {
215 let amount_msats = Self::amount_msats(invoice_request)?;
216 let signing_pubkey = invoice_request.contents.inner.offer.signing_pubkey();
217 let contents = InvoiceContents::ForOffer {
218 invoice_request: invoice_request.contents.clone(),
219 fields: Self::fields(
220 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
224 Self::new(&invoice_request.bytes, contents, ExplicitSigningPubkey {})
227 #[cfg_attr(c_bindings, allow(dead_code))]
228 pub(super) fn for_refund(
229 refund: &'a Refund, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
230 payment_hash: PaymentHash, signing_pubkey: PublicKey
231 ) -> Result<Self, Bolt12SemanticError> {
232 let amount_msats = refund.amount_msats();
233 let contents = InvoiceContents::ForRefund {
234 refund: refund.contents.clone(),
235 fields: Self::fields(
236 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
240 Self::new(&refund.bytes, contents, ExplicitSigningPubkey {})
243 /// Builds an unsigned [`Bolt12Invoice`] after checking for valid semantics. It can be signed by
244 /// [`UnsignedBolt12Invoice::sign`].
245 pub fn build($self: $self_type) -> Result<UnsignedBolt12Invoice, Bolt12SemanticError> {
246 #[cfg(feature = "std")] {
247 if $self.invoice.is_offer_or_refund_expired() {
248 return Err(Bolt12SemanticError::AlreadyExpired);
252 #[cfg(not(feature = "std"))] {
253 if $self.invoice.is_offer_or_refund_expired_no_std($self.invoice.created_at()) {
254 return Err(Bolt12SemanticError::AlreadyExpired);
258 let Self { invreq_bytes, invoice, .. } = $self;
259 #[cfg(not(c_bindings))] {
260 Ok(UnsignedBolt12Invoice::new(invreq_bytes, invoice))
263 Ok(UnsignedBolt12Invoice::new(invreq_bytes, invoice.clone()))
268 macro_rules! invoice_derived_signing_pubkey_builder_methods { ($self: ident, $self_type: ty) => {
269 #[cfg_attr(c_bindings, allow(dead_code))]
270 pub(super) fn for_offer_using_keys(
271 invoice_request: &'a InvoiceRequest, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
272 created_at: Duration, payment_hash: PaymentHash, keys: KeyPair
273 ) -> Result<Self, Bolt12SemanticError> {
274 let amount_msats = Self::amount_msats(invoice_request)?;
275 let signing_pubkey = invoice_request.contents.inner.offer.signing_pubkey();
276 let contents = InvoiceContents::ForOffer {
277 invoice_request: invoice_request.contents.clone(),
278 fields: Self::fields(
279 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
283 Self::new(&invoice_request.bytes, contents, DerivedSigningPubkey(keys))
286 #[cfg_attr(c_bindings, allow(dead_code))]
287 pub(super) fn for_refund_using_keys(
288 refund: &'a Refund, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
289 payment_hash: PaymentHash, keys: KeyPair,
290 ) -> Result<Self, Bolt12SemanticError> {
291 let amount_msats = refund.amount_msats();
292 let signing_pubkey = keys.public_key();
293 let contents = InvoiceContents::ForRefund {
294 refund: refund.contents.clone(),
295 fields: Self::fields(
296 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
300 Self::new(&refund.bytes, contents, DerivedSigningPubkey(keys))
303 /// Builds a signed [`Bolt12Invoice`] after checking for valid semantics.
304 pub fn build_and_sign<T: secp256k1::Signing>(
305 $self: $self_type, secp_ctx: &Secp256k1<T>
306 ) -> Result<Bolt12Invoice, Bolt12SemanticError> {
307 #[cfg(feature = "std")] {
308 if $self.invoice.is_offer_or_refund_expired() {
309 return Err(Bolt12SemanticError::AlreadyExpired);
313 #[cfg(not(feature = "std"))] {
314 if $self.invoice.is_offer_or_refund_expired_no_std($self.invoice.created_at()) {
315 return Err(Bolt12SemanticError::AlreadyExpired);
320 invreq_bytes, invoice, signing_pubkey_strategy: DerivedSigningPubkey(keys)
322 #[cfg(not(c_bindings))]
323 let unsigned_invoice = UnsignedBolt12Invoice::new(invreq_bytes, invoice);
325 let mut unsigned_invoice = UnsignedBolt12Invoice::new(invreq_bytes, invoice.clone());
327 let invoice = unsigned_invoice
328 .sign(|message: &UnsignedBolt12Invoice|
329 Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
336 macro_rules! invoice_builder_methods { (
337 $self: ident, $self_type: ty, $return_type: ty, $return_value: expr, $type_param: ty $(, $self_mut: tt)?
339 pub(crate) fn amount_msats(
340 invoice_request: &InvoiceRequest
341 ) -> Result<u64, Bolt12SemanticError> {
342 match invoice_request.amount_msats() {
343 Some(amount_msats) => Ok(amount_msats),
344 None => match invoice_request.contents.inner.offer.amount() {
345 Some(Amount::Bitcoin { amount_msats }) => {
346 amount_msats.checked_mul(invoice_request.quantity().unwrap_or(1))
347 .ok_or(Bolt12SemanticError::InvalidAmount)
349 Some(Amount::Currency { .. }) => Err(Bolt12SemanticError::UnsupportedCurrency),
350 None => Err(Bolt12SemanticError::MissingAmount),
355 #[cfg_attr(c_bindings, allow(dead_code))]
357 payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
358 payment_hash: PaymentHash, amount_msats: u64, signing_pubkey: PublicKey
361 payment_paths, created_at, relative_expiry: None, payment_hash, amount_msats,
362 fallbacks: None, features: Bolt12InvoiceFeatures::empty(), signing_pubkey,
366 #[cfg_attr(c_bindings, allow(dead_code))]
368 invreq_bytes: &'a Vec<u8>, contents: InvoiceContents, signing_pubkey_strategy: $type_param
369 ) -> Result<Self, Bolt12SemanticError> {
370 if contents.fields().payment_paths.is_empty() {
371 return Err(Bolt12SemanticError::MissingPaths);
374 Ok(Self { invreq_bytes, invoice: contents, signing_pubkey_strategy })
377 /// Sets the [`Bolt12Invoice::relative_expiry`] as seconds since [`Bolt12Invoice::created_at`].
378 /// Any expiry that has already passed is valid and can be checked for using
379 /// [`Bolt12Invoice::is_expired`].
381 /// Successive calls to this method will override the previous setting.
382 pub fn relative_expiry($($self_mut)* $self: $self_type, relative_expiry_secs: u32) -> $return_type {
383 let relative_expiry = Duration::from_secs(relative_expiry_secs as u64);
384 $self.invoice.fields_mut().relative_expiry = Some(relative_expiry);
388 /// Adds a P2WSH address to [`Bolt12Invoice::fallbacks`].
390 /// Successive calls to this method will add another address. Caller is responsible for not
391 /// adding duplicate addresses and only calling if capable of receiving to P2WSH addresses.
392 pub fn fallback_v0_p2wsh($($self_mut)* $self: $self_type, script_hash: &WScriptHash) -> $return_type {
393 use bitcoin::hashes::Hash;
394 let address = FallbackAddress {
395 version: WitnessVersion::V0.to_num(),
396 program: Vec::from(script_hash.to_byte_array()),
398 $self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
402 /// Adds a P2WPKH address to [`Bolt12Invoice::fallbacks`].
404 /// Successive calls to this method will add another address. Caller is responsible for not
405 /// adding duplicate addresses and only calling if capable of receiving to P2WPKH addresses.
406 pub fn fallback_v0_p2wpkh($($self_mut)* $self: $self_type, pubkey_hash: &WPubkeyHash) -> $return_type {
407 use bitcoin::hashes::Hash;
408 let address = FallbackAddress {
409 version: WitnessVersion::V0.to_num(),
410 program: Vec::from(pubkey_hash.to_byte_array()),
412 $self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
416 /// Adds a P2TR address to [`Bolt12Invoice::fallbacks`].
418 /// Successive calls to this method will add another address. Caller is responsible for not
419 /// adding duplicate addresses and only calling if capable of receiving to P2TR addresses.
420 pub fn fallback_v1_p2tr_tweaked($($self_mut)* $self: $self_type, output_key: &TweakedPublicKey) -> $return_type {
421 let address = FallbackAddress {
422 version: WitnessVersion::V1.to_num(),
423 program: Vec::from(&output_key.serialize()[..]),
425 $self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
429 /// Sets [`Bolt12Invoice::invoice_features`] to indicate MPP may be used. Otherwise, MPP is
431 pub fn allow_mpp($($self_mut)* $self: $self_type) -> $return_type {
432 $self.invoice.fields_mut().features.set_basic_mpp_optional();
437 impl<'a> InvoiceBuilder<'a, ExplicitSigningPubkey> {
438 invoice_explicit_signing_pubkey_builder_methods!(self, Self);
441 impl<'a> InvoiceBuilder<'a, DerivedSigningPubkey> {
442 invoice_derived_signing_pubkey_builder_methods!(self, Self);
445 impl<'a, S: SigningPubkeyStrategy> InvoiceBuilder<'a, S> {
446 invoice_builder_methods!(self, Self, Self, self, S, mut);
449 #[cfg(all(c_bindings, not(test)))]
450 impl<'a> InvoiceWithExplicitSigningPubkeyBuilder<'a> {
451 invoice_explicit_signing_pubkey_builder_methods!(self, &mut Self);
452 invoice_builder_methods!(self, &mut Self, (), (), ExplicitSigningPubkey);
455 #[cfg(all(c_bindings, test))]
456 impl<'a> InvoiceWithExplicitSigningPubkeyBuilder<'a> {
457 invoice_explicit_signing_pubkey_builder_methods!(self, &mut Self);
458 invoice_builder_methods!(self, &mut Self, &mut Self, self, ExplicitSigningPubkey);
461 #[cfg(all(c_bindings, not(test)))]
462 impl<'a> InvoiceWithDerivedSigningPubkeyBuilder<'a> {
463 invoice_derived_signing_pubkey_builder_methods!(self, &mut Self);
464 invoice_builder_methods!(self, &mut Self, (), (), DerivedSigningPubkey);
467 #[cfg(all(c_bindings, test))]
468 impl<'a> InvoiceWithDerivedSigningPubkeyBuilder<'a> {
469 invoice_derived_signing_pubkey_builder_methods!(self, &mut Self);
470 invoice_builder_methods!(self, &mut Self, &mut Self, self, DerivedSigningPubkey);
474 impl<'a> From<InvoiceWithExplicitSigningPubkeyBuilder<'a>>
475 for InvoiceBuilder<'a, ExplicitSigningPubkey> {
476 fn from(builder: InvoiceWithExplicitSigningPubkeyBuilder<'a>) -> Self {
477 let InvoiceWithExplicitSigningPubkeyBuilder {
478 invreq_bytes, invoice, signing_pubkey_strategy,
482 invreq_bytes, invoice, signing_pubkey_strategy,
488 impl<'a> From<InvoiceWithDerivedSigningPubkeyBuilder<'a>>
489 for InvoiceBuilder<'a, DerivedSigningPubkey> {
490 fn from(builder: InvoiceWithDerivedSigningPubkeyBuilder<'a>) -> Self {
491 let InvoiceWithDerivedSigningPubkeyBuilder {
492 invreq_bytes, invoice, signing_pubkey_strategy,
496 invreq_bytes, invoice, signing_pubkey_strategy,
501 /// A semantically valid [`Bolt12Invoice`] that hasn't been signed.
505 /// This is serialized as a TLV stream, which includes TLV records from the originating message. As
506 /// such, it may include unknown, odd TLV records.
507 pub struct UnsignedBolt12Invoice {
509 contents: InvoiceContents,
510 tagged_hash: TaggedHash,
513 /// A function for signing an [`UnsignedBolt12Invoice`].
514 pub trait SignBolt12InvoiceFn {
515 /// Signs a [`TaggedHash`] computed over the merkle root of `message`'s TLV stream.
516 fn sign_invoice(&self, message: &UnsignedBolt12Invoice) -> Result<Signature, ()>;
519 impl<F> SignBolt12InvoiceFn for F
521 F: Fn(&UnsignedBolt12Invoice) -> Result<Signature, ()>,
523 fn sign_invoice(&self, message: &UnsignedBolt12Invoice) -> Result<Signature, ()> {
528 impl<F> SignFn<UnsignedBolt12Invoice> for F
530 F: SignBolt12InvoiceFn,
532 fn sign(&self, message: &UnsignedBolt12Invoice) -> Result<Signature, ()> {
533 self.sign_invoice(message)
537 impl UnsignedBolt12Invoice {
538 fn new(invreq_bytes: &[u8], contents: InvoiceContents) -> Self {
539 // Use the invoice_request bytes instead of the invoice_request TLV stream as the latter may
540 // have contained unknown TLV records, which are not stored in `InvoiceRequestContents` or
542 let (_, _, _, invoice_tlv_stream) = contents.as_tlv_stream();
543 let invoice_request_bytes = WithoutSignatures(invreq_bytes);
544 let unsigned_tlv_stream = (invoice_request_bytes, invoice_tlv_stream);
546 let mut bytes = Vec::new();
547 unsigned_tlv_stream.write(&mut bytes).unwrap();
549 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
551 Self { bytes, contents, tagged_hash }
554 /// Returns the [`TaggedHash`] of the invoice to sign.
555 pub fn tagged_hash(&self) -> &TaggedHash {
560 macro_rules! unsigned_invoice_sign_method { ($self: ident, $self_type: ty $(, $self_mut: tt)?) => {
561 /// Signs the [`TaggedHash`] of the invoice using the given function.
563 /// Note: The hash computation may have included unknown, odd TLV records.
564 pub fn sign<F: SignBolt12InvoiceFn>(
565 $($self_mut)* $self: $self_type, sign: F
566 ) -> Result<Bolt12Invoice, SignError> {
567 let pubkey = $self.contents.fields().signing_pubkey;
568 let signature = merkle::sign_message(sign, &$self, pubkey)?;
570 // Append the signature TLV record to the bytes.
571 let signature_tlv_stream = SignatureTlvStreamRef {
572 signature: Some(&signature),
574 signature_tlv_stream.write(&mut $self.bytes).unwrap();
577 #[cfg(not(c_bindings))]
580 bytes: $self.bytes.clone(),
581 #[cfg(not(c_bindings))]
582 contents: $self.contents,
584 contents: $self.contents.clone(),
586 #[cfg(not(c_bindings))]
587 tagged_hash: $self.tagged_hash,
589 tagged_hash: $self.tagged_hash.clone(),
594 #[cfg(not(c_bindings))]
595 impl UnsignedBolt12Invoice {
596 unsigned_invoice_sign_method!(self, Self, mut);
600 impl UnsignedBolt12Invoice {
601 unsigned_invoice_sign_method!(self, &mut Self);
604 impl AsRef<TaggedHash> for UnsignedBolt12Invoice {
605 fn as_ref(&self) -> &TaggedHash {
610 /// A `Bolt12Invoice` is a payment request, typically corresponding to an [`Offer`] or a [`Refund`].
612 /// An invoice may be sent in response to an [`InvoiceRequest`] in the case of an offer or sent
613 /// directly after scanning a refund. It includes all the information needed to pay a recipient.
615 /// [`Offer`]: crate::offers::offer::Offer
616 /// [`Refund`]: crate::offers::refund::Refund
617 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
618 #[derive(Clone, Debug)]
619 pub struct Bolt12Invoice {
621 contents: InvoiceContents,
622 signature: Signature,
623 tagged_hash: TaggedHash,
626 /// The contents of an [`Bolt12Invoice`] for responding to either an [`Offer`] or a [`Refund`].
628 /// [`Offer`]: crate::offers::offer::Offer
629 /// [`Refund`]: crate::offers::refund::Refund
630 #[derive(Clone, Debug)]
631 #[cfg_attr(test, derive(PartialEq))]
632 enum InvoiceContents {
633 /// Contents for an [`Bolt12Invoice`] corresponding to an [`Offer`].
635 /// [`Offer`]: crate::offers::offer::Offer
637 invoice_request: InvoiceRequestContents,
638 fields: InvoiceFields,
640 /// Contents for an [`Bolt12Invoice`] corresponding to a [`Refund`].
642 /// [`Refund`]: crate::offers::refund::Refund
644 refund: RefundContents,
645 fields: InvoiceFields,
649 /// Invoice-specific fields for an `invoice` message.
650 #[derive(Clone, Debug, PartialEq)]
651 struct InvoiceFields {
652 payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
653 created_at: Duration,
654 relative_expiry: Option<Duration>,
655 payment_hash: PaymentHash,
657 fallbacks: Option<Vec<FallbackAddress>>,
658 features: Bolt12InvoiceFeatures,
659 signing_pubkey: PublicKey,
662 macro_rules! invoice_accessors { ($self: ident, $contents: expr) => {
663 /// The chains that may be used when paying a requested invoice.
665 /// From [`Offer::chains`]; `None` if the invoice was created in response to a [`Refund`].
667 /// [`Offer::chains`]: crate::offers::offer::Offer::chains
668 pub fn offer_chains(&$self) -> Option<Vec<ChainHash>> {
669 $contents.offer_chains()
672 /// The chain that must be used when paying the invoice; selected from [`offer_chains`] if the
673 /// invoice originated from an offer.
675 /// From [`InvoiceRequest::chain`] or [`Refund::chain`].
677 /// [`offer_chains`]: Self::offer_chains
678 /// [`InvoiceRequest::chain`]: crate::offers::invoice_request::InvoiceRequest::chain
679 pub fn chain(&$self) -> ChainHash {
683 /// Opaque bytes set by the originating [`Offer`].
685 /// From [`Offer::metadata`]; `None` if the invoice was created in response to a [`Refund`] or
686 /// if the [`Offer`] did not set it.
688 /// [`Offer`]: crate::offers::offer::Offer
689 /// [`Offer::metadata`]: crate::offers::offer::Offer::metadata
690 pub fn metadata(&$self) -> Option<&Vec<u8>> {
694 /// The minimum amount required for a successful payment of a single item.
696 /// From [`Offer::amount`]; `None` if the invoice was created in response to a [`Refund`] or if
697 /// the [`Offer`] did not set it.
699 /// [`Offer`]: crate::offers::offer::Offer
700 /// [`Offer::amount`]: crate::offers::offer::Offer::amount
701 pub fn amount(&$self) -> Option<&Amount> {
705 /// Features pertaining to the originating [`Offer`].
707 /// From [`Offer::offer_features`]; `None` if the invoice was created in response to a
710 /// [`Offer`]: crate::offers::offer::Offer
711 /// [`Offer::offer_features`]: crate::offers::offer::Offer::offer_features
712 pub fn offer_features(&$self) -> Option<&OfferFeatures> {
713 $contents.offer_features()
716 /// A complete description of the purpose of the originating offer or refund.
718 /// From [`Offer::description`] or [`Refund::description`].
720 /// [`Offer::description`]: crate::offers::offer::Offer::description
721 pub fn description(&$self) -> PrintableString {
722 $contents.description()
725 /// Duration since the Unix epoch when an invoice should no longer be requested.
727 /// From [`Offer::absolute_expiry`] or [`Refund::absolute_expiry`].
729 /// [`Offer::absolute_expiry`]: crate::offers::offer::Offer::absolute_expiry
730 pub fn absolute_expiry(&$self) -> Option<Duration> {
731 $contents.absolute_expiry()
734 /// The issuer of the offer or refund.
736 /// From [`Offer::issuer`] or [`Refund::issuer`].
738 /// [`Offer::issuer`]: crate::offers::offer::Offer::issuer
739 pub fn issuer(&$self) -> Option<PrintableString> {
743 /// Paths to the recipient originating from publicly reachable nodes.
745 /// From [`Offer::paths`] or [`Refund::paths`].
747 /// [`Offer::paths`]: crate::offers::offer::Offer::paths
748 pub fn message_paths(&$self) -> &[BlindedPath] {
749 $contents.message_paths()
752 /// The quantity of items supported.
754 /// From [`Offer::supported_quantity`]; `None` if the invoice was created in response to a
757 /// [`Offer::supported_quantity`]: crate::offers::offer::Offer::supported_quantity
758 pub fn supported_quantity(&$self) -> Option<Quantity> {
759 $contents.supported_quantity()
762 /// An unpredictable series of bytes from the payer.
764 /// From [`InvoiceRequest::payer_metadata`] or [`Refund::payer_metadata`].
765 pub fn payer_metadata(&$self) -> &[u8] {
766 $contents.payer_metadata()
769 /// Features pertaining to requesting an invoice.
771 /// From [`InvoiceRequest::invoice_request_features`] or [`Refund::features`].
772 pub fn invoice_request_features(&$self) -> &InvoiceRequestFeatures {
773 &$contents.invoice_request_features()
776 /// The quantity of items requested or refunded for.
778 /// From [`InvoiceRequest::quantity`] or [`Refund::quantity`].
779 pub fn quantity(&$self) -> Option<u64> {
783 /// A possibly transient pubkey used to sign the invoice request or to send an invoice for a
784 /// refund in case there are no [`message_paths`].
786 /// [`message_paths`]: Self::message_paths
787 pub fn payer_id(&$self) -> PublicKey {
791 /// A payer-provided note reflected back in the invoice.
793 /// From [`InvoiceRequest::payer_note`] or [`Refund::payer_note`].
794 pub fn payer_note(&$self) -> Option<PrintableString> {
795 $contents.payer_note()
798 /// Paths to the recipient originating from publicly reachable nodes, including information
799 /// needed for routing payments across them.
801 /// Blinded paths provide recipient privacy by obfuscating its node id. Note, however, that this
802 /// privacy is lost if a public node id is used for [`Bolt12Invoice::signing_pubkey`].
804 /// This is not exported to bindings users as slices with non-reference types cannot be ABI
805 /// matched in another language.
806 pub fn payment_paths(&$self) -> &[(BlindedPayInfo, BlindedPath)] {
807 $contents.payment_paths()
810 /// Duration since the Unix epoch when the invoice was created.
811 pub fn created_at(&$self) -> Duration {
812 $contents.created_at()
815 /// Duration since [`Bolt12Invoice::created_at`] when the invoice has expired and therefore
816 /// should no longer be paid.
817 pub fn relative_expiry(&$self) -> Duration {
818 $contents.relative_expiry()
821 /// Whether the invoice has expired.
822 #[cfg(feature = "std")]
823 pub fn is_expired(&$self) -> bool {
824 $contents.is_expired()
827 /// SHA256 hash of the payment preimage that will be given in return for paying the invoice.
828 pub fn payment_hash(&$self) -> PaymentHash {
829 $contents.payment_hash()
832 /// The minimum amount required for a successful payment of the invoice.
833 pub fn amount_msats(&$self) -> u64 {
834 $contents.amount_msats()
837 /// Fallback addresses for paying the invoice on-chain, in order of most-preferred to
839 pub fn fallbacks(&$self) -> Vec<Address> {
840 $contents.fallbacks()
843 /// Features pertaining to paying an invoice.
844 pub fn invoice_features(&$self) -> &Bolt12InvoiceFeatures {
848 /// The public key corresponding to the key used to sign the invoice.
849 pub fn signing_pubkey(&$self) -> PublicKey {
850 $contents.signing_pubkey()
854 impl UnsignedBolt12Invoice {
855 invoice_accessors!(self, self.contents);
859 invoice_accessors!(self, self.contents);
861 /// Signature of the invoice verified using [`Bolt12Invoice::signing_pubkey`].
862 pub fn signature(&self) -> Signature {
866 /// Hash that was used for signing the invoice.
867 pub fn signable_hash(&self) -> [u8; 32] {
868 self.tagged_hash.as_digest().as_ref().clone()
871 /// Verifies that the invoice was for a request or refund created using the given key. Returns
872 /// the associated [`PaymentId`] to use when sending the payment.
873 pub fn verify<T: secp256k1::Signing>(
874 &self, key: &ExpandedKey, secp_ctx: &Secp256k1<T>
875 ) -> Result<PaymentId, ()> {
876 self.contents.verify(TlvStream::new(&self.bytes), key, secp_ctx)
879 pub(crate) fn as_tlv_stream(&self) -> FullInvoiceTlvStreamRef {
880 let (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream) =
881 self.contents.as_tlv_stream();
882 let signature_tlv_stream = SignatureTlvStreamRef {
883 signature: Some(&self.signature),
885 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
886 signature_tlv_stream)
890 impl PartialEq for Bolt12Invoice {
891 fn eq(&self, other: &Self) -> bool {
892 self.bytes.eq(&other.bytes)
896 impl Eq for Bolt12Invoice {}
898 impl Hash for Bolt12Invoice {
899 fn hash<H: Hasher>(&self, state: &mut H) {
900 self.bytes.hash(state);
904 impl InvoiceContents {
905 /// Whether the original offer or refund has expired.
906 #[cfg(feature = "std")]
907 fn is_offer_or_refund_expired(&self) -> bool {
909 InvoiceContents::ForOffer { invoice_request, .. } =>
910 invoice_request.inner.offer.is_expired(),
911 InvoiceContents::ForRefund { refund, .. } => refund.is_expired(),
915 #[cfg(not(feature = "std"))]
916 fn is_offer_or_refund_expired_no_std(&self, duration_since_epoch: Duration) -> bool {
918 InvoiceContents::ForOffer { invoice_request, .. } =>
919 invoice_request.inner.offer.is_expired_no_std(duration_since_epoch),
920 InvoiceContents::ForRefund { refund, .. } =>
921 refund.is_expired_no_std(duration_since_epoch),
925 fn offer_chains(&self) -> Option<Vec<ChainHash>> {
927 InvoiceContents::ForOffer { invoice_request, .. } =>
928 Some(invoice_request.inner.offer.chains()),
929 InvoiceContents::ForRefund { .. } => None,
933 fn chain(&self) -> ChainHash {
935 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.chain(),
936 InvoiceContents::ForRefund { refund, .. } => refund.chain(),
940 fn metadata(&self) -> Option<&Vec<u8>> {
942 InvoiceContents::ForOffer { invoice_request, .. } =>
943 invoice_request.inner.offer.metadata(),
944 InvoiceContents::ForRefund { .. } => None,
948 fn amount(&self) -> Option<&Amount> {
950 InvoiceContents::ForOffer { invoice_request, .. } =>
951 invoice_request.inner.offer.amount(),
952 InvoiceContents::ForRefund { .. } => None,
956 fn description(&self) -> PrintableString {
958 InvoiceContents::ForOffer { invoice_request, .. } => {
959 invoice_request.inner.offer.description()
961 InvoiceContents::ForRefund { refund, .. } => refund.description(),
965 fn offer_features(&self) -> Option<&OfferFeatures> {
967 InvoiceContents::ForOffer { invoice_request, .. } => {
968 Some(invoice_request.inner.offer.features())
970 InvoiceContents::ForRefund { .. } => None,
974 fn absolute_expiry(&self) -> Option<Duration> {
976 InvoiceContents::ForOffer { invoice_request, .. } => {
977 invoice_request.inner.offer.absolute_expiry()
979 InvoiceContents::ForRefund { refund, .. } => refund.absolute_expiry(),
983 fn issuer(&self) -> Option<PrintableString> {
985 InvoiceContents::ForOffer { invoice_request, .. } => {
986 invoice_request.inner.offer.issuer()
988 InvoiceContents::ForRefund { refund, .. } => refund.issuer(),
992 fn message_paths(&self) -> &[BlindedPath] {
994 InvoiceContents::ForOffer { invoice_request, .. } => {
995 invoice_request.inner.offer.paths()
997 InvoiceContents::ForRefund { refund, .. } => refund.paths(),
1001 fn supported_quantity(&self) -> Option<Quantity> {
1003 InvoiceContents::ForOffer { invoice_request, .. } => {
1004 Some(invoice_request.inner.offer.supported_quantity())
1006 InvoiceContents::ForRefund { .. } => None,
1010 fn payer_metadata(&self) -> &[u8] {
1012 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.metadata(),
1013 InvoiceContents::ForRefund { refund, .. } => refund.metadata(),
1017 fn invoice_request_features(&self) -> &InvoiceRequestFeatures {
1019 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.features(),
1020 InvoiceContents::ForRefund { refund, .. } => refund.features(),
1024 fn quantity(&self) -> Option<u64> {
1026 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.quantity(),
1027 InvoiceContents::ForRefund { refund, .. } => refund.quantity(),
1031 fn payer_id(&self) -> PublicKey {
1033 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.payer_id(),
1034 InvoiceContents::ForRefund { refund, .. } => refund.payer_id(),
1038 fn payer_note(&self) -> Option<PrintableString> {
1040 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.payer_note(),
1041 InvoiceContents::ForRefund { refund, .. } => refund.payer_note(),
1045 fn payment_paths(&self) -> &[(BlindedPayInfo, BlindedPath)] {
1046 &self.fields().payment_paths[..]
1049 fn created_at(&self) -> Duration {
1050 self.fields().created_at
1053 fn relative_expiry(&self) -> Duration {
1054 self.fields().relative_expiry.unwrap_or(DEFAULT_RELATIVE_EXPIRY)
1057 #[cfg(feature = "std")]
1058 fn is_expired(&self) -> bool {
1059 let absolute_expiry = self.created_at().checked_add(self.relative_expiry());
1060 match absolute_expiry {
1061 Some(seconds_from_epoch) => match SystemTime::UNIX_EPOCH.elapsed() {
1062 Ok(elapsed) => elapsed > seconds_from_epoch,
1069 fn payment_hash(&self) -> PaymentHash {
1070 self.fields().payment_hash
1073 fn amount_msats(&self) -> u64 {
1074 self.fields().amount_msats
1077 fn fallbacks(&self) -> Vec<Address> {
1078 let chain = self.chain();
1079 let network = if chain == ChainHash::using_genesis_block(Network::Bitcoin) {
1081 } else if chain == ChainHash::using_genesis_block(Network::Testnet) {
1083 } else if chain == ChainHash::using_genesis_block(Network::Signet) {
1085 } else if chain == ChainHash::using_genesis_block(Network::Regtest) {
1091 let to_valid_address = |address: &FallbackAddress| {
1092 let version = match WitnessVersion::try_from(address.version) {
1093 Ok(version) => version,
1094 Err(_) => return None,
1097 let program = &address.program;
1098 let witness_program = match WitnessProgram::new(version, program.clone()) {
1099 Ok(witness_program) => witness_program,
1100 Err(_) => return None,
1102 Some(Address::new(network, Payload::WitnessProgram(witness_program)))
1105 self.fields().fallbacks
1107 .map(|fallbacks| fallbacks.iter().filter_map(to_valid_address).collect())
1108 .unwrap_or_else(Vec::new)
1111 fn features(&self) -> &Bolt12InvoiceFeatures {
1112 &self.fields().features
1115 fn signing_pubkey(&self) -> PublicKey {
1116 self.fields().signing_pubkey
1119 fn fields(&self) -> &InvoiceFields {
1121 InvoiceContents::ForOffer { fields, .. } => fields,
1122 InvoiceContents::ForRefund { fields, .. } => fields,
1126 fn fields_mut(&mut self) -> &mut InvoiceFields {
1128 InvoiceContents::ForOffer { fields, .. } => fields,
1129 InvoiceContents::ForRefund { fields, .. } => fields,
1133 fn verify<T: secp256k1::Signing>(
1134 &self, tlv_stream: TlvStream<'_>, key: &ExpandedKey, secp_ctx: &Secp256k1<T>
1135 ) -> Result<PaymentId, ()> {
1136 let offer_records = tlv_stream.clone().range(OFFER_TYPES);
1137 let invreq_records = tlv_stream.range(INVOICE_REQUEST_TYPES).filter(|record| {
1138 match record.r#type {
1139 PAYER_METADATA_TYPE => false, // Should be outside range
1140 INVOICE_REQUEST_PAYER_ID_TYPE => !self.derives_keys(),
1144 let tlv_stream = offer_records.chain(invreq_records);
1146 let (metadata, payer_id, iv_bytes) = match self {
1147 InvoiceContents::ForOffer { invoice_request, .. } => {
1148 (invoice_request.metadata(), invoice_request.payer_id(), INVOICE_REQUEST_IV_BYTES)
1150 InvoiceContents::ForRefund { refund, .. } => {
1151 (refund.metadata(), refund.payer_id(), REFUND_IV_BYTES)
1155 signer::verify_payer_metadata(metadata, key, iv_bytes, payer_id, tlv_stream, secp_ctx)
1158 fn derives_keys(&self) -> bool {
1160 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.derives_keys(),
1161 InvoiceContents::ForRefund { refund, .. } => refund.derives_keys(),
1165 fn as_tlv_stream(&self) -> PartialInvoiceTlvStreamRef {
1166 let (payer, offer, invoice_request) = match self {
1167 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.as_tlv_stream(),
1168 InvoiceContents::ForRefund { refund, .. } => refund.as_tlv_stream(),
1170 let invoice = self.fields().as_tlv_stream();
1172 (payer, offer, invoice_request, invoice)
1176 impl InvoiceFields {
1177 fn as_tlv_stream(&self) -> InvoiceTlvStreamRef {
1179 if self.features == Bolt12InvoiceFeatures::empty() { None }
1180 else { Some(&self.features) }
1183 InvoiceTlvStreamRef {
1184 paths: Some(Iterable(self.payment_paths.iter().map(|(_, path)| path))),
1185 blindedpay: Some(Iterable(self.payment_paths.iter().map(|(payinfo, _)| payinfo))),
1186 created_at: Some(self.created_at.as_secs()),
1187 relative_expiry: self.relative_expiry.map(|duration| duration.as_secs() as u32),
1188 payment_hash: Some(&self.payment_hash),
1189 amount: Some(self.amount_msats),
1190 fallbacks: self.fallbacks.as_ref(),
1192 node_id: Some(&self.signing_pubkey),
1197 impl Writeable for UnsignedBolt12Invoice {
1198 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1199 WithoutLength(&self.bytes).write(writer)
1203 impl Writeable for Bolt12Invoice {
1204 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1205 WithoutLength(&self.bytes).write(writer)
1209 impl Writeable for InvoiceContents {
1210 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1211 self.as_tlv_stream().write(writer)
1215 impl TryFrom<Vec<u8>> for UnsignedBolt12Invoice {
1216 type Error = Bolt12ParseError;
1218 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1219 let invoice = ParsedMessage::<PartialInvoiceTlvStream>::try_from(bytes)?;
1220 let ParsedMessage { bytes, tlv_stream } = invoice;
1222 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1224 let contents = InvoiceContents::try_from(
1225 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream)
1228 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
1230 Ok(UnsignedBolt12Invoice { bytes, contents, tagged_hash })
1234 impl TryFrom<Vec<u8>> for Bolt12Invoice {
1235 type Error = Bolt12ParseError;
1237 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1238 let parsed_invoice = ParsedMessage::<FullInvoiceTlvStream>::try_from(bytes)?;
1239 Bolt12Invoice::try_from(parsed_invoice)
1243 tlv_stream!(InvoiceTlvStream, InvoiceTlvStreamRef, 160..240, {
1244 (160, paths: (Vec<BlindedPath>, WithoutLength, Iterable<'a, BlindedPathIter<'a>, BlindedPath>)),
1245 (162, blindedpay: (Vec<BlindedPayInfo>, WithoutLength, Iterable<'a, BlindedPayInfoIter<'a>, BlindedPayInfo>)),
1246 (164, created_at: (u64, HighZeroBytesDroppedBigSize)),
1247 (166, relative_expiry: (u32, HighZeroBytesDroppedBigSize)),
1248 (168, payment_hash: PaymentHash),
1249 (170, amount: (u64, HighZeroBytesDroppedBigSize)),
1250 (172, fallbacks: (Vec<FallbackAddress>, WithoutLength)),
1251 (174, features: (Bolt12InvoiceFeatures, WithoutLength)),
1252 (176, node_id: PublicKey),
1255 type BlindedPathIter<'a> = core::iter::Map<
1256 core::slice::Iter<'a, (BlindedPayInfo, BlindedPath)>,
1257 for<'r> fn(&'r (BlindedPayInfo, BlindedPath)) -> &'r BlindedPath,
1260 type BlindedPayInfoIter<'a> = core::iter::Map<
1261 core::slice::Iter<'a, (BlindedPayInfo, BlindedPath)>,
1262 for<'r> fn(&'r (BlindedPayInfo, BlindedPath)) -> &'r BlindedPayInfo,
1265 /// Information needed to route a payment across a [`BlindedPath`].
1266 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
1267 pub struct BlindedPayInfo {
1268 /// Base fee charged (in millisatoshi) for the entire blinded path.
1269 pub fee_base_msat: u32,
1271 /// Liquidity fee charged (in millionths of the amount transferred) for the entire blinded path
1272 /// (i.e., 10,000 is 1%).
1273 pub fee_proportional_millionths: u32,
1275 /// Number of blocks subtracted from an incoming HTLC's `cltv_expiry` for the entire blinded
1277 pub cltv_expiry_delta: u16,
1279 /// The minimum HTLC value (in millisatoshi) that is acceptable to all channel peers on the
1280 /// blinded path from the introduction node to the recipient, accounting for any fees, i.e., as
1281 /// seen by the recipient.
1282 pub htlc_minimum_msat: u64,
1284 /// The maximum HTLC value (in millisatoshi) that is acceptable to all channel peers on the
1285 /// blinded path from the introduction node to the recipient, accounting for any fees, i.e., as
1286 /// seen by the recipient.
1287 pub htlc_maximum_msat: u64,
1289 /// Features set in `encrypted_data_tlv` for the `encrypted_recipient_data` TLV record in an
1291 pub features: BlindedHopFeatures,
1294 impl_writeable!(BlindedPayInfo, {
1296 fee_proportional_millionths,
1303 /// Wire representation for an on-chain fallback address.
1304 #[derive(Clone, Debug, PartialEq)]
1305 pub(super) struct FallbackAddress {
1310 impl_writeable!(FallbackAddress, { version, program });
1312 type FullInvoiceTlvStream =
1313 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream, SignatureTlvStream);
1315 type FullInvoiceTlvStreamRef<'a> = (
1316 PayerTlvStreamRef<'a>,
1317 OfferTlvStreamRef<'a>,
1318 InvoiceRequestTlvStreamRef<'a>,
1319 InvoiceTlvStreamRef<'a>,
1320 SignatureTlvStreamRef<'a>,
1323 impl SeekReadable for FullInvoiceTlvStream {
1324 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1325 let payer = SeekReadable::read(r)?;
1326 let offer = SeekReadable::read(r)?;
1327 let invoice_request = SeekReadable::read(r)?;
1328 let invoice = SeekReadable::read(r)?;
1329 let signature = SeekReadable::read(r)?;
1331 Ok((payer, offer, invoice_request, invoice, signature))
1335 type PartialInvoiceTlvStream =
1336 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream);
1338 type PartialInvoiceTlvStreamRef<'a> = (
1339 PayerTlvStreamRef<'a>,
1340 OfferTlvStreamRef<'a>,
1341 InvoiceRequestTlvStreamRef<'a>,
1342 InvoiceTlvStreamRef<'a>,
1345 impl SeekReadable for PartialInvoiceTlvStream {
1346 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1347 let payer = SeekReadable::read(r)?;
1348 let offer = SeekReadable::read(r)?;
1349 let invoice_request = SeekReadable::read(r)?;
1350 let invoice = SeekReadable::read(r)?;
1352 Ok((payer, offer, invoice_request, invoice))
1356 impl TryFrom<ParsedMessage<FullInvoiceTlvStream>> for Bolt12Invoice {
1357 type Error = Bolt12ParseError;
1359 fn try_from(invoice: ParsedMessage<FullInvoiceTlvStream>) -> Result<Self, Self::Error> {
1360 let ParsedMessage { bytes, tlv_stream } = invoice;
1362 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1363 SignatureTlvStream { signature },
1365 let contents = InvoiceContents::try_from(
1366 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream)
1369 let signature = match signature {
1370 None => return Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
1371 Some(signature) => signature,
1373 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
1374 let pubkey = contents.fields().signing_pubkey;
1375 merkle::verify_signature(&signature, &tagged_hash, pubkey)?;
1377 Ok(Bolt12Invoice { bytes, contents, signature, tagged_hash })
1381 impl TryFrom<PartialInvoiceTlvStream> for InvoiceContents {
1382 type Error = Bolt12SemanticError;
1384 fn try_from(tlv_stream: PartialInvoiceTlvStream) -> Result<Self, Self::Error> {
1388 invoice_request_tlv_stream,
1390 paths, blindedpay, created_at, relative_expiry, payment_hash, amount, fallbacks,
1395 let payment_paths = match (blindedpay, paths) {
1396 (_, None) => return Err(Bolt12SemanticError::MissingPaths),
1397 (None, _) => return Err(Bolt12SemanticError::InvalidPayInfo),
1398 (_, Some(paths)) if paths.is_empty() => return Err(Bolt12SemanticError::MissingPaths),
1399 (Some(blindedpay), Some(paths)) if paths.len() != blindedpay.len() => {
1400 return Err(Bolt12SemanticError::InvalidPayInfo);
1402 (Some(blindedpay), Some(paths)) => {
1403 blindedpay.into_iter().zip(paths.into_iter()).collect::<Vec<_>>()
1407 let created_at = match created_at {
1408 None => return Err(Bolt12SemanticError::MissingCreationTime),
1409 Some(timestamp) => Duration::from_secs(timestamp),
1412 let relative_expiry = relative_expiry
1413 .map(Into::<u64>::into)
1414 .map(Duration::from_secs);
1416 let payment_hash = match payment_hash {
1417 None => return Err(Bolt12SemanticError::MissingPaymentHash),
1418 Some(payment_hash) => payment_hash,
1421 let amount_msats = match amount {
1422 None => return Err(Bolt12SemanticError::MissingAmount),
1423 Some(amount) => amount,
1426 let features = features.unwrap_or_else(Bolt12InvoiceFeatures::empty);
1428 let signing_pubkey = match node_id {
1429 None => return Err(Bolt12SemanticError::MissingSigningPubkey),
1430 Some(node_id) => node_id,
1433 let fields = InvoiceFields {
1434 payment_paths, created_at, relative_expiry, payment_hash, amount_msats, fallbacks,
1435 features, signing_pubkey,
1438 match offer_tlv_stream.node_id {
1439 Some(expected_signing_pubkey) => {
1440 if fields.signing_pubkey != expected_signing_pubkey {
1441 return Err(Bolt12SemanticError::InvalidSigningPubkey);
1444 let invoice_request = InvoiceRequestContents::try_from(
1445 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1447 Ok(InvoiceContents::ForOffer { invoice_request, fields })
1450 let refund = RefundContents::try_from(
1451 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1453 Ok(InvoiceContents::ForRefund { refund, fields })
1461 use super::{Bolt12Invoice, DEFAULT_RELATIVE_EXPIRY, FallbackAddress, FullInvoiceTlvStreamRef, InvoiceTlvStreamRef, SIGNATURE_TAG, UnsignedBolt12Invoice};
1463 use bitcoin::blockdata::constants::ChainHash;
1464 use bitcoin::blockdata::script::ScriptBuf;
1465 use bitcoin::hashes::Hash;
1466 use bitcoin::network::constants::Network;
1467 use bitcoin::secp256k1::{Message, Secp256k1, XOnlyPublicKey, self};
1468 use bitcoin::address::{Address, Payload, WitnessProgram, WitnessVersion};
1469 use bitcoin::key::TweakedPublicKey;
1471 use core::time::Duration;
1473 use crate::blinded_path::{BlindedHop, BlindedPath, IntroductionNode};
1474 use crate::sign::KeyMaterial;
1475 use crate::ln::features::{Bolt12InvoiceFeatures, InvoiceRequestFeatures, OfferFeatures};
1476 use crate::ln::inbound_payment::ExpandedKey;
1477 use crate::ln::msgs::DecodeError;
1478 use crate::offers::invoice_request::InvoiceRequestTlvStreamRef;
1479 use crate::offers::merkle::{SignError, SignatureTlvStreamRef, TaggedHash, self};
1480 use crate::offers::offer::{Amount, OfferTlvStreamRef, Quantity};
1481 use crate::prelude::*;
1482 #[cfg(not(c_bindings))]
1484 crate::offers::offer::OfferBuilder,
1485 crate::offers::refund::RefundBuilder,
1489 crate::offers::offer::OfferWithExplicitMetadataBuilder as OfferBuilder,
1490 crate::offers::refund::RefundMaybeWithDerivedMetadataBuilder as RefundBuilder,
1492 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
1493 use crate::offers::payer::PayerTlvStreamRef;
1494 use crate::offers::test_utils::*;
1495 use crate::util::ser::{BigSize, Iterable, Writeable};
1496 use crate::util::string::PrintableString;
1499 fn to_bytes(&self) -> Vec<u8>;
1502 impl<'a> ToBytes for FullInvoiceTlvStreamRef<'a> {
1503 fn to_bytes(&self) -> Vec<u8> {
1504 let mut buffer = Vec::new();
1505 self.0.write(&mut buffer).unwrap();
1506 self.1.write(&mut buffer).unwrap();
1507 self.2.write(&mut buffer).unwrap();
1508 self.3.write(&mut buffer).unwrap();
1509 self.4.write(&mut buffer).unwrap();
1515 fn builds_invoice_for_offer_with_defaults() {
1516 let payment_paths = payment_paths();
1517 let payment_hash = payment_hash();
1519 let unsigned_invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1522 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1524 .sign(payer_sign).unwrap()
1525 .respond_with_no_std(payment_paths.clone(), payment_hash, now).unwrap()
1528 let mut buffer = Vec::new();
1529 unsigned_invoice.write(&mut buffer).unwrap();
1531 assert_eq!(unsigned_invoice.bytes, buffer.as_slice());
1532 assert_eq!(unsigned_invoice.payer_metadata(), &[1; 32]);
1533 assert_eq!(unsigned_invoice.offer_chains(), Some(vec![ChainHash::using_genesis_block(Network::Bitcoin)]));
1534 assert_eq!(unsigned_invoice.metadata(), None);
1535 assert_eq!(unsigned_invoice.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1536 assert_eq!(unsigned_invoice.description(), PrintableString("foo"));
1537 assert_eq!(unsigned_invoice.offer_features(), Some(&OfferFeatures::empty()));
1538 assert_eq!(unsigned_invoice.absolute_expiry(), None);
1539 assert_eq!(unsigned_invoice.message_paths(), &[]);
1540 assert_eq!(unsigned_invoice.issuer(), None);
1541 assert_eq!(unsigned_invoice.supported_quantity(), Some(Quantity::One));
1542 assert_eq!(unsigned_invoice.signing_pubkey(), recipient_pubkey());
1543 assert_eq!(unsigned_invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1544 assert_eq!(unsigned_invoice.amount_msats(), 1000);
1545 assert_eq!(unsigned_invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1546 assert_eq!(unsigned_invoice.quantity(), None);
1547 assert_eq!(unsigned_invoice.payer_id(), payer_pubkey());
1548 assert_eq!(unsigned_invoice.payer_note(), None);
1549 assert_eq!(unsigned_invoice.payment_paths(), payment_paths.as_slice());
1550 assert_eq!(unsigned_invoice.created_at(), now);
1551 assert_eq!(unsigned_invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1552 #[cfg(feature = "std")]
1553 assert!(!unsigned_invoice.is_expired());
1554 assert_eq!(unsigned_invoice.payment_hash(), payment_hash);
1555 assert_eq!(unsigned_invoice.amount_msats(), 1000);
1556 assert_eq!(unsigned_invoice.fallbacks(), vec![]);
1557 assert_eq!(unsigned_invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1558 assert_eq!(unsigned_invoice.signing_pubkey(), recipient_pubkey());
1560 match UnsignedBolt12Invoice::try_from(buffer) {
1561 Err(e) => panic!("error parsing unsigned invoice: {:?}", e),
1563 assert_eq!(parsed.bytes, unsigned_invoice.bytes);
1564 assert_eq!(parsed.tagged_hash, unsigned_invoice.tagged_hash);
1569 let mut unsigned_invoice = unsigned_invoice;
1570 let invoice = unsigned_invoice.sign(recipient_sign).unwrap();
1572 let mut buffer = Vec::new();
1573 invoice.write(&mut buffer).unwrap();
1575 assert_eq!(invoice.bytes, buffer.as_slice());
1576 assert_eq!(invoice.payer_metadata(), &[1; 32]);
1577 assert_eq!(invoice.offer_chains(), Some(vec![ChainHash::using_genesis_block(Network::Bitcoin)]));
1578 assert_eq!(invoice.metadata(), None);
1579 assert_eq!(invoice.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1580 assert_eq!(invoice.description(), PrintableString("foo"));
1581 assert_eq!(invoice.offer_features(), Some(&OfferFeatures::empty()));
1582 assert_eq!(invoice.absolute_expiry(), None);
1583 assert_eq!(invoice.message_paths(), &[]);
1584 assert_eq!(invoice.issuer(), None);
1585 assert_eq!(invoice.supported_quantity(), Some(Quantity::One));
1586 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1587 assert_eq!(invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1588 assert_eq!(invoice.amount_msats(), 1000);
1589 assert_eq!(invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1590 assert_eq!(invoice.quantity(), None);
1591 assert_eq!(invoice.payer_id(), payer_pubkey());
1592 assert_eq!(invoice.payer_note(), None);
1593 assert_eq!(invoice.payment_paths(), payment_paths.as_slice());
1594 assert_eq!(invoice.created_at(), now);
1595 assert_eq!(invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1596 #[cfg(feature = "std")]
1597 assert!(!invoice.is_expired());
1598 assert_eq!(invoice.payment_hash(), payment_hash);
1599 assert_eq!(invoice.amount_msats(), 1000);
1600 assert_eq!(invoice.fallbacks(), vec![]);
1601 assert_eq!(invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1602 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1604 let message = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &invoice.bytes);
1605 assert!(merkle::verify_signature(&invoice.signature, &message, recipient_pubkey()).is_ok());
1607 let digest = Message::from_slice(&invoice.signable_hash()).unwrap();
1608 let pubkey = recipient_pubkey().into();
1609 let secp_ctx = Secp256k1::verification_only();
1610 assert!(secp_ctx.verify_schnorr(&invoice.signature, &digest, &pubkey).is_ok());
1613 invoice.as_tlv_stream(),
1615 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1621 description: Some(&String::from("foo")),
1623 absolute_expiry: None,
1627 node_id: Some(&recipient_pubkey()),
1629 InvoiceRequestTlvStreamRef {
1634 payer_id: Some(&payer_pubkey()),
1637 InvoiceTlvStreamRef {
1638 paths: Some(Iterable(payment_paths.iter().map(|(_, path)| path))),
1639 blindedpay: Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo))),
1640 created_at: Some(now.as_secs()),
1641 relative_expiry: None,
1642 payment_hash: Some(&payment_hash),
1646 node_id: Some(&recipient_pubkey()),
1648 SignatureTlvStreamRef { signature: Some(&invoice.signature()) },
1652 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1653 panic!("error parsing invoice: {:?}", e);
1658 fn builds_invoice_for_refund_with_defaults() {
1659 let payment_paths = payment_paths();
1660 let payment_hash = payment_hash();
1662 let invoice = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1664 .respond_with_no_std(payment_paths.clone(), payment_hash, recipient_pubkey(), now)
1667 .sign(recipient_sign).unwrap();
1669 let mut buffer = Vec::new();
1670 invoice.write(&mut buffer).unwrap();
1672 assert_eq!(invoice.bytes, buffer.as_slice());
1673 assert_eq!(invoice.payer_metadata(), &[1; 32]);
1674 assert_eq!(invoice.offer_chains(), None);
1675 assert_eq!(invoice.metadata(), None);
1676 assert_eq!(invoice.amount(), None);
1677 assert_eq!(invoice.description(), PrintableString("foo"));
1678 assert_eq!(invoice.offer_features(), None);
1679 assert_eq!(invoice.absolute_expiry(), None);
1680 assert_eq!(invoice.message_paths(), &[]);
1681 assert_eq!(invoice.issuer(), None);
1682 assert_eq!(invoice.supported_quantity(), None);
1683 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1684 assert_eq!(invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1685 assert_eq!(invoice.amount_msats(), 1000);
1686 assert_eq!(invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1687 assert_eq!(invoice.quantity(), None);
1688 assert_eq!(invoice.payer_id(), payer_pubkey());
1689 assert_eq!(invoice.payer_note(), None);
1690 assert_eq!(invoice.payment_paths(), payment_paths.as_slice());
1691 assert_eq!(invoice.created_at(), now);
1692 assert_eq!(invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1693 #[cfg(feature = "std")]
1694 assert!(!invoice.is_expired());
1695 assert_eq!(invoice.payment_hash(), payment_hash);
1696 assert_eq!(invoice.amount_msats(), 1000);
1697 assert_eq!(invoice.fallbacks(), vec![]);
1698 assert_eq!(invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1699 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1701 let message = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &invoice.bytes);
1702 assert!(merkle::verify_signature(&invoice.signature, &message, recipient_pubkey()).is_ok());
1705 invoice.as_tlv_stream(),
1707 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1713 description: Some(&String::from("foo")),
1715 absolute_expiry: None,
1721 InvoiceRequestTlvStreamRef {
1726 payer_id: Some(&payer_pubkey()),
1729 InvoiceTlvStreamRef {
1730 paths: Some(Iterable(payment_paths.iter().map(|(_, path)| path))),
1731 blindedpay: Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo))),
1732 created_at: Some(now.as_secs()),
1733 relative_expiry: None,
1734 payment_hash: Some(&payment_hash),
1738 node_id: Some(&recipient_pubkey()),
1740 SignatureTlvStreamRef { signature: Some(&invoice.signature()) },
1744 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1745 panic!("error parsing invoice: {:?}", e);
1749 #[cfg(feature = "std")]
1751 fn builds_invoice_from_offer_with_expiration() {
1752 let future_expiry = Duration::from_secs(u64::max_value());
1753 let past_expiry = Duration::from_secs(0);
1755 if let Err(e) = OfferBuilder::new("foo".into(), recipient_pubkey())
1757 .absolute_expiry(future_expiry)
1759 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1761 .sign(payer_sign).unwrap()
1762 .respond_with(payment_paths(), payment_hash())
1766 panic!("error building invoice: {:?}", e);
1769 match OfferBuilder::new("foo".into(), recipient_pubkey())
1771 .absolute_expiry(past_expiry)
1773 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1775 .sign(payer_sign).unwrap()
1776 .respond_with(payment_paths(), payment_hash())
1780 Ok(_) => panic!("expected error"),
1781 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1785 #[cfg(feature = "std")]
1787 fn builds_invoice_from_refund_with_expiration() {
1788 let future_expiry = Duration::from_secs(u64::max_value());
1789 let past_expiry = Duration::from_secs(0);
1791 if let Err(e) = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1792 .absolute_expiry(future_expiry)
1794 .respond_with(payment_paths(), payment_hash(), recipient_pubkey())
1798 panic!("error building invoice: {:?}", e);
1801 match RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1802 .absolute_expiry(past_expiry)
1804 .respond_with(payment_paths(), payment_hash(), recipient_pubkey())
1808 Ok(_) => panic!("expected error"),
1809 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1814 fn builds_invoice_from_offer_using_derived_keys() {
1815 let desc = "foo".to_string();
1816 let node_id = recipient_pubkey();
1817 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1818 let entropy = FixedEntropy {};
1819 let secp_ctx = Secp256k1::new();
1821 let blinded_path = BlindedPath {
1822 introduction_node: IntroductionNode::NodeId(pubkey(40)),
1823 blinding_point: pubkey(41),
1825 BlindedHop { blinded_node_id: pubkey(42), encrypted_payload: vec![0; 43] },
1826 BlindedHop { blinded_node_id: node_id, encrypted_payload: vec![0; 44] },
1831 use crate::offers::offer::OfferWithDerivedMetadataBuilder as OfferBuilder;
1832 let offer = OfferBuilder
1833 ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
1837 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1839 .sign(payer_sign).unwrap();
1841 if let Err(e) = invoice_request.clone()
1842 .verify(&expanded_key, &secp_ctx).unwrap()
1843 .respond_using_derived_keys_no_std(payment_paths(), payment_hash(), now()).unwrap()
1844 .build_and_sign(&secp_ctx)
1846 panic!("error building invoice: {:?}", e);
1849 let expanded_key = ExpandedKey::new(&KeyMaterial([41; 32]));
1850 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_err());
1852 let desc = "foo".to_string();
1853 let offer = OfferBuilder
1854 ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
1856 // Omit the path so that node_id is used for the signing pubkey instead of deriving
1858 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1860 .sign(payer_sign).unwrap();
1862 match invoice_request
1863 .verify(&expanded_key, &secp_ctx).unwrap()
1864 .respond_using_derived_keys_no_std(payment_paths(), payment_hash(), now())
1866 Ok(_) => panic!("expected error"),
1867 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidMetadata),
1872 fn builds_invoice_from_refund_using_derived_keys() {
1873 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1874 let entropy = FixedEntropy {};
1875 let secp_ctx = Secp256k1::new();
1877 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1880 if let Err(e) = refund
1881 .respond_using_derived_keys_no_std(
1882 payment_paths(), payment_hash(), now(), &expanded_key, &entropy
1885 .build_and_sign(&secp_ctx)
1887 panic!("error building invoice: {:?}", e);
1892 fn builds_invoice_with_relative_expiry() {
1894 let one_hour = Duration::from_secs(3600);
1896 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1899 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1901 .sign(payer_sign).unwrap()
1902 .respond_with_no_std(payment_paths(), payment_hash(), now).unwrap()
1903 .relative_expiry(one_hour.as_secs() as u32)
1905 .sign(recipient_sign).unwrap();
1906 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1907 #[cfg(feature = "std")]
1908 assert!(!invoice.is_expired());
1909 assert_eq!(invoice.relative_expiry(), one_hour);
1910 assert_eq!(tlv_stream.relative_expiry, Some(one_hour.as_secs() as u32));
1912 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1915 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1917 .sign(payer_sign).unwrap()
1918 .respond_with_no_std(payment_paths(), payment_hash(), now - one_hour).unwrap()
1919 .relative_expiry(one_hour.as_secs() as u32 - 1)
1921 .sign(recipient_sign).unwrap();
1922 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1923 #[cfg(feature = "std")]
1924 assert!(invoice.is_expired());
1925 assert_eq!(invoice.relative_expiry(), one_hour - Duration::from_secs(1));
1926 assert_eq!(tlv_stream.relative_expiry, Some(one_hour.as_secs() as u32 - 1));
1930 fn builds_invoice_with_amount_from_request() {
1931 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1934 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1935 .amount_msats(1001).unwrap()
1937 .sign(payer_sign).unwrap()
1938 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1940 .sign(recipient_sign).unwrap();
1941 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1942 assert_eq!(invoice.amount_msats(), 1001);
1943 assert_eq!(tlv_stream.amount, Some(1001));
1947 fn builds_invoice_with_quantity_from_request() {
1948 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1950 .supported_quantity(Quantity::Unbounded)
1952 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1953 .quantity(2).unwrap()
1955 .sign(payer_sign).unwrap()
1956 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1958 .sign(recipient_sign).unwrap();
1959 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1960 assert_eq!(invoice.amount_msats(), 2000);
1961 assert_eq!(tlv_stream.amount, Some(2000));
1963 match OfferBuilder::new("foo".into(), recipient_pubkey())
1965 .supported_quantity(Quantity::Unbounded)
1967 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1968 .quantity(u64::max_value()).unwrap()
1970 .sign(payer_sign).unwrap()
1971 .respond_with_no_std(payment_paths(), payment_hash(), now())
1973 Ok(_) => panic!("expected error"),
1974 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1979 fn builds_invoice_with_fallback_address() {
1980 let script = ScriptBuf::new();
1981 let pubkey = bitcoin::key::PublicKey::new(recipient_pubkey());
1982 let x_only_pubkey = XOnlyPublicKey::from_keypair(&recipient_keys()).0;
1983 let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(x_only_pubkey);
1985 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1988 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1990 .sign(payer_sign).unwrap()
1991 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1992 .fallback_v0_p2wsh(&script.wscript_hash())
1993 .fallback_v0_p2wpkh(&pubkey.wpubkey_hash().unwrap())
1994 .fallback_v1_p2tr_tweaked(&tweaked_pubkey)
1996 .sign(recipient_sign).unwrap();
1997 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1999 invoice.fallbacks(),
2001 Address::p2wsh(&script, Network::Bitcoin),
2002 Address::p2wpkh(&pubkey, Network::Bitcoin).unwrap(),
2003 Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin),
2007 tlv_stream.fallbacks,
2010 version: WitnessVersion::V0.to_num(),
2011 program: Vec::from(script.wscript_hash().to_byte_array()),
2014 version: WitnessVersion::V0.to_num(),
2015 program: Vec::from(pubkey.wpubkey_hash().unwrap().to_byte_array()),
2018 version: WitnessVersion::V1.to_num(),
2019 program: Vec::from(&tweaked_pubkey.serialize()[..]),
2026 fn builds_invoice_with_allow_mpp() {
2027 let mut features = Bolt12InvoiceFeatures::empty();
2028 features.set_basic_mpp_optional();
2030 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2033 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2035 .sign(payer_sign).unwrap()
2036 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2039 .sign(recipient_sign).unwrap();
2040 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
2041 assert_eq!(invoice.invoice_features(), &features);
2042 assert_eq!(tlv_stream.features, Some(&features));
2046 fn fails_signing_invoice() {
2047 match OfferBuilder::new("foo".into(), recipient_pubkey())
2050 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2052 .sign(payer_sign).unwrap()
2053 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2057 Ok(_) => panic!("expected error"),
2058 Err(e) => assert_eq!(e, SignError::Signing),
2061 match OfferBuilder::new("foo".into(), recipient_pubkey())
2064 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2066 .sign(payer_sign).unwrap()
2067 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2071 Ok(_) => panic!("expected error"),
2072 Err(e) => assert_eq!(e, SignError::Verification(secp256k1::Error::InvalidSignature)),
2077 fn parses_invoice_with_payment_paths() {
2078 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2081 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2083 .sign(payer_sign).unwrap()
2084 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2086 .sign(recipient_sign).unwrap();
2088 let mut buffer = Vec::new();
2089 invoice.write(&mut buffer).unwrap();
2091 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2092 panic!("error parsing invoice: {:?}", e);
2095 let mut tlv_stream = invoice.as_tlv_stream();
2096 tlv_stream.3.paths = None;
2098 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2099 Ok(_) => panic!("expected error"),
2100 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaths)),
2103 let mut tlv_stream = invoice.as_tlv_stream();
2104 tlv_stream.3.blindedpay = None;
2106 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2107 Ok(_) => panic!("expected error"),
2108 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidPayInfo)),
2111 let empty_payment_paths = vec![];
2112 let mut tlv_stream = invoice.as_tlv_stream();
2113 tlv_stream.3.paths = Some(Iterable(empty_payment_paths.iter().map(|(_, path)| path)));
2115 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2116 Ok(_) => panic!("expected error"),
2117 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaths)),
2120 let mut payment_paths = payment_paths();
2121 payment_paths.pop();
2122 let mut tlv_stream = invoice.as_tlv_stream();
2123 tlv_stream.3.blindedpay = Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo)));
2125 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2126 Ok(_) => panic!("expected error"),
2127 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidPayInfo)),
2132 fn parses_invoice_with_created_at() {
2133 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2136 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2138 .sign(payer_sign).unwrap()
2139 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2141 .sign(recipient_sign).unwrap();
2143 let mut buffer = Vec::new();
2144 invoice.write(&mut buffer).unwrap();
2146 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2147 panic!("error parsing invoice: {:?}", e);
2150 let mut tlv_stream = invoice.as_tlv_stream();
2151 tlv_stream.3.created_at = None;
2153 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2154 Ok(_) => panic!("expected error"),
2156 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingCreationTime));
2162 fn parses_invoice_with_relative_expiry() {
2163 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2166 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2168 .sign(payer_sign).unwrap()
2169 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2170 .relative_expiry(3600)
2172 .sign(recipient_sign).unwrap();
2174 let mut buffer = Vec::new();
2175 invoice.write(&mut buffer).unwrap();
2177 match Bolt12Invoice::try_from(buffer) {
2178 Ok(invoice) => assert_eq!(invoice.relative_expiry(), Duration::from_secs(3600)),
2179 Err(e) => panic!("error parsing invoice: {:?}", e),
2184 fn parses_invoice_with_payment_hash() {
2185 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2188 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2190 .sign(payer_sign).unwrap()
2191 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2193 .sign(recipient_sign).unwrap();
2195 let mut buffer = Vec::new();
2196 invoice.write(&mut buffer).unwrap();
2198 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2199 panic!("error parsing invoice: {:?}", e);
2202 let mut tlv_stream = invoice.as_tlv_stream();
2203 tlv_stream.3.payment_hash = None;
2205 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2206 Ok(_) => panic!("expected error"),
2208 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaymentHash));
2214 fn parses_invoice_with_amount() {
2215 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2218 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2220 .sign(payer_sign).unwrap()
2221 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2223 .sign(recipient_sign).unwrap();
2225 let mut buffer = Vec::new();
2226 invoice.write(&mut buffer).unwrap();
2228 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2229 panic!("error parsing invoice: {:?}", e);
2232 let mut tlv_stream = invoice.as_tlv_stream();
2233 tlv_stream.3.amount = None;
2235 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2236 Ok(_) => panic!("expected error"),
2237 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount)),
2242 fn parses_invoice_with_allow_mpp() {
2243 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2246 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2248 .sign(payer_sign).unwrap()
2249 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2252 .sign(recipient_sign).unwrap();
2254 let mut buffer = Vec::new();
2255 invoice.write(&mut buffer).unwrap();
2257 match Bolt12Invoice::try_from(buffer) {
2259 let mut features = Bolt12InvoiceFeatures::empty();
2260 features.set_basic_mpp_optional();
2261 assert_eq!(invoice.invoice_features(), &features);
2263 Err(e) => panic!("error parsing invoice: {:?}", e),
2268 fn parses_invoice_with_fallback_address() {
2269 let script = ScriptBuf::new();
2270 let pubkey = bitcoin::key::PublicKey::new(recipient_pubkey());
2271 let x_only_pubkey = XOnlyPublicKey::from_keypair(&recipient_keys()).0;
2272 let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(x_only_pubkey);
2274 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
2277 let invoice_request = offer
2278 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2280 .sign(payer_sign).unwrap();
2281 #[cfg(not(c_bindings))]
2282 let invoice_builder = invoice_request
2283 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap();
2285 let mut invoice_builder = invoice_request
2286 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap();
2287 let invoice_builder = invoice_builder
2288 .fallback_v0_p2wsh(&script.wscript_hash())
2289 .fallback_v0_p2wpkh(&pubkey.wpubkey_hash().unwrap())
2290 .fallback_v1_p2tr_tweaked(&tweaked_pubkey);
2291 #[cfg(not(c_bindings))]
2292 let mut invoice_builder = invoice_builder;
2294 // Only standard addresses will be included.
2295 let fallbacks = invoice_builder.invoice.fields_mut().fallbacks.as_mut().unwrap();
2296 // Non-standard addresses
2297 fallbacks.push(FallbackAddress { version: 1, program: vec![0u8; 41] });
2298 fallbacks.push(FallbackAddress { version: 2, program: vec![0u8; 1] });
2299 fallbacks.push(FallbackAddress { version: 17, program: vec![0u8; 40] });
2301 fallbacks.push(FallbackAddress { version: 1, program: vec![0u8; 33] });
2302 fallbacks.push(FallbackAddress { version: 2, program: vec![0u8; 40] });
2304 let invoice = invoice_builder.build().unwrap().sign(recipient_sign).unwrap();
2305 let mut buffer = Vec::new();
2306 invoice.write(&mut buffer).unwrap();
2308 match Bolt12Invoice::try_from(buffer) {
2310 let v1_witness_program = WitnessProgram::new(WitnessVersion::V1, vec![0u8; 33]).unwrap();
2311 let v2_witness_program = WitnessProgram::new(WitnessVersion::V2, vec![0u8; 40]).unwrap();
2313 invoice.fallbacks(),
2315 Address::p2wsh(&script, Network::Bitcoin),
2316 Address::p2wpkh(&pubkey, Network::Bitcoin).unwrap(),
2317 Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin),
2318 Address::new(Network::Bitcoin, Payload::WitnessProgram(v1_witness_program)),
2319 Address::new(Network::Bitcoin, Payload::WitnessProgram(v2_witness_program)),
2323 Err(e) => panic!("error parsing invoice: {:?}", e),
2328 fn parses_invoice_with_node_id() {
2329 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2332 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2334 .sign(payer_sign).unwrap()
2335 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2337 .sign(recipient_sign).unwrap();
2339 let mut buffer = Vec::new();
2340 invoice.write(&mut buffer).unwrap();
2342 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2343 panic!("error parsing invoice: {:?}", e);
2346 let mut tlv_stream = invoice.as_tlv_stream();
2347 tlv_stream.3.node_id = None;
2349 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2350 Ok(_) => panic!("expected error"),
2352 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey));
2356 let invalid_pubkey = payer_pubkey();
2357 let mut tlv_stream = invoice.as_tlv_stream();
2358 tlv_stream.3.node_id = Some(&invalid_pubkey);
2360 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2361 Ok(_) => panic!("expected error"),
2363 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidSigningPubkey));
2369 fn fails_parsing_invoice_without_signature() {
2370 let mut buffer = Vec::new();
2371 OfferBuilder::new("foo".into(), recipient_pubkey())
2374 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2376 .sign(payer_sign).unwrap()
2377 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2380 .write(&mut buffer).unwrap();
2382 match Bolt12Invoice::try_from(buffer) {
2383 Ok(_) => panic!("expected error"),
2384 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
2389 fn fails_parsing_invoice_with_invalid_signature() {
2390 let mut invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2393 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2395 .sign(payer_sign).unwrap()
2396 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2398 .sign(recipient_sign).unwrap();
2399 let last_signature_byte = invoice.bytes.last_mut().unwrap();
2400 *last_signature_byte = last_signature_byte.wrapping_add(1);
2402 let mut buffer = Vec::new();
2403 invoice.write(&mut buffer).unwrap();
2405 match Bolt12Invoice::try_from(buffer) {
2406 Ok(_) => panic!("expected error"),
2408 assert_eq!(e, Bolt12ParseError::InvalidSignature(secp256k1::Error::InvalidSignature));
2414 fn fails_parsing_invoice_with_extra_tlv_records() {
2415 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2418 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2420 .sign(payer_sign).unwrap()
2421 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2423 .sign(recipient_sign).unwrap();
2425 let mut encoded_invoice = Vec::new();
2426 invoice.write(&mut encoded_invoice).unwrap();
2427 BigSize(1002).write(&mut encoded_invoice).unwrap();
2428 BigSize(32).write(&mut encoded_invoice).unwrap();
2429 [42u8; 32].write(&mut encoded_invoice).unwrap();
2431 match Bolt12Invoice::try_from(encoded_invoice) {
2432 Ok(_) => panic!("expected error"),
2433 Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),