Rename Event::PaymentClaimable::via_channel_ids to receiving_..

In 60540f7 we renamed
`Event::PaymentClaimable::inbound_channel_ids` back to
`via_channel_ids` which was changed in
c62aa23. However, it was pointed
out that while `inbound_channel_ids` was confusing, so was
`via_channel_ids` (which can be easily interpreted as the hops
that a payment took, rather than the last hops it took to get to
us in an MPP payment).

Thus, here, we rename it yet again to `receiving_channel_ids`,
which is hopefully less ambiguous.

Author: TheBlueMatt

lightning/src/events/mod.rs

@@ -859,7 +859,7 @@ pub enum Event {
 		/// The `(channel_id, user_channel_id)` pairs over which the payment was received.
 		///
 		/// This will be an incomplete vector for MPP payment events created/serialized using LDK version 0.1.0 and prior.
-		via_channel_ids: Vec<(ChannelId, Option<u128>)>,
+		receiving_channel_ids: Vec<(ChannelId, Option<u128>)>,
 		/// The block height at which this payment will be failed back and will no longer be
 		/// eligible for claiming.
 		///
@@ -1708,7 +1708,7 @@ impl Writeable for Event {
 				counterparty_skimmed_fee_msat,
 				ref purpose,
 				ref receiver_node_id,
-				ref via_channel_ids,
+				ref receiving_channel_ids,
 				ref claim_deadline,
 				ref onion_fields,
 				ref payment_id,
@@ -1753,30 +1753,31 @@ impl Writeable for Event {
 					Some(counterparty_skimmed_fee_msat)
 				};
 
-				let (via_channel_id_legacy, via_user_channel_id_legacy) =
-					match via_channel_ids.last() {
+				let (receiving_channel_id_legacy, receiving_user_channel_id_legacy) =
+					match receiving_channel_ids.last() {
 						Some((chan_id, user_chan_id)) => (Some(*chan_id), *user_chan_id),
 						None => (None, None),
 					};
 				write_tlv_fields!(writer, {
 					(0, payment_hash, required),
 					(1, receiver_node_id, option),
 					(2, payment_secret, option),
-					// Marked as legacy in version 0.2.0; superseded by `via_channel_ids`, which
-					// includes all channel IDs used in the payment instead of only the last one.
-					(3, via_channel_id_legacy, option),
+					// Marked as legacy in version 0.2.0; superseded by `receiving_channel_ids`,
+					// which includes all channel IDs used in the payment instead of only the last
+					// one.
+					(3, receiving_channel_id_legacy, option),
 					(4, amount_msat, required),
-					// Marked as legacy in version 0.2.0 for the same reason as `via_channel_id_legacy`;
-					// superseded by `via_user_channel_ids`.
-					(5, via_user_channel_id_legacy, option),
+					// Marked as legacy in version 0.2.0 for the same reason as
+					// `receiving_channel_id_legacy`; superseded by `receiving_channel_ids`.
+					(5, receiving_user_channel_id_legacy, option),
 					// Type 6 was `user_payment_id` on 0.0.103 and earlier
 					(7, claim_deadline, option),
 					(8, payment_preimage, option),
 					(9, onion_fields, option),
 					(10, skimmed_fee_opt, option),
 					(11, payment_context, option),
 					(13, payment_id, option),
-					(15, *via_channel_ids, optional_vec),
+					(15, *receiving_channel_ids, optional_vec),
 				});
 			},
 			&Event::PaymentSent {
@@ -2154,28 +2155,28 @@ impl MaybeReadable for Event {
 					let mut counterparty_skimmed_fee_msat_opt = None;
 					let mut receiver_node_id = None;
 					let mut _user_payment_id = None::<u64>; // Used in 0.0.103 and earlier, no longer written in 0.0.116+.
-					let mut via_channel_id_legacy = None;
+					let mut receiving_channel_id_legacy = None;
 					let mut claim_deadline = None;
-					let mut via_user_channel_id_legacy = None;
+					let mut receiving_user_channel_id_legacy = None;
 					let mut onion_fields = None;
 					let mut payment_context = None;
 					let mut payment_id = None;
-					let mut via_channel_ids_opt = None;
+					let mut receiving_channel_ids_opt = None;
 					read_tlv_fields!(reader, {
 						(0, payment_hash, required),
 						(1, receiver_node_id, option),
 						(2, payment_secret, option),
-						(3, via_channel_id_legacy, option),
+						(3, receiving_channel_id_legacy, option),
 						(4, amount_msat, required),
-						(5, via_user_channel_id_legacy, option),
+						(5, receiving_user_channel_id_legacy, option),
 						(6, _user_payment_id, option),
 						(7, claim_deadline, option),
 						(8, payment_preimage, option),
 						(9, onion_fields, option),
 						(10, counterparty_skimmed_fee_msat_opt, option),
 						(11, payment_context, option),
 						(13, payment_id, option),
-						(15, via_channel_ids_opt, optional_vec),
+						(15, receiving_channel_ids_opt, optional_vec),
 					});
 					let purpose = match payment_secret {
 						Some(secret) => {
@@ -2188,10 +2189,10 @@ impl MaybeReadable for Event {
 						None => return Err(msgs::DecodeError::InvalidValue),
 					};
 
-					let via_channel_ids = via_channel_ids_opt
+					let receiving_channel_ids = receiving_channel_ids_opt
 						.or_else(|| {
-							via_channel_id_legacy
-								.map(|chan_id| vec![(chan_id, via_user_channel_id_legacy)])
+							receiving_channel_id_legacy
+								.map(|chan_id| vec![(chan_id, receiving_user_channel_id_legacy)])
 						})
 						.unwrap_or_default();
 
@@ -2202,7 +2203,7 @@ impl MaybeReadable for Event {
 						counterparty_skimmed_fee_msat: counterparty_skimmed_fee_msat_opt
 							.unwrap_or(0),
 						purpose,
-						via_channel_ids,
+						receiving_channel_ids,
 						claim_deadline,
 						onion_fields,
 						payment_id,

lightning/src/ln/blinded_payment_tests.rs

@@ -255,18 +255,18 @@ fn mpp_to_one_hop_blinded_path() {
 		Some(payment_secret), ev.clone(), true, None);
 
 	match event.unwrap() {
-		Event::PaymentClaimable { mut via_channel_ids, .. } => {
-			let mut expected_via_channel_ids = nodes[3].node.list_channels()
+		Event::PaymentClaimable { mut receiving_channel_ids, .. } => {
+			let mut expected_receiving_channel_ids = nodes[3].node.list_channels()
 				.iter()
 				.map(|d| (d.channel_id, Some(d.user_channel_id)))
 				.collect::<Vec<(_, _)>>();
 
 			// `list_channels` returns channels in arbitrary order, so we sort both vectors
 			// to ensure the comparison is order-agnostic.
-			via_channel_ids.sort();
-			expected_via_channel_ids.sort();
+			receiving_channel_ids.sort();
+			expected_receiving_channel_ids.sort();
 
-			assert_eq!(via_channel_ids, expected_via_channel_ids);
+			assert_eq!(receiving_channel_ids, expected_receiving_channel_ids);
 		}
 		_ => panic!("Unexpected event"),
 	}

lightning/src/ln/chanmon_update_fail_tests.rs

@@ -218,13 +218,13 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
 			ref purpose,
 			amount_msat,
 			receiver_node_id,
-			ref via_channel_ids,
+			ref receiving_channel_ids,
 			..
 		} => {
 			assert_eq!(payment_hash_1, *payment_hash);
 			assert_eq!(amount_msat, 1_000_000);
 			assert_eq!(receiver_node_id.unwrap(), node_b_id);
-			assert_eq!(*via_channel_ids, &[(channel_id, Some(user_channel_id))]);
+			assert_eq!(*receiving_channel_ids, &[(channel_id, Some(user_channel_id))]);
 			match &purpose {
 				PaymentPurpose::Bolt11InvoicePayment {
 					payment_preimage, payment_secret, ..
@@ -660,13 +660,13 @@ fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
 			ref purpose,
 			amount_msat,
 			receiver_node_id,
-			ref via_channel_ids,
+			ref receiving_channel_ids,
 			..
 		} => {
 			assert_eq!(payment_hash_2, *payment_hash);
 			assert_eq!(amount_msat, 1_000_000);
 			assert_eq!(receiver_node_id.unwrap(), node_b_id);
-			assert_eq!(*via_channel_ids, [(channel_id, Some(user_channel_id))]);
+			assert_eq!(*receiving_channel_ids, [(channel_id, Some(user_channel_id))]);
 			match &purpose {
 				PaymentPurpose::Bolt11InvoicePayment {
 					payment_preimage, payment_secret, ..
@@ -795,13 +795,13 @@ fn test_monitor_update_fail_cs() {
 			ref purpose,
 			amount_msat,
 			receiver_node_id,
-			ref via_channel_ids,
+			ref receiving_channel_ids,
 			..
 		} => {
 			assert_eq!(payment_hash, our_payment_hash);
 			assert_eq!(amount_msat, 1_000_000);
 			assert_eq!(receiver_node_id.unwrap(), node_b_id);
-			assert_eq!(*via_channel_ids, [(channel_id, Some(user_channel_id))]);
+			assert_eq!(*receiving_channel_ids, [(channel_id, Some(user_channel_id))]);
 			match &purpose {
 				PaymentPurpose::Bolt11InvoicePayment {
 					payment_preimage, payment_secret, ..
@@ -1906,13 +1906,13 @@ fn test_monitor_update_fail_claim() {
 			ref purpose,
 			amount_msat,
 			receiver_node_id,
-			ref via_channel_ids,
+			ref receiving_channel_ids,
 			..
 		} => {
 			assert_eq!(payment_hash_2, *payment_hash);
 			assert_eq!(1_000_000, amount_msat);
 			assert_eq!(receiver_node_id.unwrap(), node_a_id);
-			assert_eq!(*via_channel_ids.last().unwrap(), (channel_id, Some(42)));
+			assert_eq!(*receiving_channel_ids.last().unwrap(), (channel_id, Some(42)));
 			match &purpose {
 				PaymentPurpose::Bolt11InvoicePayment {
 					payment_preimage, payment_secret, ..
@@ -1931,13 +1931,13 @@ fn test_monitor_update_fail_claim() {
 			ref purpose,
 			amount_msat,
 			receiver_node_id,
-			ref via_channel_ids,
+			ref receiving_channel_ids,
 			..
 		} => {
 			assert_eq!(payment_hash_3, *payment_hash);
 			assert_eq!(1_000_000, amount_msat);
 			assert_eq!(receiver_node_id.unwrap(), node_a_id);
-			assert_eq!(*via_channel_ids, [(channel_id, Some(42))]);
+			assert_eq!(*receiving_channel_ids, [(channel_id, Some(42))]);
 			match &purpose {
 				PaymentPurpose::Bolt11InvoicePayment {
 					payment_preimage, payment_secret, ..

lightning/src/ln/channelmanager.rs

@@ -960,7 +960,7 @@ impl ClaimablePayment {
 	/// Returns the inbound `(channel_id, user_channel_id)` pairs for all HTLCs associated with the payment.
 	///
 	/// Note: The `user_channel_id` will be `None` for HTLCs created using LDK version 0.0.117 or prior.
-	fn via_channel_ids(&self) -> Vec<(ChannelId, Option<u128>)> {
+	fn receiving_channel_ids(&self) -> Vec<(ChannelId, Option<u128>)> {
 		self.htlcs
 			.iter()
 			.map(|htlc| (htlc.prev_hop.channel_id, htlc.prev_hop.user_channel_id))
@@ -7168,7 +7168,7 @@ where
 									purpose: $purpose,
 									amount_msat,
 									counterparty_skimmed_fee_msat,
-									via_channel_ids: claimable_payment.via_channel_ids(),
+									receiving_channel_ids: claimable_payment.receiving_channel_ids(),
 									claim_deadline: Some(earliest_expiry - HTLC_FAIL_BACK_BUFFER),
 									onion_fields: claimable_payment.onion_fields.clone(),
 									payment_id: Some(payment_id),

lightning/src/ln/functional_test_utils.rs

@@ -3357,7 +3357,7 @@ pub fn do_pass_along_path<'a, 'b, 'c>(args: PassAlongPathArgs) -> Option<Event>
 						ref purpose,
 						amount_msat,
 						receiver_node_id,
-						ref via_channel_ids,
+						ref receiving_channel_ids,
 						claim_deadline,
 						onion_fields,
 						..
@@ -3421,7 +3421,7 @@ pub fn do_pass_along_path<'a, 'b, 'c>(args: PassAlongPathArgs) -> Option<Event>
 						}
 						assert_eq!(*amount_msat, recv_value);
 						let channels = node.node.list_channels();
-						for (chan_id, user_chan_id) in via_channel_ids {
+						for (chan_id, user_chan_id) in receiving_channel_ids {
 							let chan = channels
 								.iter()
 								.find(|details| &details.channel_id == chan_id)

lightning/src/ln/functional_tests.rs

@@ -3174,13 +3174,13 @@ fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken
 			ref purpose,
 			amount_msat,
 			receiver_node_id,
-			ref via_channel_ids,
+			ref receiving_channel_ids,
 			..
 		} => {
 			assert_eq!(payment_hash_1, *payment_hash);
 			assert_eq!(amount_msat, 1_000_000);
 			assert_eq!(receiver_node_id.unwrap(), node_b_id);
-			assert_eq!(*via_channel_ids, vec![(channel_id, Some(user_channel_id))]);
+			assert_eq!(*receiving_channel_ids, vec![(channel_id, Some(user_channel_id))]);
 			match &purpose {
 				PaymentPurpose::Bolt11InvoicePayment {
 					payment_preimage, payment_secret, ..

lightning/src/ln/htlc_reserve_unit_tests.rs

@@ -375,13 +375,13 @@ pub fn test_channel_reserve_holding_cell_htlcs() {
 			ref purpose,
 			amount_msat,
 			receiver_node_id,
-			ref via_channel_ids,
+			ref receiving_channel_ids,
 			..
 		} => {
 			assert_eq!(our_payment_hash_21, *payment_hash);
 			assert_eq!(recv_value_21, amount_msat);
 			assert_eq!(node_c_id, receiver_node_id.unwrap());
-			assert_eq!(*via_channel_ids, vec![(chan_2.2, Some(chan_2_user_id))]);
+			assert_eq!(*receiving_channel_ids, vec![(chan_2.2, Some(chan_2_user_id))]);
 			match &purpose {
 				PaymentPurpose::Bolt11InvoicePayment {
 					payment_preimage, payment_secret, ..
@@ -400,13 +400,13 @@ pub fn test_channel_reserve_holding_cell_htlcs() {
 			ref purpose,
 			amount_msat,
 			receiver_node_id,
-			ref via_channel_ids,
+			ref receiving_channel_ids,
 			..
 		} => {
 			assert_eq!(our_payment_hash_22, *payment_hash);
 			assert_eq!(recv_value_22, amount_msat);
 			assert_eq!(node_c_id, receiver_node_id.unwrap());
-			assert_eq!(*via_channel_ids, vec![(chan_2.2, Some(chan_2_user_id))]);
+			assert_eq!(*receiving_channel_ids, vec![(chan_2.2, Some(chan_2_user_id))]);
 			match &purpose {
 				PaymentPurpose::Bolt11InvoicePayment {
 					payment_preimage, payment_secret, ..