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, WitnessProgram, WitnessVersion};
46 use bitcoin::address::Payload;
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 = match amount_msat.checked_mul(10) { // Invoices are denominated in "pico BTC"
583 self.error = Some(CreationError::InvalidAmount);
587 let biggest_possible_si_prefix = SiPrefix::values_desc()
589 .find(|prefix| amount % prefix.multiplier() == 0)
590 .expect("Pico should always match");
591 self.amount = Some(amount / biggest_possible_si_prefix.multiplier());
592 self.si_prefix = Some(*biggest_possible_si_prefix);
596 /// Sets the payee's public key.
597 pub fn payee_pub_key(mut self, pub_key: PublicKey) -> Self {
598 self.tagged_fields.push(TaggedField::PayeePubKey(PayeePubKey(pub_key)));
602 /// Sets the expiry time, dropping the subsecond part (which is not representable in BOLT 11
604 pub fn expiry_time(mut self, expiry_time: Duration) -> Self {
605 self.tagged_fields.push(TaggedField::ExpiryTime(ExpiryTime::from_duration(expiry_time)));
609 /// Adds a fallback address.
610 pub fn fallback(mut self, fallback: Fallback) -> Self {
611 self.tagged_fields.push(TaggedField::Fallback(fallback));
615 /// Adds a private route.
616 pub fn private_route(mut self, hint: RouteHint) -> Self {
617 match PrivateRoute::new(hint) {
618 Ok(r) => self.tagged_fields.push(TaggedField::PrivateRoute(r)),
619 Err(e) => self.error = Some(e),
625 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, tb::True, C, S, M> {
626 /// Builds a [`RawBolt11Invoice`] if no [`CreationError`] occurred while construction any of the
628 pub fn build_raw(self) -> Result<RawBolt11Invoice, CreationError> {
630 // If an error occurred at any time before, return it now
631 if let Some(e) = self.error {
636 currency: self.currency,
637 raw_amount: self.amount,
638 si_prefix: self.si_prefix,
641 let timestamp = self.timestamp.expect("ensured to be Some(t) by type T");
643 let tagged_fields = self.tagged_fields.into_iter().map(|tf| {
644 RawTaggedField::KnownSemantics(tf)
645 }).collect::<Vec<_>>();
647 let data = RawDataPart {
652 Ok(RawBolt11Invoice {
659 impl<H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<tb::False, H, T, C, S, M> {
660 /// Set the description. This function is only available if no description (hash) was set.
661 pub fn description(mut self, description: String) -> InvoiceBuilder<tb::True, H, T, C, S, M> {
662 match Description::new(description) {
663 Ok(d) => self.tagged_fields.push(TaggedField::Description(d)),
664 Err(e) => self.error = Some(e),
669 /// Set the description hash. This function is only available if no description (hash) was set.
670 pub fn description_hash(mut self, description_hash: sha256::Hash) -> InvoiceBuilder<tb::True, H, T, C, S, M> {
671 self.tagged_fields.push(TaggedField::DescriptionHash(Sha256(description_hash)));
675 /// Set the description or description hash. This function is only available if no description (hash) was set.
676 pub fn invoice_description(self, description: Bolt11InvoiceDescription) -> InvoiceBuilder<tb::True, H, T, C, S, M> {
678 Bolt11InvoiceDescription::Direct(desc) => {
679 self.description(desc.clone().into_inner().0)
681 Bolt11InvoiceDescription::Hash(hash) => {
682 self.description_hash(hash.0)
688 impl<D: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, tb::False, T, C, S, M> {
689 /// Set the payment hash. This function is only available if no payment hash was set.
690 pub fn payment_hash(mut self, hash: sha256::Hash) -> InvoiceBuilder<D, tb::True, T, C, S, M> {
691 self.tagged_fields.push(TaggedField::PaymentHash(Sha256(hash)));
696 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, tb::False, C, S, M> {
697 /// Sets the timestamp to a specific [`SystemTime`].
698 #[cfg(feature = "std")]
699 pub fn timestamp(mut self, time: SystemTime) -> InvoiceBuilder<D, H, tb::True, C, S, M> {
700 match PositiveTimestamp::from_system_time(time) {
701 Ok(t) => self.timestamp = Some(t),
702 Err(e) => self.error = Some(e),
708 /// Sets the timestamp to a duration since the Unix epoch, dropping the subsecond part (which
709 /// is not representable in BOLT 11 invoices).
710 pub fn duration_since_epoch(mut self, time: Duration) -> InvoiceBuilder<D, H, tb::True, C, S, M> {
711 match PositiveTimestamp::from_duration_since_epoch(time) {
712 Ok(t) => self.timestamp = Some(t),
713 Err(e) => self.error = Some(e),
719 /// Sets the timestamp to the current system time.
720 #[cfg(feature = "std")]
721 pub fn current_timestamp(mut self) -> InvoiceBuilder<D, H, tb::True, C, S, M> {
722 let now = PositiveTimestamp::from_system_time(SystemTime::now());
723 self.timestamp = Some(now.expect("for the foreseeable future this shouldn't happen"));
728 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, S: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, tb::False, S, M> {
729 /// Sets `min_final_cltv_expiry_delta`.
730 pub fn min_final_cltv_expiry_delta(mut self, min_final_cltv_expiry_delta: u64) -> InvoiceBuilder<D, H, T, tb::True, S, M> {
731 self.tagged_fields.push(TaggedField::MinFinalCltvExpiryDelta(MinFinalCltvExpiryDelta(min_final_cltv_expiry_delta)));
736 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, C, tb::False, M> {
737 /// Sets the payment secret and relevant features.
738 pub fn payment_secret(mut self, payment_secret: PaymentSecret) -> InvoiceBuilder<D, H, T, C, tb::True, M> {
739 let mut found_features = false;
740 for field in self.tagged_fields.iter_mut() {
741 if let TaggedField::Features(f) = field {
742 found_features = true;
743 f.set_variable_length_onion_required();
744 f.set_payment_secret_required();
747 self.tagged_fields.push(TaggedField::PaymentSecret(payment_secret));
749 let mut features = Bolt11InvoiceFeatures::empty();
750 features.set_variable_length_onion_required();
751 features.set_payment_secret_required();
752 self.tagged_fields.push(TaggedField::Features(features));
758 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, C, S, tb::False> {
759 /// Sets the payment metadata.
761 /// By default features are set to *optionally* allow the sender to include the payment metadata.
762 /// If you wish to require that the sender include the metadata (and fail to parse the invoice if
763 /// they don't support payment metadata fields), you need to call
764 /// [`InvoiceBuilder::require_payment_metadata`] after this.
765 pub fn payment_metadata(mut self, payment_metadata: Vec<u8>) -> InvoiceBuilder<D, H, T, C, S, tb::True> {
766 self.tagged_fields.push(TaggedField::PaymentMetadata(payment_metadata));
767 let mut found_features = false;
768 for field in self.tagged_fields.iter_mut() {
769 if let TaggedField::Features(f) = field {
770 found_features = true;
771 f.set_payment_metadata_optional();
775 let mut features = Bolt11InvoiceFeatures::empty();
776 features.set_payment_metadata_optional();
777 self.tagged_fields.push(TaggedField::Features(features));
783 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, C, S, tb::True> {
784 /// Sets forwarding of payment metadata as required. A reader of the invoice which does not
785 /// support sending payment metadata will fail to read the invoice.
786 pub fn require_payment_metadata(mut self) -> InvoiceBuilder<D, H, T, C, S, tb::True> {
787 for field in self.tagged_fields.iter_mut() {
788 if let TaggedField::Features(f) = field {
789 f.set_payment_metadata_required();
796 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, M: tb::Bool> InvoiceBuilder<D, H, T, C, tb::True, M> {
797 /// Sets the `basic_mpp` feature as optional.
798 pub fn basic_mpp(mut self) -> Self {
799 for field in self.tagged_fields.iter_mut() {
800 if let TaggedField::Features(f) = field {
801 f.set_basic_mpp_optional();
808 impl<M: tb::Bool> InvoiceBuilder<tb::True, tb::True, tb::True, tb::True, tb::True, M> {
809 /// Builds and signs an invoice using the supplied `sign_function`. This function MAY NOT fail
810 /// and MUST produce a recoverable signature valid for the given hash and if applicable also for
811 /// the included payee public key.
812 pub fn build_signed<F>(self, sign_function: F) -> Result<Bolt11Invoice, CreationError>
813 where F: FnOnce(&Message) -> RecoverableSignature
815 let invoice = self.try_build_signed::<_, ()>(|hash| {
816 Ok(sign_function(hash))
821 Err(SignOrCreationError::CreationError(e)) => Err(e),
822 Err(SignOrCreationError::SignError(())) => unreachable!(),
826 /// Builds and signs an invoice using the supplied `sign_function`. This function MAY fail with
827 /// an error of type `E` and MUST produce a recoverable signature valid for the given hash and
828 /// if applicable also for the included payee public key.
829 pub fn try_build_signed<F, E>(self, sign_function: F) -> Result<Bolt11Invoice, SignOrCreationError<E>>
830 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
832 let raw = match self.build_raw() {
834 Err(e) => return Err(SignOrCreationError::CreationError(e)),
837 let signed = match raw.sign(sign_function) {
839 Err(e) => return Err(SignOrCreationError::SignError(e)),
842 let invoice = Bolt11Invoice {
843 signed_invoice: signed,
846 invoice.check_field_counts().expect("should be ensured by type signature of builder");
847 invoice.check_feature_bits().expect("should be ensured by type signature of builder");
848 invoice.check_amount().expect("should be ensured by type signature of builder");
855 impl SignedRawBolt11Invoice {
856 /// Disassembles the `SignedRawBolt11Invoice` into its three parts:
858 /// 2. hash of the raw invoice
860 pub fn into_parts(self) -> (RawBolt11Invoice, [u8; 32], Bolt11InvoiceSignature) {
861 (self.raw_invoice, self.hash, self.signature)
864 /// The [`RawBolt11Invoice`] which was signed.
865 pub fn raw_invoice(&self) -> &RawBolt11Invoice {
869 /// The hash of the [`RawBolt11Invoice`] that was signed.
870 pub fn signable_hash(&self) -> &[u8; 32] {
874 /// Signature for the invoice.
875 pub fn signature(&self) -> &Bolt11InvoiceSignature {
879 /// Recovers the public key used for signing the invoice from the recoverable signature.
880 pub fn recover_payee_pub_key(&self) -> Result<PayeePubKey, secp256k1::Error> {
881 let hash = Message::from_digest(self.hash);
883 Ok(PayeePubKey(Secp256k1::new().recover_ecdsa(
889 /// Checks if the signature is valid for the included payee public key or if none exists if it's
890 /// valid for the recovered signature (which should always be true?).
891 pub fn check_signature(&self) -> bool {
892 let included_pub_key = self.raw_invoice.payee_pub_key();
894 let mut recovered_pub_key = Option::None;
895 if recovered_pub_key.is_none() {
896 let recovered = match self.recover_payee_pub_key() {
898 Err(_) => return false,
900 recovered_pub_key = Some(recovered);
903 let pub_key = included_pub_key.or(recovered_pub_key.as_ref())
904 .expect("One is always present");
906 let hash = Message::from_digest(self.hash);
908 let secp_context = Secp256k1::new();
909 let verification_result = secp_context.verify_ecdsa(
911 &self.signature.to_standard(),
915 match verification_result {
922 /// Finds the first element of an enum stream of a given variant and extracts one member of the
923 /// variant. If no element was found `None` gets returned.
925 /// The following example would extract the first B.
933 /// let elements = vec![Enum::A(1), Enum::A(2), Enum::B(3), Enum::A(4)];
935 /// assert_eq!(find_extract!(elements.iter(), Enum::B(x), x), Some(3u16));
937 macro_rules! find_extract {
938 ($iter:expr, $enm:pat, $enm_var:ident) => {
939 find_all_extract!($iter, $enm, $enm_var).next()
943 /// Finds the all elements of an enum stream of a given variant and extracts one member of the
944 /// variant through an iterator.
946 /// The following example would extract all A.
954 /// let elements = vec![Enum::A(1), Enum::A(2), Enum::B(3), Enum::A(4)];
957 /// find_all_extract!(elements.iter(), Enum::A(x), x).collect::<Vec<u8>>(),
958 /// vec![1u8, 2u8, 4u8]
961 macro_rules! find_all_extract {
962 ($iter:expr, $enm:pat, $enm_var:ident) => {
963 $iter.filter_map(|tf| match *tf {
964 $enm => Some($enm_var),
970 #[allow(missing_docs)]
971 impl RawBolt11Invoice {
972 /// Hash the HRP as bytes and signatureless data part.
973 fn hash_from_parts(hrp_bytes: &[u8], data_without_signature: &[u5]) -> [u8; 32] {
974 let preimage = construct_invoice_preimage(hrp_bytes, data_without_signature);
975 let mut hash: [u8; 32] = Default::default();
976 hash.copy_from_slice(&sha256::Hash::hash(&preimage)[..]);
980 /// Calculate the hash of the encoded `RawBolt11Invoice` which should be signed.
981 pub fn signable_hash(&self) -> [u8; 32] {
982 use bech32::ToBase32;
984 RawBolt11Invoice::hash_from_parts(
985 self.hrp.to_string().as_bytes(),
986 &self.data.to_base32()
990 /// Signs the invoice using the supplied `sign_method`. This function MAY fail with an error of
991 /// type `E`. Since the signature of a [`SignedRawBolt11Invoice`] is not required to be valid there
992 /// are no constraints regarding the validity of the produced signature.
994 /// This is not exported to bindings users as we don't currently support passing function pointers into methods
996 pub fn sign<F, E>(self, sign_method: F) -> Result<SignedRawBolt11Invoice, E>
997 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
999 let raw_hash = self.signable_hash();
1000 let hash = Message::from_digest(raw_hash);
1001 let signature = sign_method(&hash)?;
1003 Ok(SignedRawBolt11Invoice {
1006 signature: Bolt11InvoiceSignature(signature),
1010 /// Returns an iterator over all tagged fields with known semantics.
1012 /// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
1013 pub fn known_tagged_fields(&self)
1014 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>>
1016 // For 1.14.0 compatibility: closures' types can't be written an fn()->() in the
1017 // function's type signature.
1018 // TODO: refactor once impl Trait is available
1019 fn match_raw(raw: &RawTaggedField) -> Option<&TaggedField> {
1021 RawTaggedField::KnownSemantics(ref tf) => Some(tf),
1026 self.data.tagged_fields.iter().filter_map(match_raw )
1029 pub fn payment_hash(&self) -> Option<&Sha256> {
1030 find_extract!(self.known_tagged_fields(), TaggedField::PaymentHash(ref x), x)
1033 pub fn description(&self) -> Option<&Description> {
1034 find_extract!(self.known_tagged_fields(), TaggedField::Description(ref x), x)
1037 pub fn payee_pub_key(&self) -> Option<&PayeePubKey> {
1038 find_extract!(self.known_tagged_fields(), TaggedField::PayeePubKey(ref x), x)
1041 pub fn description_hash(&self) -> Option<&Sha256> {
1042 find_extract!(self.known_tagged_fields(), TaggedField::DescriptionHash(ref x), x)
1045 pub fn expiry_time(&self) -> Option<&ExpiryTime> {
1046 find_extract!(self.known_tagged_fields(), TaggedField::ExpiryTime(ref x), x)
1049 pub fn min_final_cltv_expiry_delta(&self) -> Option<&MinFinalCltvExpiryDelta> {
1050 find_extract!(self.known_tagged_fields(), TaggedField::MinFinalCltvExpiryDelta(ref x), x)
1053 pub fn payment_secret(&self) -> Option<&PaymentSecret> {
1054 find_extract!(self.known_tagged_fields(), TaggedField::PaymentSecret(ref x), x)
1057 pub fn payment_metadata(&self) -> Option<&Vec<u8>> {
1058 find_extract!(self.known_tagged_fields(), TaggedField::PaymentMetadata(ref x), x)
1061 pub fn features(&self) -> Option<&Bolt11InvoiceFeatures> {
1062 find_extract!(self.known_tagged_fields(), TaggedField::Features(ref x), x)
1065 /// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
1066 pub fn fallbacks(&self) -> Vec<&Fallback> {
1067 find_all_extract!(self.known_tagged_fields(), TaggedField::Fallback(ref x), x).collect()
1070 pub fn private_routes(&self) -> Vec<&PrivateRoute> {
1071 find_all_extract!(self.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x).collect()
1074 /// Returns `None` if no amount is set or on overflow.
1075 pub fn amount_pico_btc(&self) -> Option<u64> {
1076 self.hrp.raw_amount.and_then(|v| {
1077 v.checked_mul(self.hrp.si_prefix.as_ref().map_or(1_000_000_000_000, |si| { si.multiplier() }))
1081 pub fn currency(&self) -> Currency {
1082 self.hrp.currency.clone()
1086 impl PositiveTimestamp {
1087 /// Creates a `PositiveTimestamp` from a Unix timestamp in the range `0..=MAX_TIMESTAMP`.
1089 /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
1090 pub fn from_unix_timestamp(unix_seconds: u64) -> Result<Self, CreationError> {
1091 if unix_seconds <= MAX_TIMESTAMP {
1092 Ok(Self(Duration::from_secs(unix_seconds)))
1094 Err(CreationError::TimestampOutOfBounds)
1098 /// Creates a `PositiveTimestamp` from a [`SystemTime`] with a corresponding Unix timestamp in
1099 /// the range `0..=MAX_TIMESTAMP`.
1101 /// Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.
1103 /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
1104 #[cfg(feature = "std")]
1105 pub fn from_system_time(time: SystemTime) -> Result<Self, CreationError> {
1106 time.duration_since(SystemTime::UNIX_EPOCH)
1107 .map(Self::from_duration_since_epoch)
1108 .unwrap_or(Err(CreationError::TimestampOutOfBounds))
1111 /// Creates a `PositiveTimestamp` from a [`Duration`] since the Unix epoch in the range
1112 /// `0..=MAX_TIMESTAMP`.
1114 /// Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.
1116 /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
1117 pub fn from_duration_since_epoch(duration: Duration) -> Result<Self, CreationError> {
1118 Self::from_unix_timestamp(duration.as_secs())
1121 /// Returns the Unix timestamp representing the stored time
1122 pub fn as_unix_timestamp(&self) -> u64 {
1126 /// Returns the duration of the stored time since the Unix epoch
1127 pub fn as_duration_since_epoch(&self) -> Duration {
1131 /// Returns the [`SystemTime`] representing the stored time
1132 #[cfg(feature = "std")]
1133 pub fn as_time(&self) -> SystemTime {
1134 SystemTime::UNIX_EPOCH + self.0
1138 impl From<PositiveTimestamp> for Duration {
1139 fn from(val: PositiveTimestamp) -> Self {
1144 #[cfg(feature = "std")]
1145 impl From<PositiveTimestamp> for SystemTime {
1146 fn from(val: PositiveTimestamp) -> Self {
1147 SystemTime::UNIX_EPOCH + val.0
1151 impl Bolt11Invoice {
1152 /// The hash of the [`RawBolt11Invoice`] that was signed.
1153 pub fn signable_hash(&self) -> [u8; 32] {
1154 self.signed_invoice.hash
1157 /// Transform the `Bolt11Invoice` into its unchecked version.
1158 pub fn into_signed_raw(self) -> SignedRawBolt11Invoice {
1162 /// Check that all mandatory fields are present
1163 fn check_field_counts(&self) -> Result<(), Bolt11SemanticError> {
1164 // "A writer MUST include exactly one p field […]."
1165 let payment_hash_cnt = self.tagged_fields().filter(|&tf| match *tf {
1166 TaggedField::PaymentHash(_) => true,
1169 if payment_hash_cnt < 1 {
1170 return Err(Bolt11SemanticError::NoPaymentHash);
1171 } else if payment_hash_cnt > 1 {
1172 return Err(Bolt11SemanticError::MultiplePaymentHashes);
1175 // "A writer MUST include either exactly one d or exactly one h field."
1176 let description_cnt = self.tagged_fields().filter(|&tf| match *tf {
1177 TaggedField::Description(_) | TaggedField::DescriptionHash(_) => true,
1180 if description_cnt < 1 {
1181 return Err(Bolt11SemanticError::NoDescription);
1182 } else if description_cnt > 1 {
1183 return Err(Bolt11SemanticError::MultipleDescriptions);
1186 self.check_payment_secret()?;
1191 /// Checks that there is exactly one payment secret field
1192 fn check_payment_secret(&self) -> Result<(), Bolt11SemanticError> {
1193 // "A writer MUST include exactly one `s` field."
1194 let payment_secret_count = self.tagged_fields().filter(|&tf| match *tf {
1195 TaggedField::PaymentSecret(_) => true,
1198 if payment_secret_count < 1 {
1199 return Err(Bolt11SemanticError::NoPaymentSecret);
1200 } else if payment_secret_count > 1 {
1201 return Err(Bolt11SemanticError::MultiplePaymentSecrets);
1207 /// Check that amount is a whole number of millisatoshis
1208 fn check_amount(&self) -> Result<(), Bolt11SemanticError> {
1209 if let Some(amount_pico_btc) = self.amount_pico_btc() {
1210 if amount_pico_btc % 10 != 0 {
1211 return Err(Bolt11SemanticError::ImpreciseAmount);
1217 /// Check that feature bits are set as required
1218 fn check_feature_bits(&self) -> Result<(), Bolt11SemanticError> {
1219 self.check_payment_secret()?;
1221 // "A writer MUST set an s field if and only if the payment_secret feature is set."
1222 // (this requirement has been since removed, and we now require the payment secret
1223 // feature bit always).
1224 let features = self.tagged_fields().find(|&tf| match *tf {
1225 TaggedField::Features(_) => true,
1229 None => Err(Bolt11SemanticError::InvalidFeatures),
1230 Some(TaggedField::Features(features)) => {
1231 if features.requires_unknown_bits() {
1232 Err(Bolt11SemanticError::InvalidFeatures)
1233 } else if !features.supports_payment_secret() {
1234 Err(Bolt11SemanticError::InvalidFeatures)
1239 Some(_) => unreachable!(),
1243 /// Check that the invoice is signed correctly and that key recovery works
1244 pub fn check_signature(&self) -> Result<(), Bolt11SemanticError> {
1245 match self.signed_invoice.recover_payee_pub_key() {
1246 Err(secp256k1::Error::InvalidRecoveryId) =>
1247 return Err(Bolt11SemanticError::InvalidRecoveryId),
1248 Err(secp256k1::Error::InvalidSignature) =>
1249 return Err(Bolt11SemanticError::InvalidSignature),
1250 Err(e) => panic!("no other error may occur, got {:?}", e),
1254 if !self.signed_invoice.check_signature() {
1255 return Err(Bolt11SemanticError::InvalidSignature);
1261 /// Constructs a `Bolt11Invoice` from a [`SignedRawBolt11Invoice`] by checking all its invariants.
1263 /// use lightning_invoice::*;
1265 /// let invoice = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
1266 /// h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
1267 /// 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
1268 /// h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
1269 /// j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
1270 /// ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
1271 /// guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
1272 /// ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
1273 /// p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
1274 /// 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
1275 /// j5r6drg6k6zcqj0fcwg";
1277 /// let signed = invoice.parse::<SignedRawBolt11Invoice>().unwrap();
1279 /// assert!(Bolt11Invoice::from_signed(signed).is_ok());
1281 pub fn from_signed(signed_invoice: SignedRawBolt11Invoice) -> Result<Self, Bolt11SemanticError> {
1282 let invoice = Bolt11Invoice {
1285 invoice.check_field_counts()?;
1286 invoice.check_feature_bits()?;
1287 invoice.check_signature()?;
1288 invoice.check_amount()?;
1293 /// Returns the `Bolt11Invoice`'s timestamp (should equal its creation time)
1294 #[cfg(feature = "std")]
1295 pub fn timestamp(&self) -> SystemTime {
1296 self.signed_invoice.raw_invoice().data.timestamp.as_time()
1299 /// Returns the `Bolt11Invoice`'s timestamp as a duration since the Unix epoch
1300 pub fn duration_since_epoch(&self) -> Duration {
1301 self.signed_invoice.raw_invoice().data.timestamp.0
1304 /// Returns an iterator over all tagged fields of this `Bolt11Invoice`.
1306 /// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
1307 pub fn tagged_fields(&self)
1308 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>> {
1309 self.signed_invoice.raw_invoice().known_tagged_fields()
1312 /// Returns the hash to which we will receive the preimage on completion of the payment
1313 pub fn payment_hash(&self) -> &sha256::Hash {
1314 &self.signed_invoice.payment_hash().expect("checked by constructor").0
1317 /// Return the description or a hash of it for longer ones
1319 /// This is not exported to bindings users because we don't yet export Bolt11InvoiceDescription
1320 pub fn description(&self) -> Bolt11InvoiceDescription {
1321 if let Some(direct) = self.signed_invoice.description() {
1322 return Bolt11InvoiceDescription::Direct(direct);
1323 } else if let Some(hash) = self.signed_invoice.description_hash() {
1324 return Bolt11InvoiceDescription::Hash(hash);
1326 unreachable!("ensured by constructor");
1329 /// Get the payee's public key if one was included in the invoice
1330 pub fn payee_pub_key(&self) -> Option<&PublicKey> {
1331 self.signed_invoice.payee_pub_key().map(|x| &x.0)
1334 /// Get the payment secret if one was included in the invoice
1335 pub fn payment_secret(&self) -> &PaymentSecret {
1336 self.signed_invoice.payment_secret().expect("was checked by constructor")
1339 /// Get the payment metadata blob if one was included in the invoice
1340 pub fn payment_metadata(&self) -> Option<&Vec<u8>> {
1341 self.signed_invoice.payment_metadata()
1344 /// Get the invoice features if they were included in the invoice
1345 pub fn features(&self) -> Option<&Bolt11InvoiceFeatures> {
1346 self.signed_invoice.features()
1349 /// Recover the payee's public key (only to be used if none was included in the invoice)
1350 pub fn recover_payee_pub_key(&self) -> PublicKey {
1351 self.signed_invoice.recover_payee_pub_key().expect("was checked by constructor").0
1354 /// Recover the payee's public key if one was included in the invoice, otherwise return the
1355 /// recovered public key from the signature
1356 pub fn get_payee_pub_key(&self) -> PublicKey {
1357 match self.payee_pub_key() {
1359 None => self.recover_payee_pub_key()
1363 /// Returns the Duration since the Unix epoch at which the invoice expires.
1364 /// Returning None if overflow occurred.
1365 pub fn expires_at(&self) -> Option<Duration> {
1366 self.duration_since_epoch().checked_add(self.expiry_time())
1369 /// Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
1370 pub fn expiry_time(&self) -> Duration {
1371 self.signed_invoice.expiry_time()
1373 .unwrap_or(Duration::from_secs(DEFAULT_EXPIRY_TIME))
1376 /// Returns whether the invoice has expired.
1377 #[cfg(feature = "std")]
1378 pub fn is_expired(&self) -> bool {
1379 Self::is_expired_from_epoch(&self.timestamp(), self.expiry_time())
1382 /// Returns whether the expiry time from the given epoch has passed.
1383 #[cfg(feature = "std")]
1384 pub(crate) fn is_expired_from_epoch(epoch: &SystemTime, expiry_time: Duration) -> bool {
1385 match epoch.elapsed() {
1386 Ok(elapsed) => elapsed > expiry_time,
1391 /// Returns the Duration remaining until the invoice expires.
1392 #[cfg(feature = "std")]
1393 pub fn duration_until_expiry(&self) -> Duration {
1394 SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)
1395 .map(|now| self.expiration_remaining_from_epoch(now))
1396 .unwrap_or(Duration::from_nanos(0))
1399 /// Returns the Duration remaining until the invoice expires given the current time.
1400 /// `time` is the timestamp as a duration since the Unix epoch.
1401 pub fn expiration_remaining_from_epoch(&self, time: Duration) -> Duration {
1402 self.expires_at().map(|x| x.checked_sub(time)).flatten().unwrap_or(Duration::from_nanos(0))
1405 /// Returns whether the expiry time would pass at the given point in time.
1406 /// `at_time` is the timestamp as a duration since the Unix epoch.
1407 pub fn would_expire(&self, at_time: Duration) -> bool {
1408 self.duration_since_epoch()
1409 .checked_add(self.expiry_time())
1410 .unwrap_or_else(|| Duration::new(u64::max_value(), 1_000_000_000 - 1)) < at_time
1413 /// Returns the invoice's `min_final_cltv_expiry_delta` time, if present, otherwise
1414 /// [`DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA`].
1415 pub fn min_final_cltv_expiry_delta(&self) -> u64 {
1416 self.signed_invoice.min_final_cltv_expiry_delta()
1418 .unwrap_or(DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA)
1421 /// Returns a list of all fallback addresses
1423 /// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
1424 pub fn fallbacks(&self) -> Vec<&Fallback> {
1425 self.signed_invoice.fallbacks()
1428 /// Returns a list of all fallback addresses as [`Address`]es
1429 pub fn fallback_addresses(&self) -> Vec<Address> {
1430 self.fallbacks().iter().filter_map(|fallback| {
1431 let payload = match fallback {
1432 Fallback::SegWitProgram { version, program } => {
1433 match WitnessProgram::new(*version, program.clone()) {
1434 Ok(witness_program) => Payload::WitnessProgram(witness_program),
1435 Err(_) => return None,
1438 Fallback::PubKeyHash(pkh) => {
1439 Payload::PubkeyHash(*pkh)
1441 Fallback::ScriptHash(sh) => {
1442 Payload::ScriptHash(*sh)
1446 Some(Address::new(self.network(), payload))
1450 /// Returns a list of all routes included in the invoice
1451 pub fn private_routes(&self) -> Vec<&PrivateRoute> {
1452 self.signed_invoice.private_routes()
1455 /// Returns a list of all routes included in the invoice as the underlying hints
1456 pub fn route_hints(&self) -> Vec<RouteHint> {
1458 self.signed_invoice.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x
1459 ).map(|route| (**route).clone()).collect()
1462 /// Returns the currency for which the invoice was issued
1463 pub fn currency(&self) -> Currency {
1464 self.signed_invoice.currency()
1467 /// Returns the network for which the invoice was issued
1469 /// This is not exported to bindings users, see [`Self::currency`] instead.
1470 pub fn network(&self) -> Network {
1471 self.signed_invoice.currency().into()
1474 /// Returns the amount if specified in the invoice as millisatoshis.
1475 pub fn amount_milli_satoshis(&self) -> Option<u64> {
1476 self.signed_invoice.amount_pico_btc().map(|v| v / 10)
1479 /// Returns the amount if specified in the invoice as pico BTC.
1480 fn amount_pico_btc(&self) -> Option<u64> {
1481 self.signed_invoice.amount_pico_btc()
1485 impl From<TaggedField> for RawTaggedField {
1486 fn from(tf: TaggedField) -> Self {
1487 RawTaggedField::KnownSemantics(tf)
1492 /// Numeric representation of the field's tag
1493 pub fn tag(&self) -> u5 {
1494 let tag = match *self {
1495 TaggedField::PaymentHash(_) => constants::TAG_PAYMENT_HASH,
1496 TaggedField::Description(_) => constants::TAG_DESCRIPTION,
1497 TaggedField::PayeePubKey(_) => constants::TAG_PAYEE_PUB_KEY,
1498 TaggedField::DescriptionHash(_) => constants::TAG_DESCRIPTION_HASH,
1499 TaggedField::ExpiryTime(_) => constants::TAG_EXPIRY_TIME,
1500 TaggedField::MinFinalCltvExpiryDelta(_) => constants::TAG_MIN_FINAL_CLTV_EXPIRY_DELTA,
1501 TaggedField::Fallback(_) => constants::TAG_FALLBACK,
1502 TaggedField::PrivateRoute(_) => constants::TAG_PRIVATE_ROUTE,
1503 TaggedField::PaymentSecret(_) => constants::TAG_PAYMENT_SECRET,
1504 TaggedField::PaymentMetadata(_) => constants::TAG_PAYMENT_METADATA,
1505 TaggedField::Features(_) => constants::TAG_FEATURES,
1508 u5::try_from_u8(tag).expect("all tags defined are <32")
1514 /// Creates a new `Description` if `description` is at most 1023 __bytes__ long,
1515 /// returns [`CreationError::DescriptionTooLong`] otherwise
1517 /// Please note that single characters may use more than one byte due to UTF8 encoding.
1518 pub fn new(description: String) -> Result<Description, CreationError> {
1519 if description.len() > 639 {
1520 Err(CreationError::DescriptionTooLong)
1522 Ok(Description(UntrustedString(description)))
1526 /// Returns the underlying description [`UntrustedString`]
1527 pub fn into_inner(self) -> UntrustedString {
1532 impl Display for Description {
1533 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1534 write!(f, "{}", self.0)
1538 impl From<PublicKey> for PayeePubKey {
1539 fn from(pk: PublicKey) -> Self {
1544 impl Deref for PayeePubKey {
1545 type Target = PublicKey;
1547 fn deref(&self) -> &PublicKey {
1553 /// Construct an `ExpiryTime` from seconds.
1554 pub fn from_seconds(seconds: u64) -> ExpiryTime {
1555 ExpiryTime(Duration::from_secs(seconds))
1558 /// Construct an `ExpiryTime` from a [`Duration`], dropping the sub-second part.
1559 pub fn from_duration(duration: Duration) -> ExpiryTime {
1560 Self::from_seconds(duration.as_secs())
1563 /// Returns the expiry time in seconds
1564 pub fn as_seconds(&self) -> u64 {
1568 /// Returns a reference to the underlying [`Duration`] (=expiry time)
1569 pub fn as_duration(&self) -> &Duration {
1575 /// Creates a new (partial) route from a list of hops
1576 pub fn new(hops: RouteHint) -> Result<PrivateRoute, CreationError> {
1577 if hops.0.len() <= 12 {
1578 Ok(PrivateRoute(hops))
1580 Err(CreationError::RouteTooLong)
1584 /// Returns the underlying list of hops
1585 pub fn into_inner(self) -> RouteHint {
1590 impl From<PrivateRoute> for RouteHint {
1591 fn from(val: PrivateRoute) -> Self {
1596 impl Deref for PrivateRoute {
1597 type Target = RouteHint;
1599 fn deref(&self) -> &RouteHint {
1604 impl Deref for Bolt11InvoiceSignature {
1605 type Target = RecoverableSignature;
1607 fn deref(&self) -> &RecoverableSignature {
1612 impl Deref for SignedRawBolt11Invoice {
1613 type Target = RawBolt11Invoice;
1615 fn deref(&self) -> &RawBolt11Invoice {
1620 /// Errors that may occur when constructing a new [`RawBolt11Invoice`] or [`Bolt11Invoice`]
1621 #[derive(Eq, PartialEq, Debug, Clone)]
1622 pub enum CreationError {
1623 /// The supplied description string was longer than 639 __bytes__ (see [`Description::new`])
1626 /// The specified route has too many hops and can't be encoded
1629 /// The Unix timestamp of the supplied date is less than zero or greater than 35-bits
1630 TimestampOutOfBounds,
1632 /// The supplied millisatoshi amount was greater than the total bitcoin supply.
1635 /// Route hints were required for this invoice and were missing. Applies to
1636 /// [phantom invoices].
1638 /// [phantom invoices]: crate::utils::create_phantom_invoice
1641 /// The provided `min_final_cltv_expiry_delta` was less than [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
1643 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
1644 MinFinalCltvExpiryDeltaTooShort,
1647 impl Display for CreationError {
1648 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1650 CreationError::DescriptionTooLong => f.write_str("The supplied description string was longer than 639 bytes"),
1651 CreationError::RouteTooLong => f.write_str("The specified route has too many hops and can't be encoded"),
1652 CreationError::TimestampOutOfBounds => f.write_str("The Unix timestamp of the supplied date is less than zero or greater than 35-bits"),
1653 CreationError::InvalidAmount => f.write_str("The supplied millisatoshi amount was greater than the total bitcoin supply"),
1654 CreationError::MissingRouteHints => f.write_str("The invoice required route hints and they weren't provided"),
1655 CreationError::MinFinalCltvExpiryDeltaTooShort => f.write_str(
1656 "The supplied final CLTV expiry delta was less than LDK's `MIN_FINAL_CLTV_EXPIRY_DELTA`"),
1661 #[cfg(feature = "std")]
1662 impl std::error::Error for CreationError { }
1664 /// Errors that may occur when converting a [`RawBolt11Invoice`] to a [`Bolt11Invoice`]. They relate to
1665 /// the requirements sections in BOLT #11
1666 #[derive(Eq, PartialEq, Debug, Clone)]
1667 pub enum Bolt11SemanticError {
1668 /// The invoice is missing the mandatory payment hash
1671 /// The invoice has multiple payment hashes which isn't allowed
1672 MultiplePaymentHashes,
1674 /// No description or description hash are part of the invoice
1677 /// The invoice contains multiple descriptions and/or description hashes which isn't allowed
1678 MultipleDescriptions,
1680 /// The invoice is missing the mandatory payment secret, which all modern lightning nodes
1684 /// The invoice contains multiple payment secrets
1685 MultiplePaymentSecrets,
1687 /// The invoice's features are invalid
1690 /// The recovery id doesn't fit the signature/pub key
1693 /// The invoice's signature is invalid
1696 /// The invoice's amount was not a whole number of millisatoshis
1700 impl Display for Bolt11SemanticError {
1701 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1703 Bolt11SemanticError::NoPaymentHash => f.write_str("The invoice is missing the mandatory payment hash"),
1704 Bolt11SemanticError::MultiplePaymentHashes => f.write_str("The invoice has multiple payment hashes which isn't allowed"),
1705 Bolt11SemanticError::NoDescription => f.write_str("No description or description hash are part of the invoice"),
1706 Bolt11SemanticError::MultipleDescriptions => f.write_str("The invoice contains multiple descriptions and/or description hashes which isn't allowed"),
1707 Bolt11SemanticError::NoPaymentSecret => f.write_str("The invoice is missing the mandatory payment secret"),
1708 Bolt11SemanticError::MultiplePaymentSecrets => f.write_str("The invoice contains multiple payment secrets"),
1709 Bolt11SemanticError::InvalidFeatures => f.write_str("The invoice's features are invalid"),
1710 Bolt11SemanticError::InvalidRecoveryId => f.write_str("The recovery id doesn't fit the signature/pub key"),
1711 Bolt11SemanticError::InvalidSignature => f.write_str("The invoice's signature is invalid"),
1712 Bolt11SemanticError::ImpreciseAmount => f.write_str("The invoice's amount was not a whole number of millisatoshis"),
1717 #[cfg(feature = "std")]
1718 impl std::error::Error for Bolt11SemanticError { }
1720 /// When signing using a fallible method either an user-supplied `SignError` or a [`CreationError`]
1722 #[derive(Eq, PartialEq, Debug, Clone)]
1723 pub enum SignOrCreationError<S = ()> {
1724 /// An error occurred during signing
1727 /// An error occurred while building the transaction
1728 CreationError(CreationError),
1731 impl<S> Display for SignOrCreationError<S> {
1732 fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1734 SignOrCreationError::SignError(_) => f.write_str("An error occurred during signing"),
1735 SignOrCreationError::CreationError(err) => err.fmt(f),
1740 #[cfg(feature = "serde")]
1741 impl Serialize for Bolt11Invoice {
1742 fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer {
1743 serializer.serialize_str(self.to_string().as_str())
1746 #[cfg(feature = "serde")]
1747 impl<'de> Deserialize<'de> for Bolt11Invoice {
1748 fn deserialize<D>(deserializer: D) -> Result<Bolt11Invoice, D::Error> where D: Deserializer<'de> {
1749 let bolt11 = String::deserialize(deserializer)?
1750 .parse::<Bolt11Invoice>()
1751 .map_err(|e| D::Error::custom(format_args!("{:?}", e)))?;
1759 use bitcoin::ScriptBuf;
1760 use bitcoin::hashes::sha256;
1761 use std::str::FromStr;
1764 fn test_system_time_bounds_assumptions() {
1766 crate::PositiveTimestamp::from_unix_timestamp(crate::MAX_TIMESTAMP + 1),
1767 Err(crate::CreationError::TimestampOutOfBounds)
1772 fn test_calc_invoice_hash() {
1773 use crate::{RawBolt11Invoice, RawHrp, RawDataPart, Currency, PositiveTimestamp};
1774 use crate::TaggedField::*;
1776 let invoice = RawBolt11Invoice {
1778 currency: Currency::Bitcoin,
1783 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1784 tagged_fields: vec![
1785 PaymentHash(crate::Sha256(sha256::Hash::from_str(
1786 "0001020304050607080900010203040506070809000102030405060708090102"
1787 ).unwrap())).into(),
1788 Description(crate::Description::new(
1789 "Please consider supporting this project".to_owned()
1795 let expected_hash = [
1796 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27, 0x7b, 0x1d,
1797 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7, 0x83, 0x5d, 0xb2, 0xec,
1798 0xd5, 0x18, 0xe1, 0xc9
1801 assert_eq!(invoice.signable_hash(), expected_hash)
1805 fn test_check_signature() {
1806 use crate::TaggedField::*;
1807 use secp256k1::Secp256k1;
1808 use secp256k1::ecdsa::{RecoveryId, RecoverableSignature};
1809 use secp256k1::{SecretKey, PublicKey};
1810 use crate::{SignedRawBolt11Invoice, Bolt11InvoiceSignature, RawBolt11Invoice, RawHrp, RawDataPart, Currency, Sha256,
1813 let invoice = SignedRawBolt11Invoice {
1814 raw_invoice: RawBolt11Invoice {
1816 currency: Currency::Bitcoin,
1821 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1822 tagged_fields: vec ! [
1823 PaymentHash(Sha256(sha256::Hash::from_str(
1824 "0001020304050607080900010203040506070809000102030405060708090102"
1825 ).unwrap())).into(),
1827 crate::Description::new(
1828 "Please consider supporting this project".to_owned()
1835 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27,
1836 0x7b, 0x1d, 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7,
1837 0x83, 0x5d, 0xb2, 0xec, 0xd5, 0x18, 0xe1, 0xc9
1839 signature: Bolt11InvoiceSignature(RecoverableSignature::from_compact(
1841 0x38u8, 0xec, 0x68, 0x91, 0x34, 0x5e, 0x20, 0x41, 0x45, 0xbe, 0x8a,
1842 0x3a, 0x99, 0xde, 0x38, 0xe9, 0x8a, 0x39, 0xd6, 0xa5, 0x69, 0x43,
1843 0x4e, 0x18, 0x45, 0xc8, 0xaf, 0x72, 0x05, 0xaf, 0xcf, 0xcc, 0x7f,
1844 0x42, 0x5f, 0xcd, 0x14, 0x63, 0xe9, 0x3c, 0x32, 0x88, 0x1e, 0xad,
1845 0x0d, 0x6e, 0x35, 0x6d, 0x46, 0x7e, 0xc8, 0xc0, 0x25, 0x53, 0xf9,
1846 0xaa, 0xb1, 0x5e, 0x57, 0x38, 0xb1, 0x1f, 0x12, 0x7f
1848 RecoveryId::from_i32(0).unwrap()
1852 assert!(invoice.check_signature());
1854 let private_key = SecretKey::from_slice(
1856 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1857 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1858 0x3b, 0x2d, 0xb7, 0x34
1861 let public_key = PublicKey::from_secret_key(&Secp256k1::new(), &private_key);
1863 assert_eq!(invoice.recover_payee_pub_key(), Ok(crate::PayeePubKey(public_key)));
1865 let (raw_invoice, _, _) = invoice.into_parts();
1866 let new_signed = raw_invoice.sign::<_, ()>(|hash| {
1867 Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key))
1870 assert!(new_signed.check_signature());
1874 fn test_check_feature_bits() {
1875 use crate::TaggedField::*;
1876 use lightning::ln::features::Bolt11InvoiceFeatures;
1877 use secp256k1::Secp256k1;
1878 use secp256k1::SecretKey;
1879 use crate::{Bolt11Invoice, RawBolt11Invoice, RawHrp, RawDataPart, Currency, Sha256, PositiveTimestamp,
1880 Bolt11SemanticError};
1882 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
1883 let payment_secret = lightning::ln::types::PaymentSecret([21; 32]);
1884 let invoice_template = RawBolt11Invoice {
1886 currency: Currency::Bitcoin,
1891 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1892 tagged_fields: vec ! [
1893 PaymentHash(Sha256(sha256::Hash::from_str(
1894 "0001020304050607080900010203040506070809000102030405060708090102"
1895 ).unwrap())).into(),
1897 crate::Description::new(
1898 "Please consider supporting this project".to_owned()
1907 let mut invoice = invoice_template.clone();
1908 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1909 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1911 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::InvalidFeatures));
1913 // Missing feature bits
1915 let mut invoice = invoice_template.clone();
1916 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1917 invoice.data.tagged_fields.push(Features(Bolt11InvoiceFeatures::empty()).into());
1918 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1920 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::InvalidFeatures));
1922 let mut payment_secret_features = Bolt11InvoiceFeatures::empty();
1923 payment_secret_features.set_payment_secret_required();
1925 // Including payment secret and feature bits
1927 let mut invoice = invoice_template.clone();
1928 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1929 invoice.data.tagged_fields.push(Features(payment_secret_features.clone()).into());
1930 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1932 assert!(Bolt11Invoice::from_signed(invoice).is_ok());
1934 // No payment secret or features
1936 let invoice = invoice_template.clone();
1937 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1939 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::NoPaymentSecret));
1941 // No payment secret or feature bits
1943 let mut invoice = invoice_template.clone();
1944 invoice.data.tagged_fields.push(Features(Bolt11InvoiceFeatures::empty()).into());
1945 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1947 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::NoPaymentSecret));
1949 // Missing payment secret
1951 let mut invoice = invoice_template.clone();
1952 invoice.data.tagged_fields.push(Features(payment_secret_features).into());
1953 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1955 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::NoPaymentSecret));
1957 // Multiple payment secrets
1959 let mut invoice = invoice_template;
1960 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1961 invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1962 invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1964 assert_eq!(Bolt11Invoice::from_signed(invoice), Err(Bolt11SemanticError::MultiplePaymentSecrets));
1968 fn test_builder_amount() {
1971 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1972 .description("Test".into())
1973 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1974 .duration_since_epoch(Duration::from_secs(1234567));
1976 let invoice = builder.clone()
1977 .amount_milli_satoshis(1500)
1981 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Nano));
1982 assert_eq!(invoice.hrp.raw_amount, Some(15));
1985 let invoice = builder
1986 .amount_milli_satoshis(150)
1990 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Pico));
1991 assert_eq!(invoice.hrp.raw_amount, Some(1500));
1995 fn test_builder_fail() {
1997 use lightning::routing::router::RouteHintHop;
1998 use std::iter::FromIterator;
1999 use secp256k1::PublicKey;
2001 let builder = InvoiceBuilder::new(Currency::Bitcoin)
2002 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2003 .duration_since_epoch(Duration::from_secs(1234567))
2004 .min_final_cltv_expiry_delta(144);
2006 let too_long_string = String::from_iter(
2007 (0..1024).map(|_| '?')
2010 let long_desc_res = builder.clone()
2011 .description(too_long_string)
2013 assert_eq!(long_desc_res, Err(CreationError::DescriptionTooLong));
2015 let route_hop = RouteHintHop {
2016 src_node_id: PublicKey::from_slice(
2018 0x03, 0x9e, 0x03, 0xa9, 0x01, 0xb8, 0x55, 0x34, 0xff, 0x1e, 0x92, 0xc4,
2019 0x3c, 0x74, 0x43, 0x1f, 0x7c, 0xe7, 0x20, 0x46, 0x06, 0x0f, 0xcf, 0x7a,
2020 0x95, 0xc3, 0x7e, 0x14, 0x8f, 0x78, 0xc7, 0x72, 0x55
2023 short_channel_id: 0,
2026 proportional_millionths: 0,
2028 cltv_expiry_delta: 0,
2029 htlc_minimum_msat: None,
2030 htlc_maximum_msat: None,
2032 let too_long_route = RouteHint(vec![route_hop; 13]);
2033 let long_route_res = builder.clone()
2034 .description("Test".into())
2035 .private_route(too_long_route)
2037 assert_eq!(long_route_res, Err(CreationError::RouteTooLong));
2039 let sign_error_res = builder
2040 .description("Test".into())
2041 .payment_secret(PaymentSecret([0; 32]))
2042 .try_build_signed(|_| {
2043 Err("ImaginaryError")
2045 assert_eq!(sign_error_res, Err(SignOrCreationError::SignError("ImaginaryError")));
2049 fn test_builder_ok() {
2051 use lightning::routing::router::RouteHintHop;
2052 use secp256k1::Secp256k1;
2053 use secp256k1::{SecretKey, PublicKey};
2054 use std::time::Duration;
2056 let secp_ctx = Secp256k1::new();
2058 let private_key = SecretKey::from_slice(
2060 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
2061 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
2062 0x3b, 0x2d, 0xb7, 0x34
2065 let public_key = PublicKey::from_secret_key(&secp_ctx, &private_key);
2067 let route_1 = RouteHint(vec![
2069 src_node_id: public_key,
2070 short_channel_id: u64::from_be_bytes([123; 8]),
2073 proportional_millionths: 1,
2075 cltv_expiry_delta: 145,
2076 htlc_minimum_msat: None,
2077 htlc_maximum_msat: None,
2080 src_node_id: public_key,
2081 short_channel_id: u64::from_be_bytes([42; 8]),
2084 proportional_millionths: 2,
2086 cltv_expiry_delta: 146,
2087 htlc_minimum_msat: None,
2088 htlc_maximum_msat: None,
2092 let route_2 = RouteHint(vec![
2094 src_node_id: public_key,
2095 short_channel_id: 0,
2098 proportional_millionths: 3,
2100 cltv_expiry_delta: 147,
2101 htlc_minimum_msat: None,
2102 htlc_maximum_msat: None,
2105 src_node_id: public_key,
2106 short_channel_id: u64::from_be_bytes([1; 8]),
2109 proportional_millionths: 4,
2111 cltv_expiry_delta: 148,
2112 htlc_minimum_msat: None,
2113 htlc_maximum_msat: None,
2117 let builder = InvoiceBuilder::new(Currency::BitcoinTestnet)
2118 .amount_milli_satoshis(123)
2119 .duration_since_epoch(Duration::from_secs(1234567))
2120 .payee_pub_key(public_key)
2121 .expiry_time(Duration::from_secs(54321))
2122 .min_final_cltv_expiry_delta(144)
2123 .fallback(Fallback::PubKeyHash(PubkeyHash::from_slice(&[0;20]).unwrap()))
2124 .private_route(route_1.clone())
2125 .private_route(route_2.clone())
2126 .description_hash(sha256::Hash::from_slice(&[3;32][..]).unwrap())
2127 .payment_hash(sha256::Hash::from_slice(&[21;32][..]).unwrap())
2128 .payment_secret(PaymentSecret([42; 32]))
2131 let invoice = builder.clone().build_signed(|hash| {
2132 secp_ctx.sign_ecdsa_recoverable(hash, &private_key)
2135 assert!(invoice.check_signature().is_ok());
2136 assert_eq!(invoice.tagged_fields().count(), 10);
2138 assert_eq!(invoice.amount_milli_satoshis(), Some(123));
2139 assert_eq!(invoice.amount_pico_btc(), Some(1230));
2140 assert_eq!(invoice.currency(), Currency::BitcoinTestnet);
2141 #[cfg(feature = "std")]
2143 invoice.timestamp().duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs(),
2146 assert_eq!(invoice.payee_pub_key(), Some(&public_key));
2147 assert_eq!(invoice.expiry_time(), Duration::from_secs(54321));
2148 assert_eq!(invoice.min_final_cltv_expiry_delta(), 144);
2149 assert_eq!(invoice.fallbacks(), vec![&Fallback::PubKeyHash(PubkeyHash::from_slice(&[0;20]).unwrap())]);
2150 let address = Address::from_script(&ScriptBuf::new_p2pkh(&PubkeyHash::from_slice(&[0;20]).unwrap()), Network::Testnet).unwrap();
2151 assert_eq!(invoice.fallback_addresses(), vec![address]);
2152 assert_eq!(invoice.private_routes(), vec![&PrivateRoute(route_1), &PrivateRoute(route_2)]);
2154 invoice.description(),
2155 Bolt11InvoiceDescription::Hash(&Sha256(sha256::Hash::from_slice(&[3;32][..]).unwrap()))
2157 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21;32][..]).unwrap());
2158 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));
2160 let mut expected_features = Bolt11InvoiceFeatures::empty();
2161 expected_features.set_variable_length_onion_required();
2162 expected_features.set_payment_secret_required();
2163 expected_features.set_basic_mpp_optional();
2164 assert_eq!(invoice.features(), Some(&expected_features));
2166 let raw_invoice = builder.build_raw().unwrap();
2167 assert_eq!(raw_invoice, *invoice.into_signed_raw().raw_invoice())
2171 fn test_default_values() {
2173 use secp256k1::Secp256k1;
2174 use secp256k1::SecretKey;
2176 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
2177 .description("Test".into())
2178 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2179 .payment_secret(PaymentSecret([0; 32]))
2180 .duration_since_epoch(Duration::from_secs(1234567))
2183 .sign::<_, ()>(|hash| {
2184 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
2185 let secp_ctx = Secp256k1::new();
2186 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
2189 let invoice = Bolt11Invoice::from_signed(signed_invoice).unwrap();
2191 assert_eq!(invoice.min_final_cltv_expiry_delta(), DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA);
2192 assert_eq!(invoice.expiry_time(), Duration::from_secs(DEFAULT_EXPIRY_TIME));
2193 assert!(!invoice.would_expire(Duration::from_secs(1234568)));
2197 fn test_expiration() {
2199 use secp256k1::Secp256k1;
2200 use secp256k1::SecretKey;
2202 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
2203 .description("Test".into())
2204 .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2205 .payment_secret(PaymentSecret([0; 32]))
2206 .duration_since_epoch(Duration::from_secs(1234567))
2209 .sign::<_, ()>(|hash| {
2210 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
2211 let secp_ctx = Secp256k1::new();
2212 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
2215 let invoice = Bolt11Invoice::from_signed(signed_invoice).unwrap();
2217 assert!(invoice.would_expire(Duration::from_secs(1234567 + DEFAULT_EXPIRY_TIME + 1)));
2220 #[cfg(feature = "serde")]
2223 let invoice_str = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
2224 h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
2225 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
2226 h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
2227 j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
2228 ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
2229 guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
2230 ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
2231 p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
2232 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
2233 j5r6drg6k6zcqj0fcwg";
2234 let invoice = invoice_str.parse::<super::Bolt11Invoice>().unwrap();
2235 let serialized_invoice = serde_json::to_string(&invoice).unwrap();
2236 let deserialized_invoice: super::Bolt11Invoice = serde_json::from_str(serialized_invoice.as_str()).unwrap();
2237 assert_eq!(invoice, deserialized_invoice);
2238 assert_eq!(invoice_str, deserialized_invoice.to_string().as_str());
2239 assert_eq!(invoice_str, serialized_invoice.as_str().trim_matches('\"'));