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::types::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::{WitnessProgram, Network, WitnessVersion, WPubkeyHash, WScriptHash};
106 use bitcoin::blockdata::constants::ChainHash;
107 use bitcoin::secp256k1::{Keypair, PublicKey, Secp256k1, self};
108 use bitcoin::secp256k1::schnorr::Signature;
109 use bitcoin::address::{Address, Payload};
110 use bitcoin::key::TweakedPublicKey;
111 use core::time::Duration;
112 use core::hash::{Hash, Hasher};
114 use crate::blinded_path::BlindedPath;
115 use crate::ln::types::PaymentHash;
116 use crate::ln::channelmanager::PaymentId;
117 use crate::ln::features::{BlindedHopFeatures, Bolt12InvoiceFeatures, InvoiceRequestFeatures, OfferFeatures};
118 use crate::ln::inbound_payment::ExpandedKey;
119 use crate::ln::msgs::DecodeError;
120 use crate::offers::invoice_request::{INVOICE_REQUEST_PAYER_ID_TYPE, INVOICE_REQUEST_TYPES, IV_BYTES as INVOICE_REQUEST_IV_BYTES, InvoiceRequest, InvoiceRequestContents, InvoiceRequestTlvStream, InvoiceRequestTlvStreamRef};
121 use crate::offers::merkle::{SignError, SignFn, SignatureTlvStream, SignatureTlvStreamRef, TaggedHash, TlvStream, WithoutSignatures, self};
122 use crate::offers::offer::{Amount, OFFER_TYPES, OfferTlvStream, OfferTlvStreamRef, Quantity};
123 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError, ParsedMessage};
124 use crate::offers::payer::{PAYER_METADATA_TYPE, PayerTlvStream, PayerTlvStreamRef};
125 use crate::offers::refund::{IV_BYTES as REFUND_IV_BYTES, Refund, RefundContents};
126 use crate::offers::signer;
127 use crate::util::ser::{HighZeroBytesDroppedBigSize, Iterable, Readable, SeekReadable, WithoutLength, Writeable, Writer};
128 use crate::util::string::PrintableString;
130 #[allow(unused_imports)]
131 use crate::prelude::*;
133 #[cfg(feature = "std")]
134 use std::time::SystemTime;
136 pub(crate) const DEFAULT_RELATIVE_EXPIRY: Duration = Duration::from_secs(7200);
138 /// Tag for the hash function used when signing a [`Bolt12Invoice`]'s merkle root.
139 pub const SIGNATURE_TAG: &'static str = concat!("lightning", "invoice", "signature");
141 /// Builds a [`Bolt12Invoice`] from either:
142 /// - an [`InvoiceRequest`] for the "offer to be paid" flow or
143 /// - a [`Refund`] for the "offer for money" flow.
145 /// See [module-level documentation] for usage.
147 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
149 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
150 /// [`Refund`]: crate::offers::refund::Refund
151 /// [module-level documentation]: self
152 pub struct InvoiceBuilder<'a, S: SigningPubkeyStrategy> {
153 invreq_bytes: &'a Vec<u8>,
154 invoice: InvoiceContents,
155 signing_pubkey_strategy: S,
158 /// Builds a [`Bolt12Invoice`] from either:
159 /// - an [`InvoiceRequest`] for the "offer to be paid" flow or
160 /// - a [`Refund`] for the "offer for money" flow.
162 /// See [module-level documentation] for usage.
164 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
165 /// [`Refund`]: crate::offers::refund::Refund
166 /// [module-level documentation]: self
168 pub struct InvoiceWithExplicitSigningPubkeyBuilder<'a> {
169 invreq_bytes: &'a Vec<u8>,
170 invoice: InvoiceContents,
171 signing_pubkey_strategy: ExplicitSigningPubkey,
174 /// Builds a [`Bolt12Invoice`] from either:
175 /// - an [`InvoiceRequest`] for the "offer to be paid" flow or
176 /// - a [`Refund`] for the "offer for money" flow.
178 /// See [module-level documentation] for usage.
180 /// [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
181 /// [`Refund`]: crate::offers::refund::Refund
182 /// [module-level documentation]: self
184 pub struct InvoiceWithDerivedSigningPubkeyBuilder<'a> {
185 invreq_bytes: &'a Vec<u8>,
186 invoice: InvoiceContents,
187 signing_pubkey_strategy: DerivedSigningPubkey,
190 /// Indicates how [`Bolt12Invoice::signing_pubkey`] was set.
192 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
193 pub trait SigningPubkeyStrategy {}
195 /// [`Bolt12Invoice::signing_pubkey`] was explicitly set.
197 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
198 pub struct ExplicitSigningPubkey {}
200 /// [`Bolt12Invoice::signing_pubkey`] was derived.
202 /// This is not exported to bindings users as builder patterns don't map outside of move semantics.
203 pub struct DerivedSigningPubkey(Keypair);
205 impl SigningPubkeyStrategy for ExplicitSigningPubkey {}
206 impl SigningPubkeyStrategy for DerivedSigningPubkey {}
208 macro_rules! invoice_explicit_signing_pubkey_builder_methods { ($self: ident, $self_type: ty) => {
209 #[cfg_attr(c_bindings, allow(dead_code))]
210 pub(super) fn for_offer(
211 invoice_request: &'a InvoiceRequest, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
212 created_at: Duration, payment_hash: PaymentHash, signing_pubkey: PublicKey
213 ) -> Result<Self, Bolt12SemanticError> {
214 let amount_msats = Self::amount_msats(invoice_request)?;
215 let contents = InvoiceContents::ForOffer {
216 invoice_request: invoice_request.contents.clone(),
217 fields: Self::fields(
218 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
222 Self::new(&invoice_request.bytes, contents, ExplicitSigningPubkey {})
225 #[cfg_attr(c_bindings, allow(dead_code))]
226 pub(super) fn for_refund(
227 refund: &'a Refund, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
228 payment_hash: PaymentHash, signing_pubkey: PublicKey
229 ) -> Result<Self, Bolt12SemanticError> {
230 let amount_msats = refund.amount_msats();
231 let contents = InvoiceContents::ForRefund {
232 refund: refund.contents.clone(),
233 fields: Self::fields(
234 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
238 Self::new(&refund.bytes, contents, ExplicitSigningPubkey {})
241 /// Builds an unsigned [`Bolt12Invoice`] after checking for valid semantics. It can be signed by
242 /// [`UnsignedBolt12Invoice::sign`].
243 pub fn build($self: $self_type) -> Result<UnsignedBolt12Invoice, Bolt12SemanticError> {
244 #[cfg(feature = "std")] {
245 if $self.invoice.is_offer_or_refund_expired() {
246 return Err(Bolt12SemanticError::AlreadyExpired);
250 #[cfg(not(feature = "std"))] {
251 if $self.invoice.is_offer_or_refund_expired_no_std($self.invoice.created_at()) {
252 return Err(Bolt12SemanticError::AlreadyExpired);
256 let Self { invreq_bytes, invoice, .. } = $self;
257 #[cfg(not(c_bindings))] {
258 Ok(UnsignedBolt12Invoice::new(invreq_bytes, invoice))
261 Ok(UnsignedBolt12Invoice::new(invreq_bytes, invoice.clone()))
266 macro_rules! invoice_derived_signing_pubkey_builder_methods { ($self: ident, $self_type: ty) => {
267 #[cfg_attr(c_bindings, allow(dead_code))]
268 pub(super) fn for_offer_using_keys(
269 invoice_request: &'a InvoiceRequest, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>,
270 created_at: Duration, payment_hash: PaymentHash, keys: Keypair
271 ) -> Result<Self, Bolt12SemanticError> {
272 let amount_msats = Self::amount_msats(invoice_request)?;
273 let signing_pubkey = keys.public_key();
274 let contents = InvoiceContents::ForOffer {
275 invoice_request: invoice_request.contents.clone(),
276 fields: Self::fields(
277 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
281 Self::new(&invoice_request.bytes, contents, DerivedSigningPubkey(keys))
284 #[cfg_attr(c_bindings, allow(dead_code))]
285 pub(super) fn for_refund_using_keys(
286 refund: &'a Refund, payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
287 payment_hash: PaymentHash, keys: Keypair,
288 ) -> Result<Self, Bolt12SemanticError> {
289 let amount_msats = refund.amount_msats();
290 let signing_pubkey = keys.public_key();
291 let contents = InvoiceContents::ForRefund {
292 refund: refund.contents.clone(),
293 fields: Self::fields(
294 payment_paths, created_at, payment_hash, amount_msats, signing_pubkey
298 Self::new(&refund.bytes, contents, DerivedSigningPubkey(keys))
301 /// Builds a signed [`Bolt12Invoice`] after checking for valid semantics.
302 pub fn build_and_sign<T: secp256k1::Signing>(
303 $self: $self_type, secp_ctx: &Secp256k1<T>
304 ) -> Result<Bolt12Invoice, Bolt12SemanticError> {
305 #[cfg(feature = "std")] {
306 if $self.invoice.is_offer_or_refund_expired() {
307 return Err(Bolt12SemanticError::AlreadyExpired);
311 #[cfg(not(feature = "std"))] {
312 if $self.invoice.is_offer_or_refund_expired_no_std($self.invoice.created_at()) {
313 return Err(Bolt12SemanticError::AlreadyExpired);
318 invreq_bytes, invoice, signing_pubkey_strategy: DerivedSigningPubkey(keys)
320 #[cfg(not(c_bindings))]
321 let unsigned_invoice = UnsignedBolt12Invoice::new(invreq_bytes, invoice);
323 let mut unsigned_invoice = UnsignedBolt12Invoice::new(invreq_bytes, invoice.clone());
325 let invoice = unsigned_invoice
326 .sign(|message: &UnsignedBolt12Invoice|
327 Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
334 macro_rules! invoice_builder_methods { (
335 $self: ident, $self_type: ty, $return_type: ty, $return_value: expr, $type_param: ty $(, $self_mut: tt)?
337 pub(crate) fn amount_msats(
338 invoice_request: &InvoiceRequest
339 ) -> Result<u64, Bolt12SemanticError> {
340 match invoice_request.amount_msats() {
341 Some(amount_msats) => Ok(amount_msats),
342 None => match invoice_request.contents.inner.offer.amount() {
343 Some(Amount::Bitcoin { amount_msats }) => {
344 amount_msats.checked_mul(invoice_request.quantity().unwrap_or(1))
345 .ok_or(Bolt12SemanticError::InvalidAmount)
347 Some(Amount::Currency { .. }) => Err(Bolt12SemanticError::UnsupportedCurrency),
348 None => Err(Bolt12SemanticError::MissingAmount),
353 #[cfg_attr(c_bindings, allow(dead_code))]
355 payment_paths: Vec<(BlindedPayInfo, BlindedPath)>, created_at: Duration,
356 payment_hash: PaymentHash, amount_msats: u64, signing_pubkey: PublicKey
359 payment_paths, created_at, relative_expiry: None, payment_hash, amount_msats,
360 fallbacks: None, features: Bolt12InvoiceFeatures::empty(), signing_pubkey,
364 #[cfg_attr(c_bindings, allow(dead_code))]
366 invreq_bytes: &'a Vec<u8>, contents: InvoiceContents, signing_pubkey_strategy: $type_param
367 ) -> Result<Self, Bolt12SemanticError> {
368 if contents.fields().payment_paths.is_empty() {
369 return Err(Bolt12SemanticError::MissingPaths);
372 Ok(Self { invreq_bytes, invoice: contents, signing_pubkey_strategy })
375 /// Sets the [`Bolt12Invoice::relative_expiry`] as seconds since [`Bolt12Invoice::created_at`].
376 /// Any expiry that has already passed is valid and can be checked for using
377 /// [`Bolt12Invoice::is_expired`].
379 /// Successive calls to this method will override the previous setting.
380 pub fn relative_expiry($($self_mut)* $self: $self_type, relative_expiry_secs: u32) -> $return_type {
381 let relative_expiry = Duration::from_secs(relative_expiry_secs as u64);
382 $self.invoice.fields_mut().relative_expiry = Some(relative_expiry);
386 /// Adds a P2WSH address to [`Bolt12Invoice::fallbacks`].
388 /// Successive calls to this method will add another address. Caller is responsible for not
389 /// adding duplicate addresses and only calling if capable of receiving to P2WSH addresses.
390 pub fn fallback_v0_p2wsh($($self_mut)* $self: $self_type, script_hash: &WScriptHash) -> $return_type {
391 use bitcoin::hashes::Hash;
392 let address = FallbackAddress {
393 version: WitnessVersion::V0.to_num(),
394 program: Vec::from(script_hash.to_byte_array()),
396 $self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
400 /// Adds a P2WPKH address to [`Bolt12Invoice::fallbacks`].
402 /// Successive calls to this method will add another address. Caller is responsible for not
403 /// adding duplicate addresses and only calling if capable of receiving to P2WPKH addresses.
404 pub fn fallback_v0_p2wpkh($($self_mut)* $self: $self_type, pubkey_hash: &WPubkeyHash) -> $return_type {
405 use bitcoin::hashes::Hash;
406 let address = FallbackAddress {
407 version: WitnessVersion::V0.to_num(),
408 program: Vec::from(pubkey_hash.to_byte_array()),
410 $self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
414 /// Adds a P2TR address to [`Bolt12Invoice::fallbacks`].
416 /// Successive calls to this method will add another address. Caller is responsible for not
417 /// adding duplicate addresses and only calling if capable of receiving to P2TR addresses.
418 pub fn fallback_v1_p2tr_tweaked($($self_mut)* $self: $self_type, output_key: &TweakedPublicKey) -> $return_type {
419 let address = FallbackAddress {
420 version: WitnessVersion::V1.to_num(),
421 program: Vec::from(&output_key.serialize()[..]),
423 $self.invoice.fields_mut().fallbacks.get_or_insert_with(Vec::new).push(address);
427 /// Sets [`Bolt12Invoice::invoice_features`] to indicate MPP may be used. Otherwise, MPP is
429 pub fn allow_mpp($($self_mut)* $self: $self_type) -> $return_type {
430 $self.invoice.fields_mut().features.set_basic_mpp_optional();
435 impl<'a> InvoiceBuilder<'a, ExplicitSigningPubkey> {
436 invoice_explicit_signing_pubkey_builder_methods!(self, Self);
439 impl<'a> InvoiceBuilder<'a, DerivedSigningPubkey> {
440 invoice_derived_signing_pubkey_builder_methods!(self, Self);
443 impl<'a, S: SigningPubkeyStrategy> InvoiceBuilder<'a, S> {
444 invoice_builder_methods!(self, Self, Self, self, S, mut);
447 #[cfg(all(c_bindings, not(test)))]
448 impl<'a> InvoiceWithExplicitSigningPubkeyBuilder<'a> {
449 invoice_explicit_signing_pubkey_builder_methods!(self, &mut Self);
450 invoice_builder_methods!(self, &mut Self, (), (), ExplicitSigningPubkey);
453 #[cfg(all(c_bindings, test))]
454 impl<'a> InvoiceWithExplicitSigningPubkeyBuilder<'a> {
455 invoice_explicit_signing_pubkey_builder_methods!(self, &mut Self);
456 invoice_builder_methods!(self, &mut Self, &mut Self, self, ExplicitSigningPubkey);
459 #[cfg(all(c_bindings, not(test)))]
460 impl<'a> InvoiceWithDerivedSigningPubkeyBuilder<'a> {
461 invoice_derived_signing_pubkey_builder_methods!(self, &mut Self);
462 invoice_builder_methods!(self, &mut Self, (), (), DerivedSigningPubkey);
465 #[cfg(all(c_bindings, test))]
466 impl<'a> InvoiceWithDerivedSigningPubkeyBuilder<'a> {
467 invoice_derived_signing_pubkey_builder_methods!(self, &mut Self);
468 invoice_builder_methods!(self, &mut Self, &mut Self, self, DerivedSigningPubkey);
472 impl<'a> From<InvoiceWithExplicitSigningPubkeyBuilder<'a>>
473 for InvoiceBuilder<'a, ExplicitSigningPubkey> {
474 fn from(builder: InvoiceWithExplicitSigningPubkeyBuilder<'a>) -> Self {
475 let InvoiceWithExplicitSigningPubkeyBuilder {
476 invreq_bytes, invoice, signing_pubkey_strategy,
480 invreq_bytes, invoice, signing_pubkey_strategy,
486 impl<'a> From<InvoiceWithDerivedSigningPubkeyBuilder<'a>>
487 for InvoiceBuilder<'a, DerivedSigningPubkey> {
488 fn from(builder: InvoiceWithDerivedSigningPubkeyBuilder<'a>) -> Self {
489 let InvoiceWithDerivedSigningPubkeyBuilder {
490 invreq_bytes, invoice, signing_pubkey_strategy,
494 invreq_bytes, invoice, signing_pubkey_strategy,
499 /// A semantically valid [`Bolt12Invoice`] that hasn't been signed.
503 /// This is serialized as a TLV stream, which includes TLV records from the originating message. As
504 /// 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) -> Option<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) -> Option<PrintableString> {
957 InvoiceContents::ForOffer { invoice_request, .. } => {
958 invoice_request.inner.offer.description()
960 InvoiceContents::ForRefund { refund, .. } => Some(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.clone();
1097 let witness_program = match WitnessProgram::new(version, program) {
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 Readable for Bolt12Invoice {
1209 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
1210 let bytes: WithoutLength<Vec<u8>> = Readable::read(reader)?;
1211 Self::try_from(bytes.0).map_err(|_| DecodeError::InvalidValue)
1215 impl Writeable for InvoiceContents {
1216 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1217 self.as_tlv_stream().write(writer)
1221 impl TryFrom<Vec<u8>> for UnsignedBolt12Invoice {
1222 type Error = Bolt12ParseError;
1224 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1225 let invoice = ParsedMessage::<PartialInvoiceTlvStream>::try_from(bytes)?;
1226 let ParsedMessage { bytes, tlv_stream } = invoice;
1228 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1230 let contents = InvoiceContents::try_from(
1231 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream)
1234 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
1236 Ok(UnsignedBolt12Invoice { bytes, contents, tagged_hash })
1240 impl TryFrom<Vec<u8>> for Bolt12Invoice {
1241 type Error = Bolt12ParseError;
1243 fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error> {
1244 let parsed_invoice = ParsedMessage::<FullInvoiceTlvStream>::try_from(bytes)?;
1245 Bolt12Invoice::try_from(parsed_invoice)
1249 tlv_stream!(InvoiceTlvStream, InvoiceTlvStreamRef, 160..240, {
1250 (160, paths: (Vec<BlindedPath>, WithoutLength, Iterable<'a, BlindedPathIter<'a>, BlindedPath>)),
1251 (162, blindedpay: (Vec<BlindedPayInfo>, WithoutLength, Iterable<'a, BlindedPayInfoIter<'a>, BlindedPayInfo>)),
1252 (164, created_at: (u64, HighZeroBytesDroppedBigSize)),
1253 (166, relative_expiry: (u32, HighZeroBytesDroppedBigSize)),
1254 (168, payment_hash: PaymentHash),
1255 (170, amount: (u64, HighZeroBytesDroppedBigSize)),
1256 (172, fallbacks: (Vec<FallbackAddress>, WithoutLength)),
1257 (174, features: (Bolt12InvoiceFeatures, WithoutLength)),
1258 (176, node_id: PublicKey),
1261 type BlindedPathIter<'a> = core::iter::Map<
1262 core::slice::Iter<'a, (BlindedPayInfo, BlindedPath)>,
1263 for<'r> fn(&'r (BlindedPayInfo, BlindedPath)) -> &'r BlindedPath,
1266 type BlindedPayInfoIter<'a> = core::iter::Map<
1267 core::slice::Iter<'a, (BlindedPayInfo, BlindedPath)>,
1268 for<'r> fn(&'r (BlindedPayInfo, BlindedPath)) -> &'r BlindedPayInfo,
1271 /// Information needed to route a payment across a [`BlindedPath`].
1272 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
1273 pub struct BlindedPayInfo {
1274 /// Base fee charged (in millisatoshi) for the entire blinded path.
1275 pub fee_base_msat: u32,
1277 /// Liquidity fee charged (in millionths of the amount transferred) for the entire blinded path
1278 /// (i.e., 10,000 is 1%).
1279 pub fee_proportional_millionths: u32,
1281 /// Number of blocks subtracted from an incoming HTLC's `cltv_expiry` for the entire blinded
1283 pub cltv_expiry_delta: u16,
1285 /// The minimum HTLC value (in millisatoshi) that is acceptable to all channel peers on the
1286 /// blinded path from the introduction node to the recipient, accounting for any fees, i.e., as
1287 /// seen by the recipient.
1288 pub htlc_minimum_msat: u64,
1290 /// The maximum HTLC value (in millisatoshi) that is acceptable to all channel peers on the
1291 /// blinded path from the introduction node to the recipient, accounting for any fees, i.e., as
1292 /// seen by the recipient.
1293 pub htlc_maximum_msat: u64,
1295 /// Features set in `encrypted_data_tlv` for the `encrypted_recipient_data` TLV record in an
1297 pub features: BlindedHopFeatures,
1300 impl_writeable!(BlindedPayInfo, {
1302 fee_proportional_millionths,
1309 /// Wire representation for an on-chain fallback address.
1310 #[derive(Clone, Debug, PartialEq)]
1311 pub(super) struct FallbackAddress {
1316 impl_writeable!(FallbackAddress, { version, program });
1318 type FullInvoiceTlvStream =
1319 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream, SignatureTlvStream);
1321 type FullInvoiceTlvStreamRef<'a> = (
1322 PayerTlvStreamRef<'a>,
1323 OfferTlvStreamRef<'a>,
1324 InvoiceRequestTlvStreamRef<'a>,
1325 InvoiceTlvStreamRef<'a>,
1326 SignatureTlvStreamRef<'a>,
1329 impl SeekReadable for FullInvoiceTlvStream {
1330 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1331 let payer = SeekReadable::read(r)?;
1332 let offer = SeekReadable::read(r)?;
1333 let invoice_request = SeekReadable::read(r)?;
1334 let invoice = SeekReadable::read(r)?;
1335 let signature = SeekReadable::read(r)?;
1337 Ok((payer, offer, invoice_request, invoice, signature))
1341 type PartialInvoiceTlvStream =
1342 (PayerTlvStream, OfferTlvStream, InvoiceRequestTlvStream, InvoiceTlvStream);
1344 type PartialInvoiceTlvStreamRef<'a> = (
1345 PayerTlvStreamRef<'a>,
1346 OfferTlvStreamRef<'a>,
1347 InvoiceRequestTlvStreamRef<'a>,
1348 InvoiceTlvStreamRef<'a>,
1351 impl SeekReadable for PartialInvoiceTlvStream {
1352 fn read<R: io::Read + io::Seek>(r: &mut R) -> Result<Self, DecodeError> {
1353 let payer = SeekReadable::read(r)?;
1354 let offer = SeekReadable::read(r)?;
1355 let invoice_request = SeekReadable::read(r)?;
1356 let invoice = SeekReadable::read(r)?;
1358 Ok((payer, offer, invoice_request, invoice))
1362 impl TryFrom<ParsedMessage<FullInvoiceTlvStream>> for Bolt12Invoice {
1363 type Error = Bolt12ParseError;
1365 fn try_from(invoice: ParsedMessage<FullInvoiceTlvStream>) -> Result<Self, Self::Error> {
1366 let ParsedMessage { bytes, tlv_stream } = invoice;
1368 payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream,
1369 SignatureTlvStream { signature },
1371 let contents = InvoiceContents::try_from(
1372 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream, invoice_tlv_stream)
1375 let signature = match signature {
1376 None => return Err(Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
1377 Some(signature) => signature,
1379 let tagged_hash = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &bytes);
1380 let pubkey = contents.fields().signing_pubkey;
1381 merkle::verify_signature(&signature, &tagged_hash, pubkey)?;
1383 Ok(Bolt12Invoice { bytes, contents, signature, tagged_hash })
1387 impl TryFrom<PartialInvoiceTlvStream> for InvoiceContents {
1388 type Error = Bolt12SemanticError;
1390 fn try_from(tlv_stream: PartialInvoiceTlvStream) -> Result<Self, Self::Error> {
1394 invoice_request_tlv_stream,
1396 paths, blindedpay, created_at, relative_expiry, payment_hash, amount, fallbacks,
1401 let payment_paths = match (blindedpay, paths) {
1402 (_, None) => return Err(Bolt12SemanticError::MissingPaths),
1403 (None, _) => return Err(Bolt12SemanticError::InvalidPayInfo),
1404 (_, Some(paths)) if paths.is_empty() => return Err(Bolt12SemanticError::MissingPaths),
1405 (Some(blindedpay), Some(paths)) if paths.len() != blindedpay.len() => {
1406 return Err(Bolt12SemanticError::InvalidPayInfo);
1408 (Some(blindedpay), Some(paths)) => {
1409 blindedpay.into_iter().zip(paths.into_iter()).collect::<Vec<_>>()
1413 let created_at = match created_at {
1414 None => return Err(Bolt12SemanticError::MissingCreationTime),
1415 Some(timestamp) => Duration::from_secs(timestamp),
1418 let relative_expiry = relative_expiry
1419 .map(Into::<u64>::into)
1420 .map(Duration::from_secs);
1422 let payment_hash = match payment_hash {
1423 None => return Err(Bolt12SemanticError::MissingPaymentHash),
1424 Some(payment_hash) => payment_hash,
1427 let amount_msats = match amount {
1428 None => return Err(Bolt12SemanticError::MissingAmount),
1429 Some(amount) => amount,
1432 let features = features.unwrap_or_else(Bolt12InvoiceFeatures::empty);
1434 let signing_pubkey = match node_id {
1435 None => return Err(Bolt12SemanticError::MissingSigningPubkey),
1436 Some(node_id) => node_id,
1439 let fields = InvoiceFields {
1440 payment_paths, created_at, relative_expiry, payment_hash, amount_msats, fallbacks,
1441 features, signing_pubkey,
1444 match (offer_tlv_stream.node_id, &offer_tlv_stream.paths) {
1445 (Some(expected_signing_pubkey), _) => {
1446 if fields.signing_pubkey != expected_signing_pubkey {
1447 return Err(Bolt12SemanticError::InvalidSigningPubkey);
1450 let invoice_request = InvoiceRequestContents::try_from(
1451 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1453 Ok(InvoiceContents::ForOffer { invoice_request, fields })
1455 (None, Some(paths)) => {
1458 .filter_map(|path| path.blinded_hops.last())
1459 .any(|last_hop| fields.signing_pubkey == last_hop.blinded_node_id)
1461 return Err(Bolt12SemanticError::InvalidSigningPubkey);
1464 let invoice_request = InvoiceRequestContents::try_from(
1465 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1467 Ok(InvoiceContents::ForOffer { invoice_request, fields })
1470 let refund = RefundContents::try_from(
1471 (payer_tlv_stream, offer_tlv_stream, invoice_request_tlv_stream)
1473 Ok(InvoiceContents::ForRefund { refund, fields })
1481 use super::{Bolt12Invoice, DEFAULT_RELATIVE_EXPIRY, FallbackAddress, FullInvoiceTlvStreamRef, InvoiceTlvStreamRef, SIGNATURE_TAG, UnsignedBolt12Invoice};
1483 use bitcoin::{WitnessProgram, WitnessVersion};
1484 use bitcoin::blockdata::constants::ChainHash;
1485 use bitcoin::blockdata::script::ScriptBuf;
1486 use bitcoin::hashes::Hash;
1487 use bitcoin::network::Network;
1488 use bitcoin::secp256k1::{Keypair, Message, Secp256k1, SecretKey, XOnlyPublicKey, self};
1489 use bitcoin::address::{Address, Payload};
1490 use bitcoin::key::TweakedPublicKey;
1492 use core::time::Duration;
1494 use crate::blinded_path::{BlindedHop, BlindedPath, IntroductionNode};
1495 use crate::sign::KeyMaterial;
1496 use crate::ln::features::{Bolt12InvoiceFeatures, InvoiceRequestFeatures, OfferFeatures};
1497 use crate::ln::inbound_payment::ExpandedKey;
1498 use crate::ln::msgs::DecodeError;
1499 use crate::offers::invoice_request::InvoiceRequestTlvStreamRef;
1500 use crate::offers::merkle::{SignError, SignatureTlvStreamRef, TaggedHash, self};
1501 use crate::offers::offer::{Amount, OfferTlvStreamRef, Quantity};
1502 use crate::prelude::*;
1503 #[cfg(not(c_bindings))]
1505 crate::offers::offer::OfferBuilder,
1506 crate::offers::refund::RefundBuilder,
1510 crate::offers::offer::OfferWithExplicitMetadataBuilder as OfferBuilder,
1511 crate::offers::refund::RefundMaybeWithDerivedMetadataBuilder as RefundBuilder,
1513 use crate::offers::parse::{Bolt12ParseError, Bolt12SemanticError};
1514 use crate::offers::payer::PayerTlvStreamRef;
1515 use crate::offers::test_utils::*;
1516 use crate::util::ser::{BigSize, Iterable, Writeable};
1517 use crate::util::string::PrintableString;
1520 fn to_bytes(&self) -> Vec<u8>;
1523 impl<'a> ToBytes for FullInvoiceTlvStreamRef<'a> {
1524 fn to_bytes(&self) -> Vec<u8> {
1525 let mut buffer = Vec::new();
1526 self.0.write(&mut buffer).unwrap();
1527 self.1.write(&mut buffer).unwrap();
1528 self.2.write(&mut buffer).unwrap();
1529 self.3.write(&mut buffer).unwrap();
1530 self.4.write(&mut buffer).unwrap();
1536 fn builds_invoice_for_offer_with_defaults() {
1537 let payment_paths = payment_paths();
1538 let payment_hash = payment_hash();
1540 let unsigned_invoice = OfferBuilder::new(recipient_pubkey())
1543 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1545 .sign(payer_sign).unwrap()
1546 .respond_with_no_std(payment_paths.clone(), payment_hash, now).unwrap()
1549 let mut buffer = Vec::new();
1550 unsigned_invoice.write(&mut buffer).unwrap();
1552 assert_eq!(unsigned_invoice.bytes, buffer.as_slice());
1553 assert_eq!(unsigned_invoice.payer_metadata(), &[1; 32]);
1554 assert_eq!(unsigned_invoice.offer_chains(), Some(vec![ChainHash::using_genesis_block(Network::Bitcoin)]));
1555 assert_eq!(unsigned_invoice.metadata(), None);
1556 assert_eq!(unsigned_invoice.amount(), Some(Amount::Bitcoin { amount_msats: 1000 }));
1557 assert_eq!(unsigned_invoice.description(), Some(PrintableString("")));
1558 assert_eq!(unsigned_invoice.offer_features(), Some(&OfferFeatures::empty()));
1559 assert_eq!(unsigned_invoice.absolute_expiry(), None);
1560 assert_eq!(unsigned_invoice.message_paths(), &[]);
1561 assert_eq!(unsigned_invoice.issuer(), None);
1562 assert_eq!(unsigned_invoice.supported_quantity(), Some(Quantity::One));
1563 assert_eq!(unsigned_invoice.signing_pubkey(), recipient_pubkey());
1564 assert_eq!(unsigned_invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1565 assert_eq!(unsigned_invoice.amount_msats(), 1000);
1566 assert_eq!(unsigned_invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1567 assert_eq!(unsigned_invoice.quantity(), None);
1568 assert_eq!(unsigned_invoice.payer_id(), payer_pubkey());
1569 assert_eq!(unsigned_invoice.payer_note(), None);
1570 assert_eq!(unsigned_invoice.payment_paths(), payment_paths.as_slice());
1571 assert_eq!(unsigned_invoice.created_at(), now);
1572 assert_eq!(unsigned_invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1573 #[cfg(feature = "std")]
1574 assert!(!unsigned_invoice.is_expired());
1575 assert_eq!(unsigned_invoice.payment_hash(), payment_hash);
1576 assert_eq!(unsigned_invoice.amount_msats(), 1000);
1577 assert!(unsigned_invoice.fallbacks().is_empty());
1578 assert_eq!(unsigned_invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1579 assert_eq!(unsigned_invoice.signing_pubkey(), recipient_pubkey());
1581 match UnsignedBolt12Invoice::try_from(buffer) {
1582 Err(e) => panic!("error parsing unsigned invoice: {:?}", e),
1584 assert_eq!(parsed.bytes, unsigned_invoice.bytes);
1585 assert_eq!(parsed.tagged_hash, unsigned_invoice.tagged_hash);
1590 let mut unsigned_invoice = unsigned_invoice;
1591 let invoice = unsigned_invoice.sign(recipient_sign).unwrap();
1593 let mut buffer = Vec::new();
1594 invoice.write(&mut buffer).unwrap();
1596 assert_eq!(invoice.bytes, buffer.as_slice());
1597 assert_eq!(invoice.payer_metadata(), &[1; 32]);
1598 assert_eq!(invoice.offer_chains(), Some(vec![ChainHash::using_genesis_block(Network::Bitcoin)]));
1599 assert_eq!(invoice.metadata(), None);
1600 assert_eq!(invoice.amount(), Some(Amount::Bitcoin { amount_msats: 1000 }));
1601 assert_eq!(invoice.description(), Some(PrintableString("")));
1602 assert_eq!(invoice.offer_features(), Some(&OfferFeatures::empty()));
1603 assert_eq!(invoice.absolute_expiry(), None);
1604 assert_eq!(invoice.message_paths(), &[]);
1605 assert_eq!(invoice.issuer(), None);
1606 assert_eq!(invoice.supported_quantity(), Some(Quantity::One));
1607 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1608 assert_eq!(invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1609 assert_eq!(invoice.amount_msats(), 1000);
1610 assert_eq!(invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1611 assert_eq!(invoice.quantity(), None);
1612 assert_eq!(invoice.payer_id(), payer_pubkey());
1613 assert_eq!(invoice.payer_note(), None);
1614 assert_eq!(invoice.payment_paths(), payment_paths.as_slice());
1615 assert_eq!(invoice.created_at(), now);
1616 assert_eq!(invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1617 #[cfg(feature = "std")]
1618 assert!(!invoice.is_expired());
1619 assert_eq!(invoice.payment_hash(), payment_hash);
1620 assert_eq!(invoice.amount_msats(), 1000);
1621 assert!(invoice.fallbacks().is_empty());
1622 assert_eq!(invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1623 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1625 let message = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &invoice.bytes);
1626 assert!(merkle::verify_signature(&invoice.signature, &message, recipient_pubkey()).is_ok());
1628 let digest = Message::from_digest(invoice.signable_hash());
1629 let pubkey = recipient_pubkey().into();
1630 let secp_ctx = Secp256k1::verification_only();
1631 assert!(secp_ctx.verify_schnorr(&invoice.signature, &digest, &pubkey).is_ok());
1634 invoice.as_tlv_stream(),
1636 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1642 description: Some(&String::from("")),
1644 absolute_expiry: None,
1648 node_id: Some(&recipient_pubkey()),
1650 InvoiceRequestTlvStreamRef {
1655 payer_id: Some(&payer_pubkey()),
1659 InvoiceTlvStreamRef {
1660 paths: Some(Iterable(payment_paths.iter().map(|(_, path)| path))),
1661 blindedpay: Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo))),
1662 created_at: Some(now.as_secs()),
1663 relative_expiry: None,
1664 payment_hash: Some(&payment_hash),
1668 node_id: Some(&recipient_pubkey()),
1670 SignatureTlvStreamRef { signature: Some(&invoice.signature()) },
1674 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1675 panic!("error parsing invoice: {:?}", e);
1680 fn builds_invoice_for_refund_with_defaults() {
1681 let payment_paths = payment_paths();
1682 let payment_hash = payment_hash();
1684 let invoice = RefundBuilder::new(vec![1; 32], payer_pubkey(), 1000).unwrap()
1686 .respond_with_no_std(payment_paths.clone(), payment_hash, recipient_pubkey(), now)
1689 .sign(recipient_sign).unwrap();
1691 let mut buffer = Vec::new();
1692 invoice.write(&mut buffer).unwrap();
1694 assert_eq!(invoice.bytes, buffer.as_slice());
1695 assert_eq!(invoice.payer_metadata(), &[1; 32]);
1696 assert_eq!(invoice.offer_chains(), None);
1697 assert_eq!(invoice.metadata(), None);
1698 assert_eq!(invoice.amount(), None);
1699 assert_eq!(invoice.description(), Some(PrintableString("")));
1700 assert_eq!(invoice.offer_features(), None);
1701 assert_eq!(invoice.absolute_expiry(), None);
1702 assert_eq!(invoice.message_paths(), &[]);
1703 assert_eq!(invoice.issuer(), None);
1704 assert_eq!(invoice.supported_quantity(), None);
1705 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1706 assert_eq!(invoice.chain(), ChainHash::using_genesis_block(Network::Bitcoin));
1707 assert_eq!(invoice.amount_msats(), 1000);
1708 assert_eq!(invoice.invoice_request_features(), &InvoiceRequestFeatures::empty());
1709 assert_eq!(invoice.quantity(), None);
1710 assert_eq!(invoice.payer_id(), payer_pubkey());
1711 assert_eq!(invoice.payer_note(), None);
1712 assert_eq!(invoice.payment_paths(), payment_paths.as_slice());
1713 assert_eq!(invoice.created_at(), now);
1714 assert_eq!(invoice.relative_expiry(), DEFAULT_RELATIVE_EXPIRY);
1715 #[cfg(feature = "std")]
1716 assert!(!invoice.is_expired());
1717 assert_eq!(invoice.payment_hash(), payment_hash);
1718 assert_eq!(invoice.amount_msats(), 1000);
1719 assert!(invoice.fallbacks().is_empty());
1720 assert_eq!(invoice.invoice_features(), &Bolt12InvoiceFeatures::empty());
1721 assert_eq!(invoice.signing_pubkey(), recipient_pubkey());
1723 let message = TaggedHash::from_valid_tlv_stream_bytes(SIGNATURE_TAG, &invoice.bytes);
1724 assert!(merkle::verify_signature(&invoice.signature, &message, recipient_pubkey()).is_ok());
1727 invoice.as_tlv_stream(),
1729 PayerTlvStreamRef { metadata: Some(&vec![1; 32]) },
1735 description: Some(&String::from("")),
1737 absolute_expiry: None,
1743 InvoiceRequestTlvStreamRef {
1748 payer_id: Some(&payer_pubkey()),
1752 InvoiceTlvStreamRef {
1753 paths: Some(Iterable(payment_paths.iter().map(|(_, path)| path))),
1754 blindedpay: Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo))),
1755 created_at: Some(now.as_secs()),
1756 relative_expiry: None,
1757 payment_hash: Some(&payment_hash),
1761 node_id: Some(&recipient_pubkey()),
1763 SignatureTlvStreamRef { signature: Some(&invoice.signature()) },
1767 if let Err(e) = Bolt12Invoice::try_from(buffer) {
1768 panic!("error parsing invoice: {:?}", e);
1772 #[cfg(feature = "std")]
1774 fn builds_invoice_from_offer_with_expiration() {
1775 let future_expiry = Duration::from_secs(u64::max_value());
1776 let past_expiry = Duration::from_secs(0);
1778 if let Err(e) = OfferBuilder::new(recipient_pubkey())
1780 .absolute_expiry(future_expiry)
1782 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1784 .sign(payer_sign).unwrap()
1785 .respond_with(payment_paths(), payment_hash())
1789 panic!("error building invoice: {:?}", e);
1792 match OfferBuilder::new(recipient_pubkey())
1794 .absolute_expiry(past_expiry)
1796 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1798 .sign(payer_sign).unwrap()
1799 .respond_with(payment_paths(), payment_hash())
1803 Ok(_) => panic!("expected error"),
1804 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1808 #[cfg(feature = "std")]
1810 fn builds_invoice_from_refund_with_expiration() {
1811 let future_expiry = Duration::from_secs(u64::max_value());
1812 let past_expiry = Duration::from_secs(0);
1814 if let Err(e) = RefundBuilder::new(vec![1; 32], payer_pubkey(), 1000).unwrap()
1815 .absolute_expiry(future_expiry)
1817 .respond_with(payment_paths(), payment_hash(), recipient_pubkey())
1821 panic!("error building invoice: {:?}", e);
1824 match RefundBuilder::new(vec![1; 32], payer_pubkey(), 1000).unwrap()
1825 .absolute_expiry(past_expiry)
1827 .respond_with(payment_paths(), payment_hash(), recipient_pubkey())
1831 Ok(_) => panic!("expected error"),
1832 Err(e) => assert_eq!(e, Bolt12SemanticError::AlreadyExpired),
1837 fn builds_invoice_from_offer_using_derived_keys() {
1838 let node_id = recipient_pubkey();
1839 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1840 let entropy = FixedEntropy {};
1841 let secp_ctx = Secp256k1::new();
1843 let blinded_path = BlindedPath {
1844 introduction_node: IntroductionNode::NodeId(pubkey(40)),
1845 blinding_point: pubkey(41),
1847 BlindedHop { blinded_node_id: pubkey(42), encrypted_payload: vec![0; 43] },
1848 BlindedHop { blinded_node_id: node_id, encrypted_payload: vec![0; 44] },
1853 use crate::offers::offer::OfferWithDerivedMetadataBuilder as OfferBuilder;
1854 let offer = OfferBuilder
1855 ::deriving_signing_pubkey(node_id, &expanded_key, &entropy, &secp_ctx)
1859 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1861 .sign(payer_sign).unwrap();
1863 if let Err(e) = invoice_request.clone()
1864 .verify(&expanded_key, &secp_ctx).unwrap()
1865 .respond_using_derived_keys_no_std(payment_paths(), payment_hash(), now()).unwrap()
1866 .build_and_sign(&secp_ctx)
1868 panic!("error building invoice: {:?}", e);
1871 let expanded_key = ExpandedKey::new(&KeyMaterial([41; 32]));
1872 assert!(invoice_request.verify(&expanded_key, &secp_ctx).is_err());
1874 let offer = OfferBuilder
1875 ::deriving_signing_pubkey(node_id, &expanded_key, &entropy, &secp_ctx)
1877 // Omit the path so that node_id is used for the signing pubkey instead of deriving
1879 let invoice_request = offer.request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1881 .sign(payer_sign).unwrap();
1883 match invoice_request
1884 .verify(&expanded_key, &secp_ctx).unwrap()
1885 .respond_using_derived_keys_no_std(payment_paths(), payment_hash(), now())
1887 Ok(_) => panic!("expected error"),
1888 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidMetadata),
1893 fn builds_invoice_from_refund_using_derived_keys() {
1894 let expanded_key = ExpandedKey::new(&KeyMaterial([42; 32]));
1895 let entropy = FixedEntropy {};
1896 let secp_ctx = Secp256k1::new();
1898 let refund = RefundBuilder::new(vec![1; 32], payer_pubkey(), 1000).unwrap()
1901 if let Err(e) = refund
1902 .respond_using_derived_keys_no_std(
1903 payment_paths(), payment_hash(), now(), &expanded_key, &entropy
1906 .build_and_sign(&secp_ctx)
1908 panic!("error building invoice: {:?}", e);
1913 fn builds_invoice_with_relative_expiry() {
1915 let one_hour = Duration::from_secs(3600);
1917 let invoice = OfferBuilder::new(recipient_pubkey())
1920 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1922 .sign(payer_sign).unwrap()
1923 .respond_with_no_std(payment_paths(), payment_hash(), now).unwrap()
1924 .relative_expiry(one_hour.as_secs() as u32)
1926 .sign(recipient_sign).unwrap();
1927 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1928 #[cfg(feature = "std")]
1929 assert!(!invoice.is_expired());
1930 assert_eq!(invoice.relative_expiry(), one_hour);
1931 assert_eq!(tlv_stream.relative_expiry, Some(one_hour.as_secs() as u32));
1933 let invoice = OfferBuilder::new(recipient_pubkey())
1936 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1938 .sign(payer_sign).unwrap()
1939 .respond_with_no_std(payment_paths(), payment_hash(), now - one_hour).unwrap()
1940 .relative_expiry(one_hour.as_secs() as u32 - 1)
1942 .sign(recipient_sign).unwrap();
1943 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1944 #[cfg(feature = "std")]
1945 assert!(invoice.is_expired());
1946 assert_eq!(invoice.relative_expiry(), one_hour - Duration::from_secs(1));
1947 assert_eq!(tlv_stream.relative_expiry, Some(one_hour.as_secs() as u32 - 1));
1951 fn builds_invoice_with_amount_from_request() {
1952 let invoice = OfferBuilder::new(recipient_pubkey())
1955 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1956 .amount_msats(1001).unwrap()
1958 .sign(payer_sign).unwrap()
1959 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1961 .sign(recipient_sign).unwrap();
1962 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1963 assert_eq!(invoice.amount_msats(), 1001);
1964 assert_eq!(tlv_stream.amount, Some(1001));
1968 fn builds_invoice_with_quantity_from_request() {
1969 let invoice = OfferBuilder::new(recipient_pubkey())
1971 .supported_quantity(Quantity::Unbounded)
1973 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1974 .quantity(2).unwrap()
1976 .sign(payer_sign).unwrap()
1977 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
1979 .sign(recipient_sign).unwrap();
1980 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
1981 assert_eq!(invoice.amount_msats(), 2000);
1982 assert_eq!(tlv_stream.amount, Some(2000));
1984 match OfferBuilder::new(recipient_pubkey())
1986 .supported_quantity(Quantity::Unbounded)
1988 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
1989 .quantity(u64::max_value()).unwrap()
1991 .sign(payer_sign).unwrap()
1992 .respond_with_no_std(payment_paths(), payment_hash(), now())
1994 Ok(_) => panic!("expected error"),
1995 Err(e) => assert_eq!(e, Bolt12SemanticError::InvalidAmount),
2000 fn builds_invoice_with_fallback_address() {
2001 let script = ScriptBuf::new();
2002 let pubkey = bitcoin::key::PublicKey::new(recipient_pubkey());
2003 let x_only_pubkey = XOnlyPublicKey::from_keypair(&recipient_keys()).0;
2004 let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(x_only_pubkey);
2006 let invoice = OfferBuilder::new(recipient_pubkey())
2009 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2011 .sign(payer_sign).unwrap()
2012 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2013 .fallback_v0_p2wsh(&script.wscript_hash())
2014 .fallback_v0_p2wpkh(&pubkey.wpubkey_hash().unwrap())
2015 .fallback_v1_p2tr_tweaked(&tweaked_pubkey)
2017 .sign(recipient_sign).unwrap();
2018 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
2020 invoice.fallbacks(),
2022 Address::p2wsh(&script, Network::Bitcoin),
2023 Address::p2wpkh(&pubkey, Network::Bitcoin).unwrap(),
2024 Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin),
2028 tlv_stream.fallbacks,
2031 version: WitnessVersion::V0.to_num(),
2032 program: Vec::from(script.wscript_hash().to_byte_array()),
2035 version: WitnessVersion::V0.to_num(),
2036 program: Vec::from(pubkey.wpubkey_hash().unwrap().to_byte_array()),
2039 version: WitnessVersion::V1.to_num(),
2040 program: Vec::from(&tweaked_pubkey.serialize()[..]),
2047 fn builds_invoice_with_allow_mpp() {
2048 let mut features = Bolt12InvoiceFeatures::empty();
2049 features.set_basic_mpp_optional();
2051 let invoice = OfferBuilder::new(recipient_pubkey())
2054 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2056 .sign(payer_sign).unwrap()
2057 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2060 .sign(recipient_sign).unwrap();
2061 let (_, _, _, tlv_stream, _) = invoice.as_tlv_stream();
2062 assert_eq!(invoice.invoice_features(), &features);
2063 assert_eq!(tlv_stream.features, Some(&features));
2067 fn fails_signing_invoice() {
2068 match OfferBuilder::new(recipient_pubkey())
2071 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2073 .sign(payer_sign).unwrap()
2074 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2078 Ok(_) => panic!("expected error"),
2079 Err(e) => assert_eq!(e, SignError::Signing),
2082 match OfferBuilder::new(recipient_pubkey())
2085 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2087 .sign(payer_sign).unwrap()
2088 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2092 Ok(_) => panic!("expected error"),
2093 Err(e) => assert_eq!(e, SignError::Verification(secp256k1::Error::InvalidSignature)),
2098 fn parses_invoice_with_payment_paths() {
2099 let invoice = OfferBuilder::new(recipient_pubkey())
2102 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2104 .sign(payer_sign).unwrap()
2105 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2107 .sign(recipient_sign).unwrap();
2109 let mut buffer = Vec::new();
2110 invoice.write(&mut buffer).unwrap();
2112 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2113 panic!("error parsing invoice: {:?}", e);
2116 let mut tlv_stream = invoice.as_tlv_stream();
2117 tlv_stream.3.paths = None;
2119 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2120 Ok(_) => panic!("expected error"),
2121 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaths)),
2124 let mut tlv_stream = invoice.as_tlv_stream();
2125 tlv_stream.3.blindedpay = None;
2127 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2128 Ok(_) => panic!("expected error"),
2129 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidPayInfo)),
2132 let empty_payment_paths = vec![];
2133 let mut tlv_stream = invoice.as_tlv_stream();
2134 tlv_stream.3.paths = Some(Iterable(empty_payment_paths.iter().map(|(_, path)| path)));
2136 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2137 Ok(_) => panic!("expected error"),
2138 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaths)),
2141 let mut payment_paths = payment_paths();
2142 payment_paths.pop();
2143 let mut tlv_stream = invoice.as_tlv_stream();
2144 tlv_stream.3.blindedpay = Some(Iterable(payment_paths.iter().map(|(payinfo, _)| payinfo)));
2146 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2147 Ok(_) => panic!("expected error"),
2148 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidPayInfo)),
2153 fn parses_invoice_with_created_at() {
2154 let invoice = OfferBuilder::new(recipient_pubkey())
2157 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2159 .sign(payer_sign).unwrap()
2160 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2162 .sign(recipient_sign).unwrap();
2164 let mut buffer = Vec::new();
2165 invoice.write(&mut buffer).unwrap();
2167 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2168 panic!("error parsing invoice: {:?}", e);
2171 let mut tlv_stream = invoice.as_tlv_stream();
2172 tlv_stream.3.created_at = None;
2174 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2175 Ok(_) => panic!("expected error"),
2177 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingCreationTime));
2183 fn parses_invoice_with_relative_expiry() {
2184 let invoice = OfferBuilder::new(recipient_pubkey())
2187 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2189 .sign(payer_sign).unwrap()
2190 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2191 .relative_expiry(3600)
2193 .sign(recipient_sign).unwrap();
2195 let mut buffer = Vec::new();
2196 invoice.write(&mut buffer).unwrap();
2198 match Bolt12Invoice::try_from(buffer) {
2199 Ok(invoice) => assert_eq!(invoice.relative_expiry(), Duration::from_secs(3600)),
2200 Err(e) => panic!("error parsing invoice: {:?}", e),
2205 fn parses_invoice_with_payment_hash() {
2206 let invoice = OfferBuilder::new(recipient_pubkey())
2209 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2211 .sign(payer_sign).unwrap()
2212 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2214 .sign(recipient_sign).unwrap();
2216 let mut buffer = Vec::new();
2217 invoice.write(&mut buffer).unwrap();
2219 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2220 panic!("error parsing invoice: {:?}", e);
2223 let mut tlv_stream = invoice.as_tlv_stream();
2224 tlv_stream.3.payment_hash = None;
2226 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2227 Ok(_) => panic!("expected error"),
2229 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingPaymentHash));
2235 fn parses_invoice_with_amount() {
2236 let invoice = OfferBuilder::new(recipient_pubkey())
2239 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2241 .sign(payer_sign).unwrap()
2242 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2244 .sign(recipient_sign).unwrap();
2246 let mut buffer = Vec::new();
2247 invoice.write(&mut buffer).unwrap();
2249 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2250 panic!("error parsing invoice: {:?}", e);
2253 let mut tlv_stream = invoice.as_tlv_stream();
2254 tlv_stream.3.amount = None;
2256 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2257 Ok(_) => panic!("expected error"),
2258 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingAmount)),
2263 fn parses_invoice_with_allow_mpp() {
2264 let invoice = OfferBuilder::new(recipient_pubkey())
2267 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2269 .sign(payer_sign).unwrap()
2270 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2273 .sign(recipient_sign).unwrap();
2275 let mut buffer = Vec::new();
2276 invoice.write(&mut buffer).unwrap();
2278 match Bolt12Invoice::try_from(buffer) {
2280 let mut features = Bolt12InvoiceFeatures::empty();
2281 features.set_basic_mpp_optional();
2282 assert_eq!(invoice.invoice_features(), &features);
2284 Err(e) => panic!("error parsing invoice: {:?}", e),
2289 fn parses_invoice_with_fallback_address() {
2290 let script = ScriptBuf::new();
2291 let pubkey = bitcoin::key::PublicKey::new(recipient_pubkey());
2292 let x_only_pubkey = XOnlyPublicKey::from_keypair(&recipient_keys()).0;
2293 let tweaked_pubkey = TweakedPublicKey::dangerous_assume_tweaked(x_only_pubkey);
2295 let offer = OfferBuilder::new(recipient_pubkey())
2298 let invoice_request = offer
2299 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2301 .sign(payer_sign).unwrap();
2302 #[cfg(not(c_bindings))]
2303 let invoice_builder = invoice_request
2304 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap();
2306 let mut invoice_builder = invoice_request
2307 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap();
2308 let invoice_builder = invoice_builder
2309 .fallback_v0_p2wsh(&script.wscript_hash())
2310 .fallback_v0_p2wpkh(&pubkey.wpubkey_hash().unwrap())
2311 .fallback_v1_p2tr_tweaked(&tweaked_pubkey);
2312 #[cfg(not(c_bindings))]
2313 let mut invoice_builder = invoice_builder;
2315 // Only standard addresses will be included.
2316 let fallbacks = invoice_builder.invoice.fields_mut().fallbacks.as_mut().unwrap();
2317 // Non-standard addresses
2318 fallbacks.push(FallbackAddress { version: 1, program: vec![0u8; 41] });
2319 fallbacks.push(FallbackAddress { version: 2, program: vec![0u8; 1] });
2320 fallbacks.push(FallbackAddress { version: 17, program: vec![0u8; 40] });
2322 fallbacks.push(FallbackAddress { version: 1, program: vec![0u8; 33] });
2323 fallbacks.push(FallbackAddress { version: 2, program: vec![0u8; 40] });
2325 let invoice = invoice_builder.build().unwrap().sign(recipient_sign).unwrap();
2326 let mut buffer = Vec::new();
2327 invoice.write(&mut buffer).unwrap();
2329 match Bolt12Invoice::try_from(buffer) {
2331 let v1_witness_program = WitnessProgram::new(WitnessVersion::V1, vec![0u8; 33]).unwrap();
2332 let v2_witness_program = WitnessProgram::new(WitnessVersion::V2, vec![0u8; 40]).unwrap();
2334 invoice.fallbacks(),
2336 Address::p2wsh(&script, Network::Bitcoin),
2337 Address::p2wpkh(&pubkey, Network::Bitcoin).unwrap(),
2338 Address::p2tr_tweaked(tweaked_pubkey, Network::Bitcoin),
2339 Address::new(Network::Bitcoin, Payload::WitnessProgram(v1_witness_program)),
2340 Address::new(Network::Bitcoin, Payload::WitnessProgram(v2_witness_program)),
2344 Err(e) => panic!("error parsing invoice: {:?}", e),
2349 fn parses_invoice_with_node_id() {
2350 let invoice = OfferBuilder::new(recipient_pubkey())
2353 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2355 .sign(payer_sign).unwrap()
2356 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2358 .sign(recipient_sign).unwrap();
2360 let mut buffer = Vec::new();
2361 invoice.write(&mut buffer).unwrap();
2363 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2364 panic!("error parsing invoice: {:?}", e);
2367 let mut tlv_stream = invoice.as_tlv_stream();
2368 tlv_stream.3.node_id = None;
2370 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2371 Ok(_) => panic!("expected error"),
2373 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSigningPubkey));
2377 let invalid_pubkey = payer_pubkey();
2378 let mut tlv_stream = invoice.as_tlv_stream();
2379 tlv_stream.3.node_id = Some(&invalid_pubkey);
2381 match Bolt12Invoice::try_from(tlv_stream.to_bytes()) {
2382 Ok(_) => panic!("expected error"),
2384 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidSigningPubkey));
2390 fn parses_invoice_with_node_id_from_blinded_path() {
2393 introduction_node: IntroductionNode::NodeId(pubkey(40)),
2394 blinding_point: pubkey(41),
2396 BlindedHop { blinded_node_id: pubkey(43), encrypted_payload: vec![0; 43] },
2397 BlindedHop { blinded_node_id: pubkey(44), encrypted_payload: vec![0; 44] },
2401 introduction_node: IntroductionNode::NodeId(pubkey(40)),
2402 blinding_point: pubkey(41),
2404 BlindedHop { blinded_node_id: pubkey(45), encrypted_payload: vec![0; 45] },
2405 BlindedHop { blinded_node_id: pubkey(46), encrypted_payload: vec![0; 46] },
2410 let blinded_node_id_sign = |message: &UnsignedBolt12Invoice| {
2411 let secp_ctx = Secp256k1::new();
2412 let keys = Keypair::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[46; 32]).unwrap());
2413 Ok(secp_ctx.sign_schnorr_no_aux_rand(message.as_ref().as_digest(), &keys))
2416 let invoice = OfferBuilder::new(recipient_pubkey())
2417 .clear_signing_pubkey()
2419 .path(paths[0].clone())
2420 .path(paths[1].clone())
2422 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2424 .sign(payer_sign).unwrap()
2425 .respond_with_no_std_using_signing_pubkey(
2426 payment_paths(), payment_hash(), now(), pubkey(46)
2429 .sign(blinded_node_id_sign).unwrap();
2431 let mut buffer = Vec::new();
2432 invoice.write(&mut buffer).unwrap();
2434 if let Err(e) = Bolt12Invoice::try_from(buffer) {
2435 panic!("error parsing invoice: {:?}", e);
2438 let invoice = OfferBuilder::new(recipient_pubkey())
2439 .clear_signing_pubkey()
2441 .path(paths[0].clone())
2442 .path(paths[1].clone())
2444 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2446 .sign(payer_sign).unwrap()
2447 .respond_with_no_std_using_signing_pubkey(
2448 payment_paths(), payment_hash(), now(), recipient_pubkey()
2451 .sign(recipient_sign).unwrap();
2453 let mut buffer = Vec::new();
2454 invoice.write(&mut buffer).unwrap();
2456 match Bolt12Invoice::try_from(buffer) {
2457 Ok(_) => panic!("expected error"),
2459 assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::InvalidSigningPubkey));
2465 fn fails_parsing_invoice_without_signature() {
2466 let mut buffer = Vec::new();
2467 OfferBuilder::new(recipient_pubkey())
2470 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2472 .sign(payer_sign).unwrap()
2473 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2476 .write(&mut buffer).unwrap();
2478 match Bolt12Invoice::try_from(buffer) {
2479 Ok(_) => panic!("expected error"),
2480 Err(e) => assert_eq!(e, Bolt12ParseError::InvalidSemantics(Bolt12SemanticError::MissingSignature)),
2485 fn fails_parsing_invoice_with_invalid_signature() {
2486 let mut invoice = OfferBuilder::new(recipient_pubkey())
2489 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2491 .sign(payer_sign).unwrap()
2492 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2494 .sign(recipient_sign).unwrap();
2495 let last_signature_byte = invoice.bytes.last_mut().unwrap();
2496 *last_signature_byte = last_signature_byte.wrapping_add(1);
2498 let mut buffer = Vec::new();
2499 invoice.write(&mut buffer).unwrap();
2501 match Bolt12Invoice::try_from(buffer) {
2502 Ok(_) => panic!("expected error"),
2504 assert_eq!(e, Bolt12ParseError::InvalidSignature(secp256k1::Error::InvalidSignature));
2510 fn fails_parsing_invoice_with_extra_tlv_records() {
2511 let invoice = OfferBuilder::new(recipient_pubkey())
2514 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2516 .sign(payer_sign).unwrap()
2517 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2519 .sign(recipient_sign).unwrap();
2521 let mut encoded_invoice = Vec::new();
2522 invoice.write(&mut encoded_invoice).unwrap();
2523 BigSize(1002).write(&mut encoded_invoice).unwrap();
2524 BigSize(32).write(&mut encoded_invoice).unwrap();
2525 [42u8; 32].write(&mut encoded_invoice).unwrap();
2527 match Bolt12Invoice::try_from(encoded_invoice) {
2528 Ok(_) => panic!("expected error"),
2529 Err(e) => assert_eq!(e, Bolt12ParseError::Decode(DecodeError::InvalidValue)),