Add ChannelManager::fail_htlc_backwards_with_reason

This function allows a user to specify the error code and
corresponding data to send to peers when failing back an HTLC.
This function is mentioned in Event::PaymentClaimable docs.
ChannelManager::get_htlc_fail_reason_from_failure_code was also
added to assist with this function.

Author: alecchendev

lightning/src/ln/channelmanager.rs

@@ -301,13 +301,8 @@ pub enum FailureCode {
 	/// We have a required feature which was not in this onion. For example, you may require
 	/// some additional metadata that was not provided with this payment.
 	RequiredNodeFeatureMissing       = 0x4000 | 0x2000 | 3,
-	/// The CLTV expiry is too close to the current block height for safe handling by us. This
-	/// should only be used when failing back as a forwarding node.
-	ExpiryTooSoon                    = 0x1000 | 14,
-	/// You may wish to use this when a `payment_hash` is unknown, the `payment_secret` is
-	/// required and not present, the `payment_secret` doesn't match the `payment_hash`, the
-	/// received amount is incorrect, the CLTV expiry of the HTLC is too close to the current
-	/// block height for safe handling, or `payment_metadata` isn't present when it should be.
+	/// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
+	/// the HTLC is too close to the current block height for safe handling.
 	/// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
 	/// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
 	IncorrectOrUnknownPaymentDetails = 0x4000 | 15,
@@ -3511,35 +3506,25 @@ where
 			for htlc in sources.drain(..) {
 				let source = HTLCSource::PreviousHopData(htlc.prev_hop.clone());
 				let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
-
-				let reason = match failure_code {
-					FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(*failure_code as u16),
-					FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(*failure_code as u16),
-					FailureCode::ExpiryTooSoon => {
-						let short_channel_id = htlc.prev_hop.short_channel_id;
-						let (counterparty_node_id, chan_id) = self.short_to_chan_info.read().unwrap().get(&short_channel_id).cloned().unwrap();
-						let per_peer_state = self.per_peer_state.read().unwrap();
-						let peer_state = per_peer_state.get(&counterparty_node_id).unwrap().lock().unwrap();
-						let chan = peer_state.channel_by_id.get(&chan_id).unwrap();
-						let channel_update = self.get_channel_update_for_onion(short_channel_id, chan).unwrap();
-						let mut channel_update_data = Vec::new();
-						(channel_update.serialized_length() as u16 + 2).write(&mut channel_update_data).expect("Writes cannot fail");
-						msgs::ChannelUpdate::TYPE.write(&mut channel_update_data).expect("Writes cannot fail");
-						channel_update.write(&mut channel_update_data).expect("Writes cannot fail");
-						HTLCFailReason::reason(*failure_code as u16, channel_update_data)
-					},
-					FailureCode::IncorrectOrUnknownPaymentDetails => {
-						let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
-						htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
-						HTLCFailReason::reason(*failure_code as u16, htlc_msat_height_data)
-					}
-				};
-
+				let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
 				self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
 			}
 		}
 	}
 
+	/// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
+	fn get_htlc_fail_reason_from_failure_code(&self, failure_code: &FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
+		match failure_code {
+			FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(*failure_code as u16),
+			FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(*failure_code as u16),
+			FailureCode::IncorrectOrUnknownPaymentDetails => {
+				let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
+				htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
+				HTLCFailReason::reason(*failure_code as u16, htlc_msat_height_data)
+			}
+		}
+	}
+
 	/// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
 	/// that we want to return and a channel.
 	///

lightning/src/util/events.rs

@@ -491,10 +491,10 @@ pub enum Event {
 	/// [`ChannelManager::claim_funds`] with the preimage given in [`PaymentPurpose`].
 	///
 	/// Note that if the preimage is not known, you should call
-	/// [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
-	/// network congestion.
-	/// If you fail to call either [`ChannelManager::claim_funds`] or
-	/// [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
+	/// [`ChannelManager::fail_htlc_backwards`] or [`ChannelManager::fail_htlc_backwards_with_reason`]
+	/// to free up resources for this HTLC and avoid network congestion.
+	/// If you fail to call either [`ChannelManager::claim_funds`], [`ChannelManager::fail_htlc_backwards`],
+	/// or [`ChannelManager::fail_htlc_backwards_with_reason`] within the HTLC's timeout, the HTLC will be
 	/// automatically failed.
 	///
 	/// # Note
@@ -506,6 +506,7 @@ pub enum Event {
 	///
 	/// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
 	/// [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
+	/// [`ChannelManager::fail_htlc_backwards_with_reason`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards_with_reason
 	PaymentClaimable {
 		/// The node that will receive the payment after it has been claimed.
 		/// This is useful to identify payments received via [phantom nodes].