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, signing_pubkey: PublicKey
214 ) -> Result<Self, Bolt12SemanticError> {
215 let amount_msats = Self::amount_msats(invoice_request)?;
216 let contents = InvoiceContents::ForOffer {
217 invoice_request: invoice_request.contents.clone(),
218 fields: Self::fields(
219 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
223 Self::new(&invoice_request.bytes, contents, ExplicitSigningPubkey {})
226 #[cfg_attr(c_bindings, allow(dead_code))]
227 pub(super) fn for_refund(
228 refund: &'a Refund, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
229 payment_hash: PaymentHash, signing_pubkey: PublicKey
230 ) -> Result<Self, Bolt12SemanticError> {
231 let amount_msats = refund.amount_msats();
232 let contents = InvoiceContents::ForRefund {
233 refund: refund.contents.clone(),
234 fields: Self::fields(
235 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
239 Self::new(&refund.bytes, contents, ExplicitSigningPubkey {})
242 /// Builds an unsigned [`Bolt12Invoice`] after checking for valid semantics. It can be signed by
243 /// [`UnsignedBolt12Invoice::sign`].
244 pub fn build($self: $self_type) -> Result<UnsignedBolt12Invoice, Bolt12SemanticError> {
245 #[cfg(feature = "std")] {
246 if $self.invoice.is_offer_or_refund_expired() {
247 return Err(Bolt12SemanticError::AlreadyExpired);
251 #[cfg(not(feature = "std"))] {
252 if $self.invoice.is_offer_or_refund_expired_no_std($self.invoice.created_at()) {
253 return Err(Bolt12SemanticError::AlreadyExpired);
257 let Self { invreq_bytes, invoice, .. } = $self;
258 #[cfg(not(c_bindings))] {
259 Ok(UnsignedBolt12Invoice::new(invreq_bytes, invoice))
262 Ok(UnsignedBolt12Invoice::new(invreq_bytes, invoice.clone()))
267 macro_rules! invoice_derived_signing_pubkey_builder_methods { ($self: ident, $self_type: ty) => {
268 #[cfg_attr(c_bindings, allow(dead_code))]
269 pub(super) fn for_offer_using_keys(
270 invoice_request: &'a InvoiceRequest, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
271 created_at: Duration, payment_hash: PaymentHash, keys: KeyPair
272 ) -> Result<Self, Bolt12SemanticError> {
273 let amount_msats = Self::amount_msats(invoice_request)?;
274 let signing_pubkey = keys.public_key();
275 let contents = InvoiceContents::ForOffer {
276 invoice_request: invoice_request.contents.clone(),
277 fields: Self::fields(
278 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
282 Self::new(&invoice_request.bytes, contents, DerivedSigningPubkey(keys))
285 #[cfg_attr(c_bindings, allow(dead_code))]
286 pub(super) fn for_refund_using_keys(
287 refund: &'a Refund, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
288 payment_hash: PaymentHash, keys: KeyPair,
289 ) -> Result<Self, Bolt12SemanticError> {
290 let amount_msats = refund.amount_msats();
291 let signing_pubkey = keys.public_key();
292 let contents = InvoiceContents::ForRefund {
293 refund: refund.contents.clone(),
294 fields: Self::fields(
295 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
299 Self::new(&refund.bytes, contents, DerivedSigningPubkey(keys))
302 /// Builds a signed [`Bolt12Invoice`] after checking for valid semantics.
303 pub fn build_and_sign<T: secp256k1::Signing>(
304 $self: $self_type, secp_ctx: &Secp256k1<T>
305 ) -> Result<Bolt12Invoice, Bolt12SemanticError> {
306 #[cfg(feature = "std")] {
307 if $self.invoice.is_offer_or_refund_expired() {
308 return Err(Bolt12SemanticError::AlreadyExpired);
312 #[cfg(not(feature = "std"))] {
313 if $self.invoice.is_offer_or_refund_expired_no_std($self.invoice.created_at()) {
314 return Err(Bolt12SemanticError::AlreadyExpired);
319 invreq_bytes, invoice, signing_pubkey_strategy: DerivedSigningPubkey(keys)
321 #[cfg(not(c_bindings))]
322 let unsigned_invoice = UnsignedBolt12Invoice::new(invreq_bytes, invoice);
324 let mut unsigned_invoice = UnsignedBolt12Invoice::new(invreq_bytes, invoice.clone());
326 let invoice = unsigned_invoice
327 .sign(|message: &UnsignedBolt12Invoice|
328 Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
335 macro_rules! invoice_builder_methods { (
336 $self: ident, $self_type: ty, $return_type: ty, $return_value: expr, $type_param: ty $(, $self_mut: tt)?
338 pub(crate) fn amount_msats(
339 invoice_request: &InvoiceRequest
340 ) -> Result<u64, Bolt12SemanticError> {
341 match invoice_request.amount_msats() {
342 Some(amount_msats) => Ok(amount_msats),
343 None => match invoice_request.contents.inner.offer.amount() {
344 Some(Amount::Bitcoin { amount_msats }) => {
345 amount_msats.checked_mul(invoice_request.quantity().unwrap_or(1))
346 .ok_or(Bolt12SemanticError::InvalidAmount)
348 Some(Amount::Currency { .. }) => Err(Bolt12SemanticError::UnsupportedCurrency),
349 None => Err(Bolt12SemanticError::MissingAmount),
354 #[cfg_attr(c_bindings, allow(dead_code))]
356 payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
357 payment_hash: PaymentHash, amount_msats: u64, signing_pubkey: PublicKey
360 payment_paths, created_at, relative_expiry: None, payment_hash, amount_msats,
361 fallbacks: None, features: Bolt12InvoiceFeatures::empty(), signing_pubkey,
365 #[cfg_attr(c_bindings, allow(dead_code))]
367 invreq_bytes: &'a Vec<u8>, contents: InvoiceContents, signing_pubkey_strategy: $type_param
368 ) -> Result<Self, Bolt12SemanticError> {
369 if contents.fields().payment_paths.is_empty() {
370 return Err(Bolt12SemanticError::MissingPaths);
373 Ok(Self { invreq_bytes, invoice: contents, signing_pubkey_strategy })
376 /// Sets the [`Bolt12Invoice::relative_expiry`] as seconds since [`Bolt12Invoice::created_at`].
377 /// Any expiry that has already passed is valid and can be checked for using
378 /// [`Bolt12Invoice::is_expired`].
380 /// Successive calls to this method will override the previous setting.
381 pub fn relative_expiry($($self_mut)* $self: $self_type, relative_expiry_secs: u32) -> $return_type {
382 let relative_expiry = Duration::from_secs(relative_expiry_secs as u64);
383 $self.invoice.fields_mut().relative_expiry = Some(relative_expiry);
387 /// Adds a P2WSH address to [`Bolt12Invoice::fallbacks`].
389 /// Successive calls to this method will add another address. Caller is responsible for not
390 /// adding duplicate addresses and only calling if capable of receiving to P2WSH addresses.
391 pub fn fallback_v0_p2wsh($($self_mut)* $self: $self_type, script_hash: &WScriptHash) -> $return_type {
392 use bitcoin::hashes::Hash;
393 let address = FallbackAddress {
394 version: WitnessVersion::V0.to_num(),
395 program: Vec::from(script_hash.to_byte_array()),
397 $self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
401 /// Adds a P2WPKH address to [`Bolt12Invoice::fallbacks`].
403 /// Successive calls to this method will add another address. Caller is responsible for not
404 /// adding duplicate addresses and only calling if capable of receiving to P2WPKH addresses.
405 pub fn fallback_v0_p2wpkh($($self_mut)* $self: $self_type, pubkey_hash: &WPubkeyHash) -> $return_type {
406 use bitcoin::hashes::Hash;
407 let address = FallbackAddress {
408 version: WitnessVersion::V0.to_num(),
409 program: Vec::from(pubkey_hash.to_byte_array()),
411 $self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
415 /// Adds a P2TR address to [`Bolt12Invoice::fallbacks`].
417 /// Successive calls to this method will add another address. Caller is responsible for not
418 /// adding duplicate addresses and only calling if capable of receiving to P2TR addresses.
419 pub fn fallback_v1_p2tr_tweaked($($self_mut)* $self: $self_type, output_key: &TweakedPublicKey) -> $return_type {
420 let address = FallbackAddress {
421 version: WitnessVersion::V1.to_num(),
422 program: Vec::from(&output_key.serialize()[..]),
424 $self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
428 /// Sets [`Bolt12Invoice::invoice_features`] to indicate MPP may be used. Otherwise, MPP is
430 pub fn allow_mpp($($self_mut)* $self: $self_type) -> $return_type {
431 $self.invoice.fields_mut().features.set_basic_mpp_optional();
436 impl<'a> InvoiceBuilder<'a, ExplicitSigningPubkey> {
437 invoice_explicit_signing_pubkey_builder_methods!(self, Self);
440 impl<'a> InvoiceBuilder<'a, DerivedSigningPubkey> {
441 invoice_derived_signing_pubkey_builder_methods!(self, Self);
444 impl<'a, S: SigningPubkeyStrategy> InvoiceBuilder<'a, S> {
445 invoice_builder_methods!(self, Self, Self, self, S, mut);
448 #[cfg(all(c_bindings, not(test)))]
449 impl<'a> InvoiceWithExplicitSigningPubkeyBuilder<'a> {
450 invoice_explicit_signing_pubkey_builder_methods!(self, &mut Self);
451 invoice_builder_methods!(self, &mut Self, (), (), ExplicitSigningPubkey);
454 #[cfg(all(c_bindings, test))]
455 impl<'a> InvoiceWithExplicitSigningPubkeyBuilder<'a> {
456 invoice_explicit_signing_pubkey_builder_methods!(self, &mut Self);
457 invoice_builder_methods!(self, &mut Self, &mut Self, self, ExplicitSigningPubkey);
460 #[cfg(all(c_bindings, not(test)))]
461 impl<'a> InvoiceWithDerivedSigningPubkeyBuilder<'a> {
462 invoice_derived_signing_pubkey_builder_methods!(self, &mut Self);
463 invoice_builder_methods!(self, &mut Self, (), (), DerivedSigningPubkey);
466 #[cfg(all(c_bindings, test))]
467 impl<'a> InvoiceWithDerivedSigningPubkeyBuilder<'a> {
468 invoice_derived_signing_pubkey_builder_methods!(self, &mut Self);
469 invoice_builder_methods!(self, &mut Self, &mut Self, self, DerivedSigningPubkey);
473 impl<'a> From<InvoiceWithExplicitSigningPubkeyBuilder<'a>>
474 for InvoiceBuilder<'a, ExplicitSigningPubkey> {
475 fn from(builder: InvoiceWithExplicitSigningPubkeyBuilder<'a>) -> Self {
476 let InvoiceWithExplicitSigningPubkeyBuilder {
477 invreq_bytes, invoice, signing_pubkey_strategy,
481 invreq_bytes, invoice, signing_pubkey_strategy,
487 impl<'a> From<InvoiceWithDerivedSigningPubkeyBuilder<'a>>
488 for InvoiceBuilder<'a, DerivedSigningPubkey> {
489 fn from(builder: InvoiceWithDerivedSigningPubkeyBuilder<'a>) -> Self {
490 let InvoiceWithDerivedSigningPubkeyBuilder {
491 invreq_bytes, invoice, signing_pubkey_strategy,
495 invreq_bytes, invoice, signing_pubkey_strategy,
500 /// A semantically valid [`Bolt12Invoice`] that hasn't been signed.
504 /// This is serialized as a TLV stream, which includes TLV records from the originating message. As
505 /// such, it may include unknown, odd TLV records.
506 pub struct UnsignedBolt12Invoice {
508 contents: InvoiceContents,
509 tagged_hash: TaggedHash,
512 /// A function for signing an [`UnsignedBolt12Invoice`].
513 pub trait SignBolt12InvoiceFn {
514 /// Signs a [`TaggedHash`] computed over the merkle root of `message`'s TLV stream.
515 fn sign_invoice(&self, message: &UnsignedBolt12Invoice) -> Result<Signature, ()>;
518 impl<F> SignBolt12InvoiceFn for F
520 F: Fn(&UnsignedBolt12Invoice) -> Result<Signature, ()>,
522 fn sign_invoice(&self, message: &UnsignedBolt12Invoice) -> Result<Signature, ()> {
527 impl<F> SignFn<UnsignedBolt12Invoice> for F
529 F: SignBolt12InvoiceFn,
531 fn sign(&self, message: &UnsignedBolt12Invoice) -> Result<Signature, ()> {
532 self.sign_invoice(message)
536 impl UnsignedBolt12Invoice {
537 fn new(invreq_bytes: &[u8], contents: InvoiceContents) -> Self {
538 // Use the invoice_request bytes instead of the invoice_request TLV stream as the latter may
539 // have contained unknown TLV records, which are not stored in `InvoiceRequestContents` or
541 let (_, _, _, invoice_tlv_stream) = contents.as_tlv_stream();
542 let invoice_request_bytes = WithoutSignatures(invreq_bytes);
543 let unsigned_tlv_stream = (invoice_request_bytes, invoice_tlv_stream);
545 let mut bytes = Vec::new();
546 unsigned_tlv_stream.write(&mut bytes).unwrap();
548 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
550 Self { bytes, contents, tagged_hash }
553 /// Returns the [`TaggedHash`] of the invoice to sign.
554 pub fn tagged_hash(&self) -> &TaggedHash {
559 macro_rules! unsigned_invoice_sign_method { ($self: ident, $self_type: ty $(, $self_mut: tt)?) => {
560 /// Signs the [`TaggedHash`] of the invoice using the given function.
562 /// Note: The hash computation may have included unknown, odd TLV records.
563 pub fn sign<F: SignBolt12InvoiceFn>(
564 $($self_mut)* $self: $self_type, sign: F
565 ) -> Result<Bolt12Invoice, SignError> {
566 let pubkey = $self.contents.fields().signing_pubkey;
567 let signature = merkle::sign_message(sign, &$self, pubkey)?;
569 // Append the signature TLV record to the bytes.
570 let signature_tlv_stream = SignatureTlvStreamRef {
571 signature: Some(&signature),
573 signature_tlv_stream.write(&mut $self.bytes).unwrap();
576 #[cfg(not(c_bindings))]
579 bytes: $self.bytes.clone(),
580 #[cfg(not(c_bindings))]
581 contents: $self.contents,
583 contents: $self.contents.clone(),
585 #[cfg(not(c_bindings))]
586 tagged_hash: $self.tagged_hash,
588 tagged_hash: $self.tagged_hash.clone(),
593 #[cfg(not(c_bindings))]
594 impl UnsignedBolt12Invoice {
595 unsigned_invoice_sign_method!(self, Self, mut);
599 impl UnsignedBolt12Invoice {
600 unsigned_invoice_sign_method!(self, &mut Self);
603 impl AsRef<TaggedHash> for UnsignedBolt12Invoice {
604 fn as_ref(&self) -> &TaggedHash {
609 /// A `Bolt12Invoice` is a payment request, typically corresponding to an [`Offer`] or a [`Refund`].
611 /// An invoice may be sent in response to an [`InvoiceRequest`] in the case of an offer or sent
612 /// directly after scanning a refund. It includes all the information needed to pay a recipient.
614 /// [`Offer`]: crate::offers::offer::Offer
615 /// [`Refund`]: crate::offers::refund::Refund
616 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
617 #[derive(Clone, Debug)]
618 pub struct Bolt12Invoice {
620 contents: InvoiceContents,
621 signature: Signature,
622 tagged_hash: TaggedHash,
625 /// The contents of an [`Bolt12Invoice`] for responding to either an [`Offer`] or a [`Refund`].
627 /// [`Offer`]: crate::offers::offer::Offer
628 /// [`Refund`]: crate::offers::refund::Refund
629 #[derive(Clone, Debug)]
630 #[cfg_attr(test, derive(PartialEq))]
631 enum InvoiceContents {
632 /// Contents for an [`Bolt12Invoice`] corresponding to an [`Offer`].
634 /// [`Offer`]: crate::offers::offer::Offer
636 invoice_request: InvoiceRequestContents,
637 fields: InvoiceFields,
639 /// Contents for an [`Bolt12Invoice`] corresponding to a [`Refund`].
641 /// [`Refund`]: crate::offers::refund::Refund
643 refund: RefundContents,
644 fields: InvoiceFields,
648 /// Invoice-specific fields for an `invoice` message.
649 #[derive(Clone, Debug, PartialEq)]
650 struct InvoiceFields {
651 payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
652 created_at: Duration,
653 relative_expiry: Option<Duration>,
654 payment_hash: PaymentHash,
656 fallbacks: Option<Vec<FallbackAddress>>,
657 features: Bolt12InvoiceFeatures,
658 signing_pubkey: PublicKey,
661 macro_rules! invoice_accessors { ($self: ident, $contents: expr) => {
662 /// The chains that may be used when paying a requested invoice.
664 /// From [`Offer::chains`]; `None` if the invoice was created in response to a [`Refund`].
666 /// [`Offer::chains`]: crate::offers::offer::Offer::chains
667 pub fn offer_chains(&$self) -> Option<Vec<ChainHash>> {
668 $contents.offer_chains()
671 /// The chain that must be used when paying the invoice; selected from [`offer_chains`] if the
672 /// invoice originated from an offer.
674 /// From [`InvoiceRequest::chain`] or [`Refund::chain`].
676 /// [`offer_chains`]: Self::offer_chains
677 /// [`InvoiceRequest::chain`]: crate::offers::invoice_request::InvoiceRequest::chain
678 pub fn chain(&$self) -> ChainHash {
682 /// Opaque bytes set by the originating [`Offer`].
684 /// From [`Offer::metadata`]; `None` if the invoice was created in response to a [`Refund`] or
685 /// if the [`Offer`] did not set it.
687 /// [`Offer`]: crate::offers::offer::Offer
688 /// [`Offer::metadata`]: crate::offers::offer::Offer::metadata
689 pub fn metadata(&$self) -> Option<&Vec<u8>> {
693 /// The minimum amount required for a successful payment of a single item.
695 /// From [`Offer::amount`]; `None` if the invoice was created in response to a [`Refund`] or if
696 /// the [`Offer`] did not set it.
698 /// [`Offer`]: crate::offers::offer::Offer
699 /// [`Offer::amount`]: crate::offers::offer::Offer::amount
700 pub fn amount(&$self) -> Option<&Amount> {
704 /// Features pertaining to the originating [`Offer`].
706 /// From [`Offer::offer_features`]; `None` if the invoice was created in response to a
709 /// [`Offer`]: crate::offers::offer::Offer
710 /// [`Offer::offer_features`]: crate::offers::offer::Offer::offer_features
711 pub fn offer_features(&$self) -> Option<&OfferFeatures> {
712 $contents.offer_features()
715 /// A complete description of the purpose of the originating offer or refund.
717 /// From [`Offer::description`] or [`Refund::description`].
719 /// [`Offer::description`]: crate::offers::offer::Offer::description
720 pub fn description(&$self) -> PrintableString {
721 $contents.description()
724 /// Duration since the Unix epoch when an invoice should no longer be requested.
726 /// From [`Offer::absolute_expiry`] or [`Refund::absolute_expiry`].
728 /// [`Offer::absolute_expiry`]: crate::offers::offer::Offer::absolute_expiry
729 pub fn absolute_expiry(&$self) -> Option<Duration> {
730 $contents.absolute_expiry()
733 /// The issuer of the offer or refund.
735 /// From [`Offer::issuer`] or [`Refund::issuer`].
737 /// [`Offer::issuer`]: crate::offers::offer::Offer::issuer
738 pub fn issuer(&$self) -> Option<PrintableString> {
742 /// Paths to the recipient originating from publicly reachable nodes.
744 /// From [`Offer::paths`] or [`Refund::paths`].
746 /// [`Offer::paths`]: crate::offers::offer::Offer::paths
747 pub fn message_paths(&$self) -> &[BlindedPath] {
748 $contents.message_paths()
751 /// The quantity of items supported.
753 /// From [`Offer::supported_quantity`]; `None` if the invoice was created in response to a
756 /// [`Offer::supported_quantity`]: crate::offers::offer::Offer::supported_quantity
757 pub fn supported_quantity(&$self) -> Option<Quantity> {
758 $contents.supported_quantity()
761 /// An unpredictable series of bytes from the payer.
763 /// From [`InvoiceRequest::payer_metadata`] or [`Refund::payer_metadata`].
764 pub fn payer_metadata(&$self) -> &[u8] {
765 $contents.payer_metadata()
768 /// Features pertaining to requesting an invoice.
770 /// From [`InvoiceRequest::invoice_request_features`] or [`Refund::features`].
771 pub fn invoice_request_features(&$self) -> &InvoiceRequestFeatures {
772 &$contents.invoice_request_features()
775 /// The quantity of items requested or refunded for.
777 /// From [`InvoiceRequest::quantity`] or [`Refund::quantity`].
778 pub fn quantity(&$self) -> Option<u64> {
782 /// A possibly transient pubkey used to sign the invoice request or to send an invoice for a
783 /// refund in case there are no [`message_paths`].
785 /// [`message_paths`]: Self::message_paths
786 pub fn payer_id(&$self) -> PublicKey {
790 /// A payer-provided note reflected back in the invoice.
792 /// From [`InvoiceRequest::payer_note`] or [`Refund::payer_note`].
793 pub fn payer_note(&$self) -> Option<PrintableString> {
794 $contents.payer_note()
797 /// Paths to the recipient originating from publicly reachable nodes, including information
798 /// needed for routing payments across them.
800 /// Blinded paths provide recipient privacy by obfuscating its node id. Note, however, that this
801 /// privacy is lost if a public node id is used for [`Bolt12Invoice::signing_pubkey`].
803 /// This is not exported to bindings users as slices with non-reference types cannot be ABI
804 /// matched in another language.
805 pub fn payment_paths(&$self) -> &[(BlindedPayInfo, BlindedPath)] {
806 $contents.payment_paths()
809 /// Duration since the Unix epoch when the invoice was created.
810 pub fn created_at(&$self) -> Duration {
811 $contents.created_at()
814 /// Duration since [`Bolt12Invoice::created_at`] when the invoice has expired and therefore
815 /// should no longer be paid.
816 pub fn relative_expiry(&$self) -> Duration {
817 $contents.relative_expiry()
820 /// Whether the invoice has expired.
821 #[cfg(feature = "std")]
822 pub fn is_expired(&$self) -> bool {
823 $contents.is_expired()
826 /// SHA256 hash of the payment preimage that will be given in return for paying the invoice.
827 pub fn payment_hash(&$self) -> PaymentHash {
828 $contents.payment_hash()
831 /// The minimum amount required for a successful payment of the invoice.
832 pub fn amount_msats(&$self) -> u64 {
833 $contents.amount_msats()
836 /// Fallback addresses for paying the invoice on-chain, in order of most-preferred to
838 pub fn fallbacks(&$self) -> Vec<Address> {
839 $contents.fallbacks()
842 /// Features pertaining to paying an invoice.
843 pub fn invoice_features(&$self) -> &Bolt12InvoiceFeatures {
847 /// The public key corresponding to the key used to sign the invoice.
848 pub fn signing_pubkey(&$self) -> PublicKey {
849 $contents.signing_pubkey()
853 impl UnsignedBolt12Invoice {
854 invoice_accessors!(self, self.contents);
858 invoice_accessors!(self, self.contents);
860 /// Signature of the invoice verified using [`Bolt12Invoice::signing_pubkey`].
861 pub fn signature(&self) -> Signature {
865 /// Hash that was used for signing the invoice.
866 pub fn signable_hash(&self) -> [u8; 32] {
867 self.tagged_hash.as_digest().as_ref().clone()
870 /// Verifies that the invoice was for a request or refund created using the given key. Returns
871 /// the associated [`PaymentId`] to use when sending the payment.
872 pub fn verify<T: secp256k1::Signing>(
873 &self, key: &ExpandedKey, secp_ctx: &Secp256k1<T>
874 ) -> Result<PaymentId, ()> {
875 self.contents.verify(TlvStream::new(&self.bytes), key, secp_ctx)
878 pub(crate) fn as_tlv_stream(&self) -> FullInvoiceTlvStreamRef {
879 let (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream) =
880 self.contents.as_tlv_stream();
881 let signature_tlv_stream = SignatureTlvStreamRef {
882 signature: Some(&self.signature),
884 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
885 signature_tlv_stream)
889 impl PartialEq for Bolt12Invoice {
890 fn eq(&self, other: &Self) -> bool {
891 self.bytes.eq(&other.bytes)
895 impl Eq for Bolt12Invoice {}
897 impl Hash for Bolt12Invoice {
898 fn hash<H: Hasher>(&self, state: &mut H) {
899 self.bytes.hash(state);
903 impl InvoiceContents {
904 /// Whether the original offer or refund has expired.
905 #[cfg(feature = "std")]
906 fn is_offer_or_refund_expired(&self) -> bool {
908 InvoiceContents::ForOffer { invoice_request, .. } =>
909 invoice_request.inner.offer.is_expired(),
910 InvoiceContents::ForRefund { refund, .. } => refund.is_expired(),
914 #[cfg(not(feature = "std"))]
915 fn is_offer_or_refund_expired_no_std(&self, duration_since_epoch: Duration) -> bool {
917 InvoiceContents::ForOffer { invoice_request, .. } =>
918 invoice_request.inner.offer.is_expired_no_std(duration_since_epoch),
919 InvoiceContents::ForRefund { refund, .. } =>
920 refund.is_expired_no_std(duration_since_epoch),
924 fn offer_chains(&self) -> Option<Vec<ChainHash>> {
926 InvoiceContents::ForOffer { invoice_request, .. } =>
927 Some(invoice_request.inner.offer.chains()),
928 InvoiceContents::ForRefund { .. } => None,
932 fn chain(&self) -> ChainHash {
934 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.chain(),
935 InvoiceContents::ForRefund { refund, .. } => refund.chain(),
939 fn metadata(&self) -> Option<&Vec<u8>> {
941 InvoiceContents::ForOffer { invoice_request, .. } =>
942 invoice_request.inner.offer.metadata(),
943 InvoiceContents::ForRefund { .. } => None,
947 fn amount(&self) -> Option<&Amount> {
949 InvoiceContents::ForOffer { invoice_request, .. } =>
950 invoice_request.inner.offer.amount(),
951 InvoiceContents::ForRefund { .. } => None,
955 fn description(&self) -> PrintableString {
957 InvoiceContents::ForOffer { invoice_request, .. } => {
958 invoice_request.inner.offer.description()
960 InvoiceContents::ForRefund { refund, .. } => refund.description(),
964 fn offer_features(&self) -> Option<&OfferFeatures> {
966 InvoiceContents::ForOffer { invoice_request, .. } => {
967 Some(invoice_request.inner.offer.features())
969 InvoiceContents::ForRefund { .. } => None,
973 fn absolute_expiry(&self) -> Option<Duration> {
975 InvoiceContents::ForOffer { invoice_request, .. } => {
976 invoice_request.inner.offer.absolute_expiry()
978 InvoiceContents::ForRefund { refund, .. } => refund.absolute_expiry(),
982 fn issuer(&self) -> Option<PrintableString> {
984 InvoiceContents::ForOffer { invoice_request, .. } => {
985 invoice_request.inner.offer.issuer()
987 InvoiceContents::ForRefund { refund, .. } => refund.issuer(),
991 fn message_paths(&self) -> &[BlindedPath] {
993 InvoiceContents::ForOffer { invoice_request, .. } => {
994 invoice_request.inner.offer.paths()
996 InvoiceContents::ForRefund { refund, .. } => refund.paths(),
1000 fn supported_quantity(&self) -> Option<Quantity> {
1002 InvoiceContents::ForOffer { invoice_request, .. } => {
1003 Some(invoice_request.inner.offer.supported_quantity())
1005 InvoiceContents::ForRefund { .. } => None,
1009 fn payer_metadata(&self) -> &[u8] {
1011 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.metadata(),
1012 InvoiceContents::ForRefund { refund, .. } => refund.metadata(),
1016 fn invoice_request_features(&self) -> &InvoiceRequestFeatures {
1018 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.features(),
1019 InvoiceContents::ForRefund { refund, .. } => refund.features(),
1023 fn quantity(&self) -> Option<u64> {
1025 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.quantity(),
1026 InvoiceContents::ForRefund { refund, .. } => refund.quantity(),
1030 fn payer_id(&self) -> PublicKey {
1032 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.payer_id(),
1033 InvoiceContents::ForRefund { refund, .. } => refund.payer_id(),
1037 fn payer_note(&self) -> Option<PrintableString> {
1039 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.payer_note(),
1040 InvoiceContents::ForRefund { refund, .. } => refund.payer_note(),
1044 fn payment_paths(&self) -> &[(BlindedPayInfo, BlindedPath)] {
1045 &self.fields().payment_paths[..]
1048 fn created_at(&self) -> Duration {
1049 self.fields().created_at
1052 fn relative_expiry(&self) -> Duration {
1053 self.fields().relative_expiry.unwrap_or(DEFAULT_RELATIVE_EXPIRY)
1056 #[cfg(feature = "std")]
1057 fn is_expired(&self) -> bool {
1058 let absolute_expiry = self.created_at().checked_add(self.relative_expiry());
1059 match absolute_expiry {
1060 Some(seconds_from_epoch) => match SystemTime::UNIX_EPOCH.elapsed() {
1061 Ok(elapsed) => elapsed > seconds_from_epoch,
1068 fn payment_hash(&self) -> PaymentHash {
1069 self.fields().payment_hash
1072 fn amount_msats(&self) -> u64 {
1073 self.fields().amount_msats
1076 fn fallbacks(&self) -> Vec<Address> {
1077 let chain = self.chain();
1078 let network = if chain == ChainHash::using_genesis_block(Network::Bitcoin) {
1080 } else if chain == ChainHash::using_genesis_block(Network::Testnet) {
1082 } else if chain == ChainHash::using_genesis_block(Network::Signet) {
1084 } else if chain == ChainHash::using_genesis_block(Network::Regtest) {
1090 let to_valid_address = |address: &FallbackAddress| {
1091 let version = match WitnessVersion::try_from(address.version) {
1092 Ok(version) => version,
1093 Err(_) => return None,
1096 let program = &address.program;
1097 let witness_program = match WitnessProgram::new(version, program.clone()) {
1098 Ok(witness_program) => witness_program,
1099 Err(_) => return None,
1101 Some(Address::new(network, Payload::WitnessProgram(witness_program)))
1104 self.fields().fallbacks
1106 .map(|fallbacks| fallbacks.iter().filter_map(to_valid_address).collect())
1107 .unwrap_or_else(Vec::new)
1110 fn features(&self) -> &Bolt12InvoiceFeatures {
1111 &self.fields().features
1114 fn signing_pubkey(&self) -> PublicKey {
1115 self.fields().signing_pubkey
1118 fn fields(&self) -> &InvoiceFields {
1120 InvoiceContents::ForOffer { fields, .. } => fields,
1121 InvoiceContents::ForRefund { fields, .. } => fields,
1125 fn fields_mut(&mut self) -> &mut InvoiceFields {
1127 InvoiceContents::ForOffer { fields, .. } => fields,
1128 InvoiceContents::ForRefund { fields, .. } => fields,
1132 fn verify<T: secp256k1::Signing>(
1133 &self, tlv_stream: TlvStream<'_>, key: &ExpandedKey, secp_ctx: &Secp256k1<T>
1134 ) -> Result<PaymentId, ()> {
1135 let offer_records = tlv_stream.clone().range(OFFER_TYPES);
1136 let invreq_records = tlv_stream.range(INVOICE_REQUEST_TYPES).filter(|record| {
1137 match record.r#type {
1138 PAYER_METADATA_TYPE => false, // Should be outside range
1139 INVOICE_REQUEST_PAYER_ID_TYPE => !self.derives_keys(),
1143 let tlv_stream = offer_records.chain(invreq_records);
1145 let (metadata, payer_id, iv_bytes) = match self {
1146 InvoiceContents::ForOffer { invoice_request, .. } => {
1147 (invoice_request.metadata(), invoice_request.payer_id(), INVOICE_REQUEST_IV_BYTES)
1149 InvoiceContents::ForRefund { refund, .. } => {
1150 (refund.metadata(), refund.payer_id(), REFUND_IV_BYTES)
1154 signer::verify_payer_metadata(metadata, key, iv_bytes, payer_id, tlv_stream, secp_ctx)
1157 fn derives_keys(&self) -> bool {
1159 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.derives_keys(),
1160 InvoiceContents::ForRefund { refund, .. } => refund.derives_keys(),
1164 fn as_tlv_stream(&self) -> PartialInvoiceTlvStreamRef {
1165 let (payer, offer, invoice_request) = match self {
1166 InvoiceContents::ForOffer { invoice_request, .. } => invoice_request.as_tlv_stream(),
1167 InvoiceContents::ForRefund { refund, .. } => refund.as_tlv_stream(),
1169 let invoice = self.fields().as_tlv_stream();
1171 (payer, offer, invoice_request, invoice)
1175 impl InvoiceFields {
1176 fn as_tlv_stream(&self) -> InvoiceTlvStreamRef {
1178 if self.features == Bolt12InvoiceFeatures::empty() { None }
1179 else { Some(&self.features) }
1182 InvoiceTlvStreamRef {
1183 paths: Some(Iterable(self.payment_paths.iter().map(|(_, path)| path))),
1184 blindedpay: Some(Iterable(self.payment_paths.iter().map(|(payinfo, _)| payinfo))),
1185 created_at: Some(self.created_at.as_secs()),
1186 relative_expiry: self.relative_expiry.map(|duration| duration.as_secs() as u32),
1187 payment_hash: Some(&self.payment_hash),
1188 amount: Some(self.amount_msats),
1189 fallbacks: self.fallbacks.as_ref(),
1191 node_id: Some(&self.signing_pubkey),
1196 impl Writeable for UnsignedBolt12Invoice {
1197 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1198 WithoutLength(&self.bytes).write(writer)
1202 impl Writeable for Bolt12Invoice {
1203 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1204 WithoutLength(&self.bytes).write(writer)
1208 impl Writeable for InvoiceContents {
1209 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1210 self.as_tlv_stream().write(writer)
1214 impl TryFrom<Vec<u8>> for UnsignedBolt12Invoice {
1215 type Error = Bolt12ParseError;
1217 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1218 let invoice = ParsedMessage::<PartialInvoiceTlvStream>::try_from(bytes)?;
1219 let ParsedMessage { bytes, tlv_stream } = invoice;
1221 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1223 let contents = InvoiceContents::try_from(
1224 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream)
1227 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
1229 Ok(UnsignedBolt12Invoice { bytes, contents, tagged_hash })
1233 impl TryFrom<Vec<u8>> for Bolt12Invoice {
1234 type Error = Bolt12ParseError;
1236 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1237 let parsed_invoice = ParsedMessage::<FullInvoiceTlvStream>::try_from(bytes)?;
1238 Bolt12Invoice::try_from(parsed_invoice)
1242 tlv_stream!(InvoiceTlvStream, InvoiceTlvStreamRef, 160..240, {
1243 (160, paths: (Vec<BlindedPath>, WithoutLength, Iterable<'a, BlindedPathIter<'a>, BlindedPath>)),
1244 (162, blindedpay: (Vec<BlindedPayInfo>, WithoutLength, Iterable<'a, BlindedPayInfoIter<'a>, BlindedPayInfo>)),
1245 (164, created_at: (u64, HighZeroBytesDroppedBigSize)),
1246 (166, relative_expiry: (u32, HighZeroBytesDroppedBigSize)),
1247 (168, payment_hash: PaymentHash),
1248 (170, amount: (u64, HighZeroBytesDroppedBigSize)),
1249 (172, fallbacks: (Vec<FallbackAddress>, WithoutLength)),
1250 (174, features: (Bolt12InvoiceFeatures, WithoutLength)),
1251 (176, node_id: PublicKey),
1254 type BlindedPathIter<'a> = core::iter::Map<
1255 core::slice::Iter<'a, (BlindedPayInfo, BlindedPath)>,
1256 for<'r> fn(&'r (BlindedPayInfo, BlindedPath)) -> &'r BlindedPath,
1259 type BlindedPayInfoIter<'a> = core::iter::Map<
1260 core::slice::Iter<'a, (BlindedPayInfo, BlindedPath)>,
1261 for<'r> fn(&'r (BlindedPayInfo, BlindedPath)) -> &'r BlindedPayInfo,
1264 /// Information needed to route a payment across a [`BlindedPath`].
1265 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
1266 pub struct BlindedPayInfo {
1267 /// Base fee charged (in millisatoshi) for the entire blinded path.
1268 pub fee_base_msat: u32,
1270 /// Liquidity fee charged (in millionths of the amount transferred) for the entire blinded path
1271 /// (i.e., 10,000 is 1%).
1272 pub fee_proportional_millionths: u32,
1274 /// Number of blocks subtracted from an incoming HTLC's `cltv_expiry` for the entire blinded
1276 pub cltv_expiry_delta: u16,
1278 /// The minimum HTLC value (in millisatoshi) that is acceptable to all channel peers on the
1279 /// blinded path from the introduction node to the recipient, accounting for any fees, i.e., as
1280 /// seen by the recipient.
1281 pub htlc_minimum_msat: u64,
1283 /// The maximum HTLC value (in millisatoshi) that is acceptable to all channel peers on the
1284 /// blinded path from the introduction node to the recipient, accounting for any fees, i.e., as
1285 /// seen by the recipient.
1286 pub htlc_maximum_msat: u64,
1288 /// Features set in `encrypted_data_tlv` for the `encrypted_recipient_data` TLV record in an
1290 pub features: BlindedHopFeatures,
1293 impl_writeable!(BlindedPayInfo, {
1295 fee_proportional_millionths,
1302 /// Wire representation for an on-chain fallback address.
1303 #[derive(Clone, Debug, PartialEq)]
1304 pub(super) struct FallbackAddress {
1309 impl_writeable!(FallbackAddress, { version, program });
1311 type FullInvoiceTlvStream =
1312 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream, SignatureTlvStream);
1314 type FullInvoiceTlvStreamRef<'a> = (
1315 PayerTlvStreamRef<'a>,
1316 OfferTlvStreamRef<'a>,
1317 InvoiceRequestTlvStreamRef<'a>,
1318 InvoiceTlvStreamRef<'a>,
1319 SignatureTlvStreamRef<'a>,
1322 impl SeekReadable for FullInvoiceTlvStream {
1323 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1324 let payer = SeekReadable::read(r)?;
1325 let offer = SeekReadable::read(r)?;
1326 let invoice_request = SeekReadable::read(r)?;
1327 let invoice = SeekReadable::read(r)?;
1328 let signature = SeekReadable::read(r)?;
1330 Ok((payer, offer, invoice_request, invoice, signature))
1334 type PartialInvoiceTlvStream =
1335 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream);
1337 type PartialInvoiceTlvStreamRef<'a> = (
1338 PayerTlvStreamRef<'a>,
1339 OfferTlvStreamRef<'a>,
1340 InvoiceRequestTlvStreamRef<'a>,
1341 InvoiceTlvStreamRef<'a>,
1344 impl SeekReadable for PartialInvoiceTlvStream {
1345 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1346 let payer = SeekReadable::read(r)?;
1347 let offer = SeekReadable::read(r)?;
1348 let invoice_request = SeekReadable::read(r)?;
1349 let invoice = SeekReadable::read(r)?;
1351 Ok((payer, offer, invoice_request, invoice))
1355 impl TryFrom<ParsedMessage<FullInvoiceTlvStream>> for Bolt12Invoice {
1356 type Error = Bolt12ParseError;
1358 fn try_from(invoice: ParsedMessage<FullInvoiceTlvStream>) -> Result<Self, Self::Error> {
1359 let ParsedMessage { bytes, tlv_stream } = invoice;
1361 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1362 SignatureTlvStream { signature },
1364 let contents = InvoiceContents::try_from(
1365 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream)
1368 let signature = match signature {
1369 None => return Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
1370 Some(signature) => signature,
1372 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
1373 let pubkey = contents.fields().signing_pubkey;
1374 merkle::verify_signature(&signature, &tagged_hash, pubkey)?;
1376 Ok(Bolt12Invoice { bytes, contents, signature, tagged_hash })
1380 impl TryFrom<PartialInvoiceTlvStream> for InvoiceContents {
1381 type Error = Bolt12SemanticError;
1383 fn try_from(tlv_stream: PartialInvoiceTlvStream) -> Result<Self, Self::Error> {
1387 invoice_request_tlv_stream,
1389 paths, blindedpay, created_at, relative_expiry, payment_hash, amount, fallbacks,
1394 let payment_paths = match (blindedpay, paths) {
1395 (_, None) => return Err(Bolt12SemanticError::MissingPaths),
1396 (None, _) => return Err(Bolt12SemanticError::InvalidPayInfo),
1397 (_, Some(paths)) if paths.is_empty() => return Err(Bolt12SemanticError::MissingPaths),
1398 (Some(blindedpay), Some(paths)) if paths.len() != blindedpay.len() => {
1399 return Err(Bolt12SemanticError::InvalidPayInfo);
1401 (Some(blindedpay), Some(paths)) => {
1402 blindedpay.into_iter().zip(paths.into_iter()).collect::<Vec<_>>()
1406 let created_at = match created_at {
1407 None => return Err(Bolt12SemanticError::MissingCreationTime),
1408 Some(timestamp) => Duration::from_secs(timestamp),
1411 let relative_expiry = relative_expiry
1412 .map(Into::<u64>::into)
1413 .map(Duration::from_secs);
1415 let payment_hash = match payment_hash {
1416 None => return Err(Bolt12SemanticError::MissingPaymentHash),
1417 Some(payment_hash) => payment_hash,
1420 let amount_msats = match amount {
1421 None => return Err(Bolt12SemanticError::MissingAmount),
1422 Some(amount) => amount,
1425 let features = features.unwrap_or_else(Bolt12InvoiceFeatures::empty);
1427 let signing_pubkey = match node_id {
1428 None => return Err(Bolt12SemanticError::MissingSigningPubkey),
1429 Some(node_id) => node_id,
1432 let fields = InvoiceFields {
1433 payment_paths, created_at, relative_expiry, payment_hash, amount_msats, fallbacks,
1434 features, signing_pubkey,
1437 match offer_tlv_stream.node_id {
1438 Some(expected_signing_pubkey) => {
1439 if fields.signing_pubkey != expected_signing_pubkey {
1440 return Err(Bolt12SemanticError::InvalidSigningPubkey);
1443 let invoice_request = InvoiceRequestContents::try_from(
1444 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1446 Ok(InvoiceContents::ForOffer { invoice_request, fields })
1449 let refund = RefundContents::try_from(
1450 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1452 Ok(InvoiceContents::ForRefund { refund, fields })
1460 use super::{Bolt12Invoice, DEFAULT_RELATIVE_EXPIRY, FallbackAddress, FullInvoiceTlvStreamRef, InvoiceTlvStreamRef, SIGNATURE_TAG, UnsignedBolt12Invoice};
1462 use bitcoin::blockdata::constants::ChainHash;
1463 use bitcoin::blockdata::script::ScriptBuf;
1464 use bitcoin::hashes::Hash;
1465 use bitcoin::network::constants::Network;
1466 use bitcoin::secp256k1::{Message, Secp256k1, XOnlyPublicKey, self};
1467 use bitcoin::address::{Address, Payload, WitnessProgram, WitnessVersion};
1468 use bitcoin::key::TweakedPublicKey;
1470 use core::time::Duration;
1472 use crate::blinded_path::{BlindedHop, BlindedPath, IntroductionNode};
1473 use crate::sign::KeyMaterial;
1474 use crate::ln::features::{Bolt12InvoiceFeatures, InvoiceRequestFeatures, OfferFeatures};
1475 use crate::ln::inbound_payment::ExpandedKey;
1476 use crate::ln::msgs::DecodeError;
1477 use crate::offers::invoice_request::InvoiceRequestTlvStreamRef;
1478 use crate::offers::merkle::{SignError, SignatureTlvStreamRef, TaggedHash, self};
1479 use crate::offers::offer::{Amount, OfferTlvStreamRef, Quantity};
1480 use crate::prelude::*;
1481 #[cfg(not(c_bindings))]
1483 crate::offers::offer::OfferBuilder,
1484 crate::offers::refund::RefundBuilder,
1488 crate::offers::offer::OfferWithExplicitMetadataBuilder as OfferBuilder,
1489 crate::offers::refund::RefundMaybeWithDerivedMetadataBuilder as RefundBuilder,
1491 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
1492 use crate::offers::payer::PayerTlvStreamRef;
1493 use crate::offers::test_utils::*;
1494 use crate::util::ser::{BigSize, Iterable, Writeable};
1495 use crate::util::string::PrintableString;
1498 fn to_bytes(&self) -> Vec<u8>;
1501 impl<'a> ToBytes for FullInvoiceTlvStreamRef<'a> {
1502 fn to_bytes(&self) -> Vec<u8> {
1503 let mut buffer = Vec::new();
1504 self.0.write(&mut buffer).unwrap();
1505 self.1.write(&mut buffer).unwrap();
1506 self.2.write(&mut buffer).unwrap();
1507 self.3.write(&mut buffer).unwrap();
1508 self.4.write(&mut buffer).unwrap();
1514 fn builds_invoice_for_offer_with_defaults() {
1515 let payment_paths = payment_paths();
1516 let payment_hash = payment_hash();
1518 let unsigned_invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1521 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1523 .sign(payer_sign).unwrap()
1524 .respond_with_no_std(payment_paths.clone(), payment_hash, now).unwrap()
1527 let mut buffer = Vec::new();
1528 unsigned_invoice.write(&mut buffer).unwrap();
1530 assert_eq!(unsigned_invoice.bytes, buffer.as_slice());
1531 assert_eq!(unsigned_invoice.payer_metadata(), &[1; 32]);
1532 assert_eq!(unsigned_invoice.offer_chains(), Some(vec![ChainHash::using_genesis_block(Network::Bitcoin)]));
1533 assert_eq!(unsigned_invoice.metadata(), None);
1534 assert_eq!(unsigned_invoice.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1535 assert_eq!(unsigned_invoice.description(), PrintableString("foo"));
1536 assert_eq!(unsigned_invoice.offer_features(), Some(&OfferFeatures::empty()));
1537 assert_eq!(unsigned_invoice.absolute_expiry(), None);
1538 assert_eq!(unsigned_invoice.message_paths(), &[]);
1539 assert_eq!(unsigned_invoice.issuer(), None);
1540 assert_eq!(unsigned_invoice.supported_quantity(), Some(Quantity::One));
1541 assert_eq!(unsigned_invoice.signing_pubkey(), recipient_pubkey());
1542 assert_eq!(unsigned_invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1543 assert_eq!(unsigned_invoice.amount_msats(), 1000);
1544 assert_eq!(unsigned_invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1545 assert_eq!(unsigned_invoice.quantity(), None);
1546 assert_eq!(unsigned_invoice.payer_id(), payer_pubkey());
1547 assert_eq!(unsigned_invoice.payer_note(), None);
1548 assert_eq!(unsigned_invoice.payment_paths(), payment_paths.as_slice());
1549 assert_eq!(unsigned_invoice.created_at(), now);
1550 assert_eq!(unsigned_invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1551 #[cfg(feature = "std")]
1552 assert!(!unsigned_invoice.is_expired());
1553 assert_eq!(unsigned_invoice.payment_hash(), payment_hash);
1554 assert_eq!(unsigned_invoice.amount_msats(), 1000);
1555 assert_eq!(unsigned_invoice.fallbacks(), vec![]);
1556 assert_eq!(unsigned_invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1557 assert_eq!(unsigned_invoice.signing_pubkey(), recipient_pubkey());
1559 match UnsignedBolt12Invoice::try_from(buffer) {
1560 Err(e) => panic!("error parsing unsigned invoice: {:?}", e),
1562 assert_eq!(parsed.bytes, unsigned_invoice.bytes);
1563 assert_eq!(parsed.tagged_hash, unsigned_invoice.tagged_hash);
1568 let mut unsigned_invoice = unsigned_invoice;
1569 let invoice = unsigned_invoice.sign(recipient_sign).unwrap();
1571 let mut buffer = Vec::new();
1572 invoice.write(&mut buffer).unwrap();
1574 assert_eq!(invoice.bytes, buffer.as_slice());
1575 assert_eq!(invoice.payer_metadata(), &[1; 32]);
1576 assert_eq!(invoice.offer_chains(), Some(vec![ChainHash::using_genesis_block(Network::Bitcoin)]));
1577 assert_eq!(invoice.metadata(), None);
1578 assert_eq!(invoice.amount(), Some(&Amount::Bitcoin { amount_msats: 1000 }));
1579 assert_eq!(invoice.description(), PrintableString("foo"));
1580 assert_eq!(invoice.offer_features(), Some(&OfferFeatures::empty()));
1581 assert_eq!(invoice.absolute_expiry(), None);
1582 assert_eq!(invoice.message_paths(), &[]);
1583 assert_eq!(invoice.issuer(), None);
1584 assert_eq!(invoice.supported_quantity(), Some(Quantity::One));
1585 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1586 assert_eq!(invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1587 assert_eq!(invoice.amount_msats(), 1000);
1588 assert_eq!(invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1589 assert_eq!(invoice.quantity(), None);
1590 assert_eq!(invoice.payer_id(), payer_pubkey());
1591 assert_eq!(invoice.payer_note(), None);
1592 assert_eq!(invoice.payment_paths(), payment_paths.as_slice());
1593 assert_eq!(invoice.created_at(), now);
1594 assert_eq!(invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1595 #[cfg(feature = "std")]
1596 assert!(!invoice.is_expired());
1597 assert_eq!(invoice.payment_hash(), payment_hash);
1598 assert_eq!(invoice.amount_msats(), 1000);
1599 assert_eq!(invoice.fallbacks(), vec![]);
1600 assert_eq!(invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1601 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1603 let message = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &invoice.bytes);
1604 assert!(merkle::verify_signature(&invoice.signature, &message, recipient_pubkey()).is_ok());
1606 let digest = Message::from_slice(&invoice.signable_hash()).unwrap();
1607 let pubkey = recipient_pubkey().into();
1608 let secp_ctx = Secp256k1::verification_only();
1609 assert!(secp_ctx.verify_schnorr(&invoice.signature, &digest, &pubkey).is_ok());
1612 invoice.as_tlv_stream(),
1614 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1620 description: Some(&String::from("foo")),
1622 absolute_expiry: None,
1626 node_id: Some(&recipient_pubkey()),
1628 InvoiceRequestTlvStreamRef {
1633 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()),
1730 InvoiceTlvStreamRef {
1731 paths: Some(Iterable(payment_paths.iter().map(|(_, path)| path))),
1732 blindedpay: Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo))),
1733 created_at: Some(now.as_secs()),
1734 relative_expiry: None,
1735 payment_hash: Some(&payment_hash),
1739 node_id: Some(&recipient_pubkey()),
1741 SignatureTlvStreamRef { signature: Some(&invoice.signature()) },
1745 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1746 panic!("error parsing invoice: {:?}", e);
1750 #[cfg(feature = "std")]
1752 fn builds_invoice_from_offer_with_expiration() {
1753 let future_expiry = Duration::from_secs(u64::max_value());
1754 let past_expiry = Duration::from_secs(0);
1756 if let Err(e) = OfferBuilder::new("foo".into(), recipient_pubkey())
1758 .absolute_expiry(future_expiry)
1760 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1762 .sign(payer_sign).unwrap()
1763 .respond_with(payment_paths(), payment_hash())
1767 panic!("error building invoice: {:?}", e);
1770 match OfferBuilder::new("foo".into(), recipient_pubkey())
1772 .absolute_expiry(past_expiry)
1774 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1776 .sign(payer_sign).unwrap()
1777 .respond_with(payment_paths(), payment_hash())
1781 Ok(_) => panic!("expected error"),
1782 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1786 #[cfg(feature = "std")]
1788 fn builds_invoice_from_refund_with_expiration() {
1789 let future_expiry = Duration::from_secs(u64::max_value());
1790 let past_expiry = Duration::from_secs(0);
1792 if let Err(e) = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1793 .absolute_expiry(future_expiry)
1795 .respond_with(payment_paths(), payment_hash(), recipient_pubkey())
1799 panic!("error building invoice: {:?}", e);
1802 match RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1803 .absolute_expiry(past_expiry)
1805 .respond_with(payment_paths(), payment_hash(), recipient_pubkey())
1809 Ok(_) => panic!("expected error"),
1810 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1815 fn builds_invoice_from_offer_using_derived_keys() {
1816 let desc = "foo".to_string();
1817 let node_id = recipient_pubkey();
1818 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1819 let entropy = FixedEntropy {};
1820 let secp_ctx = Secp256k1::new();
1822 let blinded_path = BlindedPath {
1823 introduction_node: IntroductionNode::NodeId(pubkey(40)),
1824 blinding_point: pubkey(41),
1826 BlindedHop { blinded_node_id: pubkey(42), encrypted_payload: vec![0; 43] },
1827 BlindedHop { blinded_node_id: node_id, encrypted_payload: vec![0; 44] },
1832 use crate::offers::offer::OfferWithDerivedMetadataBuilder as OfferBuilder;
1833 let offer = OfferBuilder
1834 ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
1838 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1840 .sign(payer_sign).unwrap();
1842 if let Err(e) = invoice_request.clone()
1843 .verify(&expanded_key, &secp_ctx).unwrap()
1844 .respond_using_derived_keys_no_std(payment_paths(), payment_hash(), now()).unwrap()
1845 .build_and_sign(&secp_ctx)
1847 panic!("error building invoice: {:?}", e);
1850 let expanded_key = ExpandedKey::new(&KeyMaterial([41; 32]));
1851 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_err());
1853 let desc = "foo".to_string();
1854 let offer = OfferBuilder
1855 ::deriving_signing_pubkey(desc, node_id, &expanded_key, &entropy, &secp_ctx)
1857 // Omit the path so that node_id is used for the signing pubkey instead of deriving
1859 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1861 .sign(payer_sign).unwrap();
1863 match invoice_request
1864 .verify(&expanded_key, &secp_ctx).unwrap()
1865 .respond_using_derived_keys_no_std(payment_paths(), payment_hash(), now())
1867 Ok(_) => panic!("expected error"),
1868 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidMetadata),
1873 fn builds_invoice_from_refund_using_derived_keys() {
1874 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1875 let entropy = FixedEntropy {};
1876 let secp_ctx = Secp256k1::new();
1878 let refund = RefundBuilder::new("foo".into(), vec![1; 32], payer_pubkey(), 1000).unwrap()
1881 if let Err(e) = refund
1882 .respond_using_derived_keys_no_std(
1883 payment_paths(), payment_hash(), now(), &expanded_key, &entropy
1886 .build_and_sign(&secp_ctx)
1888 panic!("error building invoice: {:?}", e);
1893 fn builds_invoice_with_relative_expiry() {
1895 let one_hour = Duration::from_secs(3600);
1897 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1900 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1902 .sign(payer_sign).unwrap()
1903 .respond_with_no_std(payment_paths(), payment_hash(), now).unwrap()
1904 .relative_expiry(one_hour.as_secs() as u32)
1906 .sign(recipient_sign).unwrap();
1907 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1908 #[cfg(feature = "std")]
1909 assert!(!invoice.is_expired());
1910 assert_eq!(invoice.relative_expiry(), one_hour);
1911 assert_eq!(tlv_stream.relative_expiry, Some(one_hour.as_secs() as u32));
1913 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1916 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1918 .sign(payer_sign).unwrap()
1919 .respond_with_no_std(payment_paths(), payment_hash(), now - one_hour).unwrap()
1920 .relative_expiry(one_hour.as_secs() as u32 - 1)
1922 .sign(recipient_sign).unwrap();
1923 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1924 #[cfg(feature = "std")]
1925 assert!(invoice.is_expired());
1926 assert_eq!(invoice.relative_expiry(), one_hour - Duration::from_secs(1));
1927 assert_eq!(tlv_stream.relative_expiry, Some(one_hour.as_secs() as u32 - 1));
1931 fn builds_invoice_with_amount_from_request() {
1932 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1935 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1936 .amount_msats(1001).unwrap()
1938 .sign(payer_sign).unwrap()
1939 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1941 .sign(recipient_sign).unwrap();
1942 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1943 assert_eq!(invoice.amount_msats(), 1001);
1944 assert_eq!(tlv_stream.amount, Some(1001));
1948 fn builds_invoice_with_quantity_from_request() {
1949 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1951 .supported_quantity(Quantity::Unbounded)
1953 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1954 .quantity(2).unwrap()
1956 .sign(payer_sign).unwrap()
1957 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1959 .sign(recipient_sign).unwrap();
1960 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1961 assert_eq!(invoice.amount_msats(), 2000);
1962 assert_eq!(tlv_stream.amount, Some(2000));
1964 match OfferBuilder::new("foo".into(), recipient_pubkey())
1966 .supported_quantity(Quantity::Unbounded)
1968 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1969 .quantity(u64::max_value()).unwrap()
1971 .sign(payer_sign).unwrap()
1972 .respond_with_no_std(payment_paths(), payment_hash(), now())
1974 Ok(_) => panic!("expected error"),
1975 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
1980 fn builds_invoice_with_fallback_address() {
1981 let script = ScriptBuf::new();
1982 let pubkey = bitcoin::key::PublicKey::new(recipient_pubkey());
1983 let x_only_pubkey = XOnlyPublicKey::from_keypair(&recipient_keys()).0;
1984 let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(x_only_pubkey);
1986 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
1989 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1991 .sign(payer_sign).unwrap()
1992 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1993 .fallback_v0_p2wsh(&script.wscript_hash())
1994 .fallback_v0_p2wpkh(&pubkey.wpubkey_hash().unwrap())
1995 .fallback_v1_p2tr_tweaked(&tweaked_pubkey)
1997 .sign(recipient_sign).unwrap();
1998 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
2000 invoice.fallbacks(),
2002 Address::p2wsh(&script, Network::Bitcoin),
2003 Address::p2wpkh(&pubkey, Network::Bitcoin).unwrap(),
2004 Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin),
2008 tlv_stream.fallbacks,
2011 version: WitnessVersion::V0.to_num(),
2012 program: Vec::from(script.wscript_hash().to_byte_array()),
2015 version: WitnessVersion::V0.to_num(),
2016 program: Vec::from(pubkey.wpubkey_hash().unwrap().to_byte_array()),
2019 version: WitnessVersion::V1.to_num(),
2020 program: Vec::from(&tweaked_pubkey.serialize()[..]),
2027 fn builds_invoice_with_allow_mpp() {
2028 let mut features = Bolt12InvoiceFeatures::empty();
2029 features.set_basic_mpp_optional();
2031 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2034 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2036 .sign(payer_sign).unwrap()
2037 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2040 .sign(recipient_sign).unwrap();
2041 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
2042 assert_eq!(invoice.invoice_features(), &features);
2043 assert_eq!(tlv_stream.features, Some(&features));
2047 fn fails_signing_invoice() {
2048 match OfferBuilder::new("foo".into(), recipient_pubkey())
2051 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2053 .sign(payer_sign).unwrap()
2054 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2058 Ok(_) => panic!("expected error"),
2059 Err(e) => assert_eq!(e, SignError::Signing),
2062 match OfferBuilder::new("foo".into(), recipient_pubkey())
2065 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2067 .sign(payer_sign).unwrap()
2068 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2072 Ok(_) => panic!("expected error"),
2073 Err(e) => assert_eq!(e, SignError::Verification(secp256k1::Error::InvalidSignature)),
2078 fn parses_invoice_with_payment_paths() {
2079 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2082 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2084 .sign(payer_sign).unwrap()
2085 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2087 .sign(recipient_sign).unwrap();
2089 let mut buffer = Vec::new();
2090 invoice.write(&mut buffer).unwrap();
2092 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2093 panic!("error parsing invoice: {:?}", e);
2096 let mut tlv_stream = invoice.as_tlv_stream();
2097 tlv_stream.3.paths = None;
2099 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2100 Ok(_) => panic!("expected error"),
2101 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaths)),
2104 let mut tlv_stream = invoice.as_tlv_stream();
2105 tlv_stream.3.blindedpay = None;
2107 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2108 Ok(_) => panic!("expected error"),
2109 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidPayInfo)),
2112 let empty_payment_paths = vec![];
2113 let mut tlv_stream = invoice.as_tlv_stream();
2114 tlv_stream.3.paths = Some(Iterable(empty_payment_paths.iter().map(|(_, path)| path)));
2116 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2117 Ok(_) => panic!("expected error"),
2118 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaths)),
2121 let mut payment_paths = payment_paths();
2122 payment_paths.pop();
2123 let mut tlv_stream = invoice.as_tlv_stream();
2124 tlv_stream.3.blindedpay = Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo)));
2126 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2127 Ok(_) => panic!("expected error"),
2128 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidPayInfo)),
2133 fn parses_invoice_with_created_at() {
2134 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2137 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2139 .sign(payer_sign).unwrap()
2140 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2142 .sign(recipient_sign).unwrap();
2144 let mut buffer = Vec::new();
2145 invoice.write(&mut buffer).unwrap();
2147 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2148 panic!("error parsing invoice: {:?}", e);
2151 let mut tlv_stream = invoice.as_tlv_stream();
2152 tlv_stream.3.created_at = None;
2154 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2155 Ok(_) => panic!("expected error"),
2157 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingCreationTime));
2163 fn parses_invoice_with_relative_expiry() {
2164 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2167 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2169 .sign(payer_sign).unwrap()
2170 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2171 .relative_expiry(3600)
2173 .sign(recipient_sign).unwrap();
2175 let mut buffer = Vec::new();
2176 invoice.write(&mut buffer).unwrap();
2178 match Bolt12Invoice::try_from(buffer) {
2179 Ok(invoice) => assert_eq!(invoice.relative_expiry(), Duration::from_secs(3600)),
2180 Err(e) => panic!("error parsing invoice: {:?}", e),
2185 fn parses_invoice_with_payment_hash() {
2186 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2189 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2191 .sign(payer_sign).unwrap()
2192 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2194 .sign(recipient_sign).unwrap();
2196 let mut buffer = Vec::new();
2197 invoice.write(&mut buffer).unwrap();
2199 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2200 panic!("error parsing invoice: {:?}", e);
2203 let mut tlv_stream = invoice.as_tlv_stream();
2204 tlv_stream.3.payment_hash = None;
2206 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2207 Ok(_) => panic!("expected error"),
2209 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaymentHash));
2215 fn parses_invoice_with_amount() {
2216 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2219 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2221 .sign(payer_sign).unwrap()
2222 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2224 .sign(recipient_sign).unwrap();
2226 let mut buffer = Vec::new();
2227 invoice.write(&mut buffer).unwrap();
2229 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2230 panic!("error parsing invoice: {:?}", e);
2233 let mut tlv_stream = invoice.as_tlv_stream();
2234 tlv_stream.3.amount = None;
2236 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2237 Ok(_) => panic!("expected error"),
2238 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount)),
2243 fn parses_invoice_with_allow_mpp() {
2244 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2247 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2249 .sign(payer_sign).unwrap()
2250 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2253 .sign(recipient_sign).unwrap();
2255 let mut buffer = Vec::new();
2256 invoice.write(&mut buffer).unwrap();
2258 match Bolt12Invoice::try_from(buffer) {
2260 let mut features = Bolt12InvoiceFeatures::empty();
2261 features.set_basic_mpp_optional();
2262 assert_eq!(invoice.invoice_features(), &features);
2264 Err(e) => panic!("error parsing invoice: {:?}", e),
2269 fn parses_invoice_with_fallback_address() {
2270 let script = ScriptBuf::new();
2271 let pubkey = bitcoin::key::PublicKey::new(recipient_pubkey());
2272 let x_only_pubkey = XOnlyPublicKey::from_keypair(&recipient_keys()).0;
2273 let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(x_only_pubkey);
2275 let offer = OfferBuilder::new("foo".into(), recipient_pubkey())
2278 let invoice_request = offer
2279 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2281 .sign(payer_sign).unwrap();
2282 #[cfg(not(c_bindings))]
2283 let invoice_builder = invoice_request
2284 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap();
2286 let mut invoice_builder = invoice_request
2287 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap();
2288 let invoice_builder = invoice_builder
2289 .fallback_v0_p2wsh(&script.wscript_hash())
2290 .fallback_v0_p2wpkh(&pubkey.wpubkey_hash().unwrap())
2291 .fallback_v1_p2tr_tweaked(&tweaked_pubkey);
2292 #[cfg(not(c_bindings))]
2293 let mut invoice_builder = invoice_builder;
2295 // Only standard addresses will be included.
2296 let fallbacks = invoice_builder.invoice.fields_mut().fallbacks.as_mut().unwrap();
2297 // Non-standard addresses
2298 fallbacks.push(FallbackAddress { version: 1, program: vec![0u8; 41] });
2299 fallbacks.push(FallbackAddress { version: 2, program: vec![0u8; 1] });
2300 fallbacks.push(FallbackAddress { version: 17, program: vec![0u8; 40] });
2302 fallbacks.push(FallbackAddress { version: 1, program: vec![0u8; 33] });
2303 fallbacks.push(FallbackAddress { version: 2, program: vec![0u8; 40] });
2305 let invoice = invoice_builder.build().unwrap().sign(recipient_sign).unwrap();
2306 let mut buffer = Vec::new();
2307 invoice.write(&mut buffer).unwrap();
2309 match Bolt12Invoice::try_from(buffer) {
2311 let v1_witness_program = WitnessProgram::new(WitnessVersion::V1, vec![0u8; 33]).unwrap();
2312 let v2_witness_program = WitnessProgram::new(WitnessVersion::V2, vec![0u8; 40]).unwrap();
2314 invoice.fallbacks(),
2316 Address::p2wsh(&script, Network::Bitcoin),
2317 Address::p2wpkh(&pubkey, Network::Bitcoin).unwrap(),
2318 Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin),
2319 Address::new(Network::Bitcoin, Payload::WitnessProgram(v1_witness_program)),
2320 Address::new(Network::Bitcoin, Payload::WitnessProgram(v2_witness_program)),
2324 Err(e) => panic!("error parsing invoice: {:?}", e),
2329 fn parses_invoice_with_node_id() {
2330 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2333 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2335 .sign(payer_sign).unwrap()
2336 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2338 .sign(recipient_sign).unwrap();
2340 let mut buffer = Vec::new();
2341 invoice.write(&mut buffer).unwrap();
2343 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2344 panic!("error parsing invoice: {:?}", e);
2347 let mut tlv_stream = invoice.as_tlv_stream();
2348 tlv_stream.3.node_id = None;
2350 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2351 Ok(_) => panic!("expected error"),
2353 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey));
2357 let invalid_pubkey = payer_pubkey();
2358 let mut tlv_stream = invoice.as_tlv_stream();
2359 tlv_stream.3.node_id = Some(&invalid_pubkey);
2361 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2362 Ok(_) => panic!("expected error"),
2364 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidSigningPubkey));
2370 fn fails_parsing_invoice_without_signature() {
2371 let mut buffer = Vec::new();
2372 OfferBuilder::new("foo".into(), recipient_pubkey())
2375 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2377 .sign(payer_sign).unwrap()
2378 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2381 .write(&mut buffer).unwrap();
2383 match Bolt12Invoice::try_from(buffer) {
2384 Ok(_) => panic!("expected error"),
2385 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
2390 fn fails_parsing_invoice_with_invalid_signature() {
2391 let mut invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2394 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2396 .sign(payer_sign).unwrap()
2397 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2399 .sign(recipient_sign).unwrap();
2400 let last_signature_byte = invoice.bytes.last_mut().unwrap();
2401 *last_signature_byte = last_signature_byte.wrapping_add(1);
2403 let mut buffer = Vec::new();
2404 invoice.write(&mut buffer).unwrap();
2406 match Bolt12Invoice::try_from(buffer) {
2407 Ok(_) => panic!("expected error"),
2409 assert_eq!(e, Bolt12ParseError::InvalidSignature(secp256k1::Error::InvalidSignature));
2415 fn fails_parsing_invoice_with_extra_tlv_records() {
2416 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2419 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2421 .sign(payer_sign).unwrap()
2422 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2424 .sign(recipient_sign).unwrap();
2426 let mut encoded_invoice = Vec::new();
2427 invoice.write(&mut encoded_invoice).unwrap();
2428 BigSize(1002).write(&mut encoded_invoice).unwrap();
2429 BigSize(32).write(&mut encoded_invoice).unwrap();
2430 [42u8; 32].write(&mut encoded_invoice).unwrap();
2432 match Bolt12Invoice::try_from(encoded_invoice) {
2433 Ok(_) => panic!("expected error"),
2434 Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),