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::sign::{EntropySource, NodeSigner, Recipient};
17 use crate::events::{self, PaymentFailureReason};
18 use crate::ln::{PaymentHash, PaymentPreimage, PaymentSecret};
19 use crate::ln::channelmanager::{ChannelDetails, EventCompletionAction, HTLCSource, PaymentId};
20 use crate::ln::onion_utils::{DecodedOnionFailure, HTLCFailReason};
21 use crate::offers::invoice::Bolt12Invoice;
22 use crate::routing::router::{InFlightHtlcs, Path, PaymentParameters, Route, RouteParameters, Router};
23 use crate::util::errors::APIError;
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;
28 use crate::util::ser::ReadableArgs;
30 use core::fmt::{self, Display, Formatter};
33 use crate::prelude::*;
34 use crate::sync::Mutex;
36 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the idempotency
37 /// of payments by [`PaymentId`]. See [`OutboundPayments::remove_stale_payments`].
39 /// [`ChannelManager::timer_tick_occurred`]: crate::ln::channelmanager::ChannelManager::timer_tick_occurred
40 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
42 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until an invoice request without
43 /// a response is timed out.
45 /// [`ChannelManager::timer_tick_occurred`]: crate::ln::channelmanager::ChannelManager::timer_tick_occurred
46 const INVOICE_REQUEST_TIMEOUT_TICKS: u8 = 3;
48 /// Stores the session_priv for each part of a payment that is still pending. For versions 0.0.102
49 /// and later, also stores information for retrying the payment.
50 pub(crate) enum PendingOutboundPayment {
52 session_privs: HashSet<[u8; 32]>,
55 timer_ticks_without_response: u8,
56 retry_strategy: Retry,
57 max_total_routing_fee_msat: Option<u64>,
60 payment_hash: PaymentHash,
61 retry_strategy: Retry,
62 // Note this field is currently just replicated from AwaitingInvoice but not actually
64 max_total_routing_fee_msat: Option<u64>,
67 retry_strategy: Option<Retry>,
68 attempts: PaymentAttempts,
69 payment_params: Option<PaymentParameters>,
70 session_privs: HashSet<[u8; 32]>,
71 payment_hash: PaymentHash,
72 payment_secret: Option<PaymentSecret>,
73 payment_metadata: Option<Vec<u8>>,
74 keysend_preimage: Option<PaymentPreimage>,
75 custom_tlvs: Vec<(u64, Vec<u8>)>,
76 pending_amt_msat: u64,
77 /// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
78 pending_fee_msat: Option<u64>,
79 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
81 /// Our best known block height at the time this payment was initiated.
82 starting_block_height: u32,
83 remaining_max_total_routing_fee_msat: Option<u64>,
85 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
86 /// been resolved. This ensures we don't look up pending payments in ChannelMonitors on restart
87 /// and add a pending payment that was already fulfilled.
89 session_privs: HashSet<[u8; 32]>,
90 /// Filled in for any payment which moved to `Fulfilled` on LDK 0.0.104 or later.
91 payment_hash: Option<PaymentHash>,
92 timer_ticks_without_htlcs: u8,
94 /// When we've decided to give up retrying a payment, we mark it as abandoned so we can eventually
95 /// generate a `PaymentFailed` event when all HTLCs have irrevocably failed.
97 session_privs: HashSet<[u8; 32]>,
98 payment_hash: PaymentHash,
99 /// Will be `None` if the payment was serialized before 0.0.115.
100 reason: Option<PaymentFailureReason>,
104 impl PendingOutboundPayment {
105 fn increment_attempts(&mut self) {
106 if let PendingOutboundPayment::Retryable { attempts, .. } = self {
110 fn is_auto_retryable_now(&self) -> bool {
112 PendingOutboundPayment::Retryable {
113 retry_strategy: Some(strategy), attempts, payment_params: Some(_), ..
115 strategy.is_retryable_now(&attempts)
120 fn is_retryable_now(&self) -> bool {
122 PendingOutboundPayment::Retryable { retry_strategy: None, .. } => {
123 // We're handling retries manually, we can always retry.
126 PendingOutboundPayment::Retryable { retry_strategy: Some(strategy), attempts, .. } => {
127 strategy.is_retryable_now(&attempts)
132 pub fn insert_previously_failed_scid(&mut self, scid: u64) {
133 if let PendingOutboundPayment::Retryable { payment_params: Some(params), .. } = self {
134 params.previously_failed_channels.push(scid);
137 fn is_awaiting_invoice(&self) -> bool {
139 PendingOutboundPayment::AwaitingInvoice { .. } => true,
143 pub(super) fn is_fulfilled(&self) -> bool {
145 PendingOutboundPayment::Fulfilled { .. } => true,
149 pub(super) fn abandoned(&self) -> bool {
151 PendingOutboundPayment::Abandoned { .. } => true,
155 fn get_pending_fee_msat(&self) -> Option<u64> {
157 PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
162 fn payment_hash(&self) -> Option<PaymentHash> {
164 PendingOutboundPayment::Legacy { .. } => None,
165 PendingOutboundPayment::AwaitingInvoice { .. } => None,
166 PendingOutboundPayment::InvoiceReceived { payment_hash, .. } => Some(*payment_hash),
167 PendingOutboundPayment::Retryable { payment_hash, .. } => Some(*payment_hash),
168 PendingOutboundPayment::Fulfilled { payment_hash, .. } => *payment_hash,
169 PendingOutboundPayment::Abandoned { payment_hash, .. } => Some(*payment_hash),
173 fn mark_fulfilled(&mut self) {
174 let mut session_privs = HashSet::new();
175 core::mem::swap(&mut session_privs, match self {
176 PendingOutboundPayment::Legacy { session_privs } |
177 PendingOutboundPayment::Retryable { session_privs, .. } |
178 PendingOutboundPayment::Fulfilled { session_privs, .. } |
179 PendingOutboundPayment::Abandoned { session_privs, .. } => session_privs,
180 PendingOutboundPayment::AwaitingInvoice { .. } |
181 PendingOutboundPayment::InvoiceReceived { .. } => { debug_assert!(false); return; },
183 let payment_hash = self.payment_hash();
184 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash, timer_ticks_without_htlcs: 0 };
187 fn mark_abandoned(&mut self, reason: PaymentFailureReason) {
188 if let PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } = self {
189 let mut our_session_privs = HashSet::new();
190 core::mem::swap(&mut our_session_privs, session_privs);
191 *self = PendingOutboundPayment::Abandoned {
192 session_privs: our_session_privs,
193 payment_hash: *payment_hash,
196 } else if let PendingOutboundPayment::InvoiceReceived { payment_hash, .. } = self {
197 *self = PendingOutboundPayment::Abandoned {
198 session_privs: HashSet::new(),
199 payment_hash: *payment_hash,
205 /// panics if path is None and !self.is_fulfilled
206 fn remove(&mut self, session_priv: &[u8; 32], path: Option<&Path>) -> bool {
207 let remove_res = match self {
208 PendingOutboundPayment::Legacy { session_privs } |
209 PendingOutboundPayment::Retryable { session_privs, .. } |
210 PendingOutboundPayment::Fulfilled { session_privs, .. } |
211 PendingOutboundPayment::Abandoned { session_privs, .. } => {
212 session_privs.remove(session_priv)
214 PendingOutboundPayment::AwaitingInvoice { .. } |
215 PendingOutboundPayment::InvoiceReceived { .. } => { debug_assert!(false); false },
218 if let PendingOutboundPayment::Retryable {
219 ref mut pending_amt_msat, ref mut pending_fee_msat,
220 ref mut remaining_max_total_routing_fee_msat, ..
222 let path = path.expect("Removing a failed payment should always come with a path");
223 *pending_amt_msat -= path.final_value_msat();
224 let path_fee_msat = path.fee_msat();
225 if let Some(fee_msat) = pending_fee_msat.as_mut() {
226 *fee_msat -= path_fee_msat;
229 if let Some(max_total_routing_fee_msat) = remaining_max_total_routing_fee_msat.as_mut() {
230 *max_total_routing_fee_msat = max_total_routing_fee_msat.saturating_add(path_fee_msat);
237 pub(super) fn insert(&mut self, session_priv: [u8; 32], path: &Path) -> bool {
238 let insert_res = match self {
239 PendingOutboundPayment::Legacy { session_privs } |
240 PendingOutboundPayment::Retryable { session_privs, .. } => {
241 session_privs.insert(session_priv)
243 PendingOutboundPayment::AwaitingInvoice { .. } |
244 PendingOutboundPayment::InvoiceReceived { .. } => { debug_assert!(false); false },
245 PendingOutboundPayment::Fulfilled { .. } => false,
246 PendingOutboundPayment::Abandoned { .. } => false,
249 if let PendingOutboundPayment::Retryable {
250 ref mut pending_amt_msat, ref mut pending_fee_msat,
251 ref mut remaining_max_total_routing_fee_msat, ..
253 *pending_amt_msat += path.final_value_msat();
254 let path_fee_msat = path.fee_msat();
255 if let Some(fee_msat) = pending_fee_msat.as_mut() {
256 *fee_msat += path_fee_msat;
259 if let Some(max_total_routing_fee_msat) = remaining_max_total_routing_fee_msat.as_mut() {
260 *max_total_routing_fee_msat = max_total_routing_fee_msat.saturating_sub(path_fee_msat);
267 pub(super) fn remaining_parts(&self) -> usize {
269 PendingOutboundPayment::Legacy { session_privs } |
270 PendingOutboundPayment::Retryable { session_privs, .. } |
271 PendingOutboundPayment::Fulfilled { session_privs, .. } |
272 PendingOutboundPayment::Abandoned { session_privs, .. } => {
275 PendingOutboundPayment::AwaitingInvoice { .. } => 0,
276 PendingOutboundPayment::InvoiceReceived { .. } => 0,
281 /// Strategies available to retry payment path failures.
282 #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
284 /// Max number of attempts to retry payment.
286 /// Each attempt may be multiple HTLCs along multiple paths if the router decides to split up a
287 /// retry, and may retry multiple failed HTLCs at once if they failed around the same time and
288 /// were retried along a route from a single call to [`Router::find_route_with_id`].
290 #[cfg(not(feature = "no-std"))]
291 /// Time elapsed before abandoning retries for a payment. At least one attempt at payment is made;
292 /// see [`PaymentParameters::expiry_time`] to avoid any attempt at payment after a specific time.
294 /// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
295 Timeout(core::time::Duration),
298 #[cfg(feature = "no-std")]
299 impl_writeable_tlv_based_enum!(Retry,
304 #[cfg(not(feature = "no-std"))]
305 impl_writeable_tlv_based_enum!(Retry,
312 pub(crate) fn is_retryable_now(&self, attempts: &PaymentAttempts) -> bool {
313 match (self, attempts) {
314 (Retry::Attempts(max_retry_count), PaymentAttempts { count, .. }) => {
315 max_retry_count > count
317 #[cfg(all(not(feature = "no-std"), not(test)))]
318 (Retry::Timeout(max_duration), PaymentAttempts { first_attempted_at, .. }) =>
319 *max_duration >= crate::util::time::MonotonicTime::now().duration_since(*first_attempted_at),
320 #[cfg(all(not(feature = "no-std"), test))]
321 (Retry::Timeout(max_duration), PaymentAttempts { first_attempted_at, .. }) =>
322 *max_duration >= SinceEpoch::now().duration_since(*first_attempted_at),
327 #[cfg(feature = "std")]
328 pub(super) fn has_expired(route_params: &RouteParameters) -> bool {
329 if let Some(expiry_time) = route_params.payment_params.expiry_time {
330 if let Ok(elapsed) = std::time::SystemTime::UNIX_EPOCH.elapsed() {
331 return elapsed > core::time::Duration::from_secs(expiry_time)
337 pub(crate) type PaymentAttempts = PaymentAttemptsUsingTime<ConfiguredTime>;
339 /// Storing minimal payment attempts information required for determining if a outbound payment can
341 pub(crate) struct PaymentAttemptsUsingTime<T: Time> {
342 /// This count will be incremented only after the result of the attempt is known. When it's 0,
343 /// it means the result of the first attempt is not known yet.
344 pub(crate) count: u32,
345 /// This field is only used when retry is `Retry::Timeout` which is only build with feature std
346 #[cfg(not(feature = "no-std"))]
347 first_attempted_at: T,
348 #[cfg(feature = "no-std")]
349 phantom: core::marker::PhantomData<T>,
353 #[cfg(not(any(feature = "no-std", test)))]
354 type ConfiguredTime = crate::util::time::MonotonicTime;
355 #[cfg(feature = "no-std")]
356 type ConfiguredTime = crate::util::time::Eternity;
357 #[cfg(all(not(feature = "no-std"), test))]
358 type ConfiguredTime = SinceEpoch;
360 impl<T: Time> PaymentAttemptsUsingTime<T> {
361 pub(crate) fn new() -> Self {
362 PaymentAttemptsUsingTime {
364 #[cfg(not(feature = "no-std"))]
365 first_attempted_at: T::now(),
366 #[cfg(feature = "no-std")]
367 phantom: core::marker::PhantomData,
372 impl<T: Time> Display for PaymentAttemptsUsingTime<T> {
373 fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> {
374 #[cfg(feature = "no-std")]
375 return write!(f, "attempts: {}", self.count);
376 #[cfg(not(feature = "no-std"))]
379 "attempts: {}, duration: {}s",
381 T::now().duration_since(self.first_attempted_at).as_secs()
386 /// Indicates an immediate error on [`ChannelManager::send_payment`]. Further errors may be
387 /// surfaced later via [`Event::PaymentPathFailed`] and [`Event::PaymentFailed`].
389 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
390 /// [`Event::PaymentPathFailed`]: crate::events::Event::PaymentPathFailed
391 /// [`Event::PaymentFailed`]: crate::events::Event::PaymentFailed
392 #[derive(Clone, Debug, PartialEq, Eq)]
393 pub enum RetryableSendFailure {
394 /// The provided [`PaymentParameters::expiry_time`] indicated that the payment has expired. Note
395 /// that this error is *not* caused by [`Retry::Timeout`].
397 /// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
399 /// We were unable to find a route to the destination.
401 /// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
402 /// yet completed (i.e. generated an [`Event::PaymentSent`] or [`Event::PaymentFailed`]).
404 /// [`PaymentId`]: crate::ln::channelmanager::PaymentId
405 /// [`Event::PaymentSent`]: crate::events::Event::PaymentSent
406 /// [`Event::PaymentFailed`]: crate::events::Event::PaymentFailed
410 /// If a payment fails to send with [`ChannelManager::send_payment_with_route`], it can be in one
411 /// of several states. This enum is returned as the Err() type describing which state the payment
412 /// is in, see the description of individual enum states for more.
414 /// [`ChannelManager::send_payment_with_route`]: crate::ln::channelmanager::ChannelManager::send_payment_with_route
415 #[derive(Clone, Debug, PartialEq, Eq)]
416 pub enum PaymentSendFailure {
417 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
418 /// send the payment at all.
420 /// You can freely resend the payment in full (with the parameter error fixed).
422 /// Because the payment failed outright, no payment tracking is done and no
423 /// [`Event::PaymentPathFailed`] or [`Event::PaymentFailed`] events will be generated.
425 /// [`Event::PaymentPathFailed`]: crate::events::Event::PaymentPathFailed
426 /// [`Event::PaymentFailed`]: crate::events::Event::PaymentFailed
427 ParameterError(APIError),
428 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
429 /// from attempting to send the payment at all.
431 /// You can freely resend the payment in full (with the parameter error fixed).
433 /// Because the payment failed outright, no payment tracking is done and no
434 /// [`Event::PaymentPathFailed`] or [`Event::PaymentFailed`] events will be generated.
436 /// The results here are ordered the same as the paths in the route object which was passed to
439 /// [`Event::PaymentPathFailed`]: crate::events::Event::PaymentPathFailed
440 /// [`Event::PaymentFailed`]: crate::events::Event::PaymentFailed
441 PathParameterError(Vec<Result<(), APIError>>),
442 /// All paths which were attempted failed to send, with no channel state change taking place.
443 /// You can freely resend the payment in full (though you probably want to do so over different
444 /// paths than the ones selected).
446 /// Because the payment failed outright, no payment tracking is done and no
447 /// [`Event::PaymentPathFailed`] or [`Event::PaymentFailed`] events will be generated.
449 /// [`Event::PaymentPathFailed`]: crate::events::Event::PaymentPathFailed
450 /// [`Event::PaymentFailed`]: crate::events::Event::PaymentFailed
451 AllFailedResendSafe(Vec<APIError>),
452 /// Indicates that a payment for the provided [`PaymentId`] is already in-flight and has not
453 /// yet completed (i.e. generated an [`Event::PaymentSent`] or [`Event::PaymentFailed`]).
455 /// [`PaymentId`]: crate::ln::channelmanager::PaymentId
456 /// [`Event::PaymentSent`]: crate::events::Event::PaymentSent
457 /// [`Event::PaymentFailed`]: crate::events::Event::PaymentFailed
459 /// Some paths that were attempted failed to send, though some paths may have succeeded. At least
460 /// some paths have irrevocably committed to the HTLC.
462 /// The results here are ordered the same as the paths in the route object that was passed to
465 /// Any entries that contain `Err(APIError::MonitorUpdateInprogress)` will send once a
466 /// [`MonitorEvent::Completed`] is provided for the next-hop channel with the latest update_id.
468 /// [`MonitorEvent::Completed`]: crate::chain::channelmonitor::MonitorEvent::Completed
470 /// The errors themselves, in the same order as the paths from the route.
471 results: Vec<Result<(), APIError>>,
472 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
473 /// contain a [`RouteParameters`] object for the failing paths.
474 failed_paths_retry: Option<RouteParameters>,
475 /// The payment id for the payment, which is now at least partially pending.
476 payment_id: PaymentId,
480 /// An error when attempting to pay a BOLT 12 invoice.
481 #[derive(Clone, Debug, PartialEq, Eq)]
482 pub(super) enum Bolt12PaymentError {
483 /// The invoice was not requested.
485 /// Payment for an invoice with the corresponding [`PaymentId`] was already initiated.
489 /// Indicates that we failed to send a payment probe. Further errors may be surfaced later via
490 /// [`Event::ProbeFailed`].
492 /// [`Event::ProbeFailed`]: crate::events::Event::ProbeFailed
493 #[derive(Clone, Debug, PartialEq, Eq)]
494 pub enum ProbeSendFailure {
495 /// We were unable to find a route to the destination.
497 /// We failed to send the payment probes.
498 SendingFailed(PaymentSendFailure),
501 /// Information which is provided, encrypted, to the payment recipient when sending HTLCs.
503 /// This should generally be constructed with data communicated to us from the recipient (via a
504 /// BOLT11 or BOLT12 invoice).
505 #[derive(Clone, Debug, PartialEq, Eq)]
506 pub struct RecipientOnionFields {
507 /// The [`PaymentSecret`] is an arbitrary 32 bytes provided by the recipient for us to repeat
508 /// in the onion. It is unrelated to `payment_hash` (or [`PaymentPreimage`]) and exists to
509 /// authenticate the sender to the recipient and prevent payment-probing (deanonymization)
512 /// If you do not have one, the [`Route`] you pay over must not contain multiple paths as
513 /// multi-path payments require a recipient-provided secret.
515 /// Some implementations may reject spontaneous payments with payment secrets, so you may only
516 /// want to provide a secret for a spontaneous payment if MPP is needed and you know your
517 /// recipient will not reject it.
518 pub payment_secret: Option<PaymentSecret>,
519 /// The payment metadata serves a similar purpose as [`Self::payment_secret`] but is of
520 /// arbitrary length. This gives recipients substantially more flexibility to receive
523 /// In LDK, while the [`Self::payment_secret`] is fixed based on an internal authentication
524 /// scheme to authenticate received payments against expected payments and invoices, this field
525 /// is not used in LDK for received payments, and can be used to store arbitrary data in
526 /// invoices which will be received with the payment.
528 /// Note that this field was added to the lightning specification more recently than
529 /// [`Self::payment_secret`] and while nearly all lightning senders support secrets, metadata
530 /// may not be supported as universally.
531 pub payment_metadata: Option<Vec<u8>>,
532 /// See [`Self::custom_tlvs`] for more info.
533 pub(super) custom_tlvs: Vec<(u64, Vec<u8>)>,
536 impl_writeable_tlv_based!(RecipientOnionFields, {
537 (0, payment_secret, option),
538 (1, custom_tlvs, optional_vec),
539 (2, payment_metadata, option),
542 impl RecipientOnionFields {
543 /// Creates a [`RecipientOnionFields`] from only a [`PaymentSecret`]. This is the most common
544 /// set of onion fields for today's BOLT11 invoices - most nodes require a [`PaymentSecret`]
545 /// but do not require or provide any further data.
546 pub fn secret_only(payment_secret: PaymentSecret) -> Self {
547 Self { payment_secret: Some(payment_secret), payment_metadata: None, custom_tlvs: Vec::new() }
550 /// Creates a new [`RecipientOnionFields`] with no fields. This generally does not create
551 /// payable HTLCs except for single-path spontaneous payments, i.e. this should generally
552 /// only be used for calls to [`ChannelManager::send_spontaneous_payment`]. If you are sending
553 /// a spontaneous MPP this will not work as all MPP require payment secrets; you may
554 /// instead want to use [`RecipientOnionFields::secret_only`].
556 /// [`ChannelManager::send_spontaneous_payment`]: super::channelmanager::ChannelManager::send_spontaneous_payment
557 /// [`RecipientOnionFields::secret_only`]: RecipientOnionFields::secret_only
558 pub fn spontaneous_empty() -> Self {
559 Self { payment_secret: None, payment_metadata: None, custom_tlvs: Vec::new() }
562 /// Creates a new [`RecipientOnionFields`] from an existing one, adding custom TLVs. Each
563 /// TLV is provided as a `(u64, Vec<u8>)` for the type number and serialized value
564 /// respectively. TLV type numbers must be unique and within the range
565 /// reserved for custom types, i.e. >= 2^16, otherwise this method will return `Err(())`.
567 /// This method will also error for types in the experimental range which have been
568 /// standardized within the protocol, which only includes 5482373484 (keysend) for now.
570 /// See [`Self::custom_tlvs`] for more info.
571 pub fn with_custom_tlvs(mut self, mut custom_tlvs: Vec<(u64, Vec<u8>)>) -> Result<Self, ()> {
572 custom_tlvs.sort_unstable_by_key(|(typ, _)| *typ);
573 let mut prev_type = None;
574 for (typ, _) in custom_tlvs.iter() {
575 if *typ < 1 << 16 { return Err(()); }
576 if *typ == 5482373484 { return Err(()); } // keysend
578 Some(prev) if prev >= *typ => return Err(()),
581 prev_type = Some(*typ);
583 self.custom_tlvs = custom_tlvs;
587 /// Gets the custom TLVs that will be sent or have been received.
589 /// Custom TLVs allow sending extra application-specific data with a payment. They provide
590 /// additional flexibility on top of payment metadata, as while other implementations may
591 /// require `payment_metadata` to reflect metadata provided in an invoice, custom TLVs
592 /// do not have this restriction.
594 /// Note that if this field is non-empty, it will contain strictly increasing TLVs, each
595 /// represented by a `(u64, Vec<u8>)` for its type number and serialized value respectively.
596 /// This is validated when setting this field using [`Self::with_custom_tlvs`].
597 pub fn custom_tlvs(&self) -> &Vec<(u64, Vec<u8>)> {
601 /// When we have received some HTLC(s) towards an MPP payment, as we receive further HTLC(s) we
602 /// have to make sure that some fields match exactly across the parts. For those that aren't
603 /// required to match, if they don't match we should remove them so as to not expose data
604 /// that's dependent on the HTLC receive order to users.
606 /// Here we implement this, first checking compatibility then mutating two objects and then
607 /// dropping any remaining non-matching fields from both.
608 pub(super) fn check_merge(&mut self, further_htlc_fields: &mut Self) -> Result<(), ()> {
609 if self.payment_secret != further_htlc_fields.payment_secret { return Err(()); }
610 if self.payment_metadata != further_htlc_fields.payment_metadata { return Err(()); }
612 let tlvs = &mut self.custom_tlvs;
613 let further_tlvs = &mut further_htlc_fields.custom_tlvs;
615 let even_tlvs = tlvs.iter().filter(|(typ, _)| *typ % 2 == 0);
616 let further_even_tlvs = further_tlvs.iter().filter(|(typ, _)| *typ % 2 == 0);
617 if even_tlvs.ne(further_even_tlvs) { return Err(()) }
619 tlvs.retain(|tlv| further_tlvs.iter().any(|further_tlv| tlv == further_tlv));
620 further_tlvs.retain(|further_tlv| tlvs.iter().any(|tlv| tlv == further_tlv));
626 /// Arguments for [`super::channelmanager::ChannelManager::send_payment_along_path`].
627 pub(super) struct SendAlongPathArgs<'a> {
629 pub payment_hash: &'a PaymentHash,
630 pub recipient_onion: RecipientOnionFields,
631 pub total_value: u64,
633 pub payment_id: PaymentId,
634 pub keysend_preimage: &'a Option<PaymentPreimage>,
635 pub session_priv_bytes: [u8; 32],
638 pub(super) struct OutboundPayments {
639 pub(super) pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
640 pub(super) retry_lock: Mutex<()>,
643 impl OutboundPayments {
644 pub(super) fn new() -> Self {
646 pending_outbound_payments: Mutex::new(HashMap::new()),
647 retry_lock: Mutex::new(()),
651 pub(super) fn send_payment<R: Deref, ES: Deref, NS: Deref, IH, SP, L: Deref>(
652 &self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId,
653 retry_strategy: Retry, route_params: RouteParameters, router: &R,
654 first_hops: Vec<ChannelDetails>, compute_inflight_htlcs: IH, entropy_source: &ES,
655 node_signer: &NS, best_block_height: u32, logger: &L,
656 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, send_payment_along_path: SP,
657 ) -> Result<(), RetryableSendFailure>
660 ES::Target: EntropySource,
661 NS::Target: NodeSigner,
663 IH: Fn() -> InFlightHtlcs,
664 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
666 self.send_payment_internal(payment_id, payment_hash, recipient_onion, None, retry_strategy,
667 route_params, router, first_hops, &compute_inflight_htlcs, entropy_source, node_signer,
668 best_block_height, logger, pending_events, &send_payment_along_path)
671 pub(super) fn send_payment_with_route<ES: Deref, NS: Deref, F>(
672 &self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields,
673 payment_id: PaymentId, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
674 send_payment_along_path: F
675 ) -> Result<(), PaymentSendFailure>
677 ES::Target: EntropySource,
678 NS::Target: NodeSigner,
679 F: Fn(SendAlongPathArgs) -> Result<(), APIError>
681 let onion_session_privs = self.add_new_pending_payment(payment_hash, recipient_onion.clone(), payment_id, None, route, None, None, entropy_source, best_block_height)?;
682 self.pay_route_internal(route, payment_hash, recipient_onion, None, payment_id, None,
683 onion_session_privs, node_signer, best_block_height, &send_payment_along_path)
684 .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
687 pub(super) fn send_spontaneous_payment<R: Deref, ES: Deref, NS: Deref, IH, SP, L: Deref>(
688 &self, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields,
689 payment_id: PaymentId, retry_strategy: Retry, route_params: RouteParameters, router: &R,
690 first_hops: Vec<ChannelDetails>, inflight_htlcs: IH, entropy_source: &ES,
691 node_signer: &NS, best_block_height: u32, logger: &L,
692 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, send_payment_along_path: SP
693 ) -> Result<PaymentHash, RetryableSendFailure>
696 ES::Target: EntropySource,
697 NS::Target: NodeSigner,
699 IH: Fn() -> InFlightHtlcs,
700 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
702 let preimage = payment_preimage
703 .unwrap_or_else(|| PaymentPreimage(entropy_source.get_secure_random_bytes()));
704 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
705 self.send_payment_internal(payment_id, payment_hash, recipient_onion, Some(preimage),
706 retry_strategy, route_params, router, first_hops, inflight_htlcs, entropy_source,
707 node_signer, best_block_height, logger, pending_events, send_payment_along_path)
708 .map(|()| payment_hash)
711 pub(super) fn send_spontaneous_payment_with_route<ES: Deref, NS: Deref, F>(
712 &self, route: &Route, payment_preimage: Option<PaymentPreimage>,
713 recipient_onion: RecipientOnionFields, payment_id: PaymentId, entropy_source: &ES,
714 node_signer: &NS, best_block_height: u32, send_payment_along_path: F
715 ) -> Result<PaymentHash, PaymentSendFailure>
717 ES::Target: EntropySource,
718 NS::Target: NodeSigner,
719 F: Fn(SendAlongPathArgs) -> Result<(), APIError>,
721 let preimage = payment_preimage
722 .unwrap_or_else(|| PaymentPreimage(entropy_source.get_secure_random_bytes()));
723 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
724 let onion_session_privs = self.add_new_pending_payment(payment_hash, recipient_onion.clone(),
725 payment_id, Some(preimage), &route, None, None, entropy_source, best_block_height)?;
727 match self.pay_route_internal(route, payment_hash, recipient_onion, Some(preimage),
728 payment_id, None, onion_session_privs, node_signer, best_block_height, &send_payment_along_path
730 Ok(()) => Ok(payment_hash),
732 self.remove_outbound_if_all_failed(payment_id, &e);
739 pub(super) fn send_payment_for_bolt12_invoice<R: Deref, ES: Deref, NS: Deref, IH, SP, L: Deref>(
740 &self, invoice: &Bolt12Invoice, payment_id: PaymentId, router: &R,
741 first_hops: Vec<ChannelDetails>, inflight_htlcs: IH, entropy_source: &ES, node_signer: &NS,
742 best_block_height: u32, logger: &L,
743 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
744 send_payment_along_path: SP,
745 ) -> Result<(), Bolt12PaymentError>
748 ES::Target: EntropySource,
749 NS::Target: NodeSigner,
751 IH: Fn() -> InFlightHtlcs,
752 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
754 let payment_hash = invoice.payment_hash();
755 let mut max_total_routing_fee_msat = None;
756 match self.pending_outbound_payments.lock().unwrap().entry(payment_id) {
757 hash_map::Entry::Occupied(entry) => match entry.get() {
758 PendingOutboundPayment::AwaitingInvoice { retry_strategy, max_total_routing_fee_msat: max_total_fee, .. } => {
759 max_total_routing_fee_msat = *max_total_fee;
760 *entry.into_mut() = PendingOutboundPayment::InvoiceReceived {
762 retry_strategy: *retry_strategy,
763 max_total_routing_fee_msat,
766 _ => return Err(Bolt12PaymentError::DuplicateInvoice),
768 hash_map::Entry::Vacant(_) => return Err(Bolt12PaymentError::UnexpectedInvoice),
771 let route_params = RouteParameters {
772 payment_params: PaymentParameters::from_bolt12_invoice(&invoice),
773 final_value_msat: invoice.amount_msats(),
774 max_total_routing_fee_msat,
777 self.find_route_and_send_payment(
778 payment_hash, payment_id, route_params, router, first_hops, &inflight_htlcs,
779 entropy_source, node_signer, best_block_height, logger, pending_events,
780 &send_payment_along_path
786 pub(super) fn check_retry_payments<R: Deref, ES: Deref, NS: Deref, SP, IH, FH, L: Deref>(
787 &self, router: &R, first_hops: FH, inflight_htlcs: IH, entropy_source: &ES, node_signer: &NS,
788 best_block_height: u32,
789 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, logger: &L,
790 send_payment_along_path: SP,
794 ES::Target: EntropySource,
795 NS::Target: NodeSigner,
796 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
797 IH: Fn() -> InFlightHtlcs,
798 FH: Fn() -> Vec<ChannelDetails>,
801 let _single_thread = self.retry_lock.lock().unwrap();
803 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
804 let mut retry_id_route_params = None;
805 for (pmt_id, pmt) in outbounds.iter_mut() {
806 if pmt.is_auto_retryable_now() {
807 if let PendingOutboundPayment::Retryable { pending_amt_msat, total_msat, payment_params: Some(params), payment_hash, remaining_max_total_routing_fee_msat, .. } = pmt {
808 if pending_amt_msat < total_msat {
809 retry_id_route_params = Some((*payment_hash, *pmt_id, RouteParameters {
810 final_value_msat: *total_msat - *pending_amt_msat,
811 payment_params: params.clone(),
812 max_total_routing_fee_msat: *remaining_max_total_routing_fee_msat,
816 } else { debug_assert!(false); }
819 core::mem::drop(outbounds);
820 if let Some((payment_hash, payment_id, route_params)) = retry_id_route_params {
821 self.find_route_and_send_payment(payment_hash, payment_id, route_params, router, first_hops(), &inflight_htlcs, entropy_source, node_signer, best_block_height, logger, pending_events, &send_payment_along_path)
825 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
826 outbounds.retain(|pmt_id, pmt| {
827 let mut retain = true;
828 if !pmt.is_auto_retryable_now() && pmt.remaining_parts() == 0 && !pmt.is_awaiting_invoice() {
829 pmt.mark_abandoned(PaymentFailureReason::RetriesExhausted);
830 if let PendingOutboundPayment::Abandoned { payment_hash, reason, .. } = pmt {
831 pending_events.lock().unwrap().push_back((events::Event::PaymentFailed {
833 payment_hash: *payment_hash,
843 pub(super) fn needs_abandon(&self) -> bool {
844 let outbounds = self.pending_outbound_payments.lock().unwrap();
845 outbounds.iter().any(|(_, pmt)|
846 !pmt.is_auto_retryable_now() && pmt.remaining_parts() == 0 && !pmt.is_fulfilled() &&
847 !pmt.is_awaiting_invoice())
850 /// Errors immediately on [`RetryableSendFailure`] error conditions. Otherwise, further errors may
851 /// be surfaced asynchronously via [`Event::PaymentPathFailed`] and [`Event::PaymentFailed`].
853 /// [`Event::PaymentPathFailed`]: crate::events::Event::PaymentPathFailed
854 /// [`Event::PaymentFailed`]: crate::events::Event::PaymentFailed
855 fn send_payment_internal<R: Deref, NS: Deref, ES: Deref, IH, SP, L: Deref>(
856 &self, payment_id: PaymentId, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields,
857 keysend_preimage: Option<PaymentPreimage>, retry_strategy: Retry, route_params: RouteParameters,
858 router: &R, first_hops: Vec<ChannelDetails>, inflight_htlcs: IH, entropy_source: &ES,
859 node_signer: &NS, best_block_height: u32, logger: &L,
860 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, send_payment_along_path: SP,
861 ) -> Result<(), RetryableSendFailure>
864 ES::Target: EntropySource,
865 NS::Target: NodeSigner,
867 IH: Fn() -> InFlightHtlcs,
868 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
870 #[cfg(feature = "std")] {
871 if has_expired(&route_params) {
872 log_error!(logger, "Payment with id {} and hash {} had expired before we started paying",
873 payment_id, payment_hash);
874 return Err(RetryableSendFailure::PaymentExpired)
878 let route = router.find_route_with_id(
879 &node_signer.get_node_id(Recipient::Node).unwrap(), &route_params,
880 Some(&first_hops.iter().collect::<Vec<_>>()), inflight_htlcs(),
881 payment_hash, payment_id,
883 log_error!(logger, "Failed to find route for payment with id {} and hash {}",
884 payment_id, payment_hash);
885 RetryableSendFailure::RouteNotFound
888 let onion_session_privs = self.add_new_pending_payment(payment_hash,
889 recipient_onion.clone(), payment_id, keysend_preimage, &route, Some(retry_strategy),
890 Some(route_params.payment_params.clone()), entropy_source, best_block_height)
892 log_error!(logger, "Payment with id {} is already pending. New payment had payment hash {}",
893 payment_id, payment_hash);
894 RetryableSendFailure::DuplicatePayment
897 let res = self.pay_route_internal(&route, payment_hash, recipient_onion, keysend_preimage, payment_id, None,
898 onion_session_privs, node_signer, best_block_height, &send_payment_along_path);
899 log_info!(logger, "Sending payment with id {} and hash {} returned {:?}",
900 payment_id, payment_hash, res);
901 if let Err(e) = res {
902 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);
907 fn find_route_and_send_payment<R: Deref, NS: Deref, ES: Deref, IH, SP, L: Deref>(
908 &self, payment_hash: PaymentHash, payment_id: PaymentId, route_params: RouteParameters,
909 router: &R, first_hops: Vec<ChannelDetails>, inflight_htlcs: &IH, entropy_source: &ES,
910 node_signer: &NS, best_block_height: u32, logger: &L,
911 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, send_payment_along_path: &SP,
915 ES::Target: EntropySource,
916 NS::Target: NodeSigner,
918 IH: Fn() -> InFlightHtlcs,
919 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
921 #[cfg(feature = "std")] {
922 if has_expired(&route_params) {
923 log_error!(logger, "Payment params expired on retry, abandoning payment {}", &payment_id);
924 self.abandon_payment(payment_id, PaymentFailureReason::PaymentExpired, pending_events);
929 let route = match router.find_route_with_id(
930 &node_signer.get_node_id(Recipient::Node).unwrap(), &route_params,
931 Some(&first_hops.iter().collect::<Vec<_>>()), inflight_htlcs(),
932 payment_hash, payment_id,
936 log_error!(logger, "Failed to find a route on retry, abandoning payment {}: {:#?}", &payment_id, e);
937 self.abandon_payment(payment_id, PaymentFailureReason::RouteNotFound, pending_events);
941 for path in route.paths.iter() {
942 if path.hops.len() == 0 {
943 log_error!(logger, "Unusable path in route (path.hops.len() must be at least 1");
944 self.abandon_payment(payment_id, PaymentFailureReason::UnexpectedError, pending_events);
949 macro_rules! abandon_with_entry {
950 ($payment: expr, $reason: expr) => {
951 $payment.get_mut().mark_abandoned($reason);
952 if let PendingOutboundPayment::Abandoned { reason, .. } = $payment.get() {
953 if $payment.get().remaining_parts() == 0 {
954 pending_events.lock().unwrap().push_back((events::Event::PaymentFailed {
964 let (total_msat, recipient_onion, keysend_preimage, onion_session_privs) = {
965 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
966 match outbounds.entry(payment_id) {
967 hash_map::Entry::Occupied(mut payment) => {
968 match payment.get() {
969 PendingOutboundPayment::Retryable {
970 total_msat, keysend_preimage, payment_secret, payment_metadata,
971 custom_tlvs, pending_amt_msat, ..
973 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
974 let retry_amt_msat = route.get_total_amount();
975 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
976 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);
977 abandon_with_entry!(payment, PaymentFailureReason::UnexpectedError);
981 if !payment.get().is_retryable_now() {
982 log_error!(logger, "Retries exhausted for payment id {}", &payment_id);
983 abandon_with_entry!(payment, PaymentFailureReason::RetriesExhausted);
987 let total_msat = *total_msat;
988 let recipient_onion = RecipientOnionFields {
989 payment_secret: *payment_secret,
990 payment_metadata: payment_metadata.clone(),
991 custom_tlvs: custom_tlvs.clone(),
993 let keysend_preimage = *keysend_preimage;
995 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
996 for _ in 0..route.paths.len() {
997 onion_session_privs.push(entropy_source.get_secure_random_bytes());
1000 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
1001 assert!(payment.get_mut().insert(*session_priv_bytes, path));
1004 payment.get_mut().increment_attempts();
1006 (total_msat, recipient_onion, keysend_preimage, onion_session_privs)
1008 PendingOutboundPayment::Legacy { .. } => {
1009 log_error!(logger, "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102");
1012 PendingOutboundPayment::AwaitingInvoice { .. } => {
1013 log_error!(logger, "Payment not yet sent");
1016 PendingOutboundPayment::InvoiceReceived { payment_hash, retry_strategy, .. } => {
1017 let total_amount = route_params.final_value_msat;
1018 let recipient_onion = RecipientOnionFields {
1019 payment_secret: None,
1020 payment_metadata: None,
1021 custom_tlvs: vec![],
1023 let retry_strategy = Some(*retry_strategy);
1024 let payment_params = Some(route_params.payment_params.clone());
1025 let (retryable_payment, onion_session_privs) = self.create_pending_payment(
1026 *payment_hash, recipient_onion.clone(), None, &route,
1027 retry_strategy, payment_params, entropy_source, best_block_height
1029 *payment.into_mut() = retryable_payment;
1030 (total_amount, recipient_onion, None, onion_session_privs)
1032 PendingOutboundPayment::Fulfilled { .. } => {
1033 log_error!(logger, "Payment already completed");
1036 PendingOutboundPayment::Abandoned { .. } => {
1037 log_error!(logger, "Payment already abandoned (with some HTLCs still pending)");
1042 hash_map::Entry::Vacant(_) => {
1043 log_error!(logger, "Payment with ID {} not found", &payment_id);
1048 let res = self.pay_route_internal(&route, payment_hash, recipient_onion, keysend_preimage,
1049 payment_id, Some(total_msat), onion_session_privs, node_signer, best_block_height,
1050 &send_payment_along_path);
1051 log_info!(logger, "Result retrying payment id {}: {:?}", &payment_id, res);
1052 if let Err(e) = res {
1053 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);
1057 fn handle_pay_route_err<R: Deref, NS: Deref, ES: Deref, IH, SP, L: Deref>(
1058 &self, err: PaymentSendFailure, payment_id: PaymentId, payment_hash: PaymentHash, route: Route,
1059 mut route_params: RouteParameters, router: &R, first_hops: Vec<ChannelDetails>,
1060 inflight_htlcs: &IH, entropy_source: &ES, node_signer: &NS, best_block_height: u32, logger: &L,
1061 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, send_payment_along_path: &SP,
1065 ES::Target: EntropySource,
1066 NS::Target: NodeSigner,
1068 IH: Fn() -> InFlightHtlcs,
1069 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
1072 PaymentSendFailure::AllFailedResendSafe(errs) => {
1073 Self::push_path_failed_evs_and_scids(payment_id, payment_hash, &mut route_params, route.paths, errs.into_iter().map(|e| Err(e)), logger, pending_events);
1074 self.find_route_and_send_payment(payment_hash, payment_id, route_params, router, first_hops, inflight_htlcs, entropy_source, node_signer, best_block_height, logger, pending_events, send_payment_along_path);
1076 PaymentSendFailure::PartialFailure { failed_paths_retry: Some(mut retry), results, .. } => {
1077 Self::push_path_failed_evs_and_scids(payment_id, payment_hash, &mut retry, route.paths, results.into_iter(), logger, pending_events);
1078 // Some paths were sent, even if we failed to send the full MPP value our recipient may
1079 // misbehave and claim the funds, at which point we have to consider the payment sent, so
1080 // return `Ok()` here, ignoring any retry errors.
1081 self.find_route_and_send_payment(payment_hash, payment_id, retry, router, first_hops, inflight_htlcs, entropy_source, node_signer, best_block_height, logger, pending_events, send_payment_along_path);
1083 PaymentSendFailure::PartialFailure { failed_paths_retry: None, .. } => {
1084 // This may happen if we send a payment and some paths fail, but only due to a temporary
1085 // monitor failure or the like, implying they're really in-flight, but we haven't sent the
1086 // initial HTLC-Add messages yet.
1088 PaymentSendFailure::PathParameterError(results) => {
1089 log_error!(logger, "Failed to send to route due to parameter error in a single path. Your router is buggy");
1090 Self::push_path_failed_evs_and_scids(payment_id, payment_hash, &mut route_params, route.paths, results.into_iter(), logger, pending_events);
1091 self.abandon_payment(payment_id, PaymentFailureReason::UnexpectedError, pending_events);
1093 PaymentSendFailure::ParameterError(e) => {
1094 log_error!(logger, "Failed to send to route due to parameter error: {:?}. Your router is buggy", e);
1095 self.abandon_payment(payment_id, PaymentFailureReason::UnexpectedError, pending_events);
1097 PaymentSendFailure::DuplicatePayment => debug_assert!(false), // unreachable
1101 fn push_path_failed_evs_and_scids<I: ExactSizeIterator + Iterator<Item = Result<(), APIError>>, L: Deref>(
1102 payment_id: PaymentId, payment_hash: PaymentHash, route_params: &mut RouteParameters,
1103 paths: Vec<Path>, path_results: I, logger: &L,
1104 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1105 ) where L::Target: Logger {
1106 let mut events = pending_events.lock().unwrap();
1107 debug_assert_eq!(paths.len(), path_results.len());
1108 for (path, path_res) in paths.into_iter().zip(path_results) {
1109 if let Err(e) = path_res {
1110 if let APIError::MonitorUpdateInProgress = e { continue }
1111 log_error!(logger, "Failed to send along path due to error: {:?}", e);
1112 let mut failed_scid = None;
1113 if let APIError::ChannelUnavailable { .. } = e {
1114 let scid = path.hops[0].short_channel_id;
1115 failed_scid = Some(scid);
1116 route_params.payment_params.previously_failed_channels.push(scid);
1118 events.push_back((events::Event::PaymentPathFailed {
1119 payment_id: Some(payment_id),
1121 payment_failed_permanently: false,
1122 failure: events::PathFailure::InitialSend { err: e },
1124 short_channel_id: failed_scid,
1134 pub(super) fn send_probe<ES: Deref, NS: Deref, F>(
1135 &self, path: Path, probing_cookie_secret: [u8; 32], entropy_source: &ES, node_signer: &NS,
1136 best_block_height: u32, send_payment_along_path: F
1137 ) -> Result<(PaymentHash, PaymentId), PaymentSendFailure>
1139 ES::Target: EntropySource,
1140 NS::Target: NodeSigner,
1141 F: Fn(SendAlongPathArgs) -> Result<(), APIError>,
1143 let payment_id = PaymentId(entropy_source.get_secure_random_bytes());
1144 let payment_secret = PaymentSecret(entropy_source.get_secure_random_bytes());
1146 let payment_hash = probing_cookie_from_id(&payment_id, probing_cookie_secret);
1148 if path.hops.len() < 2 && path.blinded_tail.is_none() {
1149 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
1150 err: "No need probing a path with less than two hops".to_string()
1154 let route = Route { paths: vec![path], route_params: None };
1155 let onion_session_privs = self.add_new_pending_payment(payment_hash,
1156 RecipientOnionFields::secret_only(payment_secret), payment_id, None, &route, None, None,
1157 entropy_source, best_block_height)?;
1159 match self.pay_route_internal(&route, payment_hash, RecipientOnionFields::spontaneous_empty(),
1160 None, payment_id, None, onion_session_privs, node_signer, best_block_height, &send_payment_along_path
1162 Ok(()) => Ok((payment_hash, payment_id)),
1164 self.remove_outbound_if_all_failed(payment_id, &e);
1171 pub(super) fn test_set_payment_metadata(
1172 &self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>
1174 match self.pending_outbound_payments.lock().unwrap().get_mut(&payment_id).unwrap() {
1175 PendingOutboundPayment::Retryable { payment_metadata, .. } => {
1176 *payment_metadata = new_payment_metadata;
1178 _ => panic!("Need a retryable payment to update metadata on"),
1183 pub(super) fn test_add_new_pending_payment<ES: Deref>(
1184 &self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId,
1185 route: &Route, retry_strategy: Option<Retry>, entropy_source: &ES, best_block_height: u32
1186 ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
1187 self.add_new_pending_payment(payment_hash, recipient_onion, payment_id, None, route, retry_strategy, None, entropy_source, best_block_height)
1190 pub(super) fn add_new_pending_payment<ES: Deref>(
1191 &self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId,
1192 keysend_preimage: Option<PaymentPreimage>, route: &Route, retry_strategy: Option<Retry>,
1193 payment_params: Option<PaymentParameters>, entropy_source: &ES, best_block_height: u32
1194 ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
1195 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
1196 match pending_outbounds.entry(payment_id) {
1197 hash_map::Entry::Occupied(_) => Err(PaymentSendFailure::DuplicatePayment),
1198 hash_map::Entry::Vacant(entry) => {
1199 let (payment, onion_session_privs) = self.create_pending_payment(
1200 payment_hash, recipient_onion, keysend_preimage, route, retry_strategy,
1201 payment_params, entropy_source, best_block_height
1203 entry.insert(payment);
1204 Ok(onion_session_privs)
1209 fn create_pending_payment<ES: Deref>(
1210 &self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields,
1211 keysend_preimage: Option<PaymentPreimage>, route: &Route, retry_strategy: Option<Retry>,
1212 payment_params: Option<PaymentParameters>, entropy_source: &ES, best_block_height: u32
1213 ) -> (PendingOutboundPayment, Vec<[u8; 32]>)
1215 ES::Target: EntropySource,
1217 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
1218 for _ in 0..route.paths.len() {
1219 onion_session_privs.push(entropy_source.get_secure_random_bytes());
1222 let mut payment = PendingOutboundPayment::Retryable {
1224 attempts: PaymentAttempts::new(),
1226 session_privs: HashSet::new(),
1227 pending_amt_msat: 0,
1228 pending_fee_msat: Some(0),
1230 payment_secret: recipient_onion.payment_secret,
1231 payment_metadata: recipient_onion.payment_metadata,
1233 custom_tlvs: recipient_onion.custom_tlvs,
1234 starting_block_height: best_block_height,
1235 total_msat: route.get_total_amount(),
1236 remaining_max_total_routing_fee_msat:
1237 route.route_params.as_ref().and_then(|p| p.max_total_routing_fee_msat),
1240 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
1241 assert!(payment.insert(*session_priv_bytes, path));
1244 (payment, onion_session_privs)
1248 pub(super) fn add_new_awaiting_invoice(
1249 &self, payment_id: PaymentId, retry_strategy: Retry, max_total_routing_fee_msat: Option<u64>
1250 ) -> Result<(), ()> {
1251 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
1252 match pending_outbounds.entry(payment_id) {
1253 hash_map::Entry::Occupied(_) => Err(()),
1254 hash_map::Entry::Vacant(entry) => {
1255 entry.insert(PendingOutboundPayment::AwaitingInvoice {
1256 timer_ticks_without_response: 0,
1258 max_total_routing_fee_msat,
1266 fn pay_route_internal<NS: Deref, F>(
1267 &self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields,
1268 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
1269 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
1270 send_payment_along_path: &F
1271 ) -> Result<(), PaymentSendFailure>
1273 NS::Target: NodeSigner,
1274 F: Fn(SendAlongPathArgs) -> Result<(), APIError>,
1276 if route.paths.len() < 1 {
1277 return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over".to_owned()}));
1279 if recipient_onion.payment_secret.is_none() && route.paths.len() > 1
1280 && !route.paths.iter().any(|p| p.blinded_tail.is_some())
1282 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_owned()}));
1284 let mut total_value = 0;
1285 let our_node_id = node_signer.get_node_id(Recipient::Node).unwrap(); // TODO no unwrap
1286 let mut path_errs = Vec::with_capacity(route.paths.len());
1287 'path_check: for path in route.paths.iter() {
1288 if path.hops.len() < 1 || path.hops.len() > 20 {
1289 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size".to_owned()}));
1290 continue 'path_check;
1292 let dest_hop_idx = if path.blinded_tail.is_some() && path.blinded_tail.as_ref().unwrap().hops.len() > 1 {
1293 usize::max_value() } else { path.hops.len() - 1 };
1294 for (idx, hop) in path.hops.iter().enumerate() {
1295 if idx != dest_hop_idx && hop.pubkey == our_node_id {
1296 path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us".to_owned()}));
1297 continue 'path_check;
1300 total_value += path.final_value_msat();
1301 path_errs.push(Ok(()));
1303 if path_errs.iter().any(|e| e.is_err()) {
1304 return Err(PaymentSendFailure::PathParameterError(path_errs));
1306 if let Some(amt_msat) = recv_value_msat {
1307 total_value = amt_msat;
1310 let cur_height = best_block_height + 1;
1311 let mut results = Vec::new();
1312 debug_assert_eq!(route.paths.len(), onion_session_privs.len());
1313 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.into_iter()) {
1314 let mut path_res = send_payment_along_path(SendAlongPathArgs {
1315 path: &path, payment_hash: &payment_hash, recipient_onion: recipient_onion.clone(),
1316 total_value, cur_height, payment_id, keysend_preimage: &keysend_preimage, session_priv_bytes
1320 Err(APIError::MonitorUpdateInProgress) => {
1321 // While a MonitorUpdateInProgress is an Err(_), the payment is still
1322 // considered "in flight" and we shouldn't remove it from the
1323 // PendingOutboundPayment set.
1326 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
1327 if let Some(payment) = pending_outbounds.get_mut(&payment_id) {
1328 let removed = payment.remove(&session_priv_bytes, Some(path));
1329 debug_assert!(removed, "This can't happen as the payment has an entry for this path added by callers");
1331 debug_assert!(false, "This can't happen as the payment was added by callers");
1332 path_res = Err(APIError::APIMisuseError { err: "Internal error: payment disappeared during processing. Please report this bug!".to_owned() });
1336 results.push(path_res);
1338 let mut has_ok = false;
1339 let mut has_err = false;
1340 let mut pending_amt_unsent = 0;
1341 let mut total_ok_fees_msat = 0;
1342 for (res, path) in results.iter().zip(route.paths.iter()) {
1345 total_ok_fees_msat += path.fee_msat();
1347 if res.is_err() { has_err = true; }
1348 if let &Err(APIError::MonitorUpdateInProgress) = res {
1349 // MonitorUpdateInProgress is inherently unsafe to retry, so we call it a
1353 total_ok_fees_msat += path.fee_msat();
1354 } else if res.is_err() {
1355 pending_amt_unsent += path.final_value_msat();
1358 if has_err && has_ok {
1359 Err(PaymentSendFailure::PartialFailure {
1362 failed_paths_retry: if pending_amt_unsent != 0 {
1363 if let Some(route_params) = &route.route_params {
1364 let mut route_params = route_params.clone();
1365 // We calculate the leftover fee budget we're allowed to spend by
1366 // subtracting the used fee from the total fee budget.
1367 route_params.max_total_routing_fee_msat = route_params
1368 .max_total_routing_fee_msat.map(|m| m.saturating_sub(total_ok_fees_msat));
1369 route_params.final_value_msat = pending_amt_unsent;
1376 Err(PaymentSendFailure::AllFailedResendSafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
1383 pub(super) fn test_send_payment_internal<NS: Deref, F>(
1384 &self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields,
1385 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
1386 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
1387 send_payment_along_path: F
1388 ) -> Result<(), PaymentSendFailure>
1390 NS::Target: NodeSigner,
1391 F: Fn(SendAlongPathArgs) -> Result<(), APIError>,
1393 self.pay_route_internal(route, payment_hash, recipient_onion, keysend_preimage, payment_id,
1394 recv_value_msat, onion_session_privs, node_signer, best_block_height,
1395 &send_payment_along_path)
1396 .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
1399 // If we failed to send any paths, remove the new PaymentId from the `pending_outbound_payments`
1400 // map as the payment is free to be resent.
1401 fn remove_outbound_if_all_failed(&self, payment_id: PaymentId, err: &PaymentSendFailure) {
1402 if let &PaymentSendFailure::AllFailedResendSafe(_) = err {
1403 let removed = self.pending_outbound_payments.lock().unwrap().remove(&payment_id).is_some();
1404 debug_assert!(removed, "We should always have a pending payment to remove here");
1408 pub(super) fn claim_htlc<L: Deref>(
1409 &self, payment_id: PaymentId, payment_preimage: PaymentPreimage, session_priv: SecretKey,
1410 path: Path, from_onchain: bool, ev_completion_action: EventCompletionAction,
1411 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1413 ) where L::Target: Logger {
1414 let mut session_priv_bytes = [0; 32];
1415 session_priv_bytes.copy_from_slice(&session_priv[..]);
1416 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1417 let mut pending_events = pending_events.lock().unwrap();
1418 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
1419 if !payment.get().is_fulfilled() {
1420 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1421 log_info!(logger, "Payment with id {} and hash {} sent!", payment_id, payment_hash);
1422 let fee_paid_msat = payment.get().get_pending_fee_msat();
1423 pending_events.push_back((events::Event::PaymentSent {
1424 payment_id: Some(payment_id),
1428 }, Some(ev_completion_action.clone())));
1429 payment.get_mut().mark_fulfilled();
1433 // We currently immediately remove HTLCs which were fulfilled on-chain.
1434 // This could potentially lead to removing a pending payment too early,
1435 // with a reorg of one block causing us to re-add the fulfilled payment on
1437 // TODO: We should have a second monitor event that informs us of payments
1438 // irrevocably fulfilled.
1439 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
1440 let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
1441 pending_events.push_back((events::Event::PaymentPathSuccessful {
1445 }, Some(ev_completion_action)));
1449 log_trace!(logger, "Received duplicative fulfill for HTLC with payment_preimage {}", &payment_preimage);
1453 pub(super) fn finalize_claims(&self, sources: Vec<HTLCSource>,
1454 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>)
1456 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1457 let mut pending_events = pending_events.lock().unwrap();
1458 for source in sources {
1459 if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
1460 let mut session_priv_bytes = [0; 32];
1461 session_priv_bytes.copy_from_slice(&session_priv[..]);
1462 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
1463 assert!(payment.get().is_fulfilled());
1464 if payment.get_mut().remove(&session_priv_bytes, None) {
1465 let payment_hash = payment.get().payment_hash();
1466 debug_assert!(payment_hash.is_some());
1467 pending_events.push_back((events::Event::PaymentPathSuccessful {
1478 pub(super) fn remove_stale_payments(
1479 &self, pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>)
1481 let mut pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
1482 let mut pending_events = pending_events.lock().unwrap();
1483 pending_outbound_payments.retain(|payment_id, payment| {
1484 // If an outbound payment was completed, and no pending HTLCs remain, we should remove it
1485 // from the map. However, if we did that immediately when the last payment HTLC is claimed,
1486 // this could race the user making a duplicate send_payment call and our idempotency
1487 // guarantees would be violated. Instead, we wait a few timer ticks to do the actual
1488 // removal. This should be more than sufficient to ensure the idempotency of any
1489 // `send_payment` calls that were made at the same time the `PaymentSent` event was being
1491 if let PendingOutboundPayment::Fulfilled { session_privs, timer_ticks_without_htlcs, .. } = payment {
1492 let mut no_remaining_entries = session_privs.is_empty();
1493 if no_remaining_entries {
1494 for (ev, _) in pending_events.iter() {
1496 events::Event::PaymentSent { payment_id: Some(ev_payment_id), .. } |
1497 events::Event::PaymentPathSuccessful { payment_id: ev_payment_id, .. } |
1498 events::Event::PaymentPathFailed { payment_id: Some(ev_payment_id), .. } => {
1499 if payment_id == ev_payment_id {
1500 no_remaining_entries = false;
1508 if no_remaining_entries {
1509 *timer_ticks_without_htlcs += 1;
1510 *timer_ticks_without_htlcs <= IDEMPOTENCY_TIMEOUT_TICKS
1512 *timer_ticks_without_htlcs = 0;
1515 } else if let PendingOutboundPayment::AwaitingInvoice { timer_ticks_without_response, .. } = payment {
1516 *timer_ticks_without_response += 1;
1517 if *timer_ticks_without_response <= INVOICE_REQUEST_TIMEOUT_TICKS {
1520 pending_events.push_back(
1521 (events::Event::InvoiceRequestFailed { payment_id: *payment_id }, None)
1529 // Returns a bool indicating whether a PendingHTLCsForwardable event should be generated.
1530 pub(super) fn fail_htlc<L: Deref>(
1531 &self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason,
1532 path: &Path, session_priv: &SecretKey, payment_id: &PaymentId,
1533 probing_cookie_secret: [u8; 32], secp_ctx: &Secp256k1<secp256k1::All>,
1534 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, logger: &L,
1535 ) -> bool where L::Target: Logger {
1537 let DecodedOnionFailure {
1538 network_update, short_channel_id, payment_retryable, onion_error_code, onion_error_data
1539 } = onion_error.decode_onion_failure(secp_ctx, logger, &source);
1541 let DecodedOnionFailure { network_update, short_channel_id, payment_retryable } =
1542 onion_error.decode_onion_failure(secp_ctx, logger, &source);
1544 let payment_is_probe = payment_is_probe(payment_hash, &payment_id, probing_cookie_secret);
1545 let mut session_priv_bytes = [0; 32];
1546 session_priv_bytes.copy_from_slice(&session_priv[..]);
1547 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1549 // If any payments already need retry, there's no need to generate a redundant
1550 // `PendingHTLCsForwardable`.
1551 let already_awaiting_retry = outbounds.iter().any(|(_, pmt)| {
1552 let mut awaiting_retry = false;
1553 if pmt.is_auto_retryable_now() {
1554 if let PendingOutboundPayment::Retryable { pending_amt_msat, total_msat, .. } = pmt {
1555 if pending_amt_msat < total_msat {
1556 awaiting_retry = true;
1563 let mut full_failure_ev = None;
1564 let mut pending_retry_ev = false;
1565 let attempts_remaining = if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(*payment_id) {
1566 if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
1567 log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", &payment_hash);
1570 if payment.get().is_fulfilled() {
1571 log_trace!(logger, "Received failure of HTLC with payment_hash {} after payment completion", &payment_hash);
1574 let mut is_retryable_now = payment.get().is_auto_retryable_now();
1575 if let Some(scid) = short_channel_id {
1576 // TODO: If we decided to blame ourselves (or one of our channels) in
1577 // process_onion_failure we should close that channel as it implies our
1578 // next-hop is needlessly blaming us!
1579 payment.get_mut().insert_previously_failed_scid(scid);
1582 if payment_is_probe || !is_retryable_now || !payment_retryable {
1583 let reason = if !payment_retryable {
1584 PaymentFailureReason::RecipientRejected
1586 PaymentFailureReason::RetriesExhausted
1588 payment.get_mut().mark_abandoned(reason);
1589 is_retryable_now = false;
1591 if payment.get().remaining_parts() == 0 {
1592 if let PendingOutboundPayment::Abandoned { payment_hash, reason, .. } = payment.get() {
1593 if !payment_is_probe {
1594 full_failure_ev = Some(events::Event::PaymentFailed {
1595 payment_id: *payment_id,
1596 payment_hash: *payment_hash,
1605 log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", &payment_hash);
1608 core::mem::drop(outbounds);
1609 log_trace!(logger, "Failing outbound payment HTLC with payment_hash {}", &payment_hash);
1611 let path_failure = {
1612 if payment_is_probe {
1613 if !payment_retryable {
1614 events::Event::ProbeSuccessful {
1615 payment_id: *payment_id,
1616 payment_hash: payment_hash.clone(),
1620 events::Event::ProbeFailed {
1621 payment_id: *payment_id,
1622 payment_hash: payment_hash.clone(),
1628 // If we miss abandoning the payment above, we *must* generate an event here or else the
1629 // payment will sit in our outbounds forever.
1630 if attempts_remaining && !already_awaiting_retry {
1631 debug_assert!(full_failure_ev.is_none());
1632 pending_retry_ev = true;
1634 events::Event::PaymentPathFailed {
1635 payment_id: Some(*payment_id),
1636 payment_hash: payment_hash.clone(),
1637 payment_failed_permanently: !payment_retryable,
1638 failure: events::PathFailure::OnPath { network_update },
1642 error_code: onion_error_code,
1644 error_data: onion_error_data
1648 let mut pending_events = pending_events.lock().unwrap();
1649 pending_events.push_back((path_failure, None));
1650 if let Some(ev) = full_failure_ev { pending_events.push_back((ev, None)); }
1654 pub(super) fn abandon_payment(
1655 &self, payment_id: PaymentId, reason: PaymentFailureReason,
1656 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>
1658 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1659 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
1660 payment.get_mut().mark_abandoned(reason);
1661 if let PendingOutboundPayment::Abandoned { payment_hash, reason, .. } = payment.get() {
1662 if payment.get().remaining_parts() == 0 {
1663 pending_events.lock().unwrap().push_back((events::Event::PaymentFailed {
1665 payment_hash: *payment_hash,
1670 } else if let PendingOutboundPayment::AwaitingInvoice { .. } = payment.get() {
1671 pending_events.lock().unwrap().push_back((events::Event::InvoiceRequestFailed {
1680 pub fn has_pending_payments(&self) -> bool {
1681 !self.pending_outbound_payments.lock().unwrap().is_empty()
1685 pub fn clear_pending_payments(&self) {
1686 self.pending_outbound_payments.lock().unwrap().clear()
1690 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
1692 pub(super) fn payment_is_probe(payment_hash: &PaymentHash, payment_id: &PaymentId,
1693 probing_cookie_secret: [u8; 32]) -> bool
1695 let target_payment_hash = probing_cookie_from_id(payment_id, probing_cookie_secret);
1696 target_payment_hash == *payment_hash
1699 /// Returns the 'probing cookie' for the given [`PaymentId`].
1700 fn probing_cookie_from_id(payment_id: &PaymentId, probing_cookie_secret: [u8; 32]) -> PaymentHash {
1701 let mut preimage = [0u8; 64];
1702 preimage[..32].copy_from_slice(&probing_cookie_secret);
1703 preimage[32..].copy_from_slice(&payment_id.0);
1704 PaymentHash(Sha256::hash(&preimage).into_inner())
1707 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
1709 (0, session_privs, required),
1712 (0, session_privs, required),
1713 (1, payment_hash, option),
1714 (3, timer_ticks_without_htlcs, (default_value, 0)),
1717 (0, session_privs, required),
1718 (1, pending_fee_msat, option),
1719 (2, payment_hash, required),
1720 // Note that while we "default" payment_param's final CLTV expiry delta to 0 we should
1721 // never see it - `payment_params` was added here after the field was added/required.
1722 (3, payment_params, (option: ReadableArgs, 0)),
1723 (4, payment_secret, option),
1724 (5, keysend_preimage, option),
1725 (6, total_msat, required),
1726 (7, payment_metadata, option),
1727 (8, pending_amt_msat, required),
1728 (9, custom_tlvs, optional_vec),
1729 (10, starting_block_height, required),
1730 (11, remaining_max_total_routing_fee_msat, option),
1731 (not_written, retry_strategy, (static_value, None)),
1732 (not_written, attempts, (static_value, PaymentAttempts::new())),
1735 (0, session_privs, required),
1736 (1, reason, option),
1737 (2, payment_hash, required),
1739 (5, AwaitingInvoice) => {
1740 (0, timer_ticks_without_response, required),
1741 (2, retry_strategy, required),
1742 (4, max_total_routing_fee_msat, option),
1744 (7, InvoiceReceived) => {
1745 (0, payment_hash, required),
1746 (2, retry_strategy, required),
1747 (4, max_total_routing_fee_msat, option),
1753 use bitcoin::network::constants::Network;
1754 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
1756 use crate::events::{Event, PathFailure, PaymentFailureReason};
1757 use crate::ln::PaymentHash;
1758 use crate::ln::channelmanager::{PaymentId, RecipientOnionFields};
1759 use crate::ln::features::{ChannelFeatures, NodeFeatures};
1760 use crate::ln::msgs::{ErrorAction, LightningError};
1761 use crate::ln::outbound_payment::{Bolt12PaymentError, INVOICE_REQUEST_TIMEOUT_TICKS, OutboundPayments, Retry, RetryableSendFailure};
1762 use crate::offers::invoice::DEFAULT_RELATIVE_EXPIRY;
1763 use crate::offers::offer::OfferBuilder;
1764 use crate::offers::test_utils::*;
1765 use crate::routing::gossip::NetworkGraph;
1766 use crate::routing::router::{InFlightHtlcs, Path, PaymentParameters, Route, RouteHop, RouteParameters};
1767 use crate::sync::{Arc, Mutex, RwLock};
1768 use crate::util::errors::APIError;
1769 use crate::util::test_utils;
1771 use alloc::collections::VecDeque;
1774 fn test_recipient_onion_fields_with_custom_tlvs() {
1775 let onion_fields = RecipientOnionFields::spontaneous_empty();
1777 let bad_type_range_tlvs = vec![
1781 assert!(onion_fields.clone().with_custom_tlvs(bad_type_range_tlvs).is_err());
1783 let keysend_tlv = vec![
1784 (5482373484, vec![42; 32]),
1786 assert!(onion_fields.clone().with_custom_tlvs(keysend_tlv).is_err());
1788 let good_tlvs = vec![
1789 ((1 << 16) + 1, vec![42]),
1790 ((1 << 16) + 3, vec![42; 32]),
1792 assert!(onion_fields.with_custom_tlvs(good_tlvs).is_ok());
1796 #[cfg(feature = "std")]
1797 fn fails_paying_after_expiration() {
1798 do_fails_paying_after_expiration(false);
1799 do_fails_paying_after_expiration(true);
1801 #[cfg(feature = "std")]
1802 fn do_fails_paying_after_expiration(on_retry: bool) {
1803 let outbound_payments = OutboundPayments::new();
1804 let logger = test_utils::TestLogger::new();
1805 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
1806 let scorer = RwLock::new(test_utils::TestScorer::new());
1807 let router = test_utils::TestRouter::new(network_graph, &scorer);
1808 let secp_ctx = Secp256k1::new();
1809 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1811 let past_expiry_time = std::time::SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() - 2;
1812 let payment_params = PaymentParameters::from_node_id(
1813 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()),
1815 ).with_expiry_time(past_expiry_time);
1816 let expired_route_params = RouteParameters::from_payment_params_and_value(payment_params, 0);
1817 let pending_events = Mutex::new(VecDeque::new());
1819 outbound_payments.add_new_pending_payment(PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(),
1820 PaymentId([0; 32]), None, &Route { paths: vec![], route_params: None },
1821 Some(Retry::Attempts(1)), Some(expired_route_params.payment_params.clone()),
1822 &&keys_manager, 0).unwrap();
1823 outbound_payments.find_route_and_send_payment(
1824 PaymentHash([0; 32]), PaymentId([0; 32]), expired_route_params, &&router, vec![],
1825 &|| InFlightHtlcs::new(), &&keys_manager, &&keys_manager, 0, &&logger, &pending_events,
1827 let events = pending_events.lock().unwrap();
1828 assert_eq!(events.len(), 1);
1829 if let Event::PaymentFailed { ref reason, .. } = events[0].0 {
1830 assert_eq!(reason.unwrap(), PaymentFailureReason::PaymentExpired);
1831 } else { panic!("Unexpected event"); }
1833 let err = outbound_payments.send_payment(
1834 PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(), PaymentId([0; 32]),
1835 Retry::Attempts(0), expired_route_params, &&router, vec![], || InFlightHtlcs::new(),
1836 &&keys_manager, &&keys_manager, 0, &&logger, &pending_events, |_| Ok(())).unwrap_err();
1837 if let RetryableSendFailure::PaymentExpired = err { } else { panic!("Unexpected error"); }
1842 fn find_route_error() {
1843 do_find_route_error(false);
1844 do_find_route_error(true);
1846 fn do_find_route_error(on_retry: bool) {
1847 let outbound_payments = OutboundPayments::new();
1848 let logger = test_utils::TestLogger::new();
1849 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
1850 let scorer = RwLock::new(test_utils::TestScorer::new());
1851 let router = test_utils::TestRouter::new(network_graph, &scorer);
1852 let secp_ctx = Secp256k1::new();
1853 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1855 let payment_params = PaymentParameters::from_node_id(
1856 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()), 0);
1857 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 0);
1858 router.expect_find_route(route_params.clone(),
1859 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
1861 let pending_events = Mutex::new(VecDeque::new());
1863 outbound_payments.add_new_pending_payment(PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(),
1864 PaymentId([0; 32]), None, &Route { paths: vec![], route_params: None },
1865 Some(Retry::Attempts(1)), Some(route_params.payment_params.clone()),
1866 &&keys_manager, 0).unwrap();
1867 outbound_payments.find_route_and_send_payment(
1868 PaymentHash([0; 32]), PaymentId([0; 32]), route_params, &&router, vec![],
1869 &|| InFlightHtlcs::new(), &&keys_manager, &&keys_manager, 0, &&logger, &pending_events,
1871 let events = pending_events.lock().unwrap();
1872 assert_eq!(events.len(), 1);
1873 if let Event::PaymentFailed { .. } = events[0].0 { } else { panic!("Unexpected event"); }
1875 let err = outbound_payments.send_payment(
1876 PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(), PaymentId([0; 32]),
1877 Retry::Attempts(0), route_params, &&router, vec![], || InFlightHtlcs::new(),
1878 &&keys_manager, &&keys_manager, 0, &&logger, &pending_events, |_| Ok(())).unwrap_err();
1879 if let RetryableSendFailure::RouteNotFound = err {
1880 } else { panic!("Unexpected error"); }
1885 fn initial_send_payment_path_failed_evs() {
1886 let outbound_payments = OutboundPayments::new();
1887 let logger = test_utils::TestLogger::new();
1888 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
1889 let scorer = RwLock::new(test_utils::TestScorer::new());
1890 let router = test_utils::TestRouter::new(network_graph, &scorer);
1891 let secp_ctx = Secp256k1::new();
1892 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1894 let sender_pk = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
1895 let receiver_pk = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[43; 32]).unwrap());
1896 let payment_params = PaymentParameters::from_node_id(sender_pk, 0);
1897 let route_params = RouteParameters::from_payment_params_and_value(payment_params.clone(), 0);
1898 let failed_scid = 42;
1900 paths: vec![Path { hops: vec![RouteHop {
1901 pubkey: receiver_pk,
1902 node_features: NodeFeatures::empty(),
1903 short_channel_id: failed_scid,
1904 channel_features: ChannelFeatures::empty(),
1906 cltv_expiry_delta: 0,
1907 maybe_announced_channel: true,
1908 }], blinded_tail: None }],
1909 route_params: Some(route_params.clone()),
1911 router.expect_find_route(route_params.clone(), Ok(route.clone()));
1912 let mut route_params_w_failed_scid = route_params.clone();
1913 route_params_w_failed_scid.payment_params.previously_failed_channels.push(failed_scid);
1914 router.expect_find_route(route_params_w_failed_scid, Ok(route.clone()));
1915 router.expect_find_route(route_params.clone(), Ok(route.clone()));
1916 router.expect_find_route(route_params.clone(), Ok(route.clone()));
1918 // Ensure that a ChannelUnavailable error will result in blaming an scid in the
1919 // PaymentPathFailed event.
1920 let pending_events = Mutex::new(VecDeque::new());
1921 outbound_payments.send_payment(
1922 PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(), PaymentId([0; 32]),
1923 Retry::Attempts(0), route_params.clone(), &&router, vec![], || InFlightHtlcs::new(),
1924 &&keys_manager, &&keys_manager, 0, &&logger, &pending_events,
1925 |_| Err(APIError::ChannelUnavailable { err: "test".to_owned() })).unwrap();
1926 let mut events = pending_events.lock().unwrap();
1927 assert_eq!(events.len(), 2);
1928 if let Event::PaymentPathFailed {
1930 failure: PathFailure::InitialSend { err: APIError::ChannelUnavailable { .. }}, .. } = events[0].0
1932 assert_eq!(short_channel_id, Some(failed_scid));
1933 } else { panic!("Unexpected event"); }
1934 if let Event::PaymentFailed { .. } = events[1].0 { } else { panic!("Unexpected event"); }
1936 core::mem::drop(events);
1938 // Ensure that a MonitorUpdateInProgress "error" will not result in a PaymentPathFailed event.
1939 outbound_payments.send_payment(
1940 PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(), PaymentId([0; 32]),
1941 Retry::Attempts(0), route_params.clone(), &&router, vec![], || InFlightHtlcs::new(),
1942 &&keys_manager, &&keys_manager, 0, &&logger, &pending_events,
1943 |_| Err(APIError::MonitorUpdateInProgress)).unwrap();
1944 assert_eq!(pending_events.lock().unwrap().len(), 0);
1946 // Ensure that any other error will result in a PaymentPathFailed event but no blamed scid.
1947 outbound_payments.send_payment(
1948 PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(), PaymentId([1; 32]),
1949 Retry::Attempts(0), route_params.clone(), &&router, vec![], || InFlightHtlcs::new(),
1950 &&keys_manager, &&keys_manager, 0, &&logger, &pending_events,
1951 |_| Err(APIError::APIMisuseError { err: "test".to_owned() })).unwrap();
1952 let events = pending_events.lock().unwrap();
1953 assert_eq!(events.len(), 2);
1954 if let Event::PaymentPathFailed {
1956 failure: PathFailure::InitialSend { err: APIError::APIMisuseError { .. }}, .. } = events[0].0
1958 assert_eq!(short_channel_id, None);
1959 } else { panic!("Unexpected event"); }
1960 if let Event::PaymentFailed { .. } = events[1].0 { } else { panic!("Unexpected event"); }
1964 fn removes_stale_awaiting_invoice() {
1965 let pending_events = Mutex::new(VecDeque::new());
1966 let outbound_payments = OutboundPayments::new();
1967 let payment_id = PaymentId([0; 32]);
1969 assert!(!outbound_payments.has_pending_payments());
1971 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), None).is_ok()
1973 assert!(outbound_payments.has_pending_payments());
1975 for _ in 0..INVOICE_REQUEST_TIMEOUT_TICKS {
1976 outbound_payments.remove_stale_payments(&pending_events);
1977 assert!(outbound_payments.has_pending_payments());
1978 assert!(pending_events.lock().unwrap().is_empty());
1981 outbound_payments.remove_stale_payments(&pending_events);
1982 assert!(!outbound_payments.has_pending_payments());
1983 assert!(!pending_events.lock().unwrap().is_empty());
1985 pending_events.lock().unwrap().pop_front(),
1986 Some((Event::InvoiceRequestFailed { payment_id }, None)),
1988 assert!(pending_events.lock().unwrap().is_empty());
1991 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), None).is_ok()
1993 assert!(outbound_payments.has_pending_payments());
1996 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), None)
2002 fn removes_abandoned_awaiting_invoice() {
2003 let pending_events = Mutex::new(VecDeque::new());
2004 let outbound_payments = OutboundPayments::new();
2005 let payment_id = PaymentId([0; 32]);
2007 assert!(!outbound_payments.has_pending_payments());
2009 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), None).is_ok()
2011 assert!(outbound_payments.has_pending_payments());
2013 outbound_payments.abandon_payment(
2014 payment_id, PaymentFailureReason::UserAbandoned, &pending_events
2016 assert!(!outbound_payments.has_pending_payments());
2017 assert!(!pending_events.lock().unwrap().is_empty());
2019 pending_events.lock().unwrap().pop_front(),
2020 Some((Event::InvoiceRequestFailed { payment_id }, None)),
2022 assert!(pending_events.lock().unwrap().is_empty());
2025 #[cfg(feature = "std")]
2027 fn fails_sending_payment_for_expired_bolt12_invoice() {
2028 let logger = test_utils::TestLogger::new();
2029 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
2030 let scorer = RwLock::new(test_utils::TestScorer::new());
2031 let router = test_utils::TestRouter::new(network_graph, &scorer);
2032 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
2034 let pending_events = Mutex::new(VecDeque::new());
2035 let outbound_payments = OutboundPayments::new();
2036 let payment_id = PaymentId([0; 32]);
2039 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), None).is_ok()
2041 assert!(outbound_payments.has_pending_payments());
2043 let created_at = now() - DEFAULT_RELATIVE_EXPIRY;
2044 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2047 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2049 .sign(payer_sign).unwrap()
2050 .respond_with_no_std(payment_paths(), payment_hash(), created_at).unwrap()
2052 .sign(recipient_sign).unwrap();
2055 outbound_payments.send_payment_for_bolt12_invoice(
2056 &invoice, payment_id, &&router, vec![], || InFlightHtlcs::new(), &&keys_manager,
2057 &&keys_manager, 0, &&logger, &pending_events, |_| panic!()
2061 assert!(!outbound_payments.has_pending_payments());
2063 let payment_hash = invoice.payment_hash();
2064 let reason = Some(PaymentFailureReason::PaymentExpired);
2066 assert!(!pending_events.lock().unwrap().is_empty());
2068 pending_events.lock().unwrap().pop_front(),
2069 Some((Event::PaymentFailed { payment_id, payment_hash, reason }, None)),
2071 assert!(pending_events.lock().unwrap().is_empty());
2075 fn fails_finding_route_for_bolt12_invoice() {
2076 let logger = test_utils::TestLogger::new();
2077 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
2078 let scorer = RwLock::new(test_utils::TestScorer::new());
2079 let router = test_utils::TestRouter::new(network_graph, &scorer);
2080 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
2082 let pending_events = Mutex::new(VecDeque::new());
2083 let outbound_payments = OutboundPayments::new();
2084 let payment_id = PaymentId([0; 32]);
2087 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), None).is_ok()
2089 assert!(outbound_payments.has_pending_payments());
2091 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2094 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2096 .sign(payer_sign).unwrap()
2097 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2099 .sign(recipient_sign).unwrap();
2101 router.expect_find_route(
2102 RouteParameters::from_payment_params_and_value(
2103 PaymentParameters::from_bolt12_invoice(&invoice),
2104 invoice.amount_msats(),
2106 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }),
2110 outbound_payments.send_payment_for_bolt12_invoice(
2111 &invoice, payment_id, &&router, vec![], || InFlightHtlcs::new(), &&keys_manager,
2112 &&keys_manager, 0, &&logger, &pending_events, |_| panic!()
2116 assert!(!outbound_payments.has_pending_payments());
2118 let payment_hash = invoice.payment_hash();
2119 let reason = Some(PaymentFailureReason::RouteNotFound);
2121 assert!(!pending_events.lock().unwrap().is_empty());
2123 pending_events.lock().unwrap().pop_front(),
2124 Some((Event::PaymentFailed { payment_id, payment_hash, reason }, None)),
2126 assert!(pending_events.lock().unwrap().is_empty());
2130 fn fails_paying_for_bolt12_invoice() {
2131 let logger = test_utils::TestLogger::new();
2132 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
2133 let scorer = RwLock::new(test_utils::TestScorer::new());
2134 let router = test_utils::TestRouter::new(network_graph, &scorer);
2135 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
2137 let pending_events = Mutex::new(VecDeque::new());
2138 let outbound_payments = OutboundPayments::new();
2139 let payment_id = PaymentId([0; 32]);
2142 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), None).is_ok()
2144 assert!(outbound_payments.has_pending_payments());
2146 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2149 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2151 .sign(payer_sign).unwrap()
2152 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2154 .sign(recipient_sign).unwrap();
2156 let route_params = RouteParameters::from_payment_params_and_value(
2157 PaymentParameters::from_bolt12_invoice(&invoice),
2158 invoice.amount_msats(),
2160 router.expect_find_route(
2161 route_params.clone(), Ok(Route { paths: vec![], route_params: Some(route_params) })
2165 outbound_payments.send_payment_for_bolt12_invoice(
2166 &invoice, payment_id, &&router, vec![], || InFlightHtlcs::new(), &&keys_manager,
2167 &&keys_manager, 0, &&logger, &pending_events, |_| panic!()
2171 assert!(!outbound_payments.has_pending_payments());
2173 let payment_hash = invoice.payment_hash();
2174 let reason = Some(PaymentFailureReason::UnexpectedError);
2176 assert!(!pending_events.lock().unwrap().is_empty());
2178 pending_events.lock().unwrap().pop_front(),
2179 Some((Event::PaymentFailed { payment_id, payment_hash, reason }, None)),
2181 assert!(pending_events.lock().unwrap().is_empty());
2185 fn sends_payment_for_bolt12_invoice() {
2186 let logger = test_utils::TestLogger::new();
2187 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
2188 let scorer = RwLock::new(test_utils::TestScorer::new());
2189 let router = test_utils::TestRouter::new(network_graph, &scorer);
2190 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
2192 let pending_events = Mutex::new(VecDeque::new());
2193 let outbound_payments = OutboundPayments::new();
2194 let payment_id = PaymentId([0; 32]);
2196 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2199 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2201 .sign(payer_sign).unwrap()
2202 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2204 .sign(recipient_sign).unwrap();
2206 let route_params = RouteParameters {
2207 payment_params: PaymentParameters::from_bolt12_invoice(&invoice),
2208 final_value_msat: invoice.amount_msats(),
2209 max_total_routing_fee_msat: Some(1234),
2211 router.expect_find_route(
2212 route_params.clone(),
2218 pubkey: recipient_pubkey(),
2219 node_features: NodeFeatures::empty(),
2220 short_channel_id: 42,
2221 channel_features: ChannelFeatures::empty(),
2222 fee_msat: invoice.amount_msats(),
2223 cltv_expiry_delta: 0,
2224 maybe_announced_channel: true,
2230 route_params: Some(route_params),
2234 assert!(!outbound_payments.has_pending_payments());
2236 outbound_payments.send_payment_for_bolt12_invoice(
2237 &invoice, payment_id, &&router, vec![], || InFlightHtlcs::new(), &&keys_manager,
2238 &&keys_manager, 0, &&logger, &pending_events, |_| panic!()
2240 Err(Bolt12PaymentError::UnexpectedInvoice),
2242 assert!(!outbound_payments.has_pending_payments());
2243 assert!(pending_events.lock().unwrap().is_empty());
2246 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), Some(1234)).is_ok()
2248 assert!(outbound_payments.has_pending_payments());
2251 outbound_payments.send_payment_for_bolt12_invoice(
2252 &invoice, payment_id, &&router, vec![], || InFlightHtlcs::new(), &&keys_manager,
2253 &&keys_manager, 0, &&logger, &pending_events, |_| Ok(())
2257 assert!(outbound_payments.has_pending_payments());
2258 assert!(pending_events.lock().unwrap().is_empty());
2261 outbound_payments.send_payment_for_bolt12_invoice(
2262 &invoice, payment_id, &&router, vec![], || InFlightHtlcs::new(), &&keys_manager,
2263 &&keys_manager, 0, &&logger, &pending_events, |_| panic!()
2265 Err(Bolt12PaymentError::DuplicateInvoice),
2267 assert!(outbound_payments.has_pending_payments());
2268 assert!(pending_events.lock().unwrap().is_empty());