Skip to content

Expose a failure reason in PaymentFailed#2142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
valentinewallace merged 2 commits into from
Apr 11, 2023
Merged

Expose a failure reason in PaymentFailed#2142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
432f0e6
Create `PaymentFailureReason` enum
alecchendev Mar 30, 2023
23c7064
Add reason to `Event::PaymentFailed`
alecchendev Apr 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 45 additions & 1 deletion lightning/src/events/mod.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -272,6 +272,43 @@ impl_writeable_tlv_based_enum!(InterceptNextHop,
};
);

/// The reason the payment failed. Used in [`Event::PaymentFailed`].
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum PaymentFailureReason {
/// The intended recipient rejected our payment.
RecipientRejected,
/// The user chose to abandon this payment by calling [`ChannelManager::abandon_payment`].
///
/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
UserAbandoned,
/// We exhausted all of our retry attempts while trying to send the payment, or we
/// exhausted the [`Retry::Timeout`] if the user set one. If at any point a retry
/// attempt failed while being forwarded along the path, an [`Event::PaymentPathFailed`] will
/// have come before this.
///
/// [`Retry::Timeout`]: crate::ln::channelmanager::Retry::Timeout
RetriesExhausted,
/// The payment expired while retrying, based on the provided
/// [`PaymentParameters::expiry_time`].
///
/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
PaymentExpired,
/// We failed to find a route while retrying the payment.
RouteNotFound,
/// This error should generally never happen. This likely means that there is a problem with
/// your router.
UnexpectedError,
}

impl_writeable_tlv_based_enum!(PaymentFailureReason,
(0, RecipientRejected) => {},
(2, UserAbandoned) => {},
(4, RetriesExhausted) => {},
(6, PaymentExpired) => {},
(8, RouteNotFound) => {},
(10, UnexpectedError) => {}, ;
);

/// An Event which you should probably take some action in response to.
///
/// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
Expand DownExpand Up@@ -438,6 +475,9 @@ pub enum Event {
///
/// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
payment_hash: PaymentHash,
/// The reason the payment failed. This is only `None` for events generated or serialized
/// by versions prior to 0.0.115.
reason: Option<PaymentFailureReason>,
},
/// Indicates that a path for an outbound payment was successful.
///
Expand DownExpand Up@@ -903,10 +943,11 @@ impl Writeable for Event {
(4, *path, vec_type)
})
},
&Event::PaymentFailed { ref payment_id, ref payment_hash } => {
&Event::PaymentFailed { ref payment_id, ref payment_hash, ref reason } => {
15u8.write(writer)?;
write_tlv_fields!(writer, {
(0, payment_id, required),
(1, reason, option),
(2, payment_hash, required),
})
},
Expand DownExpand Up@@ -1208,13 +1249,16 @@ impl MaybeReadable for Event {
let f = || {
let mut payment_hash = PaymentHash([0; 32]);
let mut payment_id = PaymentId([0; 32]);
let mut reason = None;
read_tlv_fields!(reader, {
(0, payment_id, required),
(1, reason, upgradable_option),
(2, payment_hash, required),
});
Ok(Some(Event::PaymentFailed {
payment_id,
payment_hash,
reason,
}))
};
f()
Expand Down
4 changes: 2 additions & 2 deletions lightning/src/ln/channelmanager.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, Fee
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::events;
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
// Since this struct is returned in `list_channels` methods, expose it here in case users want to
// construct one themselves.
use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
Expand DownExpand Up@@ -2711,7 +2711,7 @@ where
/// [`Event::PaymentSent`]: events::Event::PaymentSent
pub fn abandon_payment(&self, payment_id: PaymentId) {
let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
self.pending_outbound_payments.abandon_payment(payment_id, &self.pending_events);
self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
}

/// Send a spontaneous payment, which is a payment that does not require the recipient to have
Expand Down
16 changes: 11 additions & 5 deletions lightning/src/ln/functional_test_utils.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch, keysinterface::EntropySource};
use crate::chain::channelmonitor::ChannelMonitor;
use crate::chain::transaction::OutPoint;
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose};
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
Expand DownExpand Up@@ -1937,9 +1937,14 @@ pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
};
if !conditions.expected_mpp_parts_remain {
match &payment_failed_events[1] {
Event::PaymentFailed { ref payment_hash, ref payment_id } => {
Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
assert_eq!(*payment_id, expected_payment_id);
assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
PaymentFailureReason::RecipientRejected
} else {
PaymentFailureReason::RetriesExhausted
});
}
_ => panic!("Unexpected second event"),
}
Expand DownExpand Up@@ -2240,10 +2245,10 @@ pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);

pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
}

pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash, expected_fail_reason: PaymentFailureReason) {
let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());

Expand DownExpand Up@@ -2329,9 +2334,10 @@ pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
};
if i == expected_paths.len() - 1 {
match events[1] {
Event::PaymentFailed { ref payment_hash, ref payment_id } => {
Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
assert_eq!(*payment_id, expected_payment_id);
assert_eq!(reason.unwrap(), expected_fail_reason);
}
_ => panic!("Unexpected second event"),
}
Expand Down
4 changes: 2 additions & 2 deletions lightning/src/ln/functional_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::chain::channelmonitor;
use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
use crate::chain::transaction::OutPoint;
use crate::chain::keysinterface::{ChannelSigner, EcdsaChannelSigner, EntropySource};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentSecret, PaymentHash};
use crate::ln::channel::{commitment_tx_base_weight, COMMITMENT_TX_WEIGHT_PER_HTLC, CONCURRENT_INBOUND_HTLC_FEE_BUFFER, FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE, MIN_AFFORDABLE_HTLC_COUNT};
use crate::ln::channelmanager::{self, PaymentId, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
Expand DownExpand Up@@ -9608,7 +9608,7 @@ fn test_double_partial_claim() {
];
expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations);

pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash, PaymentFailureReason::RecipientRejected);

// nodes[1] now retries one of the two paths...
nodes[0].node.send_payment_with_route(&route, payment_hash,
Expand Down
9 changes: 7 additions & 2 deletions lightning/src/ln/onion_route_tests.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason};
use crate::ln::{PaymentHash, PaymentSecret};
use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId, RecipientOnionFields};
Expand DownExpand Up@@ -213,9 +213,14 @@ fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case:
panic!("Unexpected event");
}
match events[1] {
Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id } => {
Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id, reason: ref ev_reason } => {
assert_eq!(*payment_hash, ev_payment_hash);
assert_eq!(payment_id, ev_payment_id);
assert_eq!(if expected_retryable {
PaymentFailureReason::RetriesExhausted
} else {
PaymentFailureReason::RecipientRejected
}, ev_reason.unwrap());
}
_ => panic!("Unexpected second event"),
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Expose a failure reason in `PaymentFailed` by alecchendev · Pull Request #2142 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose a failure reason in PaymentFailed#2142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

