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, PaymentId};
19 use crate::ln::channelmanager::MIN_FINAL_CLTV_EXPIRY_DELTA as LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA;
20 use crate::ln::onion_utils::HTLCFailReason;
21 use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, RoutePath, Router};
22 use crate::util::errors::APIError;
23 use crate::util::events;
24 use crate::util::logger::Logger;
25 use crate::util::time::Time;
26 #[cfg(all(not(feature = "no-std"), test))]
27 use crate::util::time::tests::SinceEpoch;
30 use core::fmt::{self, Display, Formatter};
33 use crate::prelude::*;
34 use crate::sync::Mutex;
36 /// Stores the session_priv for each part of a payment that is still pending. For versions 0.0.102
37 /// and later, also stores information for retrying the payment.
38 pub(crate) enum PendingOutboundPayment {
40 session_privs: HashSet<[u8; 32]>,
43 retry_strategy: Option<Retry>,
44 attempts: PaymentAttempts,
45 payment_params: Option<PaymentParameters>,
46 session_privs: HashSet<[u8; 32]>,
47 payment_hash: PaymentHash,
48 payment_secret: Option<PaymentSecret>,
49 keysend_preimage: Option<PaymentPreimage>,
50 pending_amt_msat: u64,
51 /// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
52 pending_fee_msat: Option<u64>,
53 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
55 /// Our best known block height at the time this payment was initiated.
56 starting_block_height: u32,
58 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
59 /// been resolved. This ensures we don't look up pending payments in ChannelMonitors on restart
60 /// and add a pending payment that was already fulfilled.
62 session_privs: HashSet<[u8; 32]>,
63 payment_hash: Option<PaymentHash>,
64 timer_ticks_without_htlcs: u8,
66 /// When we've decided to give up retrying a payment, we mark it as abandoned so we can eventually
67 /// generate a `PaymentFailed` event when all HTLCs have irrevocably failed.
69 session_privs: HashSet<[u8; 32]>,
70 payment_hash: PaymentHash,
74 impl PendingOutboundPayment {
75 fn increment_attempts(&mut self) {
76 if let PendingOutboundPayment::Retryable { attempts, .. } = self {
80 fn is_auto_retryable_now(&self) -> bool {
82 PendingOutboundPayment::Retryable { retry_strategy: Some(strategy), attempts, .. } => {
83 strategy.is_retryable_now(&attempts)
88 fn is_retryable_now(&self) -> bool {
90 PendingOutboundPayment::Retryable { retry_strategy: None, .. } => {
91 // We're handling retries manually, we can always retry.
94 PendingOutboundPayment::Retryable { retry_strategy: Some(strategy), attempts, .. } => {
95 strategy.is_retryable_now(&attempts)
100 fn payment_parameters(&mut self) -> Option<&mut PaymentParameters> {
102 PendingOutboundPayment::Retryable { payment_params: Some(ref mut params), .. } => {
108 pub fn insert_previously_failed_scid(&mut self, scid: u64) {
109 if let PendingOutboundPayment::Retryable { payment_params: Some(params), .. } = self {
110 params.previously_failed_channels.push(scid);
113 pub(super) fn is_fulfilled(&self) -> bool {
115 PendingOutboundPayment::Fulfilled { .. } => true,
119 pub(super) fn abandoned(&self) -> bool {
121 PendingOutboundPayment::Abandoned { .. } => true,
125 fn get_pending_fee_msat(&self) -> Option<u64> {
127 PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
132 fn payment_hash(&self) -> Option<PaymentHash> {
134 PendingOutboundPayment::Legacy { .. } => None,
135 PendingOutboundPayment::Retryable { payment_hash, .. } => Some(*payment_hash),
136 PendingOutboundPayment::Fulfilled { payment_hash, .. } => *payment_hash,
137 PendingOutboundPayment::Abandoned { payment_hash, .. } => Some(*payment_hash),
141 fn mark_fulfilled(&mut self) {
142 let mut session_privs = HashSet::new();
143 core::mem::swap(&mut session_privs, match self {
144 PendingOutboundPayment::Legacy { session_privs } |
145 PendingOutboundPayment::Retryable { session_privs, .. } |
146 PendingOutboundPayment::Fulfilled { session_privs, .. } |
147 PendingOutboundPayment::Abandoned { session_privs, .. }
150 let payment_hash = self.payment_hash();
151 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash, timer_ticks_without_htlcs: 0 };
154 fn mark_abandoned(&mut self) -> Result<(), ()> {
155 let mut session_privs = HashSet::new();
156 let our_payment_hash;
157 core::mem::swap(&mut session_privs, match self {
158 PendingOutboundPayment::Legacy { .. } |
159 PendingOutboundPayment::Fulfilled { .. } =>
161 PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } |
162 PendingOutboundPayment::Abandoned { session_privs, payment_hash, .. } => {
163 our_payment_hash = *payment_hash;
167 *self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
171 /// panics if path is None and !self.is_fulfilled
172 fn remove(&mut self, session_priv: &[u8; 32], path: Option<&Vec<RouteHop>>) -> bool {
173 let remove_res = match self {
174 PendingOutboundPayment::Legacy { session_privs } |
175 PendingOutboundPayment::Retryable { session_privs, .. } |
176 PendingOutboundPayment::Fulfilled { session_privs, .. } |
177 PendingOutboundPayment::Abandoned { session_privs, .. } => {
178 session_privs.remove(session_priv)
182 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
183 let path = path.expect("Fulfilling a payment should always come with a path");
184 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
185 *pending_amt_msat -= path_last_hop.fee_msat;
186 if let Some(fee_msat) = pending_fee_msat.as_mut() {
187 *fee_msat -= path.get_path_fees();
194 pub(super) fn insert(&mut self, session_priv: [u8; 32], path: &Vec<RouteHop>) -> bool {
195 let insert_res = match self {
196 PendingOutboundPayment::Legacy { session_privs } |
197 PendingOutboundPayment::Retryable { session_privs, .. } => {
198 session_privs.insert(session_priv)
200 PendingOutboundPayment::Fulfilled { .. } => false,
201 PendingOutboundPayment::Abandoned { .. } => false,
204 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
205 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
206 *pending_amt_msat += path_last_hop.fee_msat;
207 if let Some(fee_msat) = pending_fee_msat.as_mut() {
208 *fee_msat += path.get_path_fees();
215 pub(super) fn remaining_parts(&self) -> usize {
217 PendingOutboundPayment::Legacy { session_privs } |
218 PendingOutboundPayment::Retryable { session_privs, .. } |
219 PendingOutboundPayment::Fulfilled { session_privs, .. } |
220 PendingOutboundPayment::Abandoned { session_privs, .. } => {
227 /// Strategies available to retry payment path failures.
228 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
230 /// Max number of attempts to retry payment.
232 /// Each attempt may be multiple HTLCs along multiple paths if the router decides to split up a
233 /// retry, and may retry multiple failed HTLCs at once if they failed around the same time and
234 /// were retried along a route from a single call to [`Router::find_route`].
236 #[cfg(not(feature = "no-std"))]
237 /// Time elapsed before abandoning retries for a payment. At least one attempt at payment is made;
238 /// see [`PaymentParameters::expiry_time`] to avoid any attempt at payment after a specific time.
240 /// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
241 Timeout(core::time::Duration),
245 pub(crate) fn is_retryable_now(&self, attempts: &PaymentAttempts) -> bool {
246 match (self, attempts) {
247 (Retry::Attempts(max_retry_count), PaymentAttempts { count, .. }) => {
248 max_retry_count > count
250 #[cfg(all(not(feature = "no-std"), not(test)))]
251 (Retry::Timeout(max_duration), PaymentAttempts { first_attempted_at, .. }) =>
252 *max_duration >= std::time::Instant::now().duration_since(*first_attempted_at),
253 #[cfg(all(not(feature = "no-std"), test))]
254 (Retry::Timeout(max_duration), PaymentAttempts { first_attempted_at, .. }) =>
255 *max_duration >= SinceEpoch::now().duration_since(*first_attempted_at),
260 #[cfg(feature = "std")]
261 pub(super) fn has_expired(route_params: &RouteParameters) -> bool {
262 if let Some(expiry_time) = route_params.payment_params.expiry_time {
263 if let Ok(elapsed) = std::time::SystemTime::UNIX_EPOCH.elapsed() {
264 return elapsed > core::time::Duration::from_secs(expiry_time)
270 pub(crate) type PaymentAttempts = PaymentAttemptsUsingTime<ConfiguredTime>;
272 /// Storing minimal payment attempts information required for determining if a outbound payment can
274 pub(crate) struct PaymentAttemptsUsingTime<T: Time> {
275 /// This count will be incremented only after the result of the attempt is known. When it's 0,
276 /// it means the result of the first attempt is not known yet.
277 pub(crate) count: usize,
278 /// This field is only used when retry is `Retry::Timeout` which is only build with feature std
279 first_attempted_at: T
282 #[cfg(not(any(feature = "no-std", test)))]
283 type ConfiguredTime = std::time::Instant;
284 #[cfg(feature = "no-std")]
285 type ConfiguredTime = crate::util::time::Eternity;
286 #[cfg(all(not(feature = "no-std"), test))]
287 type ConfiguredTime = SinceEpoch;
289 impl<T: Time> PaymentAttemptsUsingTime<T> {
290 pub(crate) fn new() -> Self {
291 PaymentAttemptsUsingTime {
293 first_attempted_at: T::now()
298 impl<T: Time> Display for PaymentAttemptsUsingTime<T> {
299 fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
300 #[cfg(feature = "no-std")]
301 return write!(f, "attempts: {}", self.count);
302 #[cfg(not(feature = "no-std"))]
305 "attempts: {}, duration: {}s",
307 T::now().duration_since(self.first_attempted_at).as_secs()
312 /// Indicates an immediate error on [`ChannelManager::send_payment_with_retry`]. Further errors
313 /// may be surfaced later via [`Event::PaymentPathFailed`] and [`Event::PaymentFailed`].
315 /// [`ChannelManager::send_payment_with_retry`]: crate::ln::channelmanager::ChannelManager::send_payment_with_retry
316 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
317 /// [`Event::PaymentFailed`]: crate::util::events::Event::PaymentFailed
318 #[derive(Clone, Debug)]
319 pub enum RetryableSendFailure {
320 /// The provided [`PaymentParameters::expiry_time`] indicated that the payment has expired. Note
321 /// that this error is *not* caused by [`Retry::Timeout`].
323 /// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
325 /// We were unable to find a route to the destination.
327 /// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
328 /// yet completed (i.e. generated an [`Event::PaymentSent`] or [`Event::PaymentFailed`]).
330 /// [`PaymentId`]: crate::ln::channelmanager::PaymentId
331 /// [`Event::PaymentSent`]: crate::util::events::Event::PaymentSent
332 /// [`Event::PaymentFailed`]: crate::util::events::Event::PaymentFailed
336 /// If a payment fails to send with [`ChannelManager::send_payment`], it can be in one of several
337 /// states. This enum is returned as the Err() type describing which state the payment is in, see
338 /// the description of individual enum states for more.
340 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
341 #[derive(Clone, Debug)]
342 pub enum PaymentSendFailure {
343 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
344 /// send the payment at all.
346 /// You can freely resend the payment in full (with the parameter error fixed).
348 /// Because the payment failed outright, no payment tracking is done and no
349 /// [`Event::PaymentPathFailed`] or [`Event::PaymentFailed`] events will be generated.
351 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
352 /// [`Event::PaymentFailed`]: crate::util::events::Event::PaymentFailed
353 ParameterError(APIError),
354 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
355 /// from attempting to send the payment at all.
357 /// You can freely resend the payment in full (with the parameter error fixed).
359 /// Because the payment failed outright, no payment tracking is done and no
360 /// [`Event::PaymentPathFailed`] or [`Event::PaymentFailed`] events will be generated.
362 /// The results here are ordered the same as the paths in the route object which was passed to
365 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
366 /// [`Event::PaymentFailed`]: crate::util::events::Event::PaymentFailed
367 PathParameterError(Vec<Result<(), APIError>>),
368 /// All paths which were attempted failed to send, with no channel state change taking place.
369 /// You can freely resend the payment in full (though you probably want to do so over different
370 /// paths than the ones selected).
372 /// Because the payment failed outright, no payment tracking is done and no
373 /// [`Event::PaymentPathFailed`] or [`Event::PaymentFailed`] events will be generated.
375 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
376 /// [`Event::PaymentFailed`]: crate::util::events::Event::PaymentFailed
377 AllFailedResendSafe(Vec<APIError>),
378 /// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
379 /// yet completed (i.e. generated an [`Event::PaymentSent`] or [`Event::PaymentFailed`]).
381 /// [`PaymentId`]: crate::ln::channelmanager::PaymentId
382 /// [`Event::PaymentSent`]: crate::util::events::Event::PaymentSent
383 /// [`Event::PaymentFailed`]: crate::util::events::Event::PaymentFailed
385 /// Some paths that were attempted failed to send, though some paths may have succeeded. At least
386 /// some paths have irrevocably committed to the HTLC.
388 /// The results here are ordered the same as the paths in the route object that was passed to
391 /// Any entries that contain `Err(APIError::MonitorUpdateInprogress)` will send once a
392 /// [`MonitorEvent::Completed`] is provided for the next-hop channel with the latest update_id.
394 /// [`MonitorEvent::Completed`]: crate::chain::channelmonitor::MonitorEvent::Completed
396 /// The errors themselves, in the same order as the paths from the route.
397 results: Vec<Result<(), APIError>>,
398 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
399 /// contain a [`RouteParameters`] object for the failing paths.
400 failed_paths_retry: Option<RouteParameters>,
401 /// The payment id for the payment, which is now at least partially pending.
402 payment_id: PaymentId,
406 pub(super) struct OutboundPayments {
407 pub(super) pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
408 pub(super) retry_lock: Mutex<()>,
411 impl OutboundPayments {
412 pub(super) fn new() -> Self {
414 pending_outbound_payments: Mutex::new(HashMap::new()),
415 retry_lock: Mutex::new(()),
419 pub(super) fn send_payment<R: Deref, ES: Deref, NS: Deref, IH, SP, L: Deref>(
420 &self, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId,
421 retry_strategy: Retry, route_params: RouteParameters, router: &R,
422 first_hops: Vec<ChannelDetails>, compute_inflight_htlcs: IH, entropy_source: &ES,
423 node_signer: &NS, best_block_height: u32, logger: &L,
424 pending_events: &Mutex<Vec<events::Event>>, send_payment_along_path: SP,
425 ) -> Result<(), RetryableSendFailure>
428 ES::Target: EntropySource,
429 NS::Target: NodeSigner,
431 IH: Fn() -> InFlightHtlcs,
432 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
433 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>,
435 self.send_payment_internal(payment_id, payment_hash, payment_secret, None, retry_strategy,
436 route_params, router, first_hops, &compute_inflight_htlcs, entropy_source, node_signer,
437 best_block_height, logger, pending_events, &send_payment_along_path)
440 pub(super) fn send_payment_with_route<ES: Deref, NS: Deref, F>(
441 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
442 payment_id: PaymentId, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
443 send_payment_along_path: F
444 ) -> Result<(), PaymentSendFailure>
446 ES::Target: EntropySource,
447 NS::Target: NodeSigner,
448 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
449 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
451 let onion_session_privs = self.add_new_pending_payment(payment_hash, *payment_secret, payment_id, None, route, None, None, entropy_source, best_block_height)?;
452 self.pay_route_internal(route, payment_hash, payment_secret, None, payment_id, None,
453 onion_session_privs, node_signer, best_block_height, &send_payment_along_path)
454 .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
457 pub(super) fn send_spontaneous_payment<R: Deref, ES: Deref, NS: Deref, IH, SP, L: Deref>(
458 &self, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId,
459 retry_strategy: Retry, route_params: RouteParameters, router: &R,
460 first_hops: Vec<ChannelDetails>, inflight_htlcs: IH, entropy_source: &ES,
461 node_signer: &NS, best_block_height: u32, logger: &L,
462 pending_events: &Mutex<Vec<events::Event>>, send_payment_along_path: SP
463 ) -> Result<PaymentHash, RetryableSendFailure>
466 ES::Target: EntropySource,
467 NS::Target: NodeSigner,
469 IH: Fn() -> InFlightHtlcs,
470 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
471 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>,
473 let preimage = payment_preimage
474 .unwrap_or_else(|| PaymentPreimage(entropy_source.get_secure_random_bytes()));
475 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
476 self.send_payment_internal(payment_id, payment_hash, &None, Some(preimage), retry_strategy,
477 route_params, router, first_hops, inflight_htlcs, entropy_source, node_signer,
478 best_block_height, logger, pending_events, send_payment_along_path)
479 .map(|()| payment_hash)
482 pub(super) fn send_spontaneous_payment_with_route<ES: Deref, NS: Deref, F>(
483 &self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId,
484 entropy_source: &ES, node_signer: &NS, best_block_height: u32, send_payment_along_path: F
485 ) -> Result<PaymentHash, PaymentSendFailure>
487 ES::Target: EntropySource,
488 NS::Target: NodeSigner,
489 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
490 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
492 let preimage = payment_preimage
493 .unwrap_or_else(|| PaymentPreimage(entropy_source.get_secure_random_bytes()));
494 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
495 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, Some(preimage), &route, None, None, entropy_source, best_block_height)?;
497 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) {
498 Ok(()) => Ok(payment_hash),
500 self.remove_outbound_if_all_failed(payment_id, &e);
506 pub(super) fn check_retry_payments<R: Deref, ES: Deref, NS: Deref, SP, IH, FH, L: Deref>(
507 &self, router: &R, first_hops: FH, inflight_htlcs: IH, entropy_source: &ES, node_signer: &NS,
508 best_block_height: u32, pending_events: &Mutex<Vec<events::Event>>, logger: &L,
509 send_payment_along_path: SP,
513 ES::Target: EntropySource,
514 NS::Target: NodeSigner,
515 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
516 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>,
517 IH: Fn() -> InFlightHtlcs,
518 FH: Fn() -> Vec<ChannelDetails>,
521 let _single_thread = self.retry_lock.lock().unwrap();
523 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
524 let mut retry_id_route_params = None;
525 for (pmt_id, pmt) in outbounds.iter_mut() {
526 if pmt.is_auto_retryable_now() {
527 if let PendingOutboundPayment::Retryable { pending_amt_msat, total_msat, payment_params: Some(params), .. } = pmt {
528 if pending_amt_msat < total_msat {
529 retry_id_route_params = Some((*pmt_id, RouteParameters {
530 final_value_msat: *total_msat - *pending_amt_msat,
531 final_cltv_expiry_delta:
532 if let Some(delta) = params.final_cltv_expiry_delta { delta }
534 debug_assert!(false, "We always set the final_cltv_expiry_delta when a path fails");
535 LDK_DEFAULT_MIN_FINAL_CLTV_EXPIRY_DELTA.into()
537 payment_params: params.clone(),
544 core::mem::drop(outbounds);
545 if let Some((payment_id, route_params)) = retry_id_route_params {
546 self.retry_payment_internal(payment_id, route_params, router, first_hops(), &inflight_htlcs, entropy_source, node_signer, best_block_height, logger, pending_events, &send_payment_along_path)
550 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
551 outbounds.retain(|pmt_id, pmt| {
552 let mut retain = true;
553 if !pmt.is_auto_retryable_now() && pmt.remaining_parts() == 0 {
554 if pmt.mark_abandoned().is_ok() {
555 pending_events.lock().unwrap().push(events::Event::PaymentFailed {
557 payment_hash: pmt.payment_hash().expect("PendingOutboundPayments::Retryable always has a payment hash set"),
566 pub(super) fn needs_abandon(&self) -> bool {
567 let outbounds = self.pending_outbound_payments.lock().unwrap();
568 outbounds.iter().any(|(_, pmt)|
569 !pmt.is_auto_retryable_now() && pmt.remaining_parts() == 0 && !pmt.is_fulfilled())
572 /// Errors immediately on [`RetryableSendFailure`] error conditions. Otherwise, further errors may
573 /// be surfaced asynchronously via [`Event::PaymentPathFailed`] and [`Event::PaymentFailed`].
575 /// [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
576 /// [`Event::PaymentFailed`]: crate::util::events::Event::PaymentFailed
577 fn send_payment_internal<R: Deref, NS: Deref, ES: Deref, IH, SP, L: Deref>(
578 &self, payment_id: PaymentId, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
579 keysend_preimage: Option<PaymentPreimage>, retry_strategy: Retry, route_params: RouteParameters,
580 router: &R, first_hops: Vec<ChannelDetails>, inflight_htlcs: IH, entropy_source: &ES,
581 node_signer: &NS, best_block_height: u32, logger: &L,
582 pending_events: &Mutex<Vec<events::Event>>, send_payment_along_path: SP,
583 ) -> Result<(), RetryableSendFailure>
586 ES::Target: EntropySource,
587 NS::Target: NodeSigner,
589 IH: Fn() -> InFlightHtlcs,
590 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
591 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
593 #[cfg(feature = "std")] {
594 if has_expired(&route_params) {
595 return Err(RetryableSendFailure::PaymentExpired)
599 let route = router.find_route(
600 &node_signer.get_node_id(Recipient::Node).unwrap(), &route_params,
601 Some(&first_hops.iter().collect::<Vec<_>>()), &inflight_htlcs()
602 ).map_err(|_| RetryableSendFailure::RouteNotFound)?;
604 let onion_session_privs = self.add_new_pending_payment(payment_hash, *payment_secret,
605 payment_id, keysend_preimage, &route, Some(retry_strategy),
606 Some(route_params.payment_params.clone()), entropy_source, best_block_height)
607 .map_err(|_| RetryableSendFailure::DuplicatePayment)?;
609 let res = self.pay_route_internal(&route, payment_hash, payment_secret, None, payment_id, None,
610 onion_session_privs, node_signer, best_block_height, &send_payment_along_path);
611 log_info!(logger, "Result sending payment with id {}: {:?}", log_bytes!(payment_id.0), res);
612 if let Err(e) = res {
613 self.handle_pay_route_err(e, payment_id, payment_hash, route, route_params, router, first_hops, &inflight_htlcs, entropy_source, node_signer, best_block_height, logger, pending_events, &send_payment_along_path);
618 fn retry_payment_internal<R: Deref, NS: Deref, ES: Deref, IH, SP, L: Deref>(
619 &self, payment_id: PaymentId, route_params: RouteParameters, router: &R,
620 first_hops: Vec<ChannelDetails>, inflight_htlcs: &IH, entropy_source: &ES, node_signer: &NS,
621 best_block_height: u32, logger: &L, pending_events: &Mutex<Vec<events::Event>>,
622 send_payment_along_path: &SP,
626 ES::Target: EntropySource,
627 NS::Target: NodeSigner,
629 IH: Fn() -> InFlightHtlcs,
630 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
631 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
633 #[cfg(feature = "std")] {
634 if has_expired(&route_params) {
635 log_error!(logger, "Payment params expired on retry, abandoning payment {}", log_bytes!(payment_id.0));
636 self.abandon_payment(payment_id, pending_events);
641 let route = match router.find_route(
642 &node_signer.get_node_id(Recipient::Node).unwrap(), &route_params,
643 Some(&first_hops.iter().collect::<Vec<_>>()), &inflight_htlcs()
647 log_error!(logger, "Failed to find a route on retry, abandoning payment {}: {:#?}", log_bytes!(payment_id.0), e);
648 self.abandon_payment(payment_id, pending_events);
652 for path in route.paths.iter() {
654 log_error!(logger, "length-0 path in route");
655 self.abandon_payment(payment_id, pending_events);
660 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
661 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
662 for _ in 0..route.paths.len() {
663 onion_session_privs.push(entropy_source.get_secure_random_bytes());
666 macro_rules! abandon_with_entry {
667 ($payment_id: expr, $payment_hash: expr, $payment: expr, $pending_events: expr) => {
668 if $payment.get_mut().mark_abandoned().is_ok() && $payment.get().remaining_parts() == 0 {
669 $pending_events.lock().unwrap().push(events::Event::PaymentFailed {
670 payment_id: $payment_id,
671 payment_hash: $payment_hash,
677 let (total_msat, payment_hash, payment_secret, keysend_preimage) = {
678 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
679 match outbounds.entry(payment_id) {
680 hash_map::Entry::Occupied(mut payment) => {
681 let res = match payment.get() {
682 PendingOutboundPayment::Retryable {
683 total_msat, payment_hash, keysend_preimage, payment_secret, pending_amt_msat, ..
685 let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
686 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
687 log_error!(logger, "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);
688 let payment_hash = *payment_hash;
689 abandon_with_entry!(payment_id, payment_hash, payment, pending_events);
692 (*total_msat, *payment_hash, *payment_secret, *keysend_preimage)
694 PendingOutboundPayment::Legacy { .. } => {
695 log_error!(logger, "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102");
698 PendingOutboundPayment::Fulfilled { .. } => {
699 log_error!(logger, "Payment already completed");
702 PendingOutboundPayment::Abandoned { .. } => {
703 log_error!(logger, "Payment already abandoned (with some HTLCs still pending)");
707 if !payment.get().is_retryable_now() {
708 log_error!(logger, "Retries exhausted for payment id {}", log_bytes!(payment_id.0));
709 abandon_with_entry!(payment_id, res.1, payment, pending_events);
712 payment.get_mut().increment_attempts();
713 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
714 assert!(payment.get_mut().insert(*session_priv_bytes, path));
718 hash_map::Entry::Vacant(_) => {
719 log_error!(logger, "Payment with ID {} not found", log_bytes!(payment_id.0));
724 let res = self.pay_route_internal(&route, payment_hash, &payment_secret, keysend_preimage,
725 payment_id, Some(total_msat), onion_session_privs, node_signer, best_block_height,
726 &send_payment_along_path);
727 log_info!(logger, "Result retrying payment id {}: {:?}", log_bytes!(payment_id.0), res);
728 if let Err(e) = res {
729 self.handle_pay_route_err(e, payment_id, payment_hash, route, route_params, router, first_hops, inflight_htlcs, entropy_source, node_signer, best_block_height, logger, pending_events, send_payment_along_path);
733 fn handle_pay_route_err<R: Deref, NS: Deref, ES: Deref, IH, SP, L: Deref>(
734 &self, err: PaymentSendFailure, payment_id: PaymentId, payment_hash: PaymentHash, route: Route,
735 mut route_params: RouteParameters, router: &R, first_hops: Vec<ChannelDetails>,
736 inflight_htlcs: &IH, entropy_source: &ES, node_signer: &NS, best_block_height: u32, logger: &L,
737 pending_events: &Mutex<Vec<events::Event>>, send_payment_along_path: &SP,
741 ES::Target: EntropySource,
742 NS::Target: NodeSigner,
744 IH: Fn() -> InFlightHtlcs,
745 SP: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
746 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
749 PaymentSendFailure::AllFailedResendSafe(errs) => {
750 Self::push_path_failed_evs_and_scids(payment_id, payment_hash, &mut route_params, route.paths, errs.into_iter().map(|e| Err(e)), pending_events);
751 self.retry_payment_internal(payment_id, route_params, router, first_hops, inflight_htlcs, entropy_source, node_signer, best_block_height, logger, pending_events, send_payment_along_path);
753 PaymentSendFailure::PartialFailure { failed_paths_retry: Some(mut retry), results, .. } => {
754 Self::push_path_failed_evs_and_scids(payment_id, payment_hash, &mut retry, route.paths, results.into_iter(), pending_events);
755 // Some paths were sent, even if we failed to send the full MPP value our recipient may
756 // misbehave and claim the funds, at which point we have to consider the payment sent, so
757 // return `Ok()` here, ignoring any retry errors.
758 self.retry_payment_internal(payment_id, retry, router, first_hops, inflight_htlcs, entropy_source, node_signer, best_block_height, logger, pending_events, send_payment_along_path);
760 PaymentSendFailure::PartialFailure { failed_paths_retry: None, .. } => {
761 // This may happen if we send a payment and some paths fail, but only due to a temporary
762 // monitor failure or the like, implying they're really in-flight, but we haven't sent the
763 // initial HTLC-Add messages yet.
765 PaymentSendFailure::PathParameterError(results) => {
766 Self::push_path_failed_evs_and_scids(payment_id, payment_hash, &mut route_params, route.paths, results.into_iter(), pending_events);
767 self.abandon_payment(payment_id, pending_events);
769 PaymentSendFailure::ParameterError(e) => {
770 log_error!(logger, "Failed to send to route due to parameter error: {:?}. Your router is buggy", e);
771 self.abandon_payment(payment_id, pending_events);
773 PaymentSendFailure::DuplicatePayment => debug_assert!(false), // unreachable
777 fn push_path_failed_evs_and_scids<I: ExactSizeIterator + Iterator<Item = Result<(), APIError>>>(
778 payment_id: PaymentId, payment_hash: PaymentHash, route_params: &mut RouteParameters,
779 paths: Vec<Vec<RouteHop>>, path_results: I, pending_events: &Mutex<Vec<events::Event>>
781 let mut events = pending_events.lock().unwrap();
782 debug_assert_eq!(paths.len(), path_results.len());
783 for (path, path_res) in paths.into_iter().zip(path_results) {
784 if let Err(e) = path_res {
785 let failed_scid = if let APIError::InvalidRoute { .. } = e {
788 let scid = path[0].short_channel_id;
789 route_params.payment_params.previously_failed_channels.push(scid);
792 events.push(events::Event::PaymentPathFailed {
793 payment_id: Some(payment_id),
795 payment_failed_permanently: false,
796 network_update: None,
797 all_paths_failed: false,
799 short_channel_id: failed_scid,
810 pub(super) fn send_probe<ES: Deref, NS: Deref, F>(
811 &self, hops: Vec<RouteHop>, probing_cookie_secret: [u8; 32], entropy_source: &ES,
812 node_signer: &NS, best_block_height: u32, send_payment_along_path: F
813 ) -> Result<(PaymentHash, PaymentId), PaymentSendFailure>
815 ES::Target: EntropySource,
816 NS::Target: NodeSigner,
817 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
818 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
820 let payment_id = PaymentId(entropy_source.get_secure_random_bytes());
822 let payment_hash = probing_cookie_from_id(&payment_id, probing_cookie_secret);
825 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
826 err: "No need probing a path with less than two hops".to_string()
830 let route = Route { paths: vec![hops], payment_params: None };
831 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, None, &route, None, None, entropy_source, best_block_height)?;
833 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) {
834 Ok(()) => Ok((payment_hash, payment_id)),
836 self.remove_outbound_if_all_failed(payment_id, &e);
843 pub(super) fn test_add_new_pending_payment<ES: Deref>(
844 &self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId,
845 route: &Route, retry_strategy: Option<Retry>, entropy_source: &ES, best_block_height: u32
846 ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
847 self.add_new_pending_payment(payment_hash, payment_secret, payment_id, None, route, retry_strategy, None, entropy_source, best_block_height)
850 pub(super) fn add_new_pending_payment<ES: Deref>(
851 &self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId,
852 keysend_preimage: Option<PaymentPreimage>, route: &Route, retry_strategy: Option<Retry>,
853 payment_params: Option<PaymentParameters>, entropy_source: &ES, best_block_height: u32
854 ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
855 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
856 for _ in 0..route.paths.len() {
857 onion_session_privs.push(entropy_source.get_secure_random_bytes());
860 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
861 match pending_outbounds.entry(payment_id) {
862 hash_map::Entry::Occupied(_) => Err(PaymentSendFailure::DuplicatePayment),
863 hash_map::Entry::Vacant(entry) => {
864 let payment = entry.insert(PendingOutboundPayment::Retryable {
866 attempts: PaymentAttempts::new(),
868 session_privs: HashSet::new(),
870 pending_fee_msat: Some(0),
874 starting_block_height: best_block_height,
875 total_msat: route.get_total_amount(),
878 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
879 assert!(payment.insert(*session_priv_bytes, path));
882 Ok(onion_session_privs)
887 fn pay_route_internal<NS: Deref, F>(
888 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
889 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
890 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
891 send_payment_along_path: &F
892 ) -> Result<(), PaymentSendFailure>
894 NS::Target: NodeSigner,
895 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
896 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
898 if route.paths.len() < 1 {
899 return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
901 if payment_secret.is_none() && route.paths.len() > 1 {
902 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
904 let mut total_value = 0;
905 let our_node_id = node_signer.get_node_id(Recipient::Node).unwrap(); // TODO no unwrap
906 let mut path_errs = Vec::with_capacity(route.paths.len());
907 'path_check: for path in route.paths.iter() {
908 if path.len() < 1 || path.len() > 20 {
909 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
910 continue 'path_check;
912 for (idx, hop) in path.iter().enumerate() {
913 if idx != path.len() - 1 && hop.pubkey == our_node_id {
914 path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
915 continue 'path_check;
918 total_value += path.last().unwrap().fee_msat;
919 path_errs.push(Ok(()));
921 if path_errs.iter().any(|e| e.is_err()) {
922 return Err(PaymentSendFailure::PathParameterError(path_errs));
924 if let Some(amt_msat) = recv_value_msat {
925 debug_assert!(amt_msat >= total_value);
926 total_value = amt_msat;
929 let cur_height = best_block_height + 1;
930 let mut results = Vec::new();
931 debug_assert_eq!(route.paths.len(), onion_session_privs.len());
932 for (path, session_priv) in route.paths.iter().zip(onion_session_privs.into_iter()) {
933 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);
936 Err(APIError::MonitorUpdateInProgress) => {
937 // While a MonitorUpdateInProgress is an Err(_), the payment is still
938 // considered "in flight" and we shouldn't remove it from the
939 // PendingOutboundPayment set.
942 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
943 if let Some(payment) = pending_outbounds.get_mut(&payment_id) {
944 let removed = payment.remove(&session_priv, Some(path));
945 debug_assert!(removed, "This can't happen as the payment has an entry for this path added by callers");
947 debug_assert!(false, "This can't happen as the payment was added by callers");
948 path_res = Err(APIError::APIMisuseError { err: "Internal error: payment disappeared during processing. Please report this bug!".to_owned() });
952 results.push(path_res);
954 let mut has_ok = false;
955 let mut has_err = false;
956 let mut pending_amt_unsent = 0;
957 let mut max_unsent_cltv_delta = 0;
958 for (res, path) in results.iter().zip(route.paths.iter()) {
959 if res.is_ok() { has_ok = true; }
960 if res.is_err() { has_err = true; }
961 if let &Err(APIError::MonitorUpdateInProgress) = res {
962 // MonitorUpdateInProgress is inherently unsafe to retry, so we call it a
966 } else if res.is_err() {
967 pending_amt_unsent += path.last().unwrap().fee_msat;
968 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
971 if has_err && has_ok {
972 Err(PaymentSendFailure::PartialFailure {
975 failed_paths_retry: if pending_amt_unsent != 0 {
976 if let Some(payment_params) = &route.payment_params {
977 Some(RouteParameters {
978 payment_params: payment_params.clone(),
979 final_value_msat: pending_amt_unsent,
980 final_cltv_expiry_delta:
981 if let Some(delta) = payment_params.final_cltv_expiry_delta { delta }
982 else { max_unsent_cltv_delta },
988 Err(PaymentSendFailure::AllFailedResendSafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
995 pub(super) fn test_send_payment_internal<NS: Deref, F>(
996 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
997 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
998 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
999 send_payment_along_path: F
1000 ) -> Result<(), PaymentSendFailure>
1002 NS::Target: NodeSigner,
1003 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
1004 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
1006 self.pay_route_internal(route, payment_hash, payment_secret, keysend_preimage, payment_id,
1007 recv_value_msat, onion_session_privs, node_signer, best_block_height,
1008 &send_payment_along_path)
1009 .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
1012 // If we failed to send any paths, remove the new PaymentId from the `pending_outbound_payments`
1013 // map as the payment is free to be resent.
1014 fn remove_outbound_if_all_failed(&self, payment_id: PaymentId, err: &PaymentSendFailure) {
1015 if let &PaymentSendFailure::AllFailedResendSafe(_) = err {
1016 let removed = self.pending_outbound_payments.lock().unwrap().remove(&payment_id).is_some();
1017 debug_assert!(removed, "We should always have a pending payment to remove here");
1021 pub(super) fn claim_htlc<L: Deref>(
1022 &self, payment_id: PaymentId, payment_preimage: PaymentPreimage, session_priv: SecretKey,
1023 path: Vec<RouteHop>, from_onchain: bool, pending_events: &Mutex<Vec<events::Event>>, logger: &L
1024 ) where L::Target: Logger {
1025 let mut session_priv_bytes = [0; 32];
1026 session_priv_bytes.copy_from_slice(&session_priv[..]);
1027 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1028 let mut pending_events = pending_events.lock().unwrap();
1029 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
1030 if !payment.get().is_fulfilled() {
1031 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1032 let fee_paid_msat = payment.get().get_pending_fee_msat();
1033 pending_events.push(
1034 events::Event::PaymentSent {
1035 payment_id: Some(payment_id),
1041 payment.get_mut().mark_fulfilled();
1045 // We currently immediately remove HTLCs which were fulfilled on-chain.
1046 // This could potentially lead to removing a pending payment too early,
1047 // with a reorg of one block causing us to re-add the fulfilled payment on
1049 // TODO: We should have a second monitor event that informs us of payments
1050 // irrevocably fulfilled.
1051 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
1052 let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
1053 pending_events.push(
1054 events::Event::PaymentPathSuccessful {
1063 log_trace!(logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
1067 pub(super) fn finalize_claims(&self, sources: Vec<HTLCSource>, pending_events: &Mutex<Vec<events::Event>>) {
1068 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1069 let mut pending_events = pending_events.lock().unwrap();
1070 for source in sources {
1071 if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
1072 let mut session_priv_bytes = [0; 32];
1073 session_priv_bytes.copy_from_slice(&session_priv[..]);
1074 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
1075 assert!(payment.get().is_fulfilled());
1076 if payment.get_mut().remove(&session_priv_bytes, None) {
1077 pending_events.push(
1078 events::Event::PaymentPathSuccessful {
1080 payment_hash: payment.get().payment_hash(),
1090 pub(super) fn remove_stale_resolved_payments(&self, pending_events: &Mutex<Vec<events::Event>>) {
1091 // If an outbound payment was completed, and no pending HTLCs remain, we should remove it
1092 // from the map. However, if we did that immediately when the last payment HTLC is claimed,
1093 // this could race the user making a duplicate send_payment call and our idempotency
1094 // guarantees would be violated. Instead, we wait a few timer ticks to do the actual
1095 // removal. This should be more than sufficient to ensure the idempotency of any
1096 // `send_payment` calls that were made at the same time the `PaymentSent` event was being
1098 let mut pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
1099 let pending_events = pending_events.lock().unwrap();
1100 pending_outbound_payments.retain(|payment_id, payment| {
1101 if let PendingOutboundPayment::Fulfilled { session_privs, timer_ticks_without_htlcs, .. } = payment {
1102 let mut no_remaining_entries = session_privs.is_empty();
1103 if no_remaining_entries {
1104 for ev in pending_events.iter() {
1106 events::Event::PaymentSent { payment_id: Some(ev_payment_id), .. } |
1107 events::Event::PaymentPathSuccessful { payment_id: ev_payment_id, .. } |
1108 events::Event::PaymentPathFailed { payment_id: Some(ev_payment_id), .. } => {
1109 if payment_id == ev_payment_id {
1110 no_remaining_entries = false;
1118 if no_remaining_entries {
1119 *timer_ticks_without_htlcs += 1;
1120 *timer_ticks_without_htlcs <= IDEMPOTENCY_TIMEOUT_TICKS
1122 *timer_ticks_without_htlcs = 0;
1129 // Returns a bool indicating whether a PendingHTLCsForwardable event should be generated.
1130 pub(super) fn fail_htlc<L: Deref>(
1131 &self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason,
1132 path: &Vec<RouteHop>, session_priv: &SecretKey, payment_id: &PaymentId,
1133 payment_params: &Option<PaymentParameters>, probing_cookie_secret: [u8; 32],
1134 secp_ctx: &Secp256k1<secp256k1::All>, pending_events: &Mutex<Vec<events::Event>>, logger: &L
1135 ) -> bool where L::Target: Logger {
1137 let (network_update, short_channel_id, payment_retryable, onion_error_code, onion_error_data) = onion_error.decode_onion_failure(secp_ctx, logger, &source);
1139 let (network_update, short_channel_id, payment_retryable, _, _) = onion_error.decode_onion_failure(secp_ctx, logger, &source);
1141 let payment_is_probe = payment_is_probe(payment_hash, &payment_id, probing_cookie_secret);
1142 let mut session_priv_bytes = [0; 32];
1143 session_priv_bytes.copy_from_slice(&session_priv[..]);
1144 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1146 // If any payments already need retry, there's no need to generate a redundant
1147 // `PendingHTLCsForwardable`.
1148 let already_awaiting_retry = outbounds.iter().any(|(_, pmt)| {
1149 let mut awaiting_retry = false;
1150 if pmt.is_auto_retryable_now() {
1151 if let PendingOutboundPayment::Retryable { pending_amt_msat, total_msat, .. } = pmt {
1152 if pending_amt_msat < total_msat {
1153 awaiting_retry = true;
1160 let mut all_paths_failed = false;
1161 let mut full_failure_ev = None;
1162 let mut pending_retry_ev = false;
1163 let mut retry = None;
1164 let attempts_remaining = if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(*payment_id) {
1165 if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
1166 log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1169 if payment.get().is_fulfilled() {
1170 log_trace!(logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
1173 let mut is_retryable_now = payment.get().is_auto_retryable_now();
1174 if let Some(scid) = short_channel_id {
1175 payment.get_mut().insert_previously_failed_scid(scid);
1178 // We want to move towards only using the `PaymentParameters` in the outbound payments
1179 // map. However, for backwards-compatibility, we still need to support passing the
1180 // `PaymentParameters` data that was shoved in the HTLC (and given to us via
1181 // `payment_params`) back to the user.
1182 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
1183 if let Some(params) = payment.get_mut().payment_parameters() {
1184 if params.final_cltv_expiry_delta.is_none() {
1185 // This should be rare, but a user could provide None for the payment data, and
1186 // we need it when we go to retry the payment, so fill it in.
1187 params.final_cltv_expiry_delta = Some(path_last_hop.cltv_expiry_delta);
1189 retry = Some(RouteParameters {
1190 payment_params: params.clone(),
1191 final_value_msat: path_last_hop.fee_msat,
1192 final_cltv_expiry_delta: params.final_cltv_expiry_delta.unwrap(),
1194 } else if let Some(params) = payment_params {
1195 retry = Some(RouteParameters {
1196 payment_params: params.clone(),
1197 final_value_msat: path_last_hop.fee_msat,
1198 final_cltv_expiry_delta:
1199 if let Some(delta) = params.final_cltv_expiry_delta { delta }
1200 else { path_last_hop.cltv_expiry_delta },
1204 if payment_is_probe || !is_retryable_now || !payment_retryable || retry.is_none() {
1205 let _ = payment.get_mut().mark_abandoned(); // we'll only Err if it's a legacy payment
1206 is_retryable_now = false;
1208 if payment.get().remaining_parts() == 0 {
1209 all_paths_failed = true;
1210 if payment.get().abandoned() {
1211 if !payment_is_probe {
1212 full_failure_ev = Some(events::Event::PaymentFailed {
1213 payment_id: *payment_id,
1214 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
1222 log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1225 core::mem::drop(outbounds);
1226 log_trace!(logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1228 let path_failure = {
1229 if payment_is_probe {
1230 if !payment_retryable {
1231 events::Event::ProbeSuccessful {
1232 payment_id: *payment_id,
1233 payment_hash: payment_hash.clone(),
1237 events::Event::ProbeFailed {
1238 payment_id: *payment_id,
1239 payment_hash: payment_hash.clone(),
1245 // TODO: If we decided to blame ourselves (or one of our channels) in
1246 // process_onion_failure we should close that channel as it implies our
1247 // next-hop is needlessly blaming us!
1248 if let Some(scid) = short_channel_id {
1249 retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
1251 // If we miss abandoning the payment above, we *must* generate an event here or else the
1252 // payment will sit in our outbounds forever.
1253 if attempts_remaining && !already_awaiting_retry {
1254 debug_assert!(full_failure_ev.is_none());
1255 pending_retry_ev = true;
1257 events::Event::PaymentPathFailed {
1258 payment_id: Some(*payment_id),
1259 payment_hash: payment_hash.clone(),
1260 payment_failed_permanently: !payment_retryable,
1267 error_code: onion_error_code,
1269 error_data: onion_error_data
1273 let mut pending_events = pending_events.lock().unwrap();
1274 pending_events.push(path_failure);
1275 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
1279 pub(super) fn abandon_payment(
1280 &self, payment_id: PaymentId, pending_events: &Mutex<Vec<events::Event>>
1282 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1283 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
1284 if let Ok(()) = payment.get_mut().mark_abandoned() {
1285 if payment.get().remaining_parts() == 0 {
1286 pending_events.lock().unwrap().push(events::Event::PaymentFailed {
1288 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
1297 pub fn has_pending_payments(&self) -> bool {
1298 !self.pending_outbound_payments.lock().unwrap().is_empty()
1302 pub fn clear_pending_payments(&self) {
1303 self.pending_outbound_payments.lock().unwrap().clear()
1307 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
1309 pub(super) fn payment_is_probe(payment_hash: &PaymentHash, payment_id: &PaymentId,
1310 probing_cookie_secret: [u8; 32]) -> bool
1312 let target_payment_hash = probing_cookie_from_id(payment_id, probing_cookie_secret);
1313 target_payment_hash == *payment_hash
1316 /// Returns the 'probing cookie' for the given [`PaymentId`].
1317 fn probing_cookie_from_id(payment_id: &PaymentId, probing_cookie_secret: [u8; 32]) -> PaymentHash {
1318 let mut preimage = [0u8; 64];
1319 preimage[..32].copy_from_slice(&probing_cookie_secret);
1320 preimage[32..].copy_from_slice(&payment_id.0);
1321 PaymentHash(Sha256::hash(&preimage).into_inner())
1324 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
1326 (0, session_privs, required),
1329 (0, session_privs, required),
1330 (1, payment_hash, option),
1331 (3, timer_ticks_without_htlcs, (default_value, 0)),
1334 (0, session_privs, required),
1335 (1, pending_fee_msat, option),
1336 (2, payment_hash, required),
1337 (3, payment_params, option),
1338 (4, payment_secret, option),
1339 (5, keysend_preimage, option),
1340 (6, total_msat, required),
1341 (8, pending_amt_msat, required),
1342 (10, starting_block_height, required),
1343 (not_written, retry_strategy, (static_value, None)),
1344 (not_written, attempts, (static_value, PaymentAttempts::new())),
1347 (0, session_privs, required),
1348 (2, payment_hash, required),
1354 use bitcoin::blockdata::constants::genesis_block;
1355 use bitcoin::network::constants::Network;
1356 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
1358 use crate::ln::PaymentHash;
1359 use crate::ln::channelmanager::PaymentId;
1360 use crate::ln::msgs::{ErrorAction, LightningError};
1361 use crate::ln::outbound_payment::{OutboundPayments, Retry, RetryableSendFailure};
1362 use crate::routing::gossip::NetworkGraph;
1363 use crate::routing::router::{InFlightHtlcs, PaymentParameters, Route, RouteParameters};
1364 use crate::sync::{Arc, Mutex};
1365 use crate::util::events::Event;
1366 use crate::util::test_utils;
1369 #[cfg(feature = "std")]
1370 fn fails_paying_after_expiration() {
1371 do_fails_paying_after_expiration(false);
1372 do_fails_paying_after_expiration(true);
1374 #[cfg(feature = "std")]
1375 fn do_fails_paying_after_expiration(on_retry: bool) {
1376 let outbound_payments = OutboundPayments::new();
1377 let logger = test_utils::TestLogger::new();
1378 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
1379 let network_graph = Arc::new(NetworkGraph::new(genesis_hash, &logger));
1380 let scorer = Mutex::new(test_utils::TestScorer::new());
1381 let router = test_utils::TestRouter::new(network_graph, &scorer);
1382 let secp_ctx = Secp256k1::new();
1383 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1385 let past_expiry_time = std::time::SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() - 2;
1386 let payment_params = PaymentParameters::from_node_id(
1387 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()),
1389 ).with_expiry_time(past_expiry_time);
1390 let expired_route_params = RouteParameters {
1392 final_value_msat: 0,
1393 final_cltv_expiry_delta: 0,
1395 let pending_events = Mutex::new(Vec::new());
1397 outbound_payments.add_new_pending_payment(PaymentHash([0; 32]), None, PaymentId([0; 32]), None,
1398 &Route { paths: vec![], payment_params: None }, Some(Retry::Attempts(1)),
1399 Some(expired_route_params.payment_params.clone()), &&keys_manager, 0).unwrap();
1400 outbound_payments.retry_payment_internal(
1401 PaymentId([0; 32]), expired_route_params, &&router, vec![], &|| InFlightHtlcs::new(),
1402 &&keys_manager, &&keys_manager, 0, &&logger, &pending_events,
1403 &|_, _, _, _, _, _, _, _, _| Ok(()));
1404 let events = pending_events.lock().unwrap();
1405 assert_eq!(events.len(), 1);
1406 if let Event::PaymentFailed { .. } = events[0] { } else { panic!("Unexpected event"); }
1408 let err = outbound_payments.send_payment(
1409 PaymentHash([0; 32]), &None, PaymentId([0; 32]), Retry::Attempts(0), expired_route_params,
1410 &&router, vec![], || InFlightHtlcs::new(), &&keys_manager, &&keys_manager, 0, &&logger,
1411 &pending_events, |_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err();
1412 if let RetryableSendFailure::PaymentExpired = err { } else { panic!("Unexpected error"); }
1417 fn find_route_error() {
1418 do_find_route_error(false);
1419 do_find_route_error(true);
1421 fn do_find_route_error(on_retry: bool) {
1422 let outbound_payments = OutboundPayments::new();
1423 let logger = test_utils::TestLogger::new();
1424 let genesis_hash = genesis_block(Network::Testnet).header.block_hash();
1425 let network_graph = Arc::new(NetworkGraph::new(genesis_hash, &logger));
1426 let scorer = Mutex::new(test_utils::TestScorer::new());
1427 let router = test_utils::TestRouter::new(network_graph, &scorer);
1428 let secp_ctx = Secp256k1::new();
1429 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1431 let payment_params = PaymentParameters::from_node_id(
1432 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()), 0);
1433 let route_params = RouteParameters {
1435 final_value_msat: 0,
1436 final_cltv_expiry_delta: 0,
1438 router.expect_find_route(route_params.clone(),
1439 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
1441 let pending_events = Mutex::new(Vec::new());
1443 outbound_payments.add_new_pending_payment(PaymentHash([0; 32]), None, PaymentId([0; 32]), None,
1444 &Route { paths: vec![], payment_params: None }, Some(Retry::Attempts(1)),
1445 Some(route_params.payment_params.clone()), &&keys_manager, 0).unwrap();
1446 outbound_payments.retry_payment_internal(
1447 PaymentId([0; 32]), route_params, &&router, vec![], &|| InFlightHtlcs::new(),
1448 &&keys_manager, &&keys_manager, 0, &&logger, &pending_events,
1449 &|_, _, _, _, _, _, _, _, _| Ok(()));
1450 let events = pending_events.lock().unwrap();
1451 assert_eq!(events.len(), 1);
1452 if let Event::PaymentFailed { .. } = events[0] { } else { panic!("Unexpected event"); }
1454 let err = outbound_payments.send_payment(
1455 PaymentHash([0; 32]), &None, PaymentId([0; 32]), Retry::Attempts(0), route_params,
1456 &&router, vec![], || InFlightHtlcs::new(), &&keys_manager, &&keys_manager, 0, &&logger,
1457 &pending_events, |_, _, _, _, _, _, _, _, _| Ok(())).unwrap_err();
1458 if let RetryableSendFailure::RouteNotFound = err {
1459 } else { panic!("Unexpected error"); }