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::{HTLCSource, IDEMPOTENCY_TIMEOUT_TICKS, PaymentId};
19 use crate::ln::msgs::DecodeError;
20 use crate::ln::onion_utils::HTLCFailReason;
21 use crate::routing::router::{PaymentParameters, Route, RouteHop, RouteParameters, RoutePath};
22 use crate::util::errors::APIError;
23 use crate::util::events;
24 use crate::util::logger::Logger;
25 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 session_privs: HashSet<[u8; 32]>,
44 payment_hash: PaymentHash,
45 payment_secret: Option<PaymentSecret>,
46 pending_amt_msat: u64,
47 /// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
48 pending_fee_msat: Option<u64>,
49 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
51 /// Our best known block height at the time this payment was initiated.
52 starting_block_height: u32,
54 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
55 /// been resolved. This ensures we don't look up pending payments in ChannelMonitors on restart
56 /// and add a pending payment that was already fulfilled.
58 session_privs: HashSet<[u8; 32]>,
59 payment_hash: Option<PaymentHash>,
60 timer_ticks_without_htlcs: u8,
62 /// When a payer gives up trying to retry a payment, they inform us, letting us generate a
63 /// `PaymentFailed` event when all HTLCs have irrevocably failed. This avoids a number of race
64 /// conditions in MPP-aware payment retriers (1), where the possibility of multiple
65 /// `PaymentPathFailed` events with `all_paths_failed` can be pending at once, confusing a
66 /// downstream event handler as to when a payment has actually failed.
68 /// (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
70 session_privs: HashSet<[u8; 32]>,
71 payment_hash: PaymentHash,
75 impl PendingOutboundPayment {
76 pub(super) fn is_fulfilled(&self) -> bool {
78 PendingOutboundPayment::Fulfilled { .. } => true,
82 pub(super) fn abandoned(&self) -> bool {
84 PendingOutboundPayment::Abandoned { .. } => true,
88 fn get_pending_fee_msat(&self) -> Option<u64> {
90 PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
95 fn payment_hash(&self) -> Option<PaymentHash> {
97 PendingOutboundPayment::Legacy { .. } => None,
98 PendingOutboundPayment::Retryable { payment_hash, .. } => Some(*payment_hash),
99 PendingOutboundPayment::Fulfilled { payment_hash, .. } => *payment_hash,
100 PendingOutboundPayment::Abandoned { payment_hash, .. } => Some(*payment_hash),
104 fn mark_fulfilled(&mut self) {
105 let mut session_privs = HashSet::new();
106 core::mem::swap(&mut session_privs, match self {
107 PendingOutboundPayment::Legacy { session_privs } |
108 PendingOutboundPayment::Retryable { session_privs, .. } |
109 PendingOutboundPayment::Fulfilled { session_privs, .. } |
110 PendingOutboundPayment::Abandoned { session_privs, .. }
113 let payment_hash = self.payment_hash();
114 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash, timer_ticks_without_htlcs: 0 };
117 fn mark_abandoned(&mut self) -> Result<(), ()> {
118 let mut session_privs = HashSet::new();
119 let our_payment_hash;
120 core::mem::swap(&mut session_privs, match self {
121 PendingOutboundPayment::Legacy { .. } |
122 PendingOutboundPayment::Fulfilled { .. } =>
124 PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } |
125 PendingOutboundPayment::Abandoned { session_privs, payment_hash, .. } => {
126 our_payment_hash = *payment_hash;
130 *self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
134 /// panics if path is None and !self.is_fulfilled
135 fn remove(&mut self, session_priv: &[u8; 32], path: Option<&Vec<RouteHop>>) -> bool {
136 let remove_res = match self {
137 PendingOutboundPayment::Legacy { session_privs } |
138 PendingOutboundPayment::Retryable { session_privs, .. } |
139 PendingOutboundPayment::Fulfilled { session_privs, .. } |
140 PendingOutboundPayment::Abandoned { session_privs, .. } => {
141 session_privs.remove(session_priv)
145 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
146 let path = path.expect("Fulfilling a payment should always come with a path");
147 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
148 *pending_amt_msat -= path_last_hop.fee_msat;
149 if let Some(fee_msat) = pending_fee_msat.as_mut() {
150 *fee_msat -= path.get_path_fees();
157 pub(super) fn insert(&mut self, session_priv: [u8; 32], path: &Vec<RouteHop>) -> bool {
158 let insert_res = match self {
159 PendingOutboundPayment::Legacy { session_privs } |
160 PendingOutboundPayment::Retryable { session_privs, .. } => {
161 session_privs.insert(session_priv)
163 PendingOutboundPayment::Fulfilled { .. } => false,
164 PendingOutboundPayment::Abandoned { .. } => false,
167 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
168 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
169 *pending_amt_msat += path_last_hop.fee_msat;
170 if let Some(fee_msat) = pending_fee_msat.as_mut() {
171 *fee_msat += path.get_path_fees();
178 pub(super) fn remaining_parts(&self) -> usize {
180 PendingOutboundPayment::Legacy { session_privs } |
181 PendingOutboundPayment::Retryable { session_privs, .. } |
182 PendingOutboundPayment::Fulfilled { session_privs, .. } |
183 PendingOutboundPayment::Abandoned { session_privs, .. } => {
190 /// Strategies available to retry payment path failures.
191 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
193 /// Max number of attempts to retry payment.
195 /// Note that this is the number of *path* failures, not full payment retries. For multi-path
196 /// payments, if this is less than the total number of paths, we will never even retry all of the
199 #[cfg(not(feature = "no-std"))]
200 /// Time elapsed before abandoning retries for a payment.
201 Timeout(core::time::Duration),
205 pub(crate) fn is_retryable_now(&self, attempts: &PaymentAttempts) -> bool {
206 match (self, attempts) {
207 (Retry::Attempts(max_retry_count), PaymentAttempts { count, .. }) => {
208 max_retry_count > count
210 #[cfg(all(not(feature = "no-std"), not(test)))]
211 (Retry::Timeout(max_duration), PaymentAttempts { first_attempted_at, .. }) =>
212 *max_duration >= std::time::Instant::now().duration_since(*first_attempted_at),
213 #[cfg(all(not(feature = "no-std"), test))]
214 (Retry::Timeout(max_duration), PaymentAttempts { first_attempted_at, .. }) =>
215 *max_duration >= SinceEpoch::now().duration_since(*first_attempted_at),
220 pub(crate) type PaymentAttempts = PaymentAttemptsUsingTime<ConfiguredTime>;
222 /// Storing minimal payment attempts information required for determining if a outbound payment can
224 pub(crate) struct PaymentAttemptsUsingTime<T: Time> {
225 /// This count will be incremented only after the result of the attempt is known. When it's 0,
226 /// it means the result of the first attempt is not known yet.
227 pub(crate) count: usize,
228 /// This field is only used when retry is `Retry::Timeout` which is only build with feature std
229 first_attempted_at: T
232 #[cfg(not(any(feature = "no-std", test)))]
233 type ConfiguredTime = std::time::Instant;
234 #[cfg(feature = "no-std")]
235 type ConfiguredTime = crate::util::time::Eternity;
236 #[cfg(all(not(feature = "no-std"), test))]
237 type ConfiguredTime = SinceEpoch;
239 impl<T: Time> PaymentAttemptsUsingTime<T> {
240 pub(crate) fn new() -> Self {
241 PaymentAttemptsUsingTime {
243 first_attempted_at: T::now()
248 impl<T: Time> Display for PaymentAttemptsUsingTime<T> {
249 fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
250 #[cfg(feature = "no-std")]
251 return write!(f, "attempts: {}", self.count);
252 #[cfg(not(feature = "no-std"))]
255 "attempts: {}, duration: {}s",
257 T::now().duration_since(self.first_attempted_at).as_secs()
262 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
263 /// Err() type describing which state the payment is in, see the description of individual enum
265 #[derive(Clone, Debug)]
266 pub enum PaymentSendFailure {
267 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
268 /// send the payment at all.
270 /// You can freely resend the payment in full (with the parameter error fixed).
272 /// Because the payment failed outright, no payment tracking is done, you do not need to call
273 /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
274 /// for this payment.
276 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
277 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
278 ParameterError(APIError),
279 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
280 /// from attempting to send the payment at all.
282 /// You can freely resend the payment in full (with the parameter error fixed).
284 /// The results here are ordered the same as the paths in the route object which was passed to
287 /// Because the payment failed outright, no payment tracking is done, you do not need to call
288 /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
289 /// for this payment.
291 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
292 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
293 PathParameterError(Vec<Result<(), APIError>>),
294 /// All paths which were attempted failed to send, with no channel state change taking place.
295 /// You can freely resend the payment in full (though you probably want to do so over different
296 /// paths than the ones selected).
298 /// Because the payment failed outright, no payment tracking is done, you do not need to call
299 /// [`ChannelManager::abandon_payment`] and [`ChannelManager::retry_payment`] will *not* work
300 /// for this payment.
302 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
303 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
304 AllFailedResendSafe(Vec<APIError>),
305 /// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
306 /// yet completed (i.e. generated an [`Event::PaymentSent`]) or been abandoned (via
307 /// [`ChannelManager::abandon_payment`]).
309 /// [`PaymentId`]: crate::ln::channelmanager::PaymentId
310 /// [`Event::PaymentSent`]: crate::util::events::Event::PaymentSent
311 /// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
313 /// Some paths which were attempted failed to send, though possibly not all. At least some
314 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
315 /// in over-/re-payment.
317 /// The results here are ordered the same as the paths in the route object which was passed to
318 /// send_payment, and any `Err`s which are not [`APIError::MonitorUpdateInProgress`] can be
319 /// safely retried via [`ChannelManager::retry_payment`].
321 /// Any entries which contain `Err(APIError::MonitorUpdateInprogress)` or `Ok(())` MUST NOT be
322 /// retried as they will result in over-/re-payment. These HTLCs all either successfully sent
323 /// (in the case of `Ok(())`) or will send once a [`MonitorEvent::Completed`] is provided for
324 /// the next-hop channel with the latest update_id.
326 /// [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
327 /// [`MonitorEvent::Completed`]: crate::chain::channelmonitor::MonitorEvent::Completed
329 /// The errors themselves, in the same order as the route hops.
330 results: Vec<Result<(), APIError>>,
331 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
332 /// contain a [`RouteParameters`] object which can be used to calculate a new route that
333 /// will pay all remaining unpaid balance.
334 failed_paths_retry: Option<RouteParameters>,
335 /// The payment id for the payment, which is now at least partially pending.
336 payment_id: PaymentId,
340 pub(super) struct OutboundPayments {
341 pub(super) pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
344 impl OutboundPayments {
345 pub(super) fn new() -> Self {
347 pending_outbound_payments: Mutex::new(HashMap::new())
351 pub(super) fn send_payment_with_route<ES: Deref, NS: Deref, F>(
352 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
353 payment_id: PaymentId, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
354 send_payment_along_path: F
355 ) -> Result<(), PaymentSendFailure>
357 ES::Target: EntropySource,
358 NS::Target: NodeSigner,
359 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
360 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
362 let onion_session_privs = self.add_new_pending_payment(payment_hash, *payment_secret, payment_id, route, Retry::Attempts(0), None, entropy_source, best_block_height)?;
363 self.send_payment_internal(route, payment_hash, payment_secret, None, payment_id, None, onion_session_privs, node_signer, best_block_height, send_payment_along_path)
366 pub(super) fn send_spontaneous_payment<ES: Deref, NS: Deref, F>(
367 &self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId,
368 entropy_source: &ES, node_signer: &NS, best_block_height: u32, send_payment_along_path: F
369 ) -> Result<PaymentHash, PaymentSendFailure>
371 ES::Target: EntropySource,
372 NS::Target: NodeSigner,
373 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
374 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
376 let preimage = match payment_preimage {
378 None => PaymentPreimage(entropy_source.get_secure_random_bytes()),
380 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
381 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, &route, Retry::Attempts(0), None, entropy_source, best_block_height)?;
383 match self.send_payment_internal(route, payment_hash, &None, Some(preimage), payment_id, None, onion_session_privs, node_signer, best_block_height, send_payment_along_path) {
384 Ok(()) => Ok(payment_hash),
389 pub(super) fn retry_payment_with_route<ES: Deref, NS: Deref, F>(
390 &self, route: &Route, payment_id: PaymentId, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
391 send_payment_along_path: F
392 ) -> Result<(), PaymentSendFailure>
394 ES::Target: EntropySource,
395 NS::Target: NodeSigner,
396 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
397 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
399 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
400 for path in route.paths.iter() {
402 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
403 err: "length-0 path in route".to_string()
408 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
409 for _ in 0..route.paths.len() {
410 onion_session_privs.push(entropy_source.get_secure_random_bytes());
413 let (total_msat, payment_hash, payment_secret) = {
414 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
415 match outbounds.get_mut(&payment_id) {
417 let res = match payment {
418 PendingOutboundPayment::Retryable {
419 total_msat, payment_hash, payment_secret, pending_amt_msat, ..
421 let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
422 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
423 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
424 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()
427 (*total_msat, *payment_hash, *payment_secret)
429 PendingOutboundPayment::Legacy { .. } => {
430 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
431 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
434 PendingOutboundPayment::Fulfilled { .. } => {
435 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
436 err: "Payment already completed".to_owned()
439 PendingOutboundPayment::Abandoned { .. } => {
440 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
441 err: "Payment already abandoned (with some HTLCs still pending)".to_owned()
445 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
446 assert!(payment.insert(*session_priv_bytes, path));
451 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
452 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
456 self.send_payment_internal(route, payment_hash, &payment_secret, None, payment_id, Some(total_msat), onion_session_privs, node_signer, best_block_height, send_payment_along_path)
459 pub(super) fn send_probe<ES: Deref, NS: Deref, F>(
460 &self, hops: Vec<RouteHop>, probing_cookie_secret: [u8; 32], entropy_source: &ES,
461 node_signer: &NS, best_block_height: u32, send_payment_along_path: F
462 ) -> Result<(PaymentHash, PaymentId), PaymentSendFailure>
464 ES::Target: EntropySource,
465 NS::Target: NodeSigner,
466 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
467 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
469 let payment_id = PaymentId(entropy_source.get_secure_random_bytes());
471 let payment_hash = probing_cookie_from_id(&payment_id, probing_cookie_secret);
474 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
475 err: "No need probing a path with less than two hops".to_string()
479 let route = Route { paths: vec![hops], payment_params: None };
480 let onion_session_privs = self.add_new_pending_payment(payment_hash, None, payment_id, &route, Retry::Attempts(0), None, entropy_source, best_block_height)?;
482 match self.send_payment_internal(&route, payment_hash, &None, None, payment_id, None, onion_session_privs, node_signer, best_block_height, send_payment_along_path) {
483 Ok(()) => Ok((payment_hash, payment_id)),
489 pub(super) fn test_add_new_pending_payment<ES: Deref>(
490 &self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId,
491 route: &Route, retry_strategy: Retry, entropy_source: &ES, best_block_height: u32
492 ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
493 self.add_new_pending_payment(payment_hash, payment_secret, payment_id, route, retry_strategy, None, entropy_source, best_block_height)
496 pub(super) fn add_new_pending_payment<ES: Deref>(
497 &self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId,
498 route: &Route, retry_strategy: Retry, route_params: Option<RouteParameters>,
499 entropy_source: &ES, best_block_height: u32
500 ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
501 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
502 for _ in 0..route.paths.len() {
503 onion_session_privs.push(entropy_source.get_secure_random_bytes());
506 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
507 match pending_outbounds.entry(payment_id) {
508 hash_map::Entry::Occupied(_) => Err(PaymentSendFailure::DuplicatePayment),
509 hash_map::Entry::Vacant(entry) => {
510 let payment = entry.insert(PendingOutboundPayment::Retryable {
511 session_privs: HashSet::new(),
513 pending_fee_msat: Some(0),
516 starting_block_height: best_block_height,
517 total_msat: route.get_total_amount(),
520 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
521 assert!(payment.insert(*session_priv_bytes, path));
524 Ok(onion_session_privs)
529 fn send_payment_internal<NS: Deref, F>(
530 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
531 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
532 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
533 send_payment_along_path: F
534 ) -> Result<(), PaymentSendFailure>
536 NS::Target: NodeSigner,
537 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
538 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
540 if route.paths.len() < 1 {
541 return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over"}));
543 if payment_secret.is_none() && route.paths.len() > 1 {
544 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
546 let mut total_value = 0;
547 let our_node_id = node_signer.get_node_id(Recipient::Node).unwrap(); // TODO no unwrap
548 let mut path_errs = Vec::with_capacity(route.paths.len());
549 'path_check: for path in route.paths.iter() {
550 if path.len() < 1 || path.len() > 20 {
551 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size"}));
552 continue 'path_check;
554 for (idx, hop) in path.iter().enumerate() {
555 if idx != path.len() - 1 && hop.pubkey == our_node_id {
556 path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us"}));
557 continue 'path_check;
560 total_value += path.last().unwrap().fee_msat;
561 path_errs.push(Ok(()));
563 if path_errs.iter().any(|e| e.is_err()) {
564 return Err(PaymentSendFailure::PathParameterError(path_errs));
566 if let Some(amt_msat) = recv_value_msat {
567 debug_assert!(amt_msat >= total_value);
568 total_value = amt_msat;
571 let cur_height = best_block_height + 1;
572 let mut results = Vec::new();
573 debug_assert_eq!(route.paths.len(), onion_session_privs.len());
574 for (path, session_priv) in route.paths.iter().zip(onion_session_privs.into_iter()) {
575 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);
578 Err(APIError::MonitorUpdateInProgress) => {
579 // While a MonitorUpdateInProgress is an Err(_), the payment is still
580 // considered "in flight" and we shouldn't remove it from the
581 // PendingOutboundPayment set.
584 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
585 if let Some(payment) = pending_outbounds.get_mut(&payment_id) {
586 let removed = payment.remove(&session_priv, Some(path));
587 debug_assert!(removed, "This can't happen as the payment has an entry for this path added by callers");
589 debug_assert!(false, "This can't happen as the payment was added by callers");
590 path_res = Err(APIError::APIMisuseError { err: "Internal error: payment disappeared during processing. Please report this bug!".to_owned() });
594 results.push(path_res);
596 let mut has_ok = false;
597 let mut has_err = false;
598 let mut pending_amt_unsent = 0;
599 let mut max_unsent_cltv_delta = 0;
600 for (res, path) in results.iter().zip(route.paths.iter()) {
601 if res.is_ok() { has_ok = true; }
602 if res.is_err() { has_err = true; }
603 if let &Err(APIError::MonitorUpdateInProgress) = res {
604 // MonitorUpdateInProgress is inherently unsafe to retry, so we call it a
608 } else if res.is_err() {
609 pending_amt_unsent += path.last().unwrap().fee_msat;
610 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
613 if has_err && has_ok {
614 Err(PaymentSendFailure::PartialFailure {
617 failed_paths_retry: if pending_amt_unsent != 0 {
618 if let Some(payment_params) = &route.payment_params {
619 Some(RouteParameters {
620 payment_params: payment_params.clone(),
621 final_value_msat: pending_amt_unsent,
622 final_cltv_expiry_delta: max_unsent_cltv_delta,
628 // If we failed to send any paths, we should remove the new PaymentId from the
629 // `pending_outbound_payments` map, as the user isn't expected to `abandon_payment`.
630 let removed = self.pending_outbound_payments.lock().unwrap().remove(&payment_id).is_some();
631 debug_assert!(removed, "We should always have a pending payment to remove here");
632 Err(PaymentSendFailure::AllFailedResendSafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
639 pub(super) fn test_send_payment_internal<NS: Deref, F>(
640 &self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>,
641 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
642 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
643 send_payment_along_path: F
644 ) -> Result<(), PaymentSendFailure>
646 NS::Target: NodeSigner,
647 F: Fn(&Vec<RouteHop>, &Option<PaymentParameters>, &PaymentHash, &Option<PaymentSecret>, u64,
648 u32, PaymentId, &Option<PaymentPreimage>, [u8; 32]) -> Result<(), APIError>
650 self.send_payment_internal(route, payment_hash, payment_secret, keysend_preimage, payment_id,
651 recv_value_msat, onion_session_privs, node_signer, best_block_height,
652 send_payment_along_path)
655 pub(super) fn claim_htlc<L: Deref>(
656 &self, payment_id: PaymentId, payment_preimage: PaymentPreimage, session_priv: SecretKey,
657 path: Vec<RouteHop>, from_onchain: bool, pending_events: &Mutex<Vec<events::Event>>, logger: &L
658 ) where L::Target: Logger {
659 let mut session_priv_bytes = [0; 32];
660 session_priv_bytes.copy_from_slice(&session_priv[..]);
661 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
662 let mut pending_events = pending_events.lock().unwrap();
663 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
664 if !payment.get().is_fulfilled() {
665 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
666 let fee_paid_msat = payment.get().get_pending_fee_msat();
668 events::Event::PaymentSent {
669 payment_id: Some(payment_id),
675 payment.get_mut().mark_fulfilled();
679 // We currently immediately remove HTLCs which were fulfilled on-chain.
680 // This could potentially lead to removing a pending payment too early,
681 // with a reorg of one block causing us to re-add the fulfilled payment on
683 // TODO: We should have a second monitor event that informs us of payments
684 // irrevocably fulfilled.
685 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
686 let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
688 events::Event::PaymentPathSuccessful {
697 log_trace!(logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
701 pub(super) fn finalize_claims(&self, sources: Vec<HTLCSource>, pending_events: &Mutex<Vec<events::Event>>) {
702 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
703 let mut pending_events = pending_events.lock().unwrap();
704 for source in sources {
705 if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
706 let mut session_priv_bytes = [0; 32];
707 session_priv_bytes.copy_from_slice(&session_priv[..]);
708 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
709 assert!(payment.get().is_fulfilled());
710 if payment.get_mut().remove(&session_priv_bytes, None) {
712 events::Event::PaymentPathSuccessful {
714 payment_hash: payment.get().payment_hash(),
724 pub(super) fn remove_stale_resolved_payments(&self, pending_events: &Mutex<Vec<events::Event>>) {
725 // If an outbound payment was completed, and no pending HTLCs remain, we should remove it
726 // from the map. However, if we did that immediately when the last payment HTLC is claimed,
727 // this could race the user making a duplicate send_payment call and our idempotency
728 // guarantees would be violated. Instead, we wait a few timer ticks to do the actual
729 // removal. This should be more than sufficient to ensure the idempotency of any
730 // `send_payment` calls that were made at the same time the `PaymentSent` event was being
732 let mut pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
733 let pending_events = pending_events.lock().unwrap();
734 pending_outbound_payments.retain(|payment_id, payment| {
735 if let PendingOutboundPayment::Fulfilled { session_privs, timer_ticks_without_htlcs, .. } = payment {
736 let mut no_remaining_entries = session_privs.is_empty();
737 if no_remaining_entries {
738 for ev in pending_events.iter() {
740 events::Event::PaymentSent { payment_id: Some(ev_payment_id), .. } |
741 events::Event::PaymentPathSuccessful { payment_id: ev_payment_id, .. } |
742 events::Event::PaymentPathFailed { payment_id: Some(ev_payment_id), .. } => {
743 if payment_id == ev_payment_id {
744 no_remaining_entries = false;
752 if no_remaining_entries {
753 *timer_ticks_without_htlcs += 1;
754 *timer_ticks_without_htlcs <= IDEMPOTENCY_TIMEOUT_TICKS
756 *timer_ticks_without_htlcs = 0;
763 pub(super) fn fail_htlc<L: Deref>(
764 &self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason,
765 path: &Vec<RouteHop>, session_priv: &SecretKey, payment_id: &PaymentId,
766 payment_params: &Option<PaymentParameters>, probing_cookie_secret: [u8; 32],
767 secp_ctx: &Secp256k1<secp256k1::All>, pending_events: &Mutex<Vec<events::Event>>, logger: &L
768 ) where L::Target: Logger {
769 let mut session_priv_bytes = [0; 32];
770 session_priv_bytes.copy_from_slice(&session_priv[..]);
771 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
772 let mut all_paths_failed = false;
773 let mut full_failure_ev = None;
774 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(*payment_id) {
775 if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
776 log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
779 if payment.get().is_fulfilled() {
780 log_trace!(logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
783 if payment.get().remaining_parts() == 0 {
784 all_paths_failed = true;
785 if payment.get().abandoned() {
786 full_failure_ev = Some(events::Event::PaymentFailed {
787 payment_id: *payment_id,
788 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
794 log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
797 let mut retry = if let Some(payment_params_data) = payment_params {
798 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
799 Some(RouteParameters {
800 payment_params: payment_params_data.clone(),
801 final_value_msat: path_last_hop.fee_msat,
802 final_cltv_expiry_delta: path_last_hop.cltv_expiry_delta,
805 log_trace!(logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
809 let (network_update, short_channel_id, payment_retryable, onion_error_code, onion_error_data) = onion_error.decode_onion_failure(secp_ctx, logger, &source);
811 let (network_update, short_channel_id, payment_retryable, _, _) = onion_error.decode_onion_failure(secp_ctx, logger, &source);
813 if payment_is_probe(payment_hash, &payment_id, probing_cookie_secret) {
814 if !payment_retryable {
815 events::Event::ProbeSuccessful {
816 payment_id: *payment_id,
817 payment_hash: payment_hash.clone(),
821 events::Event::ProbeFailed {
822 payment_id: *payment_id,
823 payment_hash: payment_hash.clone(),
829 // TODO: If we decided to blame ourselves (or one of our channels) in
830 // process_onion_failure we should close that channel as it implies our
831 // next-hop is needlessly blaming us!
832 if let Some(scid) = short_channel_id {
833 retry.as_mut().map(|r| r.payment_params.previously_failed_channels.push(scid));
835 events::Event::PaymentPathFailed {
836 payment_id: Some(*payment_id),
837 payment_hash: payment_hash.clone(),
838 payment_failed_permanently: !payment_retryable,
845 error_code: onion_error_code,
847 error_data: onion_error_data
851 let mut pending_events = pending_events.lock().unwrap();
852 pending_events.push(path_failure);
853 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
856 pub(super) fn abandon_payment(&self, payment_id: PaymentId) -> Option<events::Event> {
857 let mut failed_ev = None;
858 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
859 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
860 if let Ok(()) = payment.get_mut().mark_abandoned() {
861 if payment.get().remaining_parts() == 0 {
862 failed_ev = Some(events::Event::PaymentFailed {
864 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
874 pub fn has_pending_payments(&self) -> bool {
875 !self.pending_outbound_payments.lock().unwrap().is_empty()
879 pub fn clear_pending_payments(&self) {
880 self.pending_outbound_payments.lock().unwrap().clear()
884 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
886 pub(super) fn payment_is_probe(payment_hash: &PaymentHash, payment_id: &PaymentId,
887 probing_cookie_secret: [u8; 32]) -> bool
889 let target_payment_hash = probing_cookie_from_id(payment_id, probing_cookie_secret);
890 target_payment_hash == *payment_hash
893 /// Returns the 'probing cookie' for the given [`PaymentId`].
894 fn probing_cookie_from_id(payment_id: &PaymentId, probing_cookie_secret: [u8; 32]) -> PaymentHash {
895 let mut preimage = [0u8; 64];
896 preimage[..32].copy_from_slice(&probing_cookie_secret);
897 preimage[32..].copy_from_slice(&payment_id.0);
898 PaymentHash(Sha256::hash(&preimage).into_inner())
901 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
903 (0, session_privs, required),
906 (0, session_privs, required),
907 (1, payment_hash, option),
908 (3, timer_ticks_without_htlcs, (default_value, 0)),
911 (0, session_privs, required),
912 (1, pending_fee_msat, option),
913 (2, payment_hash, required),
914 (4, payment_secret, option),
915 (6, total_msat, required),
916 (8, pending_amt_msat, required),
917 (10, starting_block_height, required),
920 (0, session_privs, required),
921 (2, payment_hash, required),