valentinewallace
merged 2 commits into

from

Apr 11, 2023
 Merged


Expose a failure reason in PaymentFailed#2142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
432f0e6

Create `PaymentFailureReason` enum


alecchendev Mar 30, 2023
23c7064

Add reason to `Event::PaymentFailed`


alecchendev Apr 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


46 changes: 45 additions & 1 deletion
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -272,6 +272,43 @@ impl_writeable_tlv_based_enum!(InterceptNextHop,
	};
);

/// The reason the payment failed. Used in [`Event::PaymentFailed`].
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum PaymentFailureReason {
	/// The intended recipient rejected our payment.
	RecipientRejected,
	/// The user chose to abandon this payment by calling [`ChannelManager::abandon_payment`].
	///
	/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
	UserAbandoned,
	/// We exhausted all of our retry attempts while trying to send the payment, or we
	/// exhausted the [`Retry::Timeout`] if the user set one. If at any point a retry
	/// attempt failed while being forwarded along the path, an [`Event::PaymentPathFailed`] will
	/// have come before this.
	///
	/// [`Retry::Timeout`]: crate::ln::channelmanager::Retry::Timeout
	RetriesExhausted,
	/// The payment expired while retrying, based on the provided
	/// [`PaymentParameters::expiry_time`].
	///
	/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
	PaymentExpired,
	/// We failed to find a route while retrying the payment.
	RouteNotFound,
	/// This error should generally never happen. This likely means that there is a problem with
	/// your router.
	UnexpectedError,
}

impl_writeable_tlv_based_enum!(PaymentFailureReason,
	(0, RecipientRejected) => {},
	(2, UserAbandoned) => {},
	(4, RetriesExhausted) => {},
	(6, PaymentExpired) => {},
	(8, RouteNotFound) => {},
	(10, UnexpectedError) => {}, ;
);

/// An Event which you should probably take some action in response to.
///
/// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
Expand DownExpand Up@@ -438,6 +475,9 @@ pub enum Event {
 ///
 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 payment_hash: PaymentHash,
 /// The reason the payment failed. This is only `None` for events generated or serialized
 /// by versions prior to 0.0.115.
 reason: Option<PaymentFailureReason>,
	},
	/// Indicates that a path for an outbound payment was successful.
	///
Expand DownExpand Up@@ -903,10 +943,11 @@ impl Writeable for Event {
 (4, *path, vec_type)
 })
 },
 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
 &Event::PaymentFailed { ref payment_id, ref payment_hash, ref reason } => {
 15u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, payment_id, required),
 (1, reason, option),
 (2, payment_hash, required),
 })
 },
Expand DownExpand Up@@ -1208,13 +1249,16 @@ impl MaybeReadable for Event {
 let f = || {
 let mut payment_hash = PaymentHash([0; 32]);
 let mut payment_id = PaymentId([0; 32]);
 let mut reason = None;
 read_tlv_fields!(reader, {
 (0, payment_id, required),
 (1, reason, upgradable_option),
 (2, payment_hash, required),
 });
 Ok(Some(Event::PaymentFailed {
 payment_id,
 payment_hash,
 reason,
 }))
 };
 f()
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, Fee
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::events;
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
// Since this struct is returned in `list_channels` methods, expose it here in case users want to
// construct one themselves.
use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
Expand DownExpand Up@@ -2711,7 +2711,7 @@ where
	/// [`Event::PaymentSent`]: events::Event::PaymentSent
	pub fn abandon_payment(&self, payment_id: PaymentId) {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 self.pending_outbound_payments.abandon_payment(payment_id, &self.pending_events);
 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
	}

	/// Send a spontaneous payment, which is a payment that does not require the recipient to have
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch, keysinterface::EntropySource};
use crate::chain::channelmonitor::ChannelMonitor;
use crate::chain::transaction::OutPoint;
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose};
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
Expand DownExpand Up@@ -1937,9 +1937,14 @@ pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
	};
	if !conditions.expected_mpp_parts_remain {
 match &payment_failed_events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
 PaymentFailureReason::RecipientRejected
 } else {
 PaymentFailureReason::RetriesExhausted
 });
 }
 _ => panic!("Unexpected second event"),
 }
Expand DownExpand Up@@ -2240,10 +2245,10 @@ pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
	let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);

	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
}

pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash, expected_fail_reason: PaymentFailureReason) {
	let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
	check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());

Expand DownExpand Up@@ -2329,9 +2334,10 @@ pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
 };
 if i == expected_paths.len() - 1 {
 match events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), expected_fail_reason);
 }
 _ => panic!("Unexpected second event"),
 }
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::chain::channelmonitor;
use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
use crate::chain::transaction::OutPoint;
use crate::chain::keysinterface::{ChannelSigner, EcdsaChannelSigner, EntropySource};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentSecret, PaymentHash};
use crate::ln::channel::{commitment_tx_base_weight, COMMITMENT_TX_WEIGHT_PER_HTLC, CONCURRENT_INBOUND_HTLC_FEE_BUFFER, FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE, MIN_AFFORDABLE_HTLC_COUNT};
use crate::ln::channelmanager::{self, PaymentId, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
Expand DownExpand Up@@ -9608,7 +9608,7 @@ fn test_double_partial_claim() {
	];
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations);

	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash, PaymentFailureReason::RecipientRejected);

	// nodes[1] now retries one of the two paths...
	nodes[0].node.send_payment_with_route(&route, payment_hash,
Expand Down

9 changes: 7 additions & 2 deletions
lightning/src/ln/onion_route_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason};
use crate::ln::{PaymentHash, PaymentSecret};
use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId, RecipientOnionFields};
Expand DownExpand Up@@ -213,9 +213,14 @@ fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case:
 panic!("Unexpected event");
	}
	match events[1] {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id } => {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id, reason: ref ev_reason } => {
 assert_eq!(*payment_hash, ev_payment_hash);
 assert_eq!(payment_id, ev_payment_id);
 assert_eq!(if expected_retryable {
 PaymentFailureReason::RetriesExhausted
 } else {
 PaymentFailureReason::RecipientRejected
 }, ev_reason.unwrap());
 }
 _ => panic!("Unexpected second event"),
	}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Expose a failure reason in `PaymentFailed` by alecchendev · Pull Request #2142 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose a failure reason in PaymentFailed#2142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

