f - s/intended_value/sender_intended_value and clarify doc comment

Author: alecchendev

lightning/src/ln/channelmanager.rs

@@ -191,9 +191,9 @@ struct ClaimableHTLC {
 	cltv_expiry: u32,
 	/// The amount (in msats) of this MPP part
 	value: u64,
-	/// The amount (in msats) that the sender intended to be sent (used for
-	/// validating total MPP amount)
-	intended_value: u64,
+	/// The amount (in msats) that the sender intended to be sent in this MPP
+	/// part (used for validating total MPP amount)
+	sender_intended_value: u64,
 	onion_payload: OnionPayload,
 	timer_ticks: u8,
 	/// The sum total of all MPP parts
@@ -3261,7 +3261,7 @@ where
 									// if possible so that we don't prematurely mark MPP payments complete
 									// if routing nodes overpay
 									value: incoming_amt_msat.unwrap_or(outgoing_amt_msat),
-									intended_value: outgoing_amt_msat,
+									sender_intended_value: outgoing_amt_msat,
 									timer_ticks: 0,
 									total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
 									cltv_expiry,
@@ -3316,9 +3316,9 @@ where
 												continue
 											}
 										}
-										let mut total_value = claimable_htlc.intended_value;
+										let mut total_value = claimable_htlc.sender_intended_value;
 										for htlc in htlcs.iter() {
-											total_value += htlc.intended_value;
+											total_value += htlc.sender_intended_value;
 											match &htlc.onion_payload {
 												OnionPayload::Invoice { .. } => {
 													if htlc.total_msat != $payment_data.total_msat {
@@ -3333,7 +3333,7 @@ where
 										}
 										if total_value >= msgs::MAX_VALUE_MSAT {
 											fail_htlc!(claimable_htlc, payment_hash);
-										} else if total_value - claimable_htlc.intended_value >= $payment_data.total_msat {
+										} else if total_value - claimable_htlc.sender_intended_value >= $payment_data.total_msat {
 											log_trace!(self.logger, "Failing HTLC with payment_hash {} as payment is already claimable",
 												log_bytes!(payment_hash.0));
 											fail_htlc!(claimable_htlc, payment_hash);
@@ -6775,7 +6775,7 @@ impl Writeable for ClaimableHTLC {
 			(0, self.prev_hop, required),
 			(1, self.total_msat, required),
 			(2, self.value, required),
-			(3, self.intended_value, required),
+			(3, self.sender_intended_value, required),
 			(4, payment_data, option),
 			(6, self.cltv_expiry, required),
 			(8, keysend_preimage, option),
@@ -6788,7 +6788,7 @@ impl Readable for ClaimableHTLC {
 	fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
 		let mut prev_hop = crate::util::ser::RequiredWrapper(None);
 		let mut value = 0;
-		let mut intended_value = None;
+		let mut sender_intended_value = None;
 		let mut payment_data: Option<msgs::FinalOnionHopData> = None;
 		let mut cltv_expiry = 0;
 		let mut total_msat = None;
@@ -6797,7 +6797,7 @@ impl Readable for ClaimableHTLC {
 			(0, prev_hop, required),
 			(1, total_msat, option),
 			(2, value, required),
-			(3, intended_value, option),
+			(3, sender_intended_value, option),
 			(4, payment_data, option),
 			(6, cltv_expiry, required),
 			(8, keysend_preimage, option)
@@ -6826,7 +6826,7 @@ impl Readable for ClaimableHTLC {
 			prev_hop: prev_hop.0.unwrap(),
 			timer_ticks: 0,
 			value,
-			intended_value: intended_value.unwrap_or(value),
+			sender_intended_value: sender_intended_value.unwrap_or(value),
 			total_msat: total_msat.unwrap(),
 			onion_payload,
 			cltv_expiry,