Add cltv expiry to HTLCPreviousHopData

In a coming commit we'll expire HTLCs backwards even if we haven't
yet claimed them on-chain based on their inbound edge being close
to causing a channel force-closure.

Here we track and expose the incoming edge's CLTV expiry in the
`HTLCSource`, giving `ChannelMonitor` access to it.

Co-authored-by: Matt Corallo <[email protected]>

Author: 2 people

lightning/src/ln/channelmanager.rs

@@ -402,6 +402,9 @@ pub(crate) struct HTLCPreviousHopData {
 	// channel with a preimage provided by the forward channel.
 	outpoint: OutPoint,
 	counterparty_node_id: Option<PublicKey>,
+	/// Used to preserve our backwards channel by failing back in case an HTLC claim in the forward
+	/// channel remains unconfirmed for too long.
+	cltv_expiry: Option<u32>,
 }
 
 #[derive(PartialEq, Eq)]
@@ -704,6 +707,15 @@ impl HTLCSource {
 			true
 		}
 	}
+
+	/// Returns the CLTV expiry of the inbound HTLC (i.e. the source referred to by this object),
+	/// if the source was a forwarded HTLC and the HTLC was first forwarded on LDK 0.1.1 or later.
+	pub(crate) fn inbound_htlc_expiry(&self) -> Option<u32> {
+		match self {
+			Self::PreviousHopData(HTLCPreviousHopData { cltv_expiry, .. }) => *cltv_expiry,
+			_ => None,
+		}
+	}
 }
 
 /// This enum is used to specify which error data to send to peers when failing back an HTLC
@@ -5559,7 +5571,7 @@ where
 				err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
 			})?;
 
-		if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
+		if let PendingHTLCRouting::Forward { short_channel_id, incoming_cltv_expiry, .. } = payment.forward_info.routing {
 			let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
 				short_channel_id: payment.prev_short_channel_id,
 				user_channel_id: Some(payment.prev_user_channel_id),
@@ -5570,6 +5582,7 @@ where
 				incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
 				phantom_shared_secret: None,
 				blinded_failure: payment.forward_info.routing.blinded_failure(),
+				cltv_expiry: incoming_cltv_expiry,
 			});
 
 			let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
@@ -5744,6 +5757,7 @@ where
 											outgoing_cltv_value, ..
 										}
 									}) => {
+										let cltv_expiry = routing.incoming_cltv_expiry();
 										macro_rules! failure_handler {
 											($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
 												let logger = WithContext::from(&self.logger, forwarding_counterparty, Some(prev_channel_id), Some(payment_hash));
@@ -5759,6 +5773,7 @@ where
 													incoming_packet_shared_secret: incoming_shared_secret,
 													phantom_shared_secret: $phantom_ss,
 													blinded_failure: routing.blinded_failure(),
+													cltv_expiry,
 												});
 
 												let reason = if $next_hop_unknown {
@@ -5868,7 +5883,7 @@ where
 								prev_user_channel_id, prev_counterparty_node_id, forward_info: PendingHTLCInfo {
 									incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
 									routing: PendingHTLCRouting::Forward {
-										ref onion_packet, blinded, ..
+										ref onion_packet, blinded, incoming_cltv_expiry, ..
 									}, skimmed_fee_msat, ..
 								},
 							}) => {
@@ -5883,6 +5898,7 @@ where
 									// Phantom payments are only PendingHTLCRouting::Receive.
 									phantom_shared_secret: None,
 									blinded_failure: blinded.map(|b| b.failure),
+									cltv_expiry: incoming_cltv_expiry,
 								});
 								let next_blinding_point = blinded.and_then(|b| {
 									b.next_blinding_override.or_else(|| {
@@ -6073,6 +6089,7 @@ where
 										incoming_packet_shared_secret: incoming_shared_secret,
 										phantom_shared_secret,
 										blinded_failure,
+										cltv_expiry: Some(cltv_expiry),
 									},
 									// We differentiate the received value from the sender intended value
 									// if possible so that we don't prematurely mark MPP payments complete
@@ -6106,6 +6123,7 @@ where
 												incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
 												phantom_shared_secret,
 												blinded_failure,
+												cltv_expiry: Some(cltv_expiry),
 											}), payment_hash,
 											HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
 											HTLCDestination::FailedPayment { payment_hash: $payment_hash },
@@ -8889,6 +8907,7 @@ This indicates a bug inside LDK. Please report this error at https://github.com/
 											incoming_packet_shared_secret: forward_info.incoming_shared_secret,
 											phantom_shared_secret: None,
 											blinded_failure: forward_info.routing.blinded_failure(),
+											cltv_expiry: forward_info.routing.incoming_cltv_expiry(),
 										});
 
 										failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
@@ -11154,6 +11173,7 @@ where
 						outpoint: htlc.prev_funding_outpoint,
 						channel_id: htlc.prev_channel_id,
 						blinded_failure: htlc.forward_info.routing.blinded_failure(),
+						cltv_expiry: htlc.forward_info.routing.incoming_cltv_expiry(),
 					});
 
 					let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
@@ -12494,6 +12514,7 @@ impl_writeable_tlv_based!(HTLCPreviousHopData, {
 	(2, outpoint, required),
 	(3, blinded_failure, option),
 	(4, htlc_id, required),
+	(5, cltv_expiry, option),
 	(6, incoming_packet_shared_secret, required),
 	(7, user_channel_id, option),
 	// Note that by the time we get past the required read for type 2 above, outpoint will be