_ Git - rust-lightning/blob - lightning/src/ln/outbound_payment.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Utilities to send payments and manage outbound payment information.
  11
  12 use bitcoin::hashes::Hash;
  13 use bitcoin::hashes::sha256::Hash as Sha256;
  14 use bitcoin::secp256k1::{self, Secp256k1, SecretKey};
  15
  16 use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
  17 use crate::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
  18 use crate::ln::channelmanager::{ChannelDetails, HTLCSource, IDEMPOTENCY_TIMEOUT_TICKS, MIN_HTLC_RELAY_HOLDING_CELL_MILLIS, PaymentId};
  19 use crate::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA as LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA;
  20 use crate::ln::msgs::DecodeError;
  21 use crate::ln::onion_utils::HTLCFailReason;
  22 use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, RoutePath, Router};
  23 use crate::util::errors::APIError;
  24 use crate::util::events;
  25 use crate::util::logger::Logger;
  26 use crate::util::time::Time;
  27 #[cfg(all(not(feature = "no-std"), test))]
  28 use crate::util::time::tests::SinceEpoch;
  29
  30 use core::cmp;
  31 use core::fmt::{self, Display, Formatter};
  32 use core::ops::Deref;
  33 use core::time::Duration;
  34
  35 use crate::prelude::*;
  36 use crate::sync::Mutex;
  37
  38 /// Stores the session_priv for each part of a payment that is still pending. For versions 0.0.102
  39 /// and later, also stores information for retrying the payment.
  40 pub(crate) enum PendingOutboundPayment {
  41         Legacy {
  42                 session_privs: HashSet<[u8; 32]>,
  43         },
  44         Retryable {
  45                 retry_strategy: Option<Retry>,
  46                 attempts: PaymentAttempts,
  47                 payment_params: Option<PaymentParameters>,
  48                 session_privs: HashSet<[u8; 32]>,
  49                 payment_hash: PaymentHash,
  50                 payment_secret: Option<PaymentSecret>,
  51                 keysend_preimage: Option<PaymentPreimage>,
  52                 pending_amt_msat: u64,
  53                 /// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
  54                 pending_fee_msat: Option<u64>,
  55                 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
  56                 total_msat: u64,
  57                 /// Our best known block height at the time this payment was initiated.
  58                 starting_block_height: u32,
  59         },
  60         /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
  61         /// been resolved. This ensures we don't look up pending payments in ChannelMonitors on restart
  62         /// and add a pending payment that was already fulfilled.
  63         Fulfilled {
  64                 session_privs: HashSet<[u8; 32]>,
  65                 payment_hash: Option<PaymentHash>,
  66                 timer_ticks_without_htlcs: u8,
  67         },
  68         /// When a payer gives up trying to retry a payment, they inform us, letting us generate a
  69         /// `PaymentFailed` event when all HTLCs have irrevocably failed. This avoids a number of race
  70         /// conditions in MPP-aware payment retriers (1), where the possibility of multiple
  71         /// `PaymentPathFailed` events with `all_paths_failed` can be pending at once, confusing a
  72         /// downstream event handler as to when a payment has actually failed.
  73         ///
  74         /// (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
  75         Abandoned {
  76                 session_privs: HashSet<[u8; 32]>,
  77                 payment_hash: PaymentHash,
  78         },
  79 }
  80
  81 impl PendingOutboundPayment {
  82         fn increment_attempts(&mut self) {
  83                 if let PendingOutboundPayment::Retryable { attempts, .. } = self {
  84                         attempts.count += 1;
  85                 }
  86         }
  87         fn is_auto_retryable_now(&self) -> bool {
  88                 match self {
  89                         PendingOutboundPayment::Retryable { retry_strategy: Some(strategy), attempts, .. } => {
  90                                 strategy.is_retryable_now(&attempts)
  91                         },
  92                         _ => false,
  93                 }
  94         }
  95         fn is_retryable_now(&self) -> bool {
  96                 match self {
  97                         PendingOutboundPayment::Retryable { retry_strategy: None, .. } => {
  98                                 // We're handling retries manually, we can always retry.
  99                                 true
 100                         },
 101                         PendingOutboundPayment::Retryable { retry_strategy: Some(strategy), attempts, .. } => {
 102                                 strategy.is_retryable_now(&attempts)
 103                         },
 104                         _ => false,
 105                 }
 106         }
 107         fn payment_parameters(&mut self) -> Option<&mut PaymentParameters> {
 108                 match self {
 109                         PendingOutboundPayment::Retryable { payment_params: Some(ref mut params), .. } => {
 110                                 Some(params)
 111                         },
 112                         _ => None,
 113                 }
 114         }
 115         pub fn insert_previously_failed_scid(&mut self, scid: u64) {
 116                 if let PendingOutboundPayment::Retryable { payment_params: Some(params), .. } = self {
 117                         params.previously_failed_channels.push(scid);
 118                 }
 119         }
 120         pub(super) fn is_fulfilled(&self) -> bool {
 121                 match self {
 122                         PendingOutboundPayment::Fulfilled { .. } => true,
 123                         _ => false,
 124                 }
 125         }
 126         pub(super) fn abandoned(&self) -> bool {
 127                 match self {
 128                         PendingOutboundPayment::Abandoned { .. } => true,
 129                         _ => false,
 130                 }
 131         }
 132         fn get_pending_fee_msat(&self) -> Option<u64> {
 133                 match self {
 134                         PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
 135                         _ => None,
 136                 }
 137         }
 138
 139         fn payment_hash(&self) -> Option<PaymentHash> {
 140                 match self {
 141                         PendingOutboundPayment::Legacy { .. } => None,
 142                         PendingOutboundPayment::Retryable { payment_hash, .. } => Some(*payment_hash),
 143                         PendingOutboundPayment::Fulfilled { payment_hash, .. } => *payment_hash,
 144                         PendingOutboundPayment::Abandoned { payment_hash, .. } => Some(*payment_hash),
 145                 }
 146         }
 147
 148         fn mark_fulfilled(&mut self) {
 149                 let mut session_privs = HashSet::new();
 150                 core::mem::swap(&mut session_privs, match self {
 151                         PendingOutboundPayment::Legacy { session_privs } |
 152                                 PendingOutboundPayment::Retryable { session_privs, .. } |
 153                                 PendingOutboundPayment::Fulfilled { session_privs, .. } |
 154                                 PendingOutboundPayment::Abandoned { session_privs, .. }
 155                         => session_privs,
 156                 });
 157                 let payment_hash = self.payment_hash();
 158                 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash, timer_ticks_without_htlcs: 0 };
 159         }
 160
 161         fn mark_abandoned(&mut self) -> Result<(), ()> {
 162                 let mut session_privs = HashSet::new();
 163                 let our_payment_hash;
 164                 core::mem::swap(&mut session_privs, match self {
 165                         PendingOutboundPayment::Legacy { .. } |
 166                         PendingOutboundPayment::Fulfilled { .. } =>
 167                                 return Err(()),
 168                         PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } |
 169                         PendingOutboundPayment::Abandoned { session_privs, payment_hash, .. } => {
 170                                 our_payment_hash = *payment_hash;
 171                                 session_privs
 172                         },
 173                 });
 174                 *self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
 175                 Ok(())
 176         }
 177
 178         /// panics if path is None and !self.is_fulfilled
 179         fn remove(&mut self, session_priv: &[u8; 32], path: Option<&Vec<RouteHop>>) -> bool {
 180                 let remove_res = match self {
 181                         PendingOutboundPayment::Legacy { session_privs } |
 182                                 PendingOutboundPayment::Retryable { session_privs, .. } |
 183                                 PendingOutboundPayment::Fulfilled { session_privs, .. } |
 184                                 PendingOutboundPayment::Abandoned { session_privs, .. } => {
 185                                         session_privs.remove(session_priv)
 186                                 }
 187                 };
 188                 if remove_res {
 189                         if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
 190                                 let path = path.expect("Fulfilling a payment should always come with a path");
 191                                 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
 192                                 *pending_amt_msat -= path_last_hop.fee_msat;
 193                                 if let Some(fee_msat) = pending_fee_msat.as_mut() {
 194                                         *fee_msat -= path.get_path_fees();
 195                                 }
 196                         }
 197                 }
 198                 remove_res
 199         }
 200
 201         pub(super) fn insert(&mut self, session_priv: [u8; 32], path: &Vec<RouteHop>) -> bool {
 202                 let insert_res = match self {
 203                         PendingOutboundPayment::Legacy { session_privs } |
 204                                 PendingOutboundPayment::Retryable { session_privs, .. } => {
 205                                         session_privs.insert(session_priv)
 206                                 }
 207                         PendingOutboundPayment::Fulfilled { .. } => false,
 208                         PendingOutboundPayment::Abandoned { .. } => false,
 209                 };
 210                 if insert_res {
 211                         if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
 212                                 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
 213                                 *pending_amt_msat += path_last_hop.fee_msat;
 214                                 if let Some(fee_msat) = pending_fee_msat.as_mut() {
 215                                         *fee_msat += path.get_path_fees();
 216                                 }
 217                         }
 218                 }
 219                 insert_res
 220         }
 221
 222         pub(super) fn remaining_parts(&self) -> usize {
 223                 match self {
 224                         PendingOutboundPayment::Legacy { session_privs } |
 225                                 PendingOutboundPayment::Retryable { session_privs, .. } |
 226                                 PendingOutboundPayment::Fulfilled { session_privs, .. } |
 227                                 PendingOutboundPayment::Abandoned { session_privs, .. } => {
 228                                         session_privs.len()
 229                                 }
 230                 }
 231         }
 232 }
 233
 234 /// Strategies available to retry payment path failures.
 235 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
 236 pub enum Retry {
 237         /// Max number of attempts to retry payment.
 238         ///
 239         /// Each attempt may be multiple HTLCs along multiple paths if the router decides to split up a
 240         /// retry, and may retry multiple failed HTLCs at once if they failed around the same time and
 241         /// were retried along a route from a single call to [`Router::find_route`].
 242         Attempts(usize),
 243         #[cfg(not(feature = "no-std"))]
 244         /// Time elapsed before abandoning retries for a payment.
 245         Timeout(core::time::Duration),
 246 }
 247
 248 impl Retry {
 249         pub(crate) fn is_retryable_now(&self, attempts: &PaymentAttempts) -> bool {
 250                 match (self, attempts) {
 251                         (Retry::Attempts(max_retry_count), PaymentAttempts { count, .. }) => {
 252                                 max_retry_count > count
 253                         },
 254                         #[cfg(all(not(feature = "no-std"), not(test)))]
 255                         (Retry::Timeout(max_duration), PaymentAttempts { first_attempted_at, .. }) =>
 256                                 *max_duration >= std::time::Instant::now().duration_since(*first_attempted_at),
 257                         #[cfg(all(not(feature = "no-std"), test))]
 258                         (Retry::Timeout(max_duration), PaymentAttempts { first_attempted_at, .. }) =>
 259                                 *max_duration >= SinceEpoch::now().duration_since(*first_attempted_at),
 260                 }
 261         }
 262 }
 263
 264 #[cfg(feature = "std")]
 265 pub(super) fn has_expired(route_params: &RouteParameters) -> bool {
 266         if let Some(expiry_time) = route_params.payment_params.expiry_time {
 267                 if let Ok(elapsed) = std::time::SystemTime::UNIX_EPOCH.elapsed() {
 268                         return elapsed > core::time::Duration::from_secs(expiry_time)
 269                 }
 270         }
 271         false
 272 }
 273
 274 pub(crate) type PaymentAttempts = PaymentAttemptsUsingTime<ConfiguredTime>;
 275
 276 /// Storing minimal payment attempts information required for determining if a outbound payment can
 277 /// be retried.
 278 pub(crate) struct PaymentAttemptsUsingTime<T: Time> {
 279         /// This count will be incremented only after the result of the attempt is known. When it's 0,
 280         /// it means the result of the first attempt is not known yet.
 281         pub(crate) count: usize,
 282         /// This field is only used when retry is `Retry::Timeout` which is only build with feature std
 283         first_attempted_at: T
 284 }
 285
 286 #[cfg(not(any(feature = "no-std", test)))]
 287 type ConfiguredTime = std::time::Instant;
 288 #[cfg(feature = "no-std")]
 289 type ConfiguredTime = crate::util::time::Eternity;
 290 #[cfg(all(not(feature = "no-std"), test))]
 291 type ConfiguredTime = SinceEpoch;
 292
 293 impl<T: Time> PaymentAttemptsUsingTime<T> {
 294         pub(crate) fn new() -> Self {
 295                 PaymentAttemptsUsingTime {
 296                         count: 0,
 297                         first_attempted_at: T::now()
 298                 }
 299         }
 300 }
 301
 302 impl<T: Time> Display for PaymentAttemptsUsingTime<T> {
 303         fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
 304                 #[cfg(feature = "no-std")]
 305                 return write!(f, "attempts: {}", self.count);
 306                 #[cfg(not(feature = "no-std"))]
 307                 return write!(
 308                         f,
 309                         "attempts: {}, duration: {}s",
 310                         self.count,
 311                         T::now().duration_since(self.first_attempted_at).as_secs()
 312                 );
 313         }
 314 }
 315
 316 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
 317 /// Err() type describing which state the payment is in, see the description of individual enum
 318 /// states for more.
 319 #[derive(Clone, Debug)]
 320 pub enum PaymentSendFailure {
 321         /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
 322         /// send the payment at all.
 323         ///
 324         /// You can freely resend the payment in full (with the parameter error fixed).
 325         ///
 326         /// Because the payment failed outright, no payment tracking is done and no
 327         /// [`Event::PaymentPathFailed`] or [`Event::PaymentFailed`] events will be generated.
 328         ///
 329         /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
 330         /// [`Event::PaymentFailed`]: crate::util::events::Event::PaymentFailed
 331         ParameterError(APIError),
 332         /// A parameter in a single path which was passed to send_payment was invalid, preventing us
 333         /// from attempting to send the payment at all.
 334         ///
 335         /// You can freely resend the payment in full (with the parameter error fixed).
 336         ///
 337         /// Because the payment failed outright, no payment tracking is done and no
 338         /// [`Event::PaymentPathFailed`] or [`Event::PaymentFailed`] events will be generated.
 339         ///
 340         /// The results here are ordered the same as the paths in the route object which was passed to
 341         /// send_payment.
 342         ///
 343         /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
 344         /// [`Event::PaymentFailed`]: crate::util::events::Event::PaymentFailed
 345         PathParameterError(Vec<Result<(), APIError>>),
 346         /// All paths which were attempted failed to send, with no channel state change taking place.
 347         /// You can freely resend the payment in full (though you probably want to do so over different
 348         /// paths than the ones selected).
 349         ///
 350         /// Because the payment failed outright, no payment tracking is done and no
 351         /// [`Event::PaymentPathFailed`] or [`Event::PaymentFailed`] events will be generated.
 352         ///
 353         /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
 354         /// [`Event::PaymentFailed`]: crate::util::events::Event::PaymentFailed
 355         AllFailedResendSafe(Vec<APIError>),
 356         /// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
 357         /// yet completed (i.e. generated an [`Event::PaymentSent`] or [`Event::PaymentFailed`]).
 358         ///
 359         /// [`PaymentId`]: crate::ln::channelmanager::PaymentId
 360         /// [`Event::PaymentSent`]: crate::util::events::Event::PaymentSent
 361         /// [`Event::PaymentFailed`]: crate::util::events::Event::PaymentFailed
 362         DuplicatePayment,
 363         /// Some paths that were attempted failed to send, though some paths may have succeeded. At least
 364         /// some paths have irrevocably committed to the HTLC.
 365         ///
 366         /// The results here are ordered the same as the paths in the route object that was passed to
 367         /// send_payment.
 368         ///
 369         /// Any entries that contain `Err(APIError::MonitorUpdateInprogress)` will send once a
 370         /// [`MonitorEvent::Completed`] is provided for the next-hop channel with the latest update_id.
 371         ///
 372         /// [`MonitorEvent::Completed`]: crate::chain::channelmonitor::MonitorEvent::Completed
 373         PartialFailure {
 374                 /// The errors themselves, in the same order as the paths from the route.
 375                 results: Vec<Result<(), APIError>>,
 376                 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
 377                 /// contain a [`RouteParameters`] object for the failing paths.
 378                 failed_paths_retry: Option<RouteParameters>,
 379                 /// The payment id for the payment, which is now at least partially pending.
 380                 payment_id: PaymentId,
 381         },
 382 }
 383
 384 pub(super) struct OutboundPayments {
 385         pub(super) pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
 386         pub(super) retry_lock: Mutex<()>,
 387 }
 388
 389 impl OutboundPayments {
 390         pub(super) fn new() -> Self {
 391                 Self {
 392                         pending_outbound_payments: Mutex::new(HashMap::new()),
 393                         retry_lock: Mutex::new(()),
 394                 }
 395         }
 396
 397         pub(super) fn send_payment<R: Deref, ES: Deref, NS: Deref, IH, SP, L: Deref>(
 398                 &self, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId,
 399                 retry_strategy: Retry, route_params: RouteParameters, router: &R,
 400                 first_hops: Vec<ChannelDetails>, compute_inflight_htlcs: IH, entropy_source: &ES,
 401                 node_signer: &NS, best_block_height: u32, logger: &L, send_payment_along_path: SP,
 402         ) -> Result<(), PaymentSendFailure>
 403         where
 404                 R::Target: Router,
 405                 ES::Target: EntropySource,
 406                 NS::Target: NodeSigner,
 407                 L::Target: Logger,
 408                 IH: Fn() -> InFlightHtlcs,
 409                 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 410                          u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>,
 411         {
 412                 self.pay_internal(payment_id, Some((payment_hash, payment_secret, None, retry_strategy)),
 413                         route_params, router, first_hops, &compute_inflight_htlcs, entropy_source, node_signer,
 414                         best_block_height, logger, &send_payment_along_path)
 415                         .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
 416         }
 417
 418         pub(super) fn send_payment_with_route<ES: Deref, NS: Deref, F>(
 419                 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
 420                 payment_id: PaymentId, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
 421                 send_payment_along_path: F
 422         ) -> Result<(), PaymentSendFailure>
 423         where
 424                 ES::Target: EntropySource,
 425                 NS::Target: NodeSigner,
 426                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 427                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 428         {
 429                 let onion_session_privs = self.add_new_pending_payment(payment_hash, *payment_secret, payment_id, None, route, None, None, entropy_source, best_block_height)?;
 430                 self.pay_route_internal(route, payment_hash, payment_secret, None, payment_id, None,
 431                         onion_session_privs, node_signer, best_block_height, &send_payment_along_path)
 432                         .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
 433         }
 434
 435         pub(super) fn send_spontaneous_payment<R: Deref, ES: Deref, NS: Deref, IH, SP, L: Deref>(
 436                 &self, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId,
 437                 retry_strategy: Retry, route_params: RouteParameters, router: &R,
 438                 first_hops: Vec<ChannelDetails>, inflight_htlcs: IH, entropy_source: &ES,
 439                 node_signer: &NS, best_block_height: u32, logger: &L, send_payment_along_path: SP
 440         ) -> Result<PaymentHash, PaymentSendFailure>
 441         where
 442                 R::Target: Router,
 443                 ES::Target: EntropySource,
 444                 NS::Target: NodeSigner,
 445                 L::Target: Logger,
 446                 IH: Fn() -> InFlightHtlcs,
 447                 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 448                          u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>,
 449         {
 450                 let preimage = payment_preimage
 451                         .unwrap_or_else(|| PaymentPreimage(entropy_source.get_secure_random_bytes()));
 452                 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
 453                 self.pay_internal(payment_id, Some((payment_hash, &None, Some(preimage), retry_strategy)),
 454                         route_params, router, first_hops, &inflight_htlcs, entropy_source, node_signer,
 455                         best_block_height, logger, &send_payment_along_path)
 456                         .map(|()| payment_hash)
 457                         .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
 458         }
 459
 460         pub(super) fn send_spontaneous_payment_with_route<ES: Deref, NS: Deref, F>(
 461                 &self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId,
 462                 entropy_source: &ES, node_signer: &NS, best_block_height: u32, send_payment_along_path: F
 463         ) -> Result<PaymentHash, PaymentSendFailure>
 464         where
 465                 ES::Target: EntropySource,
 466                 NS::Target: NodeSigner,
 467                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 468                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 469         {
 470                 let preimage = payment_preimage
 471                         .unwrap_or_else(|| PaymentPreimage(entropy_source.get_secure_random_bytes()));
 472                 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
 473                 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, Some(preimage), &route, None, None, entropy_source, best_block_height)?;
 474
 475                 match self.pay_route_internal(route, payment_hash, &None, Some(preimage), payment_id, None, onion_session_privs, node_signer, best_block_height, &send_payment_along_path) {
 476                         Ok(()) => Ok(payment_hash),
 477                         Err(e) => {
 478                                 self.remove_outbound_if_all_failed(payment_id, &e);
 479                                 Err(e)
 480                         }
 481                 }
 482         }
 483
 484         pub(super) fn check_retry_payments<R: Deref, ES: Deref, NS: Deref, SP, IH, FH, L: Deref>(
 485                 &self, router: &R, first_hops: FH, inflight_htlcs: IH, entropy_source: &ES, node_signer: &NS,
 486                 best_block_height: u32, pending_events: &Mutex<Vec<events::Event>>, logger: &L,
 487                 send_payment_along_path: SP,
 488         )
 489         where
 490                 R::Target: Router,
 491                 ES::Target: EntropySource,
 492                 NS::Target: NodeSigner,
 493                 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 494                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>,
 495                 IH: Fn() -> InFlightHtlcs,
 496                 FH: Fn() -> Vec<ChannelDetails>,
 497                 L::Target: Logger,
 498         {
 499                 let _single_thread = self.retry_lock.lock().unwrap();
 500                 loop {
 501                         let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 502                         let mut retry_id_route_params = None;
 503                         for (pmt_id, pmt) in outbounds.iter_mut() {
 504                                 if pmt.is_auto_retryable_now() {
 505                                         if let PendingOutboundPayment::Retryable { pending_amt_msat, total_msat, payment_params: Some(params), .. } = pmt {
 506                                                 if pending_amt_msat < total_msat {
 507                                                         retry_id_route_params = Some((*pmt_id, RouteParameters {
 508                                                                 final_value_msat: *total_msat - *pending_amt_msat,
 509                                                                 final_cltv_expiry_delta:
 510                                                                         if let Some(delta) = params.final_cltv_expiry_delta { delta }
 511                                                                         else {
 512                                                                                 debug_assert!(false, "We always set the final_cltv_expiry_delta when a path fails");
 513                                                                                 LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA.into()
 514                                                                         },
 515                                                                 payment_params: params.clone(),
 516                                                         }));
 517                                                         break
 518                                                 }
 519                                         }
 520                                 }
 521                         }
 522                         core::mem::drop(outbounds);
 523                         if let Some((payment_id, route_params)) = retry_id_route_params {
 524                                 if let Err(e) = self.pay_internal(payment_id, None, route_params, router, first_hops(), &inflight_htlcs, entropy_source, node_signer, best_block_height, logger, &send_payment_along_path) {
 525                                         log_info!(logger, "Errored retrying payment: {:?}", e);
 526                                         // If we error on retry, there is no chance of the payment succeeding and no HTLCs have
 527                                         // been irrevocably committed to, so we can safely abandon.
 528                                         self.abandon_payment(payment_id, pending_events);
 529                                 }
 530                         } else { break }
 531                 }
 532
 533                 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 534                 outbounds.retain(|pmt_id, pmt| {
 535                         let mut retain = true;
 536                         if !pmt.is_auto_retryable_now() && pmt.remaining_parts() == 0 {
 537                                 if pmt.mark_abandoned().is_ok() {
 538                                         pending_events.lock().unwrap().push(events::Event::PaymentFailed {
 539                                                 payment_id: *pmt_id,
 540                                                 payment_hash: pmt.payment_hash().expect("PendingOutboundPayments::Retryable always has a payment hash set"),
 541                                         });
 542                                         retain = false;
 543                                 }
 544                         }
 545                         retain
 546                 });
 547         }
 548
 549         /// Will return `Ok(())` iff at least one HTLC is sent for the payment.
 550         fn pay_internal<R: Deref, NS: Deref, ES: Deref, IH, SP, L: Deref>(
 551                 &self, payment_id: PaymentId,
 552                 initial_send_info: Option<(PaymentHash, &Option<PaymentSecret>, Option<PaymentPreimage>, Retry)>,
 553                 route_params: RouteParameters, router: &R, first_hops: Vec<ChannelDetails>,
 554                 inflight_htlcs: &IH, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
 555                 logger: &L, send_payment_along_path: &SP,
 556         ) -> Result<(), PaymentSendFailure>
 557         where
 558                 R::Target: Router,
 559                 ES::Target: EntropySource,
 560                 NS::Target: NodeSigner,
 561                 L::Target: Logger,
 562                 IH: Fn() -> InFlightHtlcs,
 563                 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 564                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 565         {
 566                 #[cfg(feature = "std")] {
 567                         if has_expired(&route_params) {
 568                                 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 569                                         err: format!("Invoice expired for payment id {}", log_bytes!(payment_id.0)),
 570                                 }))
 571                         }
 572                 }
 573
 574                 let route = router.find_route(
 575                         &node_signer.get_node_id(Recipient::Node).unwrap(), &route_params,
 576                         Some(&first_hops.iter().collect::<Vec<_>>()), &inflight_htlcs(),
 577                 ).map_err(|e| PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 578                         err: format!("Failed to find a route for payment {}: {:?}", log_bytes!(payment_id.0), e), // TODO: add APIError::RouteNotFound
 579                 }))?;
 580
 581                 let res = if let Some((payment_hash, payment_secret, keysend_preimage, retry_strategy)) = initial_send_info {
 582                         let onion_session_privs = self.add_new_pending_payment(payment_hash, *payment_secret, payment_id, keysend_preimage, &route, Some(retry_strategy), Some(route_params.payment_params.clone()), entropy_source, best_block_height)?;
 583                         self.pay_route_internal(&route, payment_hash, payment_secret, None, payment_id, None, onion_session_privs, node_signer, best_block_height, send_payment_along_path)
 584                 } else {
 585                         self.retry_payment_with_route(&route, payment_id, entropy_source, node_signer, best_block_height, send_payment_along_path)
 586                 };
 587                 match res {
 588                         Err(PaymentSendFailure::AllFailedResendSafe(_)) => {
 589                                 let retry_res = self.pay_internal(payment_id, None, route_params, router, first_hops, inflight_htlcs, entropy_source, node_signer, best_block_height, logger, send_payment_along_path);
 590                                 log_info!(logger, "Result retrying payment id {}: {:?}", log_bytes!(payment_id.0), retry_res);
 591                                 if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = &retry_res {
 592                                         if err.starts_with("Retries exhausted ") { return res; }
 593                                 }
 594                                 retry_res
 595                         },
 596                         Err(PaymentSendFailure::PartialFailure { failed_paths_retry: Some(retry), .. }) => {
 597                                 // Some paths were sent, even if we failed to send the full MPP value our recipient may
 598                                 // misbehave and claim the funds, at which point we have to consider the payment sent, so
 599                                 // return `Ok()` here, ignoring any retry errors.
 600                                 let retry_res = self.pay_internal(payment_id, None, retry, router, first_hops, inflight_htlcs, entropy_source, node_signer, best_block_height, logger, send_payment_along_path);
 601                                 log_info!(logger, "Result retrying payment id {}: {:?}", log_bytes!(payment_id.0), retry_res);
 602                                 Ok(())
 603                         },
 604                         Err(PaymentSendFailure::PartialFailure { failed_paths_retry: None, .. }) => {
 605                                 // This may happen if we send a payment and some paths fail, but only due to a temporary
 606                                 // monitor failure or the like, implying they're really in-flight, but we haven't sent the
 607                                 // initial HTLC-Add messages yet.
 608                                 Ok(())
 609                         },
 610                         res => res,
 611                 }
 612         }
 613
 614         pub(super) fn retry_payment_with_route<ES: Deref, NS: Deref, F>(
 615                 &self, route: &Route, payment_id: PaymentId, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
 616                 send_payment_along_path: F
 617         ) -> Result<(), PaymentSendFailure>
 618         where
 619                 ES::Target: EntropySource,
 620                 NS::Target: NodeSigner,
 621                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 622                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 623         {
 624                 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
 625                 for path in route.paths.iter() {
 626                         if path.len() == 0 {
 627                                 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 628                                         err: "length-0 path in route".to_string()
 629                                 }))
 630                         }
 631                 }
 632
 633                 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
 634                 for _ in 0..route.paths.len() {
 635                         onion_session_privs.push(entropy_source.get_secure_random_bytes());
 636                 }
 637
 638                 let (total_msat, payment_hash, payment_secret, keysend_preimage) = {
 639                         let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 640                         match outbounds.get_mut(&payment_id) {
 641                                 Some(payment) => {
 642                                         let res = match payment {
 643                                                 PendingOutboundPayment::Retryable {
 644                                                         total_msat, payment_hash, keysend_preimage, payment_secret, pending_amt_msat, ..
 645                                                 } => {
 646                                                         let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
 647                                                         if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
 648                                                                 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 649                                                                         err: format!("retry_amt_msat of {} will put pending_amt_msat (currently: {}) more than 10% over total_payment_amt_msat of {}", retry_amt_msat, pending_amt_msat, total_msat).to_string()
 650                                                                 }))
 651                                                         }
 652                                                         (*total_msat, *payment_hash, *payment_secret, *keysend_preimage)
 653                                                 },
 654                                                 PendingOutboundPayment::Legacy { .. } => {
 655                                                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 656                                                                 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
 657                                                         }))
 658                                                 },
 659                                                 PendingOutboundPayment::Fulfilled { .. } => {
 660                                                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 661                                                                 err: "Payment already completed".to_owned()
 662                                                         }));
 663                                                 },
 664                                                 PendingOutboundPayment::Abandoned { .. } => {
 665                                                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 666                                                                 err: "Payment already abandoned (with some HTLCs still pending)".to_owned()
 667                                                         }));
 668                                                 },
 669                                         };
 670                                         if !payment.is_retryable_now() {
 671                                                 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 672                                                         err: format!("Retries exhausted for payment id {}", log_bytes!(payment_id.0)),
 673                                                 }))
 674                                         }
 675                                         payment.increment_attempts();
 676                                         for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
 677                                                 assert!(payment.insert(*session_priv_bytes, path));
 678                                         }
 679                                         res
 680                                 },
 681                                 None =>
 682                                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 683                                                 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
 684                                         })),
 685                         }
 686                 };
 687                 self.pay_route_internal(route, payment_hash, &payment_secret, keysend_preimage, payment_id, Some(total_msat), onion_session_privs, node_signer, best_block_height, &send_payment_along_path)
 688         }
 689
 690         pub(super) fn send_probe<ES: Deref, NS: Deref, F>(
 691                 &self, hops: Vec<RouteHop>, probing_cookie_secret: [u8; 32], entropy_source: &ES,
 692                 node_signer: &NS, best_block_height: u32, send_payment_along_path: F
 693         ) -> Result<(PaymentHash, PaymentId), PaymentSendFailure>
 694         where
 695                 ES::Target: EntropySource,
 696                 NS::Target: NodeSigner,
 697                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 698                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 699         {
 700                 let payment_id = PaymentId(entropy_source.get_secure_random_bytes());
 701
 702                 let payment_hash = probing_cookie_from_id(&payment_id, probing_cookie_secret);
 703
 704                 if hops.len() < 2 {
 705                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 706                                 err: "No need probing a path with less than two hops".to_string()
 707                         }))
 708                 }
 709
 710                 let route = Route { paths: vec![hops], payment_params: None };
 711                 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, None, &route, None, None, entropy_source, best_block_height)?;
 712
 713                 match self.pay_route_internal(&route, payment_hash, &None, None, payment_id, None, onion_session_privs, node_signer, best_block_height, &send_payment_along_path) {
 714                         Ok(()) => Ok((payment_hash, payment_id)),
 715                         Err(e) => {
 716                                 self.remove_outbound_if_all_failed(payment_id, &e);
 717                                 Err(e)
 718                         }
 719                 }
 720         }
 721
 722         #[cfg(test)]
 723         pub(super) fn test_add_new_pending_payment<ES: Deref>(
 724                 &self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId,
 725                 route: &Route, retry_strategy: Option<Retry>, entropy_source: &ES, best_block_height: u32
 726         ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
 727                 self.add_new_pending_payment(payment_hash, payment_secret, payment_id, None, route, retry_strategy, None, entropy_source, best_block_height)
 728         }
 729
 730         pub(super) fn add_new_pending_payment<ES: Deref>(
 731                 &self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId,
 732                 keysend_preimage: Option<PaymentPreimage>, route: &Route, retry_strategy: Option<Retry>,
 733                 payment_params: Option<PaymentParameters>, entropy_source: &ES, best_block_height: u32
 734         ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
 735                 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
 736                 for _ in 0..route.paths.len() {
 737                         onion_session_privs.push(entropy_source.get_secure_random_bytes());
 738                 }
 739
 740                 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
 741                 match pending_outbounds.entry(payment_id) {
 742                         hash_map::Entry::Occupied(_) => Err(PaymentSendFailure::DuplicatePayment),
 743                         hash_map::Entry::Vacant(entry) => {
 744                                 let payment = entry.insert(PendingOutboundPayment::Retryable {
 745                                         retry_strategy,
 746                                         attempts: PaymentAttempts::new(),
 747                                         payment_params,
 748                                         session_privs: HashSet::new(),
 749                                         pending_amt_msat: 0,
 750                                         pending_fee_msat: Some(0),
 751                                         payment_hash,
 752                                         payment_secret,
 753                                         keysend_preimage,
 754                                         starting_block_height: best_block_height,
 755                                         total_msat: route.get_total_amount(),
 756                                 });
 757
 758                                 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
 759                                         assert!(payment.insert(*session_priv_bytes, path));
 760                                 }
 761
 762                                 Ok(onion_session_privs)
 763                         },
 764                 }
 765         }
 766
 767         fn pay_route_internal<NS: Deref, F>(
 768                 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
 769                 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
 770                 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
 771                 send_payment_along_path: &F
 772         ) -> Result<(), PaymentSendFailure>
 773         where
 774                 NS::Target: NodeSigner,
 775                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 776                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 777         {
 778                 if route.paths.len() < 1 {
 779                         return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
 780                 }
 781                 if payment_secret.is_none() && route.paths.len() > 1 {
 782                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
 783                 }
 784                 let mut total_value = 0;
 785                 let our_node_id = node_signer.get_node_id(Recipient::Node).unwrap(); // TODO no unwrap
 786                 let mut path_errs = Vec::with_capacity(route.paths.len());
 787                 'path_check: for path in route.paths.iter() {
 788                         if path.len() < 1 || path.len() > 20 {
 789                                 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
 790                                 continue 'path_check;
 791                         }
 792                         for (idx, hop) in path.iter().enumerate() {
 793                                 if idx != path.len() - 1 && hop.pubkey == our_node_id {
 794                                         path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 795                                         continue 'path_check;
 796                                 }
 797                         }
 798                         total_value += path.last().unwrap().fee_msat;
 799                         path_errs.push(Ok(()));
 800                 }
 801                 if path_errs.iter().any(|e| e.is_err()) {
 802                         return Err(PaymentSendFailure::PathParameterError(path_errs));
 803                 }
 804                 if let Some(amt_msat) = recv_value_msat {
 805                         debug_assert!(amt_msat >= total_value);
 806                         total_value = amt_msat;
 807                 }
 808
 809                 let cur_height = best_block_height + 1;
 810                 let mut results = Vec::new();
 811                 debug_assert_eq!(route.paths.len(), onion_session_privs.len());
 812                 for (path, session_priv) in route.paths.iter().zip(onion_session_privs.into_iter()) {
 813                         let mut path_res = send_payment_along_path(&path, &route.payment_params, &payment_hash, payment_secret, total_value, cur_height, payment_id, &keysend_preimage, session_priv);
 814                         match path_res {
 815                                 Ok(_) => {},
 816                                 Err(APIError::MonitorUpdateInProgress) => {
 817                                         // While a MonitorUpdateInProgress is an Err(_), the payment is still
 818                                         // considered "in flight" and we shouldn't remove it from the
 819                                         // PendingOutboundPayment set.
 820                                 },
 821                                 Err(_) => {
 822                                         let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
 823                                         if let Some(payment) = pending_outbounds.get_mut(&payment_id) {
 824                                                 let removed = payment.remove(&session_priv, Some(path));
 825                                                 debug_assert!(removed, "This can't happen as the payment has an entry for this path added by callers");
 826                                         } else {
 827                                                 debug_assert!(false, "This can't happen as the payment was added by callers");
 828                                                 path_res = Err(APIError::APIMisuseError { err: "Internal error: payment disappeared during processing. Please report this bug!".to_owned() });
 829                                         }
 830                                 }
 831                         }
 832                         results.push(path_res);
 833                 }
 834                 let mut has_ok = false;
 835                 let mut has_err = false;
 836                 let mut pending_amt_unsent = 0;
 837                 let mut max_unsent_cltv_delta = 0;
 838                 for (res, path) in results.iter().zip(route.paths.iter()) {
 839                         if res.is_ok() { has_ok = true; }
 840                         if res.is_err() { has_err = true; }
 841                         if let &Err(APIError::MonitorUpdateInProgress) = res {
 842                                 // MonitorUpdateInProgress is inherently unsafe to retry, so we call it a
 843                                 // PartialFailure.
 844                                 has_err = true;
 845                                 has_ok = true;
 846                         } else if res.is_err() {
 847                                 pending_amt_unsent += path.last().unwrap().fee_msat;
 848                                 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
 849                         }
 850                 }
 851                 if has_err && has_ok {
 852                         Err(PaymentSendFailure::PartialFailure {
 853                                 results,
 854                                 payment_id,
 855                                 failed_paths_retry: if pending_amt_unsent != 0 {
 856                                         if let Some(payment_params) = &route.payment_params {
 857                                                 Some(RouteParameters {
 858                                                         payment_params: payment_params.clone(),
 859                                                         final_value_msat: pending_amt_unsent,
 860                                                         final_cltv_expiry_delta:
 861                                                                 if let Some(delta) = payment_params.final_cltv_expiry_delta { delta }
 862                                                                 else { max_unsent_cltv_delta },
 863                                                 })
 864                                         } else { None }
 865                                 } else { None },
 866                         })
 867                 } else if has_err {
 868                         Err(PaymentSendFailure::AllFailedResendSafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
 869                 } else {
 870                         Ok(())
 871                 }
 872         }
 873
 874         #[cfg(test)]
 875         pub(super) fn test_send_payment_internal<NS: Deref, F>(
 876                 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
 877                 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
 878                 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
 879                 send_payment_along_path: F
 880         ) -> Result<(), PaymentSendFailure>
 881         where
 882                 NS::Target: NodeSigner,
 883                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 884                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 885         {
 886                 self.pay_route_internal(route, payment_hash, payment_secret, keysend_preimage, payment_id,
 887                         recv_value_msat, onion_session_privs, node_signer, best_block_height,
 888                         &send_payment_along_path)
 889                         .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
 890         }
 891
 892         // If we failed to send any paths, remove the new PaymentId from the `pending_outbound_payments`
 893         // map as the payment is free to be resent.
 894         fn remove_outbound_if_all_failed(&self, payment_id: PaymentId, err: &PaymentSendFailure) {
 895                 if let &PaymentSendFailure::AllFailedResendSafe(_) = err {
 896                         let removed = self.pending_outbound_payments.lock().unwrap().remove(&payment_id).is_some();
 897                         debug_assert!(removed, "We should always have a pending payment to remove here");
 898                 }
 899         }
 900
 901         pub(super) fn claim_htlc<L: Deref>(
 902                 &self, payment_id: PaymentId, payment_preimage: PaymentPreimage, session_priv: SecretKey,
 903                 path: Vec<RouteHop>, from_onchain: bool, pending_events: &Mutex<Vec<events::Event>>, logger: &L
 904         ) where L::Target: Logger {
 905                 let mut session_priv_bytes = [0; 32];
 906                 session_priv_bytes.copy_from_slice(&session_priv[..]);
 907                 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 908                 let mut pending_events = pending_events.lock().unwrap();
 909                 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
 910                         if !payment.get().is_fulfilled() {
 911                                 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
 912                                 let fee_paid_msat = payment.get().get_pending_fee_msat();
 913                                 pending_events.push(
 914                                         events::Event::PaymentSent {
 915                                                 payment_id: Some(payment_id),
 916                                                 payment_preimage,
 917                                                 payment_hash,
 918                                                 fee_paid_msat,
 919                                         }
 920                                 );
 921                                 payment.get_mut().mark_fulfilled();
 922                         }
 923
 924                         if from_onchain {
 925                                 // We currently immediately remove HTLCs which were fulfilled on-chain.
 926                                 // This could potentially lead to removing a pending payment too early,
 927                                 // with a reorg of one block causing us to re-add the fulfilled payment on
 928                                 // restart.
 929                                 // TODO: We should have a second monitor event that informs us of payments
 930                                 // irrevocably fulfilled.
 931                                 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
 932                                         let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
 933                                         pending_events.push(
 934                                                 events::Event::PaymentPathSuccessful {
 935                                                         payment_id,
 936                                                         payment_hash,
 937                                                         path,
 938                                                 }
 939                                         );
 940                                 }
 941                         }
 942                 } else {
 943                         log_trace!(logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
 944                 }
 945         }
 946
 947         pub(super) fn finalize_claims(&self, sources: Vec<HTLCSource>, pending_events: &Mutex<Vec<events::Event>>) {
 948                 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 949                 let mut pending_events = pending_events.lock().unwrap();
 950                 for source in sources {
 951                         if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
 952                                 let mut session_priv_bytes = [0; 32];
 953                                 session_priv_bytes.copy_from_slice(&session_priv[..]);
 954                                 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
 955                                         assert!(payment.get().is_fulfilled());
 956                                         if payment.get_mut().remove(&session_priv_bytes, None) {
 957                                                 pending_events.push(
 958                                                         events::Event::PaymentPathSuccessful {
 959                                                                 payment_id,
 960                                                                 payment_hash: payment.get().payment_hash(),
 961                                                                 path,
 962                                                         }
 963                                                 );
 964                                         }
 965                                 }
 966                         }
 967                 }
 968         }
 969
 970         pub(super) fn remove_stale_resolved_payments(&self, pending_events: &Mutex<Vec<events::Event>>) {
 971                 // If an outbound payment was completed, and no pending HTLCs remain, we should remove it
 972                 // from the map. However, if we did that immediately when the last payment HTLC is claimed,
 973                 // this could race the user making a duplicate send_payment call and our idempotency
 974                 // guarantees would be violated. Instead, we wait a few timer ticks to do the actual
 975                 // removal. This should be more than sufficient to ensure the idempotency of any
 976                 // `send_payment` calls that were made at the same time the `PaymentSent` event was being
 977                 // processed.
 978                 let mut pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
 979                 let pending_events = pending_events.lock().unwrap();
 980                 pending_outbound_payments.retain(|payment_id, payment| {
 981                         if let PendingOutboundPayment::Fulfilled { session_privs, timer_ticks_without_htlcs, .. } = payment {
 982                                 let mut no_remaining_entries = session_privs.is_empty();
 983                                 if no_remaining_entries {
 984                                         for ev in pending_events.iter() {
 985                                                 match ev {
 986                                                         events::Event::PaymentSent { payment_id: Some(ev_payment_id), .. } |
 987                                                                 events::Event::PaymentPathSuccessful { payment_id: ev_payment_id, .. } |
 988                                                                 events::Event::PaymentPathFailed { payment_id: Some(ev_payment_id), .. } => {
 989                                                                         if payment_id == ev_payment_id {
 990                                                                                 no_remaining_entries = false;
 991                                                                                 break;
 992                                                                         }
 993                                                                 },
 994                                                         _ => {},
 995                                                 }
 996                                         }
 997                                 }
 998                                 if no_remaining_entries {
 999                                         *timer_ticks_without_htlcs += 1;
1000                                         *timer_ticks_without_htlcs <= IDEMPOTENCY_TIMEOUT_TICKS
1001                                 } else {
1002                                         *timer_ticks_without_htlcs = 0;
1003                                         true
1004                                 }
1005                         } else { true }
1006                 });
1007         }
1008
1009         pub(super) fn fail_htlc<L: Deref>(
1010                 &self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason,
1011                 path: &Vec<RouteHop>, session_priv: &SecretKey, payment_id: &PaymentId,
1012                 payment_params: &Option<PaymentParameters>, probing_cookie_secret: [u8; 32],
1013                 secp_ctx: &Secp256k1<secp256k1::All>, pending_events: &Mutex<Vec<events::Event>>, logger: &L
1014         ) where L::Target: Logger {
1015                 #[cfg(test)]
1016                 let (network_update, short_channel_id, payment_retryable, onion_error_code, onion_error_data) = onion_error.decode_onion_failure(secp_ctx, logger, &source);
1017                 #[cfg(not(test))]
1018                 let (network_update, short_channel_id, payment_retryable, _, _) = onion_error.decode_onion_failure(secp_ctx, logger, &source);
1019
1020                 let payment_is_probe = payment_is_probe(payment_hash, &payment_id, probing_cookie_secret);
1021                 let mut session_priv_bytes = [0; 32];
1022                 session_priv_bytes.copy_from_slice(&session_priv[..]);
1023                 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1024                 let mut all_paths_failed = false;
1025                 let mut full_failure_ev = None;
1026                 let mut pending_retry_ev = None;
1027                 let mut retry = None;
1028                 let attempts_remaining = if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(*payment_id) {
1029                         if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
1030                                 log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1031                                 return
1032                         }
1033                         if payment.get().is_fulfilled() {
1034                                 log_trace!(logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
1035                                 return
1036                         }
1037                         let mut is_retryable_now = payment.get().is_auto_retryable_now();
1038                         if let Some(scid) = short_channel_id {
1039                                 payment.get_mut().insert_previously_failed_scid(scid);
1040                         }
1041
1042                         // We want to move towards only using the `PaymentParameters` in the outbound payments
1043                         // map. However, for backwards-compatibility, we still need to support passing the
1044                         // `PaymentParameters` data that was shoved in the HTLC (and given to us via
1045                         // `payment_params`) back to the user.
1046                         let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
1047                         if let Some(params) = payment.get_mut().payment_parameters() {
1048                                 if params.final_cltv_expiry_delta.is_none() {
1049                                         // This should be rare, but a user could provide None for the payment data, and
1050                                         // we need it when we go to retry the payment, so fill it in.
1051                                         params.final_cltv_expiry_delta = Some(path_last_hop.cltv_expiry_delta);
1052                                 }
1053                                 retry = Some(RouteParameters {
1054                                         payment_params: params.clone(),
1055                                         final_value_msat: path_last_hop.fee_msat,
1056                                         final_cltv_expiry_delta: params.final_cltv_expiry_delta.unwrap(),
1057                                 });
1058                         } else if let Some(params) = payment_params {
1059                                 retry = Some(RouteParameters {
1060                                         payment_params: params.clone(),
1061                                         final_value_msat: path_last_hop.fee_msat,
1062                                         final_cltv_expiry_delta:
1063                                                 if let Some(delta) = params.final_cltv_expiry_delta { delta }
1064                                                 else { path_last_hop.cltv_expiry_delta },
1065                                 });
1066                         }
1067
1068                         if payment_is_probe || !is_retryable_now || !payment_retryable || retry.is_none() {
1069                                 let _ = payment.get_mut().mark_abandoned(); // we'll only Err if it's a legacy payment
1070                                 is_retryable_now = false;
1071                         }
1072                         if payment.get().remaining_parts() == 0 {
1073                                 all_paths_failed = true;
1074                                 if payment.get().abandoned() {
1075                                         if !payment_is_probe {
1076                                                 full_failure_ev = Some(events::Event::PaymentFailed {
1077                                                         payment_id: *payment_id,
1078                                                         payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
1079                                                 });
1080                                         }
1081                                         payment.remove();
1082                                 }
1083                         }
1084                         is_retryable_now
1085                 } else {
1086                         log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1087                         return
1088                 };
1089                 core::mem::drop(outbounds);
1090                 log_trace!(logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1091
1092                 let path_failure = {
1093                         if payment_is_probe {
1094                                 if !payment_retryable {
1095                                         events::Event::ProbeSuccessful {
1096                                                 payment_id: *payment_id,
1097                                                 payment_hash: payment_hash.clone(),
1098                                                 path: path.clone(),
1099                                         }
1100                                 } else {
1101                                         events::Event::ProbeFailed {
1102                                                 payment_id: *payment_id,
1103                                                 payment_hash: payment_hash.clone(),
1104                                                 path: path.clone(),
1105                                                 short_channel_id,
1106                                         }
1107                                 }
1108                         } else {
1109                                 // TODO: If we decided to blame ourselves (or one of our channels) in
1110                                 // process_onion_failure we should close that channel as it implies our
1111                                 // next-hop is needlessly blaming us!
1112                                 if let Some(scid) = short_channel_id {
1113                                         retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
1114                                 }
1115                                 // If we miss abandoning the payment above, we *must* generate an event here or else the
1116                                 // payment will sit in our outbounds forever.
1117                                 if attempts_remaining {
1118                                         debug_assert!(full_failure_ev.is_none());
1119                                         pending_retry_ev = Some(events::Event::PendingHTLCsForwardable {
1120                                                 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
1121                                         });
1122                                 }
1123                                 events::Event::PaymentPathFailed {
1124                                         payment_id: Some(*payment_id),
1125                                         payment_hash: payment_hash.clone(),
1126                                         payment_failed_permanently: !payment_retryable,
1127                                         network_update,
1128                                         all_paths_failed,
1129                                         path: path.clone(),
1130                                         short_channel_id,
1131                                         retry,
1132                                         #[cfg(test)]
1133                                         error_code: onion_error_code,
1134                                         #[cfg(test)]
1135                                         error_data: onion_error_data
1136                                 }
1137                         }
1138                 };
1139                 let mut pending_events = pending_events.lock().unwrap();
1140                 pending_events.push(path_failure);
1141                 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
1142                 if let Some(ev) = pending_retry_ev { pending_events.push(ev); }
1143         }
1144
1145         pub(super) fn abandon_payment(
1146                 &self, payment_id: PaymentId, pending_events: &Mutex<Vec<events::Event>>
1147         ) {
1148                 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1149                 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
1150                         if let Ok(()) = payment.get_mut().mark_abandoned() {
1151                                 if payment.get().remaining_parts() == 0 {
1152                                         pending_events.lock().unwrap().push(events::Event::PaymentFailed {
1153                                                 payment_id,
1154                                                 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
1155                                         });
1156                                         payment.remove();
1157                                 }
1158                         }
1159                 }
1160         }
1161
1162         #[cfg(test)]
1163         pub fn has_pending_payments(&self) -> bool {
1164                 !self.pending_outbound_payments.lock().unwrap().is_empty()
1165         }
1166
1167         #[cfg(test)]
1168         pub fn clear_pending_payments(&self) {
1169                 self.pending_outbound_payments.lock().unwrap().clear()
1170         }
1171 }
1172
1173 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
1174 /// payment probe.
1175 pub(super) fn payment_is_probe(payment_hash: &PaymentHash, payment_id: &PaymentId,
1176         probing_cookie_secret: [u8; 32]) -> bool
1177 {
1178         let target_payment_hash = probing_cookie_from_id(payment_id, probing_cookie_secret);
1179         target_payment_hash == *payment_hash
1180 }
1181
1182 /// Returns the 'probing cookie' for the given [`PaymentId`].
1183 fn probing_cookie_from_id(payment_id: &PaymentId, probing_cookie_secret: [u8; 32]) -> PaymentHash {
1184         let mut preimage = [0u8; 64];
1185         preimage[..32].copy_from_slice(&probing_cookie_secret);
1186         preimage[32..].copy_from_slice(&payment_id.0);
1187         PaymentHash(Sha256::hash(&preimage).into_inner())
1188 }
1189
1190 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
1191         (0, Legacy) => {
1192                 (0, session_privs, required),
1193         },
1194         (1, Fulfilled) => {
1195                 (0, session_privs, required),
1196                 (1, payment_hash, option),
1197                 (3, timer_ticks_without_htlcs, (default_value, 0)),
1198         },
1199         (2, Retryable) => {
1200                 (0, session_privs, required),
1201                 (1, pending_fee_msat, option),
1202                 (2, payment_hash, required),
1203                 (3, payment_params, option),
1204                 (4, payment_secret, option),
1205                 (5, keysend_preimage, option),
1206                 (6, total_msat, required),
1207                 (8, pending_amt_msat, required),
1208                 (10, starting_block_height, required),
1209                 (not_written, retry_strategy, (static_value, None)),
1210                 (not_written, attempts, (static_value, PaymentAttempts::new())),
1211         },
1212         (3, Abandoned) => {
1213                 (0, session_privs, required),
1214                 (2, payment_hash, required),
1215         },
1216 );
1217
1218 #[cfg(test)]
1219 mod tests {
1220         use bitcoin::blockdata::constants::genesis_block;
1221         use bitcoin::network::constants::Network;
1222         use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
1223
1224         use crate::ln::PaymentHash;
1225         use crate::ln::channelmanager::{PaymentId, PaymentSendFailure};
1226         use crate::ln::msgs::{ErrorAction, LightningError};
1227         use crate::ln::outbound_payment::{OutboundPayments, Retry};
1228         use crate::routing::gossip::NetworkGraph;
1229         use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteParameters};
1230         use crate::sync::{Arc, Mutex};
1231         use crate::util::errors::APIError;
1232         use crate::util::test_utils;
1233
1234         #[test]
1235         #[cfg(feature = "std")]
1236         fn fails_paying_after_expiration() {
1237                 do_fails_paying_after_expiration(false);
1238                 do_fails_paying_after_expiration(true);
1239         }
1240         #[cfg(feature = "std")]
1241         fn do_fails_paying_after_expiration(on_retry: bool) {
1242                 let outbound_payments = OutboundPayments::new();
1243                 let logger = test_utils::TestLogger::new();
1244                 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
1245                 let network_graph = Arc::new(NetworkGraph::new(genesis_hash, &logger));
1246                 let scorer = Mutex::new(test_utils::TestScorer::new());
1247                 let router = test_utils::TestRouter::new(network_graph, &scorer);
1248                 let secp_ctx = Secp256k1::new();
1249                 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1250
1251                 let past_expiry_time = std::time::SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() - 2;
1252                 let payment_params = PaymentParameters::from_node_id(
1253                                 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()),
1254                                 0
1255                         ).with_expiry_time(past_expiry_time);
1256                 let expired_route_params = RouteParameters {
1257                         payment_params,
1258                         final_value_msat: 0,
1259                         final_cltv_expiry_delta: 0,
1260                 };
1261                 let err = if on_retry {
1262                         outbound_payments.pay_internal(
1263                                 PaymentId([0; 32]), None, expired_route_params, &&router, vec![], &|| InFlightHtlcs::new(),
1264                                 &&keys_manager, &&keys_manager, 0, &&logger, &|_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err()
1265                 } else {
1266                         outbound_payments.send_payment(
1267                                 PaymentHash([0; 32]), &None, PaymentId([0; 32]), Retry::Attempts(0), expired_route_params,
1268                                 &&router, vec![], || InFlightHtlcs::new(), &&keys_manager, &&keys_manager, 0, &&logger,
1269                                 |_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err()
1270                 };
1271                 if let PaymentSendFailure::ParameterError(APIError::APIMisuseError { err }) = err {
1272                         assert!(err.contains("Invoice expired"));
1273                 } else { panic!("Unexpected error"); }
1274         }
1275
1276         #[test]
1277         fn find_route_error() {
1278                 do_find_route_error(false);
1279                 do_find_route_error(true);
1280         }
1281         fn do_find_route_error(on_retry: bool) {
1282                 let outbound_payments = OutboundPayments::new();
1283                 let logger = test_utils::TestLogger::new();
1284                 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
1285                 let network_graph = Arc::new(NetworkGraph::new(genesis_hash, &logger));
1286                 let scorer = Mutex::new(test_utils::TestScorer::new());
1287                 let router = test_utils::TestRouter::new(network_graph, &scorer);
1288                 let secp_ctx = Secp256k1::new();
1289                 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1290
1291                 let payment_params = PaymentParameters::from_node_id(
1292                         PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()), 0);
1293                 let route_params = RouteParameters {
1294                         payment_params,
1295                         final_value_msat: 0,
1296                         final_cltv_expiry_delta: 0,
1297                 };
1298                 router.expect_find_route(route_params.clone(),
1299                         Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
1300
1301                 let err = if on_retry {
1302                         outbound_payments.add_new_pending_payment(PaymentHash([0; 32]), None, PaymentId([0; 32]), None,
1303                                 &Route { paths: vec![], payment_params: None }, Some(Retry::Attempts(1)),
1304                                 Some(route_params.payment_params.clone()), &&keys_manager, 0).unwrap();
1305                         outbound_payments.pay_internal(
1306                                 PaymentId([0; 32]), None, route_params, &&router, vec![], &|| InFlightHtlcs::new(),
1307                                 &&keys_manager, &&keys_manager, 0, &&logger, &|_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err()
1308                 } else {
1309                         outbound_payments.send_payment(
1310                                 PaymentHash([0; 32]), &None, PaymentId([0; 32]), Retry::Attempts(0), route_params,
1311                                 &&router, vec![], || InFlightHtlcs::new(), &&keys_manager, &&keys_manager, 0, &&logger,
1312                                 |_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err()
1313                 };
1314                 if let PaymentSendFailure::ParameterError(APIError::APIMisuseError { err }) = err {
1315                         assert!(err.contains("Failed to find a route"));
1316                 } else { panic!("Unexpected error"); }
1317         }
1318 }