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

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! A module for paying Lightning invoices.
  11 //!
  12 //! Defines an [`InvoicePayer`] utility for paying invoices, parameterized by [`Payer`] and
  13 //! [`Router`] traits. Implementations of [`Payer`] provide the payer's node id, channels, and means
  14 //! to send a payment over a [`Route`]. Implementations of [`Router`] find a [`Route`] between payer
  15 //! and payee using information provided by the payer and from the payee's [`Invoice`].
  16 //!
  17 //! [`InvoicePayer`] is capable of retrying failed payments. It accomplishes this by implementing
  18 //! [`EventHandler`] which decorates a user-provided handler. It will intercept any
  19 //! [`Event::PaymentPathFailed`] events and retry the failed paths for a fixed number of total
  20 //! attempts or until retry is no longer possible. In such a situation, [`InvoicePayer`] will pass
  21 //! along the events to the user-provided handler.
  22 //!
  23 //! # Example
  24 //!
  25 //! ```
  26 //! # extern crate lightning;
  27 //! # extern crate lightning_invoice;
  28 //! # extern crate secp256k1;
  29 //! #
  30 //! # use lightning::ln::{PaymentHash, PaymentSecret};
  31 //! # use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure};
  32 //! # use lightning::ln::msgs::LightningError;
  33 //! # use lightning::routing;
  34 //! # use lightning::routing::network_graph::NodeId;
  35 //! # use lightning::routing::router::{Route, RouteHop, RouteParameters};
  36 //! # use lightning::util::events::{Event, EventHandler, EventsProvider};
  37 //! # use lightning::util::logger::{Logger, Record};
  38 //! # use lightning_invoice::Invoice;
  39 //! # use lightning_invoice::payment::{InvoicePayer, Payer, RetryAttempts, Router};
  40 //! # use secp256k1::key::PublicKey;
  41 //! # use std::cell::RefCell;
  42 //! # use std::ops::Deref;
  43 //! #
  44 //! # struct FakeEventProvider {}
  45 //! # impl EventsProvider for FakeEventProvider {
  46 //! #     fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {}
  47 //! # }
  48 //! #
  49 //! # struct FakePayer {}
  50 //! # impl Payer for FakePayer {
  51 //! #     fn node_id(&self) -> PublicKey { unimplemented!() }
  52 //! #     fn first_hops(&self) -> Vec<ChannelDetails> { unimplemented!() }
  53 //! #     fn send_payment(
  54 //! #         &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>
  55 //! #     ) -> Result<PaymentId, PaymentSendFailure> { unimplemented!() }
  56 //! #     fn retry_payment(
  57 //! #         &self, route: &Route, payment_id: PaymentId
  58 //! #     ) -> Result<(), PaymentSendFailure> { unimplemented!() }
  59 //! # }
  60 //! #
  61 //! # struct FakeRouter {};
  62 //! # impl<S: routing::Score> Router<S> for FakeRouter {
  63 //! #     fn find_route(
  64 //! #         &self, payer: &PublicKey, params: &RouteParameters,
  65 //! #         first_hops: Option<&[&ChannelDetails]>, scorer: &S
  66 //! #     ) -> Result<Route, LightningError> { unimplemented!() }
  67 //! # }
  68 //! #
  69 //! # struct FakeScorer {};
  70 //! # impl routing::Score for FakeScorer {
  71 //! #     fn channel_penalty_msat(
  72 //! #         &self, _short_channel_id: u64, _source: &NodeId, _target: &NodeId
  73 //! #     ) -> u64 { 0 }
  74 //! #     fn payment_path_failed(&mut self, _path: &Vec<RouteHop>, _short_channel_id: u64) {}
  75 //! # }
  76 //! #
  77 //! # struct FakeLogger {};
  78 //! # impl Logger for FakeLogger {
  79 //! #     fn log(&self, record: &Record) { unimplemented!() }
  80 //! # }
  81 //! #
  82 //! # fn main() {
  83 //! let event_handler = |event: &Event| {
  84 //!     match event {
  85 //!         Event::PaymentPathFailed { .. } => println!("payment failed after retries"),
  86 //!         Event::PaymentSent { .. } => println!("payment successful"),
  87 //!         _ => {},
  88 //!     }
  89 //! };
  90 //! # let payer = FakePayer {};
  91 //! # let router = FakeRouter {};
  92 //! # let scorer = RefCell::new(FakeScorer {});
  93 //! # let logger = FakeLogger {};
  94 //! let invoice_payer = InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
  95 //!
  96 //! let invoice = "...";
  97 //! let invoice = invoice.parse::<Invoice>().unwrap();
  98 //! invoice_payer.pay_invoice(&invoice).unwrap();
  99 //!
 100 //! # let event_provider = FakeEventProvider {};
 101 //! loop {
 102 //!     event_provider.process_pending_events(&invoice_payer);
 103 //! }
 104 //! # }
 105 //! ```
 106 //!
 107 //! # Note
 108 //!
 109 //! The [`Route`] is computed before each payment attempt. Any updates affecting path finding such
 110 //! as updates to the network graph or changes to channel scores should be applied prior to
 111 //! retries, typically by way of composing [`EventHandler`]s accordingly.
 112
 113 use crate::Invoice;
 114
 115 use bitcoin_hashes::Hash;
 116
 117 use lightning::ln::{PaymentHash, PaymentSecret};
 118 use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure};
 119 use lightning::ln::msgs::LightningError;
 120 use lightning::routing;
 121 use lightning::routing::{LockableScore, Score};
 122 use lightning::routing::router::{Payee, Route, RouteParameters};
 123 use lightning::util::events::{Event, EventHandler};
 124 use lightning::util::logger::Logger;
 125
 126 use secp256k1::key::PublicKey;
 127
 128 use std::collections::hash_map::{self, HashMap};
 129 use std::ops::Deref;
 130 use std::sync::Mutex;
 131 use std::time::{Duration, SystemTime};
 132
 133 /// A utility for paying [`Invoice]`s.
 134 pub struct InvoicePayer<P: Deref, R, S: Deref, L: Deref, E>
 135 where
 136         P::Target: Payer,
 137         R: for <'a> Router<<<S as Deref>::Target as routing::LockableScore<'a>>::Locked>,
 138         S::Target: for <'a> routing::LockableScore<'a>,
 139         L::Target: Logger,
 140         E: EventHandler,
 141 {
 142         payer: P,
 143         router: R,
 144         scorer: S,
 145         logger: L,
 146         event_handler: E,
 147         payment_cache: Mutex<HashMap<PaymentHash, usize>>,
 148         retry_attempts: RetryAttempts,
 149 }
 150
 151 /// A trait defining behavior of an [`Invoice`] payer.
 152 pub trait Payer {
 153         /// Returns the payer's node id.
 154         fn node_id(&self) -> PublicKey;
 155
 156         /// Returns the payer's channels.
 157         fn first_hops(&self) -> Vec<ChannelDetails>;
 158
 159         /// Sends a payment over the Lightning Network using the given [`Route`].
 160         fn send_payment(
 161                 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>
 162         ) -> Result<PaymentId, PaymentSendFailure>;
 163
 164         /// Retries a failed payment path for the [`PaymentId`] using the given [`Route`].
 165         fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure>;
 166 }
 167
 168 /// A trait defining behavior for routing an [`Invoice`] payment.
 169 pub trait Router<S: routing::Score> {
 170         /// Finds a [`Route`] between `payer` and `payee` for a payment with the given values.
 171         fn find_route(
 172                 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&ChannelDetails]>,
 173                 scorer: &S
 174         ) -> Result<Route, LightningError>;
 175 }
 176
 177 /// Number of attempts to retry payment path failures for an [`Invoice`].
 178 ///
 179 /// Note that this is the number of *path* failures, not full payment retries. For multi-path
 180 /// payments, if this is less than the total number of paths, we will never even retry all of the
 181 /// payment's paths.
 182 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
 183 pub struct RetryAttempts(pub usize);
 184
 185 /// An error that may occur when making a payment.
 186 #[derive(Clone, Debug)]
 187 pub enum PaymentError {
 188         /// An error resulting from the provided [`Invoice`] or payment hash.
 189         Invoice(&'static str),
 190         /// An error occurring when finding a route.
 191         Routing(LightningError),
 192         /// An error occurring when sending a payment.
 193         Sending(PaymentSendFailure),
 194 }
 195
 196 impl<P: Deref, R, S: Deref, L: Deref, E> InvoicePayer<P, R, S, L, E>
 197 where
 198         P::Target: Payer,
 199         R: for <'a> Router<<<S as Deref>::Target as routing::LockableScore<'a>>::Locked>,
 200         S::Target: for <'a> routing::LockableScore<'a>,
 201         L::Target: Logger,
 202         E: EventHandler,
 203 {
 204         /// Creates an invoice payer that retries failed payment paths.
 205         ///
 206         /// Will forward any [`Event::PaymentPathFailed`] events to the decorated `event_handler` once
 207         /// `retry_attempts` has been exceeded for a given [`Invoice`].
 208         pub fn new(
 209                 payer: P, router: R, scorer: S, logger: L, event_handler: E, retry_attempts: RetryAttempts
 210         ) -> Self {
 211                 Self {
 212                         payer,
 213                         router,
 214                         scorer,
 215                         logger,
 216                         event_handler,
 217                         payment_cache: Mutex::new(HashMap::new()),
 218                         retry_attempts,
 219                 }
 220         }
 221
 222         /// Pays the given [`Invoice`], caching it for later use in case a retry is needed.
 223         ///
 224         /// You should ensure that the `invoice.payment_hash()` is unique and the same payment_hash has
 225         /// never been paid before. Because [`InvoicePayer`] is stateless no effort is made to do so
 226         /// for you.
 227         pub fn pay_invoice(&self, invoice: &Invoice) -> Result<PaymentId, PaymentError> {
 228                 if invoice.amount_milli_satoshis().is_none() {
 229                         Err(PaymentError::Invoice("amount missing"))
 230                 } else {
 231                         self.pay_invoice_internal(invoice, None)
 232                 }
 233         }
 234
 235         /// Pays the given zero-value [`Invoice`] using the given amount, caching it for later use in
 236         /// case a retry is needed.
 237         ///
 238         /// You should ensure that the `invoice.payment_hash()` is unique and the same payment_hash has
 239         /// never been paid before. Because [`InvoicePayer`] is stateless no effort is made to do so
 240         /// for you.
 241         pub fn pay_zero_value_invoice(
 242                 &self, invoice: &Invoice, amount_msats: u64
 243         ) -> Result<PaymentId, PaymentError> {
 244                 if invoice.amount_milli_satoshis().is_some() {
 245                         Err(PaymentError::Invoice("amount unexpected"))
 246                 } else {
 247                         self.pay_invoice_internal(invoice, Some(amount_msats))
 248                 }
 249         }
 250
 251         fn pay_invoice_internal(
 252                 &self, invoice: &Invoice, amount_msats: Option<u64>
 253         ) -> Result<PaymentId, PaymentError> {
 254                 debug_assert!(invoice.amount_milli_satoshis().is_some() ^ amount_msats.is_some());
 255                 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
 256                 let mut payment_cache = self.payment_cache.lock().unwrap();
 257                 match payment_cache.entry(payment_hash) {
 258                         hash_map::Entry::Vacant(entry) => {
 259                                 let payer = self.payer.node_id();
 260                                 let mut payee = Payee::new(invoice.recover_payee_pub_key())
 261                                         .with_expiry_time(expiry_time_from_unix_epoch(&invoice).as_secs())
 262                                         .with_route_hints(invoice.route_hints());
 263                                 if let Some(features) = invoice.features() {
 264                                         payee = payee.with_features(features.clone());
 265                                 }
 266                                 let params = RouteParameters {
 267                                         payee,
 268                                         final_value_msat: invoice.amount_milli_satoshis().or(amount_msats).unwrap(),
 269                                         final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
 270                                 };
 271                                 let first_hops = self.payer.first_hops();
 272                                 let route = self.router.find_route(
 273                                         &payer,
 274                                         &params,
 275                                         Some(&first_hops.iter().collect::<Vec<_>>()),
 276                                         &self.scorer.lock(),
 277                                 ).map_err(|e| PaymentError::Routing(e))?;
 278
 279                                 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
 280                                 let payment_secret = Some(invoice.payment_secret().clone());
 281                                 let payment_id = self.payer.send_payment(&route, payment_hash, &payment_secret)
 282                                         .map_err(|e| PaymentError::Sending(e))?;
 283                                 entry.insert(0);
 284                                 Ok(payment_id)
 285                         },
 286                         hash_map::Entry::Occupied(_) => Err(PaymentError::Invoice("payment pending")),
 287                 }
 288         }
 289
 290         fn retry_payment(
 291                 &self, payment_id: PaymentId, params: &RouteParameters
 292         ) -> Result<(), PaymentError> {
 293                 let payer = self.payer.node_id();
 294                 let first_hops = self.payer.first_hops();
 295                 let route = self.router.find_route(
 296                         &payer, &params, Some(&first_hops.iter().collect::<Vec<_>>()),
 297                         &self.scorer.lock()
 298                 ).map_err(|e| PaymentError::Routing(e))?;
 299                 self.payer.retry_payment(&route, payment_id).map_err(|e| PaymentError::Sending(e))
 300         }
 301
 302         /// Removes the payment cached by the given payment hash.
 303         ///
 304         /// Should be called once a payment has failed or succeeded if not using [`InvoicePayer`] as an
 305         /// [`EventHandler`]. Otherwise, calling this method is unnecessary.
 306         pub fn remove_cached_payment(&self, payment_hash: &PaymentHash) {
 307                 self.payment_cache.lock().unwrap().remove(payment_hash);
 308         }
 309 }
 310
 311 fn expiry_time_from_unix_epoch(invoice: &Invoice) -> Duration {
 312         invoice.timestamp().duration_since(SystemTime::UNIX_EPOCH).unwrap() + invoice.expiry_time()
 313 }
 314
 315 fn has_expired(params: &RouteParameters) -> bool {
 316         let expiry_time = Duration::from_secs(params.payee.expiry_time.unwrap());
 317         Invoice::is_expired_from_epoch(&SystemTime::UNIX_EPOCH, expiry_time)
 318 }
 319
 320 impl<P: Deref, R, S: Deref, L: Deref, E> EventHandler for InvoicePayer<P, R, S, L, E>
 321 where
 322         P::Target: Payer,
 323         R: for <'a> Router<<<S as Deref>::Target as routing::LockableScore<'a>>::Locked>,
 324         S::Target: for <'a> routing::LockableScore<'a>,
 325         L::Target: Logger,
 326         E: EventHandler,
 327 {
 328         fn handle_event(&self, event: &Event) {
 329                 match event {
 330                         Event::PaymentPathFailed {
 331                                 payment_id, payment_hash, rejected_by_dest, path, short_channel_id, retry, ..
 332                         } => {
 333                                 if let Some(short_channel_id) = short_channel_id {
 334                                         self.scorer.lock().payment_path_failed(path, *short_channel_id);
 335                                 }
 336
 337                                 let mut payment_cache = self.payment_cache.lock().unwrap();
 338                                 let entry = loop {
 339                                         let entry = payment_cache.entry(*payment_hash);
 340                                         match entry {
 341                                                 hash_map::Entry::Occupied(_) => break entry,
 342                                                 hash_map::Entry::Vacant(entry) => entry.insert(0),
 343                                         };
 344                                 };
 345                                 if let hash_map::Entry::Occupied(mut entry) = entry {
 346                                         let max_payment_attempts = self.retry_attempts.0 + 1;
 347                                         let attempts = entry.get_mut();
 348                                         *attempts += 1;
 349
 350                                         if *rejected_by_dest {
 351                                                 log_trace!(self.logger, "Payment {} rejected by destination; not retrying (attempts: {})", log_bytes!(payment_hash.0), attempts);
 352                                         } else if payment_id.is_none() {
 353                                                 log_trace!(self.logger, "Payment {} has no id; not retrying (attempts: {})", log_bytes!(payment_hash.0), attempts);
 354                                         } else if *attempts >= max_payment_attempts {
 355                                                 log_trace!(self.logger, "Payment {} exceeded maximum attempts; not retrying (attempts: {})", log_bytes!(payment_hash.0), attempts);
 356                                         } else if retry.is_none() {
 357                                                 log_trace!(self.logger, "Payment {} missing retry params; not retrying (attempts: {})", log_bytes!(payment_hash.0), attempts);
 358                                         } else if has_expired(retry.as_ref().unwrap()) {
 359                                                 log_trace!(self.logger, "Invoice expired for payment {}; not retrying (attempts: {})", log_bytes!(payment_hash.0), attempts);
 360                                         } else if self.retry_payment(*payment_id.as_ref().unwrap(), retry.as_ref().unwrap()).is_err() {
 361                                                 log_trace!(self.logger, "Error retrying payment {}; not retrying (attempts: {})", log_bytes!(payment_hash.0), attempts);
 362                                         } else {
 363                                                 log_trace!(self.logger, "Payment {} failed; retrying (attempts: {})", log_bytes!(payment_hash.0), attempts);
 364                                                 return;
 365                                         }
 366
 367                                         // Either the payment was rejected, the maximum attempts were exceeded, or an
 368                                         // error occurred when attempting to retry.
 369                                         entry.remove();
 370                                 } else {
 371                                         unreachable!();
 372                                 }
 373                         },
 374                         Event::PaymentSent { payment_hash, .. } => {
 375                                 let mut payment_cache = self.payment_cache.lock().unwrap();
 376                                 let attempts = payment_cache
 377                                         .remove(payment_hash)
 378                                         .map_or(1, |attempts| attempts + 1);
 379                                 log_trace!(self.logger, "Payment {} succeeded (attempts: {})", log_bytes!(payment_hash.0), attempts);
 380                         },
 381                         _ => {},
 382                 }
 383
 384                 // Delegate to the decorated event handler unless the payment is retried.
 385                 self.event_handler.handle_event(event)
 386         }
 387 }
 388
 389 #[cfg(test)]
 390 mod tests {
 391         use super::*;
 392         use crate::{DEFAULT_EXPIRY_TIME, InvoiceBuilder, Currency};
 393         use bitcoin_hashes::sha256::Hash as Sha256;
 394         use lightning::ln::PaymentPreimage;
 395         use lightning::ln::features::{ChannelFeatures, NodeFeatures};
 396         use lightning::ln::msgs::{ErrorAction, LightningError};
 397         use lightning::routing::network_graph::NodeId;
 398         use lightning::routing::router::{Payee, Route, RouteHop};
 399         use lightning::util::test_utils::TestLogger;
 400         use lightning::util::errors::APIError;
 401         use lightning::util::events::Event;
 402         use secp256k1::{SecretKey, PublicKey, Secp256k1};
 403         use std::cell::RefCell;
 404         use std::time::{SystemTime, Duration};
 405
 406         fn invoice(payment_preimage: PaymentPreimage) -> Invoice {
 407                 let payment_hash = Sha256::hash(&payment_preimage.0);
 408                 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
 409                 InvoiceBuilder::new(Currency::Bitcoin)
 410                         .description("test".into())
 411                         .payment_hash(payment_hash)
 412                         .payment_secret(PaymentSecret([0; 32]))
 413                         .current_timestamp()
 414                         .min_final_cltv_expiry(144)
 415                         .amount_milli_satoshis(128)
 416                         .build_signed(|hash| {
 417                                 Secp256k1::new().sign_recoverable(hash, &private_key)
 418                         })
 419                         .unwrap()
 420         }
 421
 422         fn zero_value_invoice(payment_preimage: PaymentPreimage) -> Invoice {
 423                 let payment_hash = Sha256::hash(&payment_preimage.0);
 424                 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
 425                 InvoiceBuilder::new(Currency::Bitcoin)
 426                         .description("test".into())
 427                         .payment_hash(payment_hash)
 428                         .payment_secret(PaymentSecret([0; 32]))
 429                         .current_timestamp()
 430                         .min_final_cltv_expiry(144)
 431                         .build_signed(|hash| {
 432                                 Secp256k1::new().sign_recoverable(hash, &private_key)
 433                         })
 434                         .unwrap()
 435         }
 436
 437         fn expired_invoice(payment_preimage: PaymentPreimage) -> Invoice {
 438                 let payment_hash = Sha256::hash(&payment_preimage.0);
 439                 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
 440                 let timestamp = SystemTime::now()
 441                         .checked_sub(Duration::from_secs(DEFAULT_EXPIRY_TIME * 2))
 442                         .unwrap();
 443                 InvoiceBuilder::new(Currency::Bitcoin)
 444                         .description("test".into())
 445                         .payment_hash(payment_hash)
 446                         .payment_secret(PaymentSecret([0; 32]))
 447                         .timestamp(timestamp)
 448                         .min_final_cltv_expiry(144)
 449                         .amount_milli_satoshis(128)
 450                         .build_signed(|hash| {
 451                                 Secp256k1::new().sign_recoverable(hash, &private_key)
 452                         })
 453                         .unwrap()
 454         }
 455
 456         #[test]
 457         fn pays_invoice_on_first_attempt() {
 458                 let event_handled = core::cell::RefCell::new(false);
 459                 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
 460
 461                 let payment_preimage = PaymentPreimage([1; 32]);
 462                 let invoice = invoice(payment_preimage);
 463                 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
 464
 465                 let payer = TestPayer::new();
 466                 let router = TestRouter {};
 467                 let scorer = RefCell::new(TestScorer::new());
 468                 let logger = TestLogger::new();
 469                 let invoice_payer =
 470                         InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(0));
 471
 472                 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
 473                 assert_eq!(*payer.attempts.borrow(), 1);
 474
 475                 invoice_payer.handle_event(&Event::PaymentSent {
 476                         payment_id, payment_preimage, payment_hash, fee_paid_msat: None
 477                 });
 478                 assert_eq!(*event_handled.borrow(), true);
 479                 assert_eq!(*payer.attempts.borrow(), 1);
 480         }
 481
 482         #[test]
 483         fn pays_invoice_on_retry() {
 484                 let event_handled = core::cell::RefCell::new(false);
 485                 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
 486
 487                 let payment_preimage = PaymentPreimage([1; 32]);
 488                 let invoice = invoice(payment_preimage);
 489                 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
 490                 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
 491
 492                 let payer = TestPayer::new()
 493                         .expect_value_msat(final_value_msat)
 494                         .expect_value_msat(final_value_msat / 2);
 495                 let router = TestRouter {};
 496                 let scorer = RefCell::new(TestScorer::new());
 497                 let logger = TestLogger::new();
 498                 let invoice_payer =
 499                         InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
 500
 501                 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
 502                 assert_eq!(*payer.attempts.borrow(), 1);
 503
 504                 let event = Event::PaymentPathFailed {
 505                         payment_id,
 506                         payment_hash,
 507                         network_update: None,
 508                         rejected_by_dest: false,
 509                         all_paths_failed: false,
 510                         path: TestRouter::path_for_value(final_value_msat),
 511                         short_channel_id: None,
 512                         retry: Some(TestRouter::retry_for_invoice(&invoice)),
 513                 };
 514                 invoice_payer.handle_event(&event);
 515                 assert_eq!(*event_handled.borrow(), false);
 516                 assert_eq!(*payer.attempts.borrow(), 2);
 517
 518                 invoice_payer.handle_event(&Event::PaymentSent {
 519                         payment_id, payment_preimage, payment_hash, fee_paid_msat: None
 520                 });
 521                 assert_eq!(*event_handled.borrow(), true);
 522                 assert_eq!(*payer.attempts.borrow(), 2);
 523         }
 524
 525         #[test]
 526         fn retries_payment_path_for_unknown_payment() {
 527                 let event_handled = core::cell::RefCell::new(false);
 528                 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
 529
 530                 let payment_preimage = PaymentPreimage([1; 32]);
 531                 let invoice = invoice(payment_preimage);
 532                 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
 533                 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
 534
 535                 let payer = TestPayer::new();
 536                 let router = TestRouter {};
 537                 let scorer = RefCell::new(TestScorer::new());
 538                 let logger = TestLogger::new();
 539                 let invoice_payer =
 540                         InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
 541
 542                 let payment_id = Some(PaymentId([1; 32]));
 543                 let event = Event::PaymentPathFailed {
 544                         payment_id,
 545                         payment_hash,
 546                         network_update: None,
 547                         rejected_by_dest: false,
 548                         all_paths_failed: false,
 549                         path: TestRouter::path_for_value(final_value_msat),
 550                         short_channel_id: None,
 551                         retry: Some(TestRouter::retry_for_invoice(&invoice)),
 552                 };
 553                 invoice_payer.handle_event(&event);
 554                 assert_eq!(*event_handled.borrow(), false);
 555                 assert_eq!(*payer.attempts.borrow(), 1);
 556
 557                 invoice_payer.handle_event(&event);
 558                 assert_eq!(*event_handled.borrow(), false);
 559                 assert_eq!(*payer.attempts.borrow(), 2);
 560
 561                 invoice_payer.handle_event(&Event::PaymentSent {
 562                         payment_id, payment_preimage, payment_hash, fee_paid_msat: None
 563                 });
 564                 assert_eq!(*event_handled.borrow(), true);
 565                 assert_eq!(*payer.attempts.borrow(), 2);
 566         }
 567
 568         #[test]
 569         fn fails_paying_invoice_after_max_retries() {
 570                 let event_handled = core::cell::RefCell::new(false);
 571                 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
 572
 573                 let payment_preimage = PaymentPreimage([1; 32]);
 574                 let invoice = invoice(payment_preimage);
 575                 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
 576
 577                 let payer = TestPayer::new()
 578                         .expect_value_msat(final_value_msat)
 579                         .expect_value_msat(final_value_msat / 2)
 580                         .expect_value_msat(final_value_msat / 2);
 581                 let router = TestRouter {};
 582                 let scorer = RefCell::new(TestScorer::new());
 583                 let logger = TestLogger::new();
 584                 let invoice_payer =
 585                         InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
 586
 587                 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
 588                 assert_eq!(*payer.attempts.borrow(), 1);
 589
 590                 let event = Event::PaymentPathFailed {
 591                         payment_id,
 592                         payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
 593                         network_update: None,
 594                         rejected_by_dest: false,
 595                         all_paths_failed: true,
 596                         path: TestRouter::path_for_value(final_value_msat),
 597                         short_channel_id: None,
 598                         retry: Some(TestRouter::retry_for_invoice(&invoice)),
 599                 };
 600                 invoice_payer.handle_event(&event);
 601                 assert_eq!(*event_handled.borrow(), false);
 602                 assert_eq!(*payer.attempts.borrow(), 2);
 603
 604                 let event = Event::PaymentPathFailed {
 605                         payment_id,
 606                         payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
 607                         network_update: None,
 608                         rejected_by_dest: false,
 609                         all_paths_failed: false,
 610                         path: TestRouter::path_for_value(final_value_msat / 2),
 611                         short_channel_id: None,
 612                         retry: Some(RouteParameters {
 613                                 final_value_msat: final_value_msat / 2, ..TestRouter::retry_for_invoice(&invoice)
 614                         }),
 615                 };
 616                 invoice_payer.handle_event(&event);
 617                 assert_eq!(*event_handled.borrow(), false);
 618                 assert_eq!(*payer.attempts.borrow(), 3);
 619
 620                 invoice_payer.handle_event(&event);
 621                 assert_eq!(*event_handled.borrow(), true);
 622                 assert_eq!(*payer.attempts.borrow(), 3);
 623         }
 624
 625         #[test]
 626         fn fails_paying_invoice_with_missing_retry_params() {
 627                 let event_handled = core::cell::RefCell::new(false);
 628                 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
 629
 630                 let payer = TestPayer::new();
 631                 let router = TestRouter {};
 632                 let scorer = RefCell::new(TestScorer::new());
 633                 let logger = TestLogger::new();
 634                 let invoice_payer =
 635                         InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
 636
 637                 let payment_preimage = PaymentPreimage([1; 32]);
 638                 let invoice = invoice(payment_preimage);
 639                 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
 640                 assert_eq!(*payer.attempts.borrow(), 1);
 641
 642                 let event = Event::PaymentPathFailed {
 643                         payment_id,
 644                         payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
 645                         network_update: None,
 646                         rejected_by_dest: false,
 647                         all_paths_failed: false,
 648                         path: vec![],
 649                         short_channel_id: None,
 650                         retry: None,
 651                 };
 652                 invoice_payer.handle_event(&event);
 653                 assert_eq!(*event_handled.borrow(), true);
 654                 assert_eq!(*payer.attempts.borrow(), 1);
 655         }
 656
 657         #[test]
 658         fn fails_paying_invoice_after_expiration() {
 659                 let event_handled = core::cell::RefCell::new(false);
 660                 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
 661
 662                 let payer = TestPayer::new();
 663                 let router = TestRouter {};
 664                 let scorer = RefCell::new(TestScorer::new());
 665                 let logger = TestLogger::new();
 666                 let invoice_payer =
 667                         InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
 668
 669                 let payment_preimage = PaymentPreimage([1; 32]);
 670                 let invoice = expired_invoice(payment_preimage);
 671                 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
 672                 assert_eq!(*payer.attempts.borrow(), 1);
 673
 674                 let event = Event::PaymentPathFailed {
 675                         payment_id,
 676                         payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
 677                         network_update: None,
 678                         rejected_by_dest: false,
 679                         all_paths_failed: false,
 680                         path: vec![],
 681                         short_channel_id: None,
 682                         retry: Some(TestRouter::retry_for_invoice(&invoice)),
 683                 };
 684                 invoice_payer.handle_event(&event);
 685                 assert_eq!(*event_handled.borrow(), true);
 686                 assert_eq!(*payer.attempts.borrow(), 1);
 687         }
 688
 689         #[test]
 690         fn fails_paying_invoice_after_retry_error() {
 691                 let event_handled = core::cell::RefCell::new(false);
 692                 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
 693
 694                 let payment_preimage = PaymentPreimage([1; 32]);
 695                 let invoice = invoice(payment_preimage);
 696                 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
 697
 698                 let payer = TestPayer::new()
 699                         .fails_on_attempt(2)
 700                         .expect_value_msat(final_value_msat);
 701                 let router = TestRouter {};
 702                 let scorer = RefCell::new(TestScorer::new());
 703                 let logger = TestLogger::new();
 704                 let invoice_payer =
 705                         InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
 706
 707                 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
 708                 assert_eq!(*payer.attempts.borrow(), 1);
 709
 710                 let event = Event::PaymentPathFailed {
 711                         payment_id,
 712                         payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
 713                         network_update: None,
 714                         rejected_by_dest: false,
 715                         all_paths_failed: false,
 716                         path: TestRouter::path_for_value(final_value_msat / 2),
 717                         short_channel_id: None,
 718                         retry: Some(TestRouter::retry_for_invoice(&invoice)),
 719                 };
 720                 invoice_payer.handle_event(&event);
 721                 assert_eq!(*event_handled.borrow(), true);
 722                 assert_eq!(*payer.attempts.borrow(), 2);
 723         }
 724
 725         #[test]
 726         fn fails_paying_invoice_after_rejected_by_payee() {
 727                 let event_handled = core::cell::RefCell::new(false);
 728                 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
 729
 730                 let payer = TestPayer::new();
 731                 let router = TestRouter {};
 732                 let scorer = RefCell::new(TestScorer::new());
 733                 let logger = TestLogger::new();
 734                 let invoice_payer =
 735                         InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
 736
 737                 let payment_preimage = PaymentPreimage([1; 32]);
 738                 let invoice = invoice(payment_preimage);
 739                 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
 740                 assert_eq!(*payer.attempts.borrow(), 1);
 741
 742                 let event = Event::PaymentPathFailed {
 743                         payment_id,
 744                         payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
 745                         network_update: None,
 746                         rejected_by_dest: true,
 747                         all_paths_failed: false,
 748                         path: vec![],
 749                         short_channel_id: None,
 750                         retry: Some(TestRouter::retry_for_invoice(&invoice)),
 751                 };
 752                 invoice_payer.handle_event(&event);
 753                 assert_eq!(*event_handled.borrow(), true);
 754                 assert_eq!(*payer.attempts.borrow(), 1);
 755         }
 756
 757         #[test]
 758         fn fails_repaying_invoice_with_pending_payment() {
 759                 let event_handled = core::cell::RefCell::new(false);
 760                 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
 761
 762                 let payer = TestPayer::new();
 763                 let router = TestRouter {};
 764                 let scorer = RefCell::new(TestScorer::new());
 765                 let logger = TestLogger::new();
 766                 let invoice_payer =
 767                         InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(0));
 768
 769                 let payment_preimage = PaymentPreimage([1; 32]);
 770                 let invoice = invoice(payment_preimage);
 771                 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
 772
 773                 // Cannot repay an invoice pending payment.
 774                 match invoice_payer.pay_invoice(&invoice) {
 775                         Err(PaymentError::Invoice("payment pending")) => {},
 776                         Err(_) => panic!("unexpected error"),
 777                         Ok(_) => panic!("expected invoice error"),
 778                 }
 779
 780                 // Can repay an invoice once cleared from cache.
 781                 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
 782                 invoice_payer.remove_cached_payment(&payment_hash);
 783                 assert!(invoice_payer.pay_invoice(&invoice).is_ok());
 784
 785                 // Cannot retry paying an invoice if cleared from cache.
 786                 invoice_payer.remove_cached_payment(&payment_hash);
 787                 let event = Event::PaymentPathFailed {
 788                         payment_id,
 789                         payment_hash,
 790                         network_update: None,
 791                         rejected_by_dest: false,
 792                         all_paths_failed: false,
 793                         path: vec![],
 794                         short_channel_id: None,
 795                         retry: Some(TestRouter::retry_for_invoice(&invoice)),
 796                 };
 797                 invoice_payer.handle_event(&event);
 798                 assert_eq!(*event_handled.borrow(), true);
 799         }
 800
 801         #[test]
 802         fn fails_paying_invoice_with_routing_errors() {
 803                 let payer = TestPayer::new();
 804                 let router = FailingRouter {};
 805                 let scorer = RefCell::new(TestScorer::new());
 806                 let logger = TestLogger::new();
 807                 let invoice_payer =
 808                         InvoicePayer::new(&payer, router, &scorer, &logger, |_: &_| {}, RetryAttempts(0));
 809
 810                 let payment_preimage = PaymentPreimage([1; 32]);
 811                 let invoice = invoice(payment_preimage);
 812                 match invoice_payer.pay_invoice(&invoice) {
 813                         Err(PaymentError::Routing(_)) => {},
 814                         Err(_) => panic!("unexpected error"),
 815                         Ok(_) => panic!("expected routing error"),
 816                 }
 817         }
 818
 819         #[test]
 820         fn fails_paying_invoice_with_sending_errors() {
 821                 let payer = TestPayer::new().fails_on_attempt(1);
 822                 let router = TestRouter {};
 823                 let scorer = RefCell::new(TestScorer::new());
 824                 let logger = TestLogger::new();
 825                 let invoice_payer =
 826                         InvoicePayer::new(&payer, router, &scorer, &logger, |_: &_| {}, RetryAttempts(0));
 827
 828                 let payment_preimage = PaymentPreimage([1; 32]);
 829                 let invoice = invoice(payment_preimage);
 830                 match invoice_payer.pay_invoice(&invoice) {
 831                         Err(PaymentError::Sending(_)) => {},
 832                         Err(_) => panic!("unexpected error"),
 833                         Ok(_) => panic!("expected sending error"),
 834                 }
 835         }
 836
 837         #[test]
 838         fn pays_zero_value_invoice_using_amount() {
 839                 let event_handled = core::cell::RefCell::new(false);
 840                 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
 841
 842                 let payment_preimage = PaymentPreimage([1; 32]);
 843                 let invoice = zero_value_invoice(payment_preimage);
 844                 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
 845                 let final_value_msat = 100;
 846
 847                 let payer = TestPayer::new().expect_value_msat(final_value_msat);
 848                 let router = TestRouter {};
 849                 let scorer = RefCell::new(TestScorer::new());
 850                 let logger = TestLogger::new();
 851                 let invoice_payer =
 852                         InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(0));
 853
 854                 let payment_id =
 855                         Some(invoice_payer.pay_zero_value_invoice(&invoice, final_value_msat).unwrap());
 856                 assert_eq!(*payer.attempts.borrow(), 1);
 857
 858                 invoice_payer.handle_event(&Event::PaymentSent {
 859                         payment_id, payment_preimage, payment_hash, fee_paid_msat: None
 860                 });
 861                 assert_eq!(*event_handled.borrow(), true);
 862                 assert_eq!(*payer.attempts.borrow(), 1);
 863         }
 864
 865         #[test]
 866         fn fails_paying_zero_value_invoice_with_amount() {
 867                 let event_handled = core::cell::RefCell::new(false);
 868                 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
 869
 870                 let payer = TestPayer::new();
 871                 let router = TestRouter {};
 872                 let scorer = RefCell::new(TestScorer::new());
 873                 let logger = TestLogger::new();
 874                 let invoice_payer =
 875                         InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(0));
 876
 877                 let payment_preimage = PaymentPreimage([1; 32]);
 878                 let invoice = invoice(payment_preimage);
 879
 880                 // Cannot repay an invoice pending payment.
 881                 match invoice_payer.pay_zero_value_invoice(&invoice, 100) {
 882                         Err(PaymentError::Invoice("amount unexpected")) => {},
 883                         Err(_) => panic!("unexpected error"),
 884                         Ok(_) => panic!("expected invoice error"),
 885                 }
 886         }
 887
 888         #[test]
 889         fn scores_failed_channel() {
 890                 let event_handled = core::cell::RefCell::new(false);
 891                 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
 892
 893                 let payment_preimage = PaymentPreimage([1; 32]);
 894                 let invoice = invoice(payment_preimage);
 895                 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
 896                 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
 897                 let path = TestRouter::path_for_value(final_value_msat);
 898                 let short_channel_id = Some(path[0].short_channel_id);
 899
 900                 // Expect that scorer is given short_channel_id upon handling the event.
 901                 let payer = TestPayer::new();
 902                 let router = TestRouter {};
 903                 let scorer = RefCell::new(TestScorer::new().expect_channel_failure(short_channel_id.unwrap()));
 904                 let logger = TestLogger::new();
 905                 let invoice_payer =
 906                         InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
 907
 908                 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
 909                 let event = Event::PaymentPathFailed {
 910                         payment_id,
 911                         payment_hash,
 912                         network_update: None,
 913                         rejected_by_dest: false,
 914                         all_paths_failed: false,
 915                         path,
 916                         short_channel_id,
 917                         retry: Some(TestRouter::retry_for_invoice(&invoice)),
 918                 };
 919                 invoice_payer.handle_event(&event);
 920         }
 921
 922         struct TestRouter;
 923
 924         impl TestRouter {
 925                 fn route_for_value(final_value_msat: u64) -> Route {
 926                         Route {
 927                                 paths: vec![
 928                                         vec![RouteHop {
 929                                                 pubkey: PublicKey::from_slice(&hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
 930                                                 channel_features: ChannelFeatures::empty(),
 931                                                 node_features: NodeFeatures::empty(),
 932                                                 short_channel_id: 0, fee_msat: final_value_msat / 2, cltv_expiry_delta: 144
 933                                         }],
 934                                         vec![RouteHop {
 935                                                 pubkey: PublicKey::from_slice(&hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
 936                                                 channel_features: ChannelFeatures::empty(),
 937                                                 node_features: NodeFeatures::empty(),
 938                                                 short_channel_id: 1, fee_msat: final_value_msat / 2, cltv_expiry_delta: 144
 939                                         }],
 940                                 ],
 941                                 payee: None,
 942                         }
 943                 }
 944
 945                 fn path_for_value(final_value_msat: u64) -> Vec<RouteHop> {
 946                         TestRouter::route_for_value(final_value_msat).paths[0].clone()
 947                 }
 948
 949                 fn retry_for_invoice(invoice: &Invoice) -> RouteParameters {
 950                         let mut payee = Payee::new(invoice.recover_payee_pub_key())
 951                                 .with_expiry_time(expiry_time_from_unix_epoch(invoice).as_secs())
 952                                 .with_route_hints(invoice.route_hints());
 953                         if let Some(features) = invoice.features() {
 954                                 payee = payee.with_features(features.clone());
 955                         }
 956                         let final_value_msat = invoice.amount_milli_satoshis().unwrap() / 2;
 957                         RouteParameters {
 958                                 payee,
 959                                 final_value_msat,
 960                                 final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
 961                         }
 962                 }
 963         }
 964
 965         impl<S: routing::Score> Router<S> for TestRouter {
 966                 fn find_route(
 967                         &self,
 968                         _payer: &PublicKey,
 969                         params: &RouteParameters,
 970                         _first_hops: Option<&[&ChannelDetails]>,
 971                         _scorer: &S,
 972                 ) -> Result<Route, LightningError> {
 973                         Ok(Route {
 974                                 payee: Some(params.payee.clone()), ..Self::route_for_value(params.final_value_msat)
 975                         })
 976                 }
 977         }
 978
 979         struct FailingRouter;
 980
 981         impl<S: routing::Score> Router<S> for FailingRouter {
 982                 fn find_route(
 983                         &self,
 984                         _payer: &PublicKey,
 985                         _params: &RouteParameters,
 986                         _first_hops: Option<&[&ChannelDetails]>,
 987                         _scorer: &S,
 988                 ) -> Result<Route, LightningError> {
 989                         Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError })
 990                 }
 991         }
 992
 993         struct TestScorer {
 994                 expectations: std::collections::VecDeque<u64>,
 995         }
 996
 997         impl TestScorer {
 998                 fn new() -> Self {
 999                         Self {
1000                                 expectations: std::collections::VecDeque::new(),
1001                         }
1002                 }
1003
1004                 fn expect_channel_failure(mut self, short_channel_id: u64) -> Self {
1005                         self.expectations.push_back(short_channel_id);
1006                         self
1007                 }
1008         }
1009
1010         impl routing::Score for TestScorer {
1011                 fn channel_penalty_msat(
1012                         &self, _short_channel_id: u64, _source: &NodeId, _target: &NodeId
1013                 ) -> u64 { 0 }
1014
1015                 fn payment_path_failed(&mut self, _path: &Vec<RouteHop>, short_channel_id: u64) {
1016                         if let Some(expected_short_channel_id) = self.expectations.pop_front() {
1017                                 assert_eq!(short_channel_id, expected_short_channel_id);
1018                         }
1019                 }
1020         }
1021
1022         impl Drop for TestScorer {
1023                 fn drop(&mut self) {
1024                         if std::thread::panicking() {
1025                                 return;
1026                         }
1027
1028                         if !self.expectations.is_empty() {
1029                                 panic!("Unsatisfied channel failure expectations: {:?}", self.expectations);
1030                         }
1031                 }
1032         }
1033
1034         struct TestPayer {
1035                 expectations: core::cell::RefCell<std::collections::VecDeque<u64>>,
1036                 attempts: core::cell::RefCell<usize>,
1037                 failing_on_attempt: Option<usize>,
1038         }
1039
1040         impl TestPayer {
1041                 fn new() -> Self {
1042                         Self {
1043                                 expectations: core::cell::RefCell::new(std::collections::VecDeque::new()),
1044                                 attempts: core::cell::RefCell::new(0),
1045                                 failing_on_attempt: None,
1046                         }
1047                 }
1048
1049                 fn expect_value_msat(self, value_msat: u64) -> Self {
1050                         self.expectations.borrow_mut().push_back(value_msat);
1051                         self
1052                 }
1053
1054                 fn fails_on_attempt(self, attempt: usize) -> Self {
1055                         Self {
1056                                 expectations: core::cell::RefCell::new(self.expectations.borrow().clone()),
1057                                 attempts: core::cell::RefCell::new(0),
1058                                 failing_on_attempt: Some(attempt),
1059                         }
1060                 }
1061
1062                 fn check_attempts(&self) -> bool {
1063                         let mut attempts = self.attempts.borrow_mut();
1064                         *attempts += 1;
1065                         match self.failing_on_attempt {
1066                                 None => true,
1067                                 Some(attempt) if attempt != *attempts => true,
1068                                 Some(_) => false,
1069                         }
1070                 }
1071
1072                 fn check_value_msats(&self, route: &Route) {
1073                         let expected_value_msats = self.expectations.borrow_mut().pop_front();
1074                         if let Some(expected_value_msats) = expected_value_msats {
1075                                 let actual_value_msats = route.get_total_amount();
1076                                 assert_eq!(actual_value_msats, expected_value_msats);
1077                         }
1078                 }
1079         }
1080
1081         impl Drop for TestPayer {
1082                 fn drop(&mut self) {
1083                         if std::thread::panicking() {
1084                                 return;
1085                         }
1086
1087                         if !self.expectations.borrow().is_empty() {
1088                                 panic!("Unsatisfied payment expectations: {:?}", self.expectations.borrow());
1089                         }
1090                 }
1091         }
1092
1093         impl Payer for TestPayer {
1094                 fn node_id(&self) -> PublicKey {
1095                         let secp_ctx = Secp256k1::new();
1096                         PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap())
1097                 }
1098
1099                 fn first_hops(&self) -> Vec<ChannelDetails> {
1100                         Vec::new()
1101                 }
1102
1103                 fn send_payment(
1104                         &self,
1105                         route: &Route,
1106                         _payment_hash: PaymentHash,
1107                         _payment_secret: &Option<PaymentSecret>
1108                 ) -> Result<PaymentId, PaymentSendFailure> {
1109                         if self.check_attempts() {
1110                                 self.check_value_msats(route);
1111                                 Ok(PaymentId([1; 32]))
1112                         } else {
1113                                 Err(PaymentSendFailure::ParameterError(APIError::MonitorUpdateFailed))
1114                         }
1115                 }
1116
1117                 fn retry_payment(
1118                         &self, route: &Route, _payment_id: PaymentId
1119                 ) -> Result<(), PaymentSendFailure> {
1120                         if self.check_attempts() {
1121                                 self.check_value_msats(route);
1122                                 Ok(())
1123                         } else {
1124                                 Err(PaymentSendFailure::ParameterError(APIError::MonitorUpdateFailed))
1125                         }
1126                 }
1127         }
1128 }