Merge pull request #2801 from valentinewallace/2023-12-rb-groundwork-…

…followups

#2128 follow-ups

lightning/src/ln/channelmanager.rs

@@ -48,7 +48,7 @@ use crate::ln::features::{Bolt12InvoiceFeatures, ChannelFeatures, ChannelTypeFea
 #[cfg(any(feature = "_test_utils", test))]
 use crate::ln::features::Bolt11InvoiceFeatures;
 use crate::routing::router::{BlindedTail, InFlightHtlcs, Path, Payee, PaymentParameters, Route, RouteParameters, Router};
-use crate::ln::onion_payment::{check_incoming_htlc_cltv, create_recv_pending_htlc_info, create_fwd_pending_htlc_info, decode_incoming_update_add_htlc_onion, InboundOnionErr, NextPacketDetails};
+use crate::ln::onion_payment::{check_incoming_htlc_cltv, create_recv_pending_htlc_info, create_fwd_pending_htlc_info, decode_incoming_update_add_htlc_onion, InboundHTLCErr, NextPacketDetails};
 use crate::ln::msgs;
 use crate::ln::onion_utils;
 use crate::ln::onion_utils::{HTLCFailReason, INVALID_ONION_BLINDING};
@@ -3234,14 +3234,14 @@ where
 						// delay) once they've send us a commitment_signed!
 						PendingHTLCStatus::Forward(info)
 					},
-					Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
+					Err(InboundHTLCErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
 				}
 			},
 			onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
 				match create_fwd_pending_htlc_info(msg, next_hop_data, next_hop_hmac,
 					new_packet_bytes, shared_secret, next_packet_pubkey_opt) {
 					Ok(info) => PendingHTLCStatus::Forward(info),
-					Err(InboundOnionErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
+					Err(InboundHTLCErr { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
 				}
 			}
 		}
@@ -4309,7 +4309,7 @@ where
 															current_height, self.default_configuration.accept_mpp_keysend)
 														{
 															Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
-															Err(InboundOnionErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
+															Err(InboundHTLCErr { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
 														}
 													},
 													_ => panic!(),
@@ -6005,10 +6005,10 @@ where
 		let per_peer_state = self.per_peer_state.read().unwrap();
 		let peer_state_mutex = per_peer_state.get(counterparty_node_id)
 		.ok_or_else(|| {
-			let err_str = format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id); 
+			let err_str = format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id);
 			log_error!(logger, "{}", err_str);
 
-			APIError::ChannelUnavailable { err: err_str } 
+			APIError::ChannelUnavailable { err: err_str }
 		})?;
 		let mut peer_state_lock = peer_state_mutex.lock().unwrap();
 		let peer_state = &mut *peer_state_lock;
@@ -6031,7 +6031,7 @@ where
 						APIError::ChannelUnavailable { err: err_str }
 					})
 				}
