X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-invoice%2Fsrc%2Fpayment.rs;h=e7cc43508d933bb795d02d7b8e50bdd047dd8320;hb=f99301dd8a7f056c0ed09ec827fddc00f325b3e5;hp=d73ca538981d9e203d2614f68acab93e1a6caf46;hpb=b62b244c3c826523a81631037cd060bafef8e402;p=rust-lightning diff --git a/lightning-invoice/src/payment.rs b/lightning-invoice/src/payment.rs index d73ca538..e7cc4350 100644 --- a/lightning-invoice/src/payment.rs +++ b/lightning-invoice/src/payment.rs @@ -38,15 +38,15 @@ //! # use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret}; //! # use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure}; //! # use lightning::ln::msgs::LightningError; -//! # use lightning::routing::scoring::Score; -//! # use lightning::routing::network_graph::NodeId; +//! # use lightning::routing::gossip::NodeId; //! # use lightning::routing::router::{Route, RouteHop, RouteParameters}; +//! # use lightning::routing::scoring::{ChannelUsage, Score}; //! # use lightning::util::events::{Event, EventHandler, EventsProvider}; //! # use lightning::util::logger::{Logger, Record}; //! # use lightning::util::ser::{Writeable, Writer}; //! # use lightning_invoice::Invoice; -//! # use lightning_invoice::payment::{InvoicePayer, Payer, RetryAttempts, Router}; -//! # use secp256k1::key::PublicKey; +//! # use lightning_invoice::payment::{InvoicePayer, Payer, Retry, Router}; +//! # use secp256k1::PublicKey; //! # use std::cell::RefCell; //! # use std::ops::Deref; //! # @@ -77,8 +77,8 @@ //! # } //! # //! # struct FakeRouter {} -//! # impl Router for FakeRouter { -//! # fn find_route( +//! # impl Router for FakeRouter { +//! # fn find_route( //! # &self, payer: &PublicKey, params: &RouteParameters, payment_hash: &PaymentHash, //! # first_hops: Option<&[&ChannelDetails]>, scorer: &S //! # ) -> Result { unimplemented!() } @@ -90,10 +90,12 @@ //! # } //! # impl Score for FakeScorer { //! # fn channel_penalty_msat( -//! # &self, _short_channel_id: u64, _send_amt: u64, _chan_amt: Option, _source: &NodeId, _target: &NodeId +//! # &self, _short_channel_id: u64, _source: &NodeId, _target: &NodeId, _usage: ChannelUsage //! # ) -> u64 { 0 } //! # fn payment_path_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) {} //! # fn payment_path_successful(&mut self, _path: &[&RouteHop]) {} +//! # fn probe_failed(&mut self, _path: &[&RouteHop], _short_channel_id: u64) {} +//! # fn probe_successful(&mut self, _path: &[&RouteHop]) {} //! # } //! # //! # struct FakeLogger {} @@ -113,7 +115,7 @@ //! # let router = FakeRouter {}; //! # let scorer = RefCell::new(FakeScorer {}); //! # let logger = FakeLogger {}; -//! let invoice_payer = InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2)); +//! let invoice_payer = InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); //! //! let invoice = "..."; //! if let Ok(invoice) = invoice.parse::() { @@ -142,14 +144,19 @@ use crate::prelude::*; use lightning::ln::{PaymentHash, PaymentPreimage, PaymentSecret}; use lightning::ln::channelmanager::{ChannelDetails, PaymentId, PaymentSendFailure}; use lightning::ln::msgs::LightningError; -use lightning::routing::scoring::{LockableScore, Score}; -use lightning::routing::router::{Payee, Route, RouteParameters}; +use lightning::routing::gossip::NodeId; +use lightning::routing::scoring::{ChannelUsage, LockableScore, Score}; +use lightning::routing::router::{PaymentParameters, Route, RouteHop, RouteParameters}; +use lightning::util::errors::APIError; use lightning::util::events::{Event, EventHandler}; use lightning::util::logger::Logger; +use time_utils::Time; use crate::sync::Mutex; -use secp256k1::key::PublicKey; +use secp256k1::PublicKey; +use core::fmt; +use core::fmt::{Debug, Display, Formatter}; use core::ops::Deref; use core::time::Duration; #[cfg(feature = "std")] @@ -160,10 +167,19 @@ use std::time::SystemTime; /// See [module-level documentation] for details. /// /// [module-level documentation]: crate::payment -pub struct InvoicePayer +pub type InvoicePayer = InvoicePayerUsingTime::; + +#[cfg(not(feature = "no-std"))] +type ConfiguredTime = std::time::Instant; +#[cfg(feature = "no-std")] +use time_utils; +#[cfg(feature = "no-std")] +type ConfiguredTime = time_utils::Eternity; + +/// (C-not exported) generally all users should use the [`InvoicePayer`] type alias. +pub struct InvoicePayerUsingTime where P::Target: Payer, - R: for <'a> Router<<::Target as LockableScore<'a>>::Locked>, S::Target: for <'a> LockableScore<'a>, L::Target: Logger, { @@ -173,8 +189,101 @@ where logger: L, event_handler: E, /// Caches the overall attempts at making a payment, which is updated prior to retrying. - payment_cache: Mutex>, - retry_attempts: RetryAttempts, + payment_cache: Mutex>>, + retry: Retry, +} + +/// Used by [`InvoicePayerUsingTime::payment_cache`] to track the payments that are either +/// currently being made, or have outstanding paths that need retrying. +struct PaymentInfo { + attempts: PaymentAttempts, + paths: Vec>, +} + +impl PaymentInfo { + fn new() -> Self { + PaymentInfo { + attempts: PaymentAttempts::new(), + paths: vec![], + } + } +} + +/// Used to store information about all the HTLCs that are inflight across all payment attempts +struct AccountForInFlightHtlcs<'a, S: Score> { + scorer: &'a mut S, + /// Maps a channel's short channel id and its direction to the liquidity used up. + inflight_htlcs: HashMap<(u64, bool), u64>, +} + +#[cfg(c_bindings)] +impl<'a, S:Score> lightning::util::ser::Writeable for AccountForInFlightHtlcs<'a, S> { + fn write(&self, writer: &mut W) -> Result<(), std::io::Error> { self.scorer.write(writer) } +} + +impl<'a, S: Score> Score for AccountForInFlightHtlcs<'a, S> { + fn channel_penalty_msat(&self, short_channel_id: u64, source: &NodeId, target: &NodeId, usage: ChannelUsage) -> u64 { + if let Some(used_liqudity) = self.inflight_htlcs.get(&(short_channel_id, source < target)) { + let usage = ChannelUsage { + inflight_htlc_msat: usage.inflight_htlc_msat + used_liqudity, + ..usage + }; + + self.scorer.channel_penalty_msat(short_channel_id, source, target, usage) + } else { + self.scorer.channel_penalty_msat(short_channel_id, source, target, usage) + } + } + + fn payment_path_failed(&mut self, path: &[&RouteHop], short_channel_id: u64) { + self.scorer.payment_path_failed(path, short_channel_id) + } + + fn payment_path_successful(&mut self, path: &[&RouteHop]) { + self.scorer.payment_path_successful(path) + } + + fn probe_failed(&mut self, path: &[&RouteHop], short_channel_id: u64) { + self.scorer.probe_failed(path, short_channel_id) + } + + fn probe_successful(&mut self, path: &[&RouteHop]) { + self.scorer.probe_successful(path) + } +} + +/// Storing minimal payment attempts information required for determining if a outbound payment can +/// be retried. +#[derive(Clone, Copy)] +struct PaymentAttempts { + /// This count will be incremented only after the result of the attempt is known. When it's 0, + /// it means the result of the first attempt is now known yet. + count: usize, + /// This field is only used when retry is [`Retry::Timeout`] which is only build with feature std + first_attempted_at: T +} + +impl PaymentAttempts { + fn new() -> Self { + PaymentAttempts { + count: 0, + first_attempted_at: T::now() + } + } +} + +impl Display for PaymentAttempts { + fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> { + #[cfg(feature = "no-std")] + return write!( f, "attempts: {}", self.count); + #[cfg(not(feature = "no-std"))] + return write!( + f, + "attempts: {}, duration: {}s", + self.count, + T::now().duration_since(self.first_attempted_at).as_secs() + ); + } } /// A trait defining behavior of an [`Invoice`] payer. @@ -203,21 +312,41 @@ pub trait Payer { } /// A trait defining behavior for routing an [`Invoice`] payment. -pub trait Router { +pub trait Router { /// Finds a [`Route`] between `payer` and `payee` for a payment with the given values. - fn find_route( - &self, payer: &PublicKey, params: &RouteParameters, payment_hash: &PaymentHash, + fn find_route( + &self, payer: &PublicKey, route_params: &RouteParameters, payment_hash: &PaymentHash, first_hops: Option<&[&ChannelDetails]>, scorer: &S ) -> Result; } -/// Number of attempts to retry payment path failures for an [`Invoice`]. +/// Strategies available to retry payment path failures for an [`Invoice`]. /// -/// Note that this is the number of *path* failures, not full payment retries. For multi-path -/// payments, if this is less than the total number of paths, we will never even retry all of the -/// payment's paths. #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] -pub struct RetryAttempts(pub usize); +pub enum Retry { + /// Max number of attempts to retry payment. + /// + /// Note that this is the number of *path* failures, not full payment retries. For multi-path + /// payments, if this is less than the total number of paths, we will never even retry all of the + /// payment's paths. + Attempts(usize), + #[cfg(feature = "std")] + /// Time elapsed before abandoning retries for a payment. + Timeout(Duration), +} + +impl Retry { + fn is_retryable_now(&self, attempts: &PaymentAttempts) -> bool { + match (self, attempts) { + (Retry::Attempts(max_retry_count), PaymentAttempts { count, .. }) => { + max_retry_count >= &count + }, + #[cfg(feature = "std")] + (Retry::Timeout(max_duration), PaymentAttempts { first_attempted_at, .. } ) => + *max_duration >= T::now().duration_since(*first_attempted_at), + } + } +} /// An error that may occur when making a payment. #[derive(Clone, Debug)] @@ -230,19 +359,18 @@ pub enum PaymentError { Sending(PaymentSendFailure), } -impl InvoicePayer +impl InvoicePayerUsingTime where P::Target: Payer, - R: for <'a> Router<<::Target as LockableScore<'a>>::Locked>, S::Target: for <'a> LockableScore<'a>, L::Target: Logger, { /// Creates an invoice payer that retries failed payment paths. /// /// Will forward any [`Event::PaymentPathFailed`] events to the decorated `event_handler` once - /// `retry_attempts` has been exceeded for a given [`Invoice`]. + /// `retry` has been exceeded for a given [`Invoice`]. pub fn new( - payer: P, router: R, scorer: S, logger: L, event_handler: E, retry_attempts: RetryAttempts + payer: P, router: R, scorer: S, logger: L, event_handler: E, retry: Retry ) -> Self { Self { payer, @@ -251,7 +379,7 @@ where logger, event_handler, payment_cache: Mutex::new(HashMap::new()), - retry_attempts, + retry, } } @@ -292,18 +420,18 @@ where let payment_hash = PaymentHash(invoice.payment_hash().clone().into_inner()); match self.payment_cache.lock().unwrap().entry(payment_hash) { hash_map::Entry::Occupied(_) => return Err(PaymentError::Invoice("payment pending")), - hash_map::Entry::Vacant(entry) => entry.insert(0), + hash_map::Entry::Vacant(entry) => entry.insert(PaymentInfo::new()), }; let payment_secret = Some(invoice.payment_secret().clone()); - let mut payee = Payee::from_node_id(invoice.recover_payee_pub_key()) + let mut payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key()) .with_expiry_time(expiry_time_from_unix_epoch(&invoice).as_secs()) .with_route_hints(invoice.route_hints()); if let Some(features) = invoice.features() { - payee = payee.with_features(features.clone()); + payment_params = payment_params.with_features(features.clone()); } - let params = RouteParameters { - payee, + let route_params = RouteParameters { + payment_params, final_value_msat: invoice.amount_milli_satoshis().or(amount_msats).unwrap(), final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32, }; @@ -311,7 +439,8 @@ where let send_payment = |route: &Route| { self.payer.send_payment(route, payment_hash, &payment_secret) }; - self.pay_internal(¶ms, payment_hash, send_payment) + + self.pay_internal(&route_params, payment_hash, send_payment) .map_err(|e| { self.payment_cache.lock().unwrap().remove(&payment_hash); e }) } @@ -327,11 +456,11 @@ where let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()); match self.payment_cache.lock().unwrap().entry(payment_hash) { hash_map::Entry::Occupied(_) => return Err(PaymentError::Invoice("payment pending")), - hash_map::Entry::Vacant(entry) => entry.insert(0), + hash_map::Entry::Vacant(entry) => entry.insert(PaymentInfo::new()), }; - let params = RouteParameters { - payee: Payee::for_keysend(pubkey), + let route_params = RouteParameters { + payment_params: PaymentParameters::for_keysend(pubkey), final_value_msat: amount_msats, final_cltv_expiry_delta, }; @@ -339,7 +468,7 @@ where let send_payment = |route: &Route| { self.payer.send_spontaneous_payment(route, payment_preimage) }; - self.pay_internal(¶ms, payment_hash, send_payment) + self.pay_internal(&route_params, payment_hash, send_payment) .map_err(|e| { self.payment_cache.lock().unwrap().remove(&payment_hash); e }) } @@ -355,28 +484,46 @@ where let payer = self.payer.node_id(); let first_hops = self.payer.first_hops(); + let inflight_htlcs = self.create_inflight_map(); let route = self.router.find_route( - &payer, params, &payment_hash, Some(&first_hops.iter().collect::>()), - &self.scorer.lock() + &payer, ¶ms, &payment_hash, Some(&first_hops.iter().collect::>()), + &AccountForInFlightHtlcs { scorer: &mut self.scorer.lock(), inflight_htlcs } ).map_err(|e| PaymentError::Routing(e))?; match send_payment(&route) { - Ok(payment_id) => Ok(payment_id), + Ok(payment_id) => { + for path in route.paths { + self.process_path_inflight_htlcs(payment_hash, path); + } + Ok(payment_id) + }, Err(e) => match e { PaymentSendFailure::ParameterError(_) => Err(e), PaymentSendFailure::PathParameterError(_) => Err(e), PaymentSendFailure::AllFailedRetrySafe(_) => { let mut payment_cache = self.payment_cache.lock().unwrap(); - let retry_count = payment_cache.get_mut(&payment_hash).unwrap(); - if *retry_count >= self.retry_attempts.0 { - Err(e) - } else { - *retry_count += 1; + let payment_info = payment_cache.get_mut(&payment_hash).unwrap(); + payment_info.attempts.count += 1; + if self.retry.is_retryable_now(&payment_info.attempts) { core::mem::drop(payment_cache); Ok(self.pay_internal(params, payment_hash, send_payment)?) + } else { + Err(e) } }, - PaymentSendFailure::PartialFailure { failed_paths_retry, payment_id, .. } => { + PaymentSendFailure::PartialFailure { failed_paths_retry, payment_id, results } => { + // If a `PartialFailure` event returns a result that is an `Ok()`, it means that + // part of our payment is retried. When we receive `MonitorUpdateFailed`, it + // means that we are still waiting for our channel monitor update to be completed. + for (result, path) in results.iter().zip(route.paths.into_iter()) { + match result { + Ok(_) | Err(APIError::MonitorUpdateFailed) => { + self.process_path_inflight_htlcs(payment_hash, path); + }, + _ => {}, + } + } + if let Some(retry_data) = failed_paths_retry { // Some paths were sent, even if we failed to send the full MPP value our // recipient may misbehave and claim the funds, at which point we have to @@ -396,40 +543,70 @@ where }.map_err(|e| PaymentError::Sending(e)) } + // Takes in a path to have its information stored in `payment_cache`. This is done for paths + // that are pending retry. + fn process_path_inflight_htlcs(&self, payment_hash: PaymentHash, path: Vec) { + self.payment_cache.lock().unwrap().entry(payment_hash) + .or_insert_with(|| PaymentInfo::new()) + .paths.push(path); + } + + // Find the path we want to remove in `payment_cache`. If it doesn't exist, do nothing. + fn remove_path_inflight_htlcs(&self, payment_hash: PaymentHash, path: &Vec) { + self.payment_cache.lock().unwrap().entry(payment_hash) + .and_modify(|payment_info| { + if let Some(idx) = payment_info.paths.iter().position(|p| p == path) { + payment_info.paths.swap_remove(idx); + } + }); + } + fn retry_payment( &self, payment_id: PaymentId, payment_hash: PaymentHash, params: &RouteParameters ) -> Result<(), ()> { - let max_payment_attempts = self.retry_attempts.0 + 1; - let attempts = *self.payment_cache.lock().unwrap() - .entry(payment_hash) - .and_modify(|attempts| *attempts += 1) - .or_insert(1); - - if attempts >= max_payment_attempts { - log_trace!(self.logger, "Payment {} exceeded maximum attempts; not retrying (attempts: {})", log_bytes!(payment_hash.0), attempts); + let attempts = self.payment_cache.lock().unwrap().entry(payment_hash) + .and_modify(|info| info.attempts.count += 1 ) + .or_insert_with(|| PaymentInfo { + attempts: PaymentAttempts { + count: 1, + first_attempted_at: T::now(), + }, + paths: vec![], + }).attempts; + + if !self.retry.is_retryable_now(&attempts) { + log_trace!(self.logger, "Payment {} exceeded maximum attempts; not retrying ({})", log_bytes!(payment_hash.0), attempts); return Err(()); } #[cfg(feature = "std")] { if has_expired(params) { - log_trace!(self.logger, "Invoice expired for payment {}; not retrying (attempts: {})", log_bytes!(payment_hash.0), attempts); + log_trace!(self.logger, "Invoice expired for payment {}; not retrying ({:})", log_bytes!(payment_hash.0), attempts); return Err(()); } } let payer = self.payer.node_id(); let first_hops = self.payer.first_hops(); + let inflight_htlcs = self.create_inflight_map(); + let route = self.router.find_route( &payer, ¶ms, &payment_hash, Some(&first_hops.iter().collect::>()), - &self.scorer.lock() + &AccountForInFlightHtlcs { scorer: &mut self.scorer.lock(), inflight_htlcs } ); + if route.is_err() { - log_trace!(self.logger, "Failed to find a route for payment {}; not retrying (attempts: {})", log_bytes!(payment_hash.0), attempts); + log_trace!(self.logger, "Failed to find a route for payment {}; not retrying ({:})", log_bytes!(payment_hash.0), attempts); return Err(()); } - match self.payer.retry_payment(&route.unwrap(), payment_id) { - Ok(()) => Ok(()), + match self.payer.retry_payment(&route.as_ref().unwrap(), payment_id) { + Ok(()) => { + for path in route.unwrap().paths.into_iter() { + self.process_path_inflight_htlcs(payment_hash, path); + } + Ok(()) + }, Err(PaymentSendFailure::ParameterError(_)) | Err(PaymentSendFailure::PathParameterError(_)) => { log_trace!(self.logger, "Failed to retry for payment {} due to bogus route/payment data, not retrying.", log_bytes!(payment_hash.0)); @@ -438,7 +615,19 @@ where Err(PaymentSendFailure::AllFailedRetrySafe(_)) => { self.retry_payment(payment_id, payment_hash, params) }, - Err(PaymentSendFailure::PartialFailure { failed_paths_retry, .. }) => { + Err(PaymentSendFailure::PartialFailure { failed_paths_retry, results, .. }) => { + // If a `PartialFailure` error contains a result that is an `Ok()`, it means that + // part of our payment is retried. When we receive `MonitorUpdateFailed`, it + // means that we are still waiting for our channel monitor update to complete. + for (result, path) in results.iter().zip(route.unwrap().paths.into_iter()) { + match result { + Ok(_) | Err(APIError::MonitorUpdateFailed) => { + self.process_path_inflight_htlcs(payment_hash, path); + }, + _ => {}, + } + } + if let Some(retry) = failed_paths_retry { // Always return Ok for the same reason as noted in pay_internal. let _ = self.retry_payment(payment_id, payment_hash, &retry); @@ -455,6 +644,47 @@ where pub fn remove_cached_payment(&self, payment_hash: &PaymentHash) { self.payment_cache.lock().unwrap().remove(payment_hash); } + + /// Given a [`PaymentHash`], this function looks up inflight path attempts in the payment_cache. + /// Then, it uses the path information inside the cache to construct a HashMap mapping a channel's + /// short channel id and direction to the amount being sent through it. + /// + /// This function should be called whenever we need information about currently used up liquidity + /// across payments. + fn create_inflight_map(&self) -> HashMap<(u64, bool), u64> { + let mut total_inflight_map: HashMap<(u64, bool), u64> = HashMap::new(); + // Make an attempt at finding existing payment information from `payment_cache`. If it + // does not exist, it probably is a fresh payment and we can just return an empty + // HashMap. + for payment_info in self.payment_cache.lock().unwrap().values() { + for path in &payment_info.paths { + if path.is_empty() { break }; + // total_inflight_map needs to be direction-sensitive when keeping track of the HTLC value + // that is held up. However, the `hops` array, which is a path returned by `find_route` in + // the router excludes the payer node. In the following lines, the payer's information is + // hardcoded with an inflight value of 0 so that we can correctly represent the first hop + // in our sliding window of two. + let our_node_id: PublicKey = self.payer.node_id(); + let reversed_hops_with_payer = path.iter().rev().skip(1) + .map(|hop| hop.pubkey) + .chain(core::iter::once(our_node_id)); + let mut cumulative_msat = 0; + + // Taking the reversed vector from above, we zip it with just the reversed hops list to + // work "backwards" of the given path, since the last hop's `fee_msat` actually represents + // the total amount sent. + for (next_hop, prev_hop) in path.iter().rev().zip(reversed_hops_with_payer) { + cumulative_msat += next_hop.fee_msat; + total_inflight_map + .entry((next_hop.short_channel_id, NodeId::from_pubkey(&prev_hop) < NodeId::from_pubkey(&next_hop.pubkey))) + .and_modify(|used_liquidity_msat| *used_liquidity_msat += cumulative_msat) + .or_insert(cumulative_msat); + } + } + } + + total_inflight_map + } } fn expiry_time_from_unix_epoch(invoice: &Invoice) -> Duration { @@ -462,20 +692,29 @@ fn expiry_time_from_unix_epoch(invoice: &Invoice) -> Duration { } #[cfg(feature = "std")] -fn has_expired(params: &RouteParameters) -> bool { - if let Some(expiry_time) = params.payee.expiry_time { +fn has_expired(route_params: &RouteParameters) -> bool { + if let Some(expiry_time) = route_params.payment_params.expiry_time { Invoice::is_expired_from_epoch(&SystemTime::UNIX_EPOCH, Duration::from_secs(expiry_time)) } else { false } } -impl EventHandler for InvoicePayer +impl EventHandler for InvoicePayerUsingTime where P::Target: Payer, - R: for <'a> Router<<::Target as LockableScore<'a>>::Locked>, S::Target: for <'a> LockableScore<'a>, L::Target: Logger, { fn handle_event(&self, event: &Event) { + match event { + Event::PaymentPathFailed { payment_hash, path, .. } + | Event::PaymentPathSuccessful { path, payment_hash: Some(payment_hash), .. } + | Event::ProbeSuccessful { payment_hash, path, .. } + | Event::ProbeFailed { payment_hash, path, .. } => { + self.remove_path_inflight_htlcs(*payment_hash, path); + }, + _ => {}, + } + match event { Event::PaymentPathFailed { payment_id, payment_hash, rejected_by_dest, path, short_channel_id, retry, .. @@ -511,9 +750,21 @@ where let mut payment_cache = self.payment_cache.lock().unwrap(); let attempts = payment_cache .remove(payment_hash) - .map_or(1, |attempts| attempts + 1); + .map_or(1, |payment_info| payment_info.attempts.count + 1); log_trace!(self.logger, "Payment {} succeeded (attempts: {})", log_bytes!(payment_hash.0), attempts); }, + Event::ProbeSuccessful { payment_hash, path, .. } => { + log_trace!(self.logger, "Probe payment {} of {}msat was successful", log_bytes!(payment_hash.0), path.last().unwrap().fee_msat); + let path = path.iter().collect::>(); + self.scorer.lock().probe_successful(&path); + }, + Event::ProbeFailed { payment_hash, path, short_channel_id, .. } => { + if let Some(short_channel_id) = short_channel_id { + log_trace!(self.logger, "Probe payment {} of {}msat failed at channel {}", log_bytes!(payment_hash.0), path.last().unwrap().fee_msat, *short_channel_id); + let path = path.iter().collect::>(); + self.scorer.lock().probe_failed(&path, *short_channel_id); + } + }, _ => {}, } @@ -532,8 +783,9 @@ mod tests { use lightning::ln::features::{ChannelFeatures, NodeFeatures, InitFeatures}; use lightning::ln::functional_test_utils::*; use lightning::ln::msgs::{ChannelMessageHandler, ErrorAction, LightningError}; - use lightning::routing::network_graph::NodeId; - use lightning::routing::router::{Payee, Route, RouteHop}; + use lightning::routing::gossip::{EffectiveCapacity, NodeId}; + use lightning::routing::router::{PaymentParameters, Route, RouteHop}; + use lightning::routing::scoring::ChannelUsage; use lightning::util::test_utils::TestLogger; use lightning::util::errors::APIError; use lightning::util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider}; @@ -541,7 +793,9 @@ mod tests { use std::cell::RefCell; use std::collections::VecDeque; use std::time::{SystemTime, Duration}; + use time_utils::tests::SinceEpoch; use DEFAULT_EXPIRY_TIME; + use lightning::util::errors::APIError::{ChannelUnavailable, MonitorUpdateFailed}; fn invoice(payment_preimage: PaymentPreimage) -> Invoice { let payment_hash = Sha256::hash(&payment_preimage.0); @@ -555,7 +809,7 @@ mod tests { .min_final_cltv_expiry(144) .amount_milli_satoshis(128) .build_signed(|hash| { - Secp256k1::new().sign_recoverable(hash, &private_key) + Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key) }) .unwrap() } @@ -580,7 +834,7 @@ mod tests { .duration_since_epoch(duration_since_epoch()) .min_final_cltv_expiry(144) .build_signed(|hash| { - Secp256k1::new().sign_recoverable(hash, &private_key) + Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key) }) .unwrap() } @@ -600,7 +854,7 @@ mod tests { .min_final_cltv_expiry(144) .amount_milli_satoshis(128) .build_signed(|hash| { - Secp256k1::new().sign_recoverable(hash, &private_key) + Secp256k1::new().sign_ecdsa_recoverable(hash, &private_key) }) .unwrap() } @@ -624,7 +878,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(0)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(0)); let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap()); assert_eq!(*payer.attempts.borrow(), 1); @@ -653,7 +907,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap()); assert_eq!(*payer.attempts.borrow(), 1); @@ -689,8 +943,8 @@ mod tests { let final_value_msat = invoice.amount_milli_satoshis().unwrap(); let payer = TestPayer::new() - .fails_with_partial_failure(retry.clone(), OnAttempt(1)) - .fails_with_partial_failure(retry, OnAttempt(2)) + .fails_with_partial_failure(retry.clone(), OnAttempt(1), None) + .fails_with_partial_failure(retry, OnAttempt(2), None) .expect_send(Amount::ForInvoice(final_value_msat)) .expect_send(Amount::OnRetry(final_value_msat / 2)) .expect_send(Amount::OnRetry(final_value_msat / 2)); @@ -698,7 +952,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); assert!(invoice_payer.pay_invoice(&invoice).is_ok()); } @@ -720,7 +974,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); let payment_id = Some(PaymentId([1; 32])); let event = Event::PaymentPathFailed { @@ -749,7 +1003,7 @@ mod tests { } #[test] - fn fails_paying_invoice_after_max_retries() { + fn fails_paying_invoice_after_max_retry_counts() { let event_handled = core::cell::RefCell::new(false); let event_handler = |_: &_| { *event_handled.borrow_mut() = true; }; @@ -765,7 +1019,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap()); assert_eq!(*payer.attempts.borrow(), 1); @@ -805,6 +1059,52 @@ mod tests { assert_eq!(*payer.attempts.borrow(), 3); } + #[cfg(feature = "std")] + #[test] + fn fails_paying_invoice_after_max_retry_timeout() { + let event_handled = core::cell::RefCell::new(false); + let event_handler = |_: &_| { *event_handled.borrow_mut() = true; }; + + let payment_preimage = PaymentPreimage([1; 32]); + let invoice = invoice(payment_preimage); + let final_value_msat = invoice.amount_milli_satoshis().unwrap(); + + let payer = TestPayer::new() + .expect_send(Amount::ForInvoice(final_value_msat)) + .expect_send(Amount::OnRetry(final_value_msat / 2)); + + let router = TestRouter {}; + let scorer = RefCell::new(TestScorer::new()); + let logger = TestLogger::new(); + type InvoicePayerUsingSinceEpoch = InvoicePayerUsingTime::; + + let invoice_payer = + InvoicePayerUsingSinceEpoch::new(&payer, router, &scorer, &logger, event_handler, Retry::Timeout(Duration::from_secs(120))); + + let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap()); + assert_eq!(*payer.attempts.borrow(), 1); + + let event = Event::PaymentPathFailed { + payment_id, + payment_hash: PaymentHash(invoice.payment_hash().clone().into_inner()), + network_update: None, + rejected_by_dest: false, + all_paths_failed: true, + path: TestRouter::path_for_value(final_value_msat), + short_channel_id: None, + retry: Some(TestRouter::retry_for_invoice(&invoice)), + }; + invoice_payer.handle_event(&event); + assert_eq!(*event_handled.borrow(), false); + assert_eq!(*payer.attempts.borrow(), 2); + + SinceEpoch::advance(Duration::from_secs(121)); + + invoice_payer.handle_event(&event); + assert_eq!(*event_handled.borrow(), true); + assert_eq!(*payer.attempts.borrow(), 2); + } + #[test] fn fails_paying_invoice_with_missing_retry_params() { let event_handled = core::cell::RefCell::new(false); @@ -819,7 +1119,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap()); assert_eq!(*payer.attempts.borrow(), 1); @@ -851,7 +1151,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); let payment_preimage = PaymentPreimage([1; 32]); let invoice = expired_invoice(payment_preimage); @@ -876,13 +1176,13 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap()); assert_eq!(*payer.attempts.borrow(), 1); let mut retry_data = TestRouter::retry_for_invoice(&invoice); - retry_data.payee.expiry_time = Some(SystemTime::now() + retry_data.payment_params.expiry_time = Some(SystemTime::now() .checked_sub(Duration::from_secs(2)).unwrap() .duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs()); let event = Event::PaymentPathFailed { @@ -917,7 +1217,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap()); assert_eq!(*payer.attempts.borrow(), 1); @@ -951,7 +1251,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap()); assert_eq!(*payer.attempts.borrow(), 1); @@ -987,7 +1287,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(0)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(0)); let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap()); @@ -1026,7 +1326,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, |_: &_| {}, RetryAttempts(0)); + InvoicePayer::new(&payer, router, &scorer, &logger, |_: &_| {}, Retry::Attempts(0)); let payment_preimage = PaymentPreimage([1; 32]); let invoice = invoice(payment_preimage); @@ -1050,7 +1350,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, |_: &_| {}, RetryAttempts(0)); + InvoicePayer::new(&payer, router, &scorer, &logger, |_: &_| {}, Retry::Attempts(0)); match invoice_payer.pay_invoice(&invoice) { Err(PaymentError::Sending(_)) => {}, @@ -1074,7 +1374,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(0)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(0)); let payment_id = Some(invoice_payer.pay_zero_value_invoice(&invoice, final_value_msat).unwrap()); @@ -1097,7 +1397,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(0)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(0)); let payment_preimage = PaymentPreimage([1; 32]); let invoice = invoice(payment_preimage); @@ -1128,7 +1428,7 @@ mod tests { let scorer = RefCell::new(TestScorer::new()); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); let payment_id = Some(invoice_payer.pay_pubkey( pubkey, payment_preimage, final_value_msat, final_cltv_expiry_delta @@ -1136,7 +1436,7 @@ mod tests { assert_eq!(*payer.attempts.borrow(), 1); let retry = RouteParameters { - payee: Payee::for_keysend(pubkey), + payment_params: PaymentParameters::for_keysend(pubkey), final_value_msat, final_cltv_expiry_delta, }; @@ -1178,12 +1478,12 @@ mod tests { .expect_send(Amount::ForInvoice(final_value_msat)) .expect_send(Amount::OnRetry(final_value_msat / 2)); let router = TestRouter {}; - let scorer = RefCell::new(TestScorer::new().expect(PaymentPath::Failure { + let scorer = RefCell::new(TestScorer::new().expect(TestResult::PaymentFailure { path: path.clone(), short_channel_id: path[0].short_channel_id, })); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); let payment_id = Some(invoice_payer.pay_invoice(&invoice).unwrap()); let event = Event::PaymentPathFailed { @@ -1214,12 +1514,12 @@ mod tests { let payer = TestPayer::new().expect_send(Amount::ForInvoice(final_value_msat)); let router = TestRouter {}; let scorer = RefCell::new(TestScorer::new() - .expect(PaymentPath::Success { path: route.paths[0].clone() }) - .expect(PaymentPath::Success { path: route.paths[1].clone() }) + .expect(TestResult::PaymentSuccess { path: route.paths[0].clone() }) + .expect(TestResult::PaymentSuccess { path: route.paths[1].clone() }) ); let logger = TestLogger::new(); let invoice_payer = - InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, RetryAttempts(2)); + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); let payment_id = invoice_payer.pay_invoice(&invoice).unwrap(); let event = Event::PaymentPathSuccessful { @@ -1232,26 +1532,292 @@ mod tests { invoice_payer.handle_event(&event); } + #[test] + fn generates_correct_inflight_map_data() { + let event_handled = core::cell::RefCell::new(false); + let event_handler = |_: &_| { *event_handled.borrow_mut() = true; }; + + let payment_preimage = PaymentPreimage([1; 32]); + let invoice = invoice(payment_preimage); + let payment_hash = Some(PaymentHash(invoice.payment_hash().clone().into_inner())); + let final_value_msat = invoice.amount_milli_satoshis().unwrap(); + + let payer = TestPayer::new().expect_send(Amount::ForInvoice(final_value_msat)); + let final_value_msat = invoice.amount_milli_satoshis().unwrap(); + let route = TestRouter::route_for_value(final_value_msat); + let router = TestRouter {}; + let scorer = RefCell::new(TestScorer::new()); + let logger = TestLogger::new(); + let invoice_payer = + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(0)); + + let payment_id = invoice_payer.pay_invoice(&invoice).unwrap(); + + let inflight_map = invoice_payer.create_inflight_map(); + // First path check + assert_eq!(inflight_map.get(&(0, false)).unwrap().clone(), 94); + assert_eq!(inflight_map.get(&(1, true)).unwrap().clone(), 84); + assert_eq!(inflight_map.get(&(2, false)).unwrap().clone(), 64); + + // Second path check + assert_eq!(inflight_map.get(&(3, false)).unwrap().clone(), 74); + assert_eq!(inflight_map.get(&(4, false)).unwrap().clone(), 64); + + invoice_payer.handle_event(&Event::PaymentPathSuccessful { + payment_id, payment_hash, path: route.paths[0].clone() + }); + + let inflight_map = invoice_payer.create_inflight_map(); + + assert_eq!(inflight_map.get(&(0, false)), None); + assert_eq!(inflight_map.get(&(1, true)), None); + assert_eq!(inflight_map.get(&(2, false)), None); + + // Second path should still be inflight + assert_eq!(inflight_map.get(&(3, false)).unwrap().clone(), 74); + assert_eq!(inflight_map.get(&(4, false)).unwrap().clone(), 64) + } + + #[test] + fn considers_inflight_htlcs_between_invoice_payments_when_path_succeeds() { + // First, let's just send a payment through, but only make sure one of the path completes + let event_handled = core::cell::RefCell::new(false); + let event_handler = |_: &_| { *event_handled.borrow_mut() = true; }; + + let payment_preimage = PaymentPreimage([1; 32]); + let payment_invoice = invoice(payment_preimage); + let payment_hash = Some(PaymentHash(payment_invoice.payment_hash().clone().into_inner())); + let final_value_msat = payment_invoice.amount_milli_satoshis().unwrap(); + + let payer = TestPayer::new() + .expect_send(Amount::ForInvoice(final_value_msat)) + .expect_send(Amount::ForInvoice(final_value_msat)); + let final_value_msat = payment_invoice.amount_milli_satoshis().unwrap(); + let route = TestRouter::route_for_value(final_value_msat); + let router = TestRouter {}; + let scorer = RefCell::new(TestScorer::new() + // 1st invoice, 1st path + .expect_usage(ChannelUsage { amount_msat: 64, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 84, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 94, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + // 1st invoice, 2nd path + .expect_usage(ChannelUsage { amount_msat: 64, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 74, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + // 2nd invoice, 1st path + .expect_usage(ChannelUsage { amount_msat: 64, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 84, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 94, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + // 2nd invoice, 2nd path + .expect_usage(ChannelUsage { amount_msat: 64, inflight_htlc_msat: 64, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 74, inflight_htlc_msat: 74, effective_capacity: EffectiveCapacity::Unknown } ) + ); + let logger = TestLogger::new(); + let invoice_payer = + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(0)); + + // Succeed 1st path, leave 2nd path inflight + let payment_id = invoice_payer.pay_invoice(&payment_invoice).unwrap(); + invoice_payer.handle_event(&Event::PaymentPathSuccessful { + payment_id, payment_hash, path: route.paths[0].clone() + }); + + // Let's pay a second invoice that will be using the same path. This should trigger the + // assertions that expect the last 4 ChannelUsage values above where TestScorer is initialized. + // Particularly, the 2nd path of the 1st payment, since it is not yet complete, should still + // have 64 msats inflight for paths considering the channel with scid of 1. + let payment_preimage_2 = PaymentPreimage([2; 32]); + let payment_invoice_2 = invoice(payment_preimage_2); + invoice_payer.pay_invoice(&payment_invoice_2).unwrap(); + } + + #[test] + fn considers_inflight_htlcs_between_retries() { + // First, let's just send a payment through, but only make sure one of the path completes + let event_handled = core::cell::RefCell::new(false); + let event_handler = |_: &_| { *event_handled.borrow_mut() = true; }; + + let payment_preimage = PaymentPreimage([1; 32]); + let payment_invoice = invoice(payment_preimage); + let payment_hash = PaymentHash(payment_invoice.payment_hash().clone().into_inner()); + let final_value_msat = payment_invoice.amount_milli_satoshis().unwrap(); + + let payer = TestPayer::new() + .expect_send(Amount::ForInvoice(final_value_msat)) + .expect_send(Amount::OnRetry(final_value_msat / 2)) + .expect_send(Amount::OnRetry(final_value_msat / 4)); + let final_value_msat = payment_invoice.amount_milli_satoshis().unwrap(); + let router = TestRouter {}; + let scorer = RefCell::new(TestScorer::new() + // 1st invoice, 1st path + .expect_usage(ChannelUsage { amount_msat: 64, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 84, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 94, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + // 1st invoice, 2nd path + .expect_usage(ChannelUsage { amount_msat: 64, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 74, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + // Retry 1, 1st path + .expect_usage(ChannelUsage { amount_msat: 32, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 52, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 62, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + // Retry 1, 2nd path + .expect_usage(ChannelUsage { amount_msat: 32, inflight_htlc_msat: 64, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 42, inflight_htlc_msat: 64 + 10, effective_capacity: EffectiveCapacity::Unknown } ) + // Retry 2, 1st path + .expect_usage(ChannelUsage { amount_msat: 16, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 36, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 46, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown } ) + // Retry 2, 2nd path + .expect_usage(ChannelUsage { amount_msat: 16, inflight_htlc_msat: 64 + 32, effective_capacity: EffectiveCapacity::Unknown } ) + .expect_usage(ChannelUsage { amount_msat: 26, inflight_htlc_msat: 74 + 32 + 10, effective_capacity: EffectiveCapacity::Unknown } ) + ); + let logger = TestLogger::new(); + let invoice_payer = + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(2)); + + // Fail 1st path, leave 2nd path inflight + let payment_id = Some(invoice_payer.pay_invoice(&payment_invoice).unwrap()); + invoice_payer.handle_event(&Event::PaymentPathFailed { + payment_id, + payment_hash, + network_update: None, + rejected_by_dest: false, + all_paths_failed: false, + path: TestRouter::path_for_value(final_value_msat), + short_channel_id: None, + retry: Some(TestRouter::retry_for_invoice(&payment_invoice)), + }); + + // Fails again the 1st path of our retry + invoice_payer.handle_event(&Event::PaymentPathFailed { + payment_id, + payment_hash, + network_update: None, + rejected_by_dest: false, + all_paths_failed: false, + path: TestRouter::path_for_value(final_value_msat / 2), + short_channel_id: None, + retry: Some(RouteParameters { + final_value_msat: final_value_msat / 4, + ..TestRouter::retry_for_invoice(&payment_invoice) + }), + }); + } + + #[test] + fn accounts_for_some_inflight_htlcs_sent_during_partial_failure() { + let event_handled = core::cell::RefCell::new(false); + let event_handler = |_: &_| { *event_handled.borrow_mut() = true; }; + + let payment_preimage = PaymentPreimage([1; 32]); + let invoice_to_pay = invoice(payment_preimage); + let final_value_msat = invoice_to_pay.amount_milli_satoshis().unwrap(); + + let retry = TestRouter::retry_for_invoice(&invoice_to_pay); + let payer = TestPayer::new() + .fails_with_partial_failure( + retry.clone(), OnAttempt(1), + Some(vec![ + Err(ChannelUnavailable { err: "abc".to_string() }), Err(MonitorUpdateFailed) + ])) + .expect_send(Amount::ForInvoice(final_value_msat)); + + let router = TestRouter {}; + let scorer = RefCell::new(TestScorer::new()); + let logger = TestLogger::new(); + let invoice_payer = + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(0)); + + invoice_payer.pay_invoice(&invoice_to_pay).unwrap(); + let inflight_map = invoice_payer.create_inflight_map(); + + // Only the second path, which failed with `MonitorUpdateFailed` should be added to our + // inflight map because retries are disabled. + assert_eq!(inflight_map.len(), 2); + } + + #[test] + fn accounts_for_all_inflight_htlcs_sent_during_partial_failure() { + let event_handled = core::cell::RefCell::new(false); + let event_handler = |_: &_| { *event_handled.borrow_mut() = true; }; + + let payment_preimage = PaymentPreimage([1; 32]); + let invoice_to_pay = invoice(payment_preimage); + let final_value_msat = invoice_to_pay.amount_milli_satoshis().unwrap(); + + let retry = TestRouter::retry_for_invoice(&invoice_to_pay); + let payer = TestPayer::new() + .fails_with_partial_failure( + retry.clone(), OnAttempt(1), + Some(vec![ + Ok(()), Err(MonitorUpdateFailed) + ])) + .expect_send(Amount::ForInvoice(final_value_msat)); + + let router = TestRouter {}; + let scorer = RefCell::new(TestScorer::new()); + let logger = TestLogger::new(); + let invoice_payer = + InvoicePayer::new(&payer, router, &scorer, &logger, event_handler, Retry::Attempts(0)); + + invoice_payer.pay_invoice(&invoice_to_pay).unwrap(); + let inflight_map = invoice_payer.create_inflight_map(); + + // All paths successful, hence we check of the existence of all 5 hops. + assert_eq!(inflight_map.len(), 5); + } + struct TestRouter; impl TestRouter { fn route_for_value(final_value_msat: u64) -> Route { Route { paths: vec![ - vec![RouteHop { - pubkey: PublicKey::from_slice(&hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(), - channel_features: ChannelFeatures::empty(), - node_features: NodeFeatures::empty(), - short_channel_id: 0, fee_msat: final_value_msat / 2, cltv_expiry_delta: 144 - }], - vec![RouteHop { - pubkey: PublicKey::from_slice(&hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(), - channel_features: ChannelFeatures::empty(), - node_features: NodeFeatures::empty(), - short_channel_id: 1, fee_msat: final_value_msat / 2, cltv_expiry_delta: 144 - }], + vec![ + RouteHop { + pubkey: PublicKey::from_slice(&hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(), + channel_features: ChannelFeatures::empty(), + node_features: NodeFeatures::empty(), + short_channel_id: 0, + fee_msat: 10, + cltv_expiry_delta: 0 + }, + RouteHop { + pubkey: PublicKey::from_slice(&hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(), + channel_features: ChannelFeatures::empty(), + node_features: NodeFeatures::empty(), + short_channel_id: 1, + fee_msat: 20, + cltv_expiry_delta: 0 + }, + RouteHop { + pubkey: PublicKey::from_slice(&hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(), + channel_features: ChannelFeatures::empty(), + node_features: NodeFeatures::empty(), + short_channel_id: 2, + fee_msat: final_value_msat / 2, + cltv_expiry_delta: 0 + }, + ], + vec![ + RouteHop { + pubkey: PublicKey::from_slice(&hex::decode("029e03a901b85534ff1e92c43c74431f7ce72046060fcf7a95c37e148f78c77255").unwrap()[..]).unwrap(), + channel_features: ChannelFeatures::empty(), + node_features: NodeFeatures::empty(), + short_channel_id: 3, + fee_msat: 10, + cltv_expiry_delta: 144 + }, + RouteHop { + pubkey: PublicKey::from_slice(&hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(), + channel_features: ChannelFeatures::empty(), + node_features: NodeFeatures::empty(), + short_channel_id: 4, + fee_msat: final_value_msat / 2, + cltv_expiry_delta: 144 + } + ], ], - payee: None, + payment_params: None, } } @@ -1260,36 +1826,58 @@ mod tests { } fn retry_for_invoice(invoice: &Invoice) -> RouteParameters { - let mut payee = Payee::from_node_id(invoice.recover_payee_pub_key()) + let mut payment_params = PaymentParameters::from_node_id(invoice.recover_payee_pub_key()) .with_expiry_time(expiry_time_from_unix_epoch(invoice).as_secs()) .with_route_hints(invoice.route_hints()); if let Some(features) = invoice.features() { - payee = payee.with_features(features.clone()); + payment_params = payment_params.with_features(features.clone()); } let final_value_msat = invoice.amount_milli_satoshis().unwrap() / 2; RouteParameters { - payee, + payment_params, final_value_msat, final_cltv_expiry_delta: invoice.min_final_cltv_expiry() as u32, } } } - impl Router for TestRouter { - fn find_route( - &self, _payer: &PublicKey, params: &RouteParameters, _payment_hash: &PaymentHash, - _first_hops: Option<&[&ChannelDetails]>, _scorer: &S + impl Router for TestRouter { + fn find_route( + &self, payer: &PublicKey, route_params: &RouteParameters, _payment_hash: &PaymentHash, + _first_hops: Option<&[&ChannelDetails]>, scorer: &S ) -> Result { + // Simulate calling the Scorer just as you would in find_route + let route = Self::route_for_value(route_params.final_value_msat); + for path in route.paths { + let mut aggregate_msat = 0u64; + for (idx, hop) in path.iter().rev().enumerate() { + aggregate_msat += hop.fee_msat; + let usage = ChannelUsage { + amount_msat: aggregate_msat, + inflight_htlc_msat: 0, + effective_capacity: EffectiveCapacity::Unknown, + }; + + // Since the path is reversed, the last element in our iteration is the first + // hop. + if idx == path.len() - 1 { + scorer.channel_penalty_msat(hop.short_channel_id, &NodeId::from_pubkey(payer), &NodeId::from_pubkey(&hop.pubkey), usage); + } else { + scorer.channel_penalty_msat(hop.short_channel_id, &NodeId::from_pubkey(&path[idx + 1].pubkey), &NodeId::from_pubkey(&hop.pubkey), usage); + } + } + } + Ok(Route { - payee: Some(params.payee.clone()), ..Self::route_for_value(params.final_value_msat) + payment_params: Some(route_params.payment_params.clone()), ..Self::route_for_value(route_params.final_value_msat) }) } } struct FailingRouter; - impl Router for FailingRouter { - fn find_route( + impl Router for FailingRouter { + fn find_route( &self, _payer: &PublicKey, _params: &RouteParameters, _payment_hash: &PaymentHash, _first_hops: Option<&[&ChannelDetails]>, _scorer: &S ) -> Result { @@ -1298,24 +1886,31 @@ mod tests { } struct TestScorer { - expectations: Option>, + event_expectations: Option>, + scorer_expectations: RefCell>>, } #[derive(Debug)] - enum PaymentPath { - Failure { path: Vec, short_channel_id: u64 }, - Success { path: Vec }, + enum TestResult { + PaymentFailure { path: Vec, short_channel_id: u64 }, + PaymentSuccess { path: Vec }, } impl TestScorer { fn new() -> Self { Self { - expectations: None, + event_expectations: None, + scorer_expectations: RefCell::new(None), } } - fn expect(mut self, expectation: PaymentPath) -> Self { - self.expectations.get_or_insert_with(|| VecDeque::new()).push_back(expectation); + fn expect(mut self, expectation: TestResult) -> Self { + self.event_expectations.get_or_insert_with(|| VecDeque::new()).push_back(expectation); + self + } + + fn expect_usage(self, expectation: ChannelUsage) -> Self { + self.scorer_expectations.borrow_mut().get_or_insert_with(|| VecDeque::new()).push_back(expectation); self } } @@ -1327,17 +1922,28 @@ mod tests { impl Score for TestScorer { fn channel_penalty_msat( - &self, _short_channel_id: u64, _send_amt: u64, _chan_amt: Option, _source: &NodeId, _target: &NodeId - ) -> u64 { 0 } + &self, _short_channel_id: u64, _source: &NodeId, _target: &NodeId, usage: ChannelUsage + ) -> u64 { + if let Some(scorer_expectations) = self.scorer_expectations.borrow_mut().as_mut() { + match scorer_expectations.pop_front() { + Some(expectation) => { + assert_eq!(expectation.amount_msat, usage.amount_msat); + assert_eq!(expectation.inflight_htlc_msat, usage.inflight_htlc_msat); + }, + None => {}, + } + } + 0 + } fn payment_path_failed(&mut self, actual_path: &[&RouteHop], actual_short_channel_id: u64) { - if let Some(expectations) = &mut self.expectations { + if let Some(expectations) = &mut self.event_expectations { match expectations.pop_front() { - Some(PaymentPath::Failure { path, short_channel_id }) => { + Some(TestResult::PaymentFailure { path, short_channel_id }) => { assert_eq!(actual_path, &path.iter().collect::>()[..]); assert_eq!(actual_short_channel_id, short_channel_id); }, - Some(PaymentPath::Success { path }) => { + Some(TestResult::PaymentSuccess { path }) => { panic!("Unexpected successful payment path: {:?}", path) }, None => panic!("Unexpected payment_path_failed call: {:?}", actual_path), @@ -1346,18 +1952,45 @@ mod tests { } fn payment_path_successful(&mut self, actual_path: &[&RouteHop]) { - if let Some(expectations) = &mut self.expectations { + if let Some(expectations) = &mut self.event_expectations { match expectations.pop_front() { - Some(PaymentPath::Failure { path, .. }) => { + Some(TestResult::PaymentFailure { path, .. }) => { panic!("Unexpected payment path failure: {:?}", path) }, - Some(PaymentPath::Success { path }) => { + Some(TestResult::PaymentSuccess { path }) => { assert_eq!(actual_path, &path.iter().collect::>()[..]); }, None => panic!("Unexpected payment_path_successful call: {:?}", actual_path), } } } + + fn probe_failed(&mut self, actual_path: &[&RouteHop], _: u64) { + if let Some(expectations) = &mut self.event_expectations { + match expectations.pop_front() { + Some(TestResult::PaymentFailure { path, .. }) => { + panic!("Unexpected failed payment path: {:?}", path) + }, + Some(TestResult::PaymentSuccess { path }) => { + panic!("Unexpected successful payment path: {:?}", path) + }, + None => panic!("Unexpected payment_path_failed call: {:?}", actual_path), + } + } + } + fn probe_successful(&mut self, actual_path: &[&RouteHop]) { + if let Some(expectations) = &mut self.event_expectations { + match expectations.pop_front() { + Some(TestResult::PaymentFailure { path, .. }) => { + panic!("Unexpected payment path failure: {:?}", path) + }, + Some(TestResult::PaymentSuccess { path }) => { + panic!("Unexpected successful payment path: {:?}", path) + }, + None => panic!("Unexpected payment_path_successful call: {:?}", actual_path), + } + } + } } impl Drop for TestScorer { @@ -1366,9 +1999,15 @@ mod tests { return; } - if let Some(expectations) = &self.expectations { - if !expectations.is_empty() { - panic!("Unsatisfied scorer expectations: {:?}", expectations); + if let Some(event_expectations) = &self.event_expectations { + if !event_expectations.is_empty() { + panic!("Unsatisfied event expectations: {:?}", event_expectations); + } + } + + if let Some(scorer_expectations) = self.scorer_expectations.borrow().as_ref() { + if !scorer_expectations.is_empty() { + panic!("Unsatisfied scorer expectations: {:?}", scorer_expectations) } } } @@ -1408,9 +2047,9 @@ mod tests { self.fails_with(failure, OnAttempt(attempt)) } - fn fails_with_partial_failure(self, retry: RouteParameters, attempt: OnAttempt) -> Self { + fn fails_with_partial_failure(self, retry: RouteParameters, attempt: OnAttempt, results: Option>>) -> Self { self.fails_with(PaymentSendFailure::PartialFailure { - results: vec![], + results: results.unwrap_or(vec![]), failed_paths_retry: Some(retry), payment_id: PaymentId([1; 32]), }, attempt) @@ -1491,8 +2130,8 @@ mod tests { // *** Full Featured Functional Tests with a Real ChannelManager *** struct ManualRouter(RefCell>>); - impl Router for ManualRouter { - fn find_route( + impl Router for ManualRouter { + fn find_route( &self, _payer: &PublicKey, _params: &RouteParameters, _payment_hash: &PaymentHash, _first_hops: Option<&[&ChannelDetails]>, _scorer: &S ) -> Result { @@ -1543,7 +2182,7 @@ mod tests { cltv_expiry_delta: 100, }], ], - payee: Some(Payee::from_node_id(nodes[1].node.get_our_node_id())), + payment_params: Some(PaymentParameters::from_node_id(nodes[1].node.get_our_node_id())), }; let router = ManualRouter(RefCell::new(VecDeque::new())); router.expect_find_route(Ok(route.clone())); @@ -1554,11 +2193,11 @@ mod tests { let event_handler = |_: &_| { panic!(); }; let scorer = RefCell::new(TestScorer::new()); - let invoice_payer = InvoicePayer::new(nodes[0].node, router, &scorer, nodes[0].logger, event_handler, RetryAttempts(1)); + let invoice_payer = InvoicePayer::new(nodes[0].node, router, &scorer, nodes[0].logger, event_handler, Retry::Attempts(1)); assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager_and_duration_since_epoch( &nodes[1].node, nodes[1].keys_manager, Currency::Bitcoin, Some(100_010_000), "Invoice".to_string(), - duration_since_epoch()).unwrap()) + duration_since_epoch(), 3600).unwrap()) .is_ok()); let htlc_msgs = nodes[0].node.get_and_clear_pending_msg_events(); assert_eq!(htlc_msgs.len(), 2); @@ -1587,7 +2226,7 @@ mod tests { cltv_expiry_delta: 100, }], ], - payee: Some(Payee::from_node_id(nodes[1].node.get_our_node_id())), + payment_params: Some(PaymentParameters::from_node_id(nodes[1].node.get_our_node_id())), }; let router = ManualRouter(RefCell::new(VecDeque::new())); router.expect_find_route(Ok(route.clone())); @@ -1600,11 +2239,11 @@ mod tests { let event_handler = |_: &_| { panic!(); }; let scorer = RefCell::new(TestScorer::new()); - let invoice_payer = InvoicePayer::new(nodes[0].node, router, &scorer, nodes[0].logger, event_handler, RetryAttempts(1)); + let invoice_payer = InvoicePayer::new(nodes[0].node, router, &scorer, nodes[0].logger, event_handler, Retry::Attempts(1)); assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager_and_duration_since_epoch( &nodes[1].node, nodes[1].keys_manager, Currency::Bitcoin, Some(100_010_000), "Invoice".to_string(), - duration_since_epoch()).unwrap()) + duration_since_epoch(), 3600).unwrap()) .is_ok()); let htlc_msgs = nodes[0].node.get_and_clear_pending_msg_events(); assert_eq!(htlc_msgs.len(), 2); @@ -1668,7 +2307,7 @@ mod tests { cltv_expiry_delta: 100, }] ], - payee: Some(Payee::from_node_id(nodes[2].node.get_our_node_id())), + payment_params: Some(PaymentParameters::from_node_id(nodes[2].node.get_our_node_id())), }; let router = ManualRouter(RefCell::new(VecDeque::new())); router.expect_find_route(Ok(route.clone())); @@ -1682,11 +2321,11 @@ mod tests { event_checker(event); }; let scorer = RefCell::new(TestScorer::new()); - let invoice_payer = InvoicePayer::new(nodes[0].node, router, &scorer, nodes[0].logger, event_handler, RetryAttempts(1)); + let invoice_payer = InvoicePayer::new(nodes[0].node, router, &scorer, nodes[0].logger, event_handler, Retry::Attempts(1)); assert!(invoice_payer.pay_invoice(&create_invoice_from_channelmanager_and_duration_since_epoch( &nodes[1].node, nodes[1].keys_manager, Currency::Bitcoin, Some(100_010_000), "Invoice".to_string(), - duration_since_epoch()).unwrap()) + duration_since_epoch(), 3600).unwrap()) .is_ok()); let htlc_updates = SendEvent::from_node(&nodes[0]); check_added_monitors!(nodes[0], 1);