valentinewallace
merged 2 commits into

from

Apr 11, 2023
 Merged


Expose a failure reason in PaymentFailed#2142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
432f0e6

Create `PaymentFailureReason` enum


alecchendev Mar 30, 2023
23c7064

Add reason to `Event::PaymentFailed`


alecchendev Apr 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


46 changes: 45 additions & 1 deletion
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -272,6 +272,43 @@ impl_writeable_tlv_based_enum!(InterceptNextHop,
	};
);

/// The reason the payment failed. Used in [`Event::PaymentFailed`].
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum PaymentFailureReason {
	/// The intended recipient rejected our payment.
	RecipientRejected,
	/// The user chose to abandon this payment by calling [`ChannelManager::abandon_payment`].
	///
	/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
	UserAbandoned,
	/// We exhausted all of our retry attempts while trying to send the payment, or we
	/// exhausted the [`Retry::Timeout`] if the user set one. If at any point a retry
	/// attempt failed while being forwarded along the path, an [`Event::PaymentPathFailed`] will
	/// have come before this.
	///
	/// [`Retry::Timeout`]: crate::ln::channelmanager::Retry::Timeout
	RetriesExhausted,
	/// The payment expired while retrying, based on the provided
	/// [`PaymentParameters::expiry_time`].
	///
	/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
	PaymentExpired,
	/// We failed to find a route while retrying the payment.
	RouteNotFound,
	/// This error should generally never happen. This likely means that there is a problem with
	/// your router.
	UnexpectedError,
}

impl_writeable_tlv_based_enum!(PaymentFailureReason,
	(0, RecipientRejected) => {},
	(2, UserAbandoned) => {},
	(4, RetriesExhausted) => {},
	(6, PaymentExpired) => {},
	(8, RouteNotFound) => {},
	(10, UnexpectedError) => {}, ;
);

/// An Event which you should probably take some action in response to.
///
/// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
Expand DownExpand Up@@ -438,6 +475,9 @@ pub enum Event {
 ///
 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 payment_hash: PaymentHash,
 /// The reason the payment failed. This is only `None` for events generated or serialized
 /// by versions prior to 0.0.115.
 reason: Option<PaymentFailureReason>,
	},
	/// Indicates that a path for an outbound payment was successful.
	///
Expand DownExpand Up@@ -903,10 +943,11 @@ impl Writeable for Event {
 (4, *path, vec_type)
 })
 },
 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
 &Event::PaymentFailed { ref payment_id, ref payment_hash, ref reason } => {
 15u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, payment_id, required),
 (1, reason, option),
 (2, payment_hash, required),
 })
 },
Expand DownExpand Up@@ -1208,13 +1249,16 @@ impl MaybeReadable for Event {
 let f = || {
 let mut payment_hash = PaymentHash([0; 32]);
 let mut payment_id = PaymentId([0; 32]);
 let mut reason = None;
 read_tlv_fields!(reader, {
 (0, payment_id, required),
 (1, reason, upgradable_option),
 (2, payment_hash, required),
 });
 Ok(Some(Event::PaymentFailed {
 payment_id,
 payment_hash,
 reason,
 }))
 };
 f()
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, Fee
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::events;
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
// Since this struct is returned in `list_channels` methods, expose it here in case users want to
// construct one themselves.
use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
Expand DownExpand Up@@ -2711,7 +2711,7 @@ where
	/// [`Event::PaymentSent`]: events::Event::PaymentSent
	pub fn abandon_payment(&self, payment_id: PaymentId) {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 self.pending_outbound_payments.abandon_payment(payment_id, &self.pending_events);
 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
	}

	/// Send a spontaneous payment, which is a payment that does not require the recipient to have
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch, keysinterface::EntropySource};
use crate::chain::channelmonitor::ChannelMonitor;
use crate::chain::transaction::OutPoint;
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose};
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
Expand DownExpand Up@@ -1937,9 +1937,14 @@ pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
	};
	if !conditions.expected_mpp_parts_remain {
 match &payment_failed_events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
 PaymentFailureReason::RecipientRejected
 } else {
 PaymentFailureReason::RetriesExhausted
 });
 }
 _ => panic!("Unexpected second event"),
 }
Expand DownExpand Up@@ -2240,10 +2245,10 @@ pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
	let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);

	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
}

pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash, expected_fail_reason: PaymentFailureReason) {
	let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
	check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());

Expand DownExpand Up@@ -2329,9 +2334,10 @@ pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
 };
 if i == expected_paths.len() - 1 {
 match events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), expected_fail_reason);
 }
 _ => panic!("Unexpected second event"),
 }
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::chain::channelmonitor;
use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
use crate::chain::transaction::OutPoint;
use crate::chain::keysinterface::{ChannelSigner, EcdsaChannelSigner, EntropySource};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentSecret, PaymentHash};
use crate::ln::channel::{commitment_tx_base_weight, COMMITMENT_TX_WEIGHT_PER_HTLC, CONCURRENT_INBOUND_HTLC_FEE_BUFFER, FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE, MIN_AFFORDABLE_HTLC_COUNT};
use crate::ln::channelmanager::{self, PaymentId, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
Expand DownExpand Up@@ -9608,7 +9608,7 @@ fn test_double_partial_claim() {
	];
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations);

	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash, PaymentFailureReason::RecipientRejected);

	// nodes[1] now retries one of the two paths...
	nodes[0].node.send_payment_with_route(&route, payment_hash,
Expand Down

9 changes: 7 additions & 2 deletions
lightning/src/ln/onion_route_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason};
use crate::ln::{PaymentHash, PaymentSecret};
use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId, RecipientOnionFields};
Expand DownExpand Up@@ -213,9 +213,14 @@ fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case:
 panic!("Unexpected event");
	}
	match events[1] {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id } => {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id, reason: ref ev_reason } => {
 assert_eq!(*payment_hash, ev_payment_hash);
 assert_eq!(payment_id, ev_payment_id);
 assert_eq!(if expected_retryable {
 PaymentFailureReason::RetriesExhausted
 } else {
 PaymentFailureReason::RecipientRejected
 }, ev_reason.unwrap());
 }
 _ => panic!("Unexpected second event"),
	}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Expose a failure reason in `PaymentFailed` by alecchendev · Pull Request #2142 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose a failure reason in PaymentFailed#2142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

