Rename InboundOnionErr to InboundHTLCErr.

The prior name seems to reference onion decode errors specifically, when in
fact the error contents are generic failure codes for any error that occurs
during HTLC receipt.

Author: valentinewallace

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};
@@ -3245,14 +3245,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!(),
@@ -6011,10 +6011,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;
@@ -12139,7 +12139,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)

lightning/src/ln/onion_payment.rs

@@ -25,7 +25,7 @@ use core::ops::Deref;
 
 /// Invalid inbound onion payment.
 #[derive(Debug)]
-pub struct InboundOnionErr {
+pub struct InboundHTLCErr {
 	/// BOLT 4 error code.
 	pub err_code: u16,
 	/// Data attached to this error.
@@ -63,7 +63,7 @@ pub(super) fn create_fwd_pending_htlc_info(
 	msg: &msgs::UpdateAddHTLC, hop_data: msgs::InboundOnionPayload, hop_hmac: [u8; 32],
 	new_packet_bytes: [u8; onion_utils::ONION_DATA_LEN], shared_secret: [u8; 32],
 	next_packet_pubkey_opt: Option<Result<PublicKey, secp256k1::Error>>
-) -> Result<PendingHTLCInfo, InboundOnionErr> {
+) -> Result<PendingHTLCInfo, InboundHTLCErr> {
 	debug_assert!(next_packet_pubkey_opt.is_some());
 	let outgoing_packet = msgs::OnionPacket {
 		version: 0,
@@ -85,7 +85,7 @@ pub(super) fn create_fwd_pending_htlc_info(
 			).map_err(|()| {
 				// We should be returning malformed here if `msg.blinding_point` is set, but this is
 				// unreachable right now since we checked it in `decode_update_add_htlc_onion`.
-				InboundOnionErr {
+				InboundHTLCErr {
 					msg: "Underflow calculating outbound amount or cltv value for blinded forward",
 					err_code: INVALID_ONION_BLINDING,
 					err_data: vec![0; 32],
@@ -94,7 +94,7 @@ pub(super) fn create_fwd_pending_htlc_info(
 			(short_channel_id, amt_to_forward, outgoing_cltv_value, Some(intro_node_blinding_point))
 		},
 		msgs::InboundOnionPayload::Receive { .. } | msgs::InboundOnionPayload::BlindedReceive { .. } =>
-			return Err(InboundOnionErr {
+			return Err(InboundHTLCErr {
 				msg: "Final Node OnionHopData provided for us as an intermediary node",
 				err_code: 0x4000 | 22,
 				err_data: Vec::new(),
@@ -120,7 +120,7 @@ pub(super) fn create_recv_pending_htlc_info(
 	hop_data: msgs::InboundOnionPayload, shared_secret: [u8; 32], payment_hash: PaymentHash,
 	amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>, allow_underpay: bool,
 	counterparty_skimmed_fee_msat: Option<u64>, current_height: u32, accept_mpp_keysend: bool,
-) -> Result<PendingHTLCInfo, InboundOnionErr> {
+) -> Result<PendingHTLCInfo, InboundHTLCErr> {
 	let (
 		payment_data, keysend_preimage, custom_tlvs, onion_amt_msat, outgoing_cltv_value,
 		payment_metadata, requires_blinded_error
@@ -136,7 +136,7 @@ pub(super) fn create_recv_pending_htlc_info(
 		} => {
 			check_blinded_payment_constraints(amt_msat, cltv_expiry, &payment_constraints)
 				.map_err(|()| {
-					InboundOnionErr {
+					InboundHTLCErr {
 						err_code: INVALID_ONION_BLINDING,
 						err_data: vec![0; 32],
 						msg: "Amount or cltv_expiry violated blinded payment constraints",
@@ -147,14 +147,14 @@ pub(super) fn create_recv_pending_htlc_info(
 			 intro_node_blinding_point.is_none())
 		}
 		msgs::InboundOnionPayload::Forward { .. } => {
-			return Err(InboundOnionErr {
+			return Err(InboundHTLCErr {
 				err_code: 0x4000|22,
 				err_data: Vec::new(),
 				msg: "Got non final data with an HMAC of 0",
 			})
 		},
 		msgs::InboundOnionPayload::BlindedForward { .. } => {
-			return Err(InboundOnionErr {
+			return Err(InboundHTLCErr {
 				err_code: INVALID_ONION_BLINDING,
 				err_data: vec![0; 32],
 				msg: "Got blinded non final data with an HMAC of 0",
@@ -163,7 +163,7 @@ pub(super) fn create_recv_pending_htlc_info(
 	};
 	// final_incorrect_cltv_expiry
 	if outgoing_cltv_value > cltv_expiry {
-		return Err(InboundOnionErr {
+		return Err(InboundHTLCErr {
 			msg: "Upstream node set CLTV to less than the CLTV set by the sender",
 			err_code: 18,
 			err_data: cltv_expiry.to_be_bytes().to_vec()
@@ -180,7 +180,7 @@ pub(super) fn create_recv_pending_htlc_info(
 		let mut err_data = Vec::with_capacity(12);
 		err_data.extend_from_slice(&amt_msat.to_be_bytes());
 		err_data.extend_from_slice(&current_height.to_be_bytes());
-		return Err(InboundOnionErr {
+		return Err(InboundHTLCErr {
 			err_code: 0x4000 | 15, err_data,
 			msg: "The final CLTV expiry is too soon to handle",
 		});
@@ -189,7 +189,7 @@ pub(super) fn create_recv_pending_htlc_info(
 		(allow_underpay && onion_amt_msat >
 		 amt_msat.saturating_add(counterparty_skimmed_fee_msat.unwrap_or(0)))
 	{
-		return Err(InboundOnionErr {
+		return Err(InboundHTLCErr {
 			err_code: 19,
 			err_data: amt_msat.to_be_bytes().to_vec(),
 			msg: "Upstream node sent less than we were supposed to receive in payment",
@@ -204,14 +204,14 @@ pub(super) fn create_recv_pending_htlc_info(
 		// time discrepancies due to a hash collision with X.
 		let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).to_byte_array());
 		if hashed_preimage != payment_hash {
-			return Err(InboundOnionErr {
+			return Err(InboundHTLCErr {
 				err_code: 0x4000|22,
 				err_data: Vec::new(),
 				msg: "Payment preimage didn't match payment hash",
 			});
 		}
 		if !accept_mpp_keysend && payment_data.is_some() {
-			return Err(InboundOnionErr {
+			return Err(InboundHTLCErr {
 				err_code: 0x4000|22,
 				err_data: Vec::new(),
 				msg: "We don't support MPP keysend payments",
@@ -234,7 +234,7 @@ pub(super) fn create_recv_pending_htlc_info(
 			requires_blinded_error,
 		}
 	} else {
-		return Err(InboundOnionErr {
+		return Err(InboundHTLCErr {
 			err_code: 0x4000|0x2000|3,
 			err_data: Vec::new(),
 			msg: "We require payment_secrets",
@@ -263,7 +263,7 @@ pub(super) fn create_recv_pending_htlc_info(
 pub fn peel_payment_onion<NS: Deref, L: Deref, T: secp256k1::Verification>(
 	msg: &msgs::UpdateAddHTLC, node_signer: &NS, logger: &L, secp_ctx: &Secp256k1<T>,
 	cur_height: u32, accept_mpp_keysend: bool, allow_skimmed_fees: bool,
-) -> Result<PendingHTLCInfo, InboundOnionErr>
+) -> Result<PendingHTLCInfo, InboundHTLCErr>
 where
 	NS::Target: NodeSigner,
 	L::Target: Logger,
@@ -276,7 +276,7 @@ where
 			HTLCFailureMsg::Relay(r) => (0x4000 | 22, r.reason.data),
 		};
 		let msg = "Failed to decode update add htlc onion";
-		InboundOnionErr { msg, err_code, err_data }
+		InboundHTLCErr { msg, err_code, err_data }
 	})?;
 	Ok(match hop {
 		onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
@@ -285,7 +285,7 @@ where
 			} = match next_packet_details_opt {
 				Some(next_packet_details) => next_packet_details,
 				// Forward should always include the next hop details
-				None => return Err(InboundOnionErr {
+				None => return Err(InboundHTLCErr {
 					msg: "Failed to decode update add htlc onion",
 					err_code: 0x4000 | 22,
 					err_data: Vec::new(),
@@ -295,7 +295,7 @@ where
 			if let Err((err_msg, code)) = check_incoming_htlc_cltv(
 				cur_height, outgoing_cltv_value, msg.cltv_expiry
 			) {
-				return Err(InboundOnionErr {
+				return Err(InboundHTLCErr {
 					msg: err_msg,
 					err_code: code,
 					err_data: Vec::new(),