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 #[cfg(not(c_bindings))]
598 pub fn custom_tlvs(&self) -> &Vec<(u64, Vec<u8>)> {
602 /// Gets the custom TLVs that will be sent or have been received.
604 /// Custom TLVs allow sending extra application-specific data with a payment. They provide
605 /// additional flexibility on top of payment metadata, as while other implementations may
606 /// require `payment_metadata` to reflect metadata provided in an invoice, custom TLVs
607 /// do not have this restriction.
609 /// Note that if this field is non-empty, it will contain strictly increasing TLVs, each
610 /// represented by a `(u64, Vec<u8>)` for its type number and serialized value respectively.
611 /// This is validated when setting this field using [`Self::with_custom_tlvs`].
613 pub fn custom_tlvs(&self) -> Vec<(u64, Vec<u8>)> {
614 self.custom_tlvs.clone()
617 /// When we have received some HTLC(s) towards an MPP payment, as we receive further HTLC(s) we
618 /// have to make sure that some fields match exactly across the parts. For those that aren't
619 /// required to match, if they don't match we should remove them so as to not expose data
620 /// that's dependent on the HTLC receive order to users.
622 /// Here we implement this, first checking compatibility then mutating two objects and then
623 /// dropping any remaining non-matching fields from both.
624 pub(super) fn check_merge(&mut self, further_htlc_fields: &mut Self) -> Result<(), ()> {
625 if self.payment_secret != further_htlc_fields.payment_secret { return Err(()); }
626 if self.payment_metadata != further_htlc_fields.payment_metadata { return Err(()); }
628 let tlvs = &mut self.custom_tlvs;
629 let further_tlvs = &mut further_htlc_fields.custom_tlvs;
631 let even_tlvs = tlvs.iter().filter(|(typ, _)| *typ % 2 == 0);
632 let further_even_tlvs = further_tlvs.iter().filter(|(typ, _)| *typ % 2 == 0);
633 if even_tlvs.ne(further_even_tlvs) { return Err(()) }
635 tlvs.retain(|tlv| further_tlvs.iter().any(|further_tlv| tlv == further_tlv));
636 further_tlvs.retain(|further_tlv| tlvs.iter().any(|tlv| tlv == further_tlv));
642 /// Arguments for [`super::channelmanager::ChannelManager::send_payment_along_path`].
643 pub(super) struct SendAlongPathArgs<'a> {
645 pub payment_hash: &'a PaymentHash,
646 pub recipient_onion: RecipientOnionFields,
647 pub total_value: u64,
649 pub payment_id: PaymentId,
650 pub keysend_preimage: &'a Option<PaymentPreimage>,
651 pub session_priv_bytes: [u8; 32],
654 pub(super) struct OutboundPayments {
655 pub(super) pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
656 pub(super) retry_lock: Mutex<()>,
659 impl OutboundPayments {
660 pub(super) fn new() -> Self {
662 pending_outbound_payments: Mutex::new(HashMap::new()),
663 retry_lock: Mutex::new(()),
667 pub(super) fn send_payment<R: Deref, ES: Deref, NS: Deref, IH, SP, L: Deref>(
668 &self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId,
669 retry_strategy: Retry, route_params: RouteParameters, router: &R,
670 first_hops: Vec<ChannelDetails>, compute_inflight_htlcs: IH, entropy_source: &ES,
671 node_signer: &NS, best_block_height: u32, logger: &L,
672 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, send_payment_along_path: SP,
673 ) -> Result<(), RetryableSendFailure>
676 ES::Target: EntropySource,
677 NS::Target: NodeSigner,
679 IH: Fn() -> InFlightHtlcs,
680 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
682 self.send_payment_internal(payment_id, payment_hash, recipient_onion, None, retry_strategy,
683 route_params, router, first_hops, &compute_inflight_htlcs, entropy_source, node_signer,
684 best_block_height, logger, pending_events, &send_payment_along_path)
687 pub(super) fn send_payment_with_route<ES: Deref, NS: Deref, F>(
688 &self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields,
689 payment_id: PaymentId, entropy_source: &ES, node_signer: &NS, best_block_height: u32,
690 send_payment_along_path: F
691 ) -> Result<(), PaymentSendFailure>
693 ES::Target: EntropySource,
694 NS::Target: NodeSigner,
695 F: Fn(SendAlongPathArgs) -> Result<(), APIError>
697 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)?;
698 self.pay_route_internal(route, payment_hash, recipient_onion, None, payment_id, None,
699 onion_session_privs, node_signer, best_block_height, &send_payment_along_path)
700 .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
703 pub(super) fn send_spontaneous_payment<R: Deref, ES: Deref, NS: Deref, IH, SP, L: Deref>(
704 &self, payment_preimage: Option<PaymentPreimage>, recipient_onion: RecipientOnionFields,
705 payment_id: PaymentId, retry_strategy: Retry, route_params: RouteParameters, router: &R,
706 first_hops: Vec<ChannelDetails>, inflight_htlcs: IH, entropy_source: &ES,
707 node_signer: &NS, best_block_height: u32, logger: &L,
708 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, send_payment_along_path: SP
709 ) -> Result<PaymentHash, RetryableSendFailure>
712 ES::Target: EntropySource,
713 NS::Target: NodeSigner,
715 IH: Fn() -> InFlightHtlcs,
716 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
718 let preimage = payment_preimage
719 .unwrap_or_else(|| PaymentPreimage(entropy_source.get_secure_random_bytes()));
720 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
721 self.send_payment_internal(payment_id, payment_hash, recipient_onion, Some(preimage),
722 retry_strategy, route_params, router, first_hops, inflight_htlcs, entropy_source,
723 node_signer, best_block_height, logger, pending_events, send_payment_along_path)
724 .map(|()| payment_hash)
727 pub(super) fn send_spontaneous_payment_with_route<ES: Deref, NS: Deref, F>(
728 &self, route: &Route, payment_preimage: Option<PaymentPreimage>,
729 recipient_onion: RecipientOnionFields, payment_id: PaymentId, entropy_source: &ES,
730 node_signer: &NS, best_block_height: u32, send_payment_along_path: F
731 ) -> Result<PaymentHash, PaymentSendFailure>
733 ES::Target: EntropySource,
734 NS::Target: NodeSigner,
735 F: Fn(SendAlongPathArgs) -> Result<(), APIError>,
737 let preimage = payment_preimage
738 .unwrap_or_else(|| PaymentPreimage(entropy_source.get_secure_random_bytes()));
739 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
740 let onion_session_privs = self.add_new_pending_payment(payment_hash, recipient_onion.clone(),
741 payment_id, Some(preimage), &route, None, None, entropy_source, best_block_height)?;
743 match self.pay_route_internal(route, payment_hash, recipient_onion, Some(preimage),
744 payment_id, None, onion_session_privs, node_signer, best_block_height, &send_payment_along_path
746 Ok(()) => Ok(payment_hash),
748 self.remove_outbound_if_all_failed(payment_id, &e);
755 pub(super) fn send_payment_for_bolt12_invoice<R: Deref, ES: Deref, NS: Deref, IH, SP, L: Deref>(
756 &self, invoice: &Bolt12Invoice, payment_id: PaymentId, router: &R,
757 first_hops: Vec<ChannelDetails>, inflight_htlcs: IH, entropy_source: &ES, node_signer: &NS,
758 best_block_height: u32, logger: &L,
759 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
760 send_payment_along_path: SP,
761 ) -> Result<(), Bolt12PaymentError>
764 ES::Target: EntropySource,
765 NS::Target: NodeSigner,
767 IH: Fn() -> InFlightHtlcs,
768 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
770 let payment_hash = invoice.payment_hash();
771 let mut max_total_routing_fee_msat = None;
772 match self.pending_outbound_payments.lock().unwrap().entry(payment_id) {
773 hash_map::Entry::Occupied(entry) => match entry.get() {
774 PendingOutboundPayment::AwaitingInvoice { retry_strategy, max_total_routing_fee_msat: max_total_fee, .. } => {
775 max_total_routing_fee_msat = *max_total_fee;
776 *entry.into_mut() = PendingOutboundPayment::InvoiceReceived {
778 retry_strategy: *retry_strategy,
779 max_total_routing_fee_msat,
782 _ => return Err(Bolt12PaymentError::DuplicateInvoice),
784 hash_map::Entry::Vacant(_) => return Err(Bolt12PaymentError::UnexpectedInvoice),
787 let route_params = RouteParameters {
788 payment_params: PaymentParameters::from_bolt12_invoice(&invoice),
789 final_value_msat: invoice.amount_msats(),
790 max_total_routing_fee_msat,
793 self.find_route_and_send_payment(
794 payment_hash, payment_id, route_params, router, first_hops, &inflight_htlcs,
795 entropy_source, node_signer, best_block_height, logger, pending_events,
796 &send_payment_along_path
802 pub(super) fn check_retry_payments<R: Deref, ES: Deref, NS: Deref, SP, IH, FH, L: Deref>(
803 &self, router: &R, first_hops: FH, inflight_htlcs: IH, entropy_source: &ES, node_signer: &NS,
804 best_block_height: u32,
805 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, logger: &L,
806 send_payment_along_path: SP,
810 ES::Target: EntropySource,
811 NS::Target: NodeSigner,
812 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
813 IH: Fn() -> InFlightHtlcs,
814 FH: Fn() -> Vec<ChannelDetails>,
817 let _single_thread = self.retry_lock.lock().unwrap();
819 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
820 let mut retry_id_route_params = None;
821 for (pmt_id, pmt) in outbounds.iter_mut() {
822 if pmt.is_auto_retryable_now() {
823 if let PendingOutboundPayment::Retryable { pending_amt_msat, total_msat, payment_params: Some(params), payment_hash, remaining_max_total_routing_fee_msat, .. } = pmt {
824 if pending_amt_msat < total_msat {
825 retry_id_route_params = Some((*payment_hash, *pmt_id, RouteParameters {
826 final_value_msat: *total_msat - *pending_amt_msat,
827 payment_params: params.clone(),
828 max_total_routing_fee_msat: *remaining_max_total_routing_fee_msat,
832 } else { debug_assert!(false); }
835 core::mem::drop(outbounds);
836 if let Some((payment_hash, payment_id, route_params)) = retry_id_route_params {
837 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)
841 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
842 outbounds.retain(|pmt_id, pmt| {
843 let mut retain = true;
844 if !pmt.is_auto_retryable_now() && pmt.remaining_parts() == 0 && !pmt.is_awaiting_invoice() {
845 pmt.mark_abandoned(PaymentFailureReason::RetriesExhausted);
846 if let PendingOutboundPayment::Abandoned { payment_hash, reason, .. } = pmt {
847 pending_events.lock().unwrap().push_back((events::Event::PaymentFailed {
849 payment_hash: *payment_hash,
859 pub(super) fn needs_abandon(&self) -> bool {
860 let outbounds = self.pending_outbound_payments.lock().unwrap();
861 outbounds.iter().any(|(_, pmt)|
862 !pmt.is_auto_retryable_now() && pmt.remaining_parts() == 0 && !pmt.is_fulfilled() &&
863 !pmt.is_awaiting_invoice())
866 /// Errors immediately on [`RetryableSendFailure`] error conditions. Otherwise, further errors may
867 /// be surfaced asynchronously via [`Event::PaymentPathFailed`] and [`Event::PaymentFailed`].
869 /// [`Event::PaymentPathFailed`]: crate::events::Event::PaymentPathFailed
870 /// [`Event::PaymentFailed`]: crate::events::Event::PaymentFailed
871 fn send_payment_internal<R: Deref, NS: Deref, ES: Deref, IH, SP, L: Deref>(
872 &self, payment_id: PaymentId, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields,
873 keysend_preimage: Option<PaymentPreimage>, retry_strategy: Retry, route_params: RouteParameters,
874 router: &R, first_hops: Vec<ChannelDetails>, inflight_htlcs: IH, entropy_source: &ES,
875 node_signer: &NS, best_block_height: u32, logger: &L,
876 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, send_payment_along_path: SP,
877 ) -> Result<(), RetryableSendFailure>
880 ES::Target: EntropySource,
881 NS::Target: NodeSigner,
883 IH: Fn() -> InFlightHtlcs,
884 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
886 #[cfg(feature = "std")] {
887 if has_expired(&route_params) {
888 log_error!(logger, "Payment with id {} and hash {} had expired before we started paying",
889 payment_id, payment_hash);
890 return Err(RetryableSendFailure::PaymentExpired)
894 let mut route = router.find_route_with_id(
895 &node_signer.get_node_id(Recipient::Node).unwrap(), &route_params,
896 Some(&first_hops.iter().collect::<Vec<_>>()), inflight_htlcs(),
897 payment_hash, payment_id,
899 log_error!(logger, "Failed to find route for payment with id {} and hash {}",
900 payment_id, payment_hash);
901 RetryableSendFailure::RouteNotFound
904 if let Some(route_route_params) = route.route_params.as_mut() {
905 if route_route_params.final_value_msat != route_params.final_value_msat {
907 "Routers are expected to return a route which includes the requested final_value_msat");
908 route_route_params.final_value_msat = route_params.final_value_msat;
912 let onion_session_privs = self.add_new_pending_payment(payment_hash,
913 recipient_onion.clone(), payment_id, keysend_preimage, &route, Some(retry_strategy),
914 Some(route_params.payment_params.clone()), entropy_source, best_block_height)
916 log_error!(logger, "Payment with id {} is already pending. New payment had payment hash {}",
917 payment_id, payment_hash);
918 RetryableSendFailure::DuplicatePayment
921 let res = self.pay_route_internal(&route, payment_hash, recipient_onion, keysend_preimage, payment_id, None,
922 onion_session_privs, node_signer, best_block_height, &send_payment_along_path);
923 log_info!(logger, "Sending payment with id {} and hash {} returned {:?}",
924 payment_id, payment_hash, res);
925 if let Err(e) = res {
926 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);
931 fn find_route_and_send_payment<R: Deref, NS: Deref, ES: Deref, IH, SP, L: Deref>(
932 &self, payment_hash: PaymentHash, payment_id: PaymentId, route_params: RouteParameters,
933 router: &R, first_hops: Vec<ChannelDetails>, inflight_htlcs: &IH, entropy_source: &ES,
934 node_signer: &NS, best_block_height: u32, logger: &L,
935 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, send_payment_along_path: &SP,
939 ES::Target: EntropySource,
940 NS::Target: NodeSigner,
942 IH: Fn() -> InFlightHtlcs,
943 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
945 #[cfg(feature = "std")] {
946 if has_expired(&route_params) {
947 log_error!(logger, "Payment params expired on retry, abandoning payment {}", &payment_id);
948 self.abandon_payment(payment_id, PaymentFailureReason::PaymentExpired, pending_events);
953 let mut route = match router.find_route_with_id(
954 &node_signer.get_node_id(Recipient::Node).unwrap(), &route_params,
955 Some(&first_hops.iter().collect::<Vec<_>>()), inflight_htlcs(),
956 payment_hash, payment_id,
960 log_error!(logger, "Failed to find a route on retry, abandoning payment {}: {:#?}", &payment_id, e);
961 self.abandon_payment(payment_id, PaymentFailureReason::RouteNotFound, pending_events);
966 if let Some(route_route_params) = route.route_params.as_mut() {
967 if route_route_params.final_value_msat != route_params.final_value_msat {
969 "Routers are expected to return a route which includes the requested final_value_msat");
970 route_route_params.final_value_msat = route_params.final_value_msat;
974 for path in route.paths.iter() {
975 if path.hops.len() == 0 {
976 log_error!(logger, "Unusable path in route (path.hops.len() must be at least 1");
977 self.abandon_payment(payment_id, PaymentFailureReason::UnexpectedError, pending_events);
982 macro_rules! abandon_with_entry {
983 ($payment: expr, $reason: expr) => {
984 $payment.get_mut().mark_abandoned($reason);
985 if let PendingOutboundPayment::Abandoned { reason, .. } = $payment.get() {
986 if $payment.get().remaining_parts() == 0 {
987 pending_events.lock().unwrap().push_back((events::Event::PaymentFailed {
997 let (total_msat, recipient_onion, keysend_preimage, onion_session_privs) = {
998 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
999 match outbounds.entry(payment_id) {
1000 hash_map::Entry::Occupied(mut payment) => {
1001 match payment.get() {
1002 PendingOutboundPayment::Retryable {
1003 total_msat, keysend_preimage, payment_secret, payment_metadata,
1004 custom_tlvs, pending_amt_msat, ..
1006 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
1007 let retry_amt_msat = route.get_total_amount();
1008 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
1009 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);
1010 abandon_with_entry!(payment, PaymentFailureReason::UnexpectedError);
1014 if !payment.get().is_retryable_now() {
1015 log_error!(logger, "Retries exhausted for payment id {}", &payment_id);
1016 abandon_with_entry!(payment, PaymentFailureReason::RetriesExhausted);
1020 let total_msat = *total_msat;
1021 let recipient_onion = RecipientOnionFields {
1022 payment_secret: *payment_secret,
1023 payment_metadata: payment_metadata.clone(),
1024 custom_tlvs: custom_tlvs.clone(),
1026 let keysend_preimage = *keysend_preimage;
1028 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
1029 for _ in 0..route.paths.len() {
1030 onion_session_privs.push(entropy_source.get_secure_random_bytes());
1033 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
1034 assert!(payment.get_mut().insert(*session_priv_bytes, path));
1037 payment.get_mut().increment_attempts();
1039 (total_msat, recipient_onion, keysend_preimage, onion_session_privs)
1041 PendingOutboundPayment::Legacy { .. } => {
1042 log_error!(logger, "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102");
1045 PendingOutboundPayment::AwaitingInvoice { .. } => {
1046 log_error!(logger, "Payment not yet sent");
1049 PendingOutboundPayment::InvoiceReceived { payment_hash, retry_strategy, .. } => {
1050 let total_amount = route_params.final_value_msat;
1051 let recipient_onion = RecipientOnionFields {
1052 payment_secret: None,
1053 payment_metadata: None,
1054 custom_tlvs: vec![],
1056 let retry_strategy = Some(*retry_strategy);
1057 let payment_params = Some(route_params.payment_params.clone());
1058 let (retryable_payment, onion_session_privs) = self.create_pending_payment(
1059 *payment_hash, recipient_onion.clone(), None, &route,
1060 retry_strategy, payment_params, entropy_source, best_block_height
1062 *payment.into_mut() = retryable_payment;
1063 (total_amount, recipient_onion, None, onion_session_privs)
1065 PendingOutboundPayment::Fulfilled { .. } => {
1066 log_error!(logger, "Payment already completed");
1069 PendingOutboundPayment::Abandoned { .. } => {
1070 log_error!(logger, "Payment already abandoned (with some HTLCs still pending)");
1075 hash_map::Entry::Vacant(_) => {
1076 log_error!(logger, "Payment with ID {} not found", &payment_id);
1081 let res = self.pay_route_internal(&route, payment_hash, recipient_onion, keysend_preimage,
1082 payment_id, Some(total_msat), onion_session_privs, node_signer, best_block_height,
1083 &send_payment_along_path);
1084 log_info!(logger, "Result retrying payment id {}: {:?}", &payment_id, res);
1085 if let Err(e) = res {
1086 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);
1090 fn handle_pay_route_err<R: Deref, NS: Deref, ES: Deref, IH, SP, L: Deref>(
1091 &self, err: PaymentSendFailure, payment_id: PaymentId, payment_hash: PaymentHash, route: Route,
1092 mut route_params: RouteParameters, router: &R, first_hops: Vec<ChannelDetails>,
1093 inflight_htlcs: &IH, entropy_source: &ES, node_signer: &NS, best_block_height: u32, logger: &L,
1094 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, send_payment_along_path: &SP,
1098 ES::Target: EntropySource,
1099 NS::Target: NodeSigner,
1101 IH: Fn() -> InFlightHtlcs,
1102 SP: Fn(SendAlongPathArgs) -> Result<(), APIError>,
1105 PaymentSendFailure::AllFailedResendSafe(errs) => {
1106 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);
1107 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);
1109 PaymentSendFailure::PartialFailure { failed_paths_retry: Some(mut retry), results, .. } => {
1110 Self::push_path_failed_evs_and_scids(payment_id, payment_hash, &mut retry, route.paths, results.into_iter(), logger, pending_events);
1111 // Some paths were sent, even if we failed to send the full MPP value our recipient may
1112 // misbehave and claim the funds, at which point we have to consider the payment sent, so
1113 // return `Ok()` here, ignoring any retry errors.
1114 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);
1116 PaymentSendFailure::PartialFailure { failed_paths_retry: None, .. } => {
1117 // This may happen if we send a payment and some paths fail, but only due to a temporary
1118 // monitor failure or the like, implying they're really in-flight, but we haven't sent the
1119 // initial HTLC-Add messages yet.
1121 PaymentSendFailure::PathParameterError(results) => {
1122 log_error!(logger, "Failed to send to route due to parameter error in a single path. Your router is buggy");
1123 Self::push_path_failed_evs_and_scids(payment_id, payment_hash, &mut route_params, route.paths, results.into_iter(), logger, pending_events);
1124 self.abandon_payment(payment_id, PaymentFailureReason::UnexpectedError, pending_events);
1126 PaymentSendFailure::ParameterError(e) => {
1127 log_error!(logger, "Failed to send to route due to parameter error: {:?}. Your router is buggy", e);
1128 self.abandon_payment(payment_id, PaymentFailureReason::UnexpectedError, pending_events);
1130 PaymentSendFailure::DuplicatePayment => debug_assert!(false), // unreachable
1134 fn push_path_failed_evs_and_scids<I: ExactSizeIterator + Iterator<Item = Result<(), APIError>>, L: Deref>(
1135 payment_id: PaymentId, payment_hash: PaymentHash, route_params: &mut RouteParameters,
1136 paths: Vec<Path>, path_results: I, logger: &L,
1137 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1138 ) where L::Target: Logger {
1139 let mut events = pending_events.lock().unwrap();
1140 debug_assert_eq!(paths.len(), path_results.len());
1141 for (path, path_res) in paths.into_iter().zip(path_results) {
1142 if let Err(e) = path_res {
1143 if let APIError::MonitorUpdateInProgress = e { continue }
1144 log_error!(logger, "Failed to send along path due to error: {:?}", e);
1145 let mut failed_scid = None;
1146 if let APIError::ChannelUnavailable { .. } = e {
1147 let scid = path.hops[0].short_channel_id;
1148 failed_scid = Some(scid);
1149 route_params.payment_params.previously_failed_channels.push(scid);
1151 events.push_back((events::Event::PaymentPathFailed {
1152 payment_id: Some(payment_id),
1154 payment_failed_permanently: false,
1155 failure: events::PathFailure::InitialSend { err: e },
1157 short_channel_id: failed_scid,
1167 pub(super) fn send_probe<ES: Deref, NS: Deref, F>(
1168 &self, path: Path, probing_cookie_secret: [u8; 32], entropy_source: &ES, node_signer: &NS,
1169 best_block_height: u32, send_payment_along_path: F
1170 ) -> Result<(PaymentHash, PaymentId), PaymentSendFailure>
1172 ES::Target: EntropySource,
1173 NS::Target: NodeSigner,
1174 F: Fn(SendAlongPathArgs) -> Result<(), APIError>,
1176 let payment_id = PaymentId(entropy_source.get_secure_random_bytes());
1177 let payment_secret = PaymentSecret(entropy_source.get_secure_random_bytes());
1179 let payment_hash = probing_cookie_from_id(&payment_id, probing_cookie_secret);
1181 if path.hops.len() < 2 && path.blinded_tail.is_none() {
1182 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
1183 err: "No need probing a path with less than two hops".to_string()
1187 let route = Route { paths: vec![path], route_params: None };
1188 let onion_session_privs = self.add_new_pending_payment(payment_hash,
1189 RecipientOnionFields::secret_only(payment_secret), payment_id, None, &route, None, None,
1190 entropy_source, best_block_height)?;
1192 match self.pay_route_internal(&route, payment_hash, RecipientOnionFields::spontaneous_empty(),
1193 None, payment_id, None, onion_session_privs, node_signer, best_block_height, &send_payment_along_path
1195 Ok(()) => Ok((payment_hash, payment_id)),
1197 self.remove_outbound_if_all_failed(payment_id, &e);
1204 pub(super) fn test_set_payment_metadata(
1205 &self, payment_id: PaymentId, new_payment_metadata: Option<Vec<u8>>
1207 match self.pending_outbound_payments.lock().unwrap().get_mut(&payment_id).unwrap() {
1208 PendingOutboundPayment::Retryable { payment_metadata, .. } => {
1209 *payment_metadata = new_payment_metadata;
1211 _ => panic!("Need a retryable payment to update metadata on"),
1216 pub(super) fn test_add_new_pending_payment<ES: Deref>(
1217 &self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId,
1218 route: &Route, retry_strategy: Option<Retry>, entropy_source: &ES, best_block_height: u32
1219 ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
1220 self.add_new_pending_payment(payment_hash, recipient_onion, payment_id, None, route, retry_strategy, None, entropy_source, best_block_height)
1223 pub(super) fn add_new_pending_payment<ES: Deref>(
1224 &self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields, payment_id: PaymentId,
1225 keysend_preimage: Option<PaymentPreimage>, route: &Route, retry_strategy: Option<Retry>,
1226 payment_params: Option<PaymentParameters>, entropy_source: &ES, best_block_height: u32
1227 ) -> Result<Vec<[u8; 32]>, PaymentSendFailure> where ES::Target: EntropySource {
1228 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
1229 match pending_outbounds.entry(payment_id) {
1230 hash_map::Entry::Occupied(_) => Err(PaymentSendFailure::DuplicatePayment),
1231 hash_map::Entry::Vacant(entry) => {
1232 let (payment, onion_session_privs) = self.create_pending_payment(
1233 payment_hash, recipient_onion, keysend_preimage, route, retry_strategy,
1234 payment_params, entropy_source, best_block_height
1236 entry.insert(payment);
1237 Ok(onion_session_privs)
1242 fn create_pending_payment<ES: Deref>(
1243 &self, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields,
1244 keysend_preimage: Option<PaymentPreimage>, route: &Route, retry_strategy: Option<Retry>,
1245 payment_params: Option<PaymentParameters>, entropy_source: &ES, best_block_height: u32
1246 ) -> (PendingOutboundPayment, Vec<[u8; 32]>)
1248 ES::Target: EntropySource,
1250 let mut onion_session_privs = Vec::with_capacity(route.paths.len());
1251 for _ in 0..route.paths.len() {
1252 onion_session_privs.push(entropy_source.get_secure_random_bytes());
1255 let mut payment = PendingOutboundPayment::Retryable {
1257 attempts: PaymentAttempts::new(),
1259 session_privs: HashSet::new(),
1260 pending_amt_msat: 0,
1261 pending_fee_msat: Some(0),
1263 payment_secret: recipient_onion.payment_secret,
1264 payment_metadata: recipient_onion.payment_metadata,
1266 custom_tlvs: recipient_onion.custom_tlvs,
1267 starting_block_height: best_block_height,
1268 total_msat: route.get_total_amount(),
1269 remaining_max_total_routing_fee_msat:
1270 route.route_params.as_ref().and_then(|p| p.max_total_routing_fee_msat),
1273 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.iter()) {
1274 assert!(payment.insert(*session_priv_bytes, path));
1277 (payment, onion_session_privs)
1281 pub(super) fn add_new_awaiting_invoice(
1282 &self, payment_id: PaymentId, retry_strategy: Retry, max_total_routing_fee_msat: Option<u64>
1283 ) -> Result<(), ()> {
1284 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
1285 match pending_outbounds.entry(payment_id) {
1286 hash_map::Entry::Occupied(_) => Err(()),
1287 hash_map::Entry::Vacant(entry) => {
1288 entry.insert(PendingOutboundPayment::AwaitingInvoice {
1289 timer_ticks_without_response: 0,
1291 max_total_routing_fee_msat,
1299 fn pay_route_internal<NS: Deref, F>(
1300 &self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields,
1301 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
1302 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
1303 send_payment_along_path: &F
1304 ) -> Result<(), PaymentSendFailure>
1306 NS::Target: NodeSigner,
1307 F: Fn(SendAlongPathArgs) -> Result<(), APIError>,
1309 if route.paths.len() < 1 {
1310 return Err(PaymentSendFailure::ParameterError(APIError::InvalidRoute{err: "There must be at least one path to send over".to_owned()}));
1312 if recipient_onion.payment_secret.is_none() && route.paths.len() > 1
1313 && !route.paths.iter().any(|p| p.blinded_tail.is_some())
1315 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_owned()}));
1317 let mut total_value = 0;
1318 let our_node_id = node_signer.get_node_id(Recipient::Node).unwrap(); // TODO no unwrap
1319 let mut path_errs = Vec::with_capacity(route.paths.len());
1320 'path_check: for path in route.paths.iter() {
1321 if path.hops.len() < 1 || path.hops.len() > 20 {
1322 path_errs.push(Err(APIError::InvalidRoute{err: "Path didn't go anywhere/had bogus size".to_owned()}));
1323 continue 'path_check;
1325 let dest_hop_idx = if path.blinded_tail.is_some() && path.blinded_tail.as_ref().unwrap().hops.len() > 1 {
1326 usize::max_value() } else { path.hops.len() - 1 };
1327 for (idx, hop) in path.hops.iter().enumerate() {
1328 if idx != dest_hop_idx && hop.pubkey == our_node_id {
1329 path_errs.push(Err(APIError::InvalidRoute{err: "Path went through us but wasn't a simple rebalance loop to us".to_owned()}));
1330 continue 'path_check;
1333 total_value += path.final_value_msat();
1334 path_errs.push(Ok(()));
1336 if path_errs.iter().any(|e| e.is_err()) {
1337 return Err(PaymentSendFailure::PathParameterError(path_errs));
1339 if let Some(amt_msat) = recv_value_msat {
1340 total_value = amt_msat;
1343 let cur_height = best_block_height + 1;
1344 let mut results = Vec::new();
1345 debug_assert_eq!(route.paths.len(), onion_session_privs.len());
1346 for (path, session_priv_bytes) in route.paths.iter().zip(onion_session_privs.into_iter()) {
1347 let mut path_res = send_payment_along_path(SendAlongPathArgs {
1348 path: &path, payment_hash: &payment_hash, recipient_onion: recipient_onion.clone(),
1349 total_value, cur_height, payment_id, keysend_preimage: &keysend_preimage, session_priv_bytes
1353 Err(APIError::MonitorUpdateInProgress) => {
1354 // While a MonitorUpdateInProgress is an Err(_), the payment is still
1355 // considered "in flight" and we shouldn't remove it from the
1356 // PendingOutboundPayment set.
1359 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
1360 if let Some(payment) = pending_outbounds.get_mut(&payment_id) {
1361 let removed = payment.remove(&session_priv_bytes, Some(path));
1362 debug_assert!(removed, "This can't happen as the payment has an entry for this path added by callers");
1364 debug_assert!(false, "This can't happen as the payment was added by callers");
1365 path_res = Err(APIError::APIMisuseError { err: "Internal error: payment disappeared during processing. Please report this bug!".to_owned() });
1369 results.push(path_res);
1371 let mut has_ok = false;
1372 let mut has_err = false;
1373 let mut has_unsent = false;
1374 let mut total_ok_fees_msat = 0;
1375 let mut total_ok_amt_sent_msat = 0;
1376 for (res, path) in results.iter().zip(route.paths.iter()) {
1379 total_ok_fees_msat += path.fee_msat();
1380 total_ok_amt_sent_msat += path.final_value_msat();
1382 if res.is_err() { has_err = true; }
1383 if let &Err(APIError::MonitorUpdateInProgress) = res {
1384 // MonitorUpdateInProgress is inherently unsafe to retry, so we call it a
1388 total_ok_fees_msat += path.fee_msat();
1389 total_ok_amt_sent_msat += path.final_value_msat();
1390 } else if res.is_err() {
1394 if has_err && has_ok {
1395 Err(PaymentSendFailure::PartialFailure {
1398 failed_paths_retry: if has_unsent {
1399 if let Some(route_params) = &route.route_params {
1400 let mut route_params = route_params.clone();
1401 // We calculate the leftover fee budget we're allowed to spend by
1402 // subtracting the used fee from the total fee budget.
1403 route_params.max_total_routing_fee_msat = route_params
1404 .max_total_routing_fee_msat.map(|m| m.saturating_sub(total_ok_fees_msat));
1406 // We calculate the remaining target amount by subtracting the succeded
1408 route_params.final_value_msat = route_params.final_value_msat
1409 .saturating_sub(total_ok_amt_sent_msat);
1415 Err(PaymentSendFailure::AllFailedResendSafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
1422 pub(super) fn test_send_payment_internal<NS: Deref, F>(
1423 &self, route: &Route, payment_hash: PaymentHash, recipient_onion: RecipientOnionFields,
1424 keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>,
1425 onion_session_privs: Vec<[u8; 32]>, node_signer: &NS, best_block_height: u32,
1426 send_payment_along_path: F
1427 ) -> Result<(), PaymentSendFailure>
1429 NS::Target: NodeSigner,
1430 F: Fn(SendAlongPathArgs) -> Result<(), APIError>,
1432 self.pay_route_internal(route, payment_hash, recipient_onion, keysend_preimage, payment_id,
1433 recv_value_msat, onion_session_privs, node_signer, best_block_height,
1434 &send_payment_along_path)
1435 .map_err(|e| { self.remove_outbound_if_all_failed(payment_id, &e); e })
1438 // If we failed to send any paths, remove the new PaymentId from the `pending_outbound_payments`
1439 // map as the payment is free to be resent.
1440 fn remove_outbound_if_all_failed(&self, payment_id: PaymentId, err: &PaymentSendFailure) {
1441 if let &PaymentSendFailure::AllFailedResendSafe(_) = err {
1442 let removed = self.pending_outbound_payments.lock().unwrap().remove(&payment_id).is_some();
1443 debug_assert!(removed, "We should always have a pending payment to remove here");
1447 pub(super) fn claim_htlc<L: Deref>(
1448 &self, payment_id: PaymentId, payment_preimage: PaymentPreimage, session_priv: SecretKey,
1449 path: Path, from_onchain: bool, ev_completion_action: EventCompletionAction,
1450 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>,
1452 ) where L::Target: Logger {
1453 let mut session_priv_bytes = [0; 32];
1454 session_priv_bytes.copy_from_slice(&session_priv[..]);
1455 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1456 let mut pending_events = pending_events.lock().unwrap();
1457 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
1458 if !payment.get().is_fulfilled() {
1459 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1460 log_info!(logger, "Payment with id {} and hash {} sent!", payment_id, payment_hash);
1461 let fee_paid_msat = payment.get().get_pending_fee_msat();
1462 pending_events.push_back((events::Event::PaymentSent {
1463 payment_id: Some(payment_id),
1467 }, Some(ev_completion_action.clone())));
1468 payment.get_mut().mark_fulfilled();
1472 // We currently immediately remove HTLCs which were fulfilled on-chain.
1473 // This could potentially lead to removing a pending payment too early,
1474 // with a reorg of one block causing us to re-add the fulfilled payment on
1476 // TODO: We should have a second monitor event that informs us of payments
1477 // irrevocably fulfilled.
1478 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
1479 let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
1480 pending_events.push_back((events::Event::PaymentPathSuccessful {
1484 }, Some(ev_completion_action)));
1488 log_trace!(logger, "Received duplicative fulfill for HTLC with payment_preimage {}", &payment_preimage);
1492 pub(super) fn finalize_claims(&self, sources: Vec<HTLCSource>,
1493 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>)
1495 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1496 let mut pending_events = pending_events.lock().unwrap();
1497 for source in sources {
1498 if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
1499 let mut session_priv_bytes = [0; 32];
1500 session_priv_bytes.copy_from_slice(&session_priv[..]);
1501 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
1502 assert!(payment.get().is_fulfilled());
1503 if payment.get_mut().remove(&session_priv_bytes, None) {
1504 let payment_hash = payment.get().payment_hash();
1505 debug_assert!(payment_hash.is_some());
1506 pending_events.push_back((events::Event::PaymentPathSuccessful {
1517 pub(super) fn remove_stale_payments(
1518 &self, pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>)
1520 let mut pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
1521 #[cfg(not(invreqfailed))]
1522 let pending_events = pending_events.lock().unwrap();
1523 #[cfg(invreqfailed)]
1524 let mut pending_events = pending_events.lock().unwrap();
1525 pending_outbound_payments.retain(|payment_id, payment| {
1526 // If an outbound payment was completed, and no pending HTLCs remain, we should remove it
1527 // from the map. However, if we did that immediately when the last payment HTLC is claimed,
1528 // this could race the user making a duplicate send_payment call and our idempotency
1529 // guarantees would be violated. Instead, we wait a few timer ticks to do the actual
1530 // removal. This should be more than sufficient to ensure the idempotency of any
1531 // `send_payment` calls that were made at the same time the `PaymentSent` event was being
1533 if let PendingOutboundPayment::Fulfilled { session_privs, timer_ticks_without_htlcs, .. } = payment {
1534 let mut no_remaining_entries = session_privs.is_empty();
1535 if no_remaining_entries {
1536 for (ev, _) in pending_events.iter() {
1538 events::Event::PaymentSent { payment_id: Some(ev_payment_id), .. } |
1539 events::Event::PaymentPathSuccessful { payment_id: ev_payment_id, .. } |
1540 events::Event::PaymentPathFailed { payment_id: Some(ev_payment_id), .. } => {
1541 if payment_id == ev_payment_id {
1542 no_remaining_entries = false;
1550 if no_remaining_entries {
1551 *timer_ticks_without_htlcs += 1;
1552 *timer_ticks_without_htlcs <= IDEMPOTENCY_TIMEOUT_TICKS
1554 *timer_ticks_without_htlcs = 0;
1557 } else if let PendingOutboundPayment::AwaitingInvoice { timer_ticks_without_response, .. } = payment {
1558 *timer_ticks_without_response += 1;
1559 if *timer_ticks_without_response <= INVOICE_REQUEST_TIMEOUT_TICKS {
1562 #[cfg(invreqfailed)]
1563 pending_events.push_back(
1564 (events::Event::InvoiceRequestFailed { payment_id: *payment_id }, None)
1572 // Returns a bool indicating whether a PendingHTLCsForwardable event should be generated.
1573 pub(super) fn fail_htlc<L: Deref>(
1574 &self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason,
1575 path: &Path, session_priv: &SecretKey, payment_id: &PaymentId,
1576 probing_cookie_secret: [u8; 32], secp_ctx: &Secp256k1<secp256k1::All>,
1577 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>, logger: &L,
1578 ) -> bool where L::Target: Logger {
1580 let DecodedOnionFailure {
1581 network_update, short_channel_id, payment_failed_permanently, onion_error_code,
1583 } = onion_error.decode_onion_failure(secp_ctx, logger, &source);
1585 let DecodedOnionFailure { network_update, short_channel_id, payment_failed_permanently } =
1586 onion_error.decode_onion_failure(secp_ctx, logger, &source);
1588 let payment_is_probe = payment_is_probe(payment_hash, &payment_id, probing_cookie_secret);
1589 let mut session_priv_bytes = [0; 32];
1590 session_priv_bytes.copy_from_slice(&session_priv[..]);
1591 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1593 // If any payments already need retry, there's no need to generate a redundant
1594 // `PendingHTLCsForwardable`.
1595 let already_awaiting_retry = outbounds.iter().any(|(_, pmt)| {
1596 let mut awaiting_retry = false;
1597 if pmt.is_auto_retryable_now() {
1598 if let PendingOutboundPayment::Retryable { pending_amt_msat, total_msat, .. } = pmt {
1599 if pending_amt_msat < total_msat {
1600 awaiting_retry = true;
1607 let mut full_failure_ev = None;
1608 let mut pending_retry_ev = false;
1609 let attempts_remaining = if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(*payment_id) {
1610 if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
1611 log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", &payment_hash);
1614 if payment.get().is_fulfilled() {
1615 log_trace!(logger, "Received failure of HTLC with payment_hash {} after payment completion", &payment_hash);
1618 let mut is_retryable_now = payment.get().is_auto_retryable_now();
1619 if let Some(scid) = short_channel_id {
1620 // TODO: If we decided to blame ourselves (or one of our channels) in
1621 // process_onion_failure we should close that channel as it implies our
1622 // next-hop is needlessly blaming us!
1623 payment.get_mut().insert_previously_failed_scid(scid);
1626 if payment_is_probe || !is_retryable_now || payment_failed_permanently {
1627 let reason = if payment_failed_permanently {
1628 PaymentFailureReason::RecipientRejected
1630 PaymentFailureReason::RetriesExhausted
1632 payment.get_mut().mark_abandoned(reason);
1633 is_retryable_now = false;
1635 if payment.get().remaining_parts() == 0 {
1636 if let PendingOutboundPayment::Abandoned { payment_hash, reason, .. } = payment.get() {
1637 if !payment_is_probe {
1638 full_failure_ev = Some(events::Event::PaymentFailed {
1639 payment_id: *payment_id,
1640 payment_hash: *payment_hash,
1649 log_trace!(logger, "Received duplicative fail for HTLC with payment_hash {}", &payment_hash);
1652 core::mem::drop(outbounds);
1653 log_trace!(logger, "Failing outbound payment HTLC with payment_hash {}", &payment_hash);
1655 let path_failure = {
1656 if payment_is_probe {
1657 if payment_failed_permanently {
1658 events::Event::ProbeSuccessful {
1659 payment_id: *payment_id,
1660 payment_hash: payment_hash.clone(),
1664 events::Event::ProbeFailed {
1665 payment_id: *payment_id,
1666 payment_hash: payment_hash.clone(),
1672 // If we miss abandoning the payment above, we *must* generate an event here or else the
1673 // payment will sit in our outbounds forever.
1674 if attempts_remaining && !already_awaiting_retry {
1675 debug_assert!(full_failure_ev.is_none());
1676 pending_retry_ev = true;
1678 events::Event::PaymentPathFailed {
1679 payment_id: Some(*payment_id),
1680 payment_hash: payment_hash.clone(),
1681 payment_failed_permanently,
1682 failure: events::PathFailure::OnPath { network_update },
1686 error_code: onion_error_code,
1688 error_data: onion_error_data
1692 let mut pending_events = pending_events.lock().unwrap();
1693 pending_events.push_back((path_failure, None));
1694 if let Some(ev) = full_failure_ev { pending_events.push_back((ev, None)); }
1698 pub(super) fn abandon_payment(
1699 &self, payment_id: PaymentId, reason: PaymentFailureReason,
1700 pending_events: &Mutex<VecDeque<(events::Event, Option<EventCompletionAction>)>>
1702 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
1703 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
1704 payment.get_mut().mark_abandoned(reason);
1705 if let PendingOutboundPayment::Abandoned { payment_hash, reason, .. } = payment.get() {
1706 if payment.get().remaining_parts() == 0 {
1707 pending_events.lock().unwrap().push_back((events::Event::PaymentFailed {
1709 payment_hash: *payment_hash,
1714 } else if let PendingOutboundPayment::AwaitingInvoice { .. } = payment.get() {
1715 #[cfg(invreqfailed)]
1716 pending_events.lock().unwrap().push_back((events::Event::InvoiceRequestFailed {
1725 pub fn has_pending_payments(&self) -> bool {
1726 !self.pending_outbound_payments.lock().unwrap().is_empty()
1730 pub fn clear_pending_payments(&self) {
1731 self.pending_outbound_payments.lock().unwrap().clear()
1735 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
1737 pub(super) fn payment_is_probe(payment_hash: &PaymentHash, payment_id: &PaymentId,
1738 probing_cookie_secret: [u8; 32]) -> bool
1740 let target_payment_hash = probing_cookie_from_id(payment_id, probing_cookie_secret);
1741 target_payment_hash == *payment_hash
1744 /// Returns the 'probing cookie' for the given [`PaymentId`].
1745 fn probing_cookie_from_id(payment_id: &PaymentId, probing_cookie_secret: [u8; 32]) -> PaymentHash {
1746 let mut preimage = [0u8; 64];
1747 preimage[..32].copy_from_slice(&probing_cookie_secret);
1748 preimage[32..].copy_from_slice(&payment_id.0);
1749 PaymentHash(Sha256::hash(&preimage).into_inner())
1752 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
1754 (0, session_privs, required),
1757 (0, session_privs, required),
1758 (1, payment_hash, option),
1759 (3, timer_ticks_without_htlcs, (default_value, 0)),
1762 (0, session_privs, required),
1763 (1, pending_fee_msat, option),
1764 (2, payment_hash, required),
1765 // Note that while we "default" payment_param's final CLTV expiry delta to 0 we should
1766 // never see it - `payment_params` was added here after the field was added/required.
1767 (3, payment_params, (option: ReadableArgs, 0)),
1768 (4, payment_secret, option),
1769 (5, keysend_preimage, option),
1770 (6, total_msat, required),
1771 (7, payment_metadata, option),
1772 (8, pending_amt_msat, required),
1773 (9, custom_tlvs, optional_vec),
1774 (10, starting_block_height, required),
1775 (11, remaining_max_total_routing_fee_msat, option),
1776 (not_written, retry_strategy, (static_value, None)),
1777 (not_written, attempts, (static_value, PaymentAttempts::new())),
1780 (0, session_privs, required),
1781 (1, reason, option),
1782 (2, payment_hash, required),
1784 (5, AwaitingInvoice) => {
1785 (0, timer_ticks_without_response, required),
1786 (2, retry_strategy, required),
1787 (4, max_total_routing_fee_msat, option),
1789 (7, InvoiceReceived) => {
1790 (0, payment_hash, required),
1791 (2, retry_strategy, required),
1792 (4, max_total_routing_fee_msat, option),
1798 use bitcoin::network::constants::Network;
1799 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
1801 use crate::events::{Event, PathFailure, PaymentFailureReason};
1802 use crate::ln::PaymentHash;
1803 use crate::ln::channelmanager::{PaymentId, RecipientOnionFields};
1804 use crate::ln::features::{ChannelFeatures, NodeFeatures};
1805 use crate::ln::msgs::{ErrorAction, LightningError};
1806 use crate::ln::outbound_payment::{Bolt12PaymentError, OutboundPayments, Retry, RetryableSendFailure};
1807 #[cfg(invreqfailed)]
1808 use crate::ln::outbound_payment::INVOICE_REQUEST_TIMEOUT_TICKS;
1809 use crate::offers::invoice::DEFAULT_RELATIVE_EXPIRY;
1810 use crate::offers::offer::OfferBuilder;
1811 use crate::offers::test_utils::*;
1812 use crate::routing::gossip::NetworkGraph;
1813 use crate::routing::router::{InFlightHtlcs, Path, PaymentParameters, Route, RouteHop, RouteParameters};
1814 use crate::sync::{Arc, Mutex, RwLock};
1815 use crate::util::errors::APIError;
1816 use crate::util::test_utils;
1818 use alloc::collections::VecDeque;
1821 fn test_recipient_onion_fields_with_custom_tlvs() {
1822 let onion_fields = RecipientOnionFields::spontaneous_empty();
1824 let bad_type_range_tlvs = vec![
1828 assert!(onion_fields.clone().with_custom_tlvs(bad_type_range_tlvs).is_err());
1830 let keysend_tlv = vec![
1831 (5482373484, vec![42; 32]),
1833 assert!(onion_fields.clone().with_custom_tlvs(keysend_tlv).is_err());
1835 let good_tlvs = vec![
1836 ((1 << 16) + 1, vec![42]),
1837 ((1 << 16) + 3, vec![42; 32]),
1839 assert!(onion_fields.with_custom_tlvs(good_tlvs).is_ok());
1843 #[cfg(feature = "std")]
1844 fn fails_paying_after_expiration() {
1845 do_fails_paying_after_expiration(false);
1846 do_fails_paying_after_expiration(true);
1848 #[cfg(feature = "std")]
1849 fn do_fails_paying_after_expiration(on_retry: bool) {
1850 let outbound_payments = OutboundPayments::new();
1851 let logger = test_utils::TestLogger::new();
1852 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
1853 let scorer = RwLock::new(test_utils::TestScorer::new());
1854 let router = test_utils::TestRouter::new(network_graph, &scorer);
1855 let secp_ctx = Secp256k1::new();
1856 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1858 let past_expiry_time = std::time::SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() - 2;
1859 let payment_params = PaymentParameters::from_node_id(
1860 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()),
1862 ).with_expiry_time(past_expiry_time);
1863 let expired_route_params = RouteParameters::from_payment_params_and_value(payment_params, 0);
1864 let pending_events = Mutex::new(VecDeque::new());
1866 outbound_payments.add_new_pending_payment(PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(),
1867 PaymentId([0; 32]), None, &Route { paths: vec![], route_params: None },
1868 Some(Retry::Attempts(1)), Some(expired_route_params.payment_params.clone()),
1869 &&keys_manager, 0).unwrap();
1870 outbound_payments.find_route_and_send_payment(
1871 PaymentHash([0; 32]), PaymentId([0; 32]), expired_route_params, &&router, vec![],
1872 &|| InFlightHtlcs::new(), &&keys_manager, &&keys_manager, 0, &&logger, &pending_events,
1874 let events = pending_events.lock().unwrap();
1875 assert_eq!(events.len(), 1);
1876 if let Event::PaymentFailed { ref reason, .. } = events[0].0 {
1877 assert_eq!(reason.unwrap(), PaymentFailureReason::PaymentExpired);
1878 } else { panic!("Unexpected event"); }
1880 let err = outbound_payments.send_payment(
1881 PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(), PaymentId([0; 32]),
1882 Retry::Attempts(0), expired_route_params, &&router, vec![], || InFlightHtlcs::new(),
1883 &&keys_manager, &&keys_manager, 0, &&logger, &pending_events, |_| Ok(())).unwrap_err();
1884 if let RetryableSendFailure::PaymentExpired = err { } else { panic!("Unexpected error"); }
1889 fn find_route_error() {
1890 do_find_route_error(false);
1891 do_find_route_error(true);
1893 fn do_find_route_error(on_retry: bool) {
1894 let outbound_payments = OutboundPayments::new();
1895 let logger = test_utils::TestLogger::new();
1896 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
1897 let scorer = RwLock::new(test_utils::TestScorer::new());
1898 let router = test_utils::TestRouter::new(network_graph, &scorer);
1899 let secp_ctx = Secp256k1::new();
1900 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1902 let payment_params = PaymentParameters::from_node_id(
1903 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()), 0);
1904 let route_params = RouteParameters::from_payment_params_and_value(payment_params, 0);
1905 router.expect_find_route(route_params.clone(),
1906 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }));
1908 let pending_events = Mutex::new(VecDeque::new());
1910 outbound_payments.add_new_pending_payment(PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(),
1911 PaymentId([0; 32]), None, &Route { paths: vec![], route_params: None },
1912 Some(Retry::Attempts(1)), Some(route_params.payment_params.clone()),
1913 &&keys_manager, 0).unwrap();
1914 outbound_payments.find_route_and_send_payment(
1915 PaymentHash([0; 32]), PaymentId([0; 32]), route_params, &&router, vec![],
1916 &|| InFlightHtlcs::new(), &&keys_manager, &&keys_manager, 0, &&logger, &pending_events,
1918 let events = pending_events.lock().unwrap();
1919 assert_eq!(events.len(), 1);
1920 if let Event::PaymentFailed { .. } = events[0].0 { } else { panic!("Unexpected event"); }
1922 let err = outbound_payments.send_payment(
1923 PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(), PaymentId([0; 32]),
1924 Retry::Attempts(0), route_params, &&router, vec![], || InFlightHtlcs::new(),
1925 &&keys_manager, &&keys_manager, 0, &&logger, &pending_events, |_| Ok(())).unwrap_err();
1926 if let RetryableSendFailure::RouteNotFound = err {
1927 } else { panic!("Unexpected error"); }
1932 fn initial_send_payment_path_failed_evs() {
1933 let outbound_payments = OutboundPayments::new();
1934 let logger = test_utils::TestLogger::new();
1935 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
1936 let scorer = RwLock::new(test_utils::TestScorer::new());
1937 let router = test_utils::TestRouter::new(network_graph, &scorer);
1938 let secp_ctx = Secp256k1::new();
1939 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
1941 let sender_pk = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
1942 let receiver_pk = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[43; 32]).unwrap());
1943 let payment_params = PaymentParameters::from_node_id(sender_pk, 0);
1944 let route_params = RouteParameters::from_payment_params_and_value(payment_params.clone(), 0);
1945 let failed_scid = 42;
1947 paths: vec![Path { hops: vec![RouteHop {
1948 pubkey: receiver_pk,
1949 node_features: NodeFeatures::empty(),
1950 short_channel_id: failed_scid,
1951 channel_features: ChannelFeatures::empty(),
1953 cltv_expiry_delta: 0,
1954 maybe_announced_channel: true,
1955 }], blinded_tail: None }],
1956 route_params: Some(route_params.clone()),
1958 router.expect_find_route(route_params.clone(), Ok(route.clone()));
1959 let mut route_params_w_failed_scid = route_params.clone();
1960 route_params_w_failed_scid.payment_params.previously_failed_channels.push(failed_scid);
1961 router.expect_find_route(route_params_w_failed_scid, Ok(route.clone()));
1962 router.expect_find_route(route_params.clone(), Ok(route.clone()));
1963 router.expect_find_route(route_params.clone(), Ok(route.clone()));
1965 // Ensure that a ChannelUnavailable error will result in blaming an scid in the
1966 // PaymentPathFailed event.
1967 let pending_events = Mutex::new(VecDeque::new());
1968 outbound_payments.send_payment(
1969 PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(), PaymentId([0; 32]),
1970 Retry::Attempts(0), route_params.clone(), &&router, vec![], || InFlightHtlcs::new(),
1971 &&keys_manager, &&keys_manager, 0, &&logger, &pending_events,
1972 |_| Err(APIError::ChannelUnavailable { err: "test".to_owned() })).unwrap();
1973 let mut events = pending_events.lock().unwrap();
1974 assert_eq!(events.len(), 2);
1975 if let Event::PaymentPathFailed {
1977 failure: PathFailure::InitialSend { err: APIError::ChannelUnavailable { .. }}, .. } = events[0].0
1979 assert_eq!(short_channel_id, Some(failed_scid));
1980 } else { panic!("Unexpected event"); }
1981 if let Event::PaymentFailed { .. } = events[1].0 { } else { panic!("Unexpected event"); }
1983 core::mem::drop(events);
1985 // Ensure that a MonitorUpdateInProgress "error" will not result in a PaymentPathFailed event.
1986 outbound_payments.send_payment(
1987 PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(), PaymentId([0; 32]),
1988 Retry::Attempts(0), route_params.clone(), &&router, vec![], || InFlightHtlcs::new(),
1989 &&keys_manager, &&keys_manager, 0, &&logger, &pending_events,
1990 |_| Err(APIError::MonitorUpdateInProgress)).unwrap();
1991 assert_eq!(pending_events.lock().unwrap().len(), 0);
1993 // Ensure that any other error will result in a PaymentPathFailed event but no blamed scid.
1994 outbound_payments.send_payment(
1995 PaymentHash([0; 32]), RecipientOnionFields::spontaneous_empty(), PaymentId([1; 32]),
1996 Retry::Attempts(0), route_params.clone(), &&router, vec![], || InFlightHtlcs::new(),
1997 &&keys_manager, &&keys_manager, 0, &&logger, &pending_events,
1998 |_| Err(APIError::APIMisuseError { err: "test".to_owned() })).unwrap();
1999 let events = pending_events.lock().unwrap();
2000 assert_eq!(events.len(), 2);
2001 if let Event::PaymentPathFailed {
2003 failure: PathFailure::InitialSend { err: APIError::APIMisuseError { .. }}, .. } = events[0].0
2005 assert_eq!(short_channel_id, None);
2006 } else { panic!("Unexpected event"); }
2007 if let Event::PaymentFailed { .. } = events[1].0 { } else { panic!("Unexpected event"); }
2011 #[cfg(invreqfailed)]
2012 fn removes_stale_awaiting_invoice() {
2013 let pending_events = Mutex::new(VecDeque::new());
2014 let outbound_payments = OutboundPayments::new();
2015 let payment_id = PaymentId([0; 32]);
2017 assert!(!outbound_payments.has_pending_payments());
2019 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), None).is_ok()
2021 assert!(outbound_payments.has_pending_payments());
2023 for _ in 0..INVOICE_REQUEST_TIMEOUT_TICKS {
2024 outbound_payments.remove_stale_payments(&pending_events);
2025 assert!(outbound_payments.has_pending_payments());
2026 assert!(pending_events.lock().unwrap().is_empty());
2029 outbound_payments.remove_stale_payments(&pending_events);
2030 assert!(!outbound_payments.has_pending_payments());
2031 assert!(!pending_events.lock().unwrap().is_empty());
2033 pending_events.lock().unwrap().pop_front(),
2034 Some((Event::InvoiceRequestFailed { payment_id }, None)),
2036 assert!(pending_events.lock().unwrap().is_empty());
2039 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), None).is_ok()
2041 assert!(outbound_payments.has_pending_payments());
2044 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), None)
2050 #[cfg(invreqfailed)]
2051 fn removes_abandoned_awaiting_invoice() {
2052 let pending_events = Mutex::new(VecDeque::new());
2053 let outbound_payments = OutboundPayments::new();
2054 let payment_id = PaymentId([0; 32]);
2056 assert!(!outbound_payments.has_pending_payments());
2058 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), None).is_ok()
2060 assert!(outbound_payments.has_pending_payments());
2062 outbound_payments.abandon_payment(
2063 payment_id, PaymentFailureReason::UserAbandoned, &pending_events
2065 assert!(!outbound_payments.has_pending_payments());
2066 assert!(!pending_events.lock().unwrap().is_empty());
2068 pending_events.lock().unwrap().pop_front(),
2069 Some((Event::InvoiceRequestFailed { payment_id }, None)),
2071 assert!(pending_events.lock().unwrap().is_empty());
2074 #[cfg(feature = "std")]
2076 fn fails_sending_payment_for_expired_bolt12_invoice() {
2077 let logger = test_utils::TestLogger::new();
2078 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
2079 let scorer = RwLock::new(test_utils::TestScorer::new());
2080 let router = test_utils::TestRouter::new(network_graph, &scorer);
2081 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
2083 let pending_events = Mutex::new(VecDeque::new());
2084 let outbound_payments = OutboundPayments::new();
2085 let payment_id = PaymentId([0; 32]);
2088 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), None).is_ok()
2090 assert!(outbound_payments.has_pending_payments());
2092 let created_at = now() - DEFAULT_RELATIVE_EXPIRY;
2093 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2096 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2098 .sign(payer_sign).unwrap()
2099 .respond_with_no_std(payment_paths(), payment_hash(), created_at).unwrap()
2101 .sign(recipient_sign).unwrap();
2104 outbound_payments.send_payment_for_bolt12_invoice(
2105 &invoice, payment_id, &&router, vec![], || InFlightHtlcs::new(), &&keys_manager,
2106 &&keys_manager, 0, &&logger, &pending_events, |_| panic!()
2110 assert!(!outbound_payments.has_pending_payments());
2112 let payment_hash = invoice.payment_hash();
2113 let reason = Some(PaymentFailureReason::PaymentExpired);
2115 assert!(!pending_events.lock().unwrap().is_empty());
2117 pending_events.lock().unwrap().pop_front(),
2118 Some((Event::PaymentFailed { payment_id, payment_hash, reason }, None)),
2120 assert!(pending_events.lock().unwrap().is_empty());
2124 fn fails_finding_route_for_bolt12_invoice() {
2125 let logger = test_utils::TestLogger::new();
2126 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
2127 let scorer = RwLock::new(test_utils::TestScorer::new());
2128 let router = test_utils::TestRouter::new(network_graph, &scorer);
2129 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
2131 let pending_events = Mutex::new(VecDeque::new());
2132 let outbound_payments = OutboundPayments::new();
2133 let payment_id = PaymentId([0; 32]);
2135 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2138 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2140 .sign(payer_sign).unwrap()
2141 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2143 .sign(recipient_sign).unwrap();
2145 assert!(outbound_payments.add_new_awaiting_invoice(
2146 payment_id, Retry::Attempts(0), Some(invoice.amount_msats() / 100 + 50_000))
2149 assert!(outbound_payments.has_pending_payments());
2151 router.expect_find_route(
2152 RouteParameters::from_payment_params_and_value(
2153 PaymentParameters::from_bolt12_invoice(&invoice),
2154 invoice.amount_msats(),
2156 Err(LightningError { err: String::new(), action: ErrorAction::IgnoreError }),
2160 outbound_payments.send_payment_for_bolt12_invoice(
2161 &invoice, payment_id, &&router, vec![], || InFlightHtlcs::new(), &&keys_manager,
2162 &&keys_manager, 0, &&logger, &pending_events, |_| panic!()
2166 assert!(!outbound_payments.has_pending_payments());
2168 let payment_hash = invoice.payment_hash();
2169 let reason = Some(PaymentFailureReason::RouteNotFound);
2171 assert!(!pending_events.lock().unwrap().is_empty());
2173 pending_events.lock().unwrap().pop_front(),
2174 Some((Event::PaymentFailed { payment_id, payment_hash, reason }, None)),
2176 assert!(pending_events.lock().unwrap().is_empty());
2180 fn fails_paying_for_bolt12_invoice() {
2181 let logger = test_utils::TestLogger::new();
2182 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
2183 let scorer = RwLock::new(test_utils::TestScorer::new());
2184 let router = test_utils::TestRouter::new(network_graph, &scorer);
2185 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
2187 let pending_events = Mutex::new(VecDeque::new());
2188 let outbound_payments = OutboundPayments::new();
2189 let payment_id = PaymentId([0; 32]);
2191 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2194 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2196 .sign(payer_sign).unwrap()
2197 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2199 .sign(recipient_sign).unwrap();
2201 assert!(outbound_payments.add_new_awaiting_invoice(
2202 payment_id, Retry::Attempts(0), Some(invoice.amount_msats() / 100 + 50_000))
2205 assert!(outbound_payments.has_pending_payments());
2207 let route_params = RouteParameters::from_payment_params_and_value(
2208 PaymentParameters::from_bolt12_invoice(&invoice),
2209 invoice.amount_msats(),
2211 router.expect_find_route(
2212 route_params.clone(), Ok(Route { paths: vec![], route_params: Some(route_params) })
2216 outbound_payments.send_payment_for_bolt12_invoice(
2217 &invoice, payment_id, &&router, vec![], || InFlightHtlcs::new(), &&keys_manager,
2218 &&keys_manager, 0, &&logger, &pending_events, |_| panic!()
2222 assert!(!outbound_payments.has_pending_payments());
2224 let payment_hash = invoice.payment_hash();
2225 let reason = Some(PaymentFailureReason::UnexpectedError);
2227 assert!(!pending_events.lock().unwrap().is_empty());
2229 pending_events.lock().unwrap().pop_front(),
2230 Some((Event::PaymentFailed { payment_id, payment_hash, reason }, None)),
2232 assert!(pending_events.lock().unwrap().is_empty());
2236 fn sends_payment_for_bolt12_invoice() {
2237 let logger = test_utils::TestLogger::new();
2238 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &logger));
2239 let scorer = RwLock::new(test_utils::TestScorer::new());
2240 let router = test_utils::TestRouter::new(network_graph, &scorer);
2241 let keys_manager = test_utils::TestKeysInterface::new(&[0; 32], Network::Testnet);
2243 let pending_events = Mutex::new(VecDeque::new());
2244 let outbound_payments = OutboundPayments::new();
2245 let payment_id = PaymentId([0; 32]);
2247 let invoice = OfferBuilder::new("foo".into(), recipient_pubkey())
2250 .request_invoice(vec![1; 32], payer_pubkey()).unwrap()
2252 .sign(payer_sign).unwrap()
2253 .respond_with_no_std(payment_paths(), payment_hash(), now()).unwrap()
2255 .sign(recipient_sign).unwrap();
2257 let route_params = RouteParameters {
2258 payment_params: PaymentParameters::from_bolt12_invoice(&invoice),
2259 final_value_msat: invoice.amount_msats(),
2260 max_total_routing_fee_msat: Some(1234),
2262 router.expect_find_route(
2263 route_params.clone(),
2269 pubkey: recipient_pubkey(),
2270 node_features: NodeFeatures::empty(),
2271 short_channel_id: 42,
2272 channel_features: ChannelFeatures::empty(),
2273 fee_msat: invoice.amount_msats(),
2274 cltv_expiry_delta: 0,
2275 maybe_announced_channel: true,
2281 route_params: Some(route_params),
2285 assert!(!outbound_payments.has_pending_payments());
2287 outbound_payments.send_payment_for_bolt12_invoice(
2288 &invoice, payment_id, &&router, vec![], || InFlightHtlcs::new(), &&keys_manager,
2289 &&keys_manager, 0, &&logger, &pending_events, |_| panic!()
2291 Err(Bolt12PaymentError::UnexpectedInvoice),
2293 assert!(!outbound_payments.has_pending_payments());
2294 assert!(pending_events.lock().unwrap().is_empty());
2297 outbound_payments.add_new_awaiting_invoice(payment_id, Retry::Attempts(0), Some(1234)).is_ok()
2299 assert!(outbound_payments.has_pending_payments());
2302 outbound_payments.send_payment_for_bolt12_invoice(
2303 &invoice, payment_id, &&router, vec![], || InFlightHtlcs::new(), &&keys_manager,
2304 &&keys_manager, 0, &&logger, &pending_events, |_| Ok(())
2308 assert!(outbound_payments.has_pending_payments());
2309 assert!(pending_events.lock().unwrap().is_empty());
2312 outbound_payments.send_payment_for_bolt12_invoice(
2313 &invoice, payment_id, &&router, vec![], || InFlightHtlcs::new(), &&keys_manager,
2314 &&keys_manager, 0, &&logger, &pending_events, |_| panic!()
2316 Err(Bolt12PaymentError::DuplicateInvoice),
2318 assert!(outbound_payments.has_pending_payments());
2319 assert!(pending_events.lock().unwrap().is_empty());