_ 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 Duration since the Unix epoch at which the invoice expires.
1229         /// Returning None if overflow occurred.
1230         pub fn expires_at(&self) -> Option<Duration> {
1231                 self.duration_since_epoch().checked_add(self.expiry_time())
1232         }
1233
1234         /// Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
1235         pub fn expiry_time(&self) -> Duration {
1236                 self.signed_invoice.expiry_time()
1237                         .map(|x| x.0)
1238                         .unwrap_or(Duration::from_secs(DEFAULT_EXPIRY_TIME))
1239         }
1240
1241         /// Returns whether the invoice has expired.
1242         #[cfg(feature = "std")]
1243         pub fn is_expired(&self) -> bool {
1244                 Self::is_expired_from_epoch(&self.timestamp(), self.expiry_time())
1245         }
1246
1247         /// Returns whether the expiry time from the given epoch has passed.
1248         #[cfg(feature = "std")]
1249         pub(crate) fn is_expired_from_epoch(epoch: &SystemTime, expiry_time: Duration) -> bool {
1250                 match epoch.elapsed() {
1251                         Ok(elapsed) => elapsed > expiry_time,
1252                         Err(_) => false,
1253                 }
1254         }
1255
1256         /// Returns the Duration remaining until the invoice expires.
1257         #[cfg(feature = "std")]
1258         pub fn duration_until_expiry(&self) -> Duration {
1259                 SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)
1260                         .map(|now| self.expiration_remaining_from_epoch(now))
1261                         .unwrap_or(Duration::from_nanos(0))
1262         }
1263
1264         /// Returns the Duration remaining until the invoice expires given the current time.
1265         /// `time` is the timestamp as a duration since the Unix epoch.
1266         pub fn expiration_remaining_from_epoch(&self, time: Duration) -> Duration {
1267                 self.expires_at().map(|x| x.checked_sub(time)).flatten().unwrap_or(Duration::from_nanos(0))
1268         }
1269
1270         /// Returns whether the expiry time would pass at the given point in time.
1271         /// `at_time` is the timestamp as a duration since the Unix epoch.
1272         pub fn would_expire(&self, at_time: Duration) -> bool {
1273                 self.duration_since_epoch()
1274                         .checked_add(self.expiry_time())
1275                         .unwrap_or_else(|| Duration::new(u64::max_value(), 1_000_000_000 - 1)) < at_time
1276         }
1277
1278         /// Returns the invoice's `min_final_cltv_expiry_delta` time, if present, otherwise
1279         /// [`DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA`].
1280         pub fn min_final_cltv_expiry_delta(&self) -> u64 {
1281                 self.signed_invoice.min_final_cltv_expiry_delta()
1282                         .map(|x| x.0)
1283                         .unwrap_or(DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA)
1284         }
1285
1286         /// Returns a list of all fallback addresses
1287         ///
1288         /// This is not exported to bindings users as we don't support Vec<&NonOpaqueType>
1289         pub fn fallbacks(&self) -> Vec<&Fallback> {
1290                 self.signed_invoice.fallbacks()
1291         }
1292
1293         /// Returns a list of all routes included in the invoice
1294         pub fn private_routes(&self) -> Vec<&PrivateRoute> {
1295                 self.signed_invoice.private_routes()
1296         }
1297
1298         /// Returns a list of all routes included in the invoice as the underlying hints
1299         pub fn route_hints(&self) -> Vec<RouteHint> {
1300                 find_all_extract!(
1301                         self.signed_invoice.known_tagged_fields(), TaggedField::PrivateRoute(ref x), x
1302                 ).map(|route| (**route).clone()).collect()
1303         }
1304
1305         /// Returns the currency for which the invoice was issued
1306         pub fn currency(&self) -> Currency {
1307                 self.signed_invoice.currency()
1308         }
1309
1310         /// Returns the amount if specified in the invoice as millisatoshis.
1311         pub fn amount_milli_satoshis(&self) -> Option<u64> {
1312                 self.signed_invoice.amount_pico_btc().map(|v| v / 10)
1313         }
1314
1315         /// Returns the amount if specified in the invoice as pico BTC.
1316         fn amount_pico_btc(&self) -> Option<u64> {
1317                 self.signed_invoice.amount_pico_btc()
1318         }
1319 }
1320
1321 impl From<TaggedField> for RawTaggedField {
1322         fn from(tf: TaggedField) -> Self {
1323                 RawTaggedField::KnownSemantics(tf)
1324         }
1325 }
1326
1327 impl TaggedField {
1328         /// Numeric representation of the field's tag
1329         pub fn tag(&self) -> u5 {
1330                 let tag = match *self {
1331                         TaggedField::PaymentHash(_) => constants::TAG_PAYMENT_HASH,
1332                         TaggedField::Description(_) => constants::TAG_DESCRIPTION,
1333                         TaggedField::PayeePubKey(_) => constants::TAG_PAYEE_PUB_KEY,
1334                         TaggedField::DescriptionHash(_) => constants::TAG_DESCRIPTION_HASH,
1335                         TaggedField::ExpiryTime(_) => constants::TAG_EXPIRY_TIME,
1336                         TaggedField::MinFinalCltvExpiryDelta(_) => constants::TAG_MIN_FINAL_CLTV_EXPIRY_DELTA,
1337                         TaggedField::Fallback(_) => constants::TAG_FALLBACK,
1338                         TaggedField::PrivateRoute(_) => constants::TAG_PRIVATE_ROUTE,
1339                         TaggedField::PaymentSecret(_) => constants::TAG_PAYMENT_SECRET,
1340                         TaggedField::Features(_) => constants::TAG_FEATURES,
1341                 };
1342
1343                 u5::try_from_u8(tag).expect("all tags defined are <32")
1344         }
1345 }
1346
1347 impl Description {
1348
1349         /// Creates a new `Description` if `description` is at most 1023 __bytes__ long,
1350         /// returns `CreationError::DescriptionTooLong` otherwise
1351         ///
1352         /// Please note that single characters may use more than one byte due to UTF8 encoding.
1353         pub fn new(description: String) -> Result<Description, CreationError> {
1354                 if description.len() > 639 {
1355                         Err(CreationError::DescriptionTooLong)
1356                 } else {
1357                         Ok(Description(description))
1358                 }
1359         }
1360
1361         /// Returns the underlying description `String`
1362         pub fn into_inner(self) -> String {
1363                 self.0
1364         }
1365 }
1366
1367 impl From<Description> for String {
1368         fn from(val: Description) -> Self {
1369                 val.into_inner()
1370         }
1371 }
1372
1373 impl Deref for Description {
1374         type Target = str;
1375
1376         fn deref(&self) -> &str {
1377                 &self.0
1378         }
1379 }
1380
1381 impl From<PublicKey> for PayeePubKey {
1382         fn from(pk: PublicKey) -> Self {
1383                 PayeePubKey(pk)
1384         }
1385 }
1386
1387 impl Deref for PayeePubKey {
1388         type Target = PublicKey;
1389
1390         fn deref(&self) -> &PublicKey {
1391                 &self.0
1392         }
1393 }
1394
1395 impl ExpiryTime {
1396         /// Construct an `ExpiryTime` from seconds.
1397         pub fn from_seconds(seconds: u64) -> ExpiryTime {
1398                 ExpiryTime(Duration::from_secs(seconds))
1399         }
1400
1401         /// Construct an `ExpiryTime` from a `Duration`, dropping the sub-second part.
1402         pub fn from_duration(duration: Duration) -> ExpiryTime {
1403                 Self::from_seconds(duration.as_secs())
1404         }
1405
1406         /// Returns the expiry time in seconds
1407         pub fn as_seconds(&self) -> u64 {
1408                 self.0.as_secs()
1409         }
1410
1411         /// Returns a reference to the underlying `Duration` (=expiry time)
1412         pub fn as_duration(&self) -> &Duration {
1413                 &self.0
1414         }
1415 }
1416
1417 impl PrivateRoute {
1418         /// Creates a new (partial) route from a list of hops
1419         pub fn new(hops: RouteHint) -> Result<PrivateRoute, CreationError> {
1420                 if hops.0.len() <= 12 {
1421                         Ok(PrivateRoute(hops))
1422                 } else {
1423                         Err(CreationError::RouteTooLong)
1424                 }
1425         }
1426
1427         /// Returns the underlying list of hops
1428         pub fn into_inner(self) -> RouteHint {
1429                 self.0
1430         }
1431 }
1432
1433 impl From<PrivateRoute> for RouteHint {
1434         fn from(val: PrivateRoute) -> Self {
1435                 val.into_inner()
1436         }
1437 }
1438
1439 impl Deref for PrivateRoute {
1440         type Target = RouteHint;
1441
1442         fn deref(&self) -> &RouteHint {
1443                 &self.0
1444         }
1445 }
1446
1447 impl Deref for InvoiceSignature {
1448         type Target = RecoverableSignature;
1449
1450         fn deref(&self) -> &RecoverableSignature {
1451                 &self.0
1452         }
1453 }
1454
1455 impl Deref for SignedRawInvoice {
1456         type Target = RawInvoice;
1457
1458         fn deref(&self) -> &RawInvoice {
1459                 &self.raw_invoice
1460         }
1461 }
1462
1463 /// Errors that may occur when constructing a new `RawInvoice` or `Invoice`
1464 #[derive(Eq, PartialEq, Debug, Clone)]
1465 pub enum CreationError {
1466         /// The supplied description string was longer than 639 __bytes__ (see [`Description::new(…)`](./struct.Description.html#method.new))
1467         DescriptionTooLong,
1468
1469         /// The specified route has too many hops and can't be encoded
1470         RouteTooLong,
1471
1472         /// The Unix timestamp of the supplied date is less than zero or greater than 35-bits
1473         TimestampOutOfBounds,
1474
1475         /// The supplied millisatoshi amount was greater than the total bitcoin supply.
1476         InvalidAmount,
1477
1478         /// Route hints were required for this invoice and were missing. Applies to
1479         /// [phantom invoices].
1480         ///
1481         /// [phantom invoices]: crate::utils::create_phantom_invoice
1482         MissingRouteHints,
1483
1484         /// The provided `min_final_cltv_expiry_delta` was less than [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
1485         ///
1486         /// [`MIN_FINAL_CLTV_EXPIRY_DELTA`]: lightning::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA
1487         MinFinalCltvExpiryDeltaTooShort,
1488 }
1489
1490 impl Display for CreationError {
1491         fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1492                 match self {
1493                         CreationError::DescriptionTooLong => f.write_str("The supplied description string was longer than 639 bytes"),
1494                         CreationError::RouteTooLong => f.write_str("The specified route has too many hops and can't be encoded"),
1495                         CreationError::TimestampOutOfBounds => f.write_str("The Unix timestamp of the supplied date is less than zero or greater than 35-bits"),
1496                         CreationError::InvalidAmount => f.write_str("The supplied millisatoshi amount was greater than the total bitcoin supply"),
1497                         CreationError::MissingRouteHints => f.write_str("The invoice required route hints and they weren't provided"),
1498                         CreationError::MinFinalCltvExpiryDeltaTooShort => f.write_str(
1499                                 "The supplied final CLTV expiry delta was less than LDK's `MIN_FINAL_CLTV_EXPIRY_DELTA`"),
1500                 }
1501         }
1502 }
1503
1504 #[cfg(feature = "std")]
1505 impl std::error::Error for CreationError { }
1506
1507 /// Errors that may occur when converting a `RawInvoice` to an `Invoice`. They relate to the
1508 /// requirements sections in BOLT #11
1509 #[derive(Eq, PartialEq, Debug, Clone)]
1510 pub enum SemanticError {
1511         /// The invoice is missing the mandatory payment hash
1512         NoPaymentHash,
1513
1514         /// The invoice has multiple payment hashes which isn't allowed
1515         MultiplePaymentHashes,
1516
1517         /// No description or description hash are part of the invoice
1518         NoDescription,
1519
1520         /// The invoice contains multiple descriptions and/or description hashes which isn't allowed
1521         MultipleDescriptions,
1522
1523         /// The invoice is missing the mandatory payment secret, which all modern lightning nodes
1524         /// should provide.
1525         NoPaymentSecret,
1526
1527         /// The invoice contains multiple payment secrets
1528         MultiplePaymentSecrets,
1529
1530         /// The invoice's features are invalid
1531         InvalidFeatures,
1532
1533         /// The recovery id doesn't fit the signature/pub key
1534         InvalidRecoveryId,
1535
1536         /// The invoice's signature is invalid
1537         InvalidSignature,
1538
1539         /// The invoice's amount was not a whole number of millisatoshis
1540         ImpreciseAmount,
1541 }
1542
1543 impl Display for SemanticError {
1544         fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1545                 match self {
1546                         SemanticError::NoPaymentHash => f.write_str("The invoice is missing the mandatory payment hash"),
1547                         SemanticError::MultiplePaymentHashes => f.write_str("The invoice has multiple payment hashes which isn't allowed"),
1548                         SemanticError::NoDescription => f.write_str("No description or description hash are part of the invoice"),
1549                         SemanticError::MultipleDescriptions => f.write_str("The invoice contains multiple descriptions and/or description hashes which isn't allowed"),
1550                         SemanticError::NoPaymentSecret => f.write_str("The invoice is missing the mandatory payment secret"),
1551                         SemanticError::MultiplePaymentSecrets => f.write_str("The invoice contains multiple payment secrets"),
1552                         SemanticError::InvalidFeatures => f.write_str("The invoice's features are invalid"),
1553                         SemanticError::InvalidRecoveryId => f.write_str("The recovery id doesn't fit the signature/pub key"),
1554                         SemanticError::InvalidSignature => f.write_str("The invoice's signature is invalid"),
1555                         SemanticError::ImpreciseAmount => f.write_str("The invoice's amount was not a whole number of millisatoshis"),
1556                 }
1557         }
1558 }
1559
1560 #[cfg(feature = "std")]
1561 impl std::error::Error for SemanticError { }
1562
1563 /// When signing using a fallible method either an user-supplied `SignError` or a `CreationError`
1564 /// may occur.
1565 #[derive(Eq, PartialEq, Debug, Clone)]
1566 pub enum SignOrCreationError<S = ()> {
1567         /// An error occurred during signing
1568         SignError(S),
1569
1570         /// An error occurred while building the transaction
1571         CreationError(CreationError),
1572 }
1573
1574 impl<S> Display for SignOrCreationError<S> {
1575         fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
1576                 match self {
1577                         SignOrCreationError::SignError(_) => f.write_str("An error occurred during signing"),
1578                         SignOrCreationError::CreationError(err) => err.fmt(f),
1579                 }
1580         }
1581 }
1582
1583 #[cfg(feature = "serde")]
1584 impl Serialize for Invoice {
1585         fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer {
1586                 serializer.serialize_str(self.to_string().as_str())
1587         }
1588 }
1589 #[cfg(feature = "serde")]
1590 impl<'de> Deserialize<'de> for Invoice {
1591         fn deserialize<D>(deserializer: D) -> Result<Invoice, D::Error> where D: Deserializer<'de> {
1592                 let bolt11 = String::deserialize(deserializer)?
1593                         .parse::<Invoice>()
1594                         .map_err(|e| D::Error::custom(format!("{:?}", e)))?;
1595
1596                 Ok(bolt11)
1597         }
1598 }
1599
1600 #[cfg(test)]
1601 mod test {
1602         use bitcoin_hashes::hex::FromHex;
1603         use bitcoin_hashes::sha256;
1604
1605         #[test]
1606         fn test_system_time_bounds_assumptions() {
1607                 assert_eq!(
1608                         crate::PositiveTimestamp::from_unix_timestamp(crate::MAX_TIMESTAMP + 1),
1609                         Err(crate::CreationError::TimestampOutOfBounds)
1610                 );
1611         }
1612
1613         #[test]
1614         fn test_calc_invoice_hash() {
1615                 use crate::{RawInvoice, RawHrp, RawDataPart, Currency, PositiveTimestamp};
1616                 use crate::TaggedField::*;
1617
1618                 let invoice = RawInvoice {
1619                         hrp: RawHrp {
1620                                 currency: Currency::Bitcoin,
1621                                 raw_amount: None,
1622                                 si_prefix: None,
1623                         },
1624                         data: RawDataPart {
1625                                 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1626                                 tagged_fields: vec![
1627                                         PaymentHash(crate::Sha256(sha256::Hash::from_hex(
1628                                                 "0001020304050607080900010203040506070809000102030405060708090102"
1629                                         ).unwrap())).into(),
1630                                         Description(crate::Description::new(
1631                                                 "Please consider supporting this project".to_owned()
1632                                         ).unwrap()).into(),
1633                                 ],
1634                         },
1635                 };
1636
1637                 let expected_hash = [
1638                         0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27, 0x7b, 0x1d,
1639                         0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7, 0x83, 0x5d, 0xb2, 0xec,
1640                         0xd5, 0x18, 0xe1, 0xc9
1641                 ];
1642
1643                 assert_eq!(invoice.signable_hash(), expected_hash)
1644         }
1645
1646         #[test]
1647         fn test_check_signature() {
1648                 use crate::TaggedField::*;
1649                 use secp256k1::Secp256k1;
1650                 use secp256k1::ecdsa::{RecoveryId, RecoverableSignature};
1651                 use secp256k1::{SecretKey, PublicKey};
1652                 use crate::{SignedRawInvoice, InvoiceSignature, RawInvoice, RawHrp, RawDataPart, Currency, Sha256,
1653                          PositiveTimestamp};
1654
1655                 let invoice = SignedRawInvoice {
1656                         raw_invoice: RawInvoice {
1657                                 hrp: RawHrp {
1658                                         currency: Currency::Bitcoin,
1659                                         raw_amount: None,
1660                                         si_prefix: None,
1661                                 },
1662                                 data: RawDataPart {
1663                                         timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1664                                         tagged_fields: vec ! [
1665                                                 PaymentHash(Sha256(sha256::Hash::from_hex(
1666                                                         "0001020304050607080900010203040506070809000102030405060708090102"
1667                                                 ).unwrap())).into(),
1668                                                 Description(
1669                                                         crate::Description::new(
1670                                                                 "Please consider supporting this project".to_owned()
1671                                                         ).unwrap()
1672                                                 ).into(),
1673                                         ],
1674                                 },
1675                         },
1676                         hash: [
1677                                 0xc3, 0xd4, 0xe8, 0x3f, 0x64, 0x6f, 0xa7, 0x9a, 0x39, 0x3d, 0x75, 0x27,
1678                                 0x7b, 0x1d, 0x85, 0x8d, 0xb1, 0xd1, 0xf7, 0xab, 0x71, 0x37, 0xdc, 0xb7,
1679                                 0x83, 0x5d, 0xb2, 0xec, 0xd5, 0x18, 0xe1, 0xc9
1680                         ],
1681                         signature: InvoiceSignature(RecoverableSignature::from_compact(
1682                                 & [
1683                                         0x38u8, 0xec, 0x68, 0x91, 0x34, 0x5e, 0x20, 0x41, 0x45, 0xbe, 0x8a,
1684                                         0x3a, 0x99, 0xde, 0x38, 0xe9, 0x8a, 0x39, 0xd6, 0xa5, 0x69, 0x43,
1685                                         0x4e, 0x18, 0x45, 0xc8, 0xaf, 0x72, 0x05, 0xaf, 0xcf, 0xcc, 0x7f,
1686                                         0x42, 0x5f, 0xcd, 0x14, 0x63, 0xe9, 0x3c, 0x32, 0x88, 0x1e, 0xad,
1687                                         0x0d, 0x6e, 0x35, 0x6d, 0x46, 0x7e, 0xc8, 0xc0, 0x25, 0x53, 0xf9,
1688                                         0xaa, 0xb1, 0x5e, 0x57, 0x38, 0xb1, 0x1f, 0x12, 0x7f
1689                                 ],
1690                                 RecoveryId::from_i32(0).unwrap()
1691                         ).unwrap()),
1692                 };
1693
1694                 assert!(invoice.check_signature());
1695
1696                 let private_key = SecretKey::from_slice(
1697                         &[
1698                                 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1699                                 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1700                                 0x3b, 0x2d, 0xb7, 0x34
1701                         ][..]
1702                 ).unwrap();
1703                 let public_key = PublicKey::from_secret_key(&Secp256k1::new(), &private_key);
1704
1705                 assert_eq!(invoice.recover_payee_pub_key(), Ok(crate::PayeePubKey(public_key)));
1706
1707                 let (raw_invoice, _, _) = invoice.into_parts();
1708                 let new_signed = raw_invoice.sign::<_, ()>(|hash| {
1709                         Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key))
1710                 }).unwrap();
1711
1712                 assert!(new_signed.check_signature());
1713         }
1714
1715         #[test]
1716         fn test_check_feature_bits() {
1717                 use crate::TaggedField::*;
1718                 use lightning::ln::features::InvoiceFeatures;
1719                 use secp256k1::Secp256k1;
1720                 use secp256k1::SecretKey;
1721                 use crate::{RawInvoice, RawHrp, RawDataPart, Currency, Sha256, PositiveTimestamp, Invoice,
1722                          SemanticError};
1723
1724                 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
1725                 let payment_secret = lightning::ln::PaymentSecret([21; 32]);
1726                 let invoice_template = RawInvoice {
1727                         hrp: RawHrp {
1728                                 currency: Currency::Bitcoin,
1729                                 raw_amount: None,
1730                                 si_prefix: None,
1731                         },
1732                         data: RawDataPart {
1733                                 timestamp: PositiveTimestamp::from_unix_timestamp(1496314658).unwrap(),
1734                                 tagged_fields: vec ! [
1735                                         PaymentHash(Sha256(sha256::Hash::from_hex(
1736                                                 "0001020304050607080900010203040506070809000102030405060708090102"
1737                                         ).unwrap())).into(),
1738                                         Description(
1739                                                 crate::Description::new(
1740                                                         "Please consider supporting this project".to_owned()
1741                                                 ).unwrap()
1742                                         ).into(),
1743                                 ],
1744                         },
1745                 };
1746
1747                 // Missing features
1748                 let invoice = {
1749                         let mut invoice = invoice_template.clone();
1750                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1751                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1752                 }.unwrap();
1753                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::InvalidFeatures));
1754
1755                 // Missing feature bits
1756                 let invoice = {
1757                         let mut invoice = invoice_template.clone();
1758                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1759                         invoice.data.tagged_fields.push(Features(InvoiceFeatures::empty()).into());
1760                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1761                 }.unwrap();
1762                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::InvalidFeatures));
1763
1764                 let mut payment_secret_features = InvoiceFeatures::empty();
1765                 payment_secret_features.set_payment_secret_required();
1766
1767                 // Including payment secret and feature bits
1768                 let invoice = {
1769                         let mut invoice = invoice_template.clone();
1770                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1771                         invoice.data.tagged_fields.push(Features(payment_secret_features.clone()).into());
1772                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1773                 }.unwrap();
1774                 assert!(Invoice::from_signed(invoice).is_ok());
1775
1776                 // No payment secret or features
1777                 let invoice = {
1778                         let invoice = invoice_template.clone();
1779                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1780                 }.unwrap();
1781                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::NoPaymentSecret));
1782
1783                 // No payment secret or feature bits
1784                 let invoice = {
1785                         let mut invoice = invoice_template.clone();
1786                         invoice.data.tagged_fields.push(Features(InvoiceFeatures::empty()).into());
1787                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1788                 }.unwrap();
1789                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::NoPaymentSecret));
1790
1791                 // Missing payment secret
1792                 let invoice = {
1793                         let mut invoice = invoice_template.clone();
1794                         invoice.data.tagged_fields.push(Features(payment_secret_features).into());
1795                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1796                 }.unwrap();
1797                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::NoPaymentSecret));
1798
1799                 // Multiple payment secrets
1800                 let invoice = {
1801                         let mut invoice = invoice_template;
1802                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1803                         invoice.data.tagged_fields.push(PaymentSecret(payment_secret).into());
1804                         invoice.sign::<_, ()>(|hash| Ok(Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)))
1805                 }.unwrap();
1806                 assert_eq!(Invoice::from_signed(invoice), Err(SemanticError::MultiplePaymentSecrets));
1807         }
1808
1809         #[test]
1810         fn test_builder_amount() {
1811                 use crate::*;
1812
1813                 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1814                         .description("Test".into())
1815                         .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1816                         .duration_since_epoch(Duration::from_secs(1234567));
1817
1818                 let invoice = builder.clone()
1819                         .amount_milli_satoshis(1500)
1820                         .build_raw()
1821                         .unwrap();
1822
1823                 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Nano));
1824                 assert_eq!(invoice.hrp.raw_amount, Some(15));
1825
1826
1827                 let invoice = builder
1828                         .amount_milli_satoshis(150)
1829                         .build_raw()
1830                         .unwrap();
1831
1832                 assert_eq!(invoice.hrp.si_prefix, Some(SiPrefix::Pico));
1833                 assert_eq!(invoice.hrp.raw_amount, Some(1500));
1834         }
1835
1836         #[test]
1837         fn test_builder_fail() {
1838                 use crate::*;
1839                 use lightning::routing::router::RouteHintHop;
1840                 use std::iter::FromIterator;
1841                 use secp256k1::PublicKey;
1842
1843                 let builder = InvoiceBuilder::new(Currency::Bitcoin)
1844                         .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
1845                         .duration_since_epoch(Duration::from_secs(1234567))
1846                         .min_final_cltv_expiry_delta(144);
1847
1848                 let too_long_string = String::from_iter(
1849                         (0..1024).map(|_| '?')
1850                 );
1851
1852                 let long_desc_res = builder.clone()
1853                         .description(too_long_string)
1854                         .build_raw();
1855                 assert_eq!(long_desc_res, Err(CreationError::DescriptionTooLong));
1856
1857                 let route_hop = RouteHintHop {
1858                         src_node_id: PublicKey::from_slice(
1859                                         &[
1860                                                 0x03, 0x9e, 0x03, 0xa9, 0x01, 0xb8, 0x55, 0x34, 0xff, 0x1e, 0x92, 0xc4,
1861                                                 0x3c, 0x74, 0x43, 0x1f, 0x7c, 0xe7, 0x20, 0x46, 0x06, 0x0f, 0xcf, 0x7a,
1862                                                 0x95, 0xc3, 0x7e, 0x14, 0x8f, 0x78, 0xc7, 0x72, 0x55
1863                                         ][..]
1864                                 ).unwrap(),
1865                         short_channel_id: 0,
1866                         fees: RoutingFees {
1867                                 base_msat: 0,
1868                                 proportional_millionths: 0,
1869                         },
1870                         cltv_expiry_delta: 0,
1871                         htlc_minimum_msat: None,
1872                         htlc_maximum_msat: None,
1873                 };
1874                 let too_long_route = RouteHint(vec![route_hop; 13]);
1875                 let long_route_res = builder.clone()
1876                         .description("Test".into())
1877                         .private_route(too_long_route)
1878                         .build_raw();
1879                 assert_eq!(long_route_res, Err(CreationError::RouteTooLong));
1880
1881                 let sign_error_res = builder
1882                         .description("Test".into())
1883                         .payment_secret(PaymentSecret([0; 32]))
1884                         .try_build_signed(|_| {
1885                                 Err("ImaginaryError")
1886                         });
1887                 assert_eq!(sign_error_res, Err(SignOrCreationError::SignError("ImaginaryError")));
1888         }
1889
1890         #[test]
1891         fn test_builder_ok() {
1892                 use crate::*;
1893                 use lightning::routing::router::RouteHintHop;
1894                 use secp256k1::Secp256k1;
1895                 use secp256k1::{SecretKey, PublicKey};
1896                 use std::time::{UNIX_EPOCH, Duration};
1897
1898                 let secp_ctx = Secp256k1::new();
1899
1900                 let private_key = SecretKey::from_slice(
1901                         &[
1902                                 0xe1, 0x26, 0xf6, 0x8f, 0x7e, 0xaf, 0xcc, 0x8b, 0x74, 0xf5, 0x4d, 0x26, 0x9f, 0xe2,
1903                                 0x06, 0xbe, 0x71, 0x50, 0x00, 0xf9, 0x4d, 0xac, 0x06, 0x7d, 0x1c, 0x04, 0xa8, 0xca,
1904                                 0x3b, 0x2d, 0xb7, 0x34
1905                         ][..]
1906                 ).unwrap();
1907                 let public_key = PublicKey::from_secret_key(&secp_ctx, &private_key);
1908
1909                 let route_1 = RouteHint(vec![
1910                         RouteHintHop {
1911                                 src_node_id: public_key,
1912                                 short_channel_id: de::parse_int_be(&[123; 8], 256).expect("short chan ID slice too big?"),
1913                                 fees: RoutingFees {
1914                                         base_msat: 2,
1915                                         proportional_millionths: 1,
1916                                 },
1917                                 cltv_expiry_delta: 145,
1918                                 htlc_minimum_msat: None,
1919                                 htlc_maximum_msat: None,
1920                         },
1921                         RouteHintHop {
1922                                 src_node_id: public_key,
1923                                 short_channel_id: de::parse_int_be(&[42; 8], 256).expect("short chan ID slice too big?"),
1924                                 fees: RoutingFees {
1925                                         base_msat: 3,
1926                                         proportional_millionths: 2,
1927                                 },
1928                                 cltv_expiry_delta: 146,
1929                                 htlc_minimum_msat: None,
1930                                 htlc_maximum_msat: None,
1931                         }
1932                 ]);
1933
1934                 let route_2 = RouteHint(vec![
1935                         RouteHintHop {
1936                                 src_node_id: public_key,
1937                                 short_channel_id: 0,
1938                                 fees: RoutingFees {
1939                                         base_msat: 4,
1940                                         proportional_millionths: 3,
1941                                 },
1942                                 cltv_expiry_delta: 147,
1943                                 htlc_minimum_msat: None,
1944                                 htlc_maximum_msat: None,
1945                         },
1946                         RouteHintHop {
1947                                 src_node_id: public_key,
1948                                 short_channel_id: de::parse_int_be(&[1; 8], 256).expect("short chan ID slice too big?"),
1949                                 fees: RoutingFees {
1950                                         base_msat: 5,
1951                                         proportional_millionths: 4,
1952                                 },
1953                                 cltv_expiry_delta: 148,
1954                                 htlc_minimum_msat: None,
1955                                 htlc_maximum_msat: None,
1956                         }
1957                 ]);
1958
1959                 let builder = InvoiceBuilder::new(Currency::BitcoinTestnet)
1960                         .amount_milli_satoshis(123)
1961                         .duration_since_epoch(Duration::from_secs(1234567))
1962                         .payee_pub_key(public_key)
1963                         .expiry_time(Duration::from_secs(54321))
1964                         .min_final_cltv_expiry_delta(144)
1965                         .fallback(Fallback::PubKeyHash([0;20]))
1966                         .private_route(route_1.clone())
1967                         .private_route(route_2.clone())
1968                         .description_hash(sha256::Hash::from_slice(&[3;32][..]).unwrap())
1969                         .payment_hash(sha256::Hash::from_slice(&[21;32][..]).unwrap())
1970                         .payment_secret(PaymentSecret([42; 32]))
1971                         .basic_mpp();
1972
1973                 let invoice = builder.clone().build_signed(|hash| {
1974                         secp_ctx.sign_ecdsa_recoverable(hash, &private_key)
1975                 }).unwrap();
1976
1977                 assert!(invoice.check_signature().is_ok());
1978                 assert_eq!(invoice.tagged_fields().count(), 10);
1979
1980                 assert_eq!(invoice.amount_milli_satoshis(), Some(123));
1981                 assert_eq!(invoice.amount_pico_btc(), Some(1230));
1982                 assert_eq!(invoice.currency(), Currency::BitcoinTestnet);
1983                 #[cfg(feature = "std")]
1984                 assert_eq!(
1985                         invoice.timestamp().duration_since(UNIX_EPOCH).unwrap().as_secs(),
1986                         1234567
1987                 );
1988                 assert_eq!(invoice.payee_pub_key(), Some(&public_key));
1989                 assert_eq!(invoice.expiry_time(), Duration::from_secs(54321));
1990                 assert_eq!(invoice.min_final_cltv_expiry_delta(), 144);
1991                 assert_eq!(invoice.fallbacks(), vec![&Fallback::PubKeyHash([0;20])]);
1992                 assert_eq!(invoice.private_routes(), vec![&PrivateRoute(route_1), &PrivateRoute(route_2)]);
1993                 assert_eq!(
1994                         invoice.description(),
1995                         InvoiceDescription::Hash(&Sha256(sha256::Hash::from_slice(&[3;32][..]).unwrap()))
1996                 );
1997                 assert_eq!(invoice.payment_hash(), &sha256::Hash::from_slice(&[21;32][..]).unwrap());
1998                 assert_eq!(invoice.payment_secret(), &PaymentSecret([42; 32]));
1999
2000                 let mut expected_features = InvoiceFeatures::empty();
2001                 expected_features.set_variable_length_onion_required();
2002                 expected_features.set_payment_secret_required();
2003                 expected_features.set_basic_mpp_optional();
2004                 assert_eq!(invoice.features(), Some(&expected_features));
2005
2006                 let raw_invoice = builder.build_raw().unwrap();
2007                 assert_eq!(raw_invoice, *invoice.into_signed_raw().raw_invoice())
2008         }
2009
2010         #[test]
2011         fn test_default_values() {
2012                 use crate::*;
2013                 use secp256k1::Secp256k1;
2014                 use secp256k1::SecretKey;
2015
2016                 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
2017                         .description("Test".into())
2018                         .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2019                         .payment_secret(PaymentSecret([0; 32]))
2020                         .duration_since_epoch(Duration::from_secs(1234567))
2021                         .build_raw()
2022                         .unwrap()
2023                         .sign::<_, ()>(|hash| {
2024                                 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
2025                                 let secp_ctx = Secp256k1::new();
2026                                 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
2027                         })
2028                         .unwrap();
2029                 let invoice = Invoice::from_signed(signed_invoice).unwrap();
2030
2031                 assert_eq!(invoice.min_final_cltv_expiry_delta(), DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA);
2032                 assert_eq!(invoice.expiry_time(), Duration::from_secs(DEFAULT_EXPIRY_TIME));
2033                 assert!(!invoice.would_expire(Duration::from_secs(1234568)));
2034         }
2035
2036         #[test]
2037         fn test_expiration() {
2038                 use crate::*;
2039                 use secp256k1::Secp256k1;
2040                 use secp256k1::SecretKey;
2041
2042                 let signed_invoice = InvoiceBuilder::new(Currency::Bitcoin)
2043                         .description("Test".into())
2044                         .payment_hash(sha256::Hash::from_slice(&[0;32][..]).unwrap())
2045                         .payment_secret(PaymentSecret([0; 32]))
2046                         .duration_since_epoch(Duration::from_secs(1234567))
2047                         .build_raw()
2048                         .unwrap()
2049                         .sign::<_, ()>(|hash| {
2050                                 let privkey = SecretKey::from_slice(&[41; 32]).unwrap();
2051                                 let secp_ctx = Secp256k1::new();
2052                                 Ok(secp_ctx.sign_ecdsa_recoverable(hash, &privkey))
2053                         })
2054                         .unwrap();
2055                 let invoice = Invoice::from_signed(signed_invoice).unwrap();
2056
2057                 assert!(invoice.would_expire(Duration::from_secs(1234567 + DEFAULT_EXPIRY_TIME + 1)));
2058         }
2059
2060         #[cfg(feature = "serde")]
2061         #[test]
2062         fn test_serde() {
2063                 let invoice_str = "lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\
2064                         h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\
2065                         5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\
2066                         h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\
2067                         j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\
2068                         ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\
2069                         guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\
2070                         ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\
2071                         p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\
2072                         8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\
2073                         j5r6drg6k6zcqj0fcwg";
2074                 let invoice = invoice_str.parse::<super::Invoice>().unwrap();
2075                 let serialized_invoice = serde_json::to_string(&invoice).unwrap();
2076                 let deserialized_invoice: super::Invoice = serde_json::from_str(serialized_invoice.as_str()).unwrap();
2077                 assert_eq!(invoice, deserialized_invoice);
2078                 assert_eq!(invoice_str, deserialized_invoice.to_string().as_str());
2079                 assert_eq!(invoice_str, serialized_invoice.as_str().trim_matches('\"'));
2080         }
2081 }