_ 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, you do not need to call
 327         /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
 328         /// for this payment.
 329         ///
 330         /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 331         /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
 332         ParameterError(APIError),
 333         /// A parameter in a single path which was passed to send_payment was invalid, preventing us
 334         /// from attempting to send the payment at all.
 335         ///
 336         /// You can freely resend the payment in full (with the parameter error fixed).
 337         ///
 338         /// The results here are ordered the same as the paths in the route object which was passed to
 339         /// send_payment.
 340         ///
 341         /// Because the payment failed outright, no payment tracking is done, you do not need to call
 342         /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
 343         /// for this payment.
 344         ///
 345         /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 346         /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
 347         PathParameterError(Vec<Result<(), APIError>>),
 348         /// All paths which were attempted failed to send, with no channel state change taking place.
 349         /// You can freely resend the payment in full (though you probably want to do so over different
 350         /// paths than the ones selected).
 351         ///
 352         /// Because the payment failed outright, no payment tracking is done, you do not need to call
 353         /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
 354         /// for this payment.
 355         ///
 356         /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 357         /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
 358         AllFailedResendSafe(Vec<APIError>),
 359         /// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
 360         /// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
 361         /// [`ChannelManager::abandon_payment`]).
 362         ///
 363         /// [`PaymentId`]: crate::ln::channelmanager::PaymentId
 364         /// [`Event::PaymentSent`]: crate::util::events::Event::PaymentSent
 365         /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 366         DuplicatePayment,
 367         /// Some paths which were attempted failed to send, though possibly not all. At least some
 368         /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
 369         /// in over-/re-payment.
 370         ///
 371         /// The results here are ordered the same as the paths in the route object which was passed to
 372         /// send_payment, and any `Err`s which are not [`APIError::MonitorUpdateInProgress`] can be
 373         /// safely retried via [`ChannelManager::retry_payment`].
 374         ///
 375         /// Any entries which contain `Err(APIError::MonitorUpdateInprogress)` or `Ok(())` MUST NOT be
 376         /// retried as they will result in over-/re-payment. These HTLCs all either successfully sent
 377         /// (in the case of `Ok(())`) or will send once a [`MonitorEvent::Completed`] is provided for
 378         /// the next-hop channel with the latest update_id.
 379         ///
 380         /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
 381         /// [`MonitorEvent::Completed`]: crate::chain::channelmonitor::MonitorEvent::Completed
 382         PartialFailure {
 383                 /// The errors themselves, in the same order as the route hops.
 384                 results: Vec<Result<(), APIError>>,
 385                 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
 386                 /// contain a [`RouteParameters`] object which can be used to calculate a new route that
 387                 /// will pay all remaining unpaid balance.
 388                 failed_paths_retry: Option<RouteParameters>,
 389                 /// The payment id for the payment, which is now at least partially pending.
 390                 payment_id: PaymentId,
 391         },
 392 }
 393
 394 pub(super) struct OutboundPayments {
 395         pub(super) pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
 396 }
 397
 398 impl OutboundPayments {
 399         pub(super) fn new() -> Self {
 400                 Self {
 401                         pending_outbound_payments: Mutex::new(HashMap::new())
 402                 }
 403         }
 404
 405         pub(super) fn send_payment<R: Deref, ES: Deref, NS: Deref, IH, SP, L: Deref>(
 406                 &self, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId,
 407                 retry_strategy: Retry, route_params: RouteParameters, router: &R,
 408                 first_hops: Vec<ChannelDetails>, compute_inflight_htlcs: IH, entropy_source: &ES,
 409                 node_signer: &NS, best_block_height: u32, logger: &L, send_payment_along_path: SP,
 410         ) -> Result<(), PaymentSendFailure>
 411         where
 412                 R::Target: Router,
 413                 ES::Target: EntropySource,
 414                 NS::Target: NodeSigner,
 415                 L::Target: Logger,
 416                 IH: Fn() -> InFlightHtlcs,
 417                 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 418                          u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>,
 419         {
 420                 self.pay_internal(payment_id, Some((payment_hash, payment_secret, None, retry_strategy)),
 421                         route_params, router, first_hops, &compute_inflight_htlcs, entropy_source, node_signer,
 422                         best_block_height, logger, &send_payment_along_path)
 423                         .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
 424         }
 425
 426         pub(super) fn send_payment_with_route<ES: Deref, NS: Deref, F>(
 427                 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
 428                 payment_id: PaymentId, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
 429                 send_payment_along_path: F
 430         ) -> Result<(), PaymentSendFailure>
 431         where
 432                 ES::Target: EntropySource,
 433                 NS::Target: NodeSigner,
 434                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 435                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 436         {
 437                 let onion_session_privs = self.add_new_pending_payment(payment_hash, *payment_secret, payment_id, None, route, None, None, entropy_source, best_block_height)?;
 438                 self.pay_route_internal(route, payment_hash, payment_secret, None, payment_id, None,
 439                         onion_session_privs, node_signer, best_block_height, &send_payment_along_path)
 440                         .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
 441         }
 442
 443         pub(super) fn send_spontaneous_payment<R: Deref, ES: Deref, NS: Deref, IH, SP, L: Deref>(
 444                 &self, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId,
 445                 retry_strategy: Retry, route_params: RouteParameters, router: &R,
 446                 first_hops: Vec<ChannelDetails>, inflight_htlcs: IH, entropy_source: &ES,
 447                 node_signer: &NS, best_block_height: u32, logger: &L, send_payment_along_path: SP
 448         ) -> Result<PaymentHash, PaymentSendFailure>
 449         where
 450                 R::Target: Router,
 451                 ES::Target: EntropySource,
 452                 NS::Target: NodeSigner,
 453                 L::Target: Logger,
 454                 IH: Fn() -> InFlightHtlcs,
 455                 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 456                          u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>,
 457         {
 458                 let preimage = payment_preimage
 459                         .unwrap_or_else(|| PaymentPreimage(entropy_source.get_secure_random_bytes()));
 460                 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
 461                 self.pay_internal(payment_id, Some((payment_hash, &None, Some(preimage), retry_strategy)),
 462                         route_params, router, first_hops, &inflight_htlcs, entropy_source, node_signer,
 463                         best_block_height, logger, &send_payment_along_path)
 464                         .map(|()| payment_hash)
 465                         .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
 466         }
 467
 468         pub(super) fn send_spontaneous_payment_with_route<ES: Deref, NS: Deref, F>(
 469                 &self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId,
 470                 entropy_source: &ES, node_signer: &NS, best_block_height: u32, send_payment_along_path: F
 471         ) -> Result<PaymentHash, PaymentSendFailure>
 472         where
 473                 ES::Target: EntropySource,
 474                 NS::Target: NodeSigner,
 475                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 476                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 477         {
 478                 let preimage = payment_preimage
 479                         .unwrap_or_else(|| PaymentPreimage(entropy_source.get_secure_random_bytes()));
 480                 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
 481                 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, Some(preimage), &route, None, None, entropy_source, best_block_height)?;
 482
 483                 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) {
 484                         Ok(()) => Ok(payment_hash),
 485                         Err(e) => {
 486                                 self.remove_outbound_if_all_failed(payment_id, &e);
 487                                 Err(e)
 488                         }
 489                 }
 490         }
 491
 492         pub(super) fn check_retry_payments<R: Deref, ES: Deref, NS: Deref, SP, IH, FH, L: Deref>(
 493                 &self, router: &R, first_hops: FH, inflight_htlcs: IH, entropy_source: &ES, node_signer: &NS,
 494                 best_block_height: u32, pending_events: &Mutex<Vec<events::Event>>, logger: &L,
 495                 send_payment_along_path: SP,
 496         )
 497         where
 498                 R::Target: Router,
 499                 ES::Target: EntropySource,
 500                 NS::Target: NodeSigner,
 501                 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 502                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>,
 503                 IH: Fn() -> InFlightHtlcs,
 504                 FH: Fn() -> Vec<ChannelDetails>,
 505                 L::Target: Logger,
 506         {
 507                 loop {
 508                         let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 509                         let mut retry_id_route_params = None;
 510                         for (pmt_id, pmt) in outbounds.iter_mut() {
 511                                 if pmt.is_auto_retryable_now() {
 512                                         if let PendingOutboundPayment::Retryable { pending_amt_msat, total_msat, payment_params: Some(params), .. } = pmt {
 513                                                 if pending_amt_msat < total_msat {
 514                                                         retry_id_route_params = Some((*pmt_id, RouteParameters {
 515                                                                 final_value_msat: *total_msat - *pending_amt_msat,
 516                                                                 final_cltv_expiry_delta:
 517                                                                         if let Some(delta) = params.final_cltv_expiry_delta { delta }
 518                                                                         else {
 519                                                                                 debug_assert!(false, "We always set the final_cltv_expiry_delta when a path fails");
 520                                                                                 LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA.into()
 521                                                                         },
 522                                                                 payment_params: params.clone(),
 523                                                         }));
 524                                                         break
 525                                                 }
 526                                         }
 527                                 }
 528                         }
 529                         core::mem::drop(outbounds);
 530                         if let Some((payment_id, route_params)) = retry_id_route_params {
 531                                 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) {
 532                                         log_info!(logger, "Errored retrying payment: {:?}", e);
 533                                         // If we error on retry, there is no chance of the payment succeeding and no HTLCs have
 534                                         // been irrevocably committed to, so we can safely abandon.
 535                                         self.abandon_payment(payment_id, pending_events);
 536                                 }
 537                         } else { break }
 538                 }
 539         }
 540
 541         /// Will return `Ok(())` iff at least one HTLC is sent for the payment.
 542         fn pay_internal<R: Deref, NS: Deref, ES: Deref, IH, SP, L: Deref>(
 543                 &self, payment_id: PaymentId,
 544                 initial_send_info: Option<(PaymentHash, &Option<PaymentSecret>, Option<PaymentPreimage>, Retry)>,
 545                 route_params: RouteParameters, router: &R, first_hops: Vec<ChannelDetails>,
 546                 inflight_htlcs: &IH, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
 547                 logger: &L, send_payment_along_path: &SP,
 548         ) -> Result<(), PaymentSendFailure>
 549         where
 550                 R::Target: Router,
 551                 ES::Target: EntropySource,
 552                 NS::Target: NodeSigner,
 553                 L::Target: Logger,
 554                 IH: Fn() -> InFlightHtlcs,
 555                 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 556                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 557         {
 558                 #[cfg(feature = "std")] {
 559                         if has_expired(&route_params) {
 560                                 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 561                                         err: format!("Invoice expired for payment id {}", log_bytes!(payment_id.0)),
 562                                 }))
 563                         }
 564                 }
 565
 566                 let route = router.find_route(
 567                         &node_signer.get_node_id(Recipient::Node).unwrap(), &route_params,
 568                         Some(&first_hops.iter().collect::<Vec<_>>()), &inflight_htlcs(),
 569                 ).map_err(|e| PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 570                         err: format!("Failed to find a route for payment {}: {:?}", log_bytes!(payment_id.0), e), // TODO: add APIError::RouteNotFound
 571                 }))?;
 572
 573                 let res = if let Some((payment_hash, payment_secret, keysend_preimage, retry_strategy)) = initial_send_info {
 574                         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)?;
 575                         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)
 576                 } else {
 577                         self.retry_payment_with_route(&route, payment_id, entropy_source, node_signer, best_block_height, send_payment_along_path)
 578                 };
 579                 match res {
 580                         Err(PaymentSendFailure::AllFailedResendSafe(_)) => {
 581                                 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);
 582                                 log_info!(logger, "Result retrying payment id {}: {:?}", log_bytes!(payment_id.0), retry_res);
 583                                 if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = &retry_res {
 584                                         if err.starts_with("Retries exhausted ") { return res; }
 585                                 }
 586                                 retry_res
 587                         },
 588                         Err(PaymentSendFailure::PartialFailure { failed_paths_retry: Some(retry), .. }) => {
 589                                 // Some paths were sent, even if we failed to send the full MPP value our recipient may
 590                                 // misbehave and claim the funds, at which point we have to consider the payment sent, so
 591                                 // return `Ok()` here, ignoring any retry errors.
 592                                 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);
 593                                 log_info!(logger, "Result retrying payment id {}: {:?}", log_bytes!(payment_id.0), retry_res);
 594                                 Ok(())
 595                         },
 596                         Err(PaymentSendFailure::PartialFailure { failed_paths_retry: None, .. }) => {
 597                                 // This may happen if we send a payment and some paths fail, but only due to a temporary
 598                                 // monitor failure or the like, implying they're really in-flight, but we haven't sent the
 599                                 // initial HTLC-Add messages yet.
 600                                 Ok(())
 601                         },
 602                         res => res,
 603                 }
 604         }
 605
 606         pub(super) fn retry_payment_with_route<ES: Deref, NS: Deref, F>(
 607                 &self, route: &Route, payment_id: PaymentId, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
 608                 send_payment_along_path: F
 609         ) -> Result<(), PaymentSendFailure>
 610         where
 611                 ES::Target: EntropySource,
 612                 NS::Target: NodeSigner,
 613                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 614                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 615         {
 616                 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
 617                 for path in route.paths.iter() {
 618                         if path.len() == 0 {
 619                                 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 620                                         err: "length-0 path in route".to_string()
 621                                 }))
 622                         }
 623                 }
 624
 625                 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
 626                 for _ in 0..route.paths.len() {
 627                         onion_session_privs.push(entropy_source.get_secure_random_bytes());
 628                 }
 629
 630                 let (total_msat, payment_hash, payment_secret, keysend_preimage) = {
 631                         let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 632                         match outbounds.get_mut(&payment_id) {
 633                                 Some(payment) => {
 634                                         let res = match payment {
 635                                                 PendingOutboundPayment::Retryable {
 636                                                         total_msat, payment_hash, keysend_preimage, payment_secret, pending_amt_msat, ..
 637                                                 } => {
 638                                                         let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
 639                                                         if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
 640                                                                 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 641                                                                         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()
 642                                                                 }))
 643                                                         }
 644                                                         (*total_msat, *payment_hash, *payment_secret, *keysend_preimage)
 645                                                 },
 646                                                 PendingOutboundPayment::Legacy { .. } => {
 647                                                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 648                                                                 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
 649                                                         }))
 650                                                 },
 651                                                 PendingOutboundPayment::Fulfilled { .. } => {
 652                                                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 653                                                                 err: "Payment already completed".to_owned()
 654                                                         }));
 655                                                 },
 656                                                 PendingOutboundPayment::Abandoned { .. } => {
 657                                                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 658                                                                 err: "Payment already abandoned (with some HTLCs still pending)".to_owned()
 659                                                         }));
 660                                                 },
 661                                         };
 662                                         if !payment.is_retryable_now() {
 663                                                 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 664                                                         err: format!("Retries exhausted for payment id {}", log_bytes!(payment_id.0)),
 665                                                 }))
 666                                         }
 667                                         payment.increment_attempts();
 668                                         for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
 669                                                 assert!(payment.insert(*session_priv_bytes, path));
 670                                         }
 671                                         res
 672                                 },
 673                                 None =>
 674                                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 675                                                 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
 676                                         })),
 677                         }
 678                 };
 679                 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)
 680         }
 681
 682         pub(super) fn send_probe<ES: Deref, NS: Deref, F>(
 683                 &self, hops: Vec<RouteHop>, probing_cookie_secret: [u8; 32], entropy_source: &ES,
 684                 node_signer: &NS, best_block_height: u32, send_payment_along_path: F
 685         ) -> Result<(PaymentHash, PaymentId), PaymentSendFailure>
 686         where
 687                 ES::Target: EntropySource,
 688                 NS::Target: NodeSigner,
 689                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 690                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 691         {
 692                 let payment_id = PaymentId(entropy_source.get_secure_random_bytes());
 693
 694                 let payment_hash = probing_cookie_from_id(&payment_id, probing_cookie_secret);
 695
 696                 if hops.len() < 2 {
 697                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 698                                 err: "No need probing a path with less than two hops".to_string()
 699                         }))
 700                 }
 701
 702                 let route = Route { paths: vec![hops], payment_params: None };
 703                 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, None, &route, None, None, entropy_source, best_block_height)?;
 704
 705                 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) {
 706                         Ok(()) => Ok((payment_hash, payment_id)),
 707                         Err(e) => {
 708                                 self.remove_outbound_if_all_failed(payment_id, &e);
 709                                 Err(e)
 710                         }
 711                 }
 712         }
 713
 714         #[cfg(test)]
 715         pub(super) fn test_add_new_pending_payment<ES: Deref>(
 716                 &self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId,
 717                 route: &Route, retry_strategy: Option<Retry>, entropy_source: &ES, best_block_height: u32
 718         ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
 719                 self.add_new_pending_payment(payment_hash, payment_secret, payment_id, None, route, retry_strategy, None, entropy_source, best_block_height)
 720         }
 721
 722         pub(super) fn add_new_pending_payment<ES: Deref>(
 723                 &self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId,
 724                 keysend_preimage: Option<PaymentPreimage>, route: &Route, retry_strategy: Option<Retry>,
 725                 payment_params: Option<PaymentParameters>, entropy_source: &ES, best_block_height: u32
 726         ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
 727                 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
 728                 for _ in 0..route.paths.len() {
 729                         onion_session_privs.push(entropy_source.get_secure_random_bytes());
 730                 }
 731
 732                 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
 733                 match pending_outbounds.entry(payment_id) {
 734                         hash_map::Entry::Occupied(_) => Err(PaymentSendFailure::DuplicatePayment),
 735                         hash_map::Entry::Vacant(entry) => {
 736                                 let payment = entry.insert(PendingOutboundPayment::Retryable {
 737                                         retry_strategy,
 738                                         attempts: PaymentAttempts::new(),
 739                                         payment_params,
 740                                         session_privs: HashSet::new(),
 741                                         pending_amt_msat: 0,
 742                                         pending_fee_msat: Some(0),
 743                                         payment_hash,
 744                                         payment_secret,
 745                                         keysend_preimage,
 746                                         starting_block_height: best_block_height,
 747                                         total_msat: route.get_total_amount(),
 748                                 });
 749
 750                                 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
 751                                         assert!(payment.insert(*session_priv_bytes, path));
 752                                 }
 753
 754                                 Ok(onion_session_privs)
 755                         },
 756                 }
 757         }
 758
 759         fn pay_route_internal<NS: Deref, F>(
 760                 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
 761                 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
 762                 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
 763                 send_payment_along_path: &F
 764         ) -> Result<(), PaymentSendFailure>
 765         where
 766                 NS::Target: NodeSigner,
 767                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 768                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 769         {
 770                 if route.paths.len() < 1 {
 771                         return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
 772                 }
 773                 if payment_secret.is_none() && route.paths.len() > 1 {
 774                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
 775                 }
 776                 let mut total_value = 0;
 777                 let our_node_id = node_signer.get_node_id(Recipient::Node).unwrap(); // TODO no unwrap
 778                 let mut path_errs = Vec::with_capacity(route.paths.len());
 779                 'path_check: for path in route.paths.iter() {
 780                         if path.len() < 1 || path.len() > 20 {
 781                                 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
 782                                 continue 'path_check;
 783                         }
 784                         for (idx, hop) in path.iter().enumerate() {
 785                                 if idx != path.len() - 1 && hop.pubkey == our_node_id {
 786                                         path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 787                                         continue 'path_check;
 788                                 }
 789                         }
 790                         total_value += path.last().unwrap().fee_msat;
 791                         path_errs.push(Ok(()));
 792                 }
 793                 if path_errs.iter().any(|e| e.is_err()) {
 794                         return Err(PaymentSendFailure::PathParameterError(path_errs));
 795                 }
 796                 if let Some(amt_msat) = recv_value_msat {
 797                         debug_assert!(amt_msat >= total_value);
 798                         total_value = amt_msat;
 799                 }
 800
 801                 let cur_height = best_block_height + 1;
 802                 let mut results = Vec::new();
 803                 debug_assert_eq!(route.paths.len(), onion_session_privs.len());
 804                 for (path, session_priv) in route.paths.iter().zip(onion_session_privs.into_iter()) {
 805                         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);
 806                         match path_res {
 807                                 Ok(_) => {},
 808                                 Err(APIError::MonitorUpdateInProgress) => {
 809                                         // While a MonitorUpdateInProgress is an Err(_), the payment is still
 810                                         // considered "in flight" and we shouldn't remove it from the
 811                                         // PendingOutboundPayment set.
 812                                 },
 813                                 Err(_) => {
 814                                         let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
 815                                         if let Some(payment) = pending_outbounds.get_mut(&payment_id) {
 816                                                 let removed = payment.remove(&session_priv, Some(path));
 817                                                 debug_assert!(removed, "This can't happen as the payment has an entry for this path added by callers");
 818                                         } else {
 819                                                 debug_assert!(false, "This can't happen as the payment was added by callers");
 820                                                 path_res = Err(APIError::APIMisuseError { err: "Internal error: payment disappeared during processing. Please report this bug!".to_owned() });
 821                                         }
 822                                 }
 823                         }
 824                         results.push(path_res);
 825                 }
 826                 let mut has_ok = false;
 827                 let mut has_err = false;
 828                 let mut pending_amt_unsent = 0;
 829                 let mut max_unsent_cltv_delta = 0;
 830                 for (res, path) in results.iter().zip(route.paths.iter()) {
 831                         if res.is_ok() { has_ok = true; }
 832                         if res.is_err() { has_err = true; }
 833                         if let &Err(APIError::MonitorUpdateInProgress) = res {
 834                                 // MonitorUpdateInProgress is inherently unsafe to retry, so we call it a
 835                                 // PartialFailure.
 836                                 has_err = true;
 837                                 has_ok = true;
 838                         } else if res.is_err() {
 839                                 pending_amt_unsent += path.last().unwrap().fee_msat;
 840                                 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
 841                         }
 842                 }
 843                 if has_err && has_ok {
 844                         Err(PaymentSendFailure::PartialFailure {
 845                                 results,
 846                                 payment_id,
 847                                 failed_paths_retry: if pending_amt_unsent != 0 {
 848                                         if let Some(payment_params) = &route.payment_params {
 849                                                 Some(RouteParameters {
 850                                                         payment_params: payment_params.clone(),
 851                                                         final_value_msat: pending_amt_unsent,
 852                                                         final_cltv_expiry_delta:
 853                                                                 if let Some(delta) = payment_params.final_cltv_expiry_delta { delta }
 854                                                                 else { max_unsent_cltv_delta },
 855                                                 })
 856                                         } else { None }
 857                                 } else { None },
 858                         })
 859                 } else if has_err {
 860                         Err(PaymentSendFailure::AllFailedResendSafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
 861                 } else {
 862                         Ok(())
 863                 }
 864         }
 865
 866         #[cfg(test)]
 867         pub(super) fn test_send_payment_internal<NS: Deref, F>(
 868                 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
 869                 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
 870                 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
 871                 send_payment_along_path: F
 872         ) -> Result<(), PaymentSendFailure>
 873         where
 874                 NS::Target: NodeSigner,
 875                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 876                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 877         {
 878                 self.pay_route_internal(route, payment_hash, payment_secret, keysend_preimage, payment_id,
 879                         recv_value_msat, onion_session_privs, node_signer, best_block_height,
 880                         &send_payment_along_path)
 881                         .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
 882         }
 883
 884         // If we failed to send any paths, we should remove the new PaymentId from the
 885         // `pending_outbound_payments` map, as the user isn't expected to `abandon_payment`.
 886         fn remove_outbound_if_all_failed(&self, payment_id: PaymentId, err: &PaymentSendFailure) {
 887                 if let &PaymentSendFailure::AllFailedResendSafe(_) = err {
 888                         let removed = self.pending_outbound_payments.lock().unwrap().remove(&payment_id).is_some();
 889                         debug_assert!(removed, "We should always have a pending payment to remove here");
 890                 }
 891         }
 892
 893         pub(super) fn claim_htlc<L: Deref>(
 894                 &self, payment_id: PaymentId, payment_preimage: PaymentPreimage, session_priv: SecretKey,
 895                 path: Vec<RouteHop>, from_onchain: bool, pending_events: &Mutex<Vec<events::Event>>, logger: &L
 896         ) where L::Target: Logger {
 897                 let mut session_priv_bytes = [0; 32];
 898                 session_priv_bytes.copy_from_slice(&session_priv[..]);
 899                 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 900                 let mut pending_events = pending_events.lock().unwrap();
 901                 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
 902                         if !payment.get().is_fulfilled() {
 903                                 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
 904                                 let fee_paid_msat = payment.get().get_pending_fee_msat();
 905                                 pending_events.push(
 906                                         events::Event::PaymentSent {
 907                                                 payment_id: Some(payment_id),
 908                                                 payment_preimage,
 909                                                 payment_hash,
 910                                                 fee_paid_msat,
 911                                         }
 912                                 );
 913                                 payment.get_mut().mark_fulfilled();
 914                         }
 915
 916                         if from_onchain {
 917                                 // We currently immediately remove HTLCs which were fulfilled on-chain.
 918                                 // This could potentially lead to removing a pending payment too early,
 919                                 // with a reorg of one block causing us to re-add the fulfilled payment on
 920                                 // restart.
 921                                 // TODO: We should have a second monitor event that informs us of payments
 922                                 // irrevocably fulfilled.
 923                                 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
 924                                         let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
 925                                         pending_events.push(
 926                                                 events::Event::PaymentPathSuccessful {
 927                                                         payment_id,
 928                                                         payment_hash,
 929                                                         path,
 930                                                 }
 931                                         );
 932                                 }
 933                         }
 934                 } else {
 935                         log_trace!(logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
 936                 }
 937         }
 938
 939         pub(super) fn finalize_claims(&self, sources: Vec<HTLCSource>, pending_events: &Mutex<Vec<events::Event>>) {
 940                 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 941                 let mut pending_events = pending_events.lock().unwrap();
 942                 for source in sources {
 943                         if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
 944                                 let mut session_priv_bytes = [0; 32];
 945                                 session_priv_bytes.copy_from_slice(&session_priv[..]);
 946                                 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
 947                                         assert!(payment.get().is_fulfilled());
 948                                         if payment.get_mut().remove(&session_priv_bytes, None) {
 949                                                 pending_events.push(
 950                                                         events::Event::PaymentPathSuccessful {
 951                                                                 payment_id,
 952                                                                 payment_hash: payment.get().payment_hash(),
 953                                                                 path,
 954                                                         }
 955                                                 );
 956                                         }
 957                                 }
 958                         }
 959                 }
 960         }
 961
 962         pub(super) fn remove_stale_resolved_payments(&self, pending_events: &Mutex<Vec<events::Event>>) {
 963                 // If an outbound payment was completed, and no pending HTLCs remain, we should remove it
 964                 // from the map. However, if we did that immediately when the last payment HTLC is claimed,
 965                 // this could race the user making a duplicate send_payment call and our idempotency
 966                 // guarantees would be violated. Instead, we wait a few timer ticks to do the actual
 967                 // removal. This should be more than sufficient to ensure the idempotency of any
 968                 // `send_payment` calls that were made at the same time the `PaymentSent` event was being
 969                 // processed.
 970                 let mut pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
 971                 let pending_events = pending_events.lock().unwrap();
 972                 pending_outbound_payments.retain(|payment_id, payment| {
 973                         if let PendingOutboundPayment::Fulfilled { session_privs, timer_ticks_without_htlcs, .. } = payment {
 974                                 let mut no_remaining_entries = session_privs.is_empty();
 975                                 if no_remaining_entries {
 976                                         for ev in pending_events.iter() {
 977                                                 match ev {
 978                                                         events::Event::PaymentSent { payment_id: Some(ev_payment_id), .. } |
 979                                                                 events::Event::PaymentPathSuccessful { payment_id: ev_payment_id, .. } |
 980                                                                 events::Event::PaymentPathFailed { payment_id: Some(ev_payment_id), .. } => {
 981                                                                         if payment_id == ev_payment_id {
 982                                                                                 no_remaining_entries = false;
 983                                                                                 break;
 984                                                                         }
 985                                                                 },
 986                                                         _ => {},
 987                                                 }
 988                                         }
 989                                 }
 990                                 if no_remaining_entries {
 991                                         *timer_ticks_without_htlcs += 1;
 992                                         *timer_ticks_without_htlcs <= IDEMPOTENCY_TIMEOUT_TICKS
 993                                 } else {
 994                                         *timer_ticks_without_htlcs = 0;
 995                                         true
 996                                 }
 997                         } else { true }
 998                 });
 999         }