valentinewallace
merged 2 commits into

from

Apr 11, 2023
 Merged


Expose a failure reason in PaymentFailed#2142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
432f0e6

Create `PaymentFailureReason` enum


alecchendev Mar 30, 2023
23c7064

Add reason to `Event::PaymentFailed`


alecchendev Apr 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


46 changes: 45 additions & 1 deletion
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -272,6 +272,43 @@ impl_writeable_tlv_based_enum!(InterceptNextHop,
	};
);

/// The reason the payment failed. Used in [`Event::PaymentFailed`].
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum PaymentFailureReason {
	/// The intended recipient rejected our payment.
	RecipientRejected,
	/// The user chose to abandon this payment by calling [`ChannelManager::abandon_payment`].
	///
	/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
	UserAbandoned,
	/// We exhausted all of our retry attempts while trying to send the payment, or we
	/// exhausted the [`Retry::Timeout`] if the user set one. If at any point a retry
	/// attempt failed while being forwarded along the path, an [`Event::PaymentPathFailed`] will
	/// have come before this.
	///
	/// [`Retry::Timeout`]: crate::ln::channelmanager::Retry::Timeout
	RetriesExhausted,
	/// The payment expired while retrying, based on the provided
	/// [`PaymentParameters::expiry_time`].
	///
	/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
	PaymentExpired,
	/// We failed to find a route while retrying the payment.
	RouteNotFound,
	/// This error should generally never happen. This likely means that there is a problem with
	/// your router.
	UnexpectedError,
}

impl_writeable_tlv_based_enum!(PaymentFailureReason,
	(0, RecipientRejected) => {},
	(2, UserAbandoned) => {},
	(4, RetriesExhausted) => {},
	(6, PaymentExpired) => {},
	(8, RouteNotFound) => {},
	(10, UnexpectedError) => {}, ;
);

/// An Event which you should probably take some action in response to.
///
/// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
Expand DownExpand Up@@ -438,6 +475,9 @@ pub enum Event {
 ///
 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 payment_hash: PaymentHash,
 /// The reason the payment failed. This is only `None` for events generated or serialized
 /// by versions prior to 0.0.115.
 reason: Option<PaymentFailureReason>,
	},
	/// Indicates that a path for an outbound payment was successful.
	///
Expand DownExpand Up@@ -903,10 +943,11 @@ impl Writeable for Event {
 (4, *path, vec_type)
 })
 },
 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
 &Event::PaymentFailed { ref payment_id, ref payment_hash, ref reason } => {
 15u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, payment_id, required),
 (1, reason, option),
 (2, payment_hash, required),
 })
 },
Expand DownExpand Up@@ -1208,13 +1249,16 @@ impl MaybeReadable for Event {
 let f = || {
 let mut payment_hash = PaymentHash([0; 32]);
 let mut payment_id = PaymentId([0; 32]);
 let mut reason = None;
 read_tlv_fields!(reader, {
 (0, payment_id, required),
 (1, reason, upgradable_option),
 (2, payment_hash, required),
 });
 Ok(Some(Event::PaymentFailed {
 payment_id,
 payment_hash,
 reason,
 }))
 };
 f()
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, Fee
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::events;
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
// Since this struct is returned in `list_channels` methods, expose it here in case users want to
// construct one themselves.
use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
Expand DownExpand Up@@ -2711,7 +2711,7 @@ where
	/// [`Event::PaymentSent`]: events::Event::PaymentSent
	pub fn abandon_payment(&self, payment_id: PaymentId) {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 self.pending_outbound_payments.abandon_payment(payment_id, &self.pending_events);
 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
	}

	/// Send a spontaneous payment, which is a payment that does not require the recipient to have
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch, keysinterface::EntropySource};
use crate::chain::channelmonitor::ChannelMonitor;
use crate::chain::transaction::OutPoint;
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose};
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
Expand DownExpand Up@@ -1937,9 +1937,14 @@ pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
	};
	if !conditions.expected_mpp_parts_remain {
 match &payment_failed_events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
 PaymentFailureReason::RecipientRejected
 } else {
 PaymentFailureReason::RetriesExhausted
 });
 }
 _ => panic!("Unexpected second event"),
 }
Expand DownExpand Up@@ -2240,10 +2245,10 @@ pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
	let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);

	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
}

pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash, expected_fail_reason: PaymentFailureReason) {
	let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
	check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());

Expand DownExpand Up@@ -2329,9 +2334,10 @@ pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
 };
 if i == expected_paths.len() - 1 {
 match events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), expected_fail_reason);
 }
 _ => panic!("Unexpected second event"),
 }
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::chain::channelmonitor;
use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
use crate::chain::transaction::OutPoint;
use crate::chain::keysinterface::{ChannelSigner, EcdsaChannelSigner, EntropySource};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentSecret, PaymentHash};
use crate::ln::channel::{commitment_tx_base_weight, COMMITMENT_TX_WEIGHT_PER_HTLC, CONCURRENT_INBOUND_HTLC_FEE_BUFFER, FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE, MIN_AFFORDABLE_HTLC_COUNT};
use crate::ln::channelmanager::{self, PaymentId, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
Expand DownExpand Up@@ -9608,7 +9608,7 @@ fn test_double_partial_claim() {
	];
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations);

	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash, PaymentFailureReason::RecipientRejected);

	// nodes[1] now retries one of the two paths...
	nodes[0].node.send_payment_with_route(&route, payment_hash,
Expand Down

9 changes: 7 additions & 2 deletions
lightning/src/ln/onion_route_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason};
use crate::ln::{PaymentHash, PaymentSecret};
use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId, RecipientOnionFields};
Expand DownExpand Up@@ -213,9 +213,14 @@ fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case:
 panic!("Unexpected event");
	}
	match events[1] {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id } => {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id, reason: ref ev_reason } => {
 assert_eq!(*payment_hash, ev_payment_hash);
 assert_eq!(payment_id, ev_payment_id);
 assert_eq!(if expected_retryable {
 PaymentFailureReason::RetriesExhausted
 } else {
 PaymentFailureReason::RecipientRejected
 }, ev_reason.unwrap());
 }
 _ => panic!("Unexpected second event"),
	}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Expose a failure reason in `PaymentFailed` by alecchendev · Pull Request #2142 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose a failure reason in PaymentFailed#2142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

valentinewallace
merged 2 commits into

from

Apr 11, 2023
 Merged


Expose a failure reason in PaymentFailed#2142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
432f0e6

Create `PaymentFailureReason` enum


