f - change reason to an option

Author: alecchendev

lightning/src/events/mod.rs

@@ -463,8 +463,9 @@ pub enum Event {
 		///
 		/// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 		payment_hash: PaymentHash,
-		/// The reason the payment failed.
-		reason: PaymentFailureReason
+		/// 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.
 	///
@@ -907,7 +908,7 @@ impl Writeable for Event {
 				15u8.write(writer)?;
 				write_tlv_fields!(writer, {
 					(0, payment_id, required),
-					(1, reason, required),
+					(1, reason, option),
 					(2, payment_hash, required),
 				})
 			},
@@ -1196,16 +1197,16 @@ impl MaybeReadable for Event {
 				let f = || {
 					let mut payment_hash = PaymentHash([0; 32]);
 					let mut payment_id = PaymentId([0; 32]);
-					let mut reason = UpgradableRequired(None);
+					let mut reason = None;
 					read_tlv_fields!(reader, {
 						(0, payment_id, required),
-						(1, reason, upgradable_required),
+						(1, reason, upgradable_option),
 						(2, payment_hash, required),
 					});
 					Ok(Some(Event::PaymentFailed {
 						payment_id,
 						payment_hash,
-						reason: _init_tlv_based_struct_field!(reason, upgradable_required),
+						reason,
 					}))
 				};
 				f()

lightning/src/ln/functional_test_utils.rs

@@ -1923,7 +1923,7 @@ pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
 			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, PaymentFailureReason::RecipientRejected);
+				assert_eq!(reason.unwrap(), PaymentFailureReason::RecipientRejected);
 			}
 			_ => panic!("Unexpected second event"),
 		}
@@ -2309,7 +2309,7 @@ pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expe
 					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, expected_fail_reason);
+						assert_eq!(reason.unwrap(), expected_fail_reason);
 					}
 					_ => panic!("Unexpected second event"),
 				}

lightning/src/ln/onion_route_tests.rs

@@ -215,7 +215,7 @@ fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case:
 		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!(PaymentFailureReason::RecipientRejected, *ev_reason);
+			assert_eq!(PaymentFailureReason::RecipientRejected, ev_reason.unwrap());
 		}
 		_ => panic!("Unexpected second event"),
 	}

lightning/src/ln/outbound_payment.rs

@@ -550,7 +550,7 @@ impl OutboundPayments {
 					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: events::PaymentFailureReason::ExhaustedRetryAttempts
+						reason: Some(events::PaymentFailureReason::ExhaustedRetryAttempts),
 					});
 					retain = false;
 				}
@@ -667,7 +667,7 @@ impl OutboundPayments {
 					pending_events.lock().unwrap().push(events::Event::PaymentFailed {
 						payment_id,
 						payment_hash,
-						reason: $reason,
+						reason: Some($reason),
 					});
 					$payment.remove();
 				}
@@ -1178,7 +1178,7 @@ impl OutboundPayments {
 						full_failure_ev = Some(events::Event::PaymentFailed {
 							payment_id: *payment_id,
 							payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
-							reason: PaymentFailureReason::RecipientRejected
+							reason: Some(PaymentFailureReason::RecipientRejected),
 						});
 					}
 					payment.remove();
@@ -1245,7 +1245,7 @@ impl OutboundPayments {
 					pending_events.lock().unwrap().push(events::Event::PaymentFailed {
 						payment_id,
 						payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
-						reason,
+						reason: Some(reason),
 					});
 					payment.remove();
 				}
@@ -1366,7 +1366,7 @@ mod tests {
 			let events = pending_events.lock().unwrap();
 			assert_eq!(events.len(), 1);
 			if let Event::PaymentFailed { ref reason, .. } = events[0] {
-				assert_eq!(*reason, PaymentFailureReason::PaymentExpired);
+				assert_eq!(reason.unwrap(), PaymentFailureReason::PaymentExpired);
 			} else { panic!("Unexpected event"); }
 		} else {
 			let err = outbound_payments.send_payment(

lightning/src/ln/payment_tests.rs

@@ -1705,7 +1705,7 @@ fn do_automatic_retries(test: AutoRetry) {
 				Event::PaymentFailed { payment_hash: ref ev_payment_hash, payment_id: ref ev_payment_id, reason: ref ev_reason } => {
 					assert_eq!(payment_hash, *ev_payment_hash);
 					assert_eq!(PaymentId(payment_hash.0), *ev_payment_id);
-					assert_eq!(PaymentFailureReason::ExhaustedRetryAttempts, *ev_reason);
+					assert_eq!(PaymentFailureReason::ExhaustedRetryAttempts, ev_reason.unwrap());
 				},
 				_ => panic!("Unexpected event"),
 			}
@@ -1741,7 +1741,7 @@ fn do_automatic_retries(test: AutoRetry) {
 			Event::PaymentFailed { payment_hash: ref ev_payment_hash, payment_id: ref ev_payment_id, reason: ref ev_reason } => {
 				assert_eq!(payment_hash, *ev_payment_hash);
 				assert_eq!(PaymentId(payment_hash.0), *ev_payment_id);
-				assert_eq!(PaymentFailureReason::ExhaustedRetryAttempts, *ev_reason);
+				assert_eq!(PaymentFailureReason::ExhaustedRetryAttempts, ev_reason.unwrap());
 			},
 			_ => panic!("Unexpected event"),
 		}
@@ -1761,7 +1761,7 @@ fn do_automatic_retries(test: AutoRetry) {
 			Event::PaymentFailed { payment_hash: ref ev_payment_hash, payment_id: ref ev_payment_id, reason: ref ev_reason } => {
 				assert_eq!(payment_hash, *ev_payment_hash);
 				assert_eq!(PaymentId(payment_hash.0), *ev_payment_id);
-				assert_eq!(PaymentFailureReason::FailedRoutingRetry, *ev_reason);
+				assert_eq!(PaymentFailureReason::FailedRoutingRetry, ev_reason.unwrap());
 			},
 			_ => panic!("Unexpected event"),
 		}
@@ -2438,7 +2438,7 @@ fn no_extra_retries_on_back_to_back_fail() {
 		Event::PaymentFailed { payment_hash: ref ev_payment_hash, payment_id: ref ev_payment_id, reason: ref ev_reason } => {
 			assert_eq!(payment_hash, *ev_payment_hash);
 			assert_eq!(PaymentId(payment_hash.0), *ev_payment_id);
-			assert_eq!(PaymentFailureReason::RecipientRejected, *ev_reason);
+			assert_eq!(PaymentFailureReason::RecipientRejected, ev_reason.unwrap());
 		},
 		_ => panic!("Unexpected event"),
 	}