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 and sending spontaneous payments.
12 //! Defines an [`InvoicePayer`] utility for sending payments, 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`], when
18 //! [`InvoicePayer`] uses its [`Router`] parameterization for optionally notifying scorers upon
19 //! receiving the [`Event::PaymentPathFailed`] and [`Event::PaymentPathSuccessful`] events.
20 //! It also does the same for payment probe failure and success events using [`Event::ProbeFailed`]
21 //! and [`Event::ProbeSuccessful`].
23 //! [`InvoicePayer`] is capable of retrying failed payments. It accomplishes this by implementing
24 //! [`EventHandler`] which decorates a user-provided handler. It will intercept any
25 //! [`Event::PaymentPathFailed`] events and retry the failed paths for a fixed number of total
26 //! attempts or until retry is no longer possible. In such a situation, [`InvoicePayer`] will pass
27 //! along the events to the user-provided handler.
32 //! # extern crate lightning;
33 //! # extern crate lightning_invoice;
34 //! # extern crate secp256k1;
36 //! # use lightning::io;
37 //! # use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
38 //! # use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure};
39 //! # use lightning::ln::msgs::LightningError;
40 //! # use lightning::routing::gossip::NodeId;
41 //! # use lightning::routing::router::{Route, RouteHop, RouteParameters};
42 //! # use lightning::routing::scoring::{ChannelUsage, Score};
43 //! # use lightning::util::events::{Event, EventHandler, EventsProvider};
44 //! # use lightning::util::logger::{Logger, Record};
45 //! # use lightning::util::ser::{Writeable, Writer};
46 //! # use lightning_invoice::Invoice;
47 //! # use lightning_invoice::payment::{InFlightHtlcs, InvoicePayer, Payer, Retry, Router};
48 //! # use secp256k1::PublicKey;
49 //! # use std::cell::RefCell;
50 //! # use std::ops::Deref;
52 //! # struct FakeEventProvider {}
53 //! # impl EventsProvider for FakeEventProvider {
54 //! # fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {}
57 //! # struct FakePayer {}
58 //! # impl Payer for FakePayer {
59 //! # fn node_id(&self) -> PublicKey { unimplemented!() }
60 //! # fn first_hops(&self) -> Vec<ChannelDetails> { unimplemented!() }
61 //! # fn send_payment(
62 //! # &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>
63 //! # ) -> Result<PaymentId, PaymentSendFailure> { unimplemented!() }
64 //! # fn send_spontaneous_payment(
65 //! # &self, route: &Route, payment_preimage: PaymentPreimage
66 //! # ) -> Result<PaymentId, PaymentSendFailure> { unimplemented!() }
67 //! # fn retry_payment(
68 //! # &self, route: &Route, payment_id: PaymentId
69 //! # ) -> Result<(), PaymentSendFailure> { unimplemented!() }
70 //! # fn abandon_payment(&self, payment_id: PaymentId) { unimplemented!() }
73 //! # struct FakeRouter {}
74 //! # impl Router for FakeRouter {
76 //! # &self, payer: &PublicKey, params: &RouteParameters,
77 //! # first_hops: Option<&[&ChannelDetails]>, _inflight_htlcs: InFlightHtlcs
78 //! # ) -> Result<Route, LightningError> { unimplemented!() }
80 //! # fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) { unimplemented!() }
81 //! # fn notify_payment_path_successful(&self, path: &[&RouteHop]) { unimplemented!() }
82 //! # fn notify_payment_probe_successful(&self, path: &[&RouteHop]) { unimplemented!() }
83 //! # fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) { unimplemented!() }
86 //! # struct FakeScorer {}
87 //! # impl Writeable for FakeScorer {
88 //! # fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> { unimplemented!(); }
90 //! # impl Score for FakeScorer {
91 //! # fn channel_penalty_msat(
92 //! # &self, _short_channel_id: u64, _source: &NodeId, _target: &NodeId, _usage: ChannelUsage
94 //! # fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) {}
95 //! # fn payment_path_successful(&mut self, _path: &[&RouteHop]) {}
96 //! # fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) {}
97 //! # fn probe_successful(&mut self, _path: &[&RouteHop]) {}
100 //! # struct FakeLogger {}
101 //! # impl Logger for FakeLogger {
102 //! # fn log(&self, record: &Record) { unimplemented!() }
106 //! let event_handler = |event: &Event| {
108 //! Event::PaymentPathFailed { .. } => println!("payment failed after retries"),
109 //! Event::PaymentSent { .. } => println!("payment successful"),
113 //! # let payer = FakePayer {};
114 //! # let router = FakeRouter {};
115 //! # let scorer = RefCell::new(FakeScorer {});
116 //! # let logger = FakeLogger {};
117 //! let invoice_payer = InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
119 //! let invoice = "...";
120 //! if let Ok(invoice) = invoice.parse::<Invoice>() {
121 //! invoice_payer.pay_invoice(&invoice).unwrap();
123 //! # let event_provider = FakeEventProvider {};
125 //! event_provider.process_pending_events(&invoice_payer);
133 //! The [`Route`] is computed before each payment attempt. Any updates affecting path finding such
134 //! as updates to the network graph or changes to channel scores should be applied prior to
135 //! retries, typically by way of composing [`EventHandler`]s accordingly.
139 use bitcoin_hashes::Hash;
140 use bitcoin_hashes::sha256::Hash as Sha256;
142 use crate::prelude::*;
144 use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
145 use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure};
146 use lightning::ln::msgs::LightningError;
147 use lightning::routing::gossip::NodeId;
148 use lightning::routing::router::{PaymentParameters, Route, RouteHop, RouteParameters};
149 use lightning::util::errors::APIError;
150 use lightning::util::events::{Event, EventHandler};
151 use lightning::util::logger::Logger;
152 use lightning::util::ser::Writeable;
153 use crate::time_utils::Time;
154 use crate::sync::Mutex;
156 use secp256k1::PublicKey;
159 use core::fmt::{Debug, Display, Formatter};
160 use core::ops::Deref;
161 use core::time::Duration;
162 #[cfg(feature = "std")]
163 use std::time::SystemTime;
165 /// A utility for paying [`Invoice`]s and sending spontaneous payments.
167 /// See [module-level documentation] for details.
169 /// [module-level documentation]: crate::payment
170 pub type InvoicePayer<P, R, L, E> = InvoicePayerUsingTime::<P, R, L, E, ConfiguredTime>;
172 #[cfg(not(feature = "no-std"))]
173 type ConfiguredTime = std::time::Instant;
174 #[cfg(feature = "no-std")]
175 use crate::time_utils;
176 #[cfg(feature = "no-std")]
177 type ConfiguredTime = time_utils::Eternity;
179 /// (C-not exported) generally all users should use the [`InvoicePayer`] type alias.
180 pub struct InvoicePayerUsingTime<P: Deref, R: Router, L: Deref, E: EventHandler, T: Time>
189 /// Caches the overall attempts at making a payment, which is updated prior to retrying.
190 payment_cache: Mutex<HashMap<PaymentHash, PaymentInfo<T>>>,
194 /// Used by [`InvoicePayerUsingTime::payment_cache`] to track the payments that are either
195 /// currently being made, or have outstanding paths that need retrying.
196 struct PaymentInfo<T: Time> {
197 attempts: PaymentAttempts<T>,
198 paths: Vec<Vec<RouteHop>>,
201 impl<T: Time> PaymentInfo<T> {
204 attempts: PaymentAttempts::new(),
210 /// Storing minimal payment attempts information required for determining if a outbound payment can
212 #[derive(Clone, Copy)]
213 struct PaymentAttempts<T: Time> {
214 /// This count will be incremented only after the result of the attempt is known. When it's 0,
215 /// it means the result of the first attempt is now known yet.
217 /// This field is only used when retry is [`Retry::Timeout`] which is only build with feature std
218 first_attempted_at: T
221 impl<T: Time> PaymentAttempts<T> {
225 first_attempted_at: T::now()
230 impl<T: Time> Display for PaymentAttempts<T> {
231 fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
232 #[cfg(feature = "no-std")]
233 return write!( f, "attempts: {}", self.count);
234 #[cfg(not(feature = "no-std"))]
237 "attempts: {}, duration: {}s",
239 T::now().duration_since(self.first_attempted_at).as_secs()
244 /// A trait defining behavior of an [`Invoice`] payer.
246 /// Returns the payer's node id.
247 fn node_id(&self) -> PublicKey;
249 /// Returns the payer's channels.
250 fn first_hops(&self) -> Vec<ChannelDetails>;
252 /// Sends a payment over the Lightning Network using the given [`Route`].
254 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>
255 ) -> Result<PaymentId, PaymentSendFailure>;
257 /// Sends a spontaneous payment over the Lightning Network using the given [`Route`].
258 fn send_spontaneous_payment(
259 &self, route: &Route, payment_preimage: PaymentPreimage
260 ) -> Result<PaymentId, PaymentSendFailure>;
262 /// Retries a failed payment path for the [`PaymentId`] using the given [`Route`].
263 fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure>;
265 /// Signals that no further retries for the given payment will occur.
266 fn abandon_payment(&self, payment_id: PaymentId);
269 /// A trait defining behavior for routing an [`Invoice`] payment.
271 /// Finds a [`Route`] between `payer` and `payee` for a payment with the given values.
273 &self, payer: &PublicKey, route_params: &RouteParameters,
274 first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs
275 ) -> Result<Route, LightningError>;
276 /// Lets the router know that payment through a specific path has failed.
277 fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64);
278 /// Lets the router know that payment through a specific path was successful.
279 fn notify_payment_path_successful(&self, path: &[&RouteHop]);
280 /// Lets the router know that a payment probe was successful.
281 fn notify_payment_probe_successful(&self, path: &[&RouteHop]);
282 /// Lets the router know that a payment probe failed.
283 fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64);
286 /// Strategies available to retry payment path failures for an [`Invoice`].
288 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
290 /// Max number of attempts to retry payment.
292 /// Note that this is the number of *path* failures, not full payment retries. For multi-path
293 /// payments, if this is less than the total number of paths, we will never even retry all of the
296 #[cfg(feature = "std")]
297 /// Time elapsed before abandoning retries for a payment.
302 fn is_retryable_now<T: Time>(&self, attempts: &PaymentAttempts<T>) -> bool {
303 match (self, attempts) {
304 (Retry::Attempts(max_retry_count), PaymentAttempts { count, .. }) => {
305 max_retry_count >= &count
307 #[cfg(feature = "std")]
308 (Retry::Timeout(max_duration), PaymentAttempts { first_attempted_at, .. } ) =>
309 *max_duration >= T::now().duration_since(*first_attempted_at),
314 /// An error that may occur when making a payment.
315 #[derive(Clone, Debug)]
316 pub enum PaymentError {
317 /// An error resulting from the provided [`Invoice`] or payment hash.
318 Invoice(&'static str),
319 /// An error occurring when finding a route.
320 Routing(LightningError),
321 /// An error occurring when sending a payment.
322 Sending(PaymentSendFailure),
325 impl<P: Deref, R: Router, L: Deref, E: EventHandler, T: Time> InvoicePayerUsingTime<P, R, L, E, T>
330 /// Creates an invoice payer that retries failed payment paths.
332 /// Will forward any [`Event::PaymentPathFailed`] events to the decorated `event_handler` once
333 /// `retry` has been exceeded for a given [`Invoice`].
335 payer: P, router: R, logger: L, event_handler: E, retry: Retry
342 payment_cache: Mutex::new(HashMap::new()),
347 /// Pays the given [`Invoice`], caching it for later use in case a retry is needed.
349 /// You should ensure that the `invoice.payment_hash()` is unique and the same payment_hash has
350 /// never been paid before. Because [`InvoicePayer`] is stateless no effort is made to do so
352 pub fn pay_invoice(&self, invoice: &Invoice) -> Result<PaymentId, PaymentError> {
353 if invoice.amount_milli_satoshis().is_none() {
354 Err(PaymentError::Invoice("amount missing"))
356 self.pay_invoice_using_amount(invoice, None)
360 /// Pays the given zero-value [`Invoice`] using the given amount, caching it for later use in
361 /// case a retry is needed.
363 /// You should ensure that the `invoice.payment_hash()` is unique and the same payment_hash has
364 /// never been paid before. Because [`InvoicePayer`] is stateless no effort is made to do so
366 pub fn pay_zero_value_invoice(
367 &self, invoice: &Invoice, amount_msats: u64
368 ) -> Result<PaymentId, PaymentError> {
369 if invoice.amount_milli_satoshis().is_some() {
370 Err(PaymentError::Invoice("amount unexpected"))
372 self.pay_invoice_using_amount(invoice, Some(amount_msats))
376 fn pay_invoice_using_amount(
377 &self, invoice: &Invoice, amount_msats: Option<u64>
378 ) -> Result<PaymentId, PaymentError> {
379 debug_assert!(invoice.amount_milli_satoshis().is_some() ^ amount_msats.is_some());
381 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
382 match self.payment_cache.lock().unwrap().entry(payment_hash) {
383 hash_map::Entry::Occupied(_) => return Err(PaymentError::Invoice("payment pending")),
384 hash_map::Entry::Vacant(entry) => entry.insert(PaymentInfo::new()),
387 let payment_secret = Some(invoice.payment_secret().clone());
388 let mut payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key())
389 .with_expiry_time(expiry_time_from_unix_epoch(&invoice).as_secs())
390 .with_route_hints(invoice.route_hints());
391 if let Some(features) = invoice.features() {
392 payment_params = payment_params.with_features(features.clone());
394 let route_params = RouteParameters {
396 final_value_msat: invoice.amount_milli_satoshis().or(amount_msats).unwrap(),
397 final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
400 let send_payment = |route: &Route| {
401 self.payer.send_payment(route, payment_hash, &payment_secret)
404 self.pay_internal(&route_params, payment_hash, send_payment)
405 .map_err(|e| { self.payment_cache.lock().unwrap().remove(&payment_hash); e })
408 /// Pays `pubkey` an amount using the hash of the given preimage, caching it for later use in
409 /// case a retry is needed.
411 /// You should ensure that `payment_preimage` is unique and that its `payment_hash` has never
412 /// been paid before. Because [`InvoicePayer`] is stateless no effort is made to do so for you.
414 &self, pubkey: PublicKey, payment_preimage: PaymentPreimage, amount_msats: u64,
415 final_cltv_expiry_delta: u32
416 ) -> Result<PaymentId, PaymentError> {
417 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
418 match self.payment_cache.lock().unwrap().entry(payment_hash) {
419 hash_map::Entry::Occupied(_) => return Err(PaymentError::Invoice("payment pending")),
420 hash_map::Entry::Vacant(entry) => entry.insert(PaymentInfo::new()),
423 let route_params = RouteParameters {
424 payment_params: PaymentParameters::for_keysend(pubkey),
425 final_value_msat: amount_msats,
426 final_cltv_expiry_delta,
429 let send_payment = |route: &Route| {
430 self.payer.send_spontaneous_payment(route, payment_preimage)
432 self.pay_internal(&route_params, payment_hash, send_payment)
433 .map_err(|e| { self.payment_cache.lock().unwrap().remove(&payment_hash); e })
436 fn pay_internal<F: FnOnce(&Route) -> Result<PaymentId, PaymentSendFailure> + Copy>(
437 &self, params: &RouteParameters, payment_hash: PaymentHash, send_payment: F,
438 ) -> Result<PaymentId, PaymentError> {
439 #[cfg(feature = "std")] {
440 if has_expired(params) {
441 log_trace!(self.logger, "Invoice expired prior to send for payment {}", log_bytes!(payment_hash.0));
442 return Err(PaymentError::Invoice("Invoice expired prior to send"));
446 let payer = self.payer.node_id();
447 let first_hops = self.payer.first_hops();
448 let inflight_htlcs = self.create_inflight_map();
449 let route = self.router.find_route(
450 &payer, ¶ms, Some(&first_hops.iter().collect::<Vec<_>>()), inflight_htlcs
451 ).map_err(|e| PaymentError::Routing(e))?;
453 match send_payment(&route) {
455 for path in route.paths {
456 self.process_path_inflight_htlcs(payment_hash, path);
461 PaymentSendFailure::ParameterError(_) => Err(e),
462 PaymentSendFailure::PathParameterError(_) => Err(e),
463 PaymentSendFailure::AllFailedRetrySafe(_) => {
464 let mut payment_cache = self.payment_cache.lock().unwrap();
465 let payment_info = payment_cache.get_mut(&payment_hash).unwrap();
466 payment_info.attempts.count += 1;
467 if self.retry.is_retryable_now(&payment_info.attempts) {
468 core::mem::drop(payment_cache);
469 Ok(self.pay_internal(params, payment_hash, send_payment)?)
474 PaymentSendFailure::PartialFailure { failed_paths_retry, payment_id, results } => {
475 // If a `PartialFailure` event returns a result that is an `Ok()`, it means that
476 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
477 // means that we are still waiting for our channel monitor update to be completed.
478 for (result, path) in results.iter().zip(route.paths.into_iter()) {
480 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
481 self.process_path_inflight_htlcs(payment_hash, path);
487 if let Some(retry_data) = failed_paths_retry {
488 // Some paths were sent, even if we failed to send the full MPP value our
489 // recipient may misbehave and claim the funds, at which point we have to
490 // consider the payment sent, so return `Ok()` here, ignoring any retry
492 let _ = self.retry_payment(payment_id, payment_hash, &retry_data);
495 // This may happen if we send a payment and some paths fail, but
496 // only due to a temporary monitor failure or the like, implying
497 // they're really in-flight, but we haven't sent the initial
498 // HTLC-Add messages yet.
503 }.map_err(|e| PaymentError::Sending(e))
506 // Takes in a path to have its information stored in `payment_cache`. This is done for paths
507 // that are pending retry.
508 fn process_path_inflight_htlcs(&self, payment_hash: PaymentHash, path: Vec<RouteHop>) {
509 self.payment_cache.lock().unwrap().entry(payment_hash)
510 .or_insert_with(|| PaymentInfo::new())
514 // Find the path we want to remove in `payment_cache`. If it doesn't exist, do nothing.
515 fn remove_path_inflight_htlcs(&self, payment_hash: PaymentHash, path: &Vec<RouteHop>) {
516 self.payment_cache.lock().unwrap().entry(payment_hash)
517 .and_modify(|payment_info| {
518 if let Some(idx) = payment_info.paths.iter().position(|p| p == path) {
519 payment_info.paths.swap_remove(idx);
525 &self, payment_id: PaymentId, payment_hash: PaymentHash, params: &RouteParameters
526 ) -> Result<(), ()> {
527 let attempts = self.payment_cache.lock().unwrap().entry(payment_hash)
528 .and_modify(|info| info.attempts.count += 1 )
529 .or_insert_with(|| PaymentInfo {
530 attempts: PaymentAttempts {
532 first_attempted_at: T::now(),
537 if !self.retry.is_retryable_now(&attempts) {
538 log_trace!(self.logger, "Payment {} exceeded maximum attempts; not retrying ({})", log_bytes!(payment_hash.0), attempts);
542 #[cfg(feature = "std")] {
543 if has_expired(params) {
544 log_trace!(self.logger, "Invoice expired for payment {}; not retrying ({:})", log_bytes!(payment_hash.0), attempts);
549 let payer = self.payer.node_id();
550 let first_hops = self.payer.first_hops();
551 let inflight_htlcs = self.create_inflight_map();
553 let route = self.router.find_route(
554 &payer, ¶ms, Some(&first_hops.iter().collect::<Vec<_>>()), inflight_htlcs
558 log_trace!(self.logger, "Failed to find a route for payment {}; not retrying ({:})", log_bytes!(payment_hash.0), attempts);
562 match self.payer.retry_payment(&route.as_ref().unwrap(), payment_id) {
564 for path in route.unwrap().paths.into_iter() {
565 self.process_path_inflight_htlcs(payment_hash, path);
569 Err(PaymentSendFailure::ParameterError(_)) |
570 Err(PaymentSendFailure::PathParameterError(_)) => {
571 log_trace!(self.logger, "Failed to retry for payment {} due to bogus route/payment data, not retrying.", log_bytes!(payment_hash.0));
574 Err(PaymentSendFailure::AllFailedRetrySafe(_)) => {
575 self.retry_payment(payment_id, payment_hash, params)
577 Err(PaymentSendFailure::PartialFailure { failed_paths_retry, results, .. }) => {
578 // If a `PartialFailure` error contains a result that is an `Ok()`, it means that
579 // part of our payment is retried. When we receive `MonitorUpdateInProgress`, it
580 // means that we are still waiting for our channel monitor update to complete.
581 for (result, path) in results.iter().zip(route.unwrap().paths.into_iter()) {
583 Ok(_) | Err(APIError::MonitorUpdateInProgress) => {
584 self.process_path_inflight_htlcs(payment_hash, path);
590 if let Some(retry) = failed_paths_retry {
591 // Always return Ok for the same reason as noted in pay_internal.
592 let _ = self.retry_payment(payment_id, payment_hash, &retry);
599 /// Removes the payment cached by the given payment hash.
601 /// Should be called once a payment has failed or succeeded if not using [`InvoicePayer`] as an
602 /// [`EventHandler`]. Otherwise, calling this method is unnecessary.
603 pub fn remove_cached_payment(&self, payment_hash: &PaymentHash) {
604 self.payment_cache.lock().unwrap().remove(payment_hash);
607 /// Use path information in the payment_cache to construct a HashMap mapping a channel's short
608 /// channel id and direction to the amount being sent through it.
610 /// This function should be called whenever we need information about currently used up liquidity
612 fn create_inflight_map(&self) -> InFlightHtlcs {
613 let mut total_inflight_map: HashMap<(u64, bool), u64> = HashMap::new();
614 // Make an attempt at finding existing payment information from `payment_cache`. If it
615 // does not exist, it probably is a fresh payment and we can just return an empty
617 for payment_info in self.payment_cache.lock().unwrap().values() {
618 for path in &payment_info.paths {
619 if path.is_empty() { break };
620 // total_inflight_map needs to be direction-sensitive when keeping track of the HTLC value
621 // that is held up. However, the `hops` array, which is a path returned by `find_route` in
622 // the router excludes the payer node. In the following lines, the payer's information is
623 // hardcoded with an inflight value of 0 so that we can correctly represent the first hop
624 // in our sliding window of two.
625 let our_node_id: PublicKey = self.payer.node_id();
626 let reversed_hops_with_payer = path.iter().rev().skip(1)
627 .map(|hop| hop.pubkey)
628 .chain(core::iter::once(our_node_id));
629 let mut cumulative_msat = 0;
631 // Taking the reversed vector from above, we zip it with just the reversed hops list to
632 // work "backwards" of the given path, since the last hop's `fee_msat` actually represents
633 // the total amount sent.
634 for (next_hop, prev_hop) in path.iter().rev().zip(reversed_hops_with_payer) {
635 cumulative_msat += next_hop.fee_msat;
637 .entry((next_hop.short_channel_id, NodeId::from_pubkey(&prev_hop) < NodeId::from_pubkey(&next_hop.pubkey)))
638 .and_modify(|used_liquidity_msat| *used_liquidity_msat += cumulative_msat)
639 .or_insert(cumulative_msat);
644 InFlightHtlcs(total_inflight_map)
648 fn expiry_time_from_unix_epoch(invoice: &Invoice) -> Duration {
649 invoice.signed_invoice.raw_invoice.data.timestamp.0 + invoice.expiry_time()
652 #[cfg(feature = "std")]
653 fn has_expired(route_params: &RouteParameters) -> bool {
654 if let Some(expiry_time) = route_params.payment_params.expiry_time {
655 Invoice::is_expired_from_epoch(&SystemTime::UNIX_EPOCH, Duration::from_secs(expiry_time))
659 impl<P: Deref, R: Router, L: Deref, E: EventHandler, T: Time> EventHandler for InvoicePayerUsingTime<P, R, L, E, T>
664 fn handle_event(&self, event: &Event) {
666 Event::PaymentPathFailed { payment_hash, path, .. }
667 | Event::PaymentPathSuccessful { path, payment_hash: Some(payment_hash), .. }
668 | Event::ProbeSuccessful { payment_hash, path, .. }
669 | Event::ProbeFailed { payment_hash, path, .. } => {
670 self.remove_path_inflight_htlcs(*payment_hash, path);
676 Event::PaymentPathFailed {
677 payment_id, payment_hash, payment_failed_permanently, path, short_channel_id, retry, ..
679 if let Some(short_channel_id) = short_channel_id {
680 let path = path.iter().collect::<Vec<_>>();
681 self.router.notify_payment_path_failed(&path, *short_channel_id)
684 if payment_id.is_none() {
685 log_trace!(self.logger, "Payment {} has no id; not retrying", log_bytes!(payment_hash.0));
686 } else if *payment_failed_permanently {
687 log_trace!(self.logger, "Payment {} rejected by destination; not retrying", log_bytes!(payment_hash.0));
688 self.payer.abandon_payment(payment_id.unwrap());
689 } else if retry.is_none() {
690 log_trace!(self.logger, "Payment {} missing retry params; not retrying", log_bytes!(payment_hash.0));
691 self.payer.abandon_payment(payment_id.unwrap());
692 } else if self.retry_payment(payment_id.unwrap(), *payment_hash, retry.as_ref().unwrap()).is_ok() {
693 // We retried at least somewhat, don't provide the PaymentPathFailed event to the user.
696 self.payer.abandon_payment(payment_id.unwrap());
699 Event::PaymentFailed { payment_hash, .. } => {
700 self.remove_cached_payment(&payment_hash);
702 Event::PaymentPathSuccessful { path, .. } => {
703 let path = path.iter().collect::<Vec<_>>();
704 self.router.notify_payment_path_successful(&path);
706 Event::PaymentSent { payment_hash, .. } => {
707 let mut payment_cache = self.payment_cache.lock().unwrap();
708 let attempts = payment_cache
709 .remove(payment_hash)
710 .map_or(1, |payment_info| payment_info.attempts.count + 1);
711 log_trace!(self.logger, "Payment {} succeeded (attempts: {})", log_bytes!(payment_hash.0), attempts);
713 Event::ProbeSuccessful { payment_hash, path, .. } => {
714 log_trace!(self.logger, "Probe payment {} of {}msat was successful", log_bytes!(payment_hash.0), path.last().unwrap().fee_msat);
715 let path = path.iter().collect::<Vec<_>>();
716 self.router.notify_payment_probe_successful(&path);
718 Event::ProbeFailed { payment_hash, path, short_channel_id, .. } => {
719 if let Some(short_channel_id) = short_channel_id {
720 log_trace!(self.logger, "Probe payment {} of {}msat failed at channel {}", log_bytes!(payment_hash.0), path.last().unwrap().fee_msat, *short_channel_id);
721 let path = path.iter().collect::<Vec<_>>();
722 self.router.notify_payment_probe_failed(&path, *short_channel_id);
728 // Delegate to the decorated event handler unless the payment is retried.
729 self.event_handler.handle_event(event)
733 /// A map with liquidity value (in msat) keyed by a short channel id and the direction the HTLC
734 /// is traveling in. The direction boolean is determined by checking if the HTLC source's public
735 /// key is less than its destination. See [`InFlightHtlcs::used_liquidity_msat`] for more
737 pub struct InFlightHtlcs(HashMap<(u64, bool), u64>);
740 /// Returns liquidity in msat given the public key of the HTLC source, target, and short channel
742 pub fn used_liquidity_msat(&self, source: &NodeId, target: &NodeId, channel_scid: u64) -> Option<u64> {
743 self.0.get(&(channel_scid, source < target)).map(|v| *v)
747 impl Writeable for InFlightHtlcs {
748 fn write<W: lightning::util::ser::Writer>(&self, writer: &mut W) -> Result<(), io::Error> { self.0.write(writer) }
751 impl lightning::util::ser::Readable for InFlightHtlcs {
752 fn read<R: io::Read>(reader: &mut R) -> Result<Self, lightning::ln::msgs::DecodeError> {
753 let infight_map: HashMap<(u64, bool), u64> = lightning::util::ser::Readable::read(reader)?;
754 Ok(Self(infight_map))
761 use crate::{InvoiceBuilder, Currency};
762 use crate::utils::{ScorerAccountingForInFlightHtlcs, create_invoice_from_channelmanager_and_duration_since_epoch};
763 use bitcoin_hashes::sha256::Hash as Sha256;
764 use lightning::ln::PaymentPreimage;
765 use lightning::ln::channelmanager;
766 use lightning::ln::features::{ChannelFeatures, NodeFeatures};
767 use lightning::ln::functional_test_utils::*;
768 use lightning::ln::msgs::{ChannelMessageHandler, ErrorAction, LightningError};
769 use lightning::routing::gossip::{EffectiveCapacity, NodeId};
770 use lightning::routing::router::{PaymentParameters, Route, RouteHop};
771 use lightning::routing::scoring::{ChannelUsage, LockableScore, Score};
772 use lightning::util::test_utils::TestLogger;
773 use lightning::util::errors::APIError;
774 use lightning::util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
775 use secp256k1::{SecretKey, PublicKey, Secp256k1};
776 use std::cell::RefCell;
777 use std::collections::VecDeque;
778 use std::ops::DerefMut;
779 use std::time::{SystemTime, Duration};
780 use crate::time_utils::tests::SinceEpoch;
781 use crate::DEFAULT_EXPIRY_TIME;
782 use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateInProgress};
784 fn invoice(payment_preimage: PaymentPreimage) -> Invoice {
785 let payment_hash = Sha256::hash(&payment_preimage.0);
786 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
788 InvoiceBuilder::new(Currency::Bitcoin)
789 .description("test".into())
790 .payment_hash(payment_hash)
791 .payment_secret(PaymentSecret([0; 32]))
792 .duration_since_epoch(duration_since_epoch())
793 .min_final_cltv_expiry(144)
794 .amount_milli_satoshis(128)
795 .build_signed(|hash| {
796 Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)
801 fn duration_since_epoch() -> Duration {
802 #[cfg(feature = "std")]
803 let duration_since_epoch =
804 SystemTime::now().duration_since(SystemTime::UNIX_EPOCH).unwrap();
805 #[cfg(not(feature = "std"))]
806 let duration_since_epoch = Duration::from_secs(1234567);
810 fn zero_value_invoice(payment_preimage: PaymentPreimage) -> Invoice {
811 let payment_hash = Sha256::hash(&payment_preimage.0);
812 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
814 InvoiceBuilder::new(Currency::Bitcoin)
815 .description("test".into())
816 .payment_hash(payment_hash)
817 .payment_secret(PaymentSecret([0; 32]))
818 .duration_since_epoch(duration_since_epoch())
819 .min_final_cltv_expiry(144)
820 .build_signed(|hash| {
821 Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)
826 #[cfg(feature = "std")]
827 fn expired_invoice(payment_preimage: PaymentPreimage) -> Invoice {
828 let payment_hash = Sha256::hash(&payment_preimage.0);
829 let private_key = SecretKey::from_slice(&[42; 32]).unwrap();
830 let duration = duration_since_epoch()
831 .checked_sub(Duration::from_secs(DEFAULT_EXPIRY_TIME * 2))
833 InvoiceBuilder::new(Currency::Bitcoin)
834 .description("test".into())
835 .payment_hash(payment_hash)
836 .payment_secret(PaymentSecret([0; 32]))
837 .duration_since_epoch(duration)
838 .min_final_cltv_expiry(144)
839 .amount_milli_satoshis(128)
840 .build_signed(|hash| {
841 Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key)
846 fn pubkey() -> PublicKey {
847 PublicKey::from_slice(&hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap()
851 fn pays_invoice_on_first_attempt() {
852 let event_handled = core::cell::RefCell::new(false);
853 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
855 let payment_preimage = PaymentPreimage([1; 32]);
856 let invoice = invoice(payment_preimage);
857 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
858 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
860 let payer = TestPayer::new().expect_send(Amount::ForInvoice(final_value_msat));
861 let router = TestRouter::new(TestScorer::new());
862 let logger = TestLogger::new();
864 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(0));
866 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
867 assert_eq!(*payer.attempts.borrow(), 1);
869 invoice_payer.handle_event(&Event::PaymentSent {
870 payment_id, payment_preimage, payment_hash, fee_paid_msat: None
872 assert_eq!(*event_handled.borrow(), true);
873 assert_eq!(*payer.attempts.borrow(), 1);
877 fn pays_invoice_on_retry() {
878 let event_handled = core::cell::RefCell::new(false);
879 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
881 let payment_preimage = PaymentPreimage([1; 32]);
882 let invoice = invoice(payment_preimage);
883 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
884 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
886 let payer = TestPayer::new()
887 .expect_send(Amount::ForInvoice(final_value_msat))
888 .expect_send(Amount::OnRetry(final_value_msat / 2));
889 let router = TestRouter::new(TestScorer::new());
890 let logger = TestLogger::new();
892 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
894 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
895 assert_eq!(*payer.attempts.borrow(), 1);
897 let event = Event::PaymentPathFailed {
900 network_update: None,
901 payment_failed_permanently: false,
902 all_paths_failed: false,
903 path: TestRouter::path_for_value(final_value_msat),
904 short_channel_id: None,
905 retry: Some(TestRouter::retry_for_invoice(&invoice)),
907 invoice_payer.handle_event(&event);
908 assert_eq!(*event_handled.borrow(), false);
909 assert_eq!(*payer.attempts.borrow(), 2);
911 invoice_payer.handle_event(&Event::PaymentSent {
912 payment_id, payment_preimage, payment_hash, fee_paid_msat: None
914 assert_eq!(*event_handled.borrow(), true);
915 assert_eq!(*payer.attempts.borrow(), 2);
919 fn pays_invoice_on_partial_failure() {
920 let event_handler = |_: &_| { panic!() };
922 let payment_preimage = PaymentPreimage([1; 32]);
923 let invoice = invoice(payment_preimage);
924 let retry = TestRouter::retry_for_invoice(&invoice);
925 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
927 let payer = TestPayer::new()
928 .fails_with_partial_failure(retry.clone(), OnAttempt(1), None)
929 .fails_with_partial_failure(retry, OnAttempt(2), None)
930 .expect_send(Amount::ForInvoice(final_value_msat))
931 .expect_send(Amount::OnRetry(final_value_msat / 2))
932 .expect_send(Amount::OnRetry(final_value_msat / 2));
933 let router = TestRouter::new(TestScorer::new());
934 let logger = TestLogger::new();
936 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
938 assert!(invoice_payer.pay_invoice(&invoice).is_ok());
942 fn retries_payment_path_for_unknown_payment() {
943 let event_handled = core::cell::RefCell::new(false);
944 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
946 let payment_preimage = PaymentPreimage([1; 32]);
947 let invoice = invoice(payment_preimage);
948 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
949 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
951 let payer = TestPayer::new()
952 .expect_send(Amount::OnRetry(final_value_msat / 2))
953 .expect_send(Amount::OnRetry(final_value_msat / 2));
954 let router = TestRouter::new(TestScorer::new());
955 let logger = TestLogger::new();
957 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
959 let payment_id = Some(PaymentId([1; 32]));
960 let event = Event::PaymentPathFailed {
963 network_update: None,
964 payment_failed_permanently: false,
965 all_paths_failed: false,
966 path: TestRouter::path_for_value(final_value_msat),
967 short_channel_id: None,
968 retry: Some(TestRouter::retry_for_invoice(&invoice)),
970 invoice_payer.handle_event(&event);
971 assert_eq!(*event_handled.borrow(), false);
972 assert_eq!(*payer.attempts.borrow(), 1);
974 invoice_payer.handle_event(&event);
975 assert_eq!(*event_handled.borrow(), false);
976 assert_eq!(*payer.attempts.borrow(), 2);
978 invoice_payer.handle_event(&Event::PaymentSent {
979 payment_id, payment_preimage, payment_hash, fee_paid_msat: None
981 assert_eq!(*event_handled.borrow(), true);
982 assert_eq!(*payer.attempts.borrow(), 2);
986 fn fails_paying_invoice_after_max_retry_counts() {
987 let event_handled = core::cell::RefCell::new(false);
988 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
990 let payment_preimage = PaymentPreimage([1; 32]);
991 let invoice = invoice(payment_preimage);
992 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
994 let payer = TestPayer::new()
995 .expect_send(Amount::ForInvoice(final_value_msat))
996 .expect_send(Amount::OnRetry(final_value_msat / 2))
997 .expect_send(Amount::OnRetry(final_value_msat / 2));
998 let router = TestRouter::new(TestScorer::new());
999 let logger = TestLogger::new();
1001 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
1003 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
1004 assert_eq!(*payer.attempts.borrow(), 1);
1006 let event = Event::PaymentPathFailed {
1008 payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
1009 network_update: None,
1010 payment_failed_permanently: false,
1011 all_paths_failed: true,
1012 path: TestRouter::path_for_value(final_value_msat),
1013 short_channel_id: None,
1014 retry: Some(TestRouter::retry_for_invoice(&invoice)),
1016 invoice_payer.handle_event(&event);
1017 assert_eq!(*event_handled.borrow(), false);
1018 assert_eq!(*payer.attempts.borrow(), 2);
1020 let event = Event::PaymentPathFailed {
1022 payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
1023 network_update: None,
1024 payment_failed_permanently: false,
1025 all_paths_failed: false,
1026 path: TestRouter::path_for_value(final_value_msat / 2),
1027 short_channel_id: None,
1028 retry: Some(RouteParameters {
1029 final_value_msat: final_value_msat / 2, ..TestRouter::retry_for_invoice(&invoice)
1032 invoice_payer.handle_event(&event);
1033 assert_eq!(*event_handled.borrow(), false);
1034 assert_eq!(*payer.attempts.borrow(), 3);
1036 invoice_payer.handle_event(&event);
1037 assert_eq!(*event_handled.borrow(), true);
1038 assert_eq!(*payer.attempts.borrow(), 3);
1041 #[cfg(feature = "std")]
1043 fn fails_paying_invoice_after_max_retry_timeout() {
1044 let event_handled = core::cell::RefCell::new(false);
1045 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1047 let payment_preimage = PaymentPreimage([1; 32]);
1048 let invoice = invoice(payment_preimage);
1049 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
1051 let payer = TestPayer::new()
1052 .expect_send(Amount::ForInvoice(final_value_msat))
1053 .expect_send(Amount::OnRetry(final_value_msat / 2));
1055 let router = TestRouter::new(TestScorer::new());
1056 let logger = TestLogger::new();
1057 type InvoicePayerUsingSinceEpoch <P, R, L, E> = InvoicePayerUsingTime::<P, R, L, E, SinceEpoch>;
1060 InvoicePayerUsingSinceEpoch::new(&payer, router, &logger, event_handler, Retry::Timeout(Duration::from_secs(120)));
1062 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
1063 assert_eq!(*payer.attempts.borrow(), 1);
1065 let event = Event::PaymentPathFailed {
1067 payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
1068 network_update: None,
1069 payment_failed_permanently: false,
1070 all_paths_failed: true,
1071 path: TestRouter::path_for_value(final_value_msat),
1072 short_channel_id: None,
1073 retry: Some(TestRouter::retry_for_invoice(&invoice)),
1075 invoice_payer.handle_event(&event);
1076 assert_eq!(*event_handled.borrow(), false);
1077 assert_eq!(*payer.attempts.borrow(), 2);
1079 SinceEpoch::advance(Duration::from_secs(121));
1081 invoice_payer.handle_event(&event);
1082 assert_eq!(*event_handled.borrow(), true);
1083 assert_eq!(*payer.attempts.borrow(), 2);
1087 fn fails_paying_invoice_with_missing_retry_params() {
1088 let event_handled = core::cell::RefCell::new(false);
1089 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1091 let payment_preimage = PaymentPreimage([1; 32]);
1092 let invoice = invoice(payment_preimage);
1093 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
1095 let payer = TestPayer::new().expect_send(Amount::ForInvoice(final_value_msat));
1096 let router = TestRouter::new(TestScorer::new());
1097 let logger = TestLogger::new();
1099 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
1101 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
1102 assert_eq!(*payer.attempts.borrow(), 1);
1104 let event = Event::PaymentPathFailed {
1106 payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
1107 network_update: None,
1108 payment_failed_permanently: false,
1109 all_paths_failed: false,
1111 short_channel_id: None,
1114 invoice_payer.handle_event(&event);
1115 assert_eq!(*event_handled.borrow(), true);
1116 assert_eq!(*payer.attempts.borrow(), 1);
1119 // Expiration is checked only in an std environment
1120 #[cfg(feature = "std")]
1122 fn fails_paying_invoice_after_expiration() {
1123 let event_handled = core::cell::RefCell::new(false);
1124 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1126 let payer = TestPayer::new();
1127 let router = TestRouter::new(TestScorer::new());
1128 let logger = TestLogger::new();
1130 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
1132 let payment_preimage = PaymentPreimage([1; 32]);
1133 let invoice = expired_invoice(payment_preimage);
1134 if let PaymentError::Invoice(msg) = invoice_payer.pay_invoice(&invoice).unwrap_err() {
1135 assert_eq!(msg, "Invoice expired prior to send");
1136 } else { panic!("Expected Invoice Error"); }
1139 // Expiration is checked only in an std environment
1140 #[cfg(feature = "std")]
1142 fn fails_retrying_invoice_after_expiration() {
1143 let event_handled = core::cell::RefCell::new(false);
1144 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1146 let payment_preimage = PaymentPreimage([1; 32]);
1147 let invoice = invoice(payment_preimage);
1148 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
1150 let payer = TestPayer::new().expect_send(Amount::ForInvoice(final_value_msat));
1151 let router = TestRouter::new(TestScorer::new());
1152 let logger = TestLogger::new();
1154 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
1156 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
1157 assert_eq!(*payer.attempts.borrow(), 1);
1159 let mut retry_data = TestRouter::retry_for_invoice(&invoice);
1160 retry_data.payment_params.expiry_time = Some(SystemTime::now()
1161 .checked_sub(Duration::from_secs(2)).unwrap()
1162 .duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs());
1163 let event = Event::PaymentPathFailed {
1165 payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
1166 network_update: None,
1167 payment_failed_permanently: false,
1168 all_paths_failed: false,
1170 short_channel_id: None,
1171 retry: Some(retry_data),
1173 invoice_payer.handle_event(&event);
1174 assert_eq!(*event_handled.borrow(), true);
1175 assert_eq!(*payer.attempts.borrow(), 1);
1179 fn fails_paying_invoice_after_retry_error() {
1180 let event_handled = core::cell::RefCell::new(false);
1181 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1183 let payment_preimage = PaymentPreimage([1; 32]);
1184 let invoice = invoice(payment_preimage);
1185 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
1187 let payer = TestPayer::new()
1188 .fails_on_attempt(2)
1189 .expect_send(Amount::ForInvoice(final_value_msat))
1190 .expect_send(Amount::OnRetry(final_value_msat / 2));
1191 let router = TestRouter::new(TestScorer::new());
1192 let logger = TestLogger::new();
1194 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
1196 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
1197 assert_eq!(*payer.attempts.borrow(), 1);
1199 let event = Event::PaymentPathFailed {
1201 payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
1202 network_update: None,
1203 payment_failed_permanently: false,
1204 all_paths_failed: false,
1205 path: TestRouter::path_for_value(final_value_msat / 2),
1206 short_channel_id: None,
1207 retry: Some(TestRouter::retry_for_invoice(&invoice)),
1209 invoice_payer.handle_event(&event);
1210 assert_eq!(*event_handled.borrow(), true);
1211 assert_eq!(*payer.attempts.borrow(), 2);
1215 fn fails_paying_invoice_after_rejected_by_payee() {
1216 let event_handled = core::cell::RefCell::new(false);
1217 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1219 let payment_preimage = PaymentPreimage([1; 32]);
1220 let invoice = invoice(payment_preimage);
1221 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
1223 let payer = TestPayer::new().expect_send(Amount::ForInvoice(final_value_msat));
1224 let router = TestRouter::new(TestScorer::new());
1225 let logger = TestLogger::new();
1227 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
1229 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
1230 assert_eq!(*payer.attempts.borrow(), 1);
1232 let event = Event::PaymentPathFailed {
1234 payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()),
1235 network_update: None,
1236 payment_failed_permanently: true,
1237 all_paths_failed: false,
1239 short_channel_id: None,
1240 retry: Some(TestRouter::retry_for_invoice(&invoice)),
1242 invoice_payer.handle_event(&event);
1243 assert_eq!(*event_handled.borrow(), true);
1244 assert_eq!(*payer.attempts.borrow(), 1);
1248 fn fails_repaying_invoice_with_pending_payment() {
1249 let event_handled = core::cell::RefCell::new(false);
1250 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1252 let payment_preimage = PaymentPreimage([1; 32]);
1253 let invoice = invoice(payment_preimage);
1254 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
1256 let payer = TestPayer::new()
1257 .expect_send(Amount::ForInvoice(final_value_msat))
1258 .expect_send(Amount::ForInvoice(final_value_msat));
1259 let router = TestRouter::new(TestScorer::new());
1260 let logger = TestLogger::new();
1262 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(0));
1264 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
1266 // Cannot repay an invoice pending payment.
1267 match invoice_payer.pay_invoice(&invoice) {
1268 Err(PaymentError::Invoice("payment pending")) => {},
1269 Err(_) => panic!("unexpected error"),
1270 Ok(_) => panic!("expected invoice error"),
1273 // Can repay an invoice once cleared from cache.
1274 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
1275 invoice_payer.remove_cached_payment(&payment_hash);
1276 assert!(invoice_payer.pay_invoice(&invoice).is_ok());
1278 // Cannot retry paying an invoice if cleared from cache.
1279 invoice_payer.remove_cached_payment(&payment_hash);
1280 let event = Event::PaymentPathFailed {
1283 network_update: None,
1284 payment_failed_permanently: false,
1285 all_paths_failed: false,
1287 short_channel_id: None,
1288 retry: Some(TestRouter::retry_for_invoice(&invoice)),
1290 invoice_payer.handle_event(&event);
1291 assert_eq!(*event_handled.borrow(), true);
1295 fn fails_paying_invoice_with_routing_errors() {
1296 let payer = TestPayer::new();
1297 let router = FailingRouter {};
1298 let logger = TestLogger::new();
1300 InvoicePayer::new(&payer, router, &logger, |_: &_| {}, Retry::Attempts(0));
1302 let payment_preimage = PaymentPreimage([1; 32]);
1303 let invoice = invoice(payment_preimage);
1304 match invoice_payer.pay_invoice(&invoice) {
1305 Err(PaymentError::Routing(_)) => {},
1306 Err(_) => panic!("unexpected error"),
1307 Ok(_) => panic!("expected routing error"),
1312 fn fails_paying_invoice_with_sending_errors() {
1313 let payment_preimage = PaymentPreimage([1; 32]);
1314 let invoice = invoice(payment_preimage);
1315 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
1317 let payer = TestPayer::new()
1318 .fails_on_attempt(1)
1319 .expect_send(Amount::ForInvoice(final_value_msat));
1320 let router = TestRouter::new(TestScorer::new());
1321 let logger = TestLogger::new();
1323 InvoicePayer::new(&payer, router, &logger, |_: &_| {}, Retry::Attempts(0));
1325 match invoice_payer.pay_invoice(&invoice) {
1326 Err(PaymentError::Sending(_)) => {},
1327 Err(_) => panic!("unexpected error"),
1328 Ok(_) => panic!("expected sending error"),
1333 fn pays_zero_value_invoice_using_amount() {
1334 let event_handled = core::cell::RefCell::new(false);
1335 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1337 let payment_preimage = PaymentPreimage([1; 32]);
1338 let invoice = zero_value_invoice(payment_preimage);
1339 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
1340 let final_value_msat = 100;
1342 let payer = TestPayer::new().expect_send(Amount::ForInvoice(final_value_msat));
1343 let router = TestRouter::new(TestScorer::new());
1344 let logger = TestLogger::new();
1346 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(0));
1349 Some(invoice_payer.pay_zero_value_invoice(&invoice, final_value_msat).unwrap());
1350 assert_eq!(*payer.attempts.borrow(), 1);
1352 invoice_payer.handle_event(&Event::PaymentSent {
1353 payment_id, payment_preimage, payment_hash, fee_paid_msat: None
1355 assert_eq!(*event_handled.borrow(), true);
1356 assert_eq!(*payer.attempts.borrow(), 1);
1360 fn fails_paying_zero_value_invoice_with_amount() {
1361 let event_handled = core::cell::RefCell::new(false);
1362 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1364 let payer = TestPayer::new();
1365 let router = TestRouter::new(TestScorer::new());
1366 let logger = TestLogger::new();
1368 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(0));
1370 let payment_preimage = PaymentPreimage([1; 32]);
1371 let invoice = invoice(payment_preimage);
1373 // Cannot repay an invoice pending payment.
1374 match invoice_payer.pay_zero_value_invoice(&invoice, 100) {
1375 Err(PaymentError::Invoice("amount unexpected")) => {},
1376 Err(_) => panic!("unexpected error"),
1377 Ok(_) => panic!("expected invoice error"),
1382 fn pays_pubkey_with_amount() {
1383 let event_handled = core::cell::RefCell::new(false);
1384 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1386 let pubkey = pubkey();
1387 let payment_preimage = PaymentPreimage([1; 32]);
1388 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1389 let final_value_msat = 100;
1390 let final_cltv_expiry_delta = 42;
1392 let payer = TestPayer::new()
1393 .expect_send(Amount::Spontaneous(final_value_msat))
1394 .expect_send(Amount::OnRetry(final_value_msat));
1395 let router = TestRouter::new(TestScorer::new());
1396 let logger = TestLogger::new();
1398 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
1400 let payment_id = Some(invoice_payer.pay_pubkey(
1401 pubkey, payment_preimage, final_value_msat, final_cltv_expiry_delta
1403 assert_eq!(*payer.attempts.borrow(), 1);
1405 let retry = RouteParameters {
1406 payment_params: PaymentParameters::for_keysend(pubkey),
1408 final_cltv_expiry_delta,
1410 let event = Event::PaymentPathFailed {
1413 network_update: None,
1414 payment_failed_permanently: false,
1415 all_paths_failed: false,
1417 short_channel_id: None,
1420 invoice_payer.handle_event(&event);
1421 assert_eq!(*event_handled.borrow(), false);
1422 assert_eq!(*payer.attempts.borrow(), 2);
1424 invoice_payer.handle_event(&Event::PaymentSent {
1425 payment_id, payment_preimage, payment_hash, fee_paid_msat: None
1427 assert_eq!(*event_handled.borrow(), true);
1428 assert_eq!(*payer.attempts.borrow(), 2);
1432 fn scores_failed_channel() {
1433 let event_handled = core::cell::RefCell::new(false);
1434 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1436 let payment_preimage = PaymentPreimage([1; 32]);
1437 let invoice = invoice(payment_preimage);
1438 let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner());
1439 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
1440 let path = TestRouter::path_for_value(final_value_msat);
1441 let short_channel_id = Some(path[0].short_channel_id);
1443 // Expect that scorer is given short_channel_id upon handling the event.
1444 let payer = TestPayer::new()
1445 .expect_send(Amount::ForInvoice(final_value_msat))
1446 .expect_send(Amount::OnRetry(final_value_msat / 2));
1447 let scorer = TestScorer::new().expect(TestResult::PaymentFailure {
1448 path: path.clone(), short_channel_id: path[0].short_channel_id,
1450 let router = TestRouter::new(scorer);
1451 let logger = TestLogger::new();
1453 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
1455 let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap());
1456 let event = Event::PaymentPathFailed {
1459 network_update: None,
1460 payment_failed_permanently: false,
1461 all_paths_failed: false,
1464 retry: Some(TestRouter::retry_for_invoice(&invoice)),
1466 invoice_payer.handle_event(&event);
1470 fn scores_successful_channels() {
1471 let event_handled = core::cell::RefCell::new(false);
1472 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1474 let payment_preimage = PaymentPreimage([1; 32]);
1475 let invoice = invoice(payment_preimage);
1476 let payment_hash = Some(PaymentHash(invoice.payment_hash().clone().into_inner()));
1477 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
1478 let route = TestRouter::route_for_value(final_value_msat);
1480 // Expect that scorer is given short_channel_id upon handling the event.
1481 let payer = TestPayer::new().expect_send(Amount::ForInvoice(final_value_msat));
1482 let scorer = TestScorer::new()
1483 .expect(TestResult::PaymentSuccess { path: route.paths[0].clone() })
1484 .expect(TestResult::PaymentSuccess { path: route.paths[1].clone() });
1485 let router = TestRouter::new(scorer);
1486 let logger = TestLogger::new();
1488 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
1490 let payment_id = invoice_payer.pay_invoice(&invoice).unwrap();
1491 let event = Event::PaymentPathSuccessful {
1492 payment_id, payment_hash, path: route.paths[0].clone()
1494 invoice_payer.handle_event(&event);
1495 let event = Event::PaymentPathSuccessful {
1496 payment_id, payment_hash, path: route.paths[1].clone()
1498 invoice_payer.handle_event(&event);
1502 fn generates_correct_inflight_map_data() {
1503 let event_handled = core::cell::RefCell::new(false);
1504 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1506 let payment_preimage = PaymentPreimage([1; 32]);
1507 let invoice = invoice(payment_preimage);
1508 let payment_hash = Some(PaymentHash(invoice.payment_hash().clone().into_inner()));
1509 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
1511 let payer = TestPayer::new().expect_send(Amount::ForInvoice(final_value_msat));
1512 let final_value_msat = invoice.amount_milli_satoshis().unwrap();
1513 let route = TestRouter::route_for_value(final_value_msat);
1514 let router = TestRouter::new(TestScorer::new());
1515 let logger = TestLogger::new();
1517 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(0));
1519 let payment_id = invoice_payer.pay_invoice(&invoice).unwrap();
1521 let inflight_map = invoice_payer.create_inflight_map();
1523 assert_eq!(inflight_map.0.get(&(0, false)).unwrap().clone(), 94);
1524 assert_eq!(inflight_map.0.get(&(1, true)).unwrap().clone(), 84);
1525 assert_eq!(inflight_map.0.get(&(2, false)).unwrap().clone(), 64);
1527 // Second path check
1528 assert_eq!(inflight_map.0.get(&(3, false)).unwrap().clone(), 74);
1529 assert_eq!(inflight_map.0.get(&(4, false)).unwrap().clone(), 64);
1531 invoice_payer.handle_event(&Event::PaymentPathSuccessful {
1532 payment_id, payment_hash, path: route.paths[0].clone()
1535 let inflight_map = invoice_payer.create_inflight_map();
1537 assert_eq!(inflight_map.0.get(&(0, false)), None);
1538 assert_eq!(inflight_map.0.get(&(1, true)), None);
1539 assert_eq!(inflight_map.0.get(&(2, false)), None);
1541 // Second path should still be inflight
1542 assert_eq!(inflight_map.0.get(&(3, false)).unwrap().clone(), 74);
1543 assert_eq!(inflight_map.0.get(&(4, false)).unwrap().clone(), 64)
1547 fn considers_inflight_htlcs_between_invoice_payments_when_path_succeeds() {
1548 // First, let's just send a payment through, but only make sure one of the path completes
1549 let event_handled = core::cell::RefCell::new(false);
1550 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1552 let payment_preimage = PaymentPreimage([1; 32]);
1553 let payment_invoice = invoice(payment_preimage);
1554 let payment_hash = Some(PaymentHash(payment_invoice.payment_hash().clone().into_inner()));
1555 let final_value_msat = payment_invoice.amount_milli_satoshis().unwrap();
1557 let payer = TestPayer::new()
1558 .expect_send(Amount::ForInvoice(final_value_msat))
1559 .expect_send(Amount::ForInvoice(final_value_msat));
1560 let final_value_msat = payment_invoice.amount_milli_satoshis().unwrap();
1561 let route = TestRouter::route_for_value(final_value_msat);
1562 let scorer = TestScorer::new()
1563 // 1st invoice, 1st path
1564 .expect_usage(ChannelUsage { amount_msat: 64, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1565 .expect_usage(ChannelUsage { amount_msat: 84, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1566 .expect_usage(ChannelUsage { amount_msat: 94, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1567 // 1st invoice, 2nd path
1568 .expect_usage(ChannelUsage { amount_msat: 64, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1569 .expect_usage(ChannelUsage { amount_msat: 74, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1570 // 2nd invoice, 1st path
1571 .expect_usage(ChannelUsage { amount_msat: 64, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1572 .expect_usage(ChannelUsage { amount_msat: 84, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1573 .expect_usage(ChannelUsage { amount_msat: 94, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1574 // 2nd invoice, 2nd path
1575 .expect_usage(ChannelUsage { amount_msat: 64, inflight_htlc_msat: 64, effective_capacity: EffectiveCapacity::Unknown } )
1576 .expect_usage(ChannelUsage { amount_msat: 74, inflight_htlc_msat: 74, effective_capacity: EffectiveCapacity::Unknown } );
1577 let router = TestRouter::new(scorer);
1578 let logger = TestLogger::new();
1580 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(0));
1582 // Succeed 1st path, leave 2nd path inflight
1583 let payment_id = invoice_payer.pay_invoice(&payment_invoice).unwrap();
1584 invoice_payer.handle_event(&Event::PaymentPathSuccessful {
1585 payment_id, payment_hash, path: route.paths[0].clone()
1588 // Let's pay a second invoice that will be using the same path. This should trigger the
1589 // assertions that expect the last 4 ChannelUsage values above where TestScorer is initialized.
1590 // Particularly, the 2nd path of the 1st payment, since it is not yet complete, should still
1591 // have 64 msats inflight for paths considering the channel with scid of 1.
1592 let payment_preimage_2 = PaymentPreimage([2; 32]);
1593 let payment_invoice_2 = invoice(payment_preimage_2);
1594 invoice_payer.pay_invoice(&payment_invoice_2).unwrap();
1598 fn considers_inflight_htlcs_between_retries() {
1599 // First, let's just send a payment through, but only make sure one of the path completes
1600 let event_handled = core::cell::RefCell::new(false);
1601 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1603 let payment_preimage = PaymentPreimage([1; 32]);
1604 let payment_invoice = invoice(payment_preimage);
1605 let payment_hash = PaymentHash(payment_invoice.payment_hash().clone().into_inner());
1606 let final_value_msat = payment_invoice.amount_milli_satoshis().unwrap();
1608 let payer = TestPayer::new()
1609 .expect_send(Amount::ForInvoice(final_value_msat))
1610 .expect_send(Amount::OnRetry(final_value_msat / 2))
1611 .expect_send(Amount::OnRetry(final_value_msat / 4));
1612 let final_value_msat = payment_invoice.amount_milli_satoshis().unwrap();
1613 let scorer = TestScorer::new()
1614 // 1st invoice, 1st path
1615 .expect_usage(ChannelUsage { amount_msat: 64, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1616 .expect_usage(ChannelUsage { amount_msat: 84, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1617 .expect_usage(ChannelUsage { amount_msat: 94, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1618 // 1st invoice, 2nd path
1619 .expect_usage(ChannelUsage { amount_msat: 64, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1620 .expect_usage(ChannelUsage { amount_msat: 74, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1621 // Retry 1, 1st path
1622 .expect_usage(ChannelUsage { amount_msat: 32, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1623 .expect_usage(ChannelUsage { amount_msat: 52, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1624 .expect_usage(ChannelUsage { amount_msat: 62, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1625 // Retry 1, 2nd path
1626 .expect_usage(ChannelUsage { amount_msat: 32, inflight_htlc_msat: 64, effective_capacity: EffectiveCapacity::Unknown } )
1627 .expect_usage(ChannelUsage { amount_msat: 42, inflight_htlc_msat: 64 + 10, effective_capacity: EffectiveCapacity::Unknown } )
1628 // Retry 2, 1st path
1629 .expect_usage(ChannelUsage { amount_msat: 16, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1630 .expect_usage(ChannelUsage { amount_msat: 36, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1631 .expect_usage(ChannelUsage { amount_msat: 46, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } )
1632 // Retry 2, 2nd path
1633 .expect_usage(ChannelUsage { amount_msat: 16, inflight_htlc_msat: 64 + 32, effective_capacity: EffectiveCapacity::Unknown } )
1634 .expect_usage(ChannelUsage { amount_msat: 26, inflight_htlc_msat: 74 + 32 + 10, effective_capacity: EffectiveCapacity::Unknown } );
1635 let router = TestRouter::new(scorer);
1636 let logger = TestLogger::new();
1638 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(2));
1640 // Fail 1st path, leave 2nd path inflight
1641 let payment_id = Some(invoice_payer.pay_invoice(&payment_invoice).unwrap());
1642 invoice_payer.handle_event(&Event::PaymentPathFailed {
1645 network_update: None,
1646 payment_failed_permanently: false,
1647 all_paths_failed: false,
1648 path: TestRouter::path_for_value(final_value_msat),
1649 short_channel_id: None,
1650 retry: Some(TestRouter::retry_for_invoice(&payment_invoice)),
1653 // Fails again the 1st path of our retry
1654 invoice_payer.handle_event(&Event::PaymentPathFailed {
1657 network_update: None,
1658 payment_failed_permanently: false,
1659 all_paths_failed: false,
1660 path: TestRouter::path_for_value(final_value_msat / 2),
1661 short_channel_id: None,
1662 retry: Some(RouteParameters {
1663 final_value_msat: final_value_msat / 4,
1664 ..TestRouter::retry_for_invoice(&payment_invoice)
1670 fn accounts_for_some_inflight_htlcs_sent_during_partial_failure() {
1671 let event_handled = core::cell::RefCell::new(false);
1672 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1674 let payment_preimage = PaymentPreimage([1; 32]);
1675 let invoice_to_pay = invoice(payment_preimage);
1676 let final_value_msat = invoice_to_pay.amount_milli_satoshis().unwrap();
1678 let retry = TestRouter::retry_for_invoice(&invoice_to_pay);
1679 let payer = TestPayer::new()
1680 .fails_with_partial_failure(
1681 retry.clone(), OnAttempt(1),
1683 Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateInProgress)
1685 .expect_send(Amount::ForInvoice(final_value_msat));
1687 let router = TestRouter::new(TestScorer::new());
1688 let logger = TestLogger::new();
1690 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(0));
1692 invoice_payer.pay_invoice(&invoice_to_pay).unwrap();
1693 let inflight_map = invoice_payer.create_inflight_map();
1695 // Only the second path, which failed with `MonitorUpdateInProgress` should be added to our
1696 // inflight map because retries are disabled.
1697 assert_eq!(inflight_map.0.len(), 2);
1701 fn accounts_for_all_inflight_htlcs_sent_during_partial_failure() {
1702 let event_handled = core::cell::RefCell::new(false);
1703 let event_handler = |_: &_| { *event_handled.borrow_mut() = true; };
1705 let payment_preimage = PaymentPreimage([1; 32]);
1706 let invoice_to_pay = invoice(payment_preimage);
1707 let final_value_msat = invoice_to_pay.amount_milli_satoshis().unwrap();
1709 let retry = TestRouter::retry_for_invoice(&invoice_to_pay);
1710 let payer = TestPayer::new()
1711 .fails_with_partial_failure(
1712 retry.clone(), OnAttempt(1),
1714 Ok(()), Err(MonitorUpdateInProgress)
1716 .expect_send(Amount::ForInvoice(final_value_msat));
1718 let router = TestRouter::new(TestScorer::new());
1719 let logger = TestLogger::new();
1721 InvoicePayer::new(&payer, router, &logger, event_handler, Retry::Attempts(0));
1723 invoice_payer.pay_invoice(&invoice_to_pay).unwrap();
1724 let inflight_map = invoice_payer.create_inflight_map();
1726 // All paths successful, hence we check of the existence of all 5 hops.
1727 assert_eq!(inflight_map.0.len(), 5);
1731 scorer: RefCell<TestScorer>,
1735 fn new(scorer: TestScorer) -> Self {
1736 TestRouter { scorer: RefCell::new(scorer) }
1739 fn route_for_value(final_value_msat: u64) -> Route {
1744 pubkey: PublicKey::from_slice(&hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
1745 channel_features: ChannelFeatures::empty(),
1746 node_features: NodeFeatures::empty(),
1747 short_channel_id: 0,
1749 cltv_expiry_delta: 0
1752 pubkey: PublicKey::from_slice(&hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
1753 channel_features: ChannelFeatures::empty(),
1754 node_features: NodeFeatures::empty(),
1755 short_channel_id: 1,
1757 cltv_expiry_delta: 0
1760 pubkey: PublicKey::from_slice(&hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
1761 channel_features: ChannelFeatures::empty(),
1762 node_features: NodeFeatures::empty(),
1763 short_channel_id: 2,
1764 fee_msat: final_value_msat / 2,
1765 cltv_expiry_delta: 0
1770 pubkey: PublicKey::from_slice(&hex::decode("029e03a901b85534ff1e92c43c74431f7ce72046060fcf7a95c37e148f78c77255").unwrap()[..]).unwrap(),
1771 channel_features: ChannelFeatures::empty(),
1772 node_features: NodeFeatures::empty(),
1773 short_channel_id: 3,
1775 cltv_expiry_delta: 144
1778 pubkey: PublicKey::from_slice(&hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
1779 channel_features: ChannelFeatures::empty(),
1780 node_features: NodeFeatures::empty(),
1781 short_channel_id: 4,
1782 fee_msat: final_value_msat / 2,
1783 cltv_expiry_delta: 144
1787 payment_params: None,
1791 fn path_for_value(final_value_msat: u64) -> Vec<RouteHop> {
1792 TestRouter::route_for_value(final_value_msat).paths[0].clone()
1795 fn retry_for_invoice(invoice: &Invoice) -> RouteParameters {
1796 let mut payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key())
1797 .with_expiry_time(expiry_time_from_unix_epoch(invoice).as_secs())
1798 .with_route_hints(invoice.route_hints());
1799 if let Some(features) = invoice.features() {
1800 payment_params = payment_params.with_features(features.clone());
1802 let final_value_msat = invoice.amount_milli_satoshis().unwrap() / 2;
1806 final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32,
1811 impl Router for TestRouter {
1813 &self, payer: &PublicKey, route_params: &RouteParameters,
1814 _first_hops: Option<&[&ChannelDetails]>, inflight_htlcs: InFlightHtlcs
1815 ) -> Result<Route, LightningError> {
1816 // Simulate calling the Scorer just as you would in find_route
1817 let route = Self::route_for_value(route_params.final_value_msat);
1818 let mut locked_scorer = self.scorer.lock();
1819 let scorer = ScorerAccountingForInFlightHtlcs::new(locked_scorer.deref_mut(), inflight_htlcs);
1820 for path in route.paths {
1821 let mut aggregate_msat = 0u64;
1822 for (idx, hop) in path.iter().rev().enumerate() {
1823 aggregate_msat += hop.fee_msat;
1824 let usage = ChannelUsage {
1825 amount_msat: aggregate_msat,
1826 inflight_htlc_msat: 0,
1827 effective_capacity: EffectiveCapacity::Unknown,
1830 // Since the path is reversed, the last element in our iteration is the first
1832 if idx == path.len() - 1 {
1833 scorer.channel_penalty_msat(hop.short_channel_id, &NodeId::from_pubkey(payer), &NodeId::from_pubkey(&hop.pubkey), usage);
1835 scorer.channel_penalty_msat(hop.short_channel_id, &NodeId::from_pubkey(&path[idx + 1].pubkey), &NodeId::from_pubkey(&hop.pubkey), usage);
1841 payment_params: Some(route_params.payment_params.clone()), ..Self::route_for_value(route_params.final_value_msat)
1845 fn notify_payment_path_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
1846 self.scorer.lock().payment_path_failed(path, short_channel_id);
1849 fn notify_payment_path_successful(&self, path: &[&RouteHop]) {
1850 self.scorer.lock().payment_path_successful(path);
1853 fn notify_payment_probe_successful(&self, path: &[&RouteHop]) {
1854 self.scorer.lock().probe_successful(path);
1857 fn notify_payment_probe_failed(&self, path: &[&RouteHop], short_channel_id: u64) {
1858 self.scorer.lock().probe_failed(path, short_channel_id);
1862 struct FailingRouter;
1864 impl Router for FailingRouter {
1866 &self, _payer: &PublicKey, _params: &RouteParameters, _first_hops: Option<&[&ChannelDetails]>,
1867 _inflight_htlcs: InFlightHtlcs
1868 ) -> Result<Route, LightningError> {
1869 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError })
1872 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}
1874 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
1876 fn notify_payment_probe_successful(&self, _path: &[&RouteHop]) {}
1878 fn notify_payment_probe_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}
1882 event_expectations: Option<VecDeque<TestResult>>,
1883 scorer_expectations: RefCell<Option<VecDeque<ChannelUsage>>>,
1888 PaymentFailure { path: Vec<RouteHop>, short_channel_id: u64 },
1889 PaymentSuccess { path: Vec<RouteHop> },
1895 event_expectations: None,
1896 scorer_expectations: RefCell::new(None),
1900 fn expect(mut self, expectation: TestResult) -> Self {
1901 self.event_expectations.get_or_insert_with(|| VecDeque::new()).push_back(expectation);
1905 fn expect_usage(self, expectation: ChannelUsage) -> Self {
1906 self.scorer_expectations.borrow_mut().get_or_insert_with(|| VecDeque::new()).push_back(expectation);
1912 impl lightning::util::ser::Writeable for TestScorer {
1913 fn write<W: lightning::util::ser::Writer>(&self, _: &mut W) -> Result<(), lightning::io::Error> { unreachable!(); }
1916 impl Score for TestScorer {
1917 fn channel_penalty_msat(
1918 &self, _short_channel_id: u64, _source: &NodeId, _target: &NodeId, usage: ChannelUsage
1920 if let Some(scorer_expectations) = self.scorer_expectations.borrow_mut().as_mut() {
1921 match scorer_expectations.pop_front() {
1922 Some(expectation) => {
1923 assert_eq!(expectation.amount_msat, usage.amount_msat);
1924 assert_eq!(expectation.inflight_htlc_msat, usage.inflight_htlc_msat);
1932 fn payment_path_failed(&mut self, actual_path: &[&RouteHop], actual_short_channel_id: u64) {
1933 if let Some(expectations) = &mut self.event_expectations {
1934 match expectations.pop_front() {
1935 Some(TestResult::PaymentFailure { path, short_channel_id }) => {
1936 assert_eq!(actual_path, &path.iter().collect::<Vec<_>>()[..]);
1937 assert_eq!(actual_short_channel_id, short_channel_id);
1939 Some(TestResult::PaymentSuccess { path }) => {
1940 panic!("Unexpected successful payment path: {:?}", path)
1942 None => panic!("Unexpected notify_payment_path_failed call: {:?}", actual_path),
1947 fn payment_path_successful(&mut self, actual_path: &[&RouteHop]) {
1948 if let Some(expectations) = &mut self.event_expectations {
1949 match expectations.pop_front() {
1950 Some(TestResult::PaymentFailure { path, .. }) => {
1951 panic!("Unexpected payment path failure: {:?}", path)
1953 Some(TestResult::PaymentSuccess { path }) => {
1954 assert_eq!(actual_path, &path.iter().collect::<Vec<_>>()[..]);
1956 None => panic!("Unexpected notify_payment_path_successful call: {:?}", actual_path),
1961 fn probe_failed(&mut self, actual_path: &[&RouteHop], _: u64) {
1962 if let Some(expectations) = &mut self.event_expectations {
1963 match expectations.pop_front() {
1964 Some(TestResult::PaymentFailure { path, .. }) => {
1965 panic!("Unexpected failed payment path: {:?}", path)
1967 Some(TestResult::PaymentSuccess { path }) => {
1968 panic!("Unexpected successful payment path: {:?}", path)
1970 None => panic!("Unexpected notify_payment_path_failed call: {:?}", actual_path),
1974 fn probe_successful(&mut self, actual_path: &[&RouteHop]) {
1975 if let Some(expectations) = &mut self.event_expectations {
1976 match expectations.pop_front() {
1977 Some(TestResult::PaymentFailure { path, .. }) => {
1978 panic!("Unexpected payment path failure: {:?}", path)
1980 Some(TestResult::PaymentSuccess { path }) => {
1981 panic!("Unexpected successful payment path: {:?}", path)
1983 None => panic!("Unexpected notify_payment_path_successful call: {:?}", actual_path),
1989 impl Drop for TestScorer {
1990 fn drop(&mut self) {
1991 if std::thread::panicking() {
1995 if let Some(event_expectations) = &self.event_expectations {
1996 if !event_expectations.is_empty() {
1997 panic!("Unsatisfied event expectations: {:?}", event_expectations);
2001 if let Some(scorer_expectations) = self.scorer_expectations.borrow().as_ref() {
2002 if !scorer_expectations.is_empty() {
2003 panic!("Unsatisfied scorer expectations: {:?}", scorer_expectations)
2010 expectations: core::cell::RefCell<VecDeque<Amount>>,
2011 attempts: core::cell::RefCell<usize>,
2012 failing_on_attempt: core::cell::RefCell<HashMap<usize, PaymentSendFailure>>,
2015 #[derive(Clone, Debug, PartialEq, Eq)]
2022 struct OnAttempt(usize);
2027 expectations: core::cell::RefCell::new(VecDeque::new()),
2028 attempts: core::cell::RefCell::new(0),
2029 failing_on_attempt: core::cell::RefCell::new(HashMap::new()),
2033 fn expect_send(self, value_msat: Amount) -> Self {
2034 self.expectations.borrow_mut().push_back(value_msat);
2038 fn fails_on_attempt(self, attempt: usize) -> Self {
2039 let failure = PaymentSendFailure::ParameterError(APIError::MonitorUpdateInProgress);
2040 self.fails_with(failure, OnAttempt(attempt))
2043 fn fails_with_partial_failure(self, retry: RouteParameters, attempt: OnAttempt, results: Option<Vec<Result<(), APIError>>>) -> Self {
2044 self.fails_with(PaymentSendFailure::PartialFailure {
2045 results: results.unwrap_or(vec![]),
2046 failed_paths_retry: Some(retry),
2047 payment_id: PaymentId([1; 32]),
2051 fn fails_with(self, failure: PaymentSendFailure, attempt: OnAttempt) -> Self {
2052 self.failing_on_attempt.borrow_mut().insert(attempt.0, failure);
2056 fn check_attempts(&self) -> Result<PaymentId, PaymentSendFailure> {
2057 let mut attempts = self.attempts.borrow_mut();
2060 match self.failing_on_attempt.borrow_mut().remove(&*attempts) {
2061 Some(failure) => Err(failure),
2062 None => Ok(PaymentId([1; 32])),
2066 fn check_value_msats(&self, actual_value_msats: Amount) {
2067 let expected_value_msats = self.expectations.borrow_mut().pop_front();
2068 if let Some(expected_value_msats) = expected_value_msats {
2069 assert_eq!(actual_value_msats, expected_value_msats);
2071 panic!("Unexpected amount: {:?}", actual_value_msats);
2076 impl Drop for TestPayer {
2077 fn drop(&mut self) {
2078 if std::thread::panicking() {
2082 if !self.expectations.borrow().is_empty() {
2083 panic!("Unsatisfied payment expectations: {:?}", self.expectations.borrow());
2088 impl Payer for TestPayer {
2089 fn node_id(&self) -> PublicKey {
2090 let secp_ctx = Secp256k1::new();
2091 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap())
2094 fn first_hops(&self) -> Vec<ChannelDetails> {
2099 &self, route: &Route, _payment_hash: PaymentHash,
2100 _payment_secret: &Option<PaymentSecret>
2101 ) -> Result<PaymentId, PaymentSendFailure> {
2102 self.check_value_msats(Amount::ForInvoice(route.get_total_amount()));
2103 self.check_attempts()
2106 fn send_spontaneous_payment(
2107 &self, route: &Route, _payment_preimage: PaymentPreimage,
2108 ) -> Result<PaymentId, PaymentSendFailure> {
2109 self.check_value_msats(Amount::Spontaneous(route.get_total_amount()));
2110 self.check_attempts()
2114 &self, route: &Route, _payment_id: PaymentId
2115 ) -> Result<(), PaymentSendFailure> {
2116 self.check_value_msats(Amount::OnRetry(route.get_total_amount()));
2117 self.check_attempts().map(|_| ())
2120 fn abandon_payment(&self, _payment_id: PaymentId) { }
2123 // *** Full Featured Functional Tests with a Real ChannelManager ***
2124 struct ManualRouter(RefCell<VecDeque<Result<Route, LightningError>>>);
2126 impl Router for ManualRouter {
2128 &self, _payer: &PublicKey, _params: &RouteParameters, _first_hops: Option<&[&ChannelDetails]>,
2129 _inflight_htlcs: InFlightHtlcs
2130 ) -> Result<Route, LightningError> {
2131 self.0.borrow_mut().pop_front().unwrap()
2134 fn notify_payment_path_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}
2136 fn notify_payment_path_successful(&self, _path: &[&RouteHop]) {}
2138 fn notify_payment_probe_successful(&self, _path: &[&RouteHop]) {}
2140 fn notify_payment_probe_failed(&self, _path: &[&RouteHop], _short_channel_id: u64) {}
2143 fn expect_find_route(&self, result: Result<Route, LightningError>) {
2144 self.0.borrow_mut().push_back(result);
2147 impl Drop for ManualRouter {
2148 fn drop(&mut self) {
2149 if std::thread::panicking() {
2152 assert!(self.0.borrow_mut().is_empty());
2157 fn retry_multi_path_single_failed_payment() {
2158 // Tests that we can/will retry after a single path of an MPP payment failed immediately
2159 let chanmon_cfgs = create_chanmon_cfgs(2);
2160 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2161 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
2162 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2164 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2165 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2166 let chans = nodes[0].node.list_usable_channels();
2167 let mut route = Route {
2170 pubkey: nodes[1].node.get_our_node_id(),
2171 node_features: channelmanager::provided_node_features(),
2172 short_channel_id: chans[0].short_channel_id.unwrap(),
2173 channel_features: channelmanager::provided_channel_features(),
2175 cltv_expiry_delta: 100,
2178 pubkey: nodes[1].node.get_our_node_id(),
2179 node_features: channelmanager::provided_node_features(),
2180 short_channel_id: chans[1].short_channel_id.unwrap(),
2181 channel_features: channelmanager::provided_channel_features(),
2182 fee_msat: 100_000_001, // Our default max-HTLC-value is 10% of the channel value, which this is one more than
2183 cltv_expiry_delta: 100,
2186 payment_params: Some(PaymentParameters::from_node_id(nodes[1].node.get_our_node_id())),
2188 let router = ManualRouter(RefCell::new(VecDeque::new()));
2189 router.expect_find_route(Ok(route.clone()));
2190 // On retry, split the payment across both channels.
2191 route.paths[0][0].fee_msat = 50_000_001;
2192 route.paths[1][0].fee_msat = 50_000_000;
2193 router.expect_find_route(Ok(route.clone()));
2195 let event_handler = |_: &_| { panic!(); };
2196 let invoice_payer = InvoicePayer::new(nodes[0].node, router, nodes[0].logger, event_handler, Retry::Attempts(1));
2198 assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager_and_duration_since_epoch(
2199 &nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::Bitcoin,
2200 Some(100_010_000), "Invoice".to_string(), duration_since_epoch(), 3600).unwrap())
2202 let htlc_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2203 assert_eq!(htlc_msgs.len(), 2);
2204 check_added_monitors!(nodes[0], 2);
2208 fn immediate_retry_on_failure() {
2209 // Tests that we can/will retry immediately after a failure
2210 let chanmon_cfgs = create_chanmon_cfgs(2);
2211 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2212 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
2213 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2215 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2216 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features());
2217 let chans = nodes[0].node.list_usable_channels();
2218 let mut route = Route {
2221 pubkey: nodes[1].node.get_our_node_id(),
2222 node_features: channelmanager::provided_node_features(),
2223 short_channel_id: chans[0].short_channel_id.unwrap(),
2224 channel_features: channelmanager::provided_channel_features(),
2225 fee_msat: 100_000_001, // Our default max-HTLC-value is 10% of the channel value, which this is one more than
2226 cltv_expiry_delta: 100,
2229 payment_params: Some(PaymentParameters::from_node_id(nodes[1].node.get_our_node_id())),
2231 let router = ManualRouter(RefCell::new(VecDeque::new()));
2232 router.expect_find_route(Ok(route.clone()));
2233 // On retry, split the payment across both channels.
2234 route.paths.push(route.paths[0].clone());
2235 route.paths[0][0].short_channel_id = chans[1].short_channel_id.unwrap();
2236 route.paths[0][0].fee_msat = 50_000_000;
2237 route.paths[1][0].fee_msat = 50_000_001;
2238 router.expect_find_route(Ok(route.clone()));
2240 let event_handler = |_: &_| { panic!(); };
2241 let invoice_payer = InvoicePayer::new(nodes[0].node, router, nodes[0].logger, event_handler, Retry::Attempts(1));
2243 assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager_and_duration_since_epoch(
2244 &nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::Bitcoin,
2245 Some(100_010_000), "Invoice".to_string(), duration_since_epoch(), 3600).unwrap())
2247 let htlc_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2248 assert_eq!(htlc_msgs.len(), 2);
2249 check_added_monitors!(nodes[0], 2);
2253 fn no_extra_retries_on_back_to_back_fail() {
2254 // In a previous release, we had a race where we may exceed the payment retry count if we
2255 // get two failures in a row with the second having `all_paths_failed` set.
2256 // Generally, when we give up trying to retry a payment, we don't know for sure what the
2257 // current state of the ChannelManager event queue is. Specifically, we cannot be sure that
2258 // there are not multiple additional `PaymentPathFailed` or even `PaymentSent` events
2259 // pending which we will see later. Thus, when we previously removed the retry tracking map
2260 // entry after a `all_paths_failed` `PaymentPathFailed` event, we may have dropped the
2261 // retry entry even though more events for the same payment were still pending. This led to
2262 // us retrying a payment again even though we'd already given up on it.
2264 // We now have a separate event - `PaymentFailed` which indicates no HTLCs remain and which
2265 // is used to remove the payment retry counter entries instead. This tests for the specific
2266 // excess-retry case while also testing `PaymentFailed` generation.
2268 let chanmon_cfgs = create_chanmon_cfgs(3);
2269 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2270 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2271 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2273 let chan_1_scid = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
2274 let chan_2_scid = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 0, channelmanager::provided_init_features(), channelmanager::provided_init_features()).0.contents.short_channel_id;
2276 let mut route = Route {
2279 pubkey: nodes[1].node.get_our_node_id(),
2280 node_features: channelmanager::provided_node_features(),
2281 short_channel_id: chan_1_scid,
2282 channel_features: channelmanager::provided_channel_features(),
2284 cltv_expiry_delta: 100,
2286 pubkey: nodes[2].node.get_our_node_id(),
2287 node_features: channelmanager::provided_node_features(),
2288 short_channel_id: chan_2_scid,
2289 channel_features: channelmanager::provided_channel_features(),
2290 fee_msat: 100_000_000,
2291 cltv_expiry_delta: 100,
2294 pubkey: nodes[1].node.get_our_node_id(),
2295 node_features: channelmanager::provided_node_features(),
2296 short_channel_id: chan_1_scid,
2297 channel_features: channelmanager::provided_channel_features(),
2299 cltv_expiry_delta: 100,
2301 pubkey: nodes[2].node.get_our_node_id(),
2302 node_features: channelmanager::provided_node_features(),
2303 short_channel_id: chan_2_scid,
2304 channel_features: channelmanager::provided_channel_features(),
2305 fee_msat: 100_000_000,
2306 cltv_expiry_delta: 100,
2309 payment_params: Some(PaymentParameters::from_node_id(nodes[2].node.get_our_node_id())),
2311 let router = ManualRouter(RefCell::new(VecDeque::new()));
2312 router.expect_find_route(Ok(route.clone()));
2313 // On retry, we'll only be asked for one path
2314 route.paths.remove(1);
2315 router.expect_find_route(Ok(route.clone()));
2317 let expected_events: RefCell<VecDeque<&dyn Fn(&Event)>> = RefCell::new(VecDeque::new());
2318 let event_handler = |event: &Event| {
2319 let event_checker = expected_events.borrow_mut().pop_front().unwrap();
2320 event_checker(event);
2322 let invoice_payer = InvoicePayer::new(nodes[0].node, router, nodes[0].logger, event_handler, Retry::Attempts(1));
2324 assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager_and_duration_since_epoch(
2325 &nodes[1].node, nodes[1].keys_manager, nodes[1].logger, Currency::Bitcoin,
2326 Some(100_010_000), "Invoice".to_string(), duration_since_epoch(), 3600).unwrap())
2328 let htlc_updates = SendEvent::from_node(&nodes[0]);
2329 check_added_monitors!(nodes[0], 1);
2330 assert_eq!(htlc_updates.msgs.len(), 1);
2332 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &htlc_updates.msgs[0]);
2333 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &htlc_updates.commitment_msg);
2334 check_added_monitors!(nodes[1], 1);
2335 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2337 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2338 check_added_monitors!(nodes[0], 1);
2339 let second_htlc_updates = SendEvent::from_node(&nodes[0]);
2341 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2342 check_added_monitors!(nodes[0], 1);
2343 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2345 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &second_htlc_updates.msgs[0]);
2346 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &second_htlc_updates.commitment_msg);
2347 check_added_monitors!(nodes[1], 1);
2348 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2350 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2351 check_added_monitors!(nodes[1], 1);
2352 let bs_fail_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2354 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2355 check_added_monitors!(nodes[0], 1);
2357 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_update.update_fail_htlcs[0]);
2358 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_fail_update.commitment_signed);
2359 check_added_monitors!(nodes[0], 1);
2360 let (as_second_raa, as_third_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2362 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2363 check_added_monitors!(nodes[1], 1);
2364 let bs_second_fail_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2366 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_third_cs);
2367 check_added_monitors!(nodes[1], 1);
2368 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2370 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_second_fail_update.update_fail_htlcs[0]);
2371 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_fail_update.commitment_signed);
2372 check_added_monitors!(nodes[0], 1);
2374 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2375 check_added_monitors!(nodes[0], 1);
2376 let (as_third_raa, as_fourth_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2378 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_third_raa);
2379 check_added_monitors!(nodes[1], 1);
2380 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_fourth_cs);
2381 check_added_monitors!(nodes[1], 1);
2382 let bs_fourth_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2384 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_fourth_raa);
2385 check_added_monitors!(nodes[0], 1);
2387 // At this point A has sent two HTLCs which both failed due to lack of fee. It now has two
2388 // pending `PaymentPathFailed` events, one with `all_paths_failed` unset, and the second
2389 // with it set. The first event will use up the only retry we are allowed, with the second
2390 // `PaymentPathFailed` being passed up to the user (us, in this case). Previously, we'd
2391 // treated this as "HTLC complete" and dropped the retry counter, causing us to retry again
2392 // if the final HTLC failed.
2393 expected_events.borrow_mut().push_back(&|ev: &Event| {
2394 if let Event::PaymentPathFailed { payment_failed_permanently, all_paths_failed, .. } = ev {
2395 assert!(!payment_failed_permanently);
2396 assert!(all_paths_failed);
2397 } else { panic!("Unexpected event"); }
2399 nodes[0].node.process_pending_events(&invoice_payer);
2400 assert!(expected_events.borrow().is_empty());
2402 let retry_htlc_updates = SendEvent::from_node(&nodes[0]);
2403 check_added_monitors!(nodes[0], 1);
2405 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &retry_htlc_updates.msgs[0]);
2406 commitment_signed_dance!(nodes[1], nodes[0], &retry_htlc_updates.commitment_msg, false, true);
2407 let bs_fail_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2408 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_update.update_fail_htlcs[0]);
2409 commitment_signed_dance!(nodes[0], nodes[1], &bs_fail_update.commitment_signed, false, true);
2411 expected_events.borrow_mut().push_back(&|ev: &Event| {
2412 if let Event::PaymentPathFailed { payment_failed_permanently, all_paths_failed, .. } = ev {
2413 assert!(!payment_failed_permanently);
2414 assert!(all_paths_failed);
2415 } else { panic!("Unexpected event"); }
2417 expected_events.borrow_mut().push_back(&|ev: &Event| {
2418 if let Event::PaymentFailed { .. } = ev {
2419 } else { panic!("Unexpected event"); }
2421 nodes[0].node.process_pending_events(&invoice_payer);
2422 assert!(expected_events.borrow().is_empty());