alecchendev Mar 30, 2023
23c7064

Add reason to `Event::PaymentFailed`


alecchendev Apr 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


46 changes: 45 additions & 1 deletion
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -272,6 +272,43 @@ impl_writeable_tlv_based_enum!(InterceptNextHop,
	};
);

/// The reason the payment failed. Used in [`Event::PaymentFailed`].
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum PaymentFailureReason {
	/// The intended recipient rejected our payment.
	RecipientRejected,
	/// The user chose to abandon this payment by calling [`ChannelManager::abandon_payment`].
	///
	/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
	UserAbandoned,
	/// We exhausted all of our retry attempts while trying to send the payment, or we
	/// exhausted the [`Retry::Timeout`] if the user set one. If at any point a retry
	/// attempt failed while being forwarded along the path, an [`Event::PaymentPathFailed`] will
	/// have come before this.
	///
	/// [`Retry::Timeout`]: crate::ln::channelmanager::Retry::Timeout
	RetriesExhausted,
	/// The payment expired while retrying, based on the provided
	/// [`PaymentParameters::expiry_time`].
	///
	/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
	PaymentExpired,
	/// We failed to find a route while retrying the payment.
	RouteNotFound,
	/// This error should generally never happen. This likely means that there is a problem with
	/// your router.
	UnexpectedError,
}

impl_writeable_tlv_based_enum!(PaymentFailureReason,
	(0, RecipientRejected) => {},
	(2, UserAbandoned) => {},
	(4, RetriesExhausted) => {},
	(6, PaymentExpired) => {},
	(8, RouteNotFound) => {},
	(10, UnexpectedError) => {}, ;
);

/// An Event which you should probably take some action in response to.
///
/// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
Expand DownExpand Up@@ -438,6 +475,9 @@ pub enum Event {
 ///
 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 payment_hash: PaymentHash,
 /// The reason the payment failed. This is only `None` for events generated or serialized
 /// by versions prior to 0.0.115.
 reason: Option<PaymentFailureReason>,
	},
	/// Indicates that a path for an outbound payment was successful.
	///
Expand DownExpand Up@@ -903,10 +943,11 @@ impl Writeable for Event {
 (4, *path, vec_type)
 })
 },
 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
 &Event::PaymentFailed { ref payment_id, ref payment_hash, ref reason } => {
 15u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, payment_id, required),
 (1, reason, option),
 (2, payment_hash, required),
 })
 },
Expand DownExpand Up@@ -1208,13 +1249,16 @@ impl MaybeReadable for Event {
 let f = || {
 let mut payment_hash = PaymentHash([0; 32]);
 let mut payment_id = PaymentId([0; 32]);
 let mut reason = None;
 read_tlv_fields!(reader, {
 (0, payment_id, required),
 (1, reason, upgradable_option),
 (2, payment_hash, required),
 });
 Ok(Some(Event::PaymentFailed {
 payment_id,
 payment_hash,
 reason,
 }))
 };
 f()
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, Fee
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::events;
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
// Since this struct is returned in `list_channels` methods, expose it here in case users want to
// construct one themselves.
use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
Expand DownExpand Up@@ -2711,7 +2711,7 @@ where
	/// [`Event::PaymentSent`]: events::Event::PaymentSent
	pub fn abandon_payment(&self, payment_id: PaymentId) {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 self.pending_outbound_payments.abandon_payment(payment_id, &self.pending_events);
 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
	}

	/// Send a spontaneous payment, which is a payment that does not require the recipient to have
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch, keysinterface::EntropySource};
use crate::chain::channelmonitor::ChannelMonitor;
use crate::chain::transaction::OutPoint;
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose};
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
Expand DownExpand Up@@ -1937,9 +1937,14 @@ pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
	};
	if !conditions.expected_mpp_parts_remain {
 match &payment_failed_events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
 PaymentFailureReason::RecipientRejected
 } else {
 PaymentFailureReason::RetriesExhausted
 });
 }
 _ => panic!("Unexpected second event"),
 }
Expand DownExpand Up@@ -2240,10 +2245,10 @@ pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
	let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);

	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
}

pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash, expected_fail_reason: PaymentFailureReason) {
	let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
	check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());

Expand DownExpand Up@@ -2329,9 +2334,10 @@ pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
 };
 if i == expected_paths.len() - 1 {
 match events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), expected_fail_reason);
 }
 _ => panic!("Unexpected second event"),
 }
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::chain::channelmonitor;
use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
use crate::chain::transaction::OutPoint;
use crate::chain::keysinterface::{ChannelSigner, EcdsaChannelSigner, EntropySource};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentSecret, PaymentHash};
use crate::ln::channel::{commitment_tx_base_weight, COMMITMENT_TX_WEIGHT_PER_HTLC, CONCURRENT_INBOUND_HTLC_FEE_BUFFER, FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE, MIN_AFFORDABLE_HTLC_COUNT};
use crate::ln::channelmanager::{self, PaymentId, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
Expand DownExpand Up@@ -9608,7 +9608,7 @@ fn test_double_partial_claim() {
	];
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations);

	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash, PaymentFailureReason::RecipientRejected);

	// nodes[1] now retries one of the two paths...
	nodes[0].node.send_payment_with_route(&route, payment_hash,
Expand Down

9 changes: 7 additions & 2 deletions
lightning/src/ln/onion_route_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason};
use crate::ln::{PaymentHash, PaymentSecret};
use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId, RecipientOnionFields};
Expand DownExpand Up@@ -213,9 +213,14 @@ fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case:
 panic!("Unexpected event");
	}
	match events[1] {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id } => {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id, reason: ref ev_reason } => {
 assert_eq!(*payment_hash, ev_payment_hash);
 assert_eq!(payment_id, ev_payment_id);
 assert_eq!(if expected_retryable {
 PaymentFailureReason::RetriesExhausted
 } else {
 PaymentFailureReason::RecipientRejected
 }, ev_reason.unwrap());
 }
 _ => panic!("Unexpected second event"),
	}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Expose a failure reason in `PaymentFailed` by alecchendev · Pull Request #2142 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose a failure reason in PaymentFailed#2142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

valentinewallace
merged 2 commits into

from

Apr 11, 2023
 Merged


Expose a failure reason in PaymentFailed#2142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
432f0e6

Create `PaymentFailureReason` enum


alecchendev Mar 30, 2023
23c7064

Add reason to `Event::PaymentFailed`


alecchendev Apr 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


46 changes: 45 additions & 1 deletion
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -272,6 +272,43 @@ impl_writeable_tlv_based_enum!(InterceptNextHop,
	};
);