-			_ => { 
+			_ => {
 				let err_str = "No such channel awaiting to be accepted.".to_owned();
 				log_error!(logger, "{}", err_str);
 
@@ -12119,8 +12119,8 @@ mod tests {
 		let sender_intended_amt_msat = 100;
 		let extra_fee_msat = 10;
 		let hop_data = msgs::InboundOnionPayload::Receive {
-			amt_msat: 100,
-			outgoing_cltv_value: 42,
+			sender_intended_htlc_amt_msat: 100,
+			cltv_expiry_height: 42,
 			payment_metadata: None,
 			keysend_preimage: None,
 			payment_data: Some(msgs::FinalOnionHopData {
@@ -12131,7 +12131,7 @@ mod tests {
 		// Check that if the amount we received + the penultimate hop extra fee is less than the sender
 		// intended amount, we fail the payment.
 		let current_height: u32 = node[0].node.best_block.read().unwrap().height();
-		if let Err(crate::ln::channelmanager::InboundOnionErr { err_code, .. }) =
+		if let Err(crate::ln::channelmanager::InboundHTLCErr { err_code, .. }) =
 			create_recv_pending_htlc_info(hop_data, [0; 32], PaymentHash([0; 32]),
 				sender_intended_amt_msat - extra_fee_msat - 1, 42, None, true, Some(extra_fee_msat),
 				current_height, node[0].node.default_configuration.accept_mpp_keysend)
@@ -12141,8 +12141,8 @@ mod tests {
 
 		// If amt_received + extra_fee is equal to the sender intended amount, we're fine.
 		let hop_data = msgs::InboundOnionPayload::Receive { // This is the same payload as above, InboundOnionPayload doesn't implement Clone
-			amt_msat: 100,
-			outgoing_cltv_value: 42,
+			sender_intended_htlc_amt_msat: 100,
+			cltv_expiry_height: 42,
 			payment_metadata: None,
 			keysend_preimage: None,
 			payment_data: Some(msgs::FinalOnionHopData {
@@ -12165,8 +12165,8 @@ mod tests {
 
 		let current_height: u32 = node[0].node.best_block.read().unwrap().height();
 		let result = create_recv_pending_htlc_info(msgs::InboundOnionPayload::Receive {
-			amt_msat: 100,
-			outgoing_cltv_value: 22,
+			sender_intended_htlc_amt_msat: 100,
+			cltv_expiry_height: 22,
 			payment_metadata: None,
 			keysend_preimage: None,
 			payment_data: Some(msgs::FinalOnionHopData {

lightning/src/ln/functional_tests.rs

@@ -8212,8 +8212,10 @@ fn test_onion_value_mpp_set_calculation() {
 				RecipientOnionFields::secret_only(our_payment_secret), height + 1, &None).unwrap();
 			// Edit amt_to_forward to simulate the sender having set
 			// the final amount and the routing node taking less fee
-			if let msgs::OutboundOnionPayload::Receive { ref mut amt_msat, .. } = onion_payloads[1] {
-				*amt_msat = 99_000;
+			if let msgs::OutboundOnionPayload::Receive {
+				ref mut sender_intended_htlc_amt_msat, ..
+			} = onion_payloads[1] {
+				*sender_intended_htlc_amt_msat = 99_000;
 			} else { panic!() }
 			let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash).unwrap();
 			payment_event.msgs[0].onion_routing_packet = new_onion_packet;

lightning/src/ln/msgs.rs

@@ -1706,8 +1706,8 @@ mod fuzzy_internal_msgs {
 			payment_metadata: Option<Vec<u8>>,
 			keysend_preimage: Option<PaymentPreimage>,
 			custom_tlvs: Vec<(u64, Vec<u8>)>,
-			amt_msat: u64,
-			outgoing_cltv_value: u32,
+			sender_intended_htlc_amt_msat: u64,
+			cltv_expiry_height: u32,
 		},
 		BlindedForward {
 			short_channel_id: u64,
@@ -1717,9 +1717,9 @@ mod fuzzy_internal_msgs {
 			intro_node_blinding_point: PublicKey,
 		},
 		BlindedReceive {
-			amt_msat: u64,
+			sender_intended_htlc_amt_msat: u64,
 			total_msat: u64,
-			outgoing_cltv_value: u32,
+			cltv_expiry_height: u32,
 			payment_secret: PaymentSecret,
 			payment_constraints: PaymentConstraints,
 			intro_node_blinding_point: Option<PublicKey>,
@@ -1738,17 +1738,17 @@ mod fuzzy_internal_msgs {
 			payment_metadata: Option<Vec<u8>>,
 			keysend_preimage: Option<PaymentPreimage>,
 			custom_tlvs: Vec<(u64, Vec<u8>)>,
-			amt_msat: u64,
-			outgoing_cltv_value: u32,
+			sender_intended_htlc_amt_msat: u64,
+			cltv_expiry_height: u32,
 		},
 		BlindedForward {
 			encrypted_tlvs: Vec<u8>,
 			intro_node_blinding_point: Option<PublicKey>,
 		},
 		BlindedReceive {
-			amt_msat: u64,
+			sender_intended_htlc_amt_msat: u64,
 			total_msat: u64,
-			outgoing_cltv_value: u32,
+			cltv_expiry_height: u32,
 			encrypted_tlvs: Vec<u8>,
 			intro_node_blinding_point: Option<PublicKey>, // Set if the introduction node of the blinded path is the final node
 		}
@@ -2290,8 +2290,8 @@ impl Writeable for OutboundOnionPayload {
 				});
 			},
 			Self::Receive {
-				ref payment_data, ref payment_metadata, ref keysend_preimage, amt_msat,
-				outgoing_cltv_value, ref custom_tlvs,
+				ref payment_data, ref payment_metadata, ref keysend_preimage, sender_intended_htlc_amt_msat,
+				cltv_expiry_height, ref custom_tlvs,
 			} => {
 				// We need to update [`ln::outbound_payment::RecipientOnionFields::with_custom_tlvs`]
 				// to reject any reserved types in the experimental range if new ones are ever
@@ -2300,8 +2300,8 @@ impl Writeable for OutboundOnionPayload {
 				let mut custom_tlvs: Vec<&(u64, Vec<u8>)> = custom_tlvs.iter().chain(keysend_tlv.iter()).collect();
 				custom_tlvs.sort_unstable_by_key(|(typ, _)| *typ);
 				_encode_varint_length_prefixed_tlv!(w, {
-					(2, HighZeroBytesDroppedBigSize(*amt_msat), required),
-					(4, HighZeroBytesDroppedBigSize(*outgoing_cltv_value), required),
+					(2, HighZeroBytesDroppedBigSize(*sender_intended_htlc_amt_msat), required),
+					(4, HighZeroBytesDroppedBigSize(*cltv_expiry_height), required),
 					(8, payment_data, option),
 					(16, payment_metadata.as_ref().map(|m| WithoutLength(m)), option)
 				}, custom_tlvs.iter());
@@ -2313,12 +2313,12 @@ impl Writeable for OutboundOnionPayload {
 				});
 			},
 			Self::BlindedReceive {
-				amt_msat, total_msat, outgoing_cltv_value, encrypted_tlvs,
+				sender_intended_htlc_amt_msat, total_msat, cltv_expiry_height, encrypted_tlvs,
 				intro_node_blinding_point,
 			} => {
 				_encode_varint_length_prefixed_tlv!(w, {
-					(2, HighZeroBytesDroppedBigSize(*amt_msat), required),
-					(4, HighZeroBytesDroppedBigSize(*outgoing_cltv_value), required),
+					(2, HighZeroBytesDroppedBigSize(*sender_intended_htlc_amt_msat), required),
+					(4, HighZeroBytesDroppedBigSize(*cltv_expiry_height), required),
 					(10, *encrypted_tlvs, required_vec),
 					(12, intro_node_blinding_point, option),
 					(18, HighZeroBytesDroppedBigSize(*total_msat), required)
@@ -2402,9 +2402,9 @@ impl<NS: Deref> ReadableArgs<(Option<PublicKey>, &NS)> for InboundOnionPayload w
 				})} => {
 					if total_msat.unwrap_or(0) > MAX_VALUE_MSAT { return Err(DecodeError::InvalidValue) }
 					Ok(Self::BlindedReceive {
-						amt_msat: amt.ok_or(DecodeError::InvalidValue)?,
+						sender_intended_htlc_amt_msat: amt.ok_or(DecodeError::InvalidValue)?,
 						total_msat: total_msat.ok_or(DecodeError::InvalidValue)?,
-						outgoing_cltv_value: cltv_value.ok_or(DecodeError::InvalidValue)?,
+						cltv_expiry_height: cltv_value.ok_or(DecodeError::InvalidValue)?,
 						payment_secret,
 						payment_constraints,
 						intro_node_blinding_point,
@@ -2433,8 +2433,8 @@ impl<NS: Deref> ReadableArgs<(Option<PublicKey>, &NS)> for InboundOnionPayload w
 				payment_data,
 				payment_metadata: payment_metadata.map(|w| w.0),
 				keysend_preimage,
-				amt_msat: amt.ok_or(DecodeError::InvalidValue)?,
-				outgoing_cltv_value: cltv_value.ok_or(DecodeError::InvalidValue)?,
+				sender_intended_htlc_amt_msat: amt.ok_or(DecodeError::InvalidValue)?,
+				cltv_expiry_height: cltv_value.ok_or(DecodeError::InvalidValue)?,
 				custom_tlvs,
 			})
 		}
@@ -4020,8 +4020,8 @@ mod tests {
 			payment_data: None,
 			payment_metadata: None,
 			keysend_preimage: None,
-			amt_msat: 0x0badf00d01020304,
-			outgoing_cltv_value: 0xffffffff,
+			sender_intended_htlc_amt_msat: 0x0badf00d01020304,
+			cltv_expiry_height: 0xffffffff,
 			custom_tlvs: vec![],
 		};
 		let encoded_value = outbound_msg.encode();
@@ -4031,10 +4031,10 @@ mod tests {
 		let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
 		let inbound_msg = ReadableArgs::read(&mut Cursor::new(&target_value[..]), (None, &&node_signer)).unwrap();
 		if let msgs::InboundOnionPayload::Receive {
-			payment_data: None, amt_msat, outgoing_cltv_value, ..
+			payment_data: None, sender_intended_htlc_amt_msat, cltv_expiry_height, ..
 		} = inbound_msg {
-			assert_eq!(amt_msat, 0x0badf00d01020304);
-			assert_eq!(outgoing_cltv_value, 0xffffffff);
+			assert_eq!(sender_intended_htlc_amt_msat, 0x0badf00d01020304);
+			assert_eq!(cltv_expiry_height, 0xffffffff);
 		} else { panic!(); }
 	}
 
@@ -4048,8 +4048,8 @@ mod tests {
 			}),
 			payment_metadata: None,
 			keysend_preimage: None,
-			amt_msat: 0x0badf00d01020304,
-			outgoing_cltv_value: 0xffffffff,
+			sender_intended_htlc_amt_msat: 0x0badf00d01020304,
+			cltv_expiry_height: 0xffffffff,
 			custom_tlvs: vec![],
 		};
 		let encoded_value = outbound_msg.encode();
@@ -4063,14 +4063,14 @@ mod tests {
 				payment_secret,
 				total_msat: 0x1badca1f
 			}),
-			amt_msat, outgoing_cltv_value,
+			sender_intended_htlc_amt_msat, cltv_expiry_height,
 			payment_metadata: None,
 			keysend_preimage: None,
 			custom_tlvs,
 		} = inbound_msg  {
 			assert_eq!(payment_secret, expected_payment_secret);
-			assert_eq!(amt_msat, 0x0badf00d01020304);
-			assert_eq!(outgoing_cltv_value, 0xffffffff);
+			assert_eq!(sender_intended_htlc_amt_msat, 0x0badf00d01020304);
+			assert_eq!(cltv_expiry_height, 0xffffffff);
 			assert_eq!(custom_tlvs, vec![]);
 		} else { panic!(); }
 	}
@@ -4088,8 +4088,8 @@ mod tests {
 			payment_metadata: None,
 			keysend_preimage: None,
 			custom_tlvs: bad_type_range_tlvs,
-			amt_msat: 0x0badf00d01020304,
-			outgoing_cltv_value: 0xffffffff,
+			sender_intended_htlc_amt_msat: 0x0badf00d01020304,
+			cltv_expiry_height: 0xffffffff,
 		};
 		let encoded_value = msg.encode();
 		let node_signer = test_utils::TestKeysInterface::new(&[42; 32], Network::Testnet);
@@ -4120,8 +4120,8 @@ mod tests {
 			payment_metadata: None,
 			keysend_preimage: None,
 			custom_tlvs: expected_custom_tlvs.clone(),
-			amt_msat: 0x0badf00d01020304,
-			outgoing_cltv_value: 0xffffffff,
+			sender_intended_htlc_amt_msat: 0x0badf00d01020304,
+			cltv_expiry_height: 0xffffffff,
 		};
 		let encoded_value = msg.encode();
 		let target_value = <Vec<u8>>::from_hex("2e02080badf00d010203040404ffffffffff0000000146c6616b021234ff0000000146c6616f084242424242424242").unwrap();
@@ -4133,12 +4133,12 @@ mod tests {
 			payment_metadata: None,
 			keysend_preimage: None,
 			custom_tlvs,
-			amt_msat,
-			outgoing_cltv_value,
+			sender_intended_htlc_amt_msat,
+			cltv_expiry_height: outgoing_cltv_value,
 			..
 		} = inbound_msg {
 			assert_eq!(custom_tlvs, expected_custom_tlvs);
-			assert_eq!(amt_msat, 0x0badf00d01020304);
+			assert_eq!(sender_intended_htlc_amt_msat, 0x0badf00d01020304);
 			assert_eq!(outgoing_cltv_value, 0xffffffff);
 		} else { panic!(); }
 	}