1 // This file is Copyright its original authors, visible in version control
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
10 //! A module for paying Lightning invoices.
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`].
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.
26 //! # extern crate lightning;
27 //! # extern crate lightning_invoice;
28 //! # extern crate secp256k1;
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;
44 //! # struct FakeEventProvider {}
45 //! # impl EventsProvider for FakeEventProvider {
46 //! # fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {}
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!() }
61 //! # struct FakeRouter {};
62 //! # impl<S: routing::Score> Router<S> for FakeRouter {
64 //! # &self, payer: &PublicKey, params: &RouteParameters,
65 //! # first_hops: Option<&[&ChannelDetails]>, scorer: &S
66 //! # ) -> Result<Route, LightningError> { unimplemented!() }
69 //! # struct FakeScorer {};
70 //! # impl routing::Score for FakeScorer {
71 //! # fn channel_penalty_msat(
72 //! # &self, _short_channel_id: u64, _source: &NodeId, _target: &NodeId
74 //! # fn payment_path_failed(&mut self, _path: &Vec<RouteHop>, _short_channel_id: u64) {}
77 //! # struct FakeLogger {};
78 //! # impl Logger for FakeLogger {
79 //! # fn log(&self, record: &Record) { unimplemented!() }
83 //! let event_handler = |event: &Event| {
85 //! Event::PaymentPathFailed { .. } => println!("payment failed after retries"),
86 //! Event::PaymentSent { .. } => println!("payment successful"),
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));
96 //! let invoice = "...";
97 //! let invoice = invoice.parse::<Invoice>().unwrap();
98 //! invoice_payer.pay_invoice(&invoice).unwrap();
100 //! # let event_provider = FakeEventProvider {};
102 //! event_provider.process_pending_events(&invoice_payer);
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.
115 use bitcoin_hashes::Hash;
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;
126 use secp256k1::key::PublicKey;
128 use std::collections::hash_map::{self, HashMap};
130 use std::sync::Mutex;
131 use std::time::{Duration, SystemTime};
133 /// A utility for paying [`Invoice]`s.
134 pub struct InvoicePayer<P: Deref, R, S: Deref, L: Deref, E>
137 R: for <'a> Router<<<S as Deref>::Target as routing::LockableScore<'a>>::Locked>,
138 S::Target: for <'a> routing::LockableScore<'a>,
147 payment_cache: Mutex<HashMap<PaymentHash, usize>>,
148 retry_attempts: RetryAttempts,
151 /// A trait defining behavior of an [`Invoice`] payer.
153 /// Returns the payer's node id.
154 fn node_id(&self) -> PublicKey;
156 /// Returns the payer's channels.
157 fn first_hops(&self) -> Vec<ChannelDetails>;
159 /// Sends a payment over the Lightning Network using the given [`Route`].
161 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>
162 ) -> Result<PaymentId, PaymentSendFailure>;
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>;
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.
172 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&ChannelDetails]>,
174 ) -> Result<Route, LightningError>;
177 /// Number of attempts to retry payment path failures for an [`Invoice`].
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
182 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
183 pub struct RetryAttempts(pub usize);
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),
196 impl<P: Deref, R, S: Deref, L: Deref, E> InvoicePayer<P, R, S, L, E>
199 R: for <'a> Router<<<S as Deref>::Target as routing::LockableScore<'a>>::Locked>,
200 S::Target: for <'a> routing::LockableScore<'a>,
204 /// Creates an invoice payer that retries failed payment paths.
206 /// Will forward any [`Event::PaymentPathFailed`] events to the decorated `event_handler` once
207 /// `retry_attempts` has been exceeded for a given [`Invoice`].
209 payer: P, router: R, scorer: S, logger: L, event_handler: E, retry_attempts: RetryAttempts
217 payment_cache: Mutex::new(HashMap::new()),
222 /// Pays the given [`Invoice`], caching it for later use in case a retry is needed.
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
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"))
231 self.pay_invoice_internal(invoice, None, 0)
235 /// Pays the given zero-value [`Invoice`] using the given amount, caching it for later use in
236 /// case a retry is needed.
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
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"))
247 self.pay_invoice_internal(invoice, Some(amount_msats), 0)
251 fn pay_invoice_internal(
252 &self, invoice: &Invoice, amount_msats: Option<u64>, retry_count: usize
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 if invoice.is_expired() {
257 log_trace!(self.logger, "Invoice expired prior to first send for payment {}", log_bytes!(payment_hash.0));
258 return Err(PaymentError::Invoice("Invoice expired prior to send"));
260 let retry_data_payment_id = loop {
261 let mut payment_cache = self.payment_cache.lock().unwrap();
262 match payment_cache.entry(payment_hash) {
263 hash_map::Entry::Vacant(entry) => {
264 let payer = self.payer.node_id();
265 let mut payee = Payee::new(invoice.recover_payee_pub_key())
266 .with_expiry_time(expiry_time_from_unix_epoch(&invoice).as_secs())
267 .with_route_hints(invoice.route_hints());
268 if let Some(features) = invoice.features() {
269 payee = payee.with_features(features.clone());
271 let params = RouteParameters {
273 final_value_msat: invoice.amount_milli_satoshis().or(amount_msats).unwrap(),
274 final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
276 let first_hops = self.payer.first_hops();
277 let route = self.router.find_route(
280 Some(&first_hops.iter().collect::<Vec<_>>()),
282 ).map_err(|e| PaymentError::Routing(e))?;
284 let payment_secret = Some(invoice.payment_secret().clone());
285 let payment_id = match self.payer.send_payment(&route, payment_hash, &payment_secret) {
286 Ok(payment_id) => payment_id,
287 Err(PaymentSendFailure::ParameterError(e)) =>
288 return Err(PaymentError::Sending(PaymentSendFailure::ParameterError(e))),
289 Err(PaymentSendFailure::PathParameterError(e)) =>
290 return Err(PaymentError::Sending(PaymentSendFailure::PathParameterError(e))),
291 Err(PaymentSendFailure::AllFailedRetrySafe(e)) => {
292 if retry_count >= self.retry_attempts.0 {
293 return Err(PaymentError::Sending(PaymentSendFailure::AllFailedRetrySafe(e)))
297 Err(PaymentSendFailure::PartialFailure { results: _, failed_paths_retry, payment_id }) => {
298 if let Some(retry_data) = failed_paths_retry {
299 entry.insert(retry_count);
300 break Some((retry_data, payment_id));
302 // This may happen if we send a payment and some paths fail, but
303 // only due to a temporary monitor failure or the like, implying
304 // they're really in-flight, but we haven't sent the initial
305 // HTLC-Add messages yet.
310 entry.insert(retry_count);
311 return Ok(payment_id);
313 hash_map::Entry::Occupied(_) => return Err(PaymentError::Invoice("payment pending")),
316 if let Some((retry_data, payment_id)) = retry_data_payment_id {
317 // Some paths were sent, even if we failed to send the full MPP value our recipient may
318 // misbehave and claim the funds, at which point we have to consider the payment sent,
319 // so return `Ok()` here, ignoring any retry errors.
320 let _ = self.retry_payment(payment_id, payment_hash, &retry_data);
323 self.pay_invoice_internal(invoice, amount_msats, retry_count + 1)
327 fn retry_payment(&self, payment_id: PaymentId, payment_hash: PaymentHash, params: &RouteParameters)
331 let mut payment_cache = self.payment_cache.lock().unwrap();
333 let entry = payment_cache.entry(payment_hash);
335 hash_map::Entry::Occupied(_) => break entry,
336 hash_map::Entry::Vacant(entry) => entry.insert(0),
339 if let hash_map::Entry::Occupied(mut entry) = entry {
340 let max_payment_attempts = self.retry_attempts.0 + 1;
341 let attempts = entry.get_mut();
344 if *attempts >= max_payment_attempts {
345 log_trace!(self.logger, "Payment {} exceeded maximum attempts; not retrying (attempts: {})", log_bytes!(payment_hash.0), attempts);
347 } else if has_expired(params) {
348 log_trace!(self.logger, "Invoice expired for payment {}; not retrying (attempts: {})", log_bytes!(payment_hash.0), attempts);
352 let payer = self.payer.node_id();
353 let first_hops = self.payer.first_hops();
354 route = self.router.find_route(&payer, ¶ms, Some(&first_hops.iter().collect::<Vec<_>>()), &self.scorer.lock());
356 log_trace!(self.logger, "Failed to find a route for payment {}; not retrying (attempts: {})", log_bytes!(payment_hash.0), attempts);
364 let retry_res = self.payer.retry_payment(&route.unwrap(), payment_id);
367 Err(PaymentSendFailure::ParameterError(_)) |
368 Err(PaymentSendFailure::PathParameterError(_)) => {
369 log_trace!(self.logger, "Failed to retry for payment {} due to bogus route/payment data, not retrying.", log_bytes!(payment_hash.0));
372 Err(PaymentSendFailure::AllFailedRetrySafe(_)) => {
373 self.retry_payment(payment_id, payment_hash, params)
375 Err(PaymentSendFailure::PartialFailure { results: _, failed_paths_retry, .. }) => {
376 if let Some(retry) = failed_paths_retry {
377 self.retry_payment(payment_id, payment_hash, &retry)
385 /// Removes the payment cached by the given payment hash.
387 /// Should be called once a payment has failed or succeeded if not using [`InvoicePayer`] as an
388 /// [`EventHandler`]. Otherwise, calling this method is unnecessary.
389 pub fn remove_cached_payment(&self, payment_hash: &PaymentHash) {
390 self.payment_cache.lock().unwrap().remove(payment_hash);
394 fn expiry_time_from_unix_epoch(invoice: &Invoice) -> Duration {
395 invoice.timestamp().duration_since(SystemTime::UNIX_EPOCH).unwrap() + invoice.expiry_time()
398 fn has_expired(params: &RouteParameters) -> bool {
399 if let Some(expiry_time) = params.payee.expiry_time {
400 Invoice::is_expired_from_epoch(&SystemTime::UNIX_EPOCH, Duration::from_secs(expiry_time))
404 impl<P: Deref, R, S: Deref, L: Deref, E> EventHandler for InvoicePayer<P, R, S, L, E>
407 R: for <'a> Router<<<S as Deref>::Target as routing::LockableScore<'a>>::Locked>,
408 S::Target: for <'a> routing::LockableScore<'a>,
412 fn handle_event(&self, event: &Event) {
414 Event::PaymentPathFailed {
415 all_paths_failed, payment_id, payment_hash, rejected_by_dest, path, short_channel_id, retry, ..
417 if let Some(short_channel_id) = short_channel_id {
418 self.scorer.lock().payment_path_failed(path, *short_channel_id);
421 if *rejected_by_dest {
422 log_trace!(self.logger, "Payment {} rejected by destination; not retrying", log_bytes!(payment_hash.0));
423 } else if payment_id.is_none() {
424 log_trace!(self.logger, "Payment {} has no id; not retrying", log_bytes!(payment_hash.0));
425 } else if let Some(params) = retry {
426 if self.retry_payment(payment_id.unwrap(), *payment_hash, params).is_ok() {
427 // We retried at least somewhat, don't provide the PaymentPathFailed event to the user.
431 log_trace!(self.logger, "Payment {} missing retry params; not retrying", log_bytes!(payment_hash.0));
433 if *all_paths_failed { self.payment_cache.lock().unwrap().remove(payment_hash); }
435 Event::PaymentSent { payment_hash, .. } => {
436 let mut payment_cache = self.payment_cache.lock().unwrap();
437 let attempts = payment_cache
438 .remove(payment_hash)
439 .map_or(1, |attempts| attempts + 1);
440 log_trace!(self.logger, "Payment {} succeeded (attempts: {})", log_bytes!(payment_hash.0), attempts);
445 // Delegate to the decorated event handler unless the payment is retried.
446 self.event_handler.handle_event(event)
453 use crate::{DEFAULT_EXPIRY_TIME, InvoiceBuilder, Currency};
454 use utils::create_invoice_from_channelmanager;
455 use bitcoin_hashes::sha256::Hash as Sha256;
456 use lightning::ln::PaymentPreimage;
457 use lightning::ln::features::{ChannelFeatures, NodeFeatures, InitFeatures};
458 use lightning::ln::functional_test_utils::*;
459 use lightning::ln::msgs::{ErrorAction, LightningError};
460 use lightning::routing::network_graph::NodeId;
461 use lightning::routing::router::{Payee, Route, RouteHop};
462 use lightning::util::test_utils::TestLogger;
463 use lightning::util::errors::APIError;
464 use lightning::util::events::{Event, MessageSendEventsProvider};
465 use secp256k1::{SecretKey, PublicKey, Secp256k1};
466 use std::cell::RefCell;
467 use std::collections::VecDeque;
468 use std::time::{SystemTime, Duration};
470 fn invoice(payment_preimage: PaymentPreimage) -> Invoice {
471 let payment_hash = Sha256::hash(&payment_preimage.0);
472 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
473 InvoiceBuilder::new(Currency::Bitcoin)
474 .description("test".into())
475 .payment_hash(payment_hash)
476 .payment_secret(PaymentSecret([0; 32]))
478 .min_final_cltv_expiry(144)
479 .amount_milli_satoshis(128)
480 .build_signed(|hash| {
481 Secp256k1::new().sign_recoverable(hash, &private_key)
486 fn zero_value_invoice(payment_preimage: PaymentPreimage) -> Invoice {
487 let payment_hash = Sha256::hash(&payment_preimage.0);
488 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
489 InvoiceBuilder::new(Currency::Bitcoin)
490 .description("test".into())
491 .payment_hash(payment_hash)
492 .payment_secret(PaymentSecret([0; 32]))
494 .min_final_cltv_expiry(144)
495 .build_signed(|hash| {
496 Secp256k1::new().sign_recoverable(hash, &private_key)
501 fn expired_invoice(payment_preimage: PaymentPreimage) -> Invoice {
502 let payment_hash = Sha256::hash(&payment_preimage.0);
503 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
504 let timestamp = SystemTime::now()
505 .checked_sub(Duration::from_secs(DEFAULT_EXPIRY_TIME * 2))
507 InvoiceBuilder::new(Currency::Bitcoin)
508 .description("test".into())
509 .payment_hash(payment_hash)
510 .payment_secret(PaymentSecret([0; 32]))
511 .timestamp(timestamp)
512 .min_final_cltv_expiry(144)
513 .amount_milli_satoshis(128)
514 .build_signed(|hash| {
515 Secp256k1::new().sign_recoverable(hash, &private_key)
521 fn pays_invoice_on_first_attempt() {
522 let event_handled = core::cell::RefCell::new(false);
523 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
525 let payment_preimage = PaymentPreimage([1; 32]);
526 let invoice = invoice(payment_preimage);
527 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
529 let payer = TestPayer::new();
530 let router = TestRouter {};
531 let scorer = RefCell::new(TestScorer::new());
532 let logger = TestLogger::new();
534 InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(0));
536 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
537 assert_eq!(*payer.attempts.borrow(), 1);
539 invoice_payer.handle_event(&Event::PaymentSent {
540 payment_id, payment_preimage, payment_hash, fee_paid_msat: None
542 assert_eq!(*event_handled.borrow(), true);
543 assert_eq!(*payer.attempts.borrow(), 1);
547 fn pays_invoice_on_retry() {
548 let event_handled = core::cell::RefCell::new(false);
549 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
551 let payment_preimage = PaymentPreimage([1; 32]);
552 let invoice = invoice(payment_preimage);
553 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
554 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
556 let payer = TestPayer::new()
557 .expect_value_msat(final_value_msat)
558 .expect_value_msat(final_value_msat / 2);
559 let router = TestRouter {};
560 let scorer = RefCell::new(TestScorer::new());
561 let logger = TestLogger::new();
563 InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
565 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
566 assert_eq!(*payer.attempts.borrow(), 1);
568 let event = Event::PaymentPathFailed {
571 network_update: None,
572 rejected_by_dest: false,
573 all_paths_failed: false,
574 path: TestRouter::path_for_value(final_value_msat),
575 short_channel_id: None,
576 retry: Some(TestRouter::retry_for_invoice(&invoice)),
578 invoice_payer.handle_event(&event);
579 assert_eq!(*event_handled.borrow(), false);
580 assert_eq!(*payer.attempts.borrow(), 2);
582 invoice_payer.handle_event(&Event::PaymentSent {
583 payment_id, payment_preimage, payment_hash, fee_paid_msat: None
585 assert_eq!(*event_handled.borrow(), true);
586 assert_eq!(*payer.attempts.borrow(), 2);
590 fn retries_payment_path_for_unknown_payment() {
591 let event_handled = core::cell::RefCell::new(false);
592 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
594 let payment_preimage = PaymentPreimage([1; 32]);
595 let invoice = invoice(payment_preimage);
596 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
597 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
599 let payer = TestPayer::new();
600 let router = TestRouter {};
601 let scorer = RefCell::new(TestScorer::new());
602 let logger = TestLogger::new();
604 InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
606 let payment_id = Some(PaymentId([1; 32]));
607 let event = Event::PaymentPathFailed {
610 network_update: None,
611 rejected_by_dest: false,
612 all_paths_failed: false,
613 path: TestRouter::path_for_value(final_value_msat),
614 short_channel_id: None,
615 retry: Some(TestRouter::retry_for_invoice(&invoice)),
617 invoice_payer.handle_event(&event);
618 assert_eq!(*event_handled.borrow(), false);
619 assert_eq!(*payer.attempts.borrow(), 1);
621 invoice_payer.handle_event(&event);
622 assert_eq!(*event_handled.borrow(), false);
623 assert_eq!(*payer.attempts.borrow(), 2);
625 invoice_payer.handle_event(&Event::PaymentSent {
626 payment_id, payment_preimage, payment_hash, fee_paid_msat: None
628 assert_eq!(*event_handled.borrow(), true);
629 assert_eq!(*payer.attempts.borrow(), 2);
633 fn fails_paying_invoice_after_max_retries() {
634 let event_handled = core::cell::RefCell::new(false);
635 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
637 let payment_preimage = PaymentPreimage([1; 32]);
638 let invoice = invoice(payment_preimage);
639 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
641 let payer = TestPayer::new()
642 .expect_value_msat(final_value_msat)
643 .expect_value_msat(final_value_msat / 2)
644 .expect_value_msat(final_value_msat / 2);
645 let router = TestRouter {};
646 let scorer = RefCell::new(TestScorer::new());
647 let logger = TestLogger::new();
649 InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
651 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
652 assert_eq!(*payer.attempts.borrow(), 1);
654 let event = Event::PaymentPathFailed {
656 payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
657 network_update: None,
658 rejected_by_dest: false,
659 all_paths_failed: true,
660 path: TestRouter::path_for_value(final_value_msat),
661 short_channel_id: None,
662 retry: Some(TestRouter::retry_for_invoice(&invoice)),
664 invoice_payer.handle_event(&event);
665 assert_eq!(*event_handled.borrow(), false);
666 assert_eq!(*payer.attempts.borrow(), 2);
668 let event = Event::PaymentPathFailed {
670 payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
671 network_update: None,
672 rejected_by_dest: false,
673 all_paths_failed: false,
674 path: TestRouter::path_for_value(final_value_msat / 2),
675 short_channel_id: None,
676 retry: Some(RouteParameters {
677 final_value_msat: final_value_msat / 2, ..TestRouter::retry_for_invoice(&invoice)
680 invoice_payer.handle_event(&event);
681 assert_eq!(*event_handled.borrow(), false);
682 assert_eq!(*payer.attempts.borrow(), 3);
684 invoice_payer.handle_event(&event);
685 assert_eq!(*event_handled.borrow(), true);
686 assert_eq!(*payer.attempts.borrow(), 3);
690 fn fails_paying_invoice_with_missing_retry_params() {
691 let event_handled = core::cell::RefCell::new(false);
692 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
694 let payer = TestPayer::new();
695 let router = TestRouter {};
696 let scorer = RefCell::new(TestScorer::new());
697 let logger = TestLogger::new();
699 InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
701 let payment_preimage = PaymentPreimage([1; 32]);
702 let invoice = invoice(payment_preimage);
703 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
704 assert_eq!(*payer.attempts.borrow(), 1);
706 let event = Event::PaymentPathFailed {
708 payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
709 network_update: None,
710 rejected_by_dest: false,
711 all_paths_failed: false,
713 short_channel_id: None,
716 invoice_payer.handle_event(&event);
717 assert_eq!(*event_handled.borrow(), true);
718 assert_eq!(*payer.attempts.borrow(), 1);
722 fn fails_paying_invoice_after_expiration() {
723 let event_handled = core::cell::RefCell::new(false);
724 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
726 let payer = TestPayer::new();
727 let router = TestRouter {};
728 let scorer = RefCell::new(TestScorer::new());
729 let logger = TestLogger::new();
731 InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
733 let payment_preimage = PaymentPreimage([1; 32]);
734 let invoice = expired_invoice(payment_preimage);
735 if let PaymentError::Invoice(msg) = invoice_payer.pay_invoice(&invoice).unwrap_err() {
736 assert_eq!(msg, "Invoice expired prior to send");
737 } else { panic!("Expected Invoice Error"); }
741 fn fails_retrying_invoice_after_expiration() {
742 let event_handled = core::cell::RefCell::new(false);
743 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
745 let payer = TestPayer::new();
746 let router = TestRouter {};
747 let scorer = RefCell::new(TestScorer::new());
748 let logger = TestLogger::new();
750 InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
752 let payment_preimage = PaymentPreimage([1; 32]);
753 let invoice = invoice(payment_preimage);
754 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
755 assert_eq!(*payer.attempts.borrow(), 1);
757 let mut retry_data = TestRouter::retry_for_invoice(&invoice);
758 retry_data.payee.expiry_time = Some(SystemTime::now()
759 .checked_sub(Duration::from_secs(2)).unwrap()
760 .duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs());
761 let event = Event::PaymentPathFailed {
763 payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
764 network_update: None,
765 rejected_by_dest: false,
766 all_paths_failed: false,
768 short_channel_id: None,
769 retry: Some(retry_data),
771 invoice_payer.handle_event(&event);
772 assert_eq!(*event_handled.borrow(), true);
773 assert_eq!(*payer.attempts.borrow(), 1);
777 fn fails_paying_invoice_after_retry_error() {
778 let event_handled = core::cell::RefCell::new(false);
779 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
781 let payment_preimage = PaymentPreimage([1; 32]);
782 let invoice = invoice(payment_preimage);
783 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
785 let payer = TestPayer::new()
787 .expect_value_msat(final_value_msat);
788 let router = TestRouter {};
789 let scorer = RefCell::new(TestScorer::new());
790 let logger = TestLogger::new();
792 InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
794 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
795 assert_eq!(*payer.attempts.borrow(), 1);
797 let event = Event::PaymentPathFailed {
799 payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
800 network_update: None,
801 rejected_by_dest: false,
802 all_paths_failed: false,
803 path: TestRouter::path_for_value(final_value_msat / 2),
804 short_channel_id: None,
805 retry: Some(TestRouter::retry_for_invoice(&invoice)),
807 invoice_payer.handle_event(&event);
808 assert_eq!(*event_handled.borrow(), true);
809 assert_eq!(*payer.attempts.borrow(), 2);
813 fn fails_paying_invoice_after_rejected_by_payee() {
814 let event_handled = core::cell::RefCell::new(false);
815 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
817 let payer = TestPayer::new();
818 let router = TestRouter {};
819 let scorer = RefCell::new(TestScorer::new());
820 let logger = TestLogger::new();
822 InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
824 let payment_preimage = PaymentPreimage([1; 32]);
825 let invoice = invoice(payment_preimage);
826 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
827 assert_eq!(*payer.attempts.borrow(), 1);
829 let event = Event::PaymentPathFailed {
831 payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
832 network_update: None,
833 rejected_by_dest: true,
834 all_paths_failed: false,
836 short_channel_id: None,
837 retry: Some(TestRouter::retry_for_invoice(&invoice)),
839 invoice_payer.handle_event(&event);
840 assert_eq!(*event_handled.borrow(), true);
841 assert_eq!(*payer.attempts.borrow(), 1);
845 fn fails_repaying_invoice_with_pending_payment() {
846 let event_handled = core::cell::RefCell::new(false);
847 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
849 let payer = TestPayer::new();
850 let router = TestRouter {};
851 let scorer = RefCell::new(TestScorer::new());
852 let logger = TestLogger::new();
854 InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(0));
856 let payment_preimage = PaymentPreimage([1; 32]);
857 let invoice = invoice(payment_preimage);
858 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
860 // Cannot repay an invoice pending payment.
861 match invoice_payer.pay_invoice(&invoice) {
862 Err(PaymentError::Invoice("payment pending")) => {},
863 Err(_) => panic!("unexpected error"),
864 Ok(_) => panic!("expected invoice error"),
867 // Can repay an invoice once cleared from cache.
868 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
869 invoice_payer.remove_cached_payment(&payment_hash);
870 assert!(invoice_payer.pay_invoice(&invoice).is_ok());
872 // Cannot retry paying an invoice if cleared from cache.
873 invoice_payer.remove_cached_payment(&payment_hash);
874 let event = Event::PaymentPathFailed {
877 network_update: None,
878 rejected_by_dest: false,
879 all_paths_failed: false,
881 short_channel_id: None,
882 retry: Some(TestRouter::retry_for_invoice(&invoice)),
884 invoice_payer.handle_event(&event);
885 assert_eq!(*event_handled.borrow(), true);
889 fn fails_paying_invoice_with_routing_errors() {
890 let payer = TestPayer::new();
891 let router = FailingRouter {};
892 let scorer = RefCell::new(TestScorer::new());
893 let logger = TestLogger::new();
895 InvoicePayer::new(&payer, router, &scorer, &logger, |_: &_| {}, RetryAttempts(0));
897 let payment_preimage = PaymentPreimage([1; 32]);
898 let invoice = invoice(payment_preimage);
899 match invoice_payer.pay_invoice(&invoice) {
900 Err(PaymentError::Routing(_)) => {},
901 Err(_) => panic!("unexpected error"),
902 Ok(_) => panic!("expected routing error"),
907 fn fails_paying_invoice_with_sending_errors() {
908 let payer = TestPayer::new().fails_on_attempt(1);
909 let router = TestRouter {};
910 let scorer = RefCell::new(TestScorer::new());
911 let logger = TestLogger::new();
913 InvoicePayer::new(&payer, router, &scorer, &logger, |_: &_| {}, RetryAttempts(0));
915 let payment_preimage = PaymentPreimage([1; 32]);
916 let invoice = invoice(payment_preimage);
917 match invoice_payer.pay_invoice(&invoice) {
918 Err(PaymentError::Sending(_)) => {},
919 Err(_) => panic!("unexpected error"),
920 Ok(_) => panic!("expected sending error"),
925 fn pays_zero_value_invoice_using_amount() {
926 let event_handled = core::cell::RefCell::new(false);
927 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
929 let payment_preimage = PaymentPreimage([1; 32]);
930 let invoice = zero_value_invoice(payment_preimage);
931 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
932 let final_value_msat = 100;
934 let payer = TestPayer::new().expect_value_msat(final_value_msat);
935 let router = TestRouter {};
936 let scorer = RefCell::new(TestScorer::new());
937 let logger = TestLogger::new();
939 InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(0));
942 Some(invoice_payer.pay_zero_value_invoice(&invoice, final_value_msat).unwrap());
943 assert_eq!(*payer.attempts.borrow(), 1);
945 invoice_payer.handle_event(&Event::PaymentSent {
946 payment_id, payment_preimage, payment_hash, fee_paid_msat: None
948 assert_eq!(*event_handled.borrow(), true);
949 assert_eq!(*payer.attempts.borrow(), 1);
953 fn fails_paying_zero_value_invoice_with_amount() {
954 let event_handled = core::cell::RefCell::new(false);
955 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
957 let payer = TestPayer::new();
958 let router = TestRouter {};
959 let scorer = RefCell::new(TestScorer::new());
960 let logger = TestLogger::new();
962 InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(0));
964 let payment_preimage = PaymentPreimage([1; 32]);
965 let invoice = invoice(payment_preimage);
967 // Cannot repay an invoice pending payment.
968 match invoice_payer.pay_zero_value_invoice(&invoice, 100) {
969 Err(PaymentError::Invoice("amount unexpected")) => {},
970 Err(_) => panic!("unexpected error"),
971 Ok(_) => panic!("expected invoice error"),
976 fn scores_failed_channel() {
977 let event_handled = core::cell::RefCell::new(false);
978 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
980 let payment_preimage = PaymentPreimage([1; 32]);
981 let invoice = invoice(payment_preimage);
982 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
983 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
984 let path = TestRouter::path_for_value(final_value_msat);
985 let short_channel_id = Some(path[0].short_channel_id);
987 // Expect that scorer is given short_channel_id upon handling the event.
988 let payer = TestPayer::new();
989 let router = TestRouter {};
990 let scorer = RefCell::new(TestScorer::new().expect_channel_failure(short_channel_id.unwrap()));
991 let logger = TestLogger::new();
993 InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2));
995 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
996 let event = Event::PaymentPathFailed {
999 network_update: None,
1000 rejected_by_dest: false,
1001 all_paths_failed: false,
1004 retry: Some(TestRouter::retry_for_invoice(&invoice)),
1006 invoice_payer.handle_event(&event);
1012 fn route_for_value(final_value_msat: u64) -> Route {
1016 pubkey: PublicKey::from_slice(&hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
1017 channel_features: ChannelFeatures::empty(),
1018 node_features: NodeFeatures::empty(),
1019 short_channel_id: 0, fee_msat: final_value_msat / 2, cltv_expiry_delta: 144
1022 pubkey: PublicKey::from_slice(&hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
1023 channel_features: ChannelFeatures::empty(),
1024 node_features: NodeFeatures::empty(),
1025 short_channel_id: 1, fee_msat: final_value_msat / 2, cltv_expiry_delta: 144
1032 fn path_for_value(final_value_msat: u64) -> Vec<RouteHop> {
1033 TestRouter::route_for_value(final_value_msat).paths[0].clone()
1036 fn retry_for_invoice(invoice: &Invoice) -> RouteParameters {
1037 let mut payee = Payee::new(invoice.recover_payee_pub_key())
1038 .with_expiry_time(expiry_time_from_unix_epoch(invoice).as_secs())
1039 .with_route_hints(invoice.route_hints());
1040 if let Some(features) = invoice.features() {
1041 payee = payee.with_features(features.clone());
1043 let final_value_msat = invoice.amount_milli_satoshis().unwrap() / 2;
1047 final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
1052 impl<S: routing::Score> Router<S> for TestRouter {
1056 params: &RouteParameters,
1057 _first_hops: Option<&[&ChannelDetails]>,
1059 ) -> Result<Route, LightningError> {
1061 payee: Some(params.payee.clone()), ..Self::route_for_value(params.final_value_msat)
1066 struct FailingRouter;
1068 impl<S: routing::Score> Router<S> for FailingRouter {
1072 _params: &RouteParameters,
1073 _first_hops: Option<&[&ChannelDetails]>,
1075 ) -> Result<Route, LightningError> {
1076 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError })
1081 expectations: VecDeque<u64>,
1087 expectations: VecDeque::new(),
1091 fn expect_channel_failure(mut self, short_channel_id: u64) -> Self {
1092 self.expectations.push_back(short_channel_id);
1097 impl routing::Score for TestScorer {
1098 fn channel_penalty_msat(
1099 &self, _short_channel_id: u64, _source: &NodeId, _target: &NodeId
1102 fn payment_path_failed(&mut self, _path: &Vec<RouteHop>, short_channel_id: u64) {
1103 if let Some(expected_short_channel_id) = self.expectations.pop_front() {
1104 assert_eq!(short_channel_id, expected_short_channel_id);
1109 impl Drop for TestScorer {
1110 fn drop(&mut self) {
1111 if std::thread::panicking() {
1115 if !self.expectations.is_empty() {
1116 panic!("Unsatisfied channel failure expectations: {:?}", self.expectations);
1122 expectations: core::cell::RefCell<VecDeque<u64>>,
1123 attempts: core::cell::RefCell<usize>,
1124 failing_on_attempt: Option<usize>,
1130 expectations: core::cell::RefCell::new(VecDeque::new()),
1131 attempts: core::cell::RefCell::new(0),
1132 failing_on_attempt: None,
1136 fn expect_value_msat(self, value_msat: u64) -> Self {
1137 self.expectations.borrow_mut().push_back(value_msat);
1141 fn fails_on_attempt(self, attempt: usize) -> Self {
1143 expectations: core::cell::RefCell::new(self.expectations.borrow().clone()),
1144 attempts: core::cell::RefCell::new(0),
1145 failing_on_attempt: Some(attempt),
1149 fn check_attempts(&self) -> bool {
1150 let mut attempts = self.attempts.borrow_mut();
1152 match self.failing_on_attempt {
1154 Some(attempt) if attempt != *attempts => true,
1159 fn check_value_msats(&self, route: &Route) {
1160 let expected_value_msats = self.expectations.borrow_mut().pop_front();
1161 if let Some(expected_value_msats) = expected_value_msats {
1162 let actual_value_msats = route.get_total_amount();
1163 assert_eq!(actual_value_msats, expected_value_msats);
1168 impl Drop for TestPayer {
1169 fn drop(&mut self) {
1170 if std::thread::panicking() {
1174 if !self.expectations.borrow().is_empty() {
1175 panic!("Unsatisfied payment expectations: {:?}", self.expectations.borrow());
1180 impl Payer for TestPayer {
1181 fn node_id(&self) -> PublicKey {
1182 let secp_ctx = Secp256k1::new();
1183 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap())
1186 fn first_hops(&self) -> Vec<ChannelDetails> {
1193 _payment_hash: PaymentHash,
1194 _payment_secret: &Option<PaymentSecret>
1195 ) -> Result<PaymentId, PaymentSendFailure> {
1196 if self.check_attempts() {
1197 self.check_value_msats(route);
1198 Ok(PaymentId([1; 32]))
1200 Err(PaymentSendFailure::ParameterError(APIError::MonitorUpdateFailed))
1205 &self, route: &Route, _payment_id: PaymentId
1206 ) -> Result<(), PaymentSendFailure> {
1207 if self.check_attempts() {
1208 self.check_value_msats(route);
1211 Err(PaymentSendFailure::ParameterError(APIError::MonitorUpdateFailed))
1216 // *** Full Featured Functional Tests with a Real ChannelManager ***
1217 struct ManualRouter(RefCell<VecDeque<Result<Route, LightningError>>>);
1219 impl<S: routing::Score> Router<S> for ManualRouter {
1220 fn find_route(&self, _payer: &PublicKey, _params: &RouteParameters, _first_hops: Option<&[&ChannelDetails]>, _scorer: &S)
1221 -> Result<Route, LightningError> {
1222 self.0.borrow_mut().pop_front().unwrap()
1226 fn expect_find_route(&self, result: Result<Route, LightningError>) {
1227 self.0.borrow_mut().push_back(result);
1230 impl Drop for ManualRouter {
1231 fn drop(&mut self) {
1232 if std::thread::panicking() {
1235 assert!(self.0.borrow_mut().is_empty());
1240 fn retry_multi_path_single_failed_payment() {
1241 // Tests that we can/will retry after a single path of an MPP payment failed immediately
1242 let chanmon_cfgs = create_chanmon_cfgs(2);
1243 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1244 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1245 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1247 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0, InitFeatures::known(), InitFeatures::known());
1248 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0, InitFeatures::known(), InitFeatures::known());
1249 let chans = nodes[0].node.list_usable_channels();
1250 let mut route = Route {
1253 pubkey: nodes[1].node.get_our_node_id(),
1254 node_features: NodeFeatures::known(),
1255 short_channel_id: chans[0].short_channel_id.unwrap(),
1256 channel_features: ChannelFeatures::known(),
1258 cltv_expiry_delta: 100,
1261 pubkey: nodes[1].node.get_our_node_id(),
1262 node_features: NodeFeatures::known(),
1263 short_channel_id: chans[1].short_channel_id.unwrap(),
1264 channel_features: ChannelFeatures::known(),
1265 fee_msat: 100_000_001, // Our default max-HTLC-value is 10% of the channel value, which this is one more than
1266 cltv_expiry_delta: 100,
1269 payee: Some(Payee::new(nodes[1].node.get_our_node_id())),
1271 let router = ManualRouter(RefCell::new(VecDeque::new()));
1272 router.expect_find_route(Ok(route.clone()));
1273 // On retry, split the payment across both channels.
1274 route.paths[0][0].fee_msat = 50_000_001;
1275 route.paths[1][0].fee_msat = 50_000_000;
1276 router.expect_find_route(Ok(route.clone()));
1278 let event_handler = |_: &_| { panic!(); };
1279 let scorer = RefCell::new(TestScorer::new());
1280 let invoice_payer = InvoicePayer::new(nodes[0].node, router, &scorer, nodes[0].logger, event_handler, RetryAttempts(1));
1282 assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager(
1283 &nodes[1].node, nodes[1].keys_manager, Currency::Bitcoin, Some(100_010_000), "Invoice".to_string()).unwrap())
1285 let htlc_msgs = nodes[0].node.get_and_clear_pending_msg_events();
1286 assert_eq!(htlc_msgs.len(), 2);
1287 check_added_monitors!(nodes[0], 2);
1291 fn immediate_retry_on_failure() {
1292 // Tests that we can/will retry immediately after a failure
1293 let chanmon_cfgs = create_chanmon_cfgs(2);
1294 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1295 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
1296 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1298 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0, InitFeatures::known(), InitFeatures::known());
1299 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0, InitFeatures::known(), InitFeatures::known());
1300 let chans = nodes[0].node.list_usable_channels();
1301 let mut route = Route {
1304 pubkey: nodes[1].node.get_our_node_id(),
1305 node_features: NodeFeatures::known(),
1306 short_channel_id: chans[0].short_channel_id.unwrap(),
1307 channel_features: ChannelFeatures::known(),
1308 fee_msat: 100_000_001, // Our default max-HTLC-value is 10% of the channel value, which this is one more than
1309 cltv_expiry_delta: 100,
1312 payee: Some(Payee::new(nodes[1].node.get_our_node_id())),
1314 let router = ManualRouter(RefCell::new(VecDeque::new()));
1315 router.expect_find_route(Ok(route.clone()));
1316 // On retry, split the payment across both channels.
1317 route.paths.push(route.paths[0].clone());
1318 route.paths[0][0].short_channel_id = chans[1].short_channel_id.unwrap();
1319 route.paths[0][0].fee_msat = 50_000_000;
1320 route.paths[1][0].fee_msat = 50_000_001;
1321 router.expect_find_route(Ok(route.clone()));
1323 let event_handler = |_: &_| { panic!(); };
1324 let scorer = RefCell::new(TestScorer::new());
1325 let invoice_payer = InvoicePayer::new(nodes[0].node, router, &scorer, nodes[0].logger, event_handler, RetryAttempts(1));
1327 assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager(
1328 &nodes[1].node, nodes[1].keys_manager, Currency::Bitcoin, Some(100_010_000), "Invoice".to_string()).unwrap())
1330 let htlc_msgs = nodes[0].node.get_and_clear_pending_msg_events();
1331 assert_eq!(htlc_msgs.len(), 2);
1332 check_added_monitors!(nodes[0], 2);