/// The reason the payment failed. Used in [`Event::PaymentFailed`].
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum PaymentFailureReason {
	/// The intended recipient rejected our payment.
	RecipientRejected,
	/// The user chose to abandon this payment by calling [`ChannelManager::abandon_payment`].
	///
	/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
	UserAbandoned,
	/// We exhausted all of our retry attempts while trying to send the payment, or we
	/// exhausted the [`Retry::Timeout`] if the user set one. If at any point a retry
	/// attempt failed while being forwarded along the path, an [`Event::PaymentPathFailed`] will
	/// have come before this.
	///
	/// [`Retry::Timeout`]: crate::ln::channelmanager::Retry::Timeout
	RetriesExhausted,
	/// The payment expired while retrying, based on the provided
	/// [`PaymentParameters::expiry_time`].
	///
	/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
	PaymentExpired,
	/// We failed to find a route while retrying the payment.
	RouteNotFound,
	/// This error should generally never happen. This likely means that there is a problem with
	/// your router.
	UnexpectedError,
}

impl_writeable_tlv_based_enum!(PaymentFailureReason,
	(0, RecipientRejected) => {},
	(2, UserAbandoned) => {},
	(4, RetriesExhausted) => {},
	(6, PaymentExpired) => {},
	(8, RouteNotFound) => {},
	(10, UnexpectedError) => {}, ;
);

/// An Event which you should probably take some action in response to.
///
/// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
Expand DownExpand Up@@ -438,6 +475,9 @@ pub enum Event {
 ///
 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 payment_hash: PaymentHash,
 /// The reason the payment failed. This is only `None` for events generated or serialized
 /// by versions prior to 0.0.115.
 reason: Option<PaymentFailureReason>,
	},
	/// Indicates that a path for an outbound payment was successful.
	///
Expand DownExpand Up@@ -903,10 +943,11 @@ impl Writeable for Event {
 (4, *path, vec_type)
 })
 },
 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
 &Event::PaymentFailed { ref payment_id, ref payment_hash, ref reason } => {
 15u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, payment_id, required),
 (1, reason, option),
 (2, payment_hash, required),
 })
 },
Expand DownExpand Up@@ -1208,13 +1249,16 @@ impl MaybeReadable for Event {
 let f = || {
 let mut payment_hash = PaymentHash([0; 32]);
 let mut payment_id = PaymentId([0; 32]);
 let mut reason = None;
 read_tlv_fields!(reader, {
 (0, payment_id, required),
 (1, reason, upgradable_option),
 (2, payment_hash, required),
 });
 Ok(Some(Event::PaymentFailed {
 payment_id,
 payment_hash,
 reason,
 }))
 };
 f()
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, Fee
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::events;
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
// Since this struct is returned in `list_channels` methods, expose it here in case users want to
// construct one themselves.
use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
Expand DownExpand Up@@ -2711,7 +2711,7 @@ where
	/// [`Event::PaymentSent`]: events::Event::PaymentSent
	pub fn abandon_payment(&self, payment_id: PaymentId) {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 self.pending_outbound_payments.abandon_payment(payment_id, &self.pending_events);
 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
	}

	/// Send a spontaneous payment, which is a payment that does not require the recipient to have
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch, keysinterface::EntropySource};
use crate::chain::channelmonitor::ChannelMonitor;
use crate::chain::transaction::OutPoint;
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose};
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
Expand DownExpand Up@@ -1937,9 +1937,14 @@ pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
	};
	if !conditions.expected_mpp_parts_remain {
 match &payment_failed_events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
 PaymentFailureReason::RecipientRejected
 } else {
 PaymentFailureReason::RetriesExhausted
 });
 }
 _ => panic!("Unexpected second event"),
 }
Expand DownExpand Up@@ -2240,10 +2245,10 @@ pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
	let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);

	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
}

pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash, expected_fail_reason: PaymentFailureReason) {
	let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
	check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());

Expand DownExpand Up@@ -2329,9 +2334,10 @@ pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
 };
 if i == expected_paths.len() - 1 {
 match events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), expected_fail_reason);
 }
 _ => panic!("Unexpected second event"),
 }
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::chain::channelmonitor;
use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
use crate::chain::transaction::OutPoint;
use crate::chain::keysinterface::{ChannelSigner, EcdsaChannelSigner, EntropySource};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentSecret, PaymentHash};
use crate::ln::channel::{commitment_tx_base_weight, COMMITMENT_TX_WEIGHT_PER_HTLC, CONCURRENT_INBOUND_HTLC_FEE_BUFFER, FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE, MIN_AFFORDABLE_HTLC_COUNT};
use crate::ln::channelmanager::{self, PaymentId, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
Expand DownExpand Up@@ -9608,7 +9608,7 @@ fn test_double_partial_claim() {
	];
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations);

	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash, PaymentFailureReason::RecipientRejected);

	// nodes[1] now retries one of the two paths...
	nodes[0].node.send_payment_with_route(&route, payment_hash,
Expand Down

9 changes: 7 additions & 2 deletions
lightning/src/ln/onion_route_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason};
use crate::ln::{PaymentHash, PaymentSecret};
use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId, RecipientOnionFields};
Expand DownExpand Up@@ -213,9 +213,14 @@ fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case:
 panic!("Unexpected event");
	}
	match events[1] {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id } => {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id, reason: ref ev_reason } => {
 assert_eq!(*payment_hash, ev_payment_hash);
 assert_eq!(payment_id, ev_payment_id);
 assert_eq!(if expected_retryable {
 PaymentFailureReason::RetriesExhausted
 } else {
 PaymentFailureReason::RecipientRejected
 }, ev_reason.unwrap());
 }
 _ => panic!("Unexpected second event"),
	}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Expose a failure reason in `PaymentFailed` by alecchendev · Pull Request #2142 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose a failure reason in PaymentFailed#2142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

valentinewallace
merged 2 commits into

from

Apr 11, 2023
 Merged


Expose a failure reason in PaymentFailed#2142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
432f0e6

Create `PaymentFailureReason` enum


alecchendev Mar 30, 2023
23c7064

Add reason to `Event::PaymentFailed`


alecchendev Apr 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


46 changes: 45 additions & 1 deletion
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -272,6 +272,43 @@ impl_writeable_tlv_based_enum!(InterceptNextHop,
	};
);

