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 secp256k1;
36 #[cfg(any(test, feature = "std"))]
38 #[cfg(feature = "serde")]
41 #[cfg(feature = "std")]
42 use std::time::SystemTime;
45 use bitcoin::{Address, Network, PubkeyHash, ScriptHash};
46 use bitcoin::address::{Payload, WitnessProgram, WitnessVersion};
47 use bitcoin::hashes::{Hash, sha256};
48 use lightning::ln::features::Bolt11InvoiceFeatures;
49 use lightning::util::invoice::construct_invoice_preimage;
51 use secp256k1::PublicKey;
52 use secp256k1::{Message, Secp256k1};
53 use secp256k1::ecdsa::RecoverableSignature;
55 use core::cmp::Ordering;
56 use core::fmt::{Display, Formatter, self};
57 use core::iter::FilterMap;
58 use core::num::ParseIntError;
60 use core::slice::Iter;
61 use core::time::Duration;
64 #[cfg(feature = "serde")]
65 use serde::{Deserialize, Deserializer,Serialize, Serializer, de::Error};
68 pub use lightning::ln::types::PaymentSecret;
70 pub use lightning::routing::router::{RouteHint, RouteHintHop};
72 pub use lightning::routing::gossip::RoutingFees;
73 use lightning::util::string::UntrustedString;
79 #[allow(unused_imports)]
81 pub use alloc::{vec, vec::Vec, string::String};
83 pub use alloc::string::ToString;
86 use crate::prelude::*;
88 /// Errors that indicate what is wrong with the invoice. They have some granularity for debug
89 /// reasons, but should generally result in an "invalid BOLT11 invoice" message for the user.
90 #[allow(missing_docs)]
91 #[derive(PartialEq, Eq, Debug, Clone)]
92 pub enum Bolt11ParseError {
93 Bech32Error(bech32::Error),
94 ParseAmountError(ParseIntError),
95 MalformedSignature(secp256k1::Error),
101 UnexpectedEndOfTaggedFields,
102 DescriptionDecodeError(str::Utf8Error),
104 IntegerOverflowError,
105 InvalidSegWitProgramLength,
106 InvalidPubKeyHashLength,
107 InvalidScriptHashLength,
109 InvalidSliceLength(String),
111 /// Not an error, but used internally to signal that a part of the invoice should be ignored
112 /// according to BOLT11
116 /// Indicates that something went wrong while parsing or validating the invoice. Parsing errors
117 /// should be mostly seen as opaque and are only there for debugging reasons. Semantic errors
118 /// like wrong signatures, missing fields etc. could mean that someone tampered with the invoice.
119 #[derive(PartialEq, Eq, Debug, Clone)]
120 pub enum ParseOrSemanticError {
121 /// The invoice couldn't be decoded
122 ParseError(Bolt11ParseError),
124 /// The invoice could be decoded but violates the BOLT11 standard
125 SemanticError(crate::Bolt11SemanticError),
128 /// The number of bits used to represent timestamps as defined in BOLT 11.
129 const TIMESTAMP_BITS: usize = 35;
131 /// The maximum timestamp as [`Duration::as_secs`] since the Unix epoch allowed by [`BOLT 11`].
133 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
134 pub const MAX_TIMESTAMP: u64 = (1 << TIMESTAMP_BITS) - 1;
136 /// Default expiry time as defined by [BOLT 11].
138 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
139 pub const DEFAULT_EXPIRY_TIME: u64 = 3600;
141 /// Default minimum final CLTV expiry as defined by [BOLT 11].
143 /// Note that this is *not* the same value as rust-lightning's minimum CLTV expiry, which is
144 /// provided in [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
146 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
147 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
148 pub const DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA: u64 = 18;
150 /// Builder for [`Bolt11Invoice`]s. It's the most convenient and advised way to use this library. It
151 /// ensures that only a semantically and syntactically correct invoice can be built using it.
154 /// extern crate secp256k1;
155 /// extern crate lightning;
156 /// extern crate lightning_invoice;
157 /// extern crate bitcoin;
159 /// use bitcoin::hashes::Hash;
160 /// use bitcoin::hashes::sha256;
162 /// use secp256k1::Secp256k1;
163 /// use secp256k1::SecretKey;
165 /// use lightning::ln::types::PaymentSecret;
167 /// use lightning_invoice::{Currency, InvoiceBuilder};
169 /// # #[cfg(not(feature = "std"))]
171 /// # #[cfg(feature = "std")]
173 /// let private_key = SecretKey::from_slice(
175 /// 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f,
176 /// 0xe2, 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04,
177 /// 0xa8, 0xca, 0x3b, 0x2d, 0xb7, 0x34
181 /// let payment_hash = sha256::Hash::from_slice(&[0; 32][..]).unwrap();
182 /// let payment_secret = PaymentSecret([42u8; 32]);
184 /// let invoice = InvoiceBuilder::new(Currency::Bitcoin)
185 /// .description("Coins pls!".into())
186 /// .payment_hash(payment_hash)
187 /// .payment_secret(payment_secret)
188 /// .current_timestamp()
189 /// .min_final_cltv_expiry_delta(144)
190 /// .build_signed(|hash| {
191 /// Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)
195 /// assert!(invoice.to_string().starts_with("lnbc1"));
199 /// # Type parameters
200 /// The two parameters `D` and `H` signal if the builder already contains the correct amount of the
202 /// * `D`: exactly one [`TaggedField::Description`] or [`TaggedField::DescriptionHash`]
203 /// * `H`: exactly one [`TaggedField::PaymentHash`]
204 /// * `T`: the timestamp is set
205 /// * `C`: the CLTV expiry is set
206 /// * `S`: the payment secret is set
207 /// * `M`: payment metadata is set
209 /// This is not exported to bindings users as we likely need to manually select one set of boolean type parameters.
210 #[derive(Eq, PartialEq, Debug, Clone)]
211 pub struct InvoiceBuilder<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> {
214 si_prefix: Option<SiPrefix>,
215 timestamp: Option<PositiveTimestamp>,
216 tagged_fields: Vec<TaggedField>,
217 error: Option<CreationError>,
219 phantom_d: core::marker::PhantomData<D>,
220 phantom_h: core::marker::PhantomData<H>,
221 phantom_t: core::marker::PhantomData<T>,
222 phantom_c: core::marker::PhantomData<C>,
223 phantom_s: core::marker::PhantomData<S>,
224 phantom_m: core::marker::PhantomData<M>,
227 /// Represents a syntactically and semantically correct lightning BOLT11 invoice.
229 /// There are three ways to construct a `Bolt11Invoice`:
230 /// 1. using [`InvoiceBuilder`]
231 /// 2. using [`Bolt11Invoice::from_signed`]
232 /// 3. using `str::parse::<Bolt11Invoice>(&str)` (see [`Bolt11Invoice::from_str`])
234 /// [`Bolt11Invoice::from_str`]: crate::Bolt11Invoice#impl-FromStr
235 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
236 pub struct Bolt11Invoice {
237 signed_invoice: SignedRawBolt11Invoice,
240 /// Represents the description of an invoice which has to be either a directly included string or
241 /// a hash of a description provided out of band.
243 /// This is not exported to bindings users as we don't have a good way to map the reference lifetimes making this
244 /// practically impossible to use safely in languages like C.
245 #[derive(Eq, PartialEq, Debug, Clone, Ord, PartialOrd)]
246 pub enum Bolt11InvoiceDescription<'f> {
247 /// Reference to the directly supplied description in the invoice
248 Direct(&'f Description),
250 /// Reference to the description's hash included in the invoice
254 impl<'f> Display for Bolt11InvoiceDescription<'f> {
255 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
257 Bolt11InvoiceDescription::Direct(desc) => write!(f, "{}", desc.0),
258 Bolt11InvoiceDescription::Hash(hash) => write!(f, "{}", hash.0),
263 /// Represents a signed [`RawBolt11Invoice`] with cached hash. The signature is not checked and may be
267 /// The hash has to be either from the deserialized invoice or from the serialized [`RawBolt11Invoice`].
268 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
269 pub struct SignedRawBolt11Invoice {
270 /// The raw invoice that the signature belongs to
271 raw_invoice: RawBolt11Invoice,
273 /// Hash of the [`RawBolt11Invoice`] that will be used to check the signature.
275 /// * if the `SignedRawBolt11Invoice` was deserialized the hash is of from the original encoded form,
276 /// since it's not guaranteed that encoding it again will lead to the same result since integers
277 /// could have been encoded with leading zeroes etc.
278 /// * if the `SignedRawBolt11Invoice` was constructed manually the hash will be the calculated hash
279 /// from the [`RawBolt11Invoice`]
282 /// signature of the payment request
283 signature: Bolt11InvoiceSignature,
286 /// Represents an syntactically correct [`Bolt11Invoice`] for a payment on the lightning network,
287 /// but without the signature information.
288 /// Decoding and encoding should not lead to information loss but may lead to different hashes.
290 /// For methods without docs see the corresponding methods in [`Bolt11Invoice`].
291 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
292 pub struct RawBolt11Invoice {
293 /// human readable part
297 pub data: RawDataPart,
300 /// Data of the [`RawBolt11Invoice`] that is encoded in the human readable part.
302 /// This is not exported to bindings users as we don't yet support `Option<Enum>`
303 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
305 /// The currency deferred from the 3rd and 4th character of the bech32 transaction
306 pub currency: Currency,
308 /// The amount that, multiplied by the SI prefix, has to be payed
309 pub raw_amount: Option<u64>,
311 /// SI prefix that gets multiplied with the `raw_amount`
312 pub si_prefix: Option<SiPrefix>,
315 /// Data of the [`RawBolt11Invoice`] that is encoded in the data part
316 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
317 pub struct RawDataPart {
318 /// generation time of the invoice
319 pub timestamp: PositiveTimestamp,
321 /// tagged fields of the payment request
322 pub tagged_fields: Vec<RawTaggedField>,
325 /// A timestamp that refers to a date after 1 January 1970.
329 /// The Unix timestamp representing the stored time has to be positive and no greater than
330 /// [`MAX_TIMESTAMP`].
331 #[derive(Eq, PartialEq, Debug, Clone, Hash, Ord, PartialOrd)]
332 pub struct PositiveTimestamp(Duration);
334 /// SI prefixes for the human readable part
335 #[derive(Eq, PartialEq, Debug, Clone, Copy, Hash, Ord, PartialOrd)]
348 /// Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix.
349 /// This is effectively 10^12 * the prefix multiplier
350 pub fn multiplier(&self) -> u64 {
352 SiPrefix::Milli => 1_000_000_000,
353 SiPrefix::Micro => 1_000_000,
354 SiPrefix::Nano => 1_000,
359 /// Returns all enum variants of `SiPrefix` sorted in descending order of their associated
362 /// This is not exported to bindings users as we don't yet support a slice of enums, and also because this function
363 /// isn't the most critical to expose.
364 pub fn values_desc() -> &'static [SiPrefix] {
365 use crate::SiPrefix::*;
366 static VALUES: [SiPrefix; 4] = [Milli, Micro, Nano, Pico];
371 /// Enum representing the crypto currencies (or networks) supported by this library
372 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
390 impl From<Network> for Currency {
391 fn from(network: Network) -> Self {
393 Network::Bitcoin => Currency::Bitcoin,
394 Network::Testnet => Currency::BitcoinTestnet,
395 Network::Regtest => Currency::Regtest,
396 Network::Signet => Currency::Signet,
398 debug_assert!(false, "Need to handle new rust-bitcoin network type");
405 impl From<Currency> for Network {
406 fn from(currency: Currency) -> Self {
408 Currency::Bitcoin => Network::Bitcoin,
409 Currency::BitcoinTestnet => Network::Testnet,
410 Currency::Regtest => Network::Regtest,
411 Currency::Simnet => Network::Regtest,
412 Currency::Signet => Network::Signet,
417 /// Tagged field which may have an unknown tag
419 /// This is not exported to bindings users as we don't currently support TaggedField
420 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
421 pub enum RawTaggedField {
422 /// Parsed tagged field with known tag
423 KnownSemantics(TaggedField),
424 /// tagged field which was not parsed due to an unknown tag or undefined field semantics
425 UnknownSemantics(Vec<u5>),
428 /// Tagged field with known tag
430 /// For descriptions of the enum values please refer to the enclosed type's docs.
432 /// This is not exported to bindings users as we don't yet support enum variants with the same name the struct contained
434 #[allow(missing_docs)]
435 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
436 pub enum TaggedField {
438 Description(Description),
439 PayeePubKey(PayeePubKey),
440 DescriptionHash(Sha256),
441 ExpiryTime(ExpiryTime),
442 MinFinalCltvExpiryDelta(MinFinalCltvExpiryDelta),
444 PrivateRoute(PrivateRoute),
445 PaymentSecret(PaymentSecret),
446 PaymentMetadata(Vec<u8>),
447 Features(Bolt11InvoiceFeatures),
451 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
452 pub struct Sha256(/// This is not exported to bindings users as the native hash types are not currently mapped
456 /// Constructs a new [`Sha256`] from the given bytes, which are assumed to be the output of a
457 /// single sha256 hash.
459 pub fn from_bytes(bytes: &[u8; 32]) -> Self {
460 Self(sha256::Hash::from_slice(bytes).expect("from_slice only fails if len is not 32"))
464 /// Description string
467 /// The description can be at most 639 __bytes__ long
468 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd, Default)]
469 pub struct Description(UntrustedString);
472 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
473 pub struct PayeePubKey(pub PublicKey);
475 /// Positive duration that defines when (relatively to the timestamp) in the future the invoice
477 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
478 pub struct ExpiryTime(Duration);
480 /// `min_final_cltv_expiry_delta` to use for the last HTLC in the route
481 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
482 pub struct MinFinalCltvExpiryDelta(pub u64);
484 /// Fallback address in case no LN payment is possible
485 #[allow(missing_docs)]
486 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
489 version: WitnessVersion,
492 PubKeyHash(PubkeyHash),
493 ScriptHash(ScriptHash),
496 /// Recoverable signature
497 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
498 pub struct Bolt11InvoiceSignature(pub RecoverableSignature);
500 impl PartialOrd for Bolt11InvoiceSignature {
501 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
502 Some(self.cmp(other))
506 impl Ord for Bolt11InvoiceSignature {
507 fn cmp(&self, other: &Self) -> Ordering {
508 self.0.serialize_compact().1.cmp(&other.0.serialize_compact().1)
512 /// Private routing information
515 /// The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)
517 #[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
518 pub struct PrivateRoute(RouteHint);
520 /// Tag constants as specified in BOLT11
521 #[allow(missing_docs)]
523 pub const TAG_PAYMENT_HASH: u8 = 1;
524 pub const TAG_DESCRIPTION: u8 = 13;
525 pub const TAG_PAYEE_PUB_KEY: u8 = 19;
526 pub const TAG_DESCRIPTION_HASH: u8 = 23;
527 pub const TAG_EXPIRY_TIME: u8 = 6;
528 pub const TAG_MIN_FINAL_CLTV_EXPIRY_DELTA: u8 = 24;
529 pub const TAG_FALLBACK: u8 = 9;
530 pub const TAG_PRIVATE_ROUTE: u8 = 3;
531 pub const TAG_PAYMENT_SECRET: u8 = 16;
532 pub const TAG_PAYMENT_METADATA: u8 = 27;
533 pub const TAG_FEATURES: u8 = 5;
536 impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False, tb::False> {
537 /// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
538 /// `InvoiceBuilder::build(self)` becomes available.
539 pub fn new(currency: Currency) -> Self {
545 tagged_fields: Vec::with_capacity(8),
548 phantom_d: core::marker::PhantomData,
549 phantom_h: core::marker::PhantomData,
550 phantom_t: core::marker::PhantomData,
551 phantom_c: core::marker::PhantomData,
552 phantom_s: core::marker::PhantomData,
553 phantom_m: core::marker::PhantomData,
558 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> {
559 /// Helper function to set the completeness flags.
560 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> {
561 InvoiceBuilder::<DN, HN, TN, CN, SN, MN> {
562 currency: self.currency,
564 si_prefix: self.si_prefix,
565 timestamp: self.timestamp,
566 tagged_fields: self.tagged_fields,
569 phantom_d: core::marker::PhantomData,
570 phantom_h: core::marker::PhantomData,
571 phantom_t: core::marker::PhantomData,
572 phantom_c: core::marker::PhantomData,
573 phantom_s: core::marker::PhantomData,
574 phantom_m: core::marker::PhantomData,
578 /// Sets the amount in millisatoshis. The optimal SI prefix is chosen automatically.
579 pub fn amount_milli_satoshis(mut self, amount_msat: u64) -> Self {
580 let amount = amount_msat * 10; // Invoices are denominated in "pico BTC"
581 let biggest_possible_si_prefix = SiPrefix::values_desc()
583 .find(|prefix| amount % prefix.multiplier() == 0)
584 .expect("Pico should always match");
585 self.amount = Some(amount / biggest_possible_si_prefix.multiplier());
586 self.si_prefix = Some(*biggest_possible_si_prefix);
590 /// Sets the payee's public key.
591 pub fn payee_pub_key(mut self, pub_key: PublicKey) -> Self {
592 self.tagged_fields.push(TaggedField::PayeePubKey(PayeePubKey(pub_key)));
596 /// Sets the expiry time, dropping the subsecond part (which is not representable in BOLT 11
598 pub fn expiry_time(mut self, expiry_time: Duration) -> Self {
599 self.tagged_fields.push(TaggedField::ExpiryTime(ExpiryTime::from_duration(expiry_time)));
603 /// Adds a fallback address.
604 pub fn fallback(mut self, fallback: Fallback) -> Self {
605 self.tagged_fields.push(TaggedField::Fallback(fallback));
609 /// Adds a private route.
610 pub fn private_route(mut self, hint: RouteHint) -> Self {
611 match PrivateRoute::new(hint) {
612 Ok(r) => self.tagged_fields.push(TaggedField::PrivateRoute(r)),
613 Err(e) => self.error = Some(e),
619 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, tb::True, C, S, M> {
620 /// Builds a [`RawBolt11Invoice`] if no [`CreationError`] occurred while construction any of the
622 pub fn build_raw(self) -> Result<RawBolt11Invoice, CreationError> {
624 // If an error occurred at any time before, return it now
625 if let Some(e) = self.error {
630 currency: self.currency,
631 raw_amount: self.amount,
632 si_prefix: self.si_prefix,
635 let timestamp = self.timestamp.expect("ensured to be Some(t) by type T");
637 let tagged_fields = self.tagged_fields.into_iter().map(|tf| {
638 RawTaggedField::KnownSemantics(tf)
639 }).collect::<Vec<_>>();
641 let data = RawDataPart {
646 Ok(RawBolt11Invoice {
653 impl<H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<tb::False, H, T, C, S, M> {
654 /// Set the description. This function is only available if no description (hash) was set.
655 pub fn description(mut self, description: String) -> InvoiceBuilder<tb::True, H, T, C, S, M> {
656 match Description::new(description) {
657 Ok(d) => self.tagged_fields.push(TaggedField::Description(d)),
658 Err(e) => self.error = Some(e),
663 /// Set the description hash. This function is only available if no description (hash) was set.
664 pub fn description_hash(mut self, description_hash: sha256::Hash) -> InvoiceBuilder<tb::True, H, T, C, S, M> {
665 self.tagged_fields.push(TaggedField::DescriptionHash(Sha256(description_hash)));
669 /// Set the description or description hash. This function is only available if no description (hash) was set.
670 pub fn invoice_description(self, description: Bolt11InvoiceDescription) -> InvoiceBuilder<tb::True, H, T, C, S, M> {
672 Bolt11InvoiceDescription::Direct(desc) => {
673 self.description(desc.clone().into_inner().0)
675 Bolt11InvoiceDescription::Hash(hash) => {
676 self.description_hash(hash.0)
682 impl<D: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, tb::False, T, C, S, M> {
683 /// Set the payment hash. This function is only available if no payment hash was set.
684 pub fn payment_hash(mut self, hash: sha256::Hash) -> InvoiceBuilder<D, tb::True, T, C, S, M> {
685 self.tagged_fields.push(TaggedField::PaymentHash(Sha256(hash)));
690 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, tb::False, C, S, M> {
691 /// Sets the timestamp to a specific [`SystemTime`].
692 #[cfg(feature = "std")]
693 pub fn timestamp(mut self, time: SystemTime) -> InvoiceBuilder<D, H, tb::True, C, S, M> {
694 match PositiveTimestamp::from_system_time(time) {
695 Ok(t) => self.timestamp = Some(t),
696 Err(e) => self.error = Some(e),
702 /// Sets the timestamp to a duration since the Unix epoch, dropping the subsecond part (which
703 /// is not representable in BOLT 11 invoices).
704 pub fn duration_since_epoch(mut self, time: Duration) -> InvoiceBuilder<D, H, tb::True, C, S, M> {
705 match PositiveTimestamp::from_duration_since_epoch(time) {
706 Ok(t) => self.timestamp = Some(t),
707 Err(e) => self.error = Some(e),
713 /// Sets the timestamp to the current system time.
714 #[cfg(feature = "std")]
715 pub fn current_timestamp(mut self) -> InvoiceBuilder<D, H, tb::True, C, S, M> {
716 let now = PositiveTimestamp::from_system_time(SystemTime::now());
717 self.timestamp = Some(now.expect("for the foreseeable future this shouldn't happen"));
722 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, tb::False, S, M> {
723 /// Sets `min_final_cltv_expiry_delta`.
724 pub fn min_final_cltv_expiry_delta(mut self, min_final_cltv_expiry_delta: u64) -> InvoiceBuilder<D, H, T, tb::True, S, M> {
725 self.tagged_fields.push(TaggedField::MinFinalCltvExpiryDelta(MinFinalCltvExpiryDelta(min_final_cltv_expiry_delta)));
730 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, C, tb::False, M> {
731 /// Sets the payment secret and relevant features.
732 pub fn payment_secret(mut self, payment_secret: PaymentSecret) -> InvoiceBuilder<D, H, T, C, tb::True, M> {
733 let mut found_features = false;
734 for field in self.tagged_fields.iter_mut() {
735 if let TaggedField::Features(f) = field {
736 found_features = true;
737 f.set_variable_length_onion_required();
738 f.set_payment_secret_required();
741 self.tagged_fields.push(TaggedField::PaymentSecret(payment_secret));
743 let mut features = Bolt11InvoiceFeatures::empty();
744 features.set_variable_length_onion_required();
745 features.set_payment_secret_required();
746 self.tagged_fields.push(TaggedField::Features(features));
752 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, C, S, tb::False> {
753 /// Sets the payment metadata.
755 /// By default features are set to *optionally* allow the sender to include the payment metadata.
756 /// If you wish to require that the sender include the metadata (and fail to parse the invoice if
757 /// they don't support payment metadata fields), you need to call
758 /// [`InvoiceBuilder::require_payment_metadata`] after this.
759 pub fn payment_metadata(mut self, payment_metadata: Vec<u8>) -> InvoiceBuilder<D, H, T, C, S, tb::True> {
760 self.tagged_fields.push(TaggedField::PaymentMetadata(payment_metadata));
761 let mut found_features = false;
762 for field in self.tagged_fields.iter_mut() {
763 if let TaggedField::Features(f) = field {
764 found_features = true;
765 f.set_payment_metadata_optional();
769 let mut features = Bolt11InvoiceFeatures::empty();
770 features.set_payment_metadata_optional();
771 self.tagged_fields.push(TaggedField::Features(features));
777 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, C, S, tb::True> {
778 /// Sets forwarding of payment metadata as required. A reader of the invoice which does not
779 /// support sending payment metadata will fail to read the invoice.
780 pub fn require_payment_metadata(mut self) -> InvoiceBuilder<D, H, T, C, S, tb::True> {
781 for field in self.tagged_fields.iter_mut() {
782 if let TaggedField::Features(f) = field {
783 f.set_payment_metadata_required();
790 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, C, tb::True, M> {
791 /// Sets the `basic_mpp` feature as optional.
792 pub fn basic_mpp(mut self) -> Self {
793 for field in self.tagged_fields.iter_mut() {
794 if let TaggedField::Features(f) = field {
795 f.set_basic_mpp_optional();
802 impl<M: tb::Bool> InvoiceBuilder<tb::True, tb::True, tb::True, tb::True, tb::True, M> {
803 /// Builds and signs an invoice using the supplied `sign_function`. This function MAY NOT fail
804 /// and MUST produce a recoverable signature valid for the given hash and if applicable also for
805 /// the included payee public key.
806 pub fn build_signed<F>(self, sign_function: F) -> Result<Bolt11Invoice, CreationError>
807 where F: FnOnce(&Message) -> RecoverableSignature
809 let invoice = self.try_build_signed::<_, ()>(|hash| {
810 Ok(sign_function(hash))
815 Err(SignOrCreationError::CreationError(e)) => Err(e),
816 Err(SignOrCreationError::SignError(())) => unreachable!(),
820 /// Builds and signs an invoice using the supplied `sign_function`. This function MAY fail with
821 /// an error of type `E` and MUST produce a recoverable signature valid for the given hash and
822 /// if applicable also for the included payee public key.
823 pub fn try_build_signed<F, E>(self, sign_function: F) -> Result<Bolt11Invoice, SignOrCreationError<E>>
824 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
826 let raw = match self.build_raw() {
828 Err(e) => return Err(SignOrCreationError::CreationError(e)),
831 let signed = match raw.sign(sign_function) {
833 Err(e) => return Err(SignOrCreationError::SignError(e)),
836 let invoice = Bolt11Invoice {
837 signed_invoice: signed,
840 invoice.check_field_counts().expect("should be ensured by type signature of builder");
841 invoice.check_feature_bits().expect("should be ensured by type signature of builder");
842 invoice.check_amount().expect("should be ensured by type signature of builder");
849 impl SignedRawBolt11Invoice {
850 /// Disassembles the `SignedRawBolt11Invoice` into its three parts:
852 /// 2. hash of the raw invoice
854 pub fn into_parts(self) -> (RawBolt11Invoice, [u8; 32], Bolt11InvoiceSignature) {
855 (self.raw_invoice, self.hash, self.signature)
858 /// The [`RawBolt11Invoice`] which was signed.
859 pub fn raw_invoice(&self) -> &RawBolt11Invoice {
863 /// The hash of the [`RawBolt11Invoice`] that was signed.
864 pub fn signable_hash(&self) -> &[u8; 32] {
868 /// Signature for the invoice.
869 pub fn signature(&self) -> &Bolt11InvoiceSignature {
873 /// Recovers the public key used for signing the invoice from the recoverable signature.
874 pub fn recover_payee_pub_key(&self) -> Result<PayeePubKey, secp256k1::Error> {
875 let hash = Message::from_slice(&self.hash[..])
876 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
878 Ok(PayeePubKey(Secp256k1::new().recover_ecdsa(
884 /// Checks if the signature is valid for the included payee public key or if none exists if it's
885 /// valid for the recovered signature (which should always be true?).
886 pub fn check_signature(&self) -> bool {
887 let included_pub_key = self.raw_invoice.payee_pub_key();
889 let mut recovered_pub_key = Option::None;
890 if recovered_pub_key.is_none() {
891 let recovered = match self.recover_payee_pub_key() {
893 Err(_) => return false,
895 recovered_pub_key = Some(recovered);
898 let pub_key = included_pub_key.or(recovered_pub_key.as_ref())
899 .expect("One is always present");
901 let hash = Message::from_slice(&self.hash[..])
902 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
904 let secp_context = Secp256k1::new();
905 let verification_result = secp_context.verify_ecdsa(
907 &self.signature.to_standard(),
911 match verification_result {
918 /// Finds the first element of an enum stream of a given variant and extracts one member of the
919 /// variant. If no element was found `None` gets returned.
921 /// The following example would extract the first B.
929 /// let elements = vec![Enum::A(1), Enum::A(2), Enum::B(3), Enum::A(4)];
931 /// assert_eq!(find_extract!(elements.iter(), Enum::B(x), x), Some(3u16));
933 macro_rules! find_extract {
934 ($iter:expr, $enm:pat, $enm_var:ident) => {
935 find_all_extract!($iter, $enm, $enm_var).next()
939 /// Finds the all elements of an enum stream of a given variant and extracts one member of the
940 /// variant through an iterator.
942 /// The following example would extract all A.
950 /// let elements = vec![Enum::A(1), Enum::A(2), Enum::B(3), Enum::A(4)];
953 /// find_all_extract!(elements.iter(), Enum::A(x), x).collect::<Vec<u8>>(),
954 /// vec![1u8, 2u8, 4u8]
957 macro_rules! find_all_extract {
958 ($iter:expr, $enm:pat, $enm_var:ident) => {
959 $iter.filter_map(|tf| match *tf {
960 $enm => Some($enm_var),
966 #[allow(missing_docs)]
967 impl RawBolt11Invoice {
968 /// Hash the HRP as bytes and signatureless data part.
969 fn hash_from_parts(hrp_bytes: &[u8], data_without_signature: &[u5]) -> [u8; 32] {
970 let preimage = construct_invoice_preimage(hrp_bytes, data_without_signature);
971 let mut hash: [u8; 32] = Default::default();
972 hash.copy_from_slice(&sha256::Hash::hash(&preimage)[..]);
976 /// Calculate the hash of the encoded `RawBolt11Invoice` which should be signed.
977 pub fn signable_hash(&self) -> [u8; 32] {
978 use bech32::ToBase32;
980 RawBolt11Invoice::hash_from_parts(
981 self.hrp.to_string().as_bytes(),
982 &self.data.to_base32()
986 /// Signs the invoice using the supplied `sign_method`. This function MAY fail with an error of
987 /// type `E`. Since the signature of a [`SignedRawBolt11Invoice`] is not required to be valid there
988 /// are no constraints regarding the validity of the produced signature.
990 /// This is not exported to bindings users as we don't currently support passing function pointers into methods
992 pub fn sign<F, E>(self, sign_method: F) -> Result<SignedRawBolt11Invoice, E>
993 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
995 let raw_hash = self.signable_hash();
996 let hash = Message::from_slice(&raw_hash[..])
997 .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
998 let signature = sign_method(&hash)?;
1000 Ok(SignedRawBolt11Invoice {
1003 signature: Bolt11InvoiceSignature(signature),
1007 /// Returns an iterator over all tagged fields with known semantics.
1009 /// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
1010 pub fn known_tagged_fields(&self)
1011 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>>
1013 // For 1.14.0 compatibility: closures' types can't be written an fn()->() in the
1014 // function's type signature.
1015 // TODO: refactor once impl Trait is available
1016 fn match_raw(raw: &RawTaggedField) -> Option<&TaggedField> {
1018 RawTaggedField::KnownSemantics(ref tf) => Some(tf),
1023 self.data.tagged_fields.iter().filter_map(match_raw )
1026 pub fn payment_hash(&self) -> Option<&Sha256> {
1027 find_extract!(self.known_tagged_fields(), TaggedField::PaymentHash(ref x), x)
1030 pub fn description(&self) -> Option<&Description> {
1031 find_extract!(self.known_tagged_fields(), TaggedField::Description(ref x), x)
1034 pub fn payee_pub_key(&self) -> Option<&PayeePubKey> {
1035 find_extract!(self.known_tagged_fields(), TaggedField::PayeePubKey(ref x), x)
1038 pub fn description_hash(&self) -> Option<&Sha256> {
1039 find_extract!(self.known_tagged_fields(), TaggedField::DescriptionHash(ref x), x)
1042 pub fn expiry_time(&self) -> Option<&ExpiryTime> {
1043 find_extract!(self.known_tagged_fields(), TaggedField::ExpiryTime(ref x), x)
1046 pub fn min_final_cltv_expiry_delta(&self) -> Option<&MinFinalCltvExpiryDelta> {
1047 find_extract!(self.known_tagged_fields(), TaggedField::MinFinalCltvExpiryDelta(ref x), x)
1050 pub fn payment_secret(&self) -> Option<&PaymentSecret> {
1051 find_extract!(self.known_tagged_fields(), TaggedField::PaymentSecret(ref x), x)
1054 pub fn payment_metadata(&self) -> Option<&Vec<u8>> {
1055 find_extract!(self.known_tagged_fields(), TaggedField::PaymentMetadata(ref x), x)
1058 pub fn features(&self) -> Option<&Bolt11InvoiceFeatures> {
1059 find_extract!(self.known_tagged_fields(), TaggedField::Features(ref x), x)
1062 /// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
1063 pub fn fallbacks(&self) -> Vec<&Fallback> {
1064 find_all_extract!(self.known_tagged_fields(), TaggedField::Fallback(ref x), x).collect()
1067 pub fn private_routes(&self) -> Vec<&PrivateRoute> {
1068 find_all_extract!(self.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x).collect()
1071 /// Returns `None` if no amount is set or on overflow.
1072 pub fn amount_pico_btc(&self) -> Option<u64> {
1073 self.hrp.raw_amount.and_then(|v| {
1074 v.checked_mul(self.hrp.si_prefix.as_ref().map_or(1_000_000_000_000, |si| { si.multiplier() }))
1078 pub fn currency(&self) -> Currency {
1079 self.hrp.currency.clone()
1083 impl PositiveTimestamp {
1084 /// Creates a `PositiveTimestamp` from a Unix timestamp in the range `0..=MAX_TIMESTAMP`.
1086 /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
1087 pub fn from_unix_timestamp(unix_seconds: u64) -> Result<Self, CreationError> {
1088 if unix_seconds <= MAX_TIMESTAMP {
1089 Ok(Self(Duration::from_secs(unix_seconds)))
1091 Err(CreationError::TimestampOutOfBounds)
1095 /// Creates a `PositiveTimestamp` from a [`SystemTime`] with a corresponding Unix timestamp in
1096 /// the range `0..=MAX_TIMESTAMP`.
1098 /// Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.
1100 /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
1101 #[cfg(feature = "std")]
1102 pub fn from_system_time(time: SystemTime) -> Result<Self, CreationError> {
1103 time.duration_since(SystemTime::UNIX_EPOCH)
1104 .map(Self::from_duration_since_epoch)
1105 .unwrap_or(Err(CreationError::TimestampOutOfBounds))
1108 /// Creates a `PositiveTimestamp` from a [`Duration`] since the Unix epoch in the range
1109 /// `0..=MAX_TIMESTAMP`.
1111 /// Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.
1113 /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
1114 pub fn from_duration_since_epoch(duration: Duration) -> Result<Self, CreationError> {
1115 Self::from_unix_timestamp(duration.as_secs())
1118 /// Returns the Unix timestamp representing the stored time
1119 pub fn as_unix_timestamp(&self) -> u64 {
1123 /// Returns the duration of the stored time since the Unix epoch
1124 pub fn as_duration_since_epoch(&self) -> Duration {
1128 /// Returns the [`SystemTime`] representing the stored time
1129 #[cfg(feature = "std")]
1130 pub fn as_time(&self) -> SystemTime {
1131 SystemTime::UNIX_EPOCH + self.0
1135 impl From<PositiveTimestamp> for Duration {
1136 fn from(val: PositiveTimestamp) -> Self {
1141 #[cfg(feature = "std")]
1142 impl From<PositiveTimestamp> for SystemTime {
1143 fn from(val: PositiveTimestamp) -> Self {
1144 SystemTime::UNIX_EPOCH + val.0
1148 impl Bolt11Invoice {
1149 /// The hash of the [`RawBolt11Invoice`] that was signed.
1150 pub fn signable_hash(&self) -> [u8; 32] {
1151 self.signed_invoice.hash
1154 /// Transform the `Bolt11Invoice` into its unchecked version.
1155 pub fn into_signed_raw(self) -> SignedRawBolt11Invoice {
1159 /// Check that all mandatory fields are present
1160 fn check_field_counts(&self) -> Result<(), Bolt11SemanticError> {
1161 // "A writer MUST include exactly one p field […]."
1162 let payment_hash_cnt = self.tagged_fields().filter(|&tf| match *tf {
1163 TaggedField::PaymentHash(_) => true,
1166 if payment_hash_cnt < 1 {
1167 return Err(Bolt11SemanticError::NoPaymentHash);
1168 } else if payment_hash_cnt > 1 {
1169 return Err(Bolt11SemanticError::MultiplePaymentHashes);
1172 // "A writer MUST include either exactly one d or exactly one h field."
1173 let description_cnt = self.tagged_fields().filter(|&tf| match *tf {
1174 TaggedField::Description(_) | TaggedField::DescriptionHash(_) => true,
1177 if description_cnt < 1 {
1178 return Err(Bolt11SemanticError::NoDescription);
1179 } else if description_cnt > 1 {
1180 return Err(Bolt11SemanticError::MultipleDescriptions);
1183 self.check_payment_secret()?;
1188 /// Checks that there is exactly one payment secret field
1189 fn check_payment_secret(&self) -> Result<(), Bolt11SemanticError> {
1190 // "A writer MUST include exactly one `s` field."
1191 let payment_secret_count = self.tagged_fields().filter(|&tf| match *tf {
1192 TaggedField::PaymentSecret(_) => true,
1195 if payment_secret_count < 1 {
1196 return Err(Bolt11SemanticError::NoPaymentSecret);
1197 } else if payment_secret_count > 1 {
1198 return Err(Bolt11SemanticError::MultiplePaymentSecrets);
1204 /// Check that amount is a whole number of millisatoshis
1205 fn check_amount(&self) -> Result<(), Bolt11SemanticError> {
1206 if let Some(amount_pico_btc) = self.amount_pico_btc() {
1207 if amount_pico_btc % 10 != 0 {
1208 return Err(Bolt11SemanticError::ImpreciseAmount);
1214 /// Check that feature bits are set as required
1215 fn check_feature_bits(&self) -> Result<(), Bolt11SemanticError> {
1216 self.check_payment_secret()?;
1218 // "A writer MUST set an s field if and only if the payment_secret feature is set."
1219 // (this requirement has been since removed, and we now require the payment secret
1220 // feature bit always).
1221 let features = self.tagged_fields().find(|&tf| match *tf {
1222 TaggedField::Features(_) => true,
1226 None => Err(Bolt11SemanticError::InvalidFeatures),
1227 Some(TaggedField::Features(features)) => {
1228 if features.requires_unknown_bits() {
1229 Err(Bolt11SemanticError::InvalidFeatures)
1230 } else if !features.supports_payment_secret() {
1231 Err(Bolt11SemanticError::InvalidFeatures)
1236 Some(_) => unreachable!(),
1240 /// Check that the invoice is signed correctly and that key recovery works
1241 pub fn check_signature(&self) -> Result<(), Bolt11SemanticError> {
1242 match self.signed_invoice.recover_payee_pub_key() {
1243 Err(secp256k1::Error::InvalidRecoveryId) =>
1244 return Err(Bolt11SemanticError::InvalidRecoveryId),
1245 Err(secp256k1::Error::InvalidSignature) =>
1246 return Err(Bolt11SemanticError::InvalidSignature),
1247 Err(e) => panic!("no other error may occur, got {:?}", e),
1251 if !self.signed_invoice.check_signature() {
1252 return Err(Bolt11SemanticError::InvalidSignature);
1258 /// Constructs a `Bolt11Invoice` from a [`SignedRawBolt11Invoice`] by checking all its invariants.
1260 /// use lightning_invoice::*;
1262 /// let invoice = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
1263 /// h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
1264 /// 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
1265 /// h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
1266 /// j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
1267 /// ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
1268 /// guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
1269 /// ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
1270 /// p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
1271 /// 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
1272 /// j5r6drg6k6zcqj0fcwg";
1274 /// let signed = invoice.parse::<SignedRawBolt11Invoice>().unwrap();
1276 /// assert!(Bolt11Invoice::from_signed(signed).is_ok());
1278 pub fn from_signed(signed_invoice: SignedRawBolt11Invoice) -> Result<Self, Bolt11SemanticError> {
1279 let invoice = Bolt11Invoice {
1282 invoice.check_field_counts()?;
1283 invoice.check_feature_bits()?;
1284 invoice.check_signature()?;
1285 invoice.check_amount()?;
1290 /// Returns the `Bolt11Invoice`'s timestamp (should equal its creation time)
1291 #[cfg(feature = "std")]
1292 pub fn timestamp(&self) -> SystemTime {
1293 self.signed_invoice.raw_invoice().data.timestamp.as_time()
1296 /// Returns the `Bolt11Invoice`'s timestamp as a duration since the Unix epoch
1297 pub fn duration_since_epoch(&self) -> Duration {
1298 self.signed_invoice.raw_invoice().data.timestamp.0
1301 /// Returns an iterator over all tagged fields of this `Bolt11Invoice`.
1303 /// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
1304 pub fn tagged_fields(&self)
1305 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>> {
1306 self.signed_invoice.raw_invoice().known_tagged_fields()
1309 /// Returns the hash to which we will receive the preimage on completion of the payment
1310 pub fn payment_hash(&self) -> &sha256::Hash {
1311 &self.signed_invoice.payment_hash().expect("checked by constructor").0
1314 /// Return the description or a hash of it for longer ones
1316 /// This is not exported to bindings users because we don't yet export Bolt11InvoiceDescription
1317 pub fn description(&self) -> Bolt11InvoiceDescription {
1318 if let Some(direct) = self.signed_invoice.description() {
1319 return Bolt11InvoiceDescription::Direct(direct);
1320 } else if let Some(hash) = self.signed_invoice.description_hash() {
1321 return Bolt11InvoiceDescription::Hash(hash);
1323 unreachable!("ensured by constructor");
1326 /// Get the payee's public key if one was included in the invoice
1327 pub fn payee_pub_key(&self) -> Option<&PublicKey> {
1328 self.signed_invoice.payee_pub_key().map(|x| &x.0)
1331 /// Get the payment secret if one was included in the invoice
1332 pub fn payment_secret(&self) -> &PaymentSecret {
1333 self.signed_invoice.payment_secret().expect("was checked by constructor")
1336 /// Get the payment metadata blob if one was included in the invoice
1337 pub fn payment_metadata(&self) -> Option<&Vec<u8>> {
1338 self.signed_invoice.payment_metadata()
1341 /// Get the invoice features if they were included in the invoice
1342 pub fn features(&self) -> Option<&Bolt11InvoiceFeatures> {
1343 self.signed_invoice.features()
1346 /// Recover the payee's public key (only to be used if none was included in the invoice)
1347 pub fn recover_payee_pub_key(&self) -> PublicKey {
1348 self.signed_invoice.recover_payee_pub_key().expect("was checked by constructor").0
1351 /// Recover the payee's public key if one was included in the invoice, otherwise return the
1352 /// recovered public key from the signature
1353 pub fn get_payee_pub_key(&self) -> PublicKey {
1354 match self.payee_pub_key() {
1356 None => self.recover_payee_pub_key()
1360 /// Returns the Duration since the Unix epoch at which the invoice expires.
1361 /// Returning None if overflow occurred.
1362 pub fn expires_at(&self) -> Option<Duration> {
1363 self.duration_since_epoch().checked_add(self.expiry_time())
1366 /// Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
1367 pub fn expiry_time(&self) -> Duration {
1368 self.signed_invoice.expiry_time()
1370 .unwrap_or(Duration::from_secs(DEFAULT_EXPIRY_TIME))
1373 /// Returns whether the invoice has expired.
1374 #[cfg(feature = "std")]
1375 pub fn is_expired(&self) -> bool {
1376 Self::is_expired_from_epoch(&self.timestamp(), self.expiry_time())
1379 /// Returns whether the expiry time from the given epoch has passed.
1380 #[cfg(feature = "std")]
1381 pub(crate) fn is_expired_from_epoch(epoch: &SystemTime, expiry_time: Duration) -> bool {
1382 match epoch.elapsed() {
1383 Ok(elapsed) => elapsed > expiry_time,
1388 /// Returns the Duration remaining until the invoice expires.
1389 #[cfg(feature = "std")]
1390 pub fn duration_until_expiry(&self) -> Duration {
1391 SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)
1392 .map(|now| self.expiration_remaining_from_epoch(now))
1393 .unwrap_or(Duration::from_nanos(0))
1396 /// Returns the Duration remaining until the invoice expires given the current time.
1397 /// `time` is the timestamp as a duration since the Unix epoch.
1398 pub fn expiration_remaining_from_epoch(&self, time: Duration) -> Duration {
1399 self.expires_at().map(|x| x.checked_sub(time)).flatten().unwrap_or(Duration::from_nanos(0))
1402 /// Returns whether the expiry time would pass at the given point in time.
1403 /// `at_time` is the timestamp as a duration since the Unix epoch.
1404 pub fn would_expire(&self, at_time: Duration) -> bool {
1405 self.duration_since_epoch()
1406 .checked_add(self.expiry_time())
1407 .unwrap_or_else(|| Duration::new(u64::max_value(), 1_000_000_000 - 1)) < at_time
1410 /// Returns the invoice's `min_final_cltv_expiry_delta` time, if present, otherwise
1411 /// [`DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA`].
1412 pub fn min_final_cltv_expiry_delta(&self) -> u64 {
1413 self.signed_invoice.min_final_cltv_expiry_delta()
1415 .unwrap_or(DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA)
1418 /// Returns a list of all fallback addresses
1420 /// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
1421 pub fn fallbacks(&self) -> Vec<&Fallback> {
1422 self.signed_invoice.fallbacks()
1425 /// Returns a list of all fallback addresses as [`Address`]es
1426 pub fn fallback_addresses(&self) -> Vec<Address> {
1427 self.fallbacks().iter().filter_map(|fallback| {
1428 let payload = match fallback {
1429 Fallback::SegWitProgram { version, program } => {
1430 match WitnessProgram::new(*version, program.clone()) {
1431 Ok(witness_program) => Payload::WitnessProgram(witness_program),
1432 Err(_) => return None,
1435 Fallback::PubKeyHash(pkh) => {
1436 Payload::PubkeyHash(*pkh)
1438 Fallback::ScriptHash(sh) => {
1439 Payload::ScriptHash(*sh)
1443 Some(Address::new(self.network(), payload))
1447 /// Returns a list of all routes included in the invoice
1448 pub fn private_routes(&self) -> Vec<&PrivateRoute> {
1449 self.signed_invoice.private_routes()
1452 /// Returns a list of all routes included in the invoice as the underlying hints
1453 pub fn route_hints(&self) -> Vec<RouteHint> {
1455 self.signed_invoice.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x
1456 ).map(|route| (**route).clone()).collect()
1459 /// Returns the currency for which the invoice was issued
1460 pub fn currency(&self) -> Currency {
1461 self.signed_invoice.currency()
1464 /// Returns the network for which the invoice was issued
1466 /// This is not exported to bindings users, see [`Self::currency`] instead.
1467 pub fn network(&self) -> Network {
1468 self.signed_invoice.currency().into()
1471 /// Returns the amount if specified in the invoice as millisatoshis.
1472 pub fn amount_milli_satoshis(&self) -> Option<u64> {
1473 self.signed_invoice.amount_pico_btc().map(|v| v / 10)
1476 /// Returns the amount if specified in the invoice as pico BTC.
1477 fn amount_pico_btc(&self) -> Option<u64> {
1478 self.signed_invoice.amount_pico_btc()
1482 impl From<TaggedField> for RawTaggedField {
1483 fn from(tf: TaggedField) -> Self {
1484 RawTaggedField::KnownSemantics(tf)
1489 /// Numeric representation of the field's tag
1490 pub fn tag(&self) -> u5 {
1491 let tag = match *self {
1492 TaggedField::PaymentHash(_) => constants::TAG_PAYMENT_HASH,
1493 TaggedField::Description(_) => constants::TAG_DESCRIPTION,
1494 TaggedField::PayeePubKey(_) => constants::TAG_PAYEE_PUB_KEY,
1495 TaggedField::DescriptionHash(_) => constants::TAG_DESCRIPTION_HASH,
1496 TaggedField::ExpiryTime(_) => constants::TAG_EXPIRY_TIME,
1497 TaggedField::MinFinalCltvExpiryDelta(_) => constants::TAG_MIN_FINAL_CLTV_EXPIRY_DELTA,
1498 TaggedField::Fallback(_) => constants::TAG_FALLBACK,
1499 TaggedField::PrivateRoute(_) => constants::TAG_PRIVATE_ROUTE,
1500 TaggedField::PaymentSecret(_) => constants::TAG_PAYMENT_SECRET,
1501 TaggedField::PaymentMetadata(_) => constants::TAG_PAYMENT_METADATA,
1502 TaggedField::Features(_) => constants::TAG_FEATURES,
1505 u5::try_from_u8(tag).expect("all tags defined are <32")
1511 /// Creates a new `Description` if `description` is at most 1023 __bytes__ long,
1512 /// returns [`CreationError::DescriptionTooLong`] otherwise
1514 /// Please note that single characters may use more than one byte due to UTF8 encoding.
1515 pub fn new(description: String) -> Result<Description, CreationError> {
1516 if description.len() > 639 {
1517 Err(CreationError::DescriptionTooLong)
1519 Ok(Description(UntrustedString(description)))
1523 /// Returns the underlying description [`UntrustedString`]
1524 pub fn into_inner(self) -> UntrustedString {
1529 impl Display for Description {
1530 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1531 write!(f, "{}", self.0)
1535 impl From<PublicKey> for PayeePubKey {
1536 fn from(pk: PublicKey) -> Self {
1541 impl Deref for PayeePubKey {
1542 type Target = PublicKey;
1544 fn deref(&self) -> &PublicKey {
1550 /// Construct an `ExpiryTime` from seconds.
1551 pub fn from_seconds(seconds: u64) -> ExpiryTime {
1552 ExpiryTime(Duration::from_secs(seconds))
1555 /// Construct an `ExpiryTime` from a [`Duration`], dropping the sub-second part.
1556 pub fn from_duration(duration: Duration) -> ExpiryTime {
1557 Self::from_seconds(duration.as_secs())
1560 /// Returns the expiry time in seconds
1561 pub fn as_seconds(&self) -> u64 {
1565 /// Returns a reference to the underlying [`Duration`] (=expiry time)
1566 pub fn as_duration(&self) -> &Duration {
1572 /// Creates a new (partial) route from a list of hops
1573 pub fn new(hops: RouteHint) -> Result<PrivateRoute, CreationError> {
1574 if hops.0.len() <= 12 {
1575 Ok(PrivateRoute(hops))
1577 Err(CreationError::RouteTooLong)
1581 /// Returns the underlying list of hops
1582 pub fn into_inner(self) -> RouteHint {
1587 impl From<PrivateRoute> for RouteHint {
1588 fn from(val: PrivateRoute) -> Self {
1593 impl Deref for PrivateRoute {
1594 type Target = RouteHint;
1596 fn deref(&self) -> &RouteHint {
1601 impl Deref for Bolt11InvoiceSignature {
1602 type Target = RecoverableSignature;
1604 fn deref(&self) -> &RecoverableSignature {
1609 impl Deref for SignedRawBolt11Invoice {
1610 type Target = RawBolt11Invoice;
1612 fn deref(&self) -> &RawBolt11Invoice {
1617 /// Errors that may occur when constructing a new [`RawBolt11Invoice`] or [`Bolt11Invoice`]
1618 #[derive(Eq, PartialEq, Debug, Clone)]
1619 pub enum CreationError {
1620 /// The supplied description string was longer than 639 __bytes__ (see [`Description::new`])
1623 /// The specified route has too many hops and can't be encoded
1626 /// The Unix timestamp of the supplied date is less than zero or greater than 35-bits
1627 TimestampOutOfBounds,
1629 /// The supplied millisatoshi amount was greater than the total bitcoin supply.
1632 /// Route hints were required for this invoice and were missing. Applies to
1633 /// [phantom invoices].
1635 /// [phantom invoices]: crate::utils::create_phantom_invoice
1638 /// The provided `min_final_cltv_expiry_delta` was less than [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
1640 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
1641 MinFinalCltvExpiryDeltaTooShort,
1644 impl Display for CreationError {
1645 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1647 CreationError::DescriptionTooLong => f.write_str("The supplied description string was longer than 639 bytes"),
1648 CreationError::RouteTooLong => f.write_str("The specified route has too many hops and can't be encoded"),
1649 CreationError::TimestampOutOfBounds => f.write_str("The Unix timestamp of the supplied date is less than zero or greater than 35-bits"),
1650 CreationError::InvalidAmount => f.write_str("The supplied millisatoshi amount was greater than the total bitcoin supply"),
1651 CreationError::MissingRouteHints => f.write_str("The invoice required route hints and they weren't provided"),
1652 CreationError::MinFinalCltvExpiryDeltaTooShort => f.write_str(
1653 "The supplied final CLTV expiry delta was less than LDK's `MIN_FINAL_CLTV_EXPIRY_DELTA`"),
1658 #[cfg(feature = "std")]
1659 impl std::error::Error for CreationError { }
1661 /// Errors that may occur when converting a [`RawBolt11Invoice`] to a [`Bolt11Invoice`]. They relate to
1662 /// the requirements sections in BOLT #11
1663 #[derive(Eq, PartialEq, Debug, Clone)]
1664 pub enum Bolt11SemanticError {
1665 /// The invoice is missing the mandatory payment hash
1668 /// The invoice has multiple payment hashes which isn't allowed
1669 MultiplePaymentHashes,
1671 /// No description or description hash are part of the invoice
1674 /// The invoice contains multiple descriptions and/or description hashes which isn't allowed
1675 MultipleDescriptions,
1677 /// The invoice is missing the mandatory payment secret, which all modern lightning nodes
1681 /// The invoice contains multiple payment secrets
1682 MultiplePaymentSecrets,
1684 /// The invoice's features are invalid
1687 /// The recovery id doesn't fit the signature/pub key
1690 /// The invoice's signature is invalid
1693 /// The invoice's amount was not a whole number of millisatoshis
1697 impl Display for Bolt11SemanticError {
1698 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1700 Bolt11SemanticError::NoPaymentHash => f.write_str("The invoice is missing the mandatory payment hash"),
1701 Bolt11SemanticError::MultiplePaymentHashes => f.write_str("The invoice has multiple payment hashes which isn't allowed"),
1702 Bolt11SemanticError::NoDescription => f.write_str("No description or description hash are part of the invoice"),
1703 Bolt11SemanticError::MultipleDescriptions => f.write_str("The invoice contains multiple descriptions and/or description hashes which isn't allowed"),
1704 Bolt11SemanticError::NoPaymentSecret => f.write_str("The invoice is missing the mandatory payment secret"),
1705 Bolt11SemanticError::MultiplePaymentSecrets => f.write_str("The invoice contains multiple payment secrets"),
1706 Bolt11SemanticError::InvalidFeatures => f.write_str("The invoice's features are invalid"),
1707 Bolt11SemanticError::InvalidRecoveryId => f.write_str("The recovery id doesn't fit the signature/pub key"),
1708 Bolt11SemanticError::InvalidSignature => f.write_str("The invoice's signature is invalid"),
1709 Bolt11SemanticError::ImpreciseAmount => f.write_str("The invoice's amount was not a whole number of millisatoshis"),
1714 #[cfg(feature = "std")]
1715 impl std::error::Error for Bolt11SemanticError { }
1717 /// When signing using a fallible method either an user-supplied `SignError` or a [`CreationError`]
1719 #[derive(Eq, PartialEq, Debug, Clone)]
1720 pub enum SignOrCreationError<S = ()> {
1721 /// An error occurred during signing
1724 /// An error occurred while building the transaction
1725 CreationError(CreationError),
1728 impl<S> Display for SignOrCreationError<S> {
1729 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1731 SignOrCreationError::SignError(_) => f.write_str("An error occurred during signing"),
1732 SignOrCreationError::CreationError(err) => err.fmt(f),
1737 #[cfg(feature = "serde")]
1738 impl Serialize for Bolt11Invoice {
1739 fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer {
1740 serializer.serialize_str(self.to_string().as_str())
1743 #[cfg(feature = "serde")]
1744 impl<'de> Deserialize<'de> for Bolt11Invoice {
1745 fn deserialize<D>(deserializer: D) -> Result<Bolt11Invoice, D::Error> where D: Deserializer<'de> {
1746 let bolt11 = String::deserialize(deserializer)?
1747 .parse::<Bolt11Invoice>()
1748 .map_err(|e| D::Error::custom(format_args!("{:?}", e)))?;
1756 use bitcoin::ScriptBuf;
1757 use bitcoin::hashes::sha256;
1758 use std::str::FromStr;
1761 fn test_system_time_bounds_assumptions() {
1763 crate::PositiveTimestamp::from_unix_timestamp(crate::MAX_TIMESTAMP + 1),
1764 Err(crate::CreationError::TimestampOutOfBounds)
1769 fn test_calc_invoice_hash() {
1770 use crate::{RawBolt11Invoice, RawHrp, RawDataPart, Currency, PositiveTimestamp};
1771 use crate::TaggedField::*;
1773 let invoice = RawBolt11Invoice {
1775 currency: Currency::Bitcoin,
1780 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1781 tagged_fields: vec![
1782 PaymentHash(crate::Sha256(sha256::Hash::from_str(
1783 "0001020304050607080900010203040506070809000102030405060708090102"
1784 ).unwrap())).into(),
1785 Description(crate::Description::new(
1786 "Please consider supporting this project".to_owned()
1792 let expected_hash = [
1793 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27, 0x7b, 0x1d,
1794 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7, 0x83, 0x5d, 0xb2, 0xec,
1795 0xd5, 0x18, 0xe1, 0xc9
1798 assert_eq!(invoice.signable_hash(), expected_hash)
1802 fn test_check_signature() {
1803 use crate::TaggedField::*;
1804 use secp256k1::Secp256k1;
1805 use secp256k1::ecdsa::{RecoveryId, RecoverableSignature};
1806 use secp256k1::{SecretKey, PublicKey};
1807 use crate::{SignedRawBolt11Invoice, Bolt11InvoiceSignature, RawBolt11Invoice, RawHrp, RawDataPart, Currency, Sha256,
1810 let invoice = SignedRawBolt11Invoice {
1811 raw_invoice: RawBolt11Invoice {
1813 currency: Currency::Bitcoin,
1818 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1819 tagged_fields: vec ! [
1820 PaymentHash(Sha256(sha256::Hash::from_str(
1821 "0001020304050607080900010203040506070809000102030405060708090102"
1822 ).unwrap())).into(),
1824 crate::Description::new(
1825 "Please consider supporting this project".to_owned()
1832 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27,
1833 0x7b, 0x1d, 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7,
1834 0x83, 0x5d, 0xb2, 0xec, 0xd5, 0x18, 0xe1, 0xc9
1836 signature: Bolt11InvoiceSignature(RecoverableSignature::from_compact(
1838 0x38u8, 0xec, 0x68, 0x91, 0x34, 0x5e, 0x20, 0x41, 0x45, 0xbe, 0x8a,
1839 0x3a, 0x99, 0xde, 0x38, 0xe9, 0x8a, 0x39, 0xd6, 0xa5, 0x69, 0x43,
1840 0x4e, 0x18, 0x45, 0xc8, 0xaf, 0x72, 0x05, 0xaf, 0xcf, 0xcc, 0x7f,
1841 0x42, 0x5f, 0xcd, 0x14, 0x63, 0xe9, 0x3c, 0x32, 0x88, 0x1e, 0xad,
1842 0x0d, 0x6e, 0x35, 0x6d, 0x46, 0x7e, 0xc8, 0xc0, 0x25, 0x53, 0xf9,
1843 0xaa, 0xb1, 0x5e, 0x57, 0x38, 0xb1, 0x1f, 0x12, 0x7f
1845 RecoveryId::from_i32(0).unwrap()
1849 assert!(invoice.check_signature());
1851 let private_key = SecretKey::from_slice(
1853 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1854 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1855 0x3b, 0x2d, 0xb7, 0x34
1858 let public_key = PublicKey::from_secret_key(&Secp256k1::new(), &private_key);
1860 assert_eq!(invoice.recover_payee_pub_key(), Ok(crate::PayeePubKey(public_key)));
1862 let (raw_invoice, _, _) = invoice.into_parts();
1863 let new_signed = raw_invoice.sign::<_, ()>(|hash| {
1864 Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key))
1867 assert!(new_signed.check_signature());
1871 fn test_check_feature_bits() {
1872 use crate::TaggedField::*;
1873 use lightning::ln::features::Bolt11InvoiceFeatures;
1874 use secp256k1::Secp256k1;
1875 use secp256k1::SecretKey;
1876 use crate::{Bolt11Invoice, RawBolt11Invoice, RawHrp, RawDataPart, Currency, Sha256, PositiveTimestamp,
1877 Bolt11SemanticError};
1879 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
1880 let payment_secret = lightning::ln::types::PaymentSecret([21; 32]);
1881 let invoice_template = RawBolt11Invoice {
1883 currency: Currency::Bitcoin,
1888 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1889 tagged_fields: vec ! [
1890 PaymentHash(Sha256(sha256::Hash::from_str(
1891 "0001020304050607080900010203040506070809000102030405060708090102"
1892 ).unwrap())).into(),
1894 crate::Description::new(
1895 "Please consider supporting this project".to_owned()
1904 let mut invoice = invoice_template.clone();
1905 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1906 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1908 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::InvalidFeatures));
1910 // Missing feature bits
1912 let mut invoice = invoice_template.clone();
1913 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1914 invoice.data.tagged_fields.push(Features(Bolt11InvoiceFeatures::empty()).into());
1915 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1917 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::InvalidFeatures));
1919 let mut payment_secret_features = Bolt11InvoiceFeatures::empty();
1920 payment_secret_features.set_payment_secret_required();
1922 // Including payment secret and feature bits
1924 let mut invoice = invoice_template.clone();
1925 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1926 invoice.data.tagged_fields.push(Features(payment_secret_features.clone()).into());
1927 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1929 assert!(Bolt11Invoice::from_signed(invoice).is_ok());
1931 // No payment secret or features
1933 let invoice = invoice_template.clone();
1934 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1936 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::NoPaymentSecret));
1938 // No payment secret or feature bits
1940 let mut invoice = invoice_template.clone();
1941 invoice.data.tagged_fields.push(Features(Bolt11InvoiceFeatures::empty()).into());
1942 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1944 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::NoPaymentSecret));
1946 // Missing payment secret
1948 let mut invoice = invoice_template.clone();
1949 invoice.data.tagged_fields.push(Features(payment_secret_features).into());
1950 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1952 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::NoPaymentSecret));
1954 // Multiple payment secrets
1956 let mut invoice = invoice_template;
1957 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1958 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1959 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1961 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::MultiplePaymentSecrets));
1965 fn test_builder_amount() {
1968 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1969 .description("Test".into())
1970 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1971 .duration_since_epoch(Duration::from_secs(1234567));
1973 let invoice = builder.clone()
1974 .amount_milli_satoshis(1500)
1978 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Nano));
1979 assert_eq!(invoice.hrp.raw_amount, Some(15));
1982 let invoice = builder
1983 .amount_milli_satoshis(150)
1987 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Pico));
1988 assert_eq!(invoice.hrp.raw_amount, Some(1500));
1992 fn test_builder_fail() {
1994 use lightning::routing::router::RouteHintHop;
1995 use std::iter::FromIterator;
1996 use secp256k1::PublicKey;
1998 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1999 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2000 .duration_since_epoch(Duration::from_secs(1234567))
2001 .min_final_cltv_expiry_delta(144);
2003 let too_long_string = String::from_iter(
2004 (0..1024).map(|_| '?')
2007 let long_desc_res = builder.clone()
2008 .description(too_long_string)
2010 assert_eq!(long_desc_res, Err(CreationError::DescriptionTooLong));
2012 let route_hop = RouteHintHop {
2013 src_node_id: PublicKey::from_slice(
2015 0x03, 0x9e, 0x03, 0xa9, 0x01, 0xb8, 0x55, 0x34, 0xff, 0x1e, 0x92, 0xc4,
2016 0x3c, 0x74, 0x43, 0x1f, 0x7c, 0xe7, 0x20, 0x46, 0x06, 0x0f, 0xcf, 0x7a,
2017 0x95, 0xc3, 0x7e, 0x14, 0x8f, 0x78, 0xc7, 0x72, 0x55
2020 short_channel_id: 0,
2023 proportional_millionths: 0,
2025 cltv_expiry_delta: 0,
2026 htlc_minimum_msat: None,
2027 htlc_maximum_msat: None,
2029 let too_long_route = RouteHint(vec![route_hop; 13]);
2030 let long_route_res = builder.clone()
2031 .description("Test".into())
2032 .private_route(too_long_route)
2034 assert_eq!(long_route_res, Err(CreationError::RouteTooLong));
2036 let sign_error_res = builder
2037 .description("Test".into())
2038 .payment_secret(PaymentSecret([0; 32]))
2039 .try_build_signed(|_| {
2040 Err("ImaginaryError")
2042 assert_eq!(sign_error_res, Err(SignOrCreationError::SignError("ImaginaryError")));
2046 fn test_builder_ok() {
2048 use lightning::routing::router::RouteHintHop;
2049 use secp256k1::Secp256k1;
2050 use secp256k1::{SecretKey, PublicKey};
2051 use std::time::Duration;
2053 let secp_ctx = Secp256k1::new();
2055 let private_key = SecretKey::from_slice(
2057 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
2058 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
2059 0x3b, 0x2d, 0xb7, 0x34
2062 let public_key = PublicKey::from_secret_key(&secp_ctx, &private_key);
2064 let route_1 = RouteHint(vec![
2066 src_node_id: public_key,
2067 short_channel_id: u64::from_be_bytes([123; 8]),
2070 proportional_millionths: 1,
2072 cltv_expiry_delta: 145,
2073 htlc_minimum_msat: None,
2074 htlc_maximum_msat: None,
2077 src_node_id: public_key,
2078 short_channel_id: u64::from_be_bytes([42; 8]),
2081 proportional_millionths: 2,
2083 cltv_expiry_delta: 146,
2084 htlc_minimum_msat: None,
2085 htlc_maximum_msat: None,
2089 let route_2 = RouteHint(vec![
2091 src_node_id: public_key,
2092 short_channel_id: 0,
2095 proportional_millionths: 3,
2097 cltv_expiry_delta: 147,
2098 htlc_minimum_msat: None,
2099 htlc_maximum_msat: None,
2102 src_node_id: public_key,
2103 short_channel_id: u64::from_be_bytes([1; 8]),
2106 proportional_millionths: 4,
2108 cltv_expiry_delta: 148,
2109 htlc_minimum_msat: None,
2110 htlc_maximum_msat: None,
2114 let builder = InvoiceBuilder::new(Currency::BitcoinTestnet)
2115 .amount_milli_satoshis(123)
2116 .duration_since_epoch(Duration::from_secs(1234567))
2117 .payee_pub_key(public_key)
2118 .expiry_time(Duration::from_secs(54321))
2119 .min_final_cltv_expiry_delta(144)
2120 .fallback(Fallback::PubKeyHash(PubkeyHash::from_slice(&[0;20]).unwrap()))
2121 .private_route(route_1.clone())
2122 .private_route(route_2.clone())
2123 .description_hash(sha256::Hash::from_slice(&[3;32][..]).unwrap())
2124 .payment_hash(sha256::Hash::from_slice(&[21;32][..]).unwrap())
2125 .payment_secret(PaymentSecret([42; 32]))
2128 let invoice = builder.clone().build_signed(|hash| {
2129 secp_ctx.sign_ecdsa_recoverable(hash, &private_key)
2132 assert!(invoice.check_signature().is_ok());
2133 assert_eq!(invoice.tagged_fields().count(), 10);
2135 assert_eq!(invoice.amount_milli_satoshis(), Some(123));
2136 assert_eq!(invoice.amount_pico_btc(), Some(1230));
2137 assert_eq!(invoice.currency(), Currency::BitcoinTestnet);
2138 #[cfg(feature = "std")]
2140 invoice.timestamp().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs(),
2143 assert_eq!(invoice.payee_pub_key(), Some(&public_key));
2144 assert_eq!(invoice.expiry_time(), Duration::from_secs(54321));
2145 assert_eq!(invoice.min_final_cltv_expiry_delta(), 144);
2146 assert_eq!(invoice.fallbacks(), vec![&Fallback::PubKeyHash(PubkeyHash::from_slice(&[0;20]).unwrap())]);
2147 let address = Address::from_script(&ScriptBuf::new_p2pkh(&PubkeyHash::from_slice(&[0;20]).unwrap()), Network::Testnet).unwrap();
2148 assert_eq!(invoice.fallback_addresses(), vec![address]);
2149 assert_eq!(invoice.private_routes(), vec![&PrivateRoute(route_1), &PrivateRoute(route_2)]);
2151 invoice.description(),
2152 Bolt11InvoiceDescription::Hash(&Sha256(sha256::Hash::from_slice(&[3;32][..]).unwrap()))
2154 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21;32][..]).unwrap());
2155 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));
2157 let mut expected_features = Bolt11InvoiceFeatures::empty();
2158 expected_features.set_variable_length_onion_required();
2159 expected_features.set_payment_secret_required();
2160 expected_features.set_basic_mpp_optional();
2161 assert_eq!(invoice.features(), Some(&expected_features));
2163 let raw_invoice = builder.build_raw().unwrap();
2164 assert_eq!(raw_invoice, *invoice.into_signed_raw().raw_invoice())
2168 fn test_default_values() {
2170 use secp256k1::Secp256k1;
2171 use secp256k1::SecretKey;
2173 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
2174 .description("Test".into())
2175 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2176 .payment_secret(PaymentSecret([0; 32]))
2177 .duration_since_epoch(Duration::from_secs(1234567))
2180 .sign::<_, ()>(|hash| {
2181 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
2182 let secp_ctx = Secp256k1::new();
2183 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
2186 let invoice = Bolt11Invoice::from_signed(signed_invoice).unwrap();
2188 assert_eq!(invoice.min_final_cltv_expiry_delta(), DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA);
2189 assert_eq!(invoice.expiry_time(), Duration::from_secs(DEFAULT_EXPIRY_TIME));
2190 assert!(!invoice.would_expire(Duration::from_secs(1234568)));
2194 fn test_expiration() {
2196 use secp256k1::Secp256k1;
2197 use secp256k1::SecretKey;
2199 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
2200 .description("Test".into())
2201 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2202 .payment_secret(PaymentSecret([0; 32]))
2203 .duration_since_epoch(Duration::from_secs(1234567))
2206 .sign::<_, ()>(|hash| {
2207 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
2208 let secp_ctx = Secp256k1::new();
2209 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
2212 let invoice = Bolt11Invoice::from_signed(signed_invoice).unwrap();
2214 assert!(invoice.would_expire(Duration::from_secs(1234567 + DEFAULT_EXPIRY_TIME + 1)));
2217 #[cfg(feature = "serde")]
2220 let invoice_str = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
2221 h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
2222 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
2223 h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
2224 j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
2225 ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
2226 guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
2227 ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
2228 p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
2229 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
2230 j5r6drg6k6zcqj0fcwg";
2231 let invoice = invoice_str.parse::<super::Bolt11Invoice>().unwrap();
2232 let serialized_invoice = serde_json::to_string(&invoice).unwrap();
2233 let deserialized_invoice: super::Bolt11Invoice = serde_json::from_str(serialized_invoice.as_str()).unwrap();
2234 assert_eq!(invoice, deserialized_invoice);
2235 assert_eq!(invoice_str, deserialized_invoice.to_string().as_str());
2236 assert_eq!(invoice_str, serialized_invoice.as_str().trim_matches('\"'));