Create PaymentFailureReason enum

Author: alecchendev

lightning/src/events/mod.rs

@@ -270,6 +270,41 @@ 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 payment failed while being forwarded along the path. A [`Event::PaymentPathFailed`]
+	/// should have come before this.
+	FailedAlongPath,
+	/// 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.
+	ExhaustedRetryAttempts,
+	/// The payment expired while retrying. If the user chooses to include an `expiry_time` in their
+	/// `PaymentParams` this payment will be failed if it is retried after this time has elapsed.
+	PaymentExpired,
+	/// We failed to find a route while retrying the payment.
+	FailedRoutingRetry,
+	/// This error should generally never happen. This likely means that there is a problem with
+	/// your router.
+	UnexpectedError,
+}
+
+impl_writeable_tlv_based_enum_upgradable!(PaymentFailureReason,
+	(0, RecipientRejected) => {},
+	(2, FailedAlongPath) => {},
+	(4, UserAbandoned) => {},
+	(6, ExhaustedRetryAttempts) => {},
+	(8, PaymentExpired) => {},
+	(10, FailedRoutingRetry) => {},
+	(12, 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