_ Git - rust-lightning/blob - lightning-invoice/src/lib.rs

   1 // Prefix these with `rustdoc::` when we update our MSRV to be >= 1.52 to remove warnings.
   2 #![deny(broken_intra_doc_links)]
   3 #![deny(private_intra_doc_links)]
   4
   5 #![deny(missing_docs)]
   6 #![deny(non_upper_case_globals)]
   7 #![deny(non_camel_case_types)]
   8 #![deny(non_snake_case)]
   9 #![deny(unused_mut)]
  10
  11 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
  12
  13 #![cfg_attr(feature = "strict", deny(warnings))]
  14 #![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
  15
  16 //! This crate provides data structures to represent
  17 //! [lightning BOLT11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md)
  18 //! invoices and functions to create, encode and decode these. If you just want to use the standard
  19 //! en-/decoding functionality this should get you started:
  20 //!
  21 //!   * For parsing use `str::parse::<Invoice>(&self)` (see the docs of `impl FromStr for Invoice`)
  22 //!   * For constructing invoices use the `InvoiceBuilder`
  23 //!   * For serializing invoices use the `Display`/`ToString` traits
  24
  25 #[cfg(not(any(feature = "std", feature = "no-std")))]
  26 compile_error!("at least one of the `std` or `no-std` features must be enabled");
  27
  28 pub mod payment;
  29 pub mod utils;
  30
  31 pub(crate) mod time_utils;
  32
  33 extern crate bech32;
  34 extern crate bitcoin_hashes;
  35 #[macro_use] extern crate lightning;
  36 extern crate num_traits;
  37 extern crate secp256k1;
  38 extern crate alloc;
  39 #[cfg(any(test, feature = "std"))]
  40 extern crate core;
  41 #[cfg(feature = "serde")]
  42 extern crate serde;
  43
  44 #[cfg(feature = "std")]
  45 use std::time::SystemTime;
  46
  47 use bech32::u5;
  48 use bitcoin_hashes::Hash;
  49 use bitcoin_hashes::sha256;
  50 use lightning::ln::PaymentSecret;
  51 use lightning::ln::features::InvoiceFeatures;
  52 #[cfg(any(doc, test))]
  53 use lightning::routing::gossip::RoutingFees;
  54 use lightning::routing::router::RouteHint;
  55 use lightning::util::invoice::construct_invoice_preimage;
  56
  57 use secp256k1::PublicKey;
  58 use secp256k1::{Message, Secp256k1};
  59 use secp256k1::ecdsa::RecoverableSignature;
  60
  61 use core::fmt::{Display, Formatter, self};
  62 use core::iter::FilterMap;
  63 use core::num::ParseIntError;
  64 use core::ops::Deref;
  65 use core::slice::Iter;
  66 use core::time::Duration;
  67 use core::str;
  68
  69 #[cfg(feature = "serde")]
  70 use serde::{Deserialize, Deserializer,Serialize, Serializer, de::Error};
  71
  72 mod de;
  73 mod ser;
  74 mod tb;
  75
  76 mod prelude {
  77         #[cfg(feature = "hashbrown")]
  78         extern crate hashbrown;
  79
  80         pub use alloc::{vec, vec::Vec, string::String, collections::VecDeque, boxed::Box};
  81         #[cfg(not(feature = "hashbrown"))]
  82         pub use std::collections::{HashMap, HashSet, hash_map};
  83         #[cfg(feature = "hashbrown")]
  84         pub use self::hashbrown::{HashMap, HashSet, hash_map};
  85
  86         pub use alloc::string::ToString;
  87 }
  88
  89 use crate::prelude::*;
  90
  91 /// Sync compat for std/no_std
  92 #[cfg(feature = "std")]
  93 mod sync {
  94         pub use ::std::sync::{Mutex, MutexGuard};
  95 }
  96
  97 /// Sync compat for std/no_std
  98 #[cfg(not(feature = "std"))]
  99 mod sync;
 100
 101 /// Errors that indicate what is wrong with the invoice. They have some granularity for debug
 102 /// reasons, but should generally result in an "invalid BOLT11 invoice" message for the user.
 103 #[allow(missing_docs)]
 104 #[derive(PartialEq, Eq, Debug, Clone)]
 105 pub enum ParseError {
 106         Bech32Error(bech32::Error),
 107         ParseAmountError(ParseIntError),
 108         MalformedSignature(secp256k1::Error),
 109         BadPrefix,
 110         UnknownCurrency,
 111         UnknownSiPrefix,
 112         MalformedHRP,
 113         TooShortDataPart,
 114         UnexpectedEndOfTaggedFields,
 115         DescriptionDecodeError(str::Utf8Error),
 116         PaddingError,
 117         IntegerOverflowError,
 118         InvalidSegWitProgramLength,
 119         InvalidPubKeyHashLength,
 120         InvalidScriptHashLength,
 121         InvalidRecoveryId,
 122         InvalidSliceLength(String),
 123
 124         /// Not an error, but used internally to signal that a part of the invoice should be ignored
 125         /// according to BOLT11
 126         Skip,
 127 }
 128
 129 /// Indicates that something went wrong while parsing or validating the invoice. Parsing errors
 130 /// should be mostly seen as opaque and are only there for debugging reasons. Semantic errors
 131 /// like wrong signatures, missing fields etc. could mean that someone tampered with the invoice.
 132 #[derive(PartialEq, Eq, Debug, Clone)]
 133 pub enum ParseOrSemanticError {
 134         /// The invoice couldn't be decoded
 135         ParseError(ParseError),
 136
 137         /// The invoice could be decoded but violates the BOLT11 standard
 138         SemanticError(crate::SemanticError),
 139 }
 140
 141 /// The number of bits used to represent timestamps as defined in BOLT 11.
 142 const TIMESTAMP_BITS: usize = 35;
 143
 144 /// The maximum timestamp as [`Duration::as_secs`] since the Unix epoch allowed by [`BOLT 11`].
 145 ///
 146 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
 147 pub const MAX_TIMESTAMP: u64 = (1 << TIMESTAMP_BITS) - 1;
 148
 149 /// Default expiry time as defined by [BOLT 11].
 150 ///
 151 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
 152 pub const DEFAULT_EXPIRY_TIME: u64 = 3600;
 153
 154 /// Default minimum final CLTV expiry as defined by [BOLT 11].
 155 ///
 156 /// Note that this is *not* the same value as rust-lightning's minimum CLTV expiry, which is
 157 /// provided in [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
 158 ///
 159 /// [BOLT 11]: https://github.com/lightning/bolts/blob/master/11-payment-encoding.md
 160 /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
 161 pub const DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA: u64 = 18;
 162
 163 /// Builder for `Invoice`s. It's the most convenient and advised way to use this library. It ensures
 164 /// that only a semantically and syntactically correct Invoice can be built using it.
 165 ///
 166 /// ```
 167 /// extern crate secp256k1;
 168 /// extern crate lightning;
 169 /// extern crate lightning_invoice;
 170 /// extern crate bitcoin_hashes;
 171 ///
 172 /// use bitcoin_hashes::Hash;
 173 /// use bitcoin_hashes::sha256;
 174 ///
 175 /// use secp256k1::Secp256k1;
 176 /// use secp256k1::SecretKey;
 177 ///
 178 /// use lightning::ln::PaymentSecret;
 179 ///
 180 /// use lightning_invoice::{Currency, InvoiceBuilder};
 181 ///
 182 /// # #[cfg(not(feature = "std"))]
 183 /// # fn main() {}
 184 /// # #[cfg(feature = "std")]
 185 /// # fn main() {
 186 /// let private_key = SecretKey::from_slice(
 187 ///             &[
 188 ///                     0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f,
 189 ///                     0xe2, 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04,
 190 ///             0xa8, 0xca, 0x3b, 0x2d, 0xb7, 0x34
 191 ///     ][..]
 192 ///     ).unwrap();
 193 ///
 194 /// let payment_hash = sha256::Hash::from_slice(&[0; 32][..]).unwrap();
 195 /// let payment_secret = PaymentSecret([42u8; 32]);
 196 ///
 197 /// let invoice = InvoiceBuilder::new(Currency::Bitcoin)
 198 ///     .description("Coins pls!".into())
 199 ///     .payment_hash(payment_hash)
 200 ///     .payment_secret(payment_secret)
 201 ///     .current_timestamp()
 202 ///     .min_final_cltv_expiry_delta(144)
 203 ///     .build_signed(|hash| {
 204 ///             Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)
 205 ///     })
 206 ///     .unwrap();
 207 ///
 208 /// assert!(invoice.to_string().starts_with("lnbc1"));
 209 /// # }
 210 /// ```
 211 ///
 212 /// # Type parameters
 213 /// The two parameters `D` and `H` signal if the builder already contains the correct amount of the
 214 /// given field:
 215 ///  * `D`: exactly one `Description` or `DescriptionHash`
 216 ///  * `H`: exactly one `PaymentHash`
 217 ///  * `T`: the timestamp is set
 218 ///
 219 /// This is not exported to bindings users as we likely need to manually select one set of boolean type parameters.
 220 #[derive(Eq, PartialEq, Debug, Clone)]
 221 pub struct InvoiceBuilder<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> {
 222         currency: Currency,
 223         amount: Option<u64>,
 224         si_prefix: Option<SiPrefix>,
 225         timestamp: Option<PositiveTimestamp>,
 226         tagged_fields: Vec<TaggedField>,
 227         error: Option<CreationError>,
 228
 229         phantom_d: core::marker::PhantomData<D>,
 230         phantom_h: core::marker::PhantomData<H>,
 231         phantom_t: core::marker::PhantomData<T>,
 232         phantom_c: core::marker::PhantomData<C>,
 233         phantom_s: core::marker::PhantomData<S>,
 234 }
 235
 236 /// Represents a syntactically and semantically correct lightning BOLT11 invoice.
 237 ///
 238 /// There are three ways to construct an `Invoice`:
 239 ///  1. using `InvoiceBuilder`
 240 ///  2. using `Invoice::from_signed(SignedRawInvoice)`
 241 ///  3. using `str::parse::<Invoice>(&str)`
 242 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 243 pub struct Invoice {
 244         signed_invoice: SignedRawInvoice,
 245 }
 246
 247 /// Represents the description of an invoice which has to be either a directly included string or
 248 /// a hash of a description provided out of band.
 249 ///
 250 /// This is not exported to bindings users as we don't have a good way to map the reference lifetimes making this
 251 /// practically impossible to use safely in languages like C.
 252 #[derive(Eq, PartialEq, Debug, Clone)]
 253 pub enum InvoiceDescription<'f> {
 254         /// Reference to the directly supplied description in the invoice
 255         Direct(&'f Description),
 256
 257         /// Reference to the description's hash included in the invoice
 258         Hash(&'f Sha256),
 259 }
 260
 261 /// Represents a signed `RawInvoice` with cached hash. The signature is not checked and may be
 262 /// invalid.
 263 ///
 264 /// # Invariants
 265 /// The hash has to be either from the deserialized invoice or from the serialized `raw_invoice`.
 266 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 267 pub struct SignedRawInvoice {
 268         /// The rawInvoice that the signature belongs to
 269         raw_invoice: RawInvoice,
 270
 271         /// Hash of the `RawInvoice` that will be used to check the signature.
 272         ///
 273         /// * if the `SignedRawInvoice` was deserialized the hash is of from the original encoded form,
 274         /// since it's not guaranteed that encoding it again will lead to the same result since integers
 275         /// could have been encoded with leading zeroes etc.
 276         /// * if the `SignedRawInvoice` was constructed manually the hash will be the calculated hash
 277         /// from the `RawInvoice`
 278         hash: [u8; 32],
 279
 280         /// signature of the payment request
 281         signature: InvoiceSignature,
 282 }
 283
 284 /// Represents an syntactically correct Invoice for a payment on the lightning network,
 285 /// but without the signature information.
 286 /// De- and encoding should not lead to information loss but may lead to different hashes.
 287 ///
 288 /// For methods without docs see the corresponding methods in `Invoice`.
 289 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 290 pub struct RawInvoice {
 291         /// human readable part
 292         pub hrp: RawHrp,
 293
 294         /// data part
 295         pub data: RawDataPart,
 296 }
 297
 298 /// Data of the `RawInvoice` that is encoded in the human readable part
 299 ///
 300 /// This is not exported to bindings users as we don't yet support `Option<Enum>`
 301 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 302 pub struct RawHrp {
 303         /// The currency deferred from the 3rd and 4th character of the bech32 transaction
 304         pub currency: Currency,
 305
 306         /// The amount that, multiplied by the SI prefix, has to be payed
 307         pub raw_amount: Option<u64>,
 308
 309         /// SI prefix that gets multiplied with the `raw_amount`
 310         pub si_prefix: Option<SiPrefix>,
 311 }
 312
 313 /// Data of the `RawInvoice` that is encoded in the data part
 314 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 315 pub struct RawDataPart {
 316         /// generation time of the invoice
 317         pub timestamp: PositiveTimestamp,
 318
 319         /// tagged fields of the payment request
 320         pub tagged_fields: Vec<RawTaggedField>,
 321 }
 322
 323 /// A timestamp that refers to a date after 1 January 1970.
 324 ///
 325 /// # Invariants
 326 ///
 327 /// The Unix timestamp representing the stored time has to be positive and no greater than
 328 /// [`MAX_TIMESTAMP`].
 329 #[derive(Eq, PartialEq, Debug, Clone, Hash)]
 330 pub struct PositiveTimestamp(Duration);
 331
 332 /// SI prefixes for the human readable part
 333 #[derive(Eq, PartialEq, Debug, Clone, Copy, Hash)]
 334 pub enum SiPrefix {
 335         /// 10^-3
 336         Milli,
 337         /// 10^-6
 338         Micro,
 339         /// 10^-9
 340         Nano,
 341         /// 10^-12
 342         Pico,
 343 }
 344
 345 impl SiPrefix {
 346         /// Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix.
 347         /// This is effectively 10^12 * the prefix multiplier
 348         pub fn multiplier(&self) -> u64 {
 349                 match *self {
 350                         SiPrefix::Milli => 1_000_000_000,
 351                         SiPrefix::Micro => 1_000_000,
 352                         SiPrefix::Nano => 1_000,
 353                         SiPrefix::Pico => 1,
 354                 }
 355         }
 356
 357         /// Returns all enum variants of `SiPrefix` sorted in descending order of their associated
 358         /// multiplier.
 359         ///
 360         /// This is not exported to bindings users as we don't yet support a slice of enums, and also because this function
 361         /// isn't the most critical to expose.
 362         pub fn values_desc() -> &'static [SiPrefix] {
 363                 use crate::SiPrefix::*;
 364                 static VALUES: [SiPrefix; 4] = [Milli, Micro, Nano, Pico];
 365                 &VALUES
 366         }
 367 }
 368
 369 /// Enum representing the crypto currencies (or networks) supported by this library
 370 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 371 pub enum Currency {
 372         /// Bitcoin mainnet
 373         Bitcoin,
 374
 375         /// Bitcoin testnet
 376         BitcoinTestnet,
 377
 378         /// Bitcoin regtest
 379         Regtest,
 380
 381         /// Bitcoin simnet
 382         Simnet,
 383
 384         /// Bitcoin signet
 385         Signet,
 386 }
 387
 388 /// Tagged field which may have an unknown tag
 389 ///
 390 /// This is not exported to bindings users as we don't currently support TaggedField
 391 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 392 pub enum RawTaggedField {
 393         /// Parsed tagged field with known tag
 394         KnownSemantics(TaggedField),
 395         /// tagged field which was not parsed due to an unknown tag or undefined field semantics
 396         UnknownSemantics(Vec<u5>),
 397 }
 398
 399 /// Tagged field with known tag
 400 ///
 401 /// For descriptions of the enum values please refer to the enclosed type's docs.
 402 ///
 403 /// This is not exported to bindings users as we don't yet support enum variants with the same name the struct contained
 404 /// in the variant.
 405 #[allow(missing_docs)]
 406 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 407 pub enum TaggedField {
 408         PaymentHash(Sha256),
 409         Description(Description),
 410         PayeePubKey(PayeePubKey),
 411         DescriptionHash(Sha256),
 412         ExpiryTime(ExpiryTime),
 413         MinFinalCltvExpiryDelta(MinFinalCltvExpiryDelta),
 414         Fallback(Fallback),
 415         PrivateRoute(PrivateRoute),
 416         PaymentSecret(PaymentSecret),
 417         Features(InvoiceFeatures),
 418 }
 419
 420 /// SHA-256 hash
 421 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 422 pub struct Sha256(/// This is not exported to bindings users as the native hash types are not currently mapped
 423         pub sha256::Hash);
 424
 425 /// Description string
 426 ///
 427 /// # Invariants
 428 /// The description can be at most 639 __bytes__ long
 429 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 430 pub struct Description(String);
 431
 432 /// Payee public key
 433 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 434 pub struct PayeePubKey(pub PublicKey);
 435
 436 /// Positive duration that defines when (relatively to the timestamp) in the future the invoice
 437 /// expires
 438 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 439 pub struct ExpiryTime(Duration);
 440
 441 /// `min_final_cltv_expiry_delta` to use for the last HTLC in the route
 442 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 443 pub struct MinFinalCltvExpiryDelta(pub u64);
 444
 445 // TODO: better types instead onf byte arrays
 446 /// Fallback address in case no LN payment is possible
 447 #[allow(missing_docs)]
 448 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 449 pub enum Fallback {
 450         SegWitProgram {
 451                 version: u5,
 452                 program: Vec<u8>,
 453         },
 454         PubKeyHash([u8; 20]),
 455         ScriptHash([u8; 20]),
 456 }
 457
 458 /// Recoverable signature
 459 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 460 pub struct InvoiceSignature(pub RecoverableSignature);
 461
 462 /// Private routing information
 463 ///
 464 /// # Invariants
 465 /// The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)
 466 ///
 467 #[derive(Clone, Debug, Hash, Eq, PartialEq)]
 468 pub struct PrivateRoute(RouteHint);
 469
 470 /// Tag constants as specified in BOLT11
 471 #[allow(missing_docs)]
 472 pub mod constants {
 473         pub const TAG_PAYMENT_HASH: u8 = 1;
 474         pub const TAG_DESCRIPTION: u8 = 13;
 475         pub const TAG_PAYEE_PUB_KEY: u8 = 19;
 476         pub const TAG_DESCRIPTION_HASH: u8 = 23;
 477         pub const TAG_EXPIRY_TIME: u8 = 6;
 478         pub const TAG_MIN_FINAL_CLTV_EXPIRY_DELTA: u8 = 24;
 479         pub const TAG_FALLBACK: u8 = 9;
 480         pub const TAG_PRIVATE_ROUTE: u8 = 3;
 481         pub const TAG_PAYMENT_SECRET: u8 = 16;
 482         pub const TAG_FEATURES: u8 = 5;
 483 }
 484
 485 impl InvoiceBuilder<tb::False, tb::False, tb::False, tb::False, tb::False> {
 486         /// Construct new, empty `InvoiceBuilder`. All necessary fields have to be filled first before
 487         /// `InvoiceBuilder::build(self)` becomes available.
 488         pub fn new(currrency: Currency) -> Self {
 489                 InvoiceBuilder {
 490                         currency: currrency,
 491                         amount: None,
 492                         si_prefix: None,
 493                         timestamp: None,
 494                         tagged_fields: Vec::new(),
 495                         error: None,
 496
 497                         phantom_d: core::marker::PhantomData,
 498                         phantom_h: core::marker::PhantomData,
 499                         phantom_t: core::marker::PhantomData,
 500                         phantom_c: core::marker::PhantomData,
 501                         phantom_s: core::marker::PhantomData,
 502                 }
 503         }
 504 }
 505
 506 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, C, S> {
 507         /// Helper function to set the completeness flags.
 508         fn set_flags<DN: tb::Bool, HN: tb::Bool, TN: tb::Bool, CN: tb::Bool, SN: tb::Bool>(self) -> InvoiceBuilder<DN, HN, TN, CN, SN> {
 509                 InvoiceBuilder::<DN, HN, TN, CN, SN> {
 510                         currency: self.currency,
 511                         amount: self.amount,
 512                         si_prefix: self.si_prefix,
 513                         timestamp: self.timestamp,
 514                         tagged_fields: self.tagged_fields,
 515                         error: self.error,
 516
 517                         phantom_d: core::marker::PhantomData,
 518                         phantom_h: core::marker::PhantomData,
 519                         phantom_t: core::marker::PhantomData,
 520                         phantom_c: core::marker::PhantomData,
 521                         phantom_s: core::marker::PhantomData,
 522                 }
 523         }
 524
 525         /// Sets the amount in millisatoshis. The optimal SI prefix is chosen automatically.
 526         pub fn amount_milli_satoshis(mut self, amount_msat: u64) -> Self {
 527                 let amount = amount_msat * 10; // Invoices are denominated in "pico BTC"
 528                 let biggest_possible_si_prefix = SiPrefix::values_desc()
 529                         .iter()
 530                         .find(|prefix| amount % prefix.multiplier() == 0)
 531                         .expect("Pico should always match");
 532                 self.amount = Some(amount / biggest_possible_si_prefix.multiplier());
 533                 self.si_prefix = Some(*biggest_possible_si_prefix);
 534                 self
 535         }
 536
 537         /// Sets the payee's public key.
 538         pub fn payee_pub_key(mut self, pub_key: PublicKey) -> Self {
 539                 self.tagged_fields.push(TaggedField::PayeePubKey(PayeePubKey(pub_key)));
 540                 self
 541         }
 542
 543         /// Sets the expiry time, dropping the subsecond part (which is not representable in BOLT 11
 544         /// invoices).
 545         pub fn expiry_time(mut self, expiry_time: Duration) -> Self {
 546                 self.tagged_fields.push(TaggedField::ExpiryTime(ExpiryTime::from_duration(expiry_time)));
 547                 self
 548         }
 549
 550         /// Adds a fallback address.
 551         pub fn fallback(mut self, fallback: Fallback) -> Self {
 552                 self.tagged_fields.push(TaggedField::Fallback(fallback));
 553                 self
 554         }
 555
 556         /// Adds a private route.
 557         pub fn private_route(mut self, hint: RouteHint) -> Self {
 558                 match PrivateRoute::new(hint) {
 559                         Ok(r) => self.tagged_fields.push(TaggedField::PrivateRoute(r)),
 560                         Err(e) => self.error = Some(e),
 561                 }
 562                 self
 563         }
 564 }
 565
 566 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, tb::True, C, S> {
 567         /// Builds a `RawInvoice` if no `CreationError` occurred while construction any of the fields.
 568         pub fn build_raw(self) -> Result<RawInvoice, CreationError> {
 569
 570                 // If an error occurred at any time before, return it now
 571                 if let Some(e) = self.error {
 572                         return Err(e);
 573                 }
 574
 575                 let hrp = RawHrp {
 576                         currency: self.currency,
 577                         raw_amount: self.amount,
 578                         si_prefix: self.si_prefix,
 579                 };
 580
 581                 let timestamp = self.timestamp.expect("ensured to be Some(t) by type T");
 582
 583                 let tagged_fields = self.tagged_fields.into_iter().map(|tf| {
 584                         RawTaggedField::KnownSemantics(tf)
 585                 }).collect::<Vec<_>>();
 586
 587                 let data = RawDataPart {
 588                         timestamp,
 589                         tagged_fields,
 590                 };
 591
 592                 Ok(RawInvoice {
 593                         hrp,
 594                         data,
 595                 })
 596         }
 597 }
 598
 599 impl<H: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<tb::False, H, T, C, S> {
 600         /// Set the description. This function is only available if no description (hash) was set.
 601         pub fn description(mut self, description: String) -> InvoiceBuilder<tb::True, H, T, C, S> {
 602                 match Description::new(description) {
 603                         Ok(d) => self.tagged_fields.push(TaggedField::Description(d)),
 604                         Err(e) => self.error = Some(e),
 605                 }
 606                 self.set_flags()
 607         }
 608
 609         /// Set the description hash. This function is only available if no description (hash) was set.
 610         pub fn description_hash(mut self, description_hash: sha256::Hash) -> InvoiceBuilder<tb::True, H, T, C, S> {
 611                 self.tagged_fields.push(TaggedField::DescriptionHash(Sha256(description_hash)));
 612                 self.set_flags()
 613         }
 614
 615         /// Set the description or description hash. This function is only available if no description (hash) was set.
 616         pub fn invoice_description(self, description: InvoiceDescription) -> InvoiceBuilder<tb::True, H, T, C, S> {
 617                 match description {
 618                         InvoiceDescription::Direct(desc) => {
 619                                 self.description(desc.clone().into_inner())
 620                         }
 621                         InvoiceDescription::Hash(hash) => {
 622                                 self.description_hash(hash.0)
 623                         }
 624                 }
 625         }
 626 }
 627
 628 impl<D: tb::Bool, T: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, tb::False, T, C, S> {
 629         /// Set the payment hash. This function is only available if no payment hash was set.
 630         pub fn payment_hash(mut self, hash: sha256::Hash) -> InvoiceBuilder<D, tb::True, T, C, S> {
 631                 self.tagged_fields.push(TaggedField::PaymentHash(Sha256(hash)));
 632                 self.set_flags()
 633         }
 634 }
 635
 636 impl<D: tb::Bool, H: tb::Bool, C: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, tb::False, C, S> {
 637         /// Sets the timestamp to a specific [`SystemTime`].
 638         #[cfg(feature = "std")]
 639         pub fn timestamp(mut self, time: SystemTime) -> InvoiceBuilder<D, H, tb::True, C, S> {
 640                 match PositiveTimestamp::from_system_time(time) {
 641                         Ok(t) => self.timestamp = Some(t),
 642                         Err(e) => self.error = Some(e),
 643                 }
 644
 645                 self.set_flags()
 646         }
 647
 648         /// Sets the timestamp to a duration since the Unix epoch, dropping the subsecond part (which
 649         /// is not representable in BOLT 11 invoices).
 650         pub fn duration_since_epoch(mut self, time: Duration) -> InvoiceBuilder<D, H, tb::True, C, S> {
 651                 match PositiveTimestamp::from_duration_since_epoch(time) {
 652                         Ok(t) => self.timestamp = Some(t),
 653                         Err(e) => self.error = Some(e),
 654                 }
 655
 656                 self.set_flags()
 657         }
 658
 659         /// Sets the timestamp to the current system time.
 660         #[cfg(feature = "std")]
 661         pub fn current_timestamp(mut self) -> InvoiceBuilder<D, H, tb::True, C, S> {
 662                 let now = PositiveTimestamp::from_system_time(SystemTime::now());
 663                 self.timestamp = Some(now.expect("for the foreseeable future this shouldn't happen"));
 664                 self.set_flags()
 665         }
 666 }
 667
 668 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, S: tb::Bool> InvoiceBuilder<D, H, T, tb::False, S> {
 669         /// Sets `min_final_cltv_expiry_delta`.
 670         pub fn min_final_cltv_expiry_delta(mut self, min_final_cltv_expiry_delta: u64) -> InvoiceBuilder<D, H, T, tb::True, S> {
 671                 self.tagged_fields.push(TaggedField::MinFinalCltvExpiryDelta(MinFinalCltvExpiryDelta(min_final_cltv_expiry_delta)));
 672                 self.set_flags()
 673         }
 674 }
 675
 676 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool> InvoiceBuilder<D, H, T, C, tb::False> {
 677         /// Sets the payment secret and relevant features.
 678         pub fn payment_secret(mut self, payment_secret: PaymentSecret) -> InvoiceBuilder<D, H, T, C, tb::True> {
 679                 let mut features = InvoiceFeatures::empty();
 680                 features.set_variable_length_onion_required();
 681                 features.set_payment_secret_required();
 682                 self.tagged_fields.push(TaggedField::PaymentSecret(payment_secret));
 683                 self.tagged_fields.push(TaggedField::Features(features));
 684                 self.set_flags()
 685         }
 686 }
 687
 688 impl<D: tb::Bool, H: tb::Bool, T: tb::Bool, C: tb::Bool> InvoiceBuilder<D, H, T, C, tb::True> {
 689         /// Sets the `basic_mpp` feature as optional.
 690         pub fn basic_mpp(mut self) -> Self {
 691                 for field in self.tagged_fields.iter_mut() {
 692                         if let TaggedField::Features(f) = field {
 693                                 f.set_basic_mpp_optional();
 694                         }
 695                 }
 696                 self
 697         }
 698 }
 699
 700 impl InvoiceBuilder<tb::True, tb::True, tb::True, tb::True, tb::True> {
 701         /// Builds and signs an invoice using the supplied `sign_function`. This function MAY NOT fail
 702         /// and MUST produce a recoverable signature valid for the given hash and if applicable also for
 703         /// the included payee public key.
 704         pub fn build_signed<F>(self, sign_function: F) -> Result<Invoice, CreationError>
 705                 where F: FnOnce(&Message) -> RecoverableSignature
 706         {
 707                 let invoice = self.try_build_signed::<_, ()>(|hash| {
 708                         Ok(sign_function(hash))
 709                 });
 710
 711                 match invoice {
 712                         Ok(i) => Ok(i),
 713                         Err(SignOrCreationError::CreationError(e)) => Err(e),
 714                         Err(SignOrCreationError::SignError(())) => unreachable!(),
 715                 }
 716         }
 717
 718         /// Builds and signs an invoice using the supplied `sign_function`. This function MAY fail with
 719         /// an error of type `E` and MUST produce a recoverable signature valid for the given hash and
 720         /// if applicable also for the included payee public key.
 721         pub fn try_build_signed<F, E>(self, sign_function: F) -> Result<Invoice, SignOrCreationError<E>>
 722                 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
 723         {
 724                 let raw = match self.build_raw() {
 725                         Ok(r) => r,
 726                         Err(e) => return Err(SignOrCreationError::CreationError(e)),
 727                 };
 728
 729                 let signed = match raw.sign(sign_function) {
 730                         Ok(s) => s,
 731                         Err(e) => return Err(SignOrCreationError::SignError(e)),
 732                 };
 733
 734                 let invoice = Invoice {
 735                         signed_invoice: signed,
 736                 };
 737
 738                 invoice.check_field_counts().expect("should be ensured by type signature of builder");
 739                 invoice.check_feature_bits().expect("should be ensured by type signature of builder");
 740                 invoice.check_amount().expect("should be ensured by type signature of builder");
 741
 742                 Ok(invoice)
 743         }
 744 }
 745
 746
 747 impl SignedRawInvoice {
 748         /// Disassembles the `SignedRawInvoice` into its three parts:
 749         ///  1. raw invoice
 750         ///  2. hash of the raw invoice
 751         ///  3. signature
 752         pub fn into_parts(self) -> (RawInvoice, [u8; 32], InvoiceSignature) {
 753                 (self.raw_invoice, self.hash, self.signature)
 754         }
 755
 756         /// The `RawInvoice` which was signed.
 757         pub fn raw_invoice(&self) -> &RawInvoice {
 758                 &self.raw_invoice
 759         }
 760
 761         /// The hash of the `RawInvoice` that was signed.
 762         pub fn signable_hash(&self) -> &[u8; 32] {
 763                 &self.hash
 764         }
 765
 766         /// InvoiceSignature for the invoice.
 767         pub fn signature(&self) -> &InvoiceSignature {
 768                 &self.signature
 769         }
 770
 771         /// Recovers the public key used for signing the invoice from the recoverable signature.
 772         pub fn recover_payee_pub_key(&self) -> Result<PayeePubKey, secp256k1::Error> {
 773                 let hash = Message::from_slice(&self.hash[..])
 774                         .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
 775
 776                 Ok(PayeePubKey(Secp256k1::new().recover_ecdsa(
 777                         &hash,
 778                         &self.signature
 779                 )?))
 780         }
 781
 782         /// Checks if the signature is valid for the included payee public key or if none exists if it's
 783         /// valid for the recovered signature (which should always be true?).
 784         pub fn check_signature(&self) -> bool {
 785                 let included_pub_key = self.raw_invoice.payee_pub_key();
 786
 787                 let mut recovered_pub_key = Option::None;
 788                 if recovered_pub_key.is_none() {
 789                         let recovered = match self.recover_payee_pub_key() {
 790                                 Ok(pk) => pk,
 791                                 Err(_) => return false,
 792                         };
 793                         recovered_pub_key = Some(recovered);
 794                 }
 795
 796                 let pub_key = included_pub_key.or(recovered_pub_key.as_ref())
 797                         .expect("One is always present");
 798
 799                 let hash = Message::from_slice(&self.hash[..])
 800                         .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
 801
 802                 let secp_context = Secp256k1::new();
 803                 let verification_result = secp_context.verify_ecdsa(
 804                         &hash,
 805                         &self.signature.to_standard(),
 806                         pub_key
 807                 );
 808
 809                 match verification_result {
 810                         Ok(()) => true,
 811                         Err(_) => false,
 812                 }
 813         }
 814 }
 815
 816 /// Finds the first element of an enum stream of a given variant and extracts one member of the
 817 /// variant. If no element was found `None` gets returned.
 818 ///
 819 /// The following example would extract the first B.
 820 ///
 821 /// ```ignore
 822 /// enum Enum {
 823 ///     A(u8),
 824 ///     B(u16)
 825 /// }
 826 ///
 827 /// let elements = vec![Enum::A(1), Enum::A(2), Enum::B(3), Enum::A(4)];
 828 ///
 829 /// assert_eq!(find_extract!(elements.iter(), Enum::B(x), x), Some(3u16));
 830 /// ```
 831 macro_rules! find_extract {
 832         ($iter:expr, $enm:pat, $enm_var:ident) => {
 833                 find_all_extract!($iter, $enm, $enm_var).next()
 834         };
 835 }
 836
 837 /// Finds the all elements of an enum stream of a given variant and extracts one member of the
 838 /// variant through an iterator.
 839 ///
 840 /// The following example would extract all A.
 841 ///
 842 /// ```ignore
 843 /// enum Enum {
 844 ///     A(u8),
 845 ///     B(u16)
 846 /// }
 847 ///
 848 /// let elements = vec![Enum::A(1), Enum::A(2), Enum::B(3), Enum::A(4)];
 849 ///
 850 /// assert_eq!(
 851 ///     find_all_extract!(elements.iter(), Enum::A(x), x).collect::<Vec<u8>>(),
 852 ///     vec![1u8, 2u8, 4u8]
 853 /// );
 854 /// ```
 855 macro_rules! find_all_extract {
 856         ($iter:expr, $enm:pat, $enm_var:ident) => {
 857                 $iter.filter_map(|tf| match *tf {
 858                         $enm => Some($enm_var),
 859                         _ => None,
 860                 })
 861         };
 862 }
 863
 864 #[allow(missing_docs)]
 865 impl RawInvoice {
 866         /// Hash the HRP as bytes and signatureless data part.
 867         fn hash_from_parts(hrp_bytes: &[u8], data_without_signature: &[u5]) -> [u8; 32] {
 868                 let preimage = construct_invoice_preimage(hrp_bytes, data_without_signature);
 869                 let mut hash: [u8; 32] = Default::default();
 870                 hash.copy_from_slice(&sha256::Hash::hash(&preimage)[..]);
 871                 hash
 872         }
 873
 874         /// Calculate the hash of the encoded `RawInvoice` which should be signed.
 875         pub fn signable_hash(&self) -> [u8; 32] {
 876                 use bech32::ToBase32;
 877
 878                 RawInvoice::hash_from_parts(
 879                         self.hrp.to_string().as_bytes(),
 880                         &self.data.to_base32()
 881                 )
 882         }
 883
 884         /// Signs the invoice using the supplied `sign_function`. This function MAY fail with an error
 885         /// of type `E`. Since the signature of a `SignedRawInvoice` is not required to be valid there
 886         /// are no constraints regarding the validity of the produced signature.
 887         ///
 888         /// This is not exported to bindings users as we don't currently support passing function pointers into methods
 889         /// explicitly.
 890         pub fn sign<F, E>(self, sign_method: F) -> Result<SignedRawInvoice, E>
 891                 where F: FnOnce(&Message) -> Result<RecoverableSignature, E>
 892         {
 893                 let raw_hash = self.signable_hash();
 894                 let hash = Message::from_slice(&raw_hash[..])
 895                         .expect("Hash is 32 bytes long, same as MESSAGE_SIZE");
 896                 let signature = sign_method(&hash)?;
 897
 898                 Ok(SignedRawInvoice {
 899                         raw_invoice: self,
 900                         hash: raw_hash,
 901                         signature: InvoiceSignature(signature),
 902                 })
 903         }
 904
 905         /// Returns an iterator over all tagged fields with known semantics.
 906         ///
 907         /// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
 908         pub fn known_tagged_fields(&self)
 909                 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>>
 910         {
 911                 // For 1.14.0 compatibility: closures' types can't be written an fn()->() in the
 912                 // function's type signature.
 913                 // TODO: refactor once impl Trait is available
 914                 fn match_raw(raw: &RawTaggedField) -> Option<&TaggedField> {
 915                         match *raw {
 916                                 RawTaggedField::KnownSemantics(ref tf) => Some(tf),
 917                                 _ => None,
 918                         }
 919                 }
 920
 921                 self.data.tagged_fields.iter().filter_map(match_raw )
 922         }
 923
 924         pub fn payment_hash(&self) -> Option<&Sha256> {
 925                 find_extract!(self.known_tagged_fields(), TaggedField::PaymentHash(ref x), x)
 926         }
 927
 928         pub fn description(&self) -> Option<&Description> {
 929                 find_extract!(self.known_tagged_fields(), TaggedField::Description(ref x), x)
 930         }
 931
 932         pub fn payee_pub_key(&self) -> Option<&PayeePubKey> {
 933                 find_extract!(self.known_tagged_fields(), TaggedField::PayeePubKey(ref x), x)
 934         }
 935
 936         pub fn description_hash(&self) -> Option<&Sha256> {
 937                 find_extract!(self.known_tagged_fields(), TaggedField::DescriptionHash(ref x), x)
 938         }
 939
 940         pub fn expiry_time(&self) -> Option<&ExpiryTime> {
 941                 find_extract!(self.known_tagged_fields(), TaggedField::ExpiryTime(ref x), x)
 942         }
 943
 944         pub fn min_final_cltv_expiry_delta(&self) -> Option<&MinFinalCltvExpiryDelta> {
 945                 find_extract!(self.known_tagged_fields(), TaggedField::MinFinalCltvExpiryDelta(ref x), x)
 946         }
 947
 948         pub fn payment_secret(&self) -> Option<&PaymentSecret> {
 949                 find_extract!(self.known_tagged_fields(), TaggedField::PaymentSecret(ref x), x)
 950         }
 951
 952         pub fn features(&self) -> Option<&InvoiceFeatures> {
 953                 find_extract!(self.known_tagged_fields(), TaggedField::Features(ref x), x)
 954         }
 955
 956         /// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
 957         pub fn fallbacks(&self) -> Vec<&Fallback> {
 958                 find_all_extract!(self.known_tagged_fields(), TaggedField::Fallback(ref x), x).collect()
 959         }
 960
 961         pub fn private_routes(&self) -> Vec<&PrivateRoute> {
 962                 find_all_extract!(self.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x).collect()
 963         }
 964
 965         pub fn amount_pico_btc(&self) -> Option<u64> {
 966                 self.hrp.raw_amount.map(|v| {
 967                         v * self.hrp.si_prefix.as_ref().map_or(1_000_000_000_000, |si| { si.multiplier() })
 968                 })
 969         }
 970
 971         pub fn currency(&self) -> Currency {
 972                 self.hrp.currency.clone()
 973         }
 974 }
 975
 976 impl PositiveTimestamp {
 977         /// Creates a `PositiveTimestamp` from a Unix timestamp in the range `0..=MAX_TIMESTAMP`.
 978         ///
 979         /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
 980         pub fn from_unix_timestamp(unix_seconds: u64) -> Result<Self, CreationError> {
 981                 if unix_seconds <= MAX_TIMESTAMP {
 982                         Ok(Self(Duration::from_secs(unix_seconds)))
 983                 } else {
 984                         Err(CreationError::TimestampOutOfBounds)
 985                 }
 986         }
 987
 988         /// Creates a `PositiveTimestamp` from a [`SystemTime`] with a corresponding Unix timestamp in
 989         /// the range `0..=MAX_TIMESTAMP`.
 990         ///
 991         /// Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.
 992         ///
 993         /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
 994         #[cfg(feature = "std")]
 995         pub fn from_system_time(time: SystemTime) -> Result<Self, CreationError> {
 996                 time.duration_since(SystemTime::UNIX_EPOCH)
 997                         .map(Self::from_duration_since_epoch)
 998                         .unwrap_or(Err(CreationError::TimestampOutOfBounds))
 999         }
1000
1001         /// Creates a `PositiveTimestamp` from a [`Duration`] since the Unix epoch in the range
1002         /// `0..=MAX_TIMESTAMP`.
1003         ///
1004         /// Note that the subsecond part is dropped as it is not representable in BOLT 11 invoices.
1005         ///
1006         /// Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
1007         pub fn from_duration_since_epoch(duration: Duration) -> Result<Self, CreationError> {
1008                 Self::from_unix_timestamp(duration.as_secs())
1009         }
1010
1011         /// Returns the Unix timestamp representing the stored time
1012         pub fn as_unix_timestamp(&self) -> u64 {
1013                 self.0.as_secs()
1014         }
1015
1016         /// Returns the duration of the stored time since the Unix epoch
1017         pub fn as_duration_since_epoch(&self) -> Duration {
1018                 self.0
1019         }
1020
1021         /// Returns the [`SystemTime`] representing the stored time
1022         #[cfg(feature = "std")]
1023         pub fn as_time(&self) -> SystemTime {
1024                 SystemTime::UNIX_EPOCH + self.0
1025         }
1026 }
1027
1028 #[cfg(feature = "std")]
1029 impl From<PositiveTimestamp> for SystemTime {
1030         fn from(val: PositiveTimestamp) -> Self {
1031                 SystemTime::UNIX_EPOCH + val.0
1032         }
1033 }
1034
1035 impl Invoice {
1036         /// Transform the `Invoice` into it's unchecked version
1037         pub fn into_signed_raw(self) -> SignedRawInvoice {
1038                 self.signed_invoice
1039         }
1040
1041         /// Check that all mandatory fields are present
1042         fn check_field_counts(&self) -> Result<(), SemanticError> {
1043                 // "A writer MUST include exactly one p field […]."
1044                 let payment_hash_cnt = self.tagged_fields().filter(|&tf| match *tf {
1045                         TaggedField::PaymentHash(_) => true,
1046                         _ => false,
1047                 }).count();
1048                 if payment_hash_cnt < 1 {
1049                         return Err(SemanticError::NoPaymentHash);
1050                 } else if payment_hash_cnt > 1 {
1051                         return Err(SemanticError::MultiplePaymentHashes);
1052                 }
1053
1054                 // "A writer MUST include either exactly one d or exactly one h field."
1055                 let description_cnt = self.tagged_fields().filter(|&tf| match *tf {
1056                         TaggedField::Description(_) | TaggedField::DescriptionHash(_) => true,
1057                         _ => false,
1058                 }).count();
1059                 if  description_cnt < 1 {
1060                         return Err(SemanticError::NoDescription);
1061                 } else if description_cnt > 1 {
1062                         return  Err(SemanticError::MultipleDescriptions);
1063                 }
1064
1065                 self.check_payment_secret()?;
1066
1067                 Ok(())
1068         }
1069
1070         /// Checks that there is exactly one payment secret field
1071         fn check_payment_secret(&self) -> Result<(), SemanticError> {
1072                 // "A writer MUST include exactly one `s` field."
1073                 let payment_secret_count = self.tagged_fields().filter(|&tf| match *tf {
1074                         TaggedField::PaymentSecret(_) => true,
1075                         _ => false,
1076                 }).count();
1077                 if payment_secret_count < 1 {
1078                         return Err(SemanticError::NoPaymentSecret);
1079                 } else if payment_secret_count > 1 {
1080                         return Err(SemanticError::MultiplePaymentSecrets);
1081                 }
1082
1083                 Ok(())
1084         }
1085
1086         /// Check that amount is a whole number of millisatoshis
1087         fn check_amount(&self) -> Result<(), SemanticError> {
1088                 if let Some(amount_pico_btc) = self.amount_pico_btc() {
1089                         if amount_pico_btc % 10 != 0 {
1090                                 return Err(SemanticError::ImpreciseAmount);
1091                         }
1092                 }
1093                 Ok(())
1094         }
1095
1096         /// Check that feature bits are set as required
1097         fn check_feature_bits(&self) -> Result<(), SemanticError> {
1098                 self.check_payment_secret()?;
1099
1100                 // "A writer MUST set an s field if and only if the payment_secret feature is set."
1101                 // (this requirement has been since removed, and we now require the payment secret
1102                 // feature bit always).
1103                 let features = self.tagged_fields().find(|&tf| match *tf {
1104                         TaggedField::Features(_) => true,
1105                         _ => false,
1106                 });
1107                 match features {
1108                         None => Err(SemanticError::InvalidFeatures),
1109                         Some(TaggedField::Features(features)) => {
1110                                 if features.requires_unknown_bits() {
1111                                         Err(SemanticError::InvalidFeatures)
1112                                 } else if !features.supports_payment_secret() {
1113                                         Err(SemanticError::InvalidFeatures)
1114                                 } else {
1115                                         Ok(())
1116                                 }
1117                         },
1118                         Some(_) => unreachable!(),
1119                 }
1120         }
1121
1122         /// Check that the invoice is signed correctly and that key recovery works
1123         pub fn check_signature(&self) -> Result<(), SemanticError> {
1124                 match self.signed_invoice.recover_payee_pub_key() {
1125                         Err(secp256k1::Error::InvalidRecoveryId) =>
1126                                 return Err(SemanticError::InvalidRecoveryId),
1127                         Err(secp256k1::Error::InvalidSignature) =>
1128                                 return Err(SemanticError::InvalidSignature),
1129                         Err(e) => panic!("no other error may occur, got {:?}", e),
1130                         Ok(_) => {},
1131                 }
1132
1133                 if !self.signed_invoice.check_signature() {
1134                         return Err(SemanticError::InvalidSignature);
1135                 }
1136
1137                 Ok(())
1138         }
1139
1140         /// Constructs an `Invoice` from a `SignedRawInvoice` by checking all its invariants.
1141         /// ```
1142         /// use lightning_invoice::*;
1143         ///
1144         /// let invoice = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
1145         /// h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
1146         /// 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
1147         /// h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
1148         /// j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
1149         /// ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
1150         /// guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
1151         /// ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
1152         /// p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
1153         /// 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
1154         /// j5r6drg6k6zcqj0fcwg";
1155         ///
1156         /// let signed = invoice.parse::<SignedRawInvoice>().unwrap();
1157         ///
1158         /// assert!(Invoice::from_signed(signed).is_ok());
1159         /// ```
1160         pub fn from_signed(signed_invoice: SignedRawInvoice) -> Result<Self, SemanticError> {
1161                 let invoice = Invoice {
1162                         signed_invoice,
1163                 };
1164                 invoice.check_field_counts()?;
1165                 invoice.check_feature_bits()?;
1166                 invoice.check_signature()?;
1167                 invoice.check_amount()?;
1168
1169                 Ok(invoice)
1170         }
1171
1172         /// Returns the `Invoice`'s timestamp (should equal its creation time)
1173         #[cfg(feature = "std")]
1174         pub fn timestamp(&self) -> SystemTime {
1175                 self.signed_invoice.raw_invoice().data.timestamp.as_time()
1176         }
1177
1178         /// Returns the `Invoice`'s timestamp as a duration since the Unix epoch
1179         pub fn duration_since_epoch(&self) -> Duration {
1180                 self.signed_invoice.raw_invoice().data.timestamp.0
1181         }
1182
1183         /// Returns an iterator over all tagged fields of this Invoice.
1184         ///
1185         /// This is not exported to bindings users as there is not yet a manual mapping for a FilterMap
1186         pub fn tagged_fields(&self)
1187                 -> FilterMap<Iter<RawTaggedField>, fn(&RawTaggedField) -> Option<&TaggedField>> {
1188                 self.signed_invoice.raw_invoice().known_tagged_fields()
1189         }
1190
1191         /// Returns the hash to which we will receive the preimage on completion of the payment
1192         pub fn payment_hash(&self) -> &sha256::Hash {
1193                 &self.signed_invoice.payment_hash().expect("checked by constructor").0
1194         }
1195
1196         /// Return the description or a hash of it for longer ones
1197         ///
1198         /// This is not exported to bindings users because we don't yet export InvoiceDescription
1199         pub fn description(&self) -> InvoiceDescription {
1200                 if let Some(direct) = self.signed_invoice.description() {
1201                         return InvoiceDescription::Direct(direct);
1202                 } else if let Some(hash) = self.signed_invoice.description_hash() {
1203                         return InvoiceDescription::Hash(hash);
1204                 }
1205                 unreachable!("ensured by constructor");
1206         }
1207
1208         /// Get the payee's public key if one was included in the invoice
1209         pub fn payee_pub_key(&self) -> Option<&PublicKey> {
1210                 self.signed_invoice.payee_pub_key().map(|x| &x.0)
1211         }
1212
1213         /// Get the payment secret if one was included in the invoice
1214         pub fn payment_secret(&self) -> &PaymentSecret {
1215                 self.signed_invoice.payment_secret().expect("was checked by constructor")
1216         }
1217
1218         /// Get the invoice features if they were included in the invoice
1219         pub fn features(&self) -> Option<&InvoiceFeatures> {
1220                 self.signed_invoice.features()
1221         }
1222
1223         /// Recover the payee's public key (only to be used if none was included in the invoice)
1224         pub fn recover_payee_pub_key(&self) -> PublicKey {
1225                 self.signed_invoice.recover_payee_pub_key().expect("was checked by constructor").0
1226         }
1227
1228         /// Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
1229         pub fn expiry_time(&self) -> Duration {
1230                 self.signed_invoice.expiry_time()
1231                         .map(|x| x.0)
1232                         .unwrap_or(Duration::from_secs(DEFAULT_EXPIRY_TIME))
1233         }
1234
1235         /// Returns whether the invoice has expired.
1236         #[cfg(feature = "std")]
1237         pub fn is_expired(&self) -> bool {
1238                 Self::is_expired_from_epoch(&self.timestamp(), self.expiry_time())
1239         }
1240
1241         /// Returns whether the expiry time from the given epoch has passed.
1242         #[cfg(feature = "std")]
1243         pub(crate) fn is_expired_from_epoch(epoch: &SystemTime, expiry_time: Duration) -> bool {
1244                 match epoch.elapsed() {
1245                         Ok(elapsed) => elapsed > expiry_time,
1246                         Err(_) => false,
1247                 }
1248         }
1249
1250         /// Returns whether the expiry time would pass at the given point in time.
1251         /// `at_time` is the timestamp as a duration since the Unix epoch.
1252         pub fn would_expire(&self, at_time: Duration) -> bool {
1253                 self.duration_since_epoch()
1254                         .checked_add(self.expiry_time())
1255                         .unwrap_or_else(|| Duration::new(u64::max_value(), 1_000_000_000 - 1)) < at_time
1256         }
1257
1258         /// Returns the invoice's `min_final_cltv_expiry_delta` time, if present, otherwise
1259         /// [`DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA`].
1260         pub fn min_final_cltv_expiry_delta(&self) -> u64 {
1261                 self.signed_invoice.min_final_cltv_expiry_delta()
1262                         .map(|x| x.0)
1263                         .unwrap_or(DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA)
1264         }
1265
1266         /// Returns a list of all fallback addresses
1267         ///
1268         /// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
1269         pub fn fallbacks(&self) -> Vec<&Fallback> {
1270                 self.signed_invoice.fallbacks()
1271         }
1272
1273         /// Returns a list of all routes included in the invoice
1274         pub fn private_routes(&self) -> Vec<&PrivateRoute> {
1275                 self.signed_invoice.private_routes()
1276         }
1277
1278         /// Returns a list of all routes included in the invoice as the underlying hints
1279         pub fn route_hints(&self) -> Vec<RouteHint> {
1280                 find_all_extract!(
1281                         self.signed_invoice.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x
1282                 ).map(|route| (**route).clone()).collect()
1283         }
1284
1285         /// Returns the currency for which the invoice was issued
1286         pub fn currency(&self) -> Currency {
1287                 self.signed_invoice.currency()
1288         }
1289
1290         /// Returns the amount if specified in the invoice as millisatoshis.
1291         pub fn amount_milli_satoshis(&self) -> Option<u64> {
1292                 self.signed_invoice.amount_pico_btc().map(|v| v / 10)
1293         }
1294
1295         /// Returns the amount if specified in the invoice as pico BTC.
1296         fn amount_pico_btc(&self) -> Option<u64> {
1297                 self.signed_invoice.amount_pico_btc()
1298         }
1299 }
1300
1301 impl From<TaggedField> for RawTaggedField {
1302         fn from(tf: TaggedField) -> Self {
1303                 RawTaggedField::KnownSemantics(tf)
1304         }
1305 }
1306
1307 impl TaggedField {
1308         /// Numeric representation of the field's tag
1309         pub fn tag(&self) -> u5 {
1310                 let tag = match *self {
1311                         TaggedField::PaymentHash(_) => constants::TAG_PAYMENT_HASH,
1312                         TaggedField::Description(_) => constants::TAG_DESCRIPTION,
1313                         TaggedField::PayeePubKey(_) => constants::TAG_PAYEE_PUB_KEY,
1314                         TaggedField::DescriptionHash(_) => constants::TAG_DESCRIPTION_HASH,
1315                         TaggedField::ExpiryTime(_) => constants::TAG_EXPIRY_TIME,
1316                         TaggedField::MinFinalCltvExpiryDelta(_) => constants::TAG_MIN_FINAL_CLTV_EXPIRY_DELTA,
1317                         TaggedField::Fallback(_) => constants::TAG_FALLBACK,
1318                         TaggedField::PrivateRoute(_) => constants::TAG_PRIVATE_ROUTE,
1319                         TaggedField::PaymentSecret(_) => constants::TAG_PAYMENT_SECRET,
1320                         TaggedField::Features(_) => constants::TAG_FEATURES,
1321                 };
1322
1323                 u5::try_from_u8(tag).expect("all tags defined are <32")
1324         }
1325 }
1326
1327 impl Description {
1328
1329         /// Creates a new `Description` if `description` is at most 1023 __bytes__ long,
1330         /// returns `CreationError::DescriptionTooLong` otherwise
1331         ///
1332         /// Please note that single characters may use more than one byte due to UTF8 encoding.
1333         pub fn new(description: String) -> Result<Description, CreationError> {
1334                 if description.len() > 639 {
1335                         Err(CreationError::DescriptionTooLong)
1336                 } else {
1337                         Ok(Description(description))
1338                 }
1339         }
1340
1341         /// Returns the underlying description `String`
1342         pub fn into_inner(self) -> String {
1343                 self.0
1344         }
1345 }
1346
1347 impl From<Description> for String {
1348         fn from(val: Description) -> Self {
1349                 val.into_inner()
1350         }
1351 }
1352
1353 impl Deref for Description {
1354         type Target = str;
1355
1356         fn deref(&self) -> &str {
1357                 &self.0
1358         }
1359 }
1360
1361 impl From<PublicKey> for PayeePubKey {
1362         fn from(pk: PublicKey) -> Self {
1363                 PayeePubKey(pk)
1364         }
1365 }
1366
1367 impl Deref for PayeePubKey {
1368         type Target = PublicKey;
1369
1370         fn deref(&self) -> &PublicKey {
1371                 &self.0
1372         }
1373 }
1374
1375 impl ExpiryTime {
1376         /// Construct an `ExpiryTime` from seconds.
1377         pub fn from_seconds(seconds: u64) -> ExpiryTime {
1378                 ExpiryTime(Duration::from_secs(seconds))
1379         }
1380
1381         /// Construct an `ExpiryTime` from a `Duration`, dropping the sub-second part.
1382         pub fn from_duration(duration: Duration) -> ExpiryTime {
1383                 Self::from_seconds(duration.as_secs())
1384         }
1385
1386         /// Returns the expiry time in seconds
1387         pub fn as_seconds(&self) -> u64 {
1388                 self.0.as_secs()
1389         }
1390
1391         /// Returns a reference to the underlying `Duration` (=expiry time)
1392         pub fn as_duration(&self) -> &Duration {
1393                 &self.0
1394         }
1395 }
1396
1397 impl PrivateRoute {
1398         /// Creates a new (partial) route from a list of hops
1399         pub fn new(hops: RouteHint) -> Result<PrivateRoute, CreationError> {
1400                 if hops.0.len() <= 12 {
1401                         Ok(PrivateRoute(hops))
1402                 } else {
1403                         Err(CreationError::RouteTooLong)
1404                 }
1405         }
1406
1407         /// Returns the underlying list of hops
1408         pub fn into_inner(self) -> RouteHint {
1409                 self.0
1410         }
1411 }
1412
1413 impl From<PrivateRoute> for RouteHint {
1414         fn from(val: PrivateRoute) -> Self {
1415                 val.into_inner()
1416         }
1417 }
1418
1419 impl Deref for PrivateRoute {
1420         type Target = RouteHint;
1421
1422         fn deref(&self) -> &RouteHint {
1423                 &self.0
1424         }
1425 }
1426
1427 impl Deref for InvoiceSignature {
1428         type Target = RecoverableSignature;
1429
1430         fn deref(&self) -> &RecoverableSignature {
1431                 &self.0
1432         }
1433 }
1434
1435 impl Deref for SignedRawInvoice {
1436         type Target = RawInvoice;
1437
1438         fn deref(&self) -> &RawInvoice {
1439                 &self.raw_invoice
1440         }
1441 }
1442
1443 /// Errors that may occur when constructing a new `RawInvoice` or `Invoice`
1444 #[derive(Eq, PartialEq, Debug, Clone)]
1445 pub enum CreationError {
1446         /// The supplied description string was longer than 639 __bytes__ (see [`Description::new(…)`](./struct.Description.html#method.new))
1447         DescriptionTooLong,
1448
1449         /// The specified route has too many hops and can't be encoded
1450         RouteTooLong,
1451
1452         /// The Unix timestamp of the supplied date is less than zero or greater than 35-bits
1453         TimestampOutOfBounds,
1454
1455         /// The supplied millisatoshi amount was greater than the total bitcoin supply.
1456         InvalidAmount,
1457
1458         /// Route hints were required for this invoice and were missing. Applies to
1459         /// [phantom invoices].
1460         ///
1461         /// [phantom invoices]: crate::utils::create_phantom_invoice
1462         MissingRouteHints,
1463
1464         /// The provided `min_final_cltv_expiry_delta` was less than [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
1465         ///
1466         /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
1467         MinFinalCltvExpiryDeltaTooShort,
1468 }
1469
1470 impl Display for CreationError {
1471         fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1472                 match self {
1473                         CreationError::DescriptionTooLong => f.write_str("The supplied description string was longer than 639 bytes"),
1474                         CreationError::RouteTooLong => f.write_str("The specified route has too many hops and can't be encoded"),
1475                         CreationError::TimestampOutOfBounds => f.write_str("The Unix timestamp of the supplied date is less than zero or greater than 35-bits"),
1476                         CreationError::InvalidAmount => f.write_str("The supplied millisatoshi amount was greater than the total bitcoin supply"),
1477                         CreationError::MissingRouteHints => f.write_str("The invoice required route hints and they weren't provided"),
1478                         CreationError::MinFinalCltvExpiryDeltaTooShort => f.write_str(
1479                                 "The supplied final CLTV expiry delta was less than LDK's `MIN_FINAL_CLTV_EXPIRY_DELTA`"),
1480                 }
1481         }
1482 }
1483
1484 #[cfg(feature = "std")]
1485 impl std::error::Error for CreationError { }
1486
1487 /// Errors that may occur when converting a `RawInvoice` to an `Invoice`. They relate to the
1488 /// requirements sections in BOLT #11
1489 #[derive(Eq, PartialEq, Debug, Clone)]
1490 pub enum SemanticError {
1491         /// The invoice is missing the mandatory payment hash
1492         NoPaymentHash,
1493
1494         /// The invoice has multiple payment hashes which isn't allowed
1495         MultiplePaymentHashes,
1496
1497         /// No description or description hash are part of the invoice
1498         NoDescription,
1499
1500         /// The invoice contains multiple descriptions and/or description hashes which isn't allowed
1501         MultipleDescriptions,
1502
1503         /// The invoice is missing the mandatory payment secret, which all modern lightning nodes
1504         /// should provide.
1505         NoPaymentSecret,
1506
1507         /// The invoice contains multiple payment secrets
1508         MultiplePaymentSecrets,
1509
1510         /// The invoice's features are invalid
1511         InvalidFeatures,
1512
1513         /// The recovery id doesn't fit the signature/pub key
1514         InvalidRecoveryId,
1515
1516         /// The invoice's signature is invalid
1517         InvalidSignature,
1518
1519         /// The invoice's amount was not a whole number of millisatoshis
1520         ImpreciseAmount,
1521 }
1522
1523 impl Display for SemanticError {
1524         fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1525                 match self {
1526                         SemanticError::NoPaymentHash => f.write_str("The invoice is missing the mandatory payment hash"),
1527                         SemanticError::MultiplePaymentHashes => f.write_str("The invoice has multiple payment hashes which isn't allowed"),
1528                         SemanticError::NoDescription => f.write_str("No description or description hash are part of the invoice"),
1529                         SemanticError::MultipleDescriptions => f.write_str("The invoice contains multiple descriptions and/or description hashes which isn't allowed"),
1530                         SemanticError::NoPaymentSecret => f.write_str("The invoice is missing the mandatory payment secret"),
1531                         SemanticError::MultiplePaymentSecrets => f.write_str("The invoice contains multiple payment secrets"),
1532                         SemanticError::InvalidFeatures => f.write_str("The invoice's features are invalid"),
1533                         SemanticError::InvalidRecoveryId => f.write_str("The recovery id doesn't fit the signature/pub key"),
1534                         SemanticError::InvalidSignature => f.write_str("The invoice's signature is invalid"),
1535                         SemanticError::ImpreciseAmount => f.write_str("The invoice's amount was not a whole number of millisatoshis"),
1536                 }
1537         }
1538 }
1539
1540 #[cfg(feature = "std")]
1541 impl std::error::Error for SemanticError { }
1542
1543 /// When signing using a fallible method either an user-supplied `SignError` or a `CreationError`
1544 /// may occur.
1545 #[derive(Eq, PartialEq, Debug, Clone)]
1546 pub enum SignOrCreationError<S = ()> {
1547         /// An error occurred during signing
1548         SignError(S),
1549
1550         /// An error occurred while building the transaction
1551         CreationError(CreationError),
1552 }
1553
1554 impl<S> Display for SignOrCreationError<S> {
1555         fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1556                 match self {
1557                         SignOrCreationError::SignError(_) => f.write_str("An error occurred during signing"),
1558                         SignOrCreationError::CreationError(err) => err.fmt(f),
1559                 }
1560         }
1561 }
1562
1563 #[cfg(feature = "serde")]
1564 impl Serialize for Invoice {
1565         fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer {
1566                 serializer.serialize_str(self.to_string().as_str())
1567         }
1568 }
1569 #[cfg(feature = "serde")]
1570 impl<'de> Deserialize<'de> for Invoice {
1571         fn deserialize<D>(deserializer: D) -> Result<Invoice, D::Error> where D: Deserializer<'de> {
1572                 let bolt11 = String::deserialize(deserializer)?
1573                         .parse::<Invoice>()
1574                         .map_err(|e| D::Error::custom(format!("{:?}", e)))?;
1575
1576                 Ok(bolt11)
1577         }
1578 }
1579
1580 #[cfg(test)]
1581 mod test {
1582         use bitcoin_hashes::hex::FromHex;
1583         use bitcoin_hashes::sha256;
1584
1585         #[test]
1586         fn test_system_time_bounds_assumptions() {
1587                 assert_eq!(
1588                         crate::PositiveTimestamp::from_unix_timestamp(crate::MAX_TIMESTAMP + 1),
1589                         Err(crate::CreationError::TimestampOutOfBounds)
1590                 );
1591         }
1592
1593         #[test]
1594         fn test_calc_invoice_hash() {
1595                 use crate::{RawInvoice, RawHrp, RawDataPart, Currency, PositiveTimestamp};
1596                 use crate::TaggedField::*;
1597
1598                 let invoice = RawInvoice {
1599                         hrp: RawHrp {
1600                                 currency: Currency::Bitcoin,
1601                                 raw_amount: None,
1602                                 si_prefix: None,
1603                         },
1604                         data: RawDataPart {
1605                                 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1606                                 tagged_fields: vec![
1607                                         PaymentHash(crate::Sha256(sha256::Hash::from_hex(
1608                                                 "0001020304050607080900010203040506070809000102030405060708090102"
1609                                         ).unwrap())).into(),
1610                                         Description(crate::Description::new(
1611                                                 "Please consider supporting this project".to_owned()
1612                                         ).unwrap()).into(),
1613                                 ],
1614                         },
1615                 };
1616
1617                 let expected_hash = [
1618                         0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27, 0x7b, 0x1d,
1619                         0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7, 0x83, 0x5d, 0xb2, 0xec,
1620                         0xd5, 0x18, 0xe1, 0xc9
1621                 ];
1622
1623                 assert_eq!(invoice.signable_hash(), expected_hash)
1624         }
1625
1626         #[test]
1627         fn test_check_signature() {
1628                 use crate::TaggedField::*;
1629                 use secp256k1::Secp256k1;
1630                 use secp256k1::ecdsa::{RecoveryId, RecoverableSignature};
1631                 use secp256k1::{SecretKey, PublicKey};
1632                 use crate::{SignedRawInvoice, InvoiceSignature, RawInvoice, RawHrp, RawDataPart, Currency, Sha256,
1633                          PositiveTimestamp};
1634
1635                 let invoice = SignedRawInvoice {
1636                         raw_invoice: RawInvoice {
1637                                 hrp: RawHrp {
1638                                         currency: Currency::Bitcoin,
1639                                         raw_amount: None,
1640                                         si_prefix: None,
1641                                 },
1642                                 data: RawDataPart {
1643                                         timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1644                                         tagged_fields: vec ! [
1645                                                 PaymentHash(Sha256(sha256::Hash::from_hex(
1646                                                         "0001020304050607080900010203040506070809000102030405060708090102"
1647                                                 ).unwrap())).into(),
1648                                                 Description(
1649                                                         crate::Description::new(
1650                                                                 "Please consider supporting this project".to_owned()
1651                                                         ).unwrap()
1652                                                 ).into(),
1653                                         ],
1654                                 },
1655                         },
1656                         hash: [
1657                                 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27,
1658                                 0x7b, 0x1d, 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7,
1659                                 0x83, 0x5d, 0xb2, 0xec, 0xd5, 0x18, 0xe1, 0xc9
1660                         ],
1661                         signature: InvoiceSignature(RecoverableSignature::from_compact(
1662                                 & [
1663                                         0x38u8, 0xec, 0x68, 0x91, 0x34, 0x5e, 0x20, 0x41, 0x45, 0xbe, 0x8a,
1664                                         0x3a, 0x99, 0xde, 0x38, 0xe9, 0x8a, 0x39, 0xd6, 0xa5, 0x69, 0x43,
1665                                         0x4e, 0x18, 0x45, 0xc8, 0xaf, 0x72, 0x05, 0xaf, 0xcf, 0xcc, 0x7f,
1666                                         0x42, 0x5f, 0xcd, 0x14, 0x63, 0xe9, 0x3c, 0x32, 0x88, 0x1e, 0xad,
1667                                         0x0d, 0x6e, 0x35, 0x6d, 0x46, 0x7e, 0xc8, 0xc0, 0x25, 0x53, 0xf9,
1668                                         0xaa, 0xb1, 0x5e, 0x57, 0x38, 0xb1, 0x1f, 0x12, 0x7f
1669                                 ],
1670                                 RecoveryId::from_i32(0).unwrap()
1671                         ).unwrap()),
1672                 };
1673
1674                 assert!(invoice.check_signature());
1675
1676                 let private_key = SecretKey::from_slice(
1677                         &[
1678                                 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1679                                 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1680                                 0x3b, 0x2d, 0xb7, 0x34
1681                         ][..]
1682                 ).unwrap();
1683                 let public_key = PublicKey::from_secret_key(&Secp256k1::new(), &private_key);
1684
1685                 assert_eq!(invoice.recover_payee_pub_key(), Ok(crate::PayeePubKey(public_key)));
1686
1687                 let (raw_invoice, _, _) = invoice.into_parts();
1688                 let new_signed = raw_invoice.sign::<_, ()>(|hash| {
1689                         Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key))
1690                 }).unwrap();
1691
1692                 assert!(new_signed.check_signature());
1693         }
1694
1695         #[test]
1696         fn test_check_feature_bits() {
1697                 use crate::TaggedField::*;
1698                 use lightning::ln::features::InvoiceFeatures;
1699                 use secp256k1::Secp256k1;
1700                 use secp256k1::SecretKey;
1701                 use crate::{RawInvoice, RawHrp, RawDataPart, Currency, Sha256, PositiveTimestamp, Invoice,
1702                          SemanticError};
1703
1704                 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
1705                 let payment_secret = lightning::ln::PaymentSecret([21; 32]);
1706                 let invoice_template = RawInvoice {
1707                         hrp: RawHrp {
1708                                 currency: Currency::Bitcoin,
1709                                 raw_amount: None,
1710                                 si_prefix: None,
1711                         },
1712                         data: RawDataPart {
1713                                 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1714                                 tagged_fields: vec ! [
1715                                         PaymentHash(Sha256(sha256::Hash::from_hex(
1716                                                 "0001020304050607080900010203040506070809000102030405060708090102"
1717                                         ).unwrap())).into(),
1718                                         Description(
1719                                                 crate::Description::new(
1720                                                         "Please consider supporting this project".to_owned()
1721                                                 ).unwrap()
1722                                         ).into(),
1723                                 ],
1724                         },
1725                 };
1726
1727                 // Missing features
1728                 let invoice = {
1729                         let mut invoice = invoice_template.clone();
1730                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1731                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1732                 }.unwrap();
1733                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::InvalidFeatures));
1734
1735                 // Missing feature bits
1736                 let invoice = {
1737                         let mut invoice = invoice_template.clone();
1738                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1739                         invoice.data.tagged_fields.push(Features(InvoiceFeatures::empty()).into());
1740                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1741                 }.unwrap();
1742                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::InvalidFeatures));
1743
1744                 let mut payment_secret_features = InvoiceFeatures::empty();
1745                 payment_secret_features.set_payment_secret_required();
1746
1747                 // Including payment secret and feature bits
1748                 let invoice = {
1749                         let mut invoice = invoice_template.clone();
1750                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1751                         invoice.data.tagged_fields.push(Features(payment_secret_features.clone()).into());
1752                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1753                 }.unwrap();
1754                 assert!(Invoice::from_signed(invoice).is_ok());
1755
1756                 // No payment secret or features
1757                 let invoice = {
1758                         let invoice = invoice_template.clone();
1759                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1760                 }.unwrap();
1761                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::NoPaymentSecret));
1762
1763                 // No payment secret or feature bits
1764                 let invoice = {
1765                         let mut invoice = invoice_template.clone();
1766                         invoice.data.tagged_fields.push(Features(InvoiceFeatures::empty()).into());
1767                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1768                 }.unwrap();
1769                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::NoPaymentSecret));
1770
1771                 // Missing payment secret
1772                 let invoice = {
1773                         let mut invoice = invoice_template.clone();
1774                         invoice.data.tagged_fields.push(Features(payment_secret_features).into());
1775                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1776                 }.unwrap();
1777                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::NoPaymentSecret));
1778
1779                 // Multiple payment secrets
1780                 let invoice = {
1781                         let mut invoice = invoice_template;
1782                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1783                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1784                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1785                 }.unwrap();
1786                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::MultiplePaymentSecrets));
1787         }
1788
1789         #[test]
1790         fn test_builder_amount() {
1791                 use crate::*;
1792
1793                 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1794                         .description("Test".into())
1795                         .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1796                         .duration_since_epoch(Duration::from_secs(1234567));
1797
1798                 let invoice = builder.clone()
1799                         .amount_milli_satoshis(1500)
1800                         .build_raw()
1801                         .unwrap();
1802
1803                 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Nano));
1804                 assert_eq!(invoice.hrp.raw_amount, Some(15));
1805
1806
1807                 let invoice = builder
1808                         .amount_milli_satoshis(150)
1809                         .build_raw()
1810                         .unwrap();
1811
1812                 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Pico));
1813                 assert_eq!(invoice.hrp.raw_amount, Some(1500));
1814         }
1815
1816         #[test]
1817         fn test_builder_fail() {
1818                 use crate::*;
1819                 use lightning::routing::router::RouteHintHop;
1820                 use std::iter::FromIterator;
1821                 use secp256k1::PublicKey;
1822
1823                 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1824                         .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1825                         .duration_since_epoch(Duration::from_secs(1234567))
1826                         .min_final_cltv_expiry_delta(144);
1827
1828                 let too_long_string = String::from_iter(
1829                         (0..1024).map(|_| '?')
1830                 );
1831
1832                 let long_desc_res = builder.clone()
1833                         .description(too_long_string)
1834                         .build_raw();
1835                 assert_eq!(long_desc_res, Err(CreationError::DescriptionTooLong));
1836
1837                 let route_hop = RouteHintHop {
1838                         src_node_id: PublicKey::from_slice(
1839                                         &[
1840                                                 0x03, 0x9e, 0x03, 0xa9, 0x01, 0xb8, 0x55, 0x34, 0xff, 0x1e, 0x92, 0xc4,
1841                                                 0x3c, 0x74, 0x43, 0x1f, 0x7c, 0xe7, 0x20, 0x46, 0x06, 0x0f, 0xcf, 0x7a,
1842                                                 0x95, 0xc3, 0x7e, 0x14, 0x8f, 0x78, 0xc7, 0x72, 0x55
1843                                         ][..]
1844                                 ).unwrap(),
1845                         short_channel_id: 0,
1846                         fees: RoutingFees {
1847                                 base_msat: 0,
1848                                 proportional_millionths: 0,
1849                         },
1850                         cltv_expiry_delta: 0,
1851                         htlc_minimum_msat: None,
1852                         htlc_maximum_msat: None,
1853                 };
1854                 let too_long_route = RouteHint(vec![route_hop; 13]);
1855                 let long_route_res = builder.clone()
1856                         .description("Test".into())
1857                         .private_route(too_long_route)
1858                         .build_raw();
1859                 assert_eq!(long_route_res, Err(CreationError::RouteTooLong));
1860
1861                 let sign_error_res = builder
1862                         .description("Test".into())
1863                         .payment_secret(PaymentSecret([0; 32]))
1864                         .try_build_signed(|_| {
1865                                 Err("ImaginaryError")
1866                         });
1867                 assert_eq!(sign_error_res, Err(SignOrCreationError::SignError("ImaginaryError")));
1868         }
1869
1870         #[test]
1871         fn test_builder_ok() {
1872                 use crate::*;
1873                 use lightning::routing::router::RouteHintHop;
1874                 use secp256k1::Secp256k1;
1875                 use secp256k1::{SecretKey, PublicKey};
1876                 use std::time::{UNIX_EPOCH, Duration};
1877
1878                 let secp_ctx = Secp256k1::new();
1879
1880                 let private_key = SecretKey::from_slice(
1881                         &[
1882                                 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1883                                 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1884                                 0x3b, 0x2d, 0xb7, 0x34
1885                         ][..]
1886                 ).unwrap();
1887                 let public_key = PublicKey::from_secret_key(&secp_ctx, &private_key);
1888
1889                 let route_1 = RouteHint(vec![
1890                         RouteHintHop {
1891                                 src_node_id: public_key,
1892                                 short_channel_id: de::parse_int_be(&[123; 8], 256).expect("short chan ID slice too big?"),
1893                                 fees: RoutingFees {
1894                                         base_msat: 2,
1895                                         proportional_millionths: 1,
1896                                 },
1897                                 cltv_expiry_delta: 145,
1898                                 htlc_minimum_msat: None,
1899                                 htlc_maximum_msat: None,
1900                         },
1901                         RouteHintHop {
1902                                 src_node_id: public_key,
1903                                 short_channel_id: de::parse_int_be(&[42; 8], 256).expect("short chan ID slice too big?"),
1904                                 fees: RoutingFees {
1905                                         base_msat: 3,
1906                                         proportional_millionths: 2,
1907                                 },
1908                                 cltv_expiry_delta: 146,
1909                                 htlc_minimum_msat: None,
1910                                 htlc_maximum_msat: None,
1911                         }
1912                 ]);
1913
1914                 let route_2 = RouteHint(vec![
1915                         RouteHintHop {
1916                                 src_node_id: public_key,
1917                                 short_channel_id: 0,
1918                                 fees: RoutingFees {
1919                                         base_msat: 4,
1920                                         proportional_millionths: 3,
1921                                 },
1922                                 cltv_expiry_delta: 147,
1923                                 htlc_minimum_msat: None,
1924                                 htlc_maximum_msat: None,
1925                         },
1926                         RouteHintHop {
1927                                 src_node_id: public_key,
1928                                 short_channel_id: de::parse_int_be(&[1; 8], 256).expect("short chan ID slice too big?"),
1929                                 fees: RoutingFees {
1930                                         base_msat: 5,
1931                                         proportional_millionths: 4,
1932                                 },
1933                                 cltv_expiry_delta: 148,
1934                                 htlc_minimum_msat: None,
1935                                 htlc_maximum_msat: None,
1936                         }
1937                 ]);
1938
1939                 let builder = InvoiceBuilder::new(Currency::BitcoinTestnet)
1940                         .amount_milli_satoshis(123)
1941                         .duration_since_epoch(Duration::from_secs(1234567))
1942                         .payee_pub_key(public_key)
1943                         .expiry_time(Duration::from_secs(54321))
1944                         .min_final_cltv_expiry_delta(144)
1945                         .fallback(Fallback::PubKeyHash([0;20]))
1946                         .private_route(route_1.clone())
1947                         .private_route(route_2.clone())
1948                         .description_hash(sha256::Hash::from_slice(&[3;32][..]).unwrap())
1949                         .payment_hash(sha256::Hash::from_slice(&[21;32][..]).unwrap())
1950                         .payment_secret(PaymentSecret([42; 32]))
1951                         .basic_mpp();
1952
1953                 let invoice = builder.clone().build_signed(|hash| {
1954                         secp_ctx.sign_ecdsa_recoverable(hash, &private_key)
1955                 }).unwrap();
1956
1957                 assert!(invoice.check_signature().is_ok());
1958                 assert_eq!(invoice.tagged_fields().count(), 10);
1959
1960                 assert_eq!(invoice.amount_milli_satoshis(), Some(123));
1961                 assert_eq!(invoice.amount_pico_btc(), Some(1230));
1962                 assert_eq!(invoice.currency(), Currency::BitcoinTestnet);
1963                 #[cfg(feature = "std")]
1964                 assert_eq!(
1965                         invoice.timestamp().duration_since(UNIX_EPOCH).unwrap().as_secs(),
1966                         1234567
1967                 );
1968                 assert_eq!(invoice.payee_pub_key(), Some(&public_key));
1969                 assert_eq!(invoice.expiry_time(), Duration::from_secs(54321));
1970                 assert_eq!(invoice.min_final_cltv_expiry_delta(), 144);
1971                 assert_eq!(invoice.fallbacks(), vec![&Fallback::PubKeyHash([0;20])]);
1972                 assert_eq!(invoice.private_routes(), vec![&PrivateRoute(route_1), &PrivateRoute(route_2)]);
1973                 assert_eq!(
1974                         invoice.description(),
1975                         InvoiceDescription::Hash(&Sha256(sha256::Hash::from_slice(&[3;32][..]).unwrap()))
1976                 );
1977                 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21;32][..]).unwrap());
1978                 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));
1979
1980                 let mut expected_features = InvoiceFeatures::empty();
1981                 expected_features.set_variable_length_onion_required();
1982                 expected_features.set_payment_secret_required();
1983                 expected_features.set_basic_mpp_optional();
1984                 assert_eq!(invoice.features(), Some(&expected_features));
1985
1986                 let raw_invoice = builder.build_raw().unwrap();
1987                 assert_eq!(raw_invoice, *invoice.into_signed_raw().raw_invoice())
1988         }
1989
1990         #[test]
1991         fn test_default_values() {
1992                 use crate::*;
1993                 use secp256k1::Secp256k1;
1994                 use secp256k1::SecretKey;
1995
1996                 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
1997                         .description("Test".into())
1998                         .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1999                         .payment_secret(PaymentSecret([0; 32]))
2000                         .duration_since_epoch(Duration::from_secs(1234567))
2001                         .build_raw()
2002                         .unwrap()
2003                         .sign::<_, ()>(|hash| {
2004                                 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
2005                                 let secp_ctx = Secp256k1::new();
2006                                 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
2007                         })
2008                         .unwrap();
2009                 let invoice = Invoice::from_signed(signed_invoice).unwrap();
2010
2011                 assert_eq!(invoice.min_final_cltv_expiry_delta(), DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA);
2012                 assert_eq!(invoice.expiry_time(), Duration::from_secs(DEFAULT_EXPIRY_TIME));
2013                 assert!(!invoice.would_expire(Duration::from_secs(1234568)));
2014         }
2015
2016         #[test]
2017         fn test_expiration() {
2018                 use crate::*;
2019                 use secp256k1::Secp256k1;
2020                 use secp256k1::SecretKey;
2021
2022                 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
2023                         .description("Test".into())
2024                         .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2025                         .payment_secret(PaymentSecret([0; 32]))
2026                         .duration_since_epoch(Duration::from_secs(1234567))
2027                         .build_raw()
2028                         .unwrap()
2029                         .sign::<_, ()>(|hash| {
2030                                 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
2031                                 let secp_ctx = Secp256k1::new();
2032                                 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
2033                         })
2034                         .unwrap();
2035                 let invoice = Invoice::from_signed(signed_invoice).unwrap();
2036
2037                 assert!(invoice.would_expire(Duration::from_secs(1234567 + DEFAULT_EXPIRY_TIME + 1)));
2038         }
2039
2040         #[cfg(feature = "serde")]
2041         #[test]
2042         fn test_serde() {
2043                 let invoice_str = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
2044                         h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
2045                         5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
2046                         h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
2047                         j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
2048                         ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
2049                         guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
2050                         ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
2051                         p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
2052                         8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
2053                         j5r6drg6k6zcqj0fcwg";
2054                 let invoice = invoice_str.parse::<super::Invoice>().unwrap();
2055                 let serialized_invoice = serde_json::to_string(&invoice).unwrap();
2056                 let deserialized_invoice: super::Invoice = serde_json::from_str(serialized_invoice.as_str()).unwrap();
2057                 assert_eq!(invoice, deserialized_invoice);
2058                 assert_eq!(invoice_str, deserialized_invoice.to_string().as_str());
2059                 assert_eq!(invoice_str, serialized_invoice.as_str().trim_matches('\"'));
2060         }
2061 }