/// The reason the payment failed. Used in [`Event::PaymentFailed`].
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum PaymentFailureReason {
	/// The intended recipient rejected our payment.
	RecipientRejected,
	/// The user chose to abandon this payment by calling [`ChannelManager::abandon_payment`].
	///
	/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
	UserAbandoned,
	/// We exhausted all of our retry attempts while trying to send the payment, or we
	/// exhausted the [`Retry::Timeout`] if the user set one. If at any point a retry
	/// attempt failed while being forwarded along the path, an [`Event::PaymentPathFailed`] will
	/// have come before this.
	///
	/// [`Retry::Timeout`]: crate::ln::channelmanager::Retry::Timeout
	RetriesExhausted,
	/// The payment expired while retrying, based on the provided
	/// [`PaymentParameters::expiry_time`].
	///
	/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
	PaymentExpired,
	/// We failed to find a route while retrying the payment.
	RouteNotFound,
	/// This error should generally never happen. This likely means that there is a problem with
	/// your router.
	UnexpectedError,
}

impl_writeable_tlv_based_enum!(PaymentFailureReason,
	(0, RecipientRejected) => {},
	(2, UserAbandoned) => {},
	(4, RetriesExhausted) => {},
	(6, PaymentExpired) => {},
	(8, RouteNotFound) => {},
	(10, UnexpectedError) => {}, ;
);

/// An Event which you should probably take some action in response to.
///
/// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
Expand DownExpand Up@@ -438,6 +475,9 @@ pub enum Event {
 ///
 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 payment_hash: PaymentHash,
 /// The reason the payment failed. This is only `None` for events generated or serialized
 /// by versions prior to 0.0.115.
 reason: Option<PaymentFailureReason>,
	},
	/// Indicates that a path for an outbound payment was successful.
	///
Expand DownExpand Up@@ -903,10 +943,11 @@ impl Writeable for Event {
 (4, *path, vec_type)
 })
 },
 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
 &Event::PaymentFailed { ref payment_id, ref payment_hash, ref reason } => {
 15u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, payment_id, required),
 (1, reason, option),
 (2, payment_hash, required),
 })
 },
Expand DownExpand Up@@ -1208,13 +1249,16 @@ impl MaybeReadable for Event {
 let f = || {
 let mut payment_hash = PaymentHash([0; 32]);
 let mut payment_id = PaymentId([0; 32]);
 let mut reason = None;
 read_tlv_fields!(reader, {
 (0, payment_id, required),
 (1, reason, upgradable_option),
 (2, payment_hash, required),
 });
 Ok(Some(Event::PaymentFailed {
 payment_id,
 payment_hash,
 reason,
 }))
 };
 f()
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, Fee
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::events;
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
// Since this struct is returned in `list_channels` methods, expose it here in case users want to
// construct one themselves.
use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
Expand DownExpand Up@@ -2711,7 +2711,7 @@ where
	/// [`Event::PaymentSent`]: events::Event::PaymentSent
	pub fn abandon_payment(&self, payment_id: PaymentId) {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 self.pending_outbound_payments.abandon_payment(payment_id, &self.pending_events);
 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
	}

	/// Send a spontaneous payment, which is a payment that does not require the recipient to have
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch, keysinterface::EntropySource};
use crate::chain::channelmonitor::ChannelMonitor;
use crate::chain::transaction::OutPoint;
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose};
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
Expand DownExpand Up@@ -1937,9 +1937,14 @@ pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
	};
	if !conditions.expected_mpp_parts_remain {
 match &payment_failed_events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
 PaymentFailureReason::RecipientRejected
 } else {
 PaymentFailureReason::RetriesExhausted
 });
 }
 _ => panic!("Unexpected second event"),
 }
Expand DownExpand Up@@ -2240,10 +2245,10 @@ pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
	let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);

	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
}

pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash, expected_fail_reason: PaymentFailureReason) {
	let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
	check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());

Expand DownExpand Up@@ -2329,9 +2334,10 @@ pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
 };
 if i == expected_paths.len() - 1 {
 match events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), expected_fail_reason);
 }
 _ => panic!("Unexpected second event"),
 }
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::chain::channelmonitor;
use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
use crate::chain::transaction::OutPoint;
use crate::chain::keysinterface::{ChannelSigner, EcdsaChannelSigner, EntropySource};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentSecret, PaymentHash};
use crate::ln::channel::{commitment_tx_base_weight, COMMITMENT_TX_WEIGHT_PER_HTLC, CONCURRENT_INBOUND_HTLC_FEE_BUFFER, FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE, MIN_AFFORDABLE_HTLC_COUNT};
use crate::ln::channelmanager::{self, PaymentId, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
Expand DownExpand Up@@ -9608,7 +9608,7 @@ fn test_double_partial_claim() {
	];
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations);

	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash, PaymentFailureReason::RecipientRejected);

	// nodes[1] now retries one of the two paths...
	nodes[0].node.send_payment_with_route(&route, payment_hash,
Expand Down

9 changes: 7 additions & 2 deletions
lightning/src/ln/onion_route_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason};
use crate::ln::{PaymentHash, PaymentSecret};
use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId, RecipientOnionFields};
Expand DownExpand Up@@ -213,9 +213,14 @@ fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case:
 panic!("Unexpected event");
	}
	match events[1] {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id } => {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id, reason: ref ev_reason } => {
 assert_eq!(*payment_hash, ev_payment_hash);
 assert_eq!(payment_id, ev_payment_id);
 assert_eq!(if expected_retryable {
 PaymentFailureReason::RetriesExhausted
 } else {
 PaymentFailureReason::RecipientRejected
 }, ev_reason.unwrap());
 }
 _ => panic!("Unexpected second event"),
	}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Expose a failure reason in `PaymentFailed` by alecchendev · Pull Request #2142 · lightningdevkit/rust-lightning · GitHub
Skip to content
Expose a failure reason in PaymentFailed#2142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

valentinewallace
merged 2 commits into

from

Apr 11, 2023
 Merged


Expose a failure reason in PaymentFailed#2142
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
432f0e6

Create `PaymentFailureReason` enum


alecchendev Mar 30, 2023
23c7064

Add reason to `Event::PaymentFailed`


alecchendev Apr 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


46 changes: 45 additions & 1 deletion
lightning/src/events/mod.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -272,6 +272,43 @@ impl_writeable_tlv_based_enum!(InterceptNextHop,
	};
);

