Add reason to PendingOutboundPayment::Abandoned

Author: alecchendev

lightning/src/ln/outbound_payment.rs

@@ -68,6 +68,8 @@ pub(crate) enum PendingOutboundPayment {
 	Abandoned {
 		session_privs: HashSet<[u8; 32]>,
 		payment_hash: PaymentHash,
+		/// Will be `None` if the payment was serialized before 0.0.115.
+		reason: Option<PaymentFailureReason>,
 	},
 }
 
@@ -145,7 +147,7 @@ impl PendingOutboundPayment {
 		*self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash, timer_ticks_without_htlcs: 0 };
 	}
 
-	fn mark_abandoned(&mut self) -> Result<(), ()> {
+	fn mark_abandoned(&mut self, reason: PaymentFailureReason) -> Result<(), ()> {
 		let mut session_privs = HashSet::new();
 		let our_payment_hash;
 		core::mem::swap(&mut session_privs, match self {
@@ -158,7 +160,7 @@ impl PendingOutboundPayment {
 				session_privs
 			},
 		});
-		*self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
+		*self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash, reason: Some(reason) };
 		Ok(())
 	}
 
@@ -546,11 +548,12 @@ impl OutboundPayments {
 		outbounds.retain(|pmt_id, pmt| {
 			let mut retain = true;
 			if !pmt.is_auto_retryable_now() && pmt.remaining_parts() == 0 {
-				if pmt.mark_abandoned().is_ok() {
+				let reason = PaymentFailureReason::RetriesExhausted;
+				if pmt.mark_abandoned(reason).is_ok() {
 					pending_events.lock().unwrap().push(events::Event::PaymentFailed {
 						payment_id: *pmt_id,
 						payment_hash: pmt.payment_hash().expect("PendingOutboundPayments::Retryable always has a payment hash set"),
-						reason: Some(events::PaymentFailureReason::RetriesExhausted),
+						reason: Some(reason),
 					});
 					retain = false;
 				}
@@ -663,7 +666,7 @@ impl OutboundPayments {
 
 		macro_rules! abandon_with_entry {
 			($payment: expr, $reason: expr) => {
-				if $payment.get_mut().mark_abandoned().is_ok() && $payment.get().remaining_parts() == 0 {
+				if $payment.get_mut().mark_abandoned($reason).is_ok() && $payment.get().remaining_parts() == 0 {
 					pending_events.lock().unwrap().push(events::Event::PaymentFailed {
 						payment_id,
 						payment_hash,
@@ -1169,7 +1172,12 @@ impl OutboundPayments {
 			}
 
 			if payment_is_probe || !is_retryable_now || !payment_retryable {
-				let _ = payment.get_mut().mark_abandoned(); // we'll only Err if it's a legacy payment
+				let reason = if !payment_retryable {
+					PaymentFailureReason::RecipientRejected
+				} else {
+					PaymentFailureReason::RetriesExhausted
+				};
+				let _ = payment.get_mut().mark_abandoned(reason); // we'll only Err if it's a legacy payment
 				is_retryable_now = false;
 			}
 			if payment.get().remaining_parts() == 0 {
@@ -1244,7 +1252,7 @@ impl OutboundPayments {
 	) {
 		let mut outbounds = self.pending_outbound_payments.lock().unwrap();
 		if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
-			if let Ok(()) = payment.get_mut().mark_abandoned() {
+			if let Ok(()) = payment.get_mut().mark_abandoned(reason) {
 				if payment.get().remaining_parts() == 0 {
 					pending_events.lock().unwrap().push(events::Event::PaymentFailed {
 						payment_id,
@@ -1311,6 +1319,7 @@ impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
 	},
 	(3, Abandoned) => {
 		(0, session_privs, required),
+		(1, reason, option),
 		(2, payment_hash, required),
 	},
 );