1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Utilities to send payments and manage outbound payment information.
12 use bitcoin::hashes::Hash;
13 use bitcoin::hashes::sha256::Hash as Sha256;
14 use bitcoin::secp256k1::{self, Secp256k1, SecretKey};
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;
31 use core::fmt::{self, Display, Formatter};
33 use core::time::Duration;
35 use crate::prelude::*;
36 use crate::sync::Mutex;
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 {
42 session_privs: HashSet<[u8; 32]>,
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.
57 /// Our best known block height at the time this payment was initiated.
58 starting_block_height: u32,
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.
64 session_privs: HashSet<[u8; 32]>,
65 payment_hash: Option<PaymentHash>,
66 timer_ticks_without_htlcs: u8,
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.
74 /// (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
76 session_privs: HashSet<[u8; 32]>,
77 payment_hash: PaymentHash,
81 impl PendingOutboundPayment {
82 fn increment_attempts(&mut self) {
83 if let PendingOutboundPayment::Retryable { attempts, .. } = self {
87 fn is_auto_retryable_now(&self) -> bool {
89 PendingOutboundPayment::Retryable { retry_strategy: Some(strategy), attempts, .. } => {
90 strategy.is_retryable_now(&attempts)
95 fn is_retryable_now(&self) -> bool {
97 PendingOutboundPayment::Retryable { retry_strategy: None, .. } => {
98 // We're handling retries manually, we can always retry.
101 PendingOutboundPayment::Retryable { retry_strategy: Some(strategy), attempts, .. } => {
102 strategy.is_retryable_now(&attempts)
107 fn payment_parameters(&mut self) -> Option<&mut PaymentParameters> {
109 PendingOutboundPayment::Retryable { payment_params: Some(ref mut params), .. } => {
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);
120 pub(super) fn is_fulfilled(&self) -> bool {
122 PendingOutboundPayment::Fulfilled { .. } => true,
126 pub(super) fn abandoned(&self) -> bool {
128 PendingOutboundPayment::Abandoned { .. } => true,
132 fn get_pending_fee_msat(&self) -> Option<u64> {
134 PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
139 fn payment_hash(&self) -> Option<PaymentHash> {
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),
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, .. }
157 let payment_hash = self.payment_hash();
158 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash, timer_ticks_without_htlcs: 0 };
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 { .. } =>
168 PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } |
169 PendingOutboundPayment::Abandoned { session_privs, payment_hash, .. } => {
170 our_payment_hash = *payment_hash;
174 *self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
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)
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();
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)
207 PendingOutboundPayment::Fulfilled { .. } => false,
208 PendingOutboundPayment::Abandoned { .. } => false,
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();
222 pub(super) fn remaining_parts(&self) -> usize {
224 PendingOutboundPayment::Legacy { session_privs } |
225 PendingOutboundPayment::Retryable { session_privs, .. } |
226 PendingOutboundPayment::Fulfilled { session_privs, .. } |
227 PendingOutboundPayment::Abandoned { session_privs, .. } => {
234 /// Strategies available to retry payment path failures.
235 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
237 /// Max number of attempts to retry payment.
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`].
243 #[cfg(not(feature = "no-std"))]
244 /// Time elapsed before abandoning retries for a payment.
245 Timeout(core::time::Duration),
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
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),
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)
274 pub(crate) type PaymentAttempts = PaymentAttemptsUsingTime<ConfiguredTime>;
276 /// Storing minimal payment attempts information required for determining if a outbound payment can
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
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;
293 impl<T: Time> PaymentAttemptsUsingTime<T> {
294 pub(crate) fn new() -> Self {
295 PaymentAttemptsUsingTime {
297 first_attempted_at: T::now()
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"))]
309 "attempts: {}, duration: {}s",
311 T::now().duration_since(self.first_attempted_at).as_secs()
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
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.
324 /// You can freely resend the payment in full (with the parameter error fixed).
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.
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.
336 /// You can freely resend the payment in full (with the parameter error fixed).
338 /// The results here are ordered the same as the paths in the route object which was passed to
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.
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).
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.
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`]).
363 /// [`PaymentId`]: crate::ln::channelmanager::PaymentId
364 /// [`Event::PaymentSent`]: crate::util::events::Event::PaymentSent
365 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
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.
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`].
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.
380 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
381 /// [`MonitorEvent::Completed`]: crate::chain::channelmonitor::MonitorEvent::Completed
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,
394 pub(super) struct OutboundPayments {
395 pub(super) pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
398 impl OutboundPayments {
399 pub(super) fn new() -> Self {
401 pending_outbound_payments: Mutex::new(HashMap::new())
405 pub(super) fn send_payment<R: Deref, ES: Deref, NS: Deref, F, 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>, inflight_htlcs: InFlightHtlcs, entropy_source: &ES,
409 node_signer: &NS, best_block_height: u32, logger: &L, send_payment_along_path: F,
410 ) -> Result<(), PaymentSendFailure>
413 ES::Target: EntropySource,
414 NS::Target: NodeSigner,
416 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
417 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>,
419 self.pay_internal(payment_id, Some((payment_hash, payment_secret, None, retry_strategy)),
420 route_params, router, first_hops, inflight_htlcs, entropy_source, node_signer,
421 best_block_height, logger, &send_payment_along_path)
422 .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
425 pub(super) fn send_payment_with_route<ES: Deref, NS: Deref, F>(
426 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
427 payment_id: PaymentId, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
428 send_payment_along_path: F
429 ) -> Result<(), PaymentSendFailure>
431 ES::Target: EntropySource,
432 NS::Target: NodeSigner,
433 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
434 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
436 let onion_session_privs = self.add_new_pending_payment(payment_hash, *payment_secret, payment_id, None, route, None, None, entropy_source, best_block_height)?;
437 self.pay_route_internal(route, payment_hash, payment_secret, None, payment_id, None,
438 onion_session_privs, node_signer, best_block_height, &send_payment_along_path)
439 .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
442 pub(super) fn send_spontaneous_payment<R: Deref, ES: Deref, NS: Deref, F, L: Deref>(
443 &self, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId,
444 retry_strategy: Retry, route_params: RouteParameters, router: &R,
445 first_hops: Vec<ChannelDetails>, inflight_htlcs: InFlightHtlcs, entropy_source: &ES,
446 node_signer: &NS, best_block_height: u32, logger: &L, send_payment_along_path: F
447 ) -> Result<PaymentHash, PaymentSendFailure>
450 ES::Target: EntropySource,
451 NS::Target: NodeSigner,
453 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
454 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>,
456 let preimage = match payment_preimage {
458 None => 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 })
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>
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>
478 let preimage = match payment_preimage {
480 None => PaymentPreimage(entropy_source.get_secure_random_bytes()),
482 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
483 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, Some(preimage), &route, None, None, entropy_source, best_block_height)?;
485 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) {
486 Ok(()) => Ok(payment_hash),
488 self.remove_outbound_if_all_failed(payment_id, &e);
494 pub(super) fn check_retry_payments<R: Deref, ES: Deref, NS: Deref, SP, IH, FH, L: Deref>(
495 &self, router: &R, first_hops: FH, inflight_htlcs: IH, entropy_source: &ES, node_signer: &NS,
496 best_block_height: u32, logger: &L, send_payment_along_path: SP,
500 ES::Target: EntropySource,
501 NS::Target: NodeSigner,
502 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
503 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>,
504 IH: Fn() -> InFlightHtlcs,
505 FH: Fn() -> Vec<ChannelDetails>,
509 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
510 let mut retry_id_route_params = None;
511 for (pmt_id, pmt) in outbounds.iter_mut() {
512 if pmt.is_auto_retryable_now() {
513 if let PendingOutboundPayment::Retryable { pending_amt_msat, total_msat, payment_params: Some(params), .. } = pmt {
514 if pending_amt_msat < total_msat {
515 retry_id_route_params = Some((*pmt_id, RouteParameters {
516 final_value_msat: *total_msat - *pending_amt_msat,
517 final_cltv_expiry_delta:
518 if let Some(delta) = params.final_cltv_expiry_delta { delta }
520 debug_assert!(false, "We always set the final_cltv_expiry_delta when a path fails");
521 LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA.into()
523 payment_params: params.clone(),
530 if let Some((payment_id, route_params)) = retry_id_route_params {
531 core::mem::drop(outbounds);
532 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) {
533 log_info!(logger, "Errored retrying payment: {:?}", e);
539 fn pay_internal<R: Deref, NS: Deref, ES: Deref, F, L: Deref>(
540 &self, payment_id: PaymentId,
541 initial_send_info: Option<(PaymentHash, &Option<PaymentSecret>, Option<PaymentPreimage>, Retry)>,
542 route_params: RouteParameters, router: &R, first_hops: Vec<ChannelDetails>,
543 inflight_htlcs: InFlightHtlcs, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
544 logger: &L, send_payment_along_path: &F,
545 ) -> Result<(), PaymentSendFailure>
548 ES::Target: EntropySource,
549 NS::Target: NodeSigner,
551 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
552 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
554 #[cfg(feature = "std")] {
555 if has_expired(&route_params) {
556 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
557 err: format!("Invoice expired for payment id {}", log_bytes!(payment_id.0)),
562 let route = router.find_route(
563 &node_signer.get_node_id(Recipient::Node).unwrap(), &route_params,
564 Some(&first_hops.iter().collect::<Vec<_>>()), &inflight_htlcs
565 ).map_err(|e| PaymentSendFailure::ParameterError(APIError::APIMisuseError {
566 err: format!("Failed to find a route for payment {}: {:?}", log_bytes!(payment_id.0), e), // TODO: add APIError::RouteNotFound
569 let res = if let Some((payment_hash, payment_secret, keysend_preimage, retry_strategy)) = initial_send_info {
570 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)?;
571 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)
573 self.retry_payment_with_route(&route, payment_id, entropy_source, node_signer, best_block_height, send_payment_along_path)
576 Err(PaymentSendFailure::AllFailedResendSafe(_)) => {
577 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);
578 log_info!(logger, "Result retrying payment id {}: {:?}", log_bytes!(payment_id.0), retry_res);
579 if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = &retry_res {
580 if err.starts_with("Retries exhausted ") { return res; }
584 Err(PaymentSendFailure::PartialFailure { failed_paths_retry: Some(retry), .. }) => {
585 // Some paths were sent, even if we failed to send the full MPP value our recipient may
586 // misbehave and claim the funds, at which point we have to consider the payment sent, so
587 // return `Ok()` here, ignoring any retry errors.
588 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);
589 log_info!(logger, "Result retrying payment id {}: {:?}", log_bytes!(payment_id.0), retry_res);
592 Err(PaymentSendFailure::PartialFailure { failed_paths_retry: None, .. }) => {
593 // This may happen if we send a payment and some paths fail, but only due to a temporary
594 // monitor failure or the like, implying they're really in-flight, but we haven't sent the
595 // initial HTLC-Add messages yet.
602 pub(super) fn retry_payment_with_route<ES: Deref, NS: Deref, F>(
603 &self, route: &Route, payment_id: PaymentId, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
604 send_payment_along_path: F
605 ) -> Result<(), PaymentSendFailure>
607 ES::Target: EntropySource,
608 NS::Target: NodeSigner,
609 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
610 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
612 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
613 for path in route.paths.iter() {
615 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
616 err: "length-0 path in route".to_string()
621 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
622 for _ in 0..route.paths.len() {
623 onion_session_privs.push(entropy_source.get_secure_random_bytes());
626 let (total_msat, payment_hash, payment_secret, keysend_preimage) = {
627 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
628 match outbounds.get_mut(&payment_id) {
630 let res = match payment {
631 PendingOutboundPayment::Retryable {
632 total_msat, payment_hash, keysend_preimage, payment_secret, pending_amt_msat, ..
634 let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
635 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
636 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
637 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()
640 (*total_msat, *payment_hash, *payment_secret, *keysend_preimage)
642 PendingOutboundPayment::Legacy { .. } => {
643 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
644 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
647 PendingOutboundPayment::Fulfilled { .. } => {
648 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
649 err: "Payment already completed".to_owned()
652 PendingOutboundPayment::Abandoned { .. } => {
653 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
654 err: "Payment already abandoned (with some HTLCs still pending)".to_owned()
658 if !payment.is_retryable_now() {
659 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
660 err: format!("Retries exhausted for payment id {}", log_bytes!(payment_id.0)),
663 payment.increment_attempts();
664 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
665 assert!(payment.insert(*session_priv_bytes, path));
670 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
671 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
675 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)
678 pub(super) fn send_probe<ES: Deref, NS: Deref, F>(
679 &self, hops: Vec<RouteHop>, probing_cookie_secret: [u8; 32], entropy_source: &ES,
680 node_signer: &NS, best_block_height: u32, send_payment_along_path: F
681 ) -> Result<(PaymentHash, PaymentId), PaymentSendFailure>
683 ES::Target: EntropySource,
684 NS::Target: NodeSigner,
685 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
686 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
688 let payment_id = PaymentId(entropy_source.get_secure_random_bytes());
690 let payment_hash = probing_cookie_from_id(&payment_id, probing_cookie_secret);
693 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
694 err: "No need probing a path with less than two hops".to_string()
698 let route = Route { paths: vec![hops], payment_params: None };
699 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, None, &route, None, None, entropy_source, best_block_height)?;
701 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) {
702 Ok(()) => Ok((payment_hash, payment_id)),
704 self.remove_outbound_if_all_failed(payment_id, &e);
711 pub(super) fn test_add_new_pending_payment<ES: Deref>(
712 &self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId,
713 route: &Route, retry_strategy: Option<Retry>, entropy_source: &ES, best_block_height: u32
714 ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
715 self.add_new_pending_payment(payment_hash, payment_secret, payment_id, None, route, retry_strategy, None, entropy_source, best_block_height)
718 pub(super) fn add_new_pending_payment<ES: Deref>(
719 &self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId,
720 keysend_preimage: Option<PaymentPreimage>, route: &Route, retry_strategy: Option<Retry>,
721 payment_params: Option<PaymentParameters>, entropy_source: &ES, best_block_height: u32
722 ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
723 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
724 for _ in 0..route.paths.len() {
725 onion_session_privs.push(entropy_source.get_secure_random_bytes());
728 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
729 match pending_outbounds.entry(payment_id) {
730 hash_map::Entry::Occupied(_) => Err(PaymentSendFailure::DuplicatePayment),
731 hash_map::Entry::Vacant(entry) => {
732 let payment = entry.insert(PendingOutboundPayment::Retryable {
734 attempts: PaymentAttempts::new(),
736 session_privs: HashSet::new(),
738 pending_fee_msat: Some(0),
742 starting_block_height: best_block_height,
743 total_msat: route.get_total_amount(),
746 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
747 assert!(payment.insert(*session_priv_bytes, path));
750 Ok(onion_session_privs)
755 fn pay_route_internal<NS: Deref, F>(
756 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
757 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
758 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
759 send_payment_along_path: &F
760 ) -> Result<(), PaymentSendFailure>
762 NS::Target: NodeSigner,
763 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
764 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
766 if route.paths.len() < 1 {
767 return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
769 if payment_secret.is_none() && route.paths.len() > 1 {
770 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
772 let mut total_value = 0;
773 let our_node_id = node_signer.get_node_id(Recipient::Node).unwrap(); // TODO no unwrap
774 let mut path_errs = Vec::with_capacity(route.paths.len());
775 'path_check: for path in route.paths.iter() {
776 if path.len() < 1 || path.len() > 20 {
777 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
778 continue 'path_check;
780 for (idx, hop) in path.iter().enumerate() {
781 if idx != path.len() - 1 && hop.pubkey == our_node_id {
782 path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
783 continue 'path_check;
786 total_value += path.last().unwrap().fee_msat;
787 path_errs.push(Ok(()));
789 if path_errs.iter().any(|e| e.is_err()) {
790 return Err(PaymentSendFailure::PathParameterError(path_errs));
792 if let Some(amt_msat) = recv_value_msat {
793 debug_assert!(amt_msat >= total_value);
794 total_value = amt_msat;
797 let cur_height = best_block_height + 1;
798 let mut results = Vec::new();
799 debug_assert_eq!(route.paths.len(), onion_session_privs.len());
800 for (path, session_priv) in route.paths.iter().zip(onion_session_privs.into_iter()) {
801 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);
804 Err(APIError::MonitorUpdateInProgress) => {
805 // While a MonitorUpdateInProgress is an Err(_), the payment is still
806 // considered "in flight" and we shouldn't remove it from the
807 // PendingOutboundPayment set.
810 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
811 if let Some(payment) = pending_outbounds.get_mut(&payment_id) {
812 let removed = payment.remove(&session_priv, Some(path));
813 debug_assert!(removed, "This can't happen as the payment has an entry for this path added by callers");
815 debug_assert!(false, "This can't happen as the payment was added by callers");
816 path_res = Err(APIError::APIMisuseError { err: "Internal error: payment disappeared during processing. Please report this bug!".to_owned() });
820 results.push(path_res);
822 let mut has_ok = false;
823 let mut has_err = false;
824 let mut pending_amt_unsent = 0;
825 let mut max_unsent_cltv_delta = 0;
826 for (res, path) in results.iter().zip(route.paths.iter()) {
827 if res.is_ok() { has_ok = true; }
828 if res.is_err() { has_err = true; }
829 if let &Err(APIError::MonitorUpdateInProgress) = res {
830 // MonitorUpdateInProgress is inherently unsafe to retry, so we call it a
834 } else if res.is_err() {
835 pending_amt_unsent += path.last().unwrap().fee_msat;
836 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
839 if has_err && has_ok {
840 Err(PaymentSendFailure::PartialFailure {
843 failed_paths_retry: if pending_amt_unsent != 0 {
844 if let Some(payment_params) = &route.payment_params {
845 Some(RouteParameters {
846 payment_params: payment_params.clone(),
847 final_value_msat: pending_amt_unsent,
848 final_cltv_expiry_delta:
849 if let Some(delta) = payment_params.final_cltv_expiry_delta { delta }
850 else { max_unsent_cltv_delta },
856 Err(PaymentSendFailure::AllFailedResendSafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
863 pub(super) fn test_send_payment_internal<NS: Deref, F>(
864 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
865 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
866 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
867 send_payment_along_path: F
868 ) -> Result<(), PaymentSendFailure>
870 NS::Target: NodeSigner,
871 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
872 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
874 self.pay_route_internal(route, payment_hash, payment_secret, keysend_preimage, payment_id,
875 recv_value_msat, onion_session_privs, node_signer, best_block_height,
876 &send_payment_along_path)
877 .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
880 // If we failed to send any paths, we should remove the new PaymentId from the
881 // `pending_outbound_payments` map, as the user isn't expected to `abandon_payment`.
882 fn remove_outbound_if_all_failed(&self, payment_id: PaymentId, err: &PaymentSendFailure) {
883 if let &PaymentSendFailure::AllFailedResendSafe(_) = err {
884 let removed = self.pending_outbound_payments.lock().unwrap().remove(&payment_id).is_some();
885 debug_assert!(removed, "We should always have a pending payment to remove here");
889 pub(super) fn claim_htlc<L: Deref>(
890 &self, payment_id: PaymentId, payment_preimage: PaymentPreimage, session_priv: SecretKey,
891 path: Vec<RouteHop>, from_onchain: bool, pending_events: &Mutex<Vec<events::Event>>, logger: &L
892 ) where L::Target: Logger {
893 let mut session_priv_bytes = [0; 32];
894 session_priv_bytes.copy_from_slice(&session_priv[..]);
895 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
896 let mut pending_events = pending_events.lock().unwrap();
897 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
898 if !payment.get().is_fulfilled() {
899 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
900 let fee_paid_msat = payment.get().get_pending_fee_msat();
902 events::Event::PaymentSent {
903 payment_id: Some(payment_id),
909 payment.get_mut().mark_fulfilled();
913 // We currently immediately remove HTLCs which were fulfilled on-chain.
914 // This could potentially lead to removing a pending payment too early,
915 // with a reorg of one block causing us to re-add the fulfilled payment on
917 // TODO: We should have a second monitor event that informs us of payments
918 // irrevocably fulfilled.
919 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
920 let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
922 events::Event::PaymentPathSuccessful {
931 log_trace!(logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
935 pub(super) fn finalize_claims(&self, sources: Vec<HTLCSource>, pending_events: &Mutex<Vec<events::Event>>) {
936 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
937 let mut pending_events = pending_events.lock().unwrap();
938 for source in sources {
939 if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
940 let mut session_priv_bytes = [0; 32];
941 session_priv_bytes.copy_from_slice(&session_priv[..]);
942 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
943 assert!(payment.get().is_fulfilled());
944 if payment.get_mut().remove(&session_priv_bytes, None) {
946 events::Event::PaymentPathSuccessful {
948 payment_hash: payment.get().payment_hash(),
958 pub(super) fn remove_stale_resolved_payments(&self, pending_events: &Mutex<Vec<events::Event>>) {
959 // If an outbound payment was completed, and no pending HTLCs remain, we should remove it
960 // from the map. However, if we did that immediately when the last payment HTLC is claimed,
961 // this could race the user making a duplicate send_payment call and our idempotency
962 // guarantees would be violated. Instead, we wait a few timer ticks to do the actual
963 // removal. This should be more than sufficient to ensure the idempotency of any
964 // `send_payment` calls that were made at the same time the `PaymentSent` event was being
966 let mut pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
967 let pending_events = pending_events.lock().unwrap();
968 pending_outbound_payments.retain(|payment_id, payment| {
969 if let PendingOutboundPayment::Fulfilled { session_privs, timer_ticks_without_htlcs, .. } = payment {
970 let mut no_remaining_entries = session_privs.is_empty();
971 if no_remaining_entries {
972 for ev in pending_events.iter() {
974 events::Event::PaymentSent { payment_id: Some(ev_payment_id), .. } |
975 events::Event::PaymentPathSuccessful { payment_id: ev_payment_id, .. } |
976 events::Event::PaymentPathFailed { payment_id: Some(ev_payment_id), .. } => {
977 if payment_id == ev_payment_id {
978 no_remaining_entries = false;
986 if no_remaining_entries {
987 *timer_ticks_without_htlcs += 1;
988 *timer_ticks_without_htlcs <= IDEMPOTENCY_TIMEOUT_TICKS
990 *timer_ticks_without_htlcs = 0;
997 pub(super) fn fail_htlc<L: Deref>(
998 &self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason,
999 path: &Vec<RouteHop>, session_priv: &SecretKey, payment_id: &PaymentId,
1000 payment_params: &Option<PaymentParameters>, probing_cookie_secret: [u8; 32],
1001 secp_ctx: &Secp256k1<secp256k1::All>, pending_events: &Mutex<Vec<events::Event>>, logger: &L
1002 ) where L::Target: Logger {
1004 let (network_update, short_channel_id, payment_retryable, onion_error_code, onion_error_data) = onion_error.decode_onion_failure(secp_ctx, logger, &source);
1006 let (network_update, short_channel_id, payment_retryable, _, _) = onion_error.decode_onion_failure(secp_ctx, logger, &source);
1008 let mut session_priv_bytes = [0; 32];
1009 session_priv_bytes.copy_from_slice(&session_priv[..]);
1010 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1011 let mut all_paths_failed = false;
1012 let mut full_failure_ev = None;
1013 let mut pending_retry_ev = None;
1014 let mut retry = None;
1015 let attempts_remaining = if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(*payment_id) {
1016 if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
1017 log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1020 if payment.get().is_fulfilled() {
1021 log_trace!(logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
1024 let is_retryable_now = payment.get().is_auto_retryable_now();
1025 if let Some(scid) = short_channel_id {
1026 payment.get_mut().insert_previously_failed_scid(scid);
1029 // We want to move towards only using the `PaymentParameters` in the outbound payments
1030 // map. However, for backwards-compatibility, we still need to support passing the
1031 // `PaymentParameters` data that was shoved in the HTLC (and given to us via
1032 // `payment_params`) back to the user.
1033 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
1034 if let Some(params) = payment.get_mut().payment_parameters() {
1035 if params.final_cltv_expiry_delta.is_none() {
1036 // This should be rare, but a user could provide None for the payment data, and
1037 // we need it when we go to retry the payment, so fill it in.
1038 params.final_cltv_expiry_delta = Some(path_last_hop.cltv_expiry_delta);
1040 retry = Some(RouteParameters {
1041 payment_params: params.clone(),
1042 final_value_msat: path_last_hop.fee_msat,
1043 final_cltv_expiry_delta: params.final_cltv_expiry_delta.unwrap(),
1045 } else if let Some(params) = payment_params {
1046 retry = Some(RouteParameters {
1047 payment_params: params.clone(),
1048 final_value_msat: path_last_hop.fee_msat,
1049 final_cltv_expiry_delta:
1050 if let Some(delta) = params.final_cltv_expiry_delta { delta }
1051 else { path_last_hop.cltv_expiry_delta },
1055 if payment.get().remaining_parts() == 0 {
1056 all_paths_failed = true;
1057 if payment.get().abandoned() {
1058 full_failure_ev = Some(events::Event::PaymentFailed {
1059 payment_id: *payment_id,
1060 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
1067 log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1070 core::mem::drop(outbounds);
1071 log_trace!(logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1073 let path_failure = {
1074 if payment_is_probe(payment_hash, &payment_id, probing_cookie_secret) {
1075 if !payment_retryable {
1076 events::Event::ProbeSuccessful {
1077 payment_id: *payment_id,
1078 payment_hash: payment_hash.clone(),
1082 events::Event::ProbeFailed {
1083 payment_id: *payment_id,
1084 payment_hash: payment_hash.clone(),
1090 // TODO: If we decided to blame ourselves (or one of our channels) in
1091 // process_onion_failure we should close that channel as it implies our
1092 // next-hop is needlessly blaming us!
1093 if let Some(scid) = short_channel_id {
1094 retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
1096 if payment_retryable && attempts_remaining && retry.is_some() {
1097 debug_assert!(full_failure_ev.is_none());
1098 pending_retry_ev = Some(events::Event::PendingHTLCsForwardable {
1099 time_forwardable: Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS),
1102 events::Event::PaymentPathFailed {
1103 payment_id: Some(*payment_id),
1104 payment_hash: payment_hash.clone(),
1105 payment_failed_permanently: !payment_retryable,
1112 error_code: onion_error_code,
1114 error_data: onion_error_data
1118 let mut pending_events = pending_events.lock().unwrap();
1119 pending_events.push(path_failure);
1120 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
1121 if let Some(ev) = pending_retry_ev { pending_events.push(ev); }
1124 pub(super) fn abandon_payment(&self, payment_id: PaymentId) -> Option<events::Event> {
1125 let mut failed_ev = None;
1126 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1127 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
1128 if let Ok(()) = payment.get_mut().mark_abandoned() {
1129 if payment.get().remaining_parts() == 0 {
1130 failed_ev = Some(events::Event::PaymentFailed {
1132 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
1142 pub fn has_pending_payments(&self) -> bool {
1143 !self.pending_outbound_payments.lock().unwrap().is_empty()
1147 pub fn clear_pending_payments(&self) {
1148 self.pending_outbound_payments.lock().unwrap().clear()
1152 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
1154 pub(super) fn payment_is_probe(payment_hash: &PaymentHash, payment_id: &PaymentId,
1155 probing_cookie_secret: [u8; 32]) -> bool
1157 let target_payment_hash = probing_cookie_from_id(payment_id, probing_cookie_secret);
1158 target_payment_hash == *payment_hash
1161 /// Returns the 'probing cookie' for the given [`PaymentId`].
1162 fn probing_cookie_from_id(payment_id: &PaymentId, probing_cookie_secret: [u8; 32]) -> PaymentHash {
1163 let mut preimage = [0u8; 64];
1164 preimage[..32].copy_from_slice(&probing_cookie_secret);
1165 preimage[32..].copy_from_slice(&payment_id.0);
1166 PaymentHash(Sha256::hash(&preimage).into_inner())
1169 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
1171 (0, session_privs, required),
1174 (0, session_privs, required),
1175 (1, payment_hash, option),
1176 (3, timer_ticks_without_htlcs, (default_value, 0)),
1179 (0, session_privs, required),
1180 (1, pending_fee_msat, option),
1181 (2, payment_hash, required),
1182 (3, payment_params, option),
1183 (4, payment_secret, option),
1184 (5, keysend_preimage, option),
1185 (6, total_msat, required),
1186 (8, pending_amt_msat, required),
1187 (10, starting_block_height, required),
1188 (not_written, retry_strategy, (static_value, None)),
1189 (not_written, attempts, (static_value, PaymentAttempts::new())),
1192 (0, session_privs, required),
1193 (2, payment_hash, required),
1199 use bitcoin::blockdata::constants::genesis_block;
1200 use bitcoin::network::constants::Network;
1201 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
1203 use crate::ln::PaymentHash;
1204 use crate::ln::channelmanager::{PaymentId, PaymentSendFailure};
1205 use crate::ln::msgs::{ErrorAction, LightningError};
1206 use crate::ln::outbound_payment::{OutboundPayments, Retry};
1207 use crate::routing::gossip::NetworkGraph;
1208 use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteParameters};
1209 use crate::sync::Arc;
1210 use crate::util::errors::APIError;
1211 use crate::util::test_utils;
1214 #[cfg(feature = "std")]
1215 fn fails_paying_after_expiration() {
1216 do_fails_paying_after_expiration(false);
1217 do_fails_paying_after_expiration(true);
1219 #[cfg(feature = "std")]
1220 fn do_fails_paying_after_expiration(on_retry: bool) {
1221 let outbound_payments = OutboundPayments::new();
1222 let logger = test_utils::TestLogger::new();
1223 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
1224 let network_graph = Arc::new(NetworkGraph::new(genesis_hash, &logger));
1225 let router = test_utils::TestRouter::new(network_graph);
1226 let secp_ctx = Secp256k1::new();
1227 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1229 let past_expiry_time = std::time::SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() - 2;
1230 let payment_params = PaymentParameters::from_node_id(
1231 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()),
1233 ).with_expiry_time(past_expiry_time);
1234 let expired_route_params = RouteParameters {
1236 final_value_msat: 0,
1237 final_cltv_expiry_delta: 0,
1239 let err = if on_retry {
1240 outbound_payments.pay_internal(
1241 PaymentId([0; 32]), None, expired_route_params, &&router, vec![], InFlightHtlcs::new(),
1242 &&keys_manager, &&keys_manager, 0, &&logger, &|_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err()
1244 outbound_payments.send_payment(
1245 PaymentHash([0; 32]), &None, PaymentId([0; 32]), Retry::Attempts(0), expired_route_params,
1246 &&router, vec![], InFlightHtlcs::new(), &&keys_manager, &&keys_manager, 0, &&logger,
1247 |_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err()
1249 if let PaymentSendFailure::ParameterError(APIError::APIMisuseError { err }) = err {
1250 assert!(err.contains("Invoice expired"));
1251 } else { panic!("Unexpected error"); }
1255 fn find_route_error() {
1256 do_find_route_error(false);
1257 do_find_route_error(true);
1259 fn do_find_route_error(on_retry: bool) {
1260 let outbound_payments = OutboundPayments::new();
1261 let logger = test_utils::TestLogger::new();
1262 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
1263 let network_graph = Arc::new(NetworkGraph::new(genesis_hash, &logger));
1264 let router = test_utils::TestRouter::new(network_graph);
1265 let secp_ctx = Secp256k1::new();
1266 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1268 let payment_params = PaymentParameters::from_node_id(
1269 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()), 0);
1270 let route_params = RouteParameters {
1272 final_value_msat: 0,
1273 final_cltv_expiry_delta: 0,
1275 router.expect_find_route(route_params.clone(),
1276 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
1278 let err = if on_retry {
1279 outbound_payments.add_new_pending_payment(PaymentHash([0; 32]), None, PaymentId([0; 32]), None,
1280 &Route { paths: vec![], payment_params: None }, Some(Retry::Attempts(1)),
1281 Some(route_params.payment_params.clone()), &&keys_manager, 0).unwrap();
1282 outbound_payments.pay_internal(
1283 PaymentId([0; 32]), None, route_params, &&router, vec![], InFlightHtlcs::new(),
1284 &&keys_manager, &&keys_manager, 0, &&logger, &|_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err()
1286 outbound_payments.send_payment(
1287 PaymentHash([0; 32]), &None, PaymentId([0; 32]), Retry::Attempts(0), route_params,
1288 &&router, vec![], InFlightHtlcs::new(), &&keys_manager, &&keys_manager, 0, &&logger,
1289 |_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err()
1291 if let PaymentSendFailure::ParameterError(APIError::APIMisuseError { err }) = err {
1292 assert!(err.contains("Failed to find a route"));
1293 } else { panic!("Unexpected error"); }