/// The reason the payment failed. Used in [`Event::PaymentFailed`].
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum PaymentFailureReason {
	/// The intended recipient rejected our payment.
	RecipientRejected,
	/// The user chose to abandon this payment by calling [`ChannelManager::abandon_payment`].
	///
	/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
	UserAbandoned,
	/// We exhausted all of our retry attempts while trying to send the payment, or we
	/// exhausted the [`Retry::Timeout`] if the user set one. If at any point a retry
	/// attempt failed while being forwarded along the path, an [`Event::PaymentPathFailed`] will
	/// have come before this.
	///
	/// [`Retry::Timeout`]: crate::ln::channelmanager::Retry::Timeout
	RetriesExhausted,
	/// The payment expired while retrying, based on the provided
	/// [`PaymentParameters::expiry_time`].
	///
	/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
	PaymentExpired,
	/// We failed to find a route while retrying the payment.
	RouteNotFound,
	/// This error should generally never happen. This likely means that there is a problem with
	/// your router.
	UnexpectedError,
}

impl_writeable_tlv_based_enum!(PaymentFailureReason,
	(0, RecipientRejected) => {},
	(2, UserAbandoned) => {},
	(4, RetriesExhausted) => {},
	(6, PaymentExpired) => {},
	(8, RouteNotFound) => {},
	(10, UnexpectedError) => {}, ;
);

/// An Event which you should probably take some action in response to.
///
/// Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
Expand DownExpand Up@@ -438,6 +475,9 @@ pub enum Event {
 ///
 /// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 payment_hash: PaymentHash,
 /// The reason the payment failed. This is only `None` for events generated or serialized
 /// by versions prior to 0.0.115.
 reason: Option<PaymentFailureReason>,
	},
	/// Indicates that a path for an outbound payment was successful.
	///
Expand DownExpand Up@@ -903,10 +943,11 @@ impl Writeable for Event {
 (4, *path, vec_type)
 })
 },
 &Event::PaymentFailed { ref payment_id, ref payment_hash } => {
 &Event::PaymentFailed { ref payment_id, ref payment_hash, ref reason } => {
 15u8.write(writer)?;
 write_tlv_fields!(writer, {
 (0, payment_id, required),
 (1, reason, option),
 (2, payment_hash, required),
 })
 },
Expand DownExpand Up@@ -1208,13 +1249,16 @@ impl MaybeReadable for Event {
 let f = || {
 let mut payment_hash = PaymentHash([0; 32]);
 let mut payment_id = PaymentId([0; 32]);
 let mut reason = None;
 read_tlv_fields!(reader, {
 (0, payment_id, required),
 (1, reason, upgradable_option),
 (2, payment_hash, required),
 });
 Ok(Some(Event::PaymentFailed {
 payment_id,
 payment_hash,
 reason,
 }))
 };
 f()
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/channelmanager.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@ use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, Fee
use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
use crate::chain::transaction::{OutPoint, TransactionData};
use crate::events;
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
use crate::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination, PaymentFailureReason};
// Since this struct is returned in `list_channels` methods, expose it here in case users want to
// construct one themselves.
use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
Expand DownExpand Up@@ -2711,7 +2711,7 @@ where
	/// [`Event::PaymentSent`]: events::Event::PaymentSent
	pub fn abandon_payment(&self, payment_id: PaymentId) {
 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
 self.pending_outbound_payments.abandon_payment(payment_id, &self.pending_events);
 self.pending_outbound_payments.abandon_payment(payment_id, PaymentFailureReason::UserAbandoned, &self.pending_events);
	}

	/// Send a spontaneous payment, which is a payment that does not require the recipient to have
Expand Down

16 changes: 11 additions & 5 deletions
lightning/src/ln/functional_test_utils.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@
use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch, keysinterface::EntropySource};
use crate::chain::channelmonitor::ChannelMonitor;
use crate::chain::transaction::OutPoint;
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose};
use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
use crate::ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
Expand DownExpand Up@@ -1937,9 +1937,14 @@ pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
	};
	if !conditions.expected_mpp_parts_remain {
 match &payment_failed_events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
 PaymentFailureReason::RecipientRejected
 } else {
 PaymentFailureReason::RetriesExhausted
 });
 }
 _ => panic!("Unexpected second event"),
 }
Expand DownExpand Up@@ -2240,10 +2245,10 @@ pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
	let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);

	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
	pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
}

pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash, expected_fail_reason: PaymentFailureReason) {
	let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
	check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());

Expand DownExpand Up@@ -2329,9 +2334,10 @@ pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
 };
 if i == expected_paths.len() - 1 {
 match events[1] {
 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
 assert_eq!(*payment_id, expected_payment_id);
 assert_eq!(reason.unwrap(), expected_fail_reason);
 }
 _ => panic!("Unexpected second event"),
 }
Expand Down

4 changes: 2 additions & 2 deletions
lightning/src/ln/functional_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ use crate::chain::channelmonitor;
use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
use crate::chain::transaction::OutPoint;
use crate::chain::keysinterface::{ChannelSigner, EcdsaChannelSigner, EntropySource};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination};
use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, ClosureReason, HTLCDestination, PaymentFailureReason};
use crate::ln::{PaymentPreimage, PaymentSecret, PaymentHash};
use crate::ln::channel::{commitment_tx_base_weight, COMMITMENT_TX_WEIGHT_PER_HTLC, CONCURRENT_INBOUND_HTLC_FEE_BUFFER, FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE, MIN_AFFORDABLE_HTLC_COUNT};
use crate::ln::channelmanager::{self, PaymentId, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA};
Expand DownExpand Up@@ -9608,7 +9608,7 @@ fn test_double_partial_claim() {
	];
	expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], failed_destinations);

	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
	pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash, PaymentFailureReason::RecipientRejected);

	// nodes[1] now retries one of the two paths...
	nodes[0].node.send_payment_with_route(&route, payment_hash,
Expand Down

9 changes: 7 additions & 2 deletions
lightning/src/ln/onion_route_tests.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@

use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure};
use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason};
use crate::ln::{PaymentHash, PaymentSecret};
use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId, RecipientOnionFields};
Expand DownExpand Up@@ -213,9 +213,14 @@ fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case:
 panic!("Unexpected event");
	}
	match events[1] {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id } => {
 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id, reason: ref ev_reason } => {
 assert_eq!(*payment_hash, ev_payment_hash);
 assert_eq!(payment_id, ev_payment_id);
 assert_eq!(if expected_retryable {
 PaymentFailureReason::RetriesExhausted
 } else {
 PaymentFailureReason::RecipientRejected
 }, ev_reason.unwrap());
 }
 _ => panic!("Unexpected second event"),
	}
Expand Down
Loading