_ 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, KeysInterface, NodeSigner, Recipient};
  17 use crate::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
  18 use crate::ln::channelmanager::{HTLCSource, IDEMPOTENCY_TIMEOUT_TICKS, PaymentId};
  19 use crate::ln::msgs::DecodeError;
  20 use crate::ln::onion_utils::HTLCFailReason;
  21 use crate::routing::router::{PaymentParameters, Route, RouteHop, RouteParameters, RoutePath};
  22 use crate::util::errors::APIError;
  23 use crate::util::events;
  24 use crate::util::logger::Logger;
  25
  26 use core::cmp;
  27 use core::ops::Deref;
  28 use crate::prelude::*;
  29 use crate::sync::Mutex;
  30
  31 /// Stores the session_priv for each part of a payment that is still pending. For versions 0.0.102
  32 /// and later, also stores information for retrying the payment.
  33 pub(crate) enum PendingOutboundPayment {
  34         Legacy {
  35                 session_privs: HashSet<[u8; 32]>,
  36         },
  37         Retryable {
  38                 session_privs: HashSet<[u8; 32]>,
  39                 payment_hash: PaymentHash,
  40                 payment_secret: Option<PaymentSecret>,
  41                 pending_amt_msat: u64,
  42                 /// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
  43                 pending_fee_msat: Option<u64>,
  44                 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
  45                 total_msat: u64,
  46                 /// Our best known block height at the time this payment was initiated.
  47                 starting_block_height: u32,
  48         },
  49         /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
  50         /// been resolved. This ensures we don't look up pending payments in ChannelMonitors on restart
  51         /// and add a pending payment that was already fulfilled.
  52         Fulfilled {
  53                 session_privs: HashSet<[u8; 32]>,
  54                 payment_hash: Option<PaymentHash>,
  55                 timer_ticks_without_htlcs: u8,
  56         },
  57         /// When a payer gives up trying to retry a payment, they inform us, letting us generate a
  58         /// `PaymentFailed` event when all HTLCs have irrevocably failed. This avoids a number of race
  59         /// conditions in MPP-aware payment retriers (1), where the possibility of multiple
  60         /// `PaymentPathFailed` events with `all_paths_failed` can be pending at once, confusing a
  61         /// downstream event handler as to when a payment has actually failed.
  62         ///
  63         /// (1) https://github.com/lightningdevkit/rust-lightning/issues/1164
  64         Abandoned {
  65                 session_privs: HashSet<[u8; 32]>,
  66                 payment_hash: PaymentHash,
  67         },
  68 }
  69
  70 impl PendingOutboundPayment {
  71         pub(super) fn is_fulfilled(&self) -> bool {
  72                 match self {
  73                         PendingOutboundPayment::Fulfilled { .. } => true,
  74                         _ => false,
  75                 }
  76         }
  77         pub(super) fn abandoned(&self) -> bool {
  78                 match self {
  79                         PendingOutboundPayment::Abandoned { .. } => true,
  80                         _ => false,
  81                 }
  82         }
  83         fn get_pending_fee_msat(&self) -> Option<u64> {
  84                 match self {
  85                         PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
  86                         _ => None,
  87                 }
  88         }
  89
  90         fn payment_hash(&self) -> Option<PaymentHash> {
  91                 match self {
  92                         PendingOutboundPayment::Legacy { .. } => None,
  93                         PendingOutboundPayment::Retryable { payment_hash, .. } => Some(*payment_hash),
  94                         PendingOutboundPayment::Fulfilled { payment_hash, .. } => *payment_hash,
  95                         PendingOutboundPayment::Abandoned { payment_hash, .. } => Some(*payment_hash),
  96                 }
  97         }
  98
  99         fn mark_fulfilled(&mut self) {
 100                 let mut session_privs = HashSet::new();
 101                 core::mem::swap(&mut session_privs, match self {
 102                         PendingOutboundPayment::Legacy { session_privs } |
 103                                 PendingOutboundPayment::Retryable { session_privs, .. } |
 104                                 PendingOutboundPayment::Fulfilled { session_privs, .. } |
 105                                 PendingOutboundPayment::Abandoned { session_privs, .. }
 106                         => session_privs,
 107                 });
 108                 let payment_hash = self.payment_hash();
 109                 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash, timer_ticks_without_htlcs: 0 };
 110         }
 111
 112         fn mark_abandoned(&mut self) -> Result<(), ()> {
 113                 let mut session_privs = HashSet::new();
 114                 let our_payment_hash;
 115                 core::mem::swap(&mut session_privs, match self {
 116                         PendingOutboundPayment::Legacy { .. } |
 117                                 PendingOutboundPayment::Fulfilled { .. } =>
 118                                 return Err(()),
 119                                 PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } |
 120                                         PendingOutboundPayment::Abandoned { session_privs, payment_hash, .. } => {
 121                                                 our_payment_hash = *payment_hash;
 122                                                 session_privs
 123                                         },
 124                 });
 125                 *self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
 126                 Ok(())
 127         }
 128
 129         /// panics if path is None and !self.is_fulfilled
 130         fn remove(&mut self, session_priv: &[u8; 32], path: Option<&Vec<RouteHop>>) -> bool {
 131                 let remove_res = match self {
 132                         PendingOutboundPayment::Legacy { session_privs } |
 133                                 PendingOutboundPayment::Retryable { session_privs, .. } |
 134                                 PendingOutboundPayment::Fulfilled { session_privs, .. } |
 135                                 PendingOutboundPayment::Abandoned { session_privs, .. } => {
 136                                         session_privs.remove(session_priv)
 137                                 }
 138                 };
 139                 if remove_res {
 140                         if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
 141                                 let path = path.expect("Fulfilling a payment should always come with a path");
 142                                 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
 143                                 *pending_amt_msat -= path_last_hop.fee_msat;
 144                                 if let Some(fee_msat) = pending_fee_msat.as_mut() {
 145                                         *fee_msat -= path.get_path_fees();
 146                                 }
 147                         }
 148                 }
 149                 remove_res
 150         }
 151
 152         pub(super) fn insert(&mut self, session_priv: [u8; 32], path: &Vec<RouteHop>) -> bool {
 153                 let insert_res = match self {
 154                         PendingOutboundPayment::Legacy { session_privs } |
 155                                 PendingOutboundPayment::Retryable { session_privs, .. } => {
 156                                         session_privs.insert(session_priv)
 157                                 }
 158                         PendingOutboundPayment::Fulfilled { .. } => false,
 159                         PendingOutboundPayment::Abandoned { .. } => false,
 160                 };
 161                 if insert_res {
 162                         if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
 163                                 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
 164                                 *pending_amt_msat += path_last_hop.fee_msat;
 165                                 if let Some(fee_msat) = pending_fee_msat.as_mut() {
 166                                         *fee_msat += path.get_path_fees();
 167                                 }
 168                         }
 169                 }
 170                 insert_res
 171         }
 172
 173         pub(super) fn remaining_parts(&self) -> usize {
 174                 match self {
 175                         PendingOutboundPayment::Legacy { session_privs } |
 176                                 PendingOutboundPayment::Retryable { session_privs, .. } |
 177                                 PendingOutboundPayment::Fulfilled { session_privs, .. } |
 178                                 PendingOutboundPayment::Abandoned { session_privs, .. } => {
 179                                         session_privs.len()
 180                                 }
 181                 }
 182         }
 183 }
 184
 185 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
 186 /// Err() type describing which state the payment is in, see the description of individual enum
 187 /// states for more.
 188 #[derive(Clone, Debug)]
 189 pub enum PaymentSendFailure {
 190         /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
 191         /// send the payment at all.
 192         ///
 193         /// You can freely resend the payment in full (with the parameter error fixed).
 194         ///
 195         /// Because the payment failed outright, no payment tracking is done, you do not need to call
 196         /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
 197         /// for this payment.
 198         ///
 199         /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 200         /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
 201         ParameterError(APIError),
 202         /// A parameter in a single path which was passed to send_payment was invalid, preventing us
 203         /// from attempting to send the payment at all.
 204         ///
 205         /// You can freely resend the payment in full (with the parameter error fixed).
 206         ///
 207         /// The results here are ordered the same as the paths in the route object which was passed to
 208         /// send_payment.
 209         ///
 210         /// Because the payment failed outright, no payment tracking is done, you do not need to call
 211         /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
 212         /// for this payment.
 213         ///
 214         /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 215         /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
 216         PathParameterError(Vec<Result<(), APIError>>),
 217         /// All paths which were attempted failed to send, with no channel state change taking place.
 218         /// You can freely resend the payment in full (though you probably want to do so over different
 219         /// paths than the ones selected).
 220         ///
 221         /// Because the payment failed outright, no payment tracking is done, you do not need to call
 222         /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
 223         /// for this payment.
 224         ///
 225         /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 226         /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
 227         AllFailedResendSafe(Vec<APIError>),
 228         /// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
 229         /// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
 230         /// [`ChannelManager::abandon_payment`]).
 231         ///
 232         /// [`PaymentId`]: crate::ln::channelmanager::PaymentId
 233         /// [`Event::PaymentSent`]: crate::util::events::Event::PaymentSent
 234         /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 235         DuplicatePayment,
 236         /// Some paths which were attempted failed to send, though possibly not all. At least some
 237         /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
 238         /// in over-/re-payment.
 239         ///
 240         /// The results here are ordered the same as the paths in the route object which was passed to
 241         /// send_payment, and any `Err`s which are not [`APIError::MonitorUpdateInProgress`] can be
 242         /// safely retried via [`ChannelManager::retry_payment`].
 243         ///
 244         /// Any entries which contain `Err(APIError::MonitorUpdateInprogress)` or `Ok(())` MUST NOT be
 245         /// retried as they will result in over-/re-payment. These HTLCs all either successfully sent
 246         /// (in the case of `Ok(())`) or will send once a [`MonitorEvent::Completed`] is provided for
 247         /// the next-hop channel with the latest update_id.
 248         ///
 249         /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
 250         /// [`MonitorEvent::Completed`]: crate::chain::channelmonitor::MonitorEvent::Completed
 251         PartialFailure {
 252                 /// The errors themselves, in the same order as the route hops.
 253                 results: Vec<Result<(), APIError>>,
 254                 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
 255                 /// contain a [`RouteParameters`] object which can be used to calculate a new route that
 256                 /// will pay all remaining unpaid balance.
 257                 failed_paths_retry: Option<RouteParameters>,
 258                 /// The payment id for the payment, which is now at least partially pending.
 259                 payment_id: PaymentId,
 260         },
 261 }
 262
 263 pub(super) struct OutboundPayments {
 264         pub(super) pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
 265 }
 266
 267 impl OutboundPayments {
 268         pub(super) fn new() -> Self {
 269                 Self {
 270                         pending_outbound_payments: Mutex::new(HashMap::new())
 271                 }
 272         }
 273
 274         pub(super) fn send_payment_with_route<K: Deref, F>(
 275                 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
 276                 payment_id: PaymentId, keys_manager: &K, best_block_height: u32, send_payment_along_path: F
 277         ) -> Result<(), PaymentSendFailure>
 278         where
 279                 K::Target: KeysInterface,
 280                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 281                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 282         {
 283                 let onion_session_privs = self.add_new_pending_payment(payment_hash, *payment_secret, payment_id, route, keys_manager, best_block_height)?;
 284                 self.send_payment_internal(route, payment_hash, payment_secret, None, payment_id, None, onion_session_privs, keys_manager, best_block_height, send_payment_along_path)
 285         }
 286
 287         pub(super) fn send_spontaneous_payment<K: Deref, F>(
 288                 &self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId,
 289                 keys_manager: &K, best_block_height: u32, send_payment_along_path: F
 290         ) -> Result<PaymentHash, PaymentSendFailure>
 291         where
 292                 K::Target: KeysInterface,
 293                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 294                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 295         {
 296                 let preimage = match payment_preimage {
 297                         Some(p) => p,
 298                         None => PaymentPreimage(keys_manager.get_secure_random_bytes()),
 299                 };
 300                 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
 301                 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, &route, keys_manager, best_block_height)?;
 302
 303                 match self.send_payment_internal(route, payment_hash, &None, Some(preimage), payment_id, None, onion_session_privs, keys_manager, best_block_height, send_payment_along_path) {
 304                         Ok(()) => Ok(payment_hash),
 305                         Err(e) => Err(e)
 306                 }
 307         }
 308
 309         pub(super) fn retry_payment_with_route<K: Deref, F>(
 310                 &self, route: &Route, payment_id: PaymentId, keys_manager: &K, best_block_height: u32,
 311                 send_payment_along_path: F
 312         ) -> Result<(), PaymentSendFailure>
 313         where
 314                 K::Target: KeysInterface,
 315                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 316                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 317         {
 318                 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
 319                 for path in route.paths.iter() {
 320                         if path.len() == 0 {
 321                                 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 322                                         err: "length-0 path in route".to_string()
 323                                 }))
 324                         }
 325                 }
 326
 327                 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
 328                 for _ in 0..route.paths.len() {
 329                         onion_session_privs.push(keys_manager.get_secure_random_bytes());
 330                 }
 331
 332                 let (total_msat, payment_hash, payment_secret) = {
 333                         let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 334                         match outbounds.get_mut(&payment_id) {
 335                                 Some(payment) => {
 336                                         let res = match payment {
 337                                                 PendingOutboundPayment::Retryable {
 338                                                         total_msat, payment_hash, payment_secret, pending_amt_msat, ..
 339                                                 } => {
 340                                                         let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
 341                                                         if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
 342                                                                 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 343                                                                         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()
 344                                                                 }))
 345                                                         }
 346                                                         (*total_msat, *payment_hash, *payment_secret)
 347                                                 },
 348                                                 PendingOutboundPayment::Legacy { .. } => {
 349                                                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 350                                                                 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
 351                                                         }))
 352                                                 },
 353                                                 PendingOutboundPayment::Fulfilled { .. } => {
 354                                                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 355                                                                 err: "Payment already completed".to_owned()
 356                                                         }));
 357                                                 },
 358                                                 PendingOutboundPayment::Abandoned { .. } => {
 359                                                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 360                                                                 err: "Payment already abandoned (with some HTLCs still pending)".to_owned()
 361                                                         }));
 362                                                 },
 363                                         };
 364                                         for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
 365                                                 assert!(payment.insert(*session_priv_bytes, path));
 366                                         }
 367                                         res
 368                                 },
 369                                 None =>
 370                                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 371                                                 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
 372                                         })),
 373                         }
 374                 };
 375                 self.send_payment_internal(route, payment_hash, &payment_secret, None, payment_id, Some(total_msat), onion_session_privs, keys_manager, best_block_height, send_payment_along_path)
 376         }
 377
 378         pub(super) fn send_probe<K: Deref, F>(
 379                 &self, hops: Vec<RouteHop>, probing_cookie_secret: [u8; 32], keys_manager: &K,
 380                 best_block_height: u32, send_payment_along_path: F
 381         ) -> Result<(PaymentHash, PaymentId), PaymentSendFailure>
 382         where
 383                 K::Target: KeysInterface,
 384                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 385                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 386         {
 387                 let payment_id = PaymentId(keys_manager.get_secure_random_bytes());
 388
 389                 let payment_hash = probing_cookie_from_id(&payment_id, probing_cookie_secret);
 390
 391                 if hops.len() < 2 {
 392                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
 393                                 err: "No need probing a path with less than two hops".to_string()
 394                         }))
 395                 }
 396
 397                 let route = Route { paths: vec![hops], payment_params: None };
 398                 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, &route, keys_manager, best_block_height)?;
 399
 400                 match self.send_payment_internal(&route, payment_hash, &None, None, payment_id, None, onion_session_privs, keys_manager, best_block_height, send_payment_along_path) {
 401                         Ok(()) => Ok((payment_hash, payment_id)),
 402                         Err(e) => Err(e)
 403                 }
 404         }
 405
 406         #[cfg(test)]
 407         pub(super) fn test_add_new_pending_payment<K: Deref>(
 408                 &self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId,
 409                 route: &Route, keys_manager: &K, best_block_height: u32
 410         ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where K::Target: KeysInterface {
 411                 self.add_new_pending_payment(payment_hash, payment_secret, payment_id, route, keys_manager, best_block_height)
 412         }
 413
 414         fn add_new_pending_payment<K: Deref>(
 415                 &self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId,
 416                 route: &Route, keys_manager: &K, best_block_height: u32
 417         ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where K::Target: KeysInterface {
 418                 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
 419                 for _ in 0..route.paths.len() {
 420                         onion_session_privs.push(keys_manager.get_secure_random_bytes());
 421                 }
 422
 423                 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
 424                 match pending_outbounds.entry(payment_id) {
 425                         hash_map::Entry::Occupied(_) => Err(PaymentSendFailure::DuplicatePayment),
 426                         hash_map::Entry::Vacant(entry) => {
 427                                 let payment = entry.insert(PendingOutboundPayment::Retryable {
 428                                         session_privs: HashSet::new(),
 429                                         pending_amt_msat: 0,
 430                                         pending_fee_msat: Some(0),
 431                                         payment_hash,
 432                                         payment_secret,
 433                                         starting_block_height: best_block_height,
 434                                         total_msat: route.get_total_amount(),
 435                                 });
 436
 437                                 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
 438                                         assert!(payment.insert(*session_priv_bytes, path));
 439                                 }
 440
 441                                 Ok(onion_session_privs)
 442                         },
 443                 }
 444         }
 445
 446         fn send_payment_internal<K: Deref, F>(
 447                 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
 448                 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
 449                 onion_session_privs: Vec<[u8; 32]>, keys_manager: &K, best_block_height: u32,
 450                 send_payment_along_path: F
 451         ) -> Result<(), PaymentSendFailure>
 452         where
 453                 K::Target: KeysInterface,
 454                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 455                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 456         {
 457                 if route.paths.len() < 1 {
 458                         return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
 459                 }
 460                 if payment_secret.is_none() && route.paths.len() > 1 {
 461                         return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
 462                 }
 463                 let mut total_value = 0;
 464                 let our_node_id = keys_manager.get_node_id(Recipient::Node).unwrap(); // TODO no unwrap
 465                 let mut path_errs = Vec::with_capacity(route.paths.len());
 466                 'path_check: for path in route.paths.iter() {
 467                         if path.len() < 1 || path.len() > 20 {
 468                                 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
 469                                 continue 'path_check;
 470                         }
 471                         for (idx, hop) in path.iter().enumerate() {
 472                                 if idx != path.len() - 1 && hop.pubkey == our_node_id {
 473                                         path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
 474                                         continue 'path_check;
 475                                 }
 476                         }
 477                         total_value += path.last().unwrap().fee_msat;
 478                         path_errs.push(Ok(()));
 479                 }
 480                 if path_errs.iter().any(|e| e.is_err()) {
 481                         return Err(PaymentSendFailure::PathParameterError(path_errs));
 482                 }
 483                 if let Some(amt_msat) = recv_value_msat {
 484                         debug_assert!(amt_msat >= total_value);
 485                         total_value = amt_msat;
 486                 }
 487
 488                 let cur_height = best_block_height + 1;
 489                 let mut results = Vec::new();
 490                 debug_assert_eq!(route.paths.len(), onion_session_privs.len());
 491                 for (path, session_priv) in route.paths.iter().zip(onion_session_privs.into_iter()) {
 492                         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);
 493                         match path_res {
 494                                 Ok(_) => {},
 495                                 Err(APIError::MonitorUpdateInProgress) => {
 496                                         // While a MonitorUpdateInProgress is an Err(_), the payment is still
 497                                         // considered "in flight" and we shouldn't remove it from the
 498                                         // PendingOutboundPayment set.
 499                                 },
 500                                 Err(_) => {
 501                                         let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
 502                                         if let Some(payment) = pending_outbounds.get_mut(&payment_id) {
 503                                                 let removed = payment.remove(&session_priv, Some(path));
 504                                                 debug_assert!(removed, "This can't happen as the payment has an entry for this path added by callers");
 505                                         } else {
 506                                                 debug_assert!(false, "This can't happen as the payment was added by callers");
 507                                                 path_res = Err(APIError::APIMisuseError { err: "Internal error: payment disappeared during processing. Please report this bug!".to_owned() });
 508                                         }
 509                                 }
 510                         }
 511                         results.push(path_res);
 512                 }
 513                 let mut has_ok = false;
 514                 let mut has_err = false;
 515                 let mut pending_amt_unsent = 0;
 516                 let mut max_unsent_cltv_delta = 0;
 517                 for (res, path) in results.iter().zip(route.paths.iter()) {
 518                         if res.is_ok() { has_ok = true; }
 519                         if res.is_err() { has_err = true; }
 520                         if let &Err(APIError::MonitorUpdateInProgress) = res {
 521                                 // MonitorUpdateInProgress is inherently unsafe to retry, so we call it a
 522                                 // PartialFailure.
 523                                 has_err = true;
 524                                 has_ok = true;
 525                         } else if res.is_err() {
 526                                 pending_amt_unsent += path.last().unwrap().fee_msat;
 527                                 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
 528                         }
 529                 }
 530                 if has_err && has_ok {
 531                         Err(PaymentSendFailure::PartialFailure {
 532                                 results,
 533                                 payment_id,
 534                                 failed_paths_retry: if pending_amt_unsent != 0 {
 535                                         if let Some(payment_params) = &route.payment_params {
 536                                                 Some(RouteParameters {
 537                                                         payment_params: payment_params.clone(),
 538                                                         final_value_msat: pending_amt_unsent,
 539                                                         final_cltv_expiry_delta: max_unsent_cltv_delta,
 540                                                 })
 541                                         } else { None }
 542                                 } else { None },
 543                         })
 544                 } else if has_err {
 545                         // If we failed to send any paths, we should remove the new PaymentId from the
 546                         // `pending_outbound_payments` map, as the user isn't expected to `abandon_payment`.
 547                         let removed = self.pending_outbound_payments.lock().unwrap().remove(&payment_id).is_some();
 548                         debug_assert!(removed, "We should always have a pending payment to remove here");
 549                         Err(PaymentSendFailure::AllFailedResendSafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
 550                 } else {
 551                         Ok(())
 552                 }
 553         }
 554
 555         #[cfg(test)]
 556         pub(super) fn test_send_payment_internal<K: Deref, F>(
 557                 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
 558                 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
 559                 onion_session_privs: Vec<[u8; 32]>, keys_manager: &K, best_block_height: u32,
 560                 send_payment_along_path: F
 561         ) -> Result<(), PaymentSendFailure>
 562         where
 563                 K::Target: KeysInterface,
 564                 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
 565                    u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
 566         {
 567                 self.send_payment_internal(route, payment_hash, payment_secret, keysend_preimage, payment_id,
 568                         recv_value_msat, onion_session_privs, keys_manager, best_block_height,
 569                         send_payment_along_path)
 570         }
 571
 572         pub(super) fn claim_htlc<L: Deref>(
 573                 &self, payment_id: PaymentId, payment_preimage: PaymentPreimage, session_priv: SecretKey,
 574                 path: Vec<RouteHop>, from_onchain: bool, pending_events: &Mutex<Vec<events::Event>>, logger: &L
 575         ) where L::Target: Logger {
 576                 let mut session_priv_bytes = [0; 32];
 577                 session_priv_bytes.copy_from_slice(&session_priv[..]);
 578                 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 579                 let mut pending_events = pending_events.lock().unwrap();
 580                 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
 581                         if !payment.get().is_fulfilled() {
 582                                 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
 583                                 let fee_paid_msat = payment.get().get_pending_fee_msat();
 584                                 pending_events.push(
 585                                         events::Event::PaymentSent {
 586                                                 payment_id: Some(payment_id),
 587                                                 payment_preimage,
 588                                                 payment_hash,
 589                                                 fee_paid_msat,
 590                                         }
 591                                 );
 592                                 payment.get_mut().mark_fulfilled();
 593                         }
 594
 595                         if from_onchain {
 596                                 // We currently immediately remove HTLCs which were fulfilled on-chain.
 597                                 // This could potentially lead to removing a pending payment too early,
 598                                 // with a reorg of one block causing us to re-add the fulfilled payment on
 599                                 // restart.
 600                                 // TODO: We should have a second monitor event that informs us of payments
 601                                 // irrevocably fulfilled.
 602                                 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
 603                                         let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
 604                                         pending_events.push(
 605                                                 events::Event::PaymentPathSuccessful {
 606                                                         payment_id,
 607                                                         payment_hash,
 608                                                         path,
 609                                                 }
 610                                         );
 611                                 }
 612                         }
 613                 } else {
 614                         log_trace!(logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
 615                 }
 616         }
 617
 618         pub(super) fn finalize_claims(&self, sources: Vec<HTLCSource>, pending_events: &Mutex<Vec<events::Event>>) {
 619                 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 620                 let mut pending_events = pending_events.lock().unwrap();
 621                 for source in sources {
 622                         if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
 623                                 let mut session_priv_bytes = [0; 32];
 624                                 session_priv_bytes.copy_from_slice(&session_priv[..]);
 625                                 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
 626                                         assert!(payment.get().is_fulfilled());
 627                                         if payment.get_mut().remove(&session_priv_bytes, None) {
 628                                                 pending_events.push(
 629                                                         events::Event::PaymentPathSuccessful {
 630                                                                 payment_id,
 631                                                                 payment_hash: payment.get().payment_hash(),
 632                                                                 path,
 633                                                         }
 634                                                 );
 635                                         }
 636                                 }
 637                         }
 638                 }
 639         }
 640
 641         pub(super) fn remove_stale_resolved_payments(&self, pending_events: &Mutex<Vec<events::Event>>) {
 642                 // If an outbound payment was completed, and no pending HTLCs remain, we should remove it
 643                 // from the map. However, if we did that immediately when the last payment HTLC is claimed,
 644                 // this could race the user making a duplicate send_payment call and our idempotency
 645                 // guarantees would be violated. Instead, we wait a few timer ticks to do the actual
 646                 // removal. This should be more than sufficient to ensure the idempotency of any
 647                 // `send_payment` calls that were made at the same time the `PaymentSent` event was being
 648                 // processed.
 649                 let mut pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
 650                 let pending_events = pending_events.lock().unwrap();
 651                 pending_outbound_payments.retain(|payment_id, payment| {
 652                         if let PendingOutboundPayment::Fulfilled { session_privs, timer_ticks_without_htlcs, .. } = payment {
 653                                 let mut no_remaining_entries = session_privs.is_empty();
 654                                 if no_remaining_entries {
 655                                         for ev in pending_events.iter() {
 656                                                 match ev {
 657                                                         events::Event::PaymentSent { payment_id: Some(ev_payment_id), .. } |
 658                                                                 events::Event::PaymentPathSuccessful { payment_id: ev_payment_id, .. } |
 659                                                                 events::Event::PaymentPathFailed { payment_id: Some(ev_payment_id), .. } => {
 660                                                                         if payment_id == ev_payment_id {
 661                                                                                 no_remaining_entries = false;
 662                                                                                 break;
 663                                                                         }
 664                                                                 },
 665                                                         _ => {},
 666                                                 }
 667                                         }
 668                                 }
 669                                 if no_remaining_entries {
 670                                         *timer_ticks_without_htlcs += 1;
 671                                         *timer_ticks_without_htlcs <= IDEMPOTENCY_TIMEOUT_TICKS
 672                                 } else {
 673                                         *timer_ticks_without_htlcs = 0;
 674                                         true
 675                                 }
 676                         } else { true }
 677                 });
 678         }
 679
 680         pub(super) fn fail_htlc<L: Deref>(
 681                 &self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason,
 682                 path: &Vec<RouteHop>, session_priv: &SecretKey, payment_id: &PaymentId,
 683                 payment_params: &Option<PaymentParameters>, probing_cookie_secret: [u8; 32],
 684                 secp_ctx: &Secp256k1<secp256k1::All>, pending_events: &Mutex<Vec<events::Event>>, logger: &L
 685         ) where L::Target: Logger {
 686                 let mut session_priv_bytes = [0; 32];
 687                 session_priv_bytes.copy_from_slice(&session_priv[..]);
 688                 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 689                 let mut all_paths_failed = false;
 690                 let mut full_failure_ev = None;
 691                 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(*payment_id) {
 692                         if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
 693                                 log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
 694                                 return
 695                         }
 696                         if payment.get().is_fulfilled() {
 697                                 log_trace!(logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
 698                                 return
 699                         }
 700                         if payment.get().remaining_parts() == 0 {
 701                                 all_paths_failed = true;
 702                                 if payment.get().abandoned() {
 703                                         full_failure_ev = Some(events::Event::PaymentFailed {
 704                                                 payment_id: *payment_id,
 705                                                 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
 706                                         });
 707                                         payment.remove();
 708                                 }
 709                         }
 710                 } else {
 711                         log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
 712                         return
 713                 }
 714                 let mut retry = if let Some(payment_params_data) = payment_params {
 715                         let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
 716                         Some(RouteParameters {
 717                                 payment_params: payment_params_data.clone(),
 718                                 final_value_msat: path_last_hop.fee_msat,
 719                                 final_cltv_expiry_delta: path_last_hop.cltv_expiry_delta,
 720                         })
 721                 } else { None };
 722                 log_trace!(logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
 723
 724                 let path_failure = {
 725                         #[cfg(test)]
 726                         let (network_update, short_channel_id, payment_retryable, onion_error_code, onion_error_data) = onion_error.decode_onion_failure(secp_ctx, logger, &source);
 727                         #[cfg(not(test))]
 728                         let (network_update, short_channel_id, payment_retryable, _, _) = onion_error.decode_onion_failure(secp_ctx, logger, &source);
 729
 730                         if payment_is_probe(payment_hash, &payment_id, probing_cookie_secret) {
 731                                 if !payment_retryable {
 732                                         events::Event::ProbeSuccessful {
 733                                                 payment_id: *payment_id,
 734                                                 payment_hash: payment_hash.clone(),
 735                                                 path: path.clone(),
 736                                         }
 737                                 } else {
 738                                         events::Event::ProbeFailed {
 739                                                 payment_id: *payment_id,
 740                                                 payment_hash: payment_hash.clone(),
 741                                                 path: path.clone(),
 742                                                 short_channel_id,
 743                                         }
 744                                 }
 745                         } else {
 746                                 // TODO: If we decided to blame ourselves (or one of our channels) in
 747                                 // process_onion_failure we should close that channel as it implies our
 748                                 // next-hop is needlessly blaming us!
 749                                 if let Some(scid) = short_channel_id {
 750                                         retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
 751                                 }
 752                                 events::Event::PaymentPathFailed {
 753                                         payment_id: Some(*payment_id),
 754                                         payment_hash: payment_hash.clone(),
 755                                         payment_failed_permanently: !payment_retryable,
 756                                         network_update,
 757                                         all_paths_failed,
 758                                         path: path.clone(),
 759                                         short_channel_id,
 760                                         retry,
 761                                         #[cfg(test)]
 762                                         error_code: onion_error_code,
 763                                         #[cfg(test)]
 764                                         error_data: onion_error_data
 765                                 }
 766                         }
 767                 };
 768                 let mut pending_events = pending_events.lock().unwrap();
 769                 pending_events.push(path_failure);
 770                 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
 771         }
 772
 773         pub(super) fn abandon_payment(&self, payment_id: PaymentId) -> Option<events::Event> {
 774                 let mut failed_ev = None;
 775                 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 776                 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
 777                         if let Ok(()) = payment.get_mut().mark_abandoned() {
 778                                 if payment.get().remaining_parts() == 0 {
 779                                         failed_ev = Some(events::Event::PaymentFailed {
 780                                                 payment_id,
 781                                                 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
 782                                         });
 783                                         payment.remove();
 784                                 }
 785                         }
 786                 }
 787                 failed_ev
 788         }
 789
 790         #[cfg(test)]
 791         pub fn has_pending_payments(&self) -> bool {
 792                 !self.pending_outbound_payments.lock().unwrap().is_empty()
 793         }
 794
 795         #[cfg(test)]
 796         pub fn clear_pending_payments(&self) {
 797                 self.pending_outbound_payments.lock().unwrap().clear()
 798         }
 799 }
 800
 801 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
 802 /// payment probe.
 803 pub(super) fn payment_is_probe(payment_hash: &PaymentHash, payment_id: &PaymentId,
 804         probing_cookie_secret: [u8; 32]) -> bool
 805 {
 806         let target_payment_hash = probing_cookie_from_id(payment_id, probing_cookie_secret);
 807         target_payment_hash == *payment_hash
 808 }
 809
 810 /// Returns the 'probing cookie' for the given [`PaymentId`].
 811 fn probing_cookie_from_id(payment_id: &PaymentId, probing_cookie_secret: [u8; 32]) -> PaymentHash {
 812         let mut preimage = [0u8; 64];
 813         preimage[..32].copy_from_slice(&probing_cookie_secret);
 814         preimage[32..].copy_from_slice(&payment_id.0);
 815         PaymentHash(Sha256::hash(&preimage).into_inner())
 816 }
 817
 818 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
 819         (0, Legacy) => {
 820                 (0, session_privs, required),
 821         },
 822         (1, Fulfilled) => {
 823                 (0, session_privs, required),
 824                 (1, payment_hash, option),
 825                 (3, timer_ticks_without_htlcs, (default_value, 0)),
 826         },
 827         (2, Retryable) => {
 828                 (0, session_privs, required),
 829                 (1, pending_fee_msat, option),
 830                 (2, payment_hash, required),
 831                 (4, payment_secret, option),
 832                 (6, total_msat, required),
 833                 (8, pending_amt_msat, required),
 834                 (10, starting_block_height, required),
 835         },
 836         (3, Abandoned) => {
 837                 (0, session_privs, required),
 838                 (2, payment_hash, required),
 839         },
 840 );