1 #![deny(rustdoc::broken_intra_doc_links)]
2 #![deny(rustdoc::private_intra_doc_links)]
5 #![deny(non_upper_case_globals)]
6 #![deny(non_camel_case_types)]
7 #![deny(non_snake_case)]
10 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
12 #![cfg_attr(feature = "strict", deny(warnings))]
13 #![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
15 //! This crate provides data structures to represent
16 //! [lightning BOLT11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md)
17 //! invoices and functions to create, encode and decode these. If you just want to use the standard
18 //! en-/decoding functionality this should get you started:
20 //! * For parsing use `str::parse::<Bolt11Invoice>(&self)` (see [`Bolt11Invoice::from_str`])
21 //! * For constructing invoices use the [`InvoiceBuilder`]
22 //! * For serializing invoices use the [`Display`]/[`ToString`] traits
24 //! [`Bolt11Invoice::from_str`]: crate::Bolt11Invoice#impl-FromStr
26 #[cfg(not(any(feature = "std", feature = "no-std")))]
27 compile_error!("at least one of the `std` or `no-std` features must be enabled");
33 #[macro_use] extern crate lightning;
34 extern crate num_traits;
35 extern crate secp256k1;
37 #[cfg(any(test, feature = "std"))]
39 #[cfg(feature = "serde")]
42 #[cfg(feature = "std")]
43 use std::time::SystemTime;
46 use bitcoin::{Address, Network, PubkeyHash, ScriptHash};
47 use bitcoin::address::{Payload, WitnessProgram, WitnessVersion};
48 use bitcoin::hashes::{Hash, sha256};
49 use lightning::ln::features::Bolt11InvoiceFeatures;
50 use lightning::util::invoice::construct_invoice_preimage;
52 use secp256k1::PublicKey;
53 use secp256k1::{Message, Secp256k1};
54 use secp256k1::ecdsa::RecoverableSignature;
56 use core::cmp::Ordering;
57 use core::fmt::{Display, Formatter, self};
58 use core::iter::FilterMap;
59 use core::num::ParseIntError;
61 use core::slice::Iter;
62 use core::time::Duration;
65 #[cfg(feature = "serde")]
66 use serde::{Deserialize, Deserializer,Serialize, Serializer, de::Error};
69 pub use lightning::ln::PaymentSecret;
71 pub use lightning::routing::router::{RouteHint, RouteHintHop};
73 pub use lightning::routing::gossip::RoutingFees;
74 use lightning::util::string::UntrustedString;
80 #[allow(unused_imports)]
82 #[cfg(feature = "hashbrown")]
83 extern crate hashbrown;
85 pub use alloc::{vec, vec::Vec, string::String};
86 #[cfg(not(feature = "hashbrown"))]
87 pub use std::collections::{HashMap, hash_map};
88 #[cfg(feature = "hashbrown")]
89 pub use self::hashbrown::{HashMap, HashSet, hash_map};
91 pub use alloc::string::ToString;
94 use crate::prelude::*;
96 /// Errors that indicate what is wrong with the invoice. They have some granularity for debug
97 /// reasons, but should generally result in an "invalid BOLT11 invoice" message for the user.
98 #[allow(missing_docs)]
99 #[derive(PartialEq, Eq, Debug, Clone)]
100 pub enum Bolt11ParseError {
101 Bech32Error(bech32::Error),
102 ParseAmountError(ParseIntError),
103 MalformedSignature(secp256k1::Error),
109 UnexpectedEndOfTaggedFields,
110 DescriptionDecodeError(str::Utf8Error),
112 IntegerOverflowError,
113 InvalidSegWitProgramLength,
114 InvalidPubKeyHashLength,
115 InvalidScriptHashLength,
117 InvalidSliceLength(String),
119 /// Not an error, but used internally to signal that a part of the invoice should be ignored
120 /// according to BOLT11
124 /// Indicates that something went wrong while parsing or validating the invoice. Parsing errors
125 /// should be mostly seen as opaque and are only there for debugging reasons. Semantic errors
126 /// like wrong signatures, missing fields etc. could mean that someone tampered with the invoice.
127 #[derive(PartialEq, Eq, Debug, Clone)]
128 pub enum ParseOrSemanticError {
129 /// The invoice couldn't be decoded
130 ParseError(Bolt11ParseError),
132 /// The invoice could be decoded but violates the BOLT11 standard
133 SemanticError(crate::Bolt11SemanticError),
136 /// The number of bits used to represent timestamps as defined in BOLT 11.
137 const TIMESTAMP_BITS: usize = 35;
139 /// The maximum timestamp as [`Duration::as_secs`] since the Unix epoch allowed by [`BOLT 11`].
141 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
142 pub const MAX_TIMESTAMP: u64 = (1 << TIMESTAMP_BITS) - 1;
144 /// Default expiry time as defined by [BOLT 11].
146 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
147 pub const DEFAULT_EXPIRY_TIME: u64 = 3600;
149 /// Default minimum final CLTV expiry as defined by [BOLT 11].
151 /// Note that this is *not* the same value as rust-lightning's minimum CLTV expiry, which is
152 /// provided in [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
154 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
155 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
156 pub const DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA: u64 = 18;
158 /// Builder for [`Bolt11Invoice`]s. It's the most convenient and advised way to use this library. It
159 /// ensures that only a semantically and syntactically correct invoice can be built using it.
162 /// extern crate secp256k1;
163 /// extern crate lightning;
164 /// extern crate lightning_invoice;
165 /// extern crate bitcoin;
167 /// use bitcoin::hashes::Hash;
168 /// use bitcoin::hashes::sha256;
170 /// use secp256k1::Secp256k1;
171 /// use secp256k1::SecretKey;
173 /// use lightning::ln::PaymentSecret;
175 /// use lightning_invoice::{Currency, InvoiceBuilder};
177 /// # #[cfg(not(feature = "std"))]
179 /// # #[cfg(feature = "std")]
181 /// let private_key = SecretKey::from_slice(
183 /// 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f,
184 /// 0xe2, 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04,
185 /// 0xa8, 0xca, 0x3b, 0x2d, 0xb7, 0x34
189 /// let payment_hash = sha256::Hash::from_slice(&[0; 32][..]).unwrap();
190 /// let payment_secret = PaymentSecret([42u8; 32]);
192 /// let invoice = InvoiceBuilder::new(Currency::Bitcoin)
193 /// .description("Coins pls!".into())
194 /// .payment_hash(payment_hash)
195 /// .payment_secret(payment_secret)
196 /// .current_timestamp()
197 /// .min_final_cltv_expiry_delta(144)
198 /// .build_signed(|hash| {
199 /// Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)
203 /// assert!(invoice.to_string().starts_with("lnbc1"));
207 /// # Type parameters
208 /// The two parameters `D` and `H` signal if the builder already contains the correct amount of the
210 /// * `D`: exactly one [`TaggedField::Description`] or [`TaggedField::DescriptionHash`]
211 /// * `H`: exactly one [`TaggedField::PaymentHash`]
212 /// * `T`: the timestamp is set
213 /// * `C`: the CLTV expiry is set
214 /// * `S`: the payment secret is set
215 /// * `M`: payment metadata is set
217 /// This is not exported to bindings users as we likely need to manually select one set of boolean type parameters.
218 #[derive(Eq, PartialEq, Debug, Clone)]
219 pub struct InvoiceBuilder<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> {
222 si_prefix: Option<SiPrefix>,
223 timestamp: Option<PositiveTimestamp>,
224 tagged_fields: Vec<TaggedField>,
225 error: Option<CreationError>,
227 phantom_d: core::marker::PhantomData<D>,
228 phantom_h: core::marker::PhantomData<H>,
229 phantom_t: core::marker::PhantomData<T>,
230 phantom_c: core::marker::PhantomData<C>,
231 phantom_s: core::marker::PhantomData<S>,
232 phantom_m: core::marker::PhantomData<M>,
235 /// Represents a syntactically and semantically correct lightning BOLT11 invoice.
237 /// There are three ways to construct a `Bolt11Invoice`:
238 /// 1. using [`InvoiceBuilder`]
239 /// 2. using [`Bolt11Invoice::from_signed`]
240 /// 3. using `str::parse::<Bolt11Invoice>(&str)` (see [`Bolt11Invoice::from_str`])
242 /// [`Bolt11Invoice::from_str`]: crate::Bolt11Invoice#impl-FromStr
243 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
244 pub struct Bolt11Invoice {
245 signed_invoice: SignedRawBolt11Invoice,
248 /// Represents the description of an invoice which has to be either a directly included string or
249 /// a hash of a description provided out of band.
251 /// This is not exported to bindings users as we don't have a good way to map the reference lifetimes making this
252 /// practically impossible to use safely in languages like C.
253 #[derive(Eq, PartialEq, Debug, Clone, Ord, PartialOrd)]
254 pub enum Bolt11InvoiceDescription<'f> {
255 /// Reference to the directly supplied description in the invoice
256 Direct(&'f Description),
258 /// Reference to the description's hash included in the invoice
262 impl<'f> Display for Bolt11InvoiceDescription<'f> {
263 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
265 Bolt11InvoiceDescription::Direct(desc) => write!(f, "{}", desc.0),
266 Bolt11InvoiceDescription::Hash(hash) => write!(f, "{}", hash.0),
271 /// Represents a signed [`RawBolt11Invoice`] with cached hash. The signature is not checked and may be
275 /// The hash has to be either from the deserialized invoice or from the serialized [`RawBolt11Invoice`].
276 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
277 pub struct SignedRawBolt11Invoice {
278 /// The raw invoice that the signature belongs to
279 raw_invoice: RawBolt11Invoice,
281 /// Hash of the [`RawBolt11Invoice`] that will be used to check the signature.
283 /// * if the `SignedRawBolt11Invoice` was deserialized the hash is of from the original encoded form,
284 /// since it's not guaranteed that encoding it again will lead to the same result since integers
285 /// could have been encoded with leading zeroes etc.
286 /// * if the `SignedRawBolt11Invoice` was constructed manually the hash will be the calculated hash
287 /// from the [`RawBolt11Invoice`]
290 /// signature of the payment request
291 signature: Bolt11InvoiceSignature,
294 /// Represents an syntactically correct [`Bolt11Invoice`] for a payment on the lightning network,
295 /// but without the signature information.
296 /// Decoding and encoding should not lead to information loss but may lead to different hashes.
298 /// For methods without docs see the corresponding methods in [`Bolt11Invoice`].
299 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
300 pub struct RawBolt11Invoice {
301 /// human readable part
305 pub data: RawDataPart,
308 /// Data of the [`RawBolt11Invoice`] that is encoded in the human readable part.
310 /// This is not exported to bindings users as we don't yet support `Option<Enum>`
311 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
313 /// The currency deferred from the 3rd and 4th character of the bech32 transaction
314 pub currency: Currency,
316 /// The amount that, multiplied by the SI prefix, has to be payed
317 pub raw_amount: Option<u64>,
319 /// SI prefix that gets multiplied with the `raw_amount`
320 pub si_prefix: Option<SiPrefix>,
323 /// Data of the [`RawBolt11Invoice`] that is encoded in the data part
324 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
325 pub struct RawDataPart {
326 /// generation time of the invoice
327 pub timestamp: PositiveTimestamp,
329 /// tagged fields of the payment request
330 pub tagged_fields: Vec<RawTaggedField>,
333 /// A timestamp that refers to a date after 1 January 1970.
337 /// The Unix timestamp representing the stored time has to be positive and no greater than
338 /// [`MAX_TIMESTAMP`].
339 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
340 pub struct PositiveTimestamp(Duration);
342 /// SI prefixes for the human readable part
343 #[derive(Eq, PartialEq, Debug, Clone, Copy, Hash, Ord, PartialOrd)]
356 /// Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix.
357 /// This is effectively 10^12 * the prefix multiplier
358 pub fn multiplier(&self) -> u64 {
360 SiPrefix::Milli => 1_000_000_000,
361 SiPrefix::Micro => 1_000_000,
362 SiPrefix::Nano => 1_000,
367 /// Returns all enum variants of `SiPrefix` sorted in descending order of their associated
370 /// This is not exported to bindings users as we don't yet support a slice of enums, and also because this function
371 /// isn't the most critical to expose.
372 pub fn values_desc() -> &'static [SiPrefix] {
373 use crate::SiPrefix::*;
374 static VALUES: [SiPrefix; 4] = [Milli, Micro, Nano, Pico];
379 /// Enum representing the crypto currencies (or networks) supported by this library
380 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
398 impl From<Network> for Currency {
399 fn from(network: Network) -> Self {
401 Network::Bitcoin => Currency::Bitcoin,
402 Network::Testnet => Currency::BitcoinTestnet,
403 Network::Regtest => Currency::Regtest,
404 Network::Signet => Currency::Signet,
406 debug_assert!(false, "Need to handle new rust-bitcoin network type");
413 impl From<Currency> for Network {
414 fn from(currency: Currency) -> Self {
416 Currency::Bitcoin => Network::Bitcoin,
417 Currency::BitcoinTestnet => Network::Testnet,
418 Currency::Regtest => Network::Regtest,
419 Currency::Simnet => Network::Regtest,
420 Currency::Signet => Network::Signet,
425 /// Tagged field which may have an unknown tag
427 /// This is not exported to bindings users as we don't currently support TaggedField
428 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
429 pub enum RawTaggedField {
430 /// Parsed tagged field with known tag
431 KnownSemantics(TaggedField),
432 /// tagged field which was not parsed due to an unknown tag or undefined field semantics
433 UnknownSemantics(Vec<u5>),
436 /// Tagged field with known tag
438 /// For descriptions of the enum values please refer to the enclosed type's docs.
440 /// This is not exported to bindings users as we don't yet support enum variants with the same name the struct contained
442 #[allow(missing_docs)]
443 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
444 pub enum TaggedField {
446 Description(Description),
447 PayeePubKey(PayeePubKey),
448 DescriptionHash(Sha256),
449 ExpiryTime(ExpiryTime),
450 MinFinalCltvExpiryDelta(MinFinalCltvExpiryDelta),
452 PrivateRoute(PrivateRoute),
453 PaymentSecret(PaymentSecret),
454 PaymentMetadata(Vec<u8>),
455 Features(Bolt11InvoiceFeatures),
459 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
460 pub struct Sha256(/// This is not exported to bindings users as the native hash types are not currently mapped
464 /// Constructs a new [`Sha256`] from the given bytes, which are assumed to be the output of a
465 /// single sha256 hash.
467 pub fn from_bytes(bytes: &[u8; 32]) -> Self {
468 Self(sha256::Hash::from_slice(bytes).expect("from_slice only fails if len is not 32"))
472 /// Description string
475 /// The description can be at most 639 __bytes__ long
476 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd, Default)]
477 pub struct Description(UntrustedString);
480 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
481 pub struct PayeePubKey(pub PublicKey);
483 /// Positive duration that defines when (relatively to the timestamp) in the future the invoice
485 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
486 pub struct ExpiryTime(Duration);
488 /// `min_final_cltv_expiry_delta` to use for the last HTLC in the route
489 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
490 pub struct MinFinalCltvExpiryDelta(pub u64);
492 /// Fallback address in case no LN payment is possible
493 #[allow(missing_docs)]
494 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
497 version: WitnessVersion,
500 PubKeyHash(PubkeyHash),
501 ScriptHash(ScriptHash),
504 /// Recoverable signature
505 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
506 pub struct Bolt11InvoiceSignature(pub RecoverableSignature);
508 impl PartialOrd for Bolt11InvoiceSignature {
509 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
510 Some(self.cmp(other))
514 impl Ord for Bolt11InvoiceSignature {
515 fn cmp(&self, other: &Self) -> Ordering {
516 self.0.serialize_compact().1.cmp(&other.0.serialize_compact().1)
520 /// Private routing information
523 /// The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)
525 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
526 pub struct PrivateRoute(RouteHint);
528 /// Tag constants as specified in BOLT11
529 #[allow(missing_docs)]
531 pub const TAG_PAYMENT_HASH: u8 = 1;
532 pub const TAG_DESCRIPTION: u8 = 13;
533 pub const TAG_PAYEE_PUB_KEY: u8 = 19;
534 pub const TAG_DESCRIPTION_HASH: u8 = 23;
535 pub const TAG_EXPIRY_TIME: u8 = 6;
536 pub const TAG_MIN_FINAL_CLTV_EXPIRY_DELTA: u8 = 24;
537 pub const TAG_FALLBACK: u8 = 9;
538 pub const TAG_PRIVATE_ROUTE: u8 = 3;
539 pub const TAG_PAYMENT_SECRET: u8 = 16;
540 pub const TAG_PAYMENT_METADATA: u8 = 27;
541 pub const TAG_FEATURES: u8 = 5;
544 impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False, tb::False> {
545 /// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
546 /// `InvoiceBuilder::build(self)` becomes available.
547 pub fn new(currency: Currency) -> Self {
553 tagged_fields: Vec::with_capacity(8),
556 phantom_d: core::marker::PhantomData,
557 phantom_h: core::marker::PhantomData,
558 phantom_t: core::marker::PhantomData,
559 phantom_c: core::marker::PhantomData,
560 phantom_s: core::marker::PhantomData,
561 phantom_m: core::marker::PhantomData,
566 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, C, S, M> {
567 /// Helper function to set the completeness flags.
568 fn set_flags<DN: tb::Bool, HN: tb::Bool, TN: tb::Bool, CN: tb::Bool, SN: tb::Bool, MN: tb::Bool>(self) -> InvoiceBuilder<DN, HN, TN, CN, SN, MN> {
569 InvoiceBuilder::<DN, HN, TN, CN, SN, MN> {
570 currency: self.currency,
572 si_prefix: self.si_prefix,
573 timestamp: self.timestamp,
574 tagged_fields: self.tagged_fields,
577 phantom_d: core::marker::PhantomData,
578 phantom_h: core::marker::PhantomData,
579 phantom_t: core::marker::PhantomData,
580 phantom_c: core::marker::PhantomData,
581 phantom_s: core::marker::PhantomData,
582 phantom_m: core::marker::PhantomData,
586 /// Sets the amount in millisatoshis. The optimal SI prefix is chosen automatically.
587 pub fn amount_milli_satoshis(mut self, amount_msat: u64) -> Self {
588 let amount = amount_msat * 10; // Invoices are denominated in "pico BTC"
589 let biggest_possible_si_prefix = SiPrefix::values_desc()
591 .find(|prefix| amount % prefix.multiplier() == 0)
592 .expect("Pico should always match");
593 self.amount = Some(amount / biggest_possible_si_prefix.multiplier());
594 self.si_prefix = Some(*biggest_possible_si_prefix);
598 /// Sets the payee's public key.
599 pub fn payee_pub_key(mut self, pub_key: PublicKey) -> Self {
600 self.tagged_fields.push(TaggedField::PayeePubKey(PayeePubKey(pub_key)));
604 /// Sets the expiry time, dropping the subsecond part (which is not representable in BOLT 11
606 pub fn expiry_time(mut self, expiry_time: Duration) -> Self {
607 self.tagged_fields.push(TaggedField::ExpiryTime(ExpiryTime::from_duration(expiry_time)));
611 /// Adds a fallback address.
612 pub fn fallback(mut self, fallback: Fallback) -> Self {
613 self.tagged_fields.push(TaggedField::Fallback(fallback));
617 /// Adds a private route.
618 pub fn private_route(mut self, hint: RouteHint) -> Self {
619 match PrivateRoute::new(hint) {
620 Ok(r) => self.tagged_fields.push(TaggedField::PrivateRoute(r)),
621 Err(e) => self.error = Some(e),
627 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, tb::True, C, S, M> {
628 /// Builds a [`RawBolt11Invoice`] if no [`CreationError`] occurred while construction any of the
630 pub fn build_raw(self) -> Result<RawBolt11Invoice, CreationError> {
632 // If an error occurred at any time before, return it now
633 if let Some(e) = self.error {
638 currency: self.currency,
639 raw_amount: self.amount,
640 si_prefix: self.si_prefix,
643 let timestamp = self.timestamp.expect("ensured to be Some(t) by type T");
645 let tagged_fields = self.tagged_fields.into_iter().map(|tf| {
646 RawTaggedField::KnownSemantics(tf)
647 }).collect::<Vec<_>>();
649 let data = RawDataPart {
654 Ok(RawBolt11Invoice {
661 impl<H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<tb::False, H, T, C, S, M> {
662 /// Set the description. This function is only available if no description (hash) was set.
663 pub fn description(mut self, description: String) -> InvoiceBuilder<tb::True, H, T, C, S, M> {
664 match Description::new(description) {
665 Ok(d) => self.tagged_fields.push(TaggedField::Description(d)),
666 Err(e) => self.error = Some(e),
671 /// Set the description hash. This function is only available if no description (hash) was set.
672 pub fn description_hash(mut self, description_hash: sha256::Hash) -> InvoiceBuilder<tb::True, H, T, C, S, M> {
673 self.tagged_fields.push(TaggedField::DescriptionHash(Sha256(description_hash)));
677 /// Set the description or description hash. This function is only available if no description (hash) was set.
678 pub fn invoice_description(self, description: Bolt11InvoiceDescription) -> InvoiceBuilder<tb::True, H, T, C, S, M> {
680 Bolt11InvoiceDescription::Direct(desc) => {
681 self.description(desc.clone().into_inner().0)
683 Bolt11InvoiceDescription::Hash(hash) => {
684 self.description_hash(hash.0)
690 impl<D: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, tb::False, T, C, S, M> {
691 /// Set the payment hash. This function is only available if no payment hash was set.
692 pub fn payment_hash(mut self, hash: sha256::Hash) -> InvoiceBuilder<D, tb::True, T, C, S, M> {
693 self.tagged_fields.push(TaggedField::PaymentHash(Sha256(hash)));
698 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, tb::False, C, S, M> {
699 /// Sets the timestamp to a specific [`SystemTime`].
700 #[cfg(feature = "std")]
701 pub fn timestamp(mut self, time: SystemTime) -> InvoiceBuilder<D, H, tb::True, C, S, M> {
702 match PositiveTimestamp::from_system_time(time) {
703 Ok(t) => self.timestamp = Some(t),
704 Err(e) => self.error = Some(e),
710 /// Sets the timestamp to a duration since the Unix epoch, dropping the subsecond part (which
711 /// is not representable in BOLT 11 invoices).
712 pub fn duration_since_epoch(mut self, time: Duration) -> InvoiceBuilder<D, H, tb::True, C, S, M> {
713 match PositiveTimestamp::from_duration_since_epoch(time) {
714 Ok(t) => self.timestamp = Some(t),
715 Err(e) => self.error = Some(e),
721 /// Sets the timestamp to the current system time.
722 #[cfg(feature = "std")]
723 pub fn current_timestamp(mut self) -> InvoiceBuilder<D, H, tb::True, C, S, M> {
724 let now = PositiveTimestamp::from_system_time(SystemTime::now());
725 self.timestamp = Some(now.expect("for the foreseeable future this shouldn't happen"));
730 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, tb::False, S, M> {
731 /// Sets `min_final_cltv_expiry_delta`.
732 pub fn min_final_cltv_expiry_delta(mut self, min_final_cltv_expiry_delta: u64) -> InvoiceBuilder<D, H, T, tb::True, S, M> {
733 self.tagged_fields.push(TaggedField::MinFinalCltvExpiryDelta(MinFinalCltvExpiryDelta(min_final_cltv_expiry_delta)));
738 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, C, tb::False, M> {
739 /// Sets the payment secret and relevant features.
740 pub fn payment_secret(mut self, payment_secret: PaymentSecret) -> InvoiceBuilder<D, H, T, C, tb::True, M> {
741 let mut found_features = false;
742 for field in self.tagged_fields.iter_mut() {
743 if let TaggedField::Features(f) = field {
744 found_features = true;
745 f.set_variable_length_onion_required();
746 f.set_payment_secret_required();
749 self.tagged_fields.push(TaggedField::PaymentSecret(payment_secret));
751 let mut features = Bolt11InvoiceFeatures::empty();
752 features.set_variable_length_onion_required();
753 features.set_payment_secret_required();
754 self.tagged_fields.push(TaggedField::Features(features));
760 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, C, S, tb::False> {
761 /// Sets the payment metadata.
763 /// By default features are set to *optionally* allow the sender to include the payment metadata.
764 /// If you wish to require that the sender include the metadata (and fail to parse the invoice if
765 /// they don't support payment metadata fields), you need to call
766 /// [`InvoiceBuilder::require_payment_metadata`] after this.
767 pub fn payment_metadata(mut self, payment_metadata: Vec<u8>) -> InvoiceBuilder<D, H, T, C, S, tb::True> {
768 self.tagged_fields.push(TaggedField::PaymentMetadata(payment_metadata));
769 let mut found_features = false;
770 for field in self.tagged_fields.iter_mut() {
771 if let TaggedField::Features(f) = field {
772 found_features = true;
773 f.set_payment_metadata_optional();
777 let mut features = Bolt11InvoiceFeatures::empty();
778 features.set_payment_metadata_optional();
779 self.tagged_fields.push(TaggedField::Features(features));
785 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, C, S, tb::True> {
786 /// Sets forwarding of payment metadata as required. A reader of the invoice which does not
787 /// support sending payment metadata will fail to read the invoice.
788 pub fn require_payment_metadata(mut self) -> InvoiceBuilder<D, H, T, C, S, tb::True> {
789 for field in self.tagged_fields.iter_mut() {
790 if let TaggedField::Features(f) = field {
791 f.set_payment_metadata_required();
798 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, C, tb::True, M> {
799 /// Sets the `basic_mpp` feature as optional.
800 pub fn basic_mpp(mut self) -> Self {
801 for field in self.tagged_fields.iter_mut() {
802 if let TaggedField::Features(f) = field {
803 f.set_basic_mpp_optional();
810 impl<M: tb::Bool> InvoiceBuilder<tb::True, tb::True, tb::True, tb::True, tb::True, M> {
811 /// Builds and signs an invoice using the supplied `sign_function`. This function MAY NOT fail
812 /// and MUST produce a recoverable signature valid for the given hash and if applicable also for
813 /// the included payee public key.
814 pub fn build_signed<F>(self, sign_function: F) -> Result<Bolt11Invoice, CreationError>
815 where F: FnOnce(&Message) -> RecoverableSignature
817 let invoice = self.try_build_signed::<_, ()>(|hash| {
818 Ok(sign_function(hash))
823 Err(SignOrCreationError::CreationError(e)) => Err(e),
824 Err(SignOrCreationError::SignError(())) => unreachable!(),
828 /// Builds and signs an invoice using the supplied `sign_function`. This function MAY fail with
829 /// an error of type `E` and MUST produce a recoverable signature valid for the given hash and
830 /// if applicable also for the included payee public key.
831 pub fn try_build_signed<F, E>(self, sign_function: F) -> Result<Bolt11Invoice, SignOrCreationError<E>>
832 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
834 let raw = match self.build_raw() {
836 Err(e) => return Err(SignOrCreationError::CreationError(e)),
839 let signed = match raw.sign(sign_function) {
841 Err(e) => return Err(SignOrCreationError::SignError(e)),
844 let invoice = Bolt11Invoice {
845 signed_invoice: signed,
848 invoice.check_field_counts().expect("should be ensured by type signature of builder");
849 invoice.check_feature_bits().expect("should be ensured by type signature of builder");
850 invoice.check_amount().expect("should be ensured by type signature of builder");
857 impl SignedRawBolt11Invoice {
858 /// Disassembles the `SignedRawBolt11Invoice` into its three parts:
860 /// 2. hash of the raw invoice
862 pub fn into_parts(self) -> (RawBolt11Invoice, [u8; 32], Bolt11InvoiceSignature) {
863 (self.raw_invoice, self.hash, self.signature)
866 /// The [`RawBolt11Invoice`] which was signed.
867 pub fn raw_invoice(&self) -> &RawBolt11Invoice {
871 /// The hash of the [`RawBolt11Invoice`] that was signed.
872 pub fn signable_hash(&self) -> &[u8; 32] {
876 /// Signature for the invoice.
877 pub fn signature(&self) -> &Bolt11InvoiceSignature {
881 /// Recovers the public key used for signing the invoice from the recoverable signature.
882 pub fn recover_payee_pub_key(&self) -> Result<PayeePubKey, secp256k1::Error> {
883 let hash = Message::from_slice(&self.hash[..])
884 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
886 Ok(PayeePubKey(Secp256k1::new().recover_ecdsa(
892 /// Checks if the signature is valid for the included payee public key or if none exists if it's
893 /// valid for the recovered signature (which should always be true?).
894 pub fn check_signature(&self) -> bool {
895 let included_pub_key = self.raw_invoice.payee_pub_key();
897 let mut recovered_pub_key = Option::None;
898 if recovered_pub_key.is_none() {
899 let recovered = match self.recover_payee_pub_key() {
901 Err(_) => return false,
903 recovered_pub_key = Some(recovered);
906 let pub_key = included_pub_key.or(recovered_pub_key.as_ref())
907 .expect("One is always present");
909 let hash = Message::from_slice(&self.hash[..])
910 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
912 let secp_context = Secp256k1::new();
913 let verification_result = secp_context.verify_ecdsa(
915 &self.signature.to_standard(),
919 match verification_result {
926 /// Finds the first element of an enum stream of a given variant and extracts one member of the
927 /// variant. If no element was found `None` gets returned.
929 /// The following example would extract the first B.
937 /// let elements = vec![Enum::A(1), Enum::A(2), Enum::B(3), Enum::A(4)];
939 /// assert_eq!(find_extract!(elements.iter(), Enum::B(x), x), Some(3u16));
941 macro_rules! find_extract {
942 ($iter:expr, $enm:pat, $enm_var:ident) => {
943 find_all_extract!($iter, $enm, $enm_var).next()
947 /// Finds the all elements of an enum stream of a given variant and extracts one member of the
948 /// variant through an iterator.
950 /// The following example would extract all A.
958 /// let elements = vec![Enum::A(1), Enum::A(2), Enum::B(3), Enum::A(4)];
961 /// find_all_extract!(elements.iter(), Enum::A(x), x).collect::<Vec<u8>>(),
962 /// vec![1u8, 2u8, 4u8]
965 macro_rules! find_all_extract {
966 ($iter:expr, $enm:pat, $enm_var:ident) => {
967 $iter.filter_map(|tf| match *tf {
968 $enm => Some($enm_var),
974 #[allow(missing_docs)]
975 impl RawBolt11Invoice {
976 /// Hash the HRP as bytes and signatureless data part.
977 fn hash_from_parts(hrp_bytes: &[u8], data_without_signature: &[u5]) -> [u8; 32] {
978 let preimage = construct_invoice_preimage(hrp_bytes, data_without_signature);
979 let mut hash: [u8; 32] = Default::default();
980 hash.copy_from_slice(&sha256::Hash::hash(&preimage)[..]);
984 /// Calculate the hash of the encoded `RawBolt11Invoice` which should be signed.
985 pub fn signable_hash(&self) -> [u8; 32] {
986 use bech32::ToBase32;
988 RawBolt11Invoice::hash_from_parts(
989 self.hrp.to_string().as_bytes(),
990 &self.data.to_base32()
994 /// Signs the invoice using the supplied `sign_method`. This function MAY fail with an error of
995 /// type `E`. Since the signature of a [`SignedRawBolt11Invoice`] is not required to be valid there
996 /// are no constraints regarding the validity of the produced signature.
998 /// This is not exported to bindings users as we don't currently support passing function pointers into methods
1000 pub fn sign<F, E>(self, sign_method: F) -> Result<SignedRawBolt11Invoice, E>
1001 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
1003 let raw_hash = self.signable_hash();
1004 let hash = Message::from_slice(&raw_hash[..])
1005 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
1006 let signature = sign_method(&hash)?;
1008 Ok(SignedRawBolt11Invoice {
1011 signature: Bolt11InvoiceSignature(signature),
1015 /// Returns an iterator over all tagged fields with known semantics.
1017 /// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
1018 pub fn known_tagged_fields(&self)
1019 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>>
1021 // For 1.14.0 compatibility: closures' types can't be written an fn()->() in the
1022 // function's type signature.
1023 // TODO: refactor once impl Trait is available
1024 fn match_raw(raw: &RawTaggedField) -> Option<&TaggedField> {
1026 RawTaggedField::KnownSemantics(ref tf) => Some(tf),
1031 self.data.tagged_fields.iter().filter_map(match_raw )
1034 pub fn payment_hash(&self) -> Option<&Sha256> {
1035 find_extract!(self.known_tagged_fields(), TaggedField::PaymentHash(ref x), x)
1038 pub fn description(&self) -> Option<&Description> {
1039 find_extract!(self.known_tagged_fields(), TaggedField::Description(ref x), x)
1042 pub fn payee_pub_key(&self) -> Option<&PayeePubKey> {
1043 find_extract!(self.known_tagged_fields(), TaggedField::PayeePubKey(ref x), x)
1046 pub fn description_hash(&self) -> Option<&Sha256> {
1047 find_extract!(self.known_tagged_fields(), TaggedField::DescriptionHash(ref x), x)
1050 pub fn expiry_time(&self) -> Option<&ExpiryTime> {
1051 find_extract!(self.known_tagged_fields(), TaggedField::ExpiryTime(ref x), x)
1054 pub fn min_final_cltv_expiry_delta(&self) -> Option<&MinFinalCltvExpiryDelta> {
1055 find_extract!(self.known_tagged_fields(), TaggedField::MinFinalCltvExpiryDelta(ref x), x)
1058 pub fn payment_secret(&self) -> Option<&PaymentSecret> {
1059 find_extract!(self.known_tagged_fields(), TaggedField::PaymentSecret(ref x), x)
1062 pub fn payment_metadata(&self) -> Option<&Vec<u8>> {
1063 find_extract!(self.known_tagged_fields(), TaggedField::PaymentMetadata(ref x), x)
1066 pub fn features(&self) -> Option<&Bolt11InvoiceFeatures> {
1067 find_extract!(self.known_tagged_fields(), TaggedField::Features(ref x), x)
1070 /// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
1071 pub fn fallbacks(&self) -> Vec<&Fallback> {
1072 find_all_extract!(self.known_tagged_fields(), TaggedField::Fallback(ref x), x).collect()
1075 pub fn private_routes(&self) -> Vec<&PrivateRoute> {
1076 find_all_extract!(self.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x).collect()
1079 pub fn amount_pico_btc(&self) -> Option<u64> {
1080 self.hrp.raw_amount.map(|v| {
1081 v * self.hrp.si_prefix.as_ref().map_or(1_000_000_000_000, |si| { si.multiplier() })
1085 pub fn currency(&self) -> Currency {
1086 self.hrp.currency.clone()
1090 impl PositiveTimestamp {
1091 /// Creates a `PositiveTimestamp` from a Unix timestamp in the range `0..=MAX_TIMESTAMP`.
1093 /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
1094 pub fn from_unix_timestamp(unix_seconds: u64) -> Result<Self, CreationError> {
1095 if unix_seconds <= MAX_TIMESTAMP {
1096 Ok(Self(Duration::from_secs(unix_seconds)))
1098 Err(CreationError::TimestampOutOfBounds)
1102 /// Creates a `PositiveTimestamp` from a [`SystemTime`] with a corresponding Unix timestamp in
1103 /// the range `0..=MAX_TIMESTAMP`.
1105 /// Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.
1107 /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
1108 #[cfg(feature = "std")]
1109 pub fn from_system_time(time: SystemTime) -> Result<Self, CreationError> {
1110 time.duration_since(SystemTime::UNIX_EPOCH)
1111 .map(Self::from_duration_since_epoch)
1112 .unwrap_or(Err(CreationError::TimestampOutOfBounds))
1115 /// Creates a `PositiveTimestamp` from a [`Duration`] since the Unix epoch in the range
1116 /// `0..=MAX_TIMESTAMP`.
1118 /// Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.
1120 /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
1121 pub fn from_duration_since_epoch(duration: Duration) -> Result<Self, CreationError> {
1122 Self::from_unix_timestamp(duration.as_secs())
1125 /// Returns the Unix timestamp representing the stored time
1126 pub fn as_unix_timestamp(&self) -> u64 {
1130 /// Returns the duration of the stored time since the Unix epoch
1131 pub fn as_duration_since_epoch(&self) -> Duration {
1135 /// Returns the [`SystemTime`] representing the stored time
1136 #[cfg(feature = "std")]
1137 pub fn as_time(&self) -> SystemTime {
1138 SystemTime::UNIX_EPOCH + self.0
1142 impl From<PositiveTimestamp> for Duration {
1143 fn from(val: PositiveTimestamp) -> Self {
1148 #[cfg(feature = "std")]
1149 impl From<PositiveTimestamp> for SystemTime {
1150 fn from(val: PositiveTimestamp) -> Self {
1151 SystemTime::UNIX_EPOCH + val.0
1155 impl Bolt11Invoice {
1156 /// The hash of the [`RawBolt11Invoice`] that was signed.
1157 pub fn signable_hash(&self) -> [u8; 32] {
1158 self.signed_invoice.hash
1161 /// Transform the `Bolt11Invoice` into its unchecked version.
1162 pub fn into_signed_raw(self) -> SignedRawBolt11Invoice {
1166 /// Check that all mandatory fields are present
1167 fn check_field_counts(&self) -> Result<(), Bolt11SemanticError> {
1168 // "A writer MUST include exactly one p field […]."
1169 let payment_hash_cnt = self.tagged_fields().filter(|&tf| match *tf {
1170 TaggedField::PaymentHash(_) => true,
1173 if payment_hash_cnt < 1 {
1174 return Err(Bolt11SemanticError::NoPaymentHash);
1175 } else if payment_hash_cnt > 1 {
1176 return Err(Bolt11SemanticError::MultiplePaymentHashes);
1179 // "A writer MUST include either exactly one d or exactly one h field."
1180 let description_cnt = self.tagged_fields().filter(|&tf| match *tf {
1181 TaggedField::Description(_) | TaggedField::DescriptionHash(_) => true,
1184 if description_cnt < 1 {
1185 return Err(Bolt11SemanticError::NoDescription);
1186 } else if description_cnt > 1 {
1187 return Err(Bolt11SemanticError::MultipleDescriptions);
1190 self.check_payment_secret()?;
1195 /// Checks that there is exactly one payment secret field
1196 fn check_payment_secret(&self) -> Result<(), Bolt11SemanticError> {
1197 // "A writer MUST include exactly one `s` field."
1198 let payment_secret_count = self.tagged_fields().filter(|&tf| match *tf {
1199 TaggedField::PaymentSecret(_) => true,
1202 if payment_secret_count < 1 {
1203 return Err(Bolt11SemanticError::NoPaymentSecret);
1204 } else if payment_secret_count > 1 {
1205 return Err(Bolt11SemanticError::MultiplePaymentSecrets);
1211 /// Check that amount is a whole number of millisatoshis
1212 fn check_amount(&self) -> Result<(), Bolt11SemanticError> {
1213 if let Some(amount_pico_btc) = self.amount_pico_btc() {
1214 if amount_pico_btc % 10 != 0 {
1215 return Err(Bolt11SemanticError::ImpreciseAmount);
1221 /// Check that feature bits are set as required
1222 fn check_feature_bits(&self) -> Result<(), Bolt11SemanticError> {
1223 self.check_payment_secret()?;
1225 // "A writer MUST set an s field if and only if the payment_secret feature is set."
1226 // (this requirement has been since removed, and we now require the payment secret
1227 // feature bit always).
1228 let features = self.tagged_fields().find(|&tf| match *tf {
1229 TaggedField::Features(_) => true,
1233 None => Err(Bolt11SemanticError::InvalidFeatures),
1234 Some(TaggedField::Features(features)) => {
1235 if features.requires_unknown_bits() {
1236 Err(Bolt11SemanticError::InvalidFeatures)
1237 } else if !features.supports_payment_secret() {
1238 Err(Bolt11SemanticError::InvalidFeatures)
1243 Some(_) => unreachable!(),
1247 /// Check that the invoice is signed correctly and that key recovery works
1248 pub fn check_signature(&self) -> Result<(), Bolt11SemanticError> {
1249 match self.signed_invoice.recover_payee_pub_key() {
1250 Err(secp256k1::Error::InvalidRecoveryId) =>
1251 return Err(Bolt11SemanticError::InvalidRecoveryId),
1252 Err(secp256k1::Error::InvalidSignature) =>
1253 return Err(Bolt11SemanticError::InvalidSignature),
1254 Err(e) => panic!("no other error may occur, got {:?}", e),
1258 if !self.signed_invoice.check_signature() {
1259 return Err(Bolt11SemanticError::InvalidSignature);
1265 /// Constructs a `Bolt11Invoice` from a [`SignedRawBolt11Invoice`] by checking all its invariants.
1267 /// use lightning_invoice::*;
1269 /// let invoice = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
1270 /// h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
1271 /// 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
1272 /// h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
1273 /// j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
1274 /// ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
1275 /// guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
1276 /// ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
1277 /// p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
1278 /// 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
1279 /// j5r6drg6k6zcqj0fcwg";
1281 /// let signed = invoice.parse::<SignedRawBolt11Invoice>().unwrap();
1283 /// assert!(Bolt11Invoice::from_signed(signed).is_ok());
1285 pub fn from_signed(signed_invoice: SignedRawBolt11Invoice) -> Result<Self, Bolt11SemanticError> {
1286 let invoice = Bolt11Invoice {
1289 invoice.check_field_counts()?;
1290 invoice.check_feature_bits()?;
1291 invoice.check_signature()?;
1292 invoice.check_amount()?;
1297 /// Returns the `Bolt11Invoice`'s timestamp (should equal its creation time)
1298 #[cfg(feature = "std")]
1299 pub fn timestamp(&self) -> SystemTime {
1300 self.signed_invoice.raw_invoice().data.timestamp.as_time()
1303 /// Returns the `Bolt11Invoice`'s timestamp as a duration since the Unix epoch
1304 pub fn duration_since_epoch(&self) -> Duration {
1305 self.signed_invoice.raw_invoice().data.timestamp.0
1308 /// Returns an iterator over all tagged fields of this `Bolt11Invoice`.
1310 /// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
1311 pub fn tagged_fields(&self)
1312 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>> {
1313 self.signed_invoice.raw_invoice().known_tagged_fields()
1316 /// Returns the hash to which we will receive the preimage on completion of the payment
1317 pub fn payment_hash(&self) -> &sha256::Hash {
1318 &self.signed_invoice.payment_hash().expect("checked by constructor").0
1321 /// Return the description or a hash of it for longer ones
1323 /// This is not exported to bindings users because we don't yet export Bolt11InvoiceDescription
1324 pub fn description(&self) -> Bolt11InvoiceDescription {
1325 if let Some(direct) = self.signed_invoice.description() {
1326 return Bolt11InvoiceDescription::Direct(direct);
1327 } else if let Some(hash) = self.signed_invoice.description_hash() {
1328 return Bolt11InvoiceDescription::Hash(hash);
1330 unreachable!("ensured by constructor");
1333 /// Get the payee's public key if one was included in the invoice
1334 pub fn payee_pub_key(&self) -> Option<&PublicKey> {
1335 self.signed_invoice.payee_pub_key().map(|x| &x.0)
1338 /// Get the payment secret if one was included in the invoice
1339 pub fn payment_secret(&self) -> &PaymentSecret {
1340 self.signed_invoice.payment_secret().expect("was checked by constructor")
1343 /// Get the payment metadata blob if one was included in the invoice
1344 pub fn payment_metadata(&self) -> Option<&Vec<u8>> {
1345 self.signed_invoice.payment_metadata()
1348 /// Get the invoice features if they were included in the invoice
1349 pub fn features(&self) -> Option<&Bolt11InvoiceFeatures> {
1350 self.signed_invoice.features()
1353 /// Recover the payee's public key (only to be used if none was included in the invoice)
1354 pub fn recover_payee_pub_key(&self) -> PublicKey {
1355 self.signed_invoice.recover_payee_pub_key().expect("was checked by constructor").0
1358 /// Recover the payee's public key if one was included in the invoice, otherwise return the
1359 /// recovered public key from the signature
1360 pub fn get_payee_pub_key(&self) -> PublicKey {
1361 match self.payee_pub_key() {
1363 None => self.recover_payee_pub_key()
1367 /// Returns the Duration since the Unix epoch at which the invoice expires.
1368 /// Returning None if overflow occurred.
1369 pub fn expires_at(&self) -> Option<Duration> {
1370 self.duration_since_epoch().checked_add(self.expiry_time())
1373 /// Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
1374 pub fn expiry_time(&self) -> Duration {
1375 self.signed_invoice.expiry_time()
1377 .unwrap_or(Duration::from_secs(DEFAULT_EXPIRY_TIME))
1380 /// Returns whether the invoice has expired.
1381 #[cfg(feature = "std")]
1382 pub fn is_expired(&self) -> bool {
1383 Self::is_expired_from_epoch(&self.timestamp(), self.expiry_time())
1386 /// Returns whether the expiry time from the given epoch has passed.
1387 #[cfg(feature = "std")]
1388 pub(crate) fn is_expired_from_epoch(epoch: &SystemTime, expiry_time: Duration) -> bool {
1389 match epoch.elapsed() {
1390 Ok(elapsed) => elapsed > expiry_time,
1395 /// Returns the Duration remaining until the invoice expires.
1396 #[cfg(feature = "std")]
1397 pub fn duration_until_expiry(&self) -> Duration {
1398 SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)
1399 .map(|now| self.expiration_remaining_from_epoch(now))
1400 .unwrap_or(Duration::from_nanos(0))
1403 /// Returns the Duration remaining until the invoice expires given the current time.
1404 /// `time` is the timestamp as a duration since the Unix epoch.
1405 pub fn expiration_remaining_from_epoch(&self, time: Duration) -> Duration {
1406 self.expires_at().map(|x| x.checked_sub(time)).flatten().unwrap_or(Duration::from_nanos(0))
1409 /// Returns whether the expiry time would pass at the given point in time.
1410 /// `at_time` is the timestamp as a duration since the Unix epoch.
1411 pub fn would_expire(&self, at_time: Duration) -> bool {
1412 self.duration_since_epoch()
1413 .checked_add(self.expiry_time())
1414 .unwrap_or_else(|| Duration::new(u64::max_value(), 1_000_000_000 - 1)) < at_time
1417 /// Returns the invoice's `min_final_cltv_expiry_delta` time, if present, otherwise
1418 /// [`DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA`].
1419 pub fn min_final_cltv_expiry_delta(&self) -> u64 {
1420 self.signed_invoice.min_final_cltv_expiry_delta()
1422 .unwrap_or(DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA)
1425 /// Returns a list of all fallback addresses
1427 /// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
1428 pub fn fallbacks(&self) -> Vec<&Fallback> {
1429 self.signed_invoice.fallbacks()
1432 /// Returns a list of all fallback addresses as [`Address`]es
1433 pub fn fallback_addresses(&self) -> Vec<Address> {
1434 self.fallbacks().iter().filter_map(|fallback| {
1435 let payload = match fallback {
1436 Fallback::SegWitProgram { version, program } => {
1437 match WitnessProgram::new(*version, program.clone()) {
1438 Ok(witness_program) => Payload::WitnessProgram(witness_program),
1439 Err(_) => return None,
1442 Fallback::PubKeyHash(pkh) => {
1443 Payload::PubkeyHash(*pkh)
1445 Fallback::ScriptHash(sh) => {
1446 Payload::ScriptHash(*sh)
1450 Some(Address::new(self.network(), payload))
1454 /// Returns a list of all routes included in the invoice
1455 pub fn private_routes(&self) -> Vec<&PrivateRoute> {
1456 self.signed_invoice.private_routes()
1459 /// Returns a list of all routes included in the invoice as the underlying hints
1460 pub fn route_hints(&self) -> Vec<RouteHint> {
1462 self.signed_invoice.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x
1463 ).map(|route| (**route).clone()).collect()
1466 /// Returns the currency for which the invoice was issued
1467 pub fn currency(&self) -> Currency {
1468 self.signed_invoice.currency()
1471 /// Returns the network for which the invoice was issued
1473 /// This is not exported to bindings users, see [`Self::currency`] instead.
1474 pub fn network(&self) -> Network {
1475 self.signed_invoice.currency().into()
1478 /// Returns the amount if specified in the invoice as millisatoshis.
1479 pub fn amount_milli_satoshis(&self) -> Option<u64> {
1480 self.signed_invoice.amount_pico_btc().map(|v| v / 10)
1483 /// Returns the amount if specified in the invoice as pico BTC.
1484 fn amount_pico_btc(&self) -> Option<u64> {
1485 self.signed_invoice.amount_pico_btc()
1489 impl From<TaggedField> for RawTaggedField {
1490 fn from(tf: TaggedField) -> Self {
1491 RawTaggedField::KnownSemantics(tf)
1496 /// Numeric representation of the field's tag
1497 pub fn tag(&self) -> u5 {
1498 let tag = match *self {
1499 TaggedField::PaymentHash(_) => constants::TAG_PAYMENT_HASH,
1500 TaggedField::Description(_) => constants::TAG_DESCRIPTION,
1501 TaggedField::PayeePubKey(_) => constants::TAG_PAYEE_PUB_KEY,
1502 TaggedField::DescriptionHash(_) => constants::TAG_DESCRIPTION_HASH,
1503 TaggedField::ExpiryTime(_) => constants::TAG_EXPIRY_TIME,
1504 TaggedField::MinFinalCltvExpiryDelta(_) => constants::TAG_MIN_FINAL_CLTV_EXPIRY_DELTA,
1505 TaggedField::Fallback(_) => constants::TAG_FALLBACK,
1506 TaggedField::PrivateRoute(_) => constants::TAG_PRIVATE_ROUTE,
1507 TaggedField::PaymentSecret(_) => constants::TAG_PAYMENT_SECRET,
1508 TaggedField::PaymentMetadata(_) => constants::TAG_PAYMENT_METADATA,
1509 TaggedField::Features(_) => constants::TAG_FEATURES,
1512 u5::try_from_u8(tag).expect("all tags defined are <32")
1518 /// Creates a new `Description` if `description` is at most 1023 __bytes__ long,
1519 /// returns [`CreationError::DescriptionTooLong`] otherwise
1521 /// Please note that single characters may use more than one byte due to UTF8 encoding.
1522 pub fn new(description: String) -> Result<Description, CreationError> {
1523 if description.len() > 639 {
1524 Err(CreationError::DescriptionTooLong)
1526 Ok(Description(UntrustedString(description)))
1530 /// Returns the underlying description [`UntrustedString`]
1531 pub fn into_inner(self) -> UntrustedString {
1536 impl Display for Description {
1537 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1538 write!(f, "{}", self.0)
1542 impl From<PublicKey> for PayeePubKey {
1543 fn from(pk: PublicKey) -> Self {
1548 impl Deref for PayeePubKey {
1549 type Target = PublicKey;
1551 fn deref(&self) -> &PublicKey {
1557 /// Construct an `ExpiryTime` from seconds.
1558 pub fn from_seconds(seconds: u64) -> ExpiryTime {
1559 ExpiryTime(Duration::from_secs(seconds))
1562 /// Construct an `ExpiryTime` from a [`Duration`], dropping the sub-second part.
1563 pub fn from_duration(duration: Duration) -> ExpiryTime {
1564 Self::from_seconds(duration.as_secs())
1567 /// Returns the expiry time in seconds
1568 pub fn as_seconds(&self) -> u64 {
1572 /// Returns a reference to the underlying [`Duration`] (=expiry time)
1573 pub fn as_duration(&self) -> &Duration {
1579 /// Creates a new (partial) route from a list of hops
1580 pub fn new(hops: RouteHint) -> Result<PrivateRoute, CreationError> {
1581 if hops.0.len() <= 12 {
1582 Ok(PrivateRoute(hops))
1584 Err(CreationError::RouteTooLong)
1588 /// Returns the underlying list of hops
1589 pub fn into_inner(self) -> RouteHint {
1594 impl From<PrivateRoute> for RouteHint {
1595 fn from(val: PrivateRoute) -> Self {
1600 impl Deref for PrivateRoute {
1601 type Target = RouteHint;
1603 fn deref(&self) -> &RouteHint {
1608 impl Deref for Bolt11InvoiceSignature {
1609 type Target = RecoverableSignature;
1611 fn deref(&self) -> &RecoverableSignature {
1616 impl Deref for SignedRawBolt11Invoice {
1617 type Target = RawBolt11Invoice;
1619 fn deref(&self) -> &RawBolt11Invoice {
1624 /// Errors that may occur when constructing a new [`RawBolt11Invoice`] or [`Bolt11Invoice`]
1625 #[derive(Eq, PartialEq, Debug, Clone)]
1626 pub enum CreationError {
1627 /// The supplied description string was longer than 639 __bytes__ (see [`Description::new`])
1630 /// The specified route has too many hops and can't be encoded
1633 /// The Unix timestamp of the supplied date is less than zero or greater than 35-bits
1634 TimestampOutOfBounds,
1636 /// The supplied millisatoshi amount was greater than the total bitcoin supply.
1639 /// Route hints were required for this invoice and were missing. Applies to
1640 /// [phantom invoices].
1642 /// [phantom invoices]: crate::utils::create_phantom_invoice
1645 /// The provided `min_final_cltv_expiry_delta` was less than [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
1647 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
1648 MinFinalCltvExpiryDeltaTooShort,
1651 impl Display for CreationError {
1652 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1654 CreationError::DescriptionTooLong => f.write_str("The supplied description string was longer than 639 bytes"),
1655 CreationError::RouteTooLong => f.write_str("The specified route has too many hops and can't be encoded"),
1656 CreationError::TimestampOutOfBounds => f.write_str("The Unix timestamp of the supplied date is less than zero or greater than 35-bits"),
1657 CreationError::InvalidAmount => f.write_str("The supplied millisatoshi amount was greater than the total bitcoin supply"),
1658 CreationError::MissingRouteHints => f.write_str("The invoice required route hints and they weren't provided"),
1659 CreationError::MinFinalCltvExpiryDeltaTooShort => f.write_str(
1660 "The supplied final CLTV expiry delta was less than LDK's `MIN_FINAL_CLTV_EXPIRY_DELTA`"),
1665 #[cfg(feature = "std")]
1666 impl std::error::Error for CreationError { }
1668 /// Errors that may occur when converting a [`RawBolt11Invoice`] to a [`Bolt11Invoice`]. They relate to
1669 /// the requirements sections in BOLT #11
1670 #[derive(Eq, PartialEq, Debug, Clone)]
1671 pub enum Bolt11SemanticError {
1672 /// The invoice is missing the mandatory payment hash
1675 /// The invoice has multiple payment hashes which isn't allowed
1676 MultiplePaymentHashes,
1678 /// No description or description hash are part of the invoice
1681 /// The invoice contains multiple descriptions and/or description hashes which isn't allowed
1682 MultipleDescriptions,
1684 /// The invoice is missing the mandatory payment secret, which all modern lightning nodes
1688 /// The invoice contains multiple payment secrets
1689 MultiplePaymentSecrets,
1691 /// The invoice's features are invalid
1694 /// The recovery id doesn't fit the signature/pub key
1697 /// The invoice's signature is invalid
1700 /// The invoice's amount was not a whole number of millisatoshis
1704 impl Display for Bolt11SemanticError {
1705 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1707 Bolt11SemanticError::NoPaymentHash => f.write_str("The invoice is missing the mandatory payment hash"),
1708 Bolt11SemanticError::MultiplePaymentHashes => f.write_str("The invoice has multiple payment hashes which isn't allowed"),
1709 Bolt11SemanticError::NoDescription => f.write_str("No description or description hash are part of the invoice"),
1710 Bolt11SemanticError::MultipleDescriptions => f.write_str("The invoice contains multiple descriptions and/or description hashes which isn't allowed"),
1711 Bolt11SemanticError::NoPaymentSecret => f.write_str("The invoice is missing the mandatory payment secret"),
1712 Bolt11SemanticError::MultiplePaymentSecrets => f.write_str("The invoice contains multiple payment secrets"),
1713 Bolt11SemanticError::InvalidFeatures => f.write_str("The invoice's features are invalid"),
1714 Bolt11SemanticError::InvalidRecoveryId => f.write_str("The recovery id doesn't fit the signature/pub key"),
1715 Bolt11SemanticError::InvalidSignature => f.write_str("The invoice's signature is invalid"),
1716 Bolt11SemanticError::ImpreciseAmount => f.write_str("The invoice's amount was not a whole number of millisatoshis"),
1721 #[cfg(feature = "std")]
1722 impl std::error::Error for Bolt11SemanticError { }
1724 /// When signing using a fallible method either an user-supplied `SignError` or a [`CreationError`]
1726 #[derive(Eq, PartialEq, Debug, Clone)]
1727 pub enum SignOrCreationError<S = ()> {
1728 /// An error occurred during signing
1731 /// An error occurred while building the transaction
1732 CreationError(CreationError),
1735 impl<S> Display for SignOrCreationError<S> {
1736 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1738 SignOrCreationError::SignError(_) => f.write_str("An error occurred during signing"),
1739 SignOrCreationError::CreationError(err) => err.fmt(f),
1744 #[cfg(feature = "serde")]
1745 impl Serialize for Bolt11Invoice {
1746 fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer {
1747 serializer.serialize_str(self.to_string().as_str())
1750 #[cfg(feature = "serde")]
1751 impl<'de> Deserialize<'de> for Bolt11Invoice {
1752 fn deserialize<D>(deserializer: D) -> Result<Bolt11Invoice, D::Error> where D: Deserializer<'de> {
1753 let bolt11 = String::deserialize(deserializer)?
1754 .parse::<Bolt11Invoice>()
1755 .map_err(|e| D::Error::custom(format_args!("{:?}", e)))?;
1763 use bitcoin::ScriptBuf;
1764 use bitcoin::hashes::sha256;
1765 use std::str::FromStr;
1768 fn test_system_time_bounds_assumptions() {
1770 crate::PositiveTimestamp::from_unix_timestamp(crate::MAX_TIMESTAMP + 1),
1771 Err(crate::CreationError::TimestampOutOfBounds)
1776 fn test_calc_invoice_hash() {
1777 use crate::{RawBolt11Invoice, RawHrp, RawDataPart, Currency, PositiveTimestamp};
1778 use crate::TaggedField::*;
1780 let invoice = RawBolt11Invoice {
1782 currency: Currency::Bitcoin,
1787 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1788 tagged_fields: vec![
1789 PaymentHash(crate::Sha256(sha256::Hash::from_str(
1790 "0001020304050607080900010203040506070809000102030405060708090102"
1791 ).unwrap())).into(),
1792 Description(crate::Description::new(
1793 "Please consider supporting this project".to_owned()
1799 let expected_hash = [
1800 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27, 0x7b, 0x1d,
1801 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7, 0x83, 0x5d, 0xb2, 0xec,
1802 0xd5, 0x18, 0xe1, 0xc9
1805 assert_eq!(invoice.signable_hash(), expected_hash)
1809 fn test_check_signature() {
1810 use crate::TaggedField::*;
1811 use secp256k1::Secp256k1;
1812 use secp256k1::ecdsa::{RecoveryId, RecoverableSignature};
1813 use secp256k1::{SecretKey, PublicKey};
1814 use crate::{SignedRawBolt11Invoice, Bolt11InvoiceSignature, RawBolt11Invoice, RawHrp, RawDataPart, Currency, Sha256,
1817 let invoice = SignedRawBolt11Invoice {
1818 raw_invoice: RawBolt11Invoice {
1820 currency: Currency::Bitcoin,
1825 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1826 tagged_fields: vec ! [
1827 PaymentHash(Sha256(sha256::Hash::from_str(
1828 "0001020304050607080900010203040506070809000102030405060708090102"
1829 ).unwrap())).into(),
1831 crate::Description::new(
1832 "Please consider supporting this project".to_owned()
1839 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27,
1840 0x7b, 0x1d, 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7,
1841 0x83, 0x5d, 0xb2, 0xec, 0xd5, 0x18, 0xe1, 0xc9
1843 signature: Bolt11InvoiceSignature(RecoverableSignature::from_compact(
1845 0x38u8, 0xec, 0x68, 0x91, 0x34, 0x5e, 0x20, 0x41, 0x45, 0xbe, 0x8a,
1846 0x3a, 0x99, 0xde, 0x38, 0xe9, 0x8a, 0x39, 0xd6, 0xa5, 0x69, 0x43,
1847 0x4e, 0x18, 0x45, 0xc8, 0xaf, 0x72, 0x05, 0xaf, 0xcf, 0xcc, 0x7f,
1848 0x42, 0x5f, 0xcd, 0x14, 0x63, 0xe9, 0x3c, 0x32, 0x88, 0x1e, 0xad,
1849 0x0d, 0x6e, 0x35, 0x6d, 0x46, 0x7e, 0xc8, 0xc0, 0x25, 0x53, 0xf9,
1850 0xaa, 0xb1, 0x5e, 0x57, 0x38, 0xb1, 0x1f, 0x12, 0x7f
1852 RecoveryId::from_i32(0).unwrap()
1856 assert!(invoice.check_signature());
1858 let private_key = SecretKey::from_slice(
1860 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1861 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1862 0x3b, 0x2d, 0xb7, 0x34
1865 let public_key = PublicKey::from_secret_key(&Secp256k1::new(), &private_key);
1867 assert_eq!(invoice.recover_payee_pub_key(), Ok(crate::PayeePubKey(public_key)));
1869 let (raw_invoice, _, _) = invoice.into_parts();
1870 let new_signed = raw_invoice.sign::<_, ()>(|hash| {
1871 Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key))
1874 assert!(new_signed.check_signature());
1878 fn test_check_feature_bits() {
1879 use crate::TaggedField::*;
1880 use lightning::ln::features::Bolt11InvoiceFeatures;
1881 use secp256k1::Secp256k1;
1882 use secp256k1::SecretKey;
1883 use crate::{Bolt11Invoice, RawBolt11Invoice, RawHrp, RawDataPart, Currency, Sha256, PositiveTimestamp,
1884 Bolt11SemanticError};
1886 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
1887 let payment_secret = lightning::ln::PaymentSecret([21; 32]);
1888 let invoice_template = RawBolt11Invoice {
1890 currency: Currency::Bitcoin,
1895 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1896 tagged_fields: vec ! [
1897 PaymentHash(Sha256(sha256::Hash::from_str(
1898 "0001020304050607080900010203040506070809000102030405060708090102"
1899 ).unwrap())).into(),
1901 crate::Description::new(
1902 "Please consider supporting this project".to_owned()
1911 let mut invoice = invoice_template.clone();
1912 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1913 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1915 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::InvalidFeatures));
1917 // Missing feature bits
1919 let mut invoice = invoice_template.clone();
1920 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1921 invoice.data.tagged_fields.push(Features(Bolt11InvoiceFeatures::empty()).into());
1922 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1924 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::InvalidFeatures));
1926 let mut payment_secret_features = Bolt11InvoiceFeatures::empty();
1927 payment_secret_features.set_payment_secret_required();
1929 // Including payment secret and feature bits
1931 let mut invoice = invoice_template.clone();
1932 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1933 invoice.data.tagged_fields.push(Features(payment_secret_features.clone()).into());
1934 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1936 assert!(Bolt11Invoice::from_signed(invoice).is_ok());
1938 // No payment secret or features
1940 let invoice = invoice_template.clone();
1941 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1943 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::NoPaymentSecret));
1945 // No payment secret or feature bits
1947 let mut invoice = invoice_template.clone();
1948 invoice.data.tagged_fields.push(Features(Bolt11InvoiceFeatures::empty()).into());
1949 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1951 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::NoPaymentSecret));
1953 // Missing payment secret
1955 let mut invoice = invoice_template.clone();
1956 invoice.data.tagged_fields.push(Features(payment_secret_features).into());
1957 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1959 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::NoPaymentSecret));
1961 // Multiple payment secrets
1963 let mut invoice = invoice_template;
1964 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1965 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1966 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1968 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::MultiplePaymentSecrets));
1972 fn test_builder_amount() {
1975 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1976 .description("Test".into())
1977 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1978 .duration_since_epoch(Duration::from_secs(1234567));
1980 let invoice = builder.clone()
1981 .amount_milli_satoshis(1500)
1985 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Nano));
1986 assert_eq!(invoice.hrp.raw_amount, Some(15));
1989 let invoice = builder
1990 .amount_milli_satoshis(150)
1994 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Pico));
1995 assert_eq!(invoice.hrp.raw_amount, Some(1500));
1999 fn test_builder_fail() {
2001 use lightning::routing::router::RouteHintHop;
2002 use std::iter::FromIterator;
2003 use secp256k1::PublicKey;
2005 let builder = InvoiceBuilder::new(Currency::Bitcoin)
2006 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2007 .duration_since_epoch(Duration::from_secs(1234567))
2008 .min_final_cltv_expiry_delta(144);
2010 let too_long_string = String::from_iter(
2011 (0..1024).map(|_| '?')
2014 let long_desc_res = builder.clone()
2015 .description(too_long_string)
2017 assert_eq!(long_desc_res, Err(CreationError::DescriptionTooLong));
2019 let route_hop = RouteHintHop {
2020 src_node_id: PublicKey::from_slice(
2022 0x03, 0x9e, 0x03, 0xa9, 0x01, 0xb8, 0x55, 0x34, 0xff, 0x1e, 0x92, 0xc4,
2023 0x3c, 0x74, 0x43, 0x1f, 0x7c, 0xe7, 0x20, 0x46, 0x06, 0x0f, 0xcf, 0x7a,
2024 0x95, 0xc3, 0x7e, 0x14, 0x8f, 0x78, 0xc7, 0x72, 0x55
2027 short_channel_id: 0,
2030 proportional_millionths: 0,
2032 cltv_expiry_delta: 0,
2033 htlc_minimum_msat: None,
2034 htlc_maximum_msat: None,
2036 let too_long_route = RouteHint(vec![route_hop; 13]);
2037 let long_route_res = builder.clone()
2038 .description("Test".into())
2039 .private_route(too_long_route)
2041 assert_eq!(long_route_res, Err(CreationError::RouteTooLong));
2043 let sign_error_res = builder
2044 .description("Test".into())
2045 .payment_secret(PaymentSecret([0; 32]))
2046 .try_build_signed(|_| {
2047 Err("ImaginaryError")
2049 assert_eq!(sign_error_res, Err(SignOrCreationError::SignError("ImaginaryError")));
2053 fn test_builder_ok() {
2055 use lightning::routing::router::RouteHintHop;
2056 use secp256k1::Secp256k1;
2057 use secp256k1::{SecretKey, PublicKey};
2058 use std::time::Duration;
2060 let secp_ctx = Secp256k1::new();
2062 let private_key = SecretKey::from_slice(
2064 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
2065 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
2066 0x3b, 0x2d, 0xb7, 0x34
2069 let public_key = PublicKey::from_secret_key(&secp_ctx, &private_key);
2071 let route_1 = RouteHint(vec![
2073 src_node_id: public_key,
2074 short_channel_id: de::parse_int_be(&[123; 8], 256).expect("short chan ID slice too big?"),
2077 proportional_millionths: 1,
2079 cltv_expiry_delta: 145,
2080 htlc_minimum_msat: None,
2081 htlc_maximum_msat: None,
2084 src_node_id: public_key,
2085 short_channel_id: de::parse_int_be(&[42; 8], 256).expect("short chan ID slice too big?"),
2088 proportional_millionths: 2,
2090 cltv_expiry_delta: 146,
2091 htlc_minimum_msat: None,
2092 htlc_maximum_msat: None,
2096 let route_2 = RouteHint(vec![
2098 src_node_id: public_key,
2099 short_channel_id: 0,
2102 proportional_millionths: 3,
2104 cltv_expiry_delta: 147,
2105 htlc_minimum_msat: None,
2106 htlc_maximum_msat: None,
2109 src_node_id: public_key,
2110 short_channel_id: de::parse_int_be(&[1; 8], 256).expect("short chan ID slice too big?"),
2113 proportional_millionths: 4,
2115 cltv_expiry_delta: 148,
2116 htlc_minimum_msat: None,
2117 htlc_maximum_msat: None,
2121 let builder = InvoiceBuilder::new(Currency::BitcoinTestnet)
2122 .amount_milli_satoshis(123)
2123 .duration_since_epoch(Duration::from_secs(1234567))
2124 .payee_pub_key(public_key)
2125 .expiry_time(Duration::from_secs(54321))
2126 .min_final_cltv_expiry_delta(144)
2127 .fallback(Fallback::PubKeyHash(PubkeyHash::from_slice(&[0;20]).unwrap()))
2128 .private_route(route_1.clone())
2129 .private_route(route_2.clone())
2130 .description_hash(sha256::Hash::from_slice(&[3;32][..]).unwrap())
2131 .payment_hash(sha256::Hash::from_slice(&[21;32][..]).unwrap())
2132 .payment_secret(PaymentSecret([42; 32]))
2135 let invoice = builder.clone().build_signed(|hash| {
2136 secp_ctx.sign_ecdsa_recoverable(hash, &private_key)
2139 assert!(invoice.check_signature().is_ok());
2140 assert_eq!(invoice.tagged_fields().count(), 10);
2142 assert_eq!(invoice.amount_milli_satoshis(), Some(123));
2143 assert_eq!(invoice.amount_pico_btc(), Some(1230));
2144 assert_eq!(invoice.currency(), Currency::BitcoinTestnet);
2145 #[cfg(feature = "std")]
2147 invoice.timestamp().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs(),
2150 assert_eq!(invoice.payee_pub_key(), Some(&public_key));
2151 assert_eq!(invoice.expiry_time(), Duration::from_secs(54321));
2152 assert_eq!(invoice.min_final_cltv_expiry_delta(), 144);
2153 assert_eq!(invoice.fallbacks(), vec![&Fallback::PubKeyHash(PubkeyHash::from_slice(&[0;20]).unwrap())]);
2154 let address = Address::from_script(&ScriptBuf::new_p2pkh(&PubkeyHash::from_slice(&[0;20]).unwrap()), Network::Testnet).unwrap();
2155 assert_eq!(invoice.fallback_addresses(), vec![address]);
2156 assert_eq!(invoice.private_routes(), vec![&PrivateRoute(route_1), &PrivateRoute(route_2)]);
2158 invoice.description(),
2159 Bolt11InvoiceDescription::Hash(&Sha256(sha256::Hash::from_slice(&[3;32][..]).unwrap()))
2161 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21;32][..]).unwrap());
2162 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));
2164 let mut expected_features = Bolt11InvoiceFeatures::empty();
2165 expected_features.set_variable_length_onion_required();
2166 expected_features.set_payment_secret_required();
2167 expected_features.set_basic_mpp_optional();
2168 assert_eq!(invoice.features(), Some(&expected_features));
2170 let raw_invoice = builder.build_raw().unwrap();
2171 assert_eq!(raw_invoice, *invoice.into_signed_raw().raw_invoice())
2175 fn test_default_values() {
2177 use secp256k1::Secp256k1;
2178 use secp256k1::SecretKey;
2180 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
2181 .description("Test".into())
2182 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2183 .payment_secret(PaymentSecret([0; 32]))
2184 .duration_since_epoch(Duration::from_secs(1234567))
2187 .sign::<_, ()>(|hash| {
2188 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
2189 let secp_ctx = Secp256k1::new();
2190 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
2193 let invoice = Bolt11Invoice::from_signed(signed_invoice).unwrap();
2195 assert_eq!(invoice.min_final_cltv_expiry_delta(), DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA);
2196 assert_eq!(invoice.expiry_time(), Duration::from_secs(DEFAULT_EXPIRY_TIME));
2197 assert!(!invoice.would_expire(Duration::from_secs(1234568)));
2201 fn test_expiration() {
2203 use secp256k1::Secp256k1;
2204 use secp256k1::SecretKey;
2206 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
2207 .description("Test".into())
2208 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2209 .payment_secret(PaymentSecret([0; 32]))
2210 .duration_since_epoch(Duration::from_secs(1234567))
2213 .sign::<_, ()>(|hash| {
2214 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
2215 let secp_ctx = Secp256k1::new();
2216 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
2219 let invoice = Bolt11Invoice::from_signed(signed_invoice).unwrap();
2221 assert!(invoice.would_expire(Duration::from_secs(1234567 + DEFAULT_EXPIRY_TIME + 1)));
2224 #[cfg(feature = "serde")]
2227 let invoice_str = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
2228 h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
2229 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
2230 h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
2231 j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
2232 ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
2233 guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
2234 ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
2235 p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
2236 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
2237 j5r6drg6k6zcqj0fcwg";
2238 let invoice = invoice_str.parse::<super::Bolt11Invoice>().unwrap();
2239 let serialized_invoice = serde_json::to_string(&invoice).unwrap();
2240 let deserialized_invoice: super::Bolt11Invoice = serde_json::from_str(serialized_invoice.as_str()).unwrap();
2241 assert_eq!(invoice, deserialized_invoice);
2242 assert_eq!(invoice_str, deserialized_invoice.to_string().as_str());
2243 assert_eq!(invoice_str, serialized_invoice.as_str().trim_matches('\"'));