1000
1001         pub(super) fn fail_htlc<L: Deref>(
1002                 &self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason,
1003                 path: &Vec<RouteHop>, session_priv: &SecretKey, payment_id: &PaymentId,
1004                 payment_params: &Option<PaymentParameters>, probing_cookie_secret: [u8; 32],
1005                 secp_ctx: &Secp256k1<secp256k1::All>, pending_events: &Mutex<Vec<events::Event>>, logger: &L
1006         ) where L::Target: Logger {
1007                 #[cfg(test)]
1008                 let (network_update, short_channel_id, payment_retryable, onion_error_code, onion_error_data) = onion_error.decode_onion_failure(secp_ctx, logger, &source);
1009                 #[cfg(not(test))]
1010                 let (network_update, short_channel_id, payment_retryable, _, _) = onion_error.decode_onion_failure(secp_ctx, logger, &source);
1011
1012                 let payment_is_probe = payment_is_probe(payment_hash, &payment_id, probing_cookie_secret);
1013                 let mut session_priv_bytes = [0; 32];
1014                 session_priv_bytes.copy_from_slice(&session_priv[..]);
1015                 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1016                 let mut all_paths_failed = false;
1017                 let mut full_failure_ev = None;
1018                 let mut pending_retry_ev = None;
1019                 let mut retry = None;
1020                 let attempts_remaining = if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(*payment_id) {
1021                         if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
1022                                 log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1023                                 return
1024                         }
1025                         if payment.get().is_fulfilled() {
1026                                 log_trace!(logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
1027                                 return
1028                         }
1029                         let mut is_retryable_now = payment.get().is_auto_retryable_now();
1030                         if let Some(scid) = short_channel_id {
1031                                 payment.get_mut().insert_previously_failed_scid(scid);
1032                         }
1033
1034                         // We want to move towards only using the `PaymentParameters` in the outbound payments
1035                         // map. However, for backwards-compatibility, we still need to support passing the
1036                         // `PaymentParameters` data that was shoved in the HTLC (and given to us via
1037                         // `payment_params`) back to the user.
1038                         let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
1039                         if let Some(params) = payment.get_mut().payment_parameters() {
1040                                 if params.final_cltv_expiry_delta.is_none() {
1041                                         // This should be rare, but a user could provide None for the payment data, and
1042                                         // we need it when we go to retry the payment, so fill it in.
1043                                         params.final_cltv_expiry_delta = Some(path_last_hop.cltv_expiry_delta);
1044                                 }
1045                                 retry = Some(RouteParameters {
1046                                         payment_params: params.clone(),
1047                                         final_value_msat: path_last_hop.fee_msat,
1048                                         final_cltv_expiry_delta: params.final_cltv_expiry_delta.unwrap(),
1049                                 });
1050                         } else if let Some(params) = payment_params {
1051                                 retry = Some(RouteParameters {
1052                                         payment_params: params.clone(),
1053                                         final_value_msat: path_last_hop.fee_msat,
1054                                         final_cltv_expiry_delta:
1055                                                 if let Some(delta) = params.final_cltv_expiry_delta { delta }
1056                                                 else { path_last_hop.cltv_expiry_delta },
1057                                 });
1058                         }
1059
1060                         if !payment_is_probe && (!is_retryable_now || !payment_retryable || retry.is_none()) {
1061                                 let _ = payment.get_mut().mark_abandoned(); // we'll only Err if it's a legacy payment
1062                                 is_retryable_now = false;
1063                         }
1064                         if payment.get().remaining_parts() == 0 {
1065                                 all_paths_failed = true;
1066                                 if payment.get().abandoned() {
1067                                         full_failure_ev = Some(events::Event::PaymentFailed {
1068                                                 payment_id: *payment_id,
1069                                                 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
1070                                         });
1071                                         payment.remove();
1072                                 }
1073                         }
1074                         is_retryable_now
1075                 } else {
1076                         log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1077                         return
1078                 };
1079                 core::mem::drop(outbounds);
1080                 log_trace!(logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1081
1082                 let path_failure = {
1083                         if payment_is_probe {
1084                                 if !payment_retryable {
1085                                         events::Event::ProbeSuccessful {
1086                                                 payment_id: *payment_id,
1087                                                 payment_hash: payment_hash.clone(),
1088                                                 path: path.clone(),
1089                                         }
1090                                 } else {
1091                                         events::Event::ProbeFailed {
1092                                                 payment_id: *payment_id,
1093                                                 payment_hash: payment_hash.clone(),
1094                                                 path: path.clone(),
1095                                                 short_channel_id,
1096                                         }
1097                                 }
1098                         } else {
1099                                 // TODO: If we decided to blame ourselves (or one of our channels) in
1100                                 // process_onion_failure we should close that channel as it implies our
1101                                 // next-hop is needlessly blaming us!
1102                                 if let Some(scid) = short_channel_id {
1103                                         retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
1104                                 }
1105                                 // If we miss abandoning the payment above, we *must* generate an event here or else the
1106                                 // payment will sit in our outbounds forever.
1107                                 if attempts_remaining {
1108                                         debug_assert!(full_failure_ev.is_none());
1109                                         pending_retry_ev = Some(events::Event::PendingHTLCsForwardable {
1110                                                 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
1111                                         });
1112                                 }
1113                                 events::Event::PaymentPathFailed {
1114                                         payment_id: Some(*payment_id),
1115                                         payment_hash: payment_hash.clone(),
1116                                         payment_failed_permanently: !payment_retryable,
1117                                         network_update,
1118                                         all_paths_failed,
1119                                         path: path.clone(),
1120                                         short_channel_id,
1121                                         retry,
1122                                         #[cfg(test)]
1123                                         error_code: onion_error_code,
1124                                         #[cfg(test)]
1125                                         error_data: onion_error_data
1126                                 }
1127                         }
1128                 };
1129                 let mut pending_events = pending_events.lock().unwrap();
1130                 pending_events.push(path_failure);
1131                 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
1132                 if let Some(ev) = pending_retry_ev { pending_events.push(ev); }
1133         }
1134
1135         pub(super) fn abandon_payment(
1136                 &self, payment_id: PaymentId, pending_events: &Mutex<Vec<events::Event>>
1137         ) {
1138                 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1139                 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
1140                         if let Ok(()) = payment.get_mut().mark_abandoned() {
1141                                 if payment.get().remaining_parts() == 0 {
1142                                         pending_events.lock().unwrap().push(events::Event::PaymentFailed {
1143                                                 payment_id,
1144                                                 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
1145                                         });
1146                                         payment.remove();
1147                                 }
1148                         }
1149                 }
1150         }
1151
1152         #[cfg(test)]
1153         pub fn has_pending_payments(&self) -> bool {
1154                 !self.pending_outbound_payments.lock().unwrap().is_empty()
1155         }
1156
1157         #[cfg(test)]
1158         pub fn clear_pending_payments(&self) {
1159                 self.pending_outbound_payments.lock().unwrap().clear()
1160         }
1161 }
1162
1163 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
1164 /// payment probe.
1165 pub(super) fn payment_is_probe(payment_hash: &PaymentHash, payment_id: &PaymentId,
1166         probing_cookie_secret: [u8; 32]) -> bool
1167 {
1168         let target_payment_hash = probing_cookie_from_id(payment_id, probing_cookie_secret);
1169         target_payment_hash == *payment_hash
1170 }
1171
1172 /// Returns the 'probing cookie' for the given [`PaymentId`].
1173 fn probing_cookie_from_id(payment_id: &PaymentId, probing_cookie_secret: [u8; 32]) -> PaymentHash {
1174         let mut preimage = [0u8; 64];
1175         preimage[..32].copy_from_slice(&probing_cookie_secret);
1176         preimage[32..].copy_from_slice(&payment_id.0);
1177         PaymentHash(Sha256::hash(&preimage).into_inner())
1178 }
1179
1180 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
1181         (0, Legacy) => {
1182                 (0, session_privs, required),
1183         },
1184         (1, Fulfilled) => {
1185                 (0, session_privs, required),
1186                 (1, payment_hash, option),
1187                 (3, timer_ticks_without_htlcs, (default_value, 0)),
1188         },
1189         (2, Retryable) => {
1190                 (0, session_privs, required),
1191                 (1, pending_fee_msat, option),
1192                 (2, payment_hash, required),
1193                 (3, payment_params, option),
1194                 (4, payment_secret, option),
1195                 (5, keysend_preimage, option),
1196                 (6, total_msat, required),
1197                 (8, pending_amt_msat, required),
1198                 (10, starting_block_height, required),
1199                 (not_written, retry_strategy, (static_value, None)),
1200                 (not_written, attempts, (static_value, PaymentAttempts::new())),
1201         },
1202         (3, Abandoned) => {
1203                 (0, session_privs, required),
1204                 (2, payment_hash, required),
1205         },
1206 );
1207
1208 #[cfg(test)]
1209 mod tests {
1210         use bitcoin::blockdata::constants::genesis_block;
1211         use bitcoin::network::constants::Network;
1212         use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
1213
1214         use crate::ln::PaymentHash;
1215         use crate::ln::channelmanager::{PaymentId, PaymentSendFailure};
1216         use crate::ln::msgs::{ErrorAction, LightningError};
1217         use crate::ln::outbound_payment::{OutboundPayments, Retry};
1218         use crate::routing::gossip::NetworkGraph;
1219         use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteParameters};
1220         use crate::sync::{Arc, Mutex};
1221         use crate::util::errors::APIError;
1222         use crate::util::test_utils;
1223
1224         #[test]
1225         #[cfg(feature = "std")]
1226         fn fails_paying_after_expiration() {
1227                 do_fails_paying_after_expiration(false);
1228                 do_fails_paying_after_expiration(true);
1229         }
1230         #[cfg(feature = "std")]
1231         fn do_fails_paying_after_expiration(on_retry: bool) {
1232                 let outbound_payments = OutboundPayments::new();
1233                 let logger = test_utils::TestLogger::new();
1234                 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
1235                 let network_graph = Arc::new(NetworkGraph::new(genesis_hash, &logger));
1236                 let scorer = Mutex::new(test_utils::TestScorer::new());
1237                 let router = test_utils::TestRouter::new(network_graph, &scorer);
1238                 let secp_ctx = Secp256k1::new();
1239                 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1240
1241                 let past_expiry_time = std::time::SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() - 2;
1242                 let payment_params = PaymentParameters::from_node_id(
1243                                 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()),
1244                                 0
1245                         ).with_expiry_time(past_expiry_time);
1246                 let expired_route_params = RouteParameters {
1247                         payment_params,
1248                         final_value_msat: 0,
1249                         final_cltv_expiry_delta: 0,
1250                 };
1251                 let err = if on_retry {
1252                         outbound_payments.pay_internal(
1253                                 PaymentId([0; 32]), None, expired_route_params, &&router, vec![], &|| InFlightHtlcs::new(),
1254                                 &&keys_manager, &&keys_manager, 0, &&logger, &|_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err()
1255                 } else {
1256                         outbound_payments.send_payment(
1257                                 PaymentHash([0; 32]), &None, PaymentId([0; 32]), Retry::Attempts(0), expired_route_params,
1258                                 &&router, vec![], || InFlightHtlcs::new(), &&keys_manager, &&keys_manager, 0, &&logger,
1259                                 |_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err()
1260                 };
1261                 if let PaymentSendFailure::ParameterError(APIError::APIMisuseError { err }) = err {
1262                         assert!(err.contains("Invoice expired"));
1263                 } else { panic!("Unexpected error"); }
1264         }
1265
1266         #[test]
1267         fn find_route_error() {
1268                 do_find_route_error(false);
1269                 do_find_route_error(true);
1270         }
1271         fn do_find_route_error(on_retry: bool) {
1272                 let outbound_payments = OutboundPayments::new();
1273                 let logger = test_utils::TestLogger::new();
1274                 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
1275                 let network_graph = Arc::new(NetworkGraph::new(genesis_hash, &logger));
1276                 let scorer = Mutex::new(test_utils::TestScorer::new());
1277                 let router = test_utils::TestRouter::new(network_graph, &scorer);
1278                 let secp_ctx = Secp256k1::new();
1279                 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1280
1281                 let payment_params = PaymentParameters::from_node_id(
1282                         PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()), 0);
1283                 let route_params = RouteParameters {
1284                         payment_params,
1285                         final_value_msat: 0,
1286                         final_cltv_expiry_delta: 0,
1287                 };
1288                 router.expect_find_route(route_params.clone(),
1289                         Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
1290
1291                 let err = if on_retry {
1292                         outbound_payments.add_new_pending_payment(PaymentHash([0; 32]), None, PaymentId([0; 32]), None,
1293                                 &Route { paths: vec![], payment_params: None }, Some(Retry::Attempts(1)),
1294                                 Some(route_params.payment_params.clone()), &&keys_manager, 0).unwrap();
1295                         outbound_payments.pay_internal(
1296                                 PaymentId([0; 32]), None, route_params, &&router, vec![], &|| InFlightHtlcs::new(),
1297                                 &&keys_manager, &&keys_manager, 0, &&logger, &|_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err()
1298                 } else {
1299                         outbound_payments.send_payment(
1300                                 PaymentHash([0; 32]), &None, PaymentId([0; 32]), Retry::Attempts(0), route_params,
1301                                 &&router, vec![], || InFlightHtlcs::new(), &&keys_manager, &&keys_manager, 0, &&logger,
1302                                 |_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err()
1303                 };
1304                 if let PaymentSendFailure::ParameterError(APIError::APIMisuseError { err }) = err {
1305                         assert!(err.contains("Failed to find a route"));
1306                 } else { panic!("Unexpected error"); }
1307         }
1308 }