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