Skip to content

Commit d474665

Browse files
tee8ztee8z
committed
renames variable 'our_node_id' to 'receiver_node_id' and cleans up change based on PR comments
1 parent 434d8ce commit d474665

File tree

5 files changed

+38
-38
lines changed

5 files changed

+38
-38
lines changed

‎lightning/src/ln/chanmon_update_fail_tests.rs

+10-10
Original file line numberDiff line numberDiff line change
@@ -201,10 +201,10 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
201201
let events_3 = nodes[1].node.get_and_clear_pending_events();
202202
assert_eq!(events_3.len(), 1);
203203
match events_3[0] {
204-
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, our_node_id } => {
204+
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, receiver_node_id } => {
205205
assert_eq!(payment_hash_1, *payment_hash);
206206
assert_eq!(amount_msat, 1_000_000);
207-
assert_eq!(our_node_id.unwrap(), nodes[1].node.get_our_node_id());
207+
assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
208208
match &purpose {
209209
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
210210
assert!(payment_preimage.is_none());
@@ -570,10 +570,10 @@ fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
570570
let events_5 = nodes[1].node.get_and_clear_pending_events();
571571
assert_eq!(events_5.len(), 1);
572572
match events_5[0] {
573-
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, our_node_id } => {
573+
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, receiver_node_id } => {
574574
assert_eq!(payment_hash_2, *payment_hash);
575575
assert_eq!(amount_msat, 1_000_000);
576-
assert_eq!(our_node_id.unwrap(), nodes[1].node.get_our_node_id());
576+
assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
577577
match &purpose {
578578
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
579579
assert!(payment_preimage.is_none());
@@ -688,10 +688,10 @@ fn test_monitor_update_fail_cs() {
688688
let events = nodes[1].node.get_and_clear_pending_events();
689689
assert_eq!(events.len(), 1);
690690
match events[0] {
691-
Event::PaymentReceived { payment_hash, ref purpose, amount_msat, our_node_id } => {
691+
Event::PaymentReceived { payment_hash, ref purpose, amount_msat, receiver_node_id } => {
692692
assert_eq!(payment_hash, our_payment_hash);
693693
assert_eq!(amount_msat, 1_000_000);
694-
assert_eq!(our_node_id.unwrap(), nodes[1].node.get_our_node_id());
694+
assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
695695
match &purpose {
696696
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
697697
assert!(payment_preimage.is_none());
@@ -1663,10 +1663,10 @@ fn test_monitor_update_fail_claim() {
16631663
let events = nodes[0].node.get_and_clear_pending_events();
16641664
assert_eq!(events.len(), 2);
16651665
match events[0] {
1666-
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, our_node_id } => {
1666+
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, receiver_node_id } => {
16671667
assert_eq!(payment_hash_2, *payment_hash);
16681668
assert_eq!(1_000_000, amount_msat);
1669-
assert_eq!(our_node_id.unwrap(), nodes[0].node.get_our_node_id());
1669+
assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
16701670
match &purpose {
16711671
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
16721672
assert!(payment_preimage.is_none());
@@ -1678,10 +1678,10 @@ fn test_monitor_update_fail_claim() {
16781678
_ => panic!("Unexpected event"),
16791679
}
16801680
match events[1] {
1681-
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, our_node_id } => {
1681+
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, receiver_node_id } => {
16821682
assert_eq!(payment_hash_3, *payment_hash);
16831683
assert_eq!(1_000_000, amount_msat);
1684-
assert_eq!(our_node_id.unwrap(), nodes[0].node.get_our_node_id());
1684+
assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
16851685
match &purpose {
16861686
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
16871687
assert!(payment_preimage.is_none());

‎lightning/src/ln/channelmanager.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -3360,7 +3360,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
33603360
} else if total_value == $payment_data.total_msat {
33613361
htlcs.push(claimable_htlc);
33623362
new_events.push(events::Event::PaymentReceived {
3363-
our_node_id: Some(self.our_network_pubkey),
3363+
receiver_node_id: Some(self.our_network_pubkey),
33643364
payment_hash,
33653365
purpose: purpose(),
33663366
amount_msat: total_value,
@@ -3403,7 +3403,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
34033403
let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
34043404
e.insert((purpose.clone(), vec![claimable_htlc]));
34053405
new_events.push(events::Event::PaymentReceived {
3406-
our_node_id: Some(self.our_network_pubkey),
3406+
receiver_node_id: Some(self.our_network_pubkey),
34073407
payment_hash,
34083408
amount_msat: amt_to_forward,
34093409
purpose,
@@ -4101,7 +4101,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
41014101

41024102
if claimed_any_htlcs {
41034103
self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
4104-
our_node_id: Some(self.our_network_pubkey),
4104+
receiver_node_id: Some(self.our_network_pubkey),
41054105
payment_hash,
41064106
purpose: payment_purpose,
41074107
amount_msat: claimable_amt_msat,
@@ -7228,7 +7228,7 @@ impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
72287228
}
72297229
}
72307230
pending_events_read.push(events::Event::PaymentClaimed {
7231-
our_node_id: Some(our_network_pubkey),
7231+
receiver_node_id: Some(our_network_pubkey),
72327232
payment_hash,
72337233
purpose: payment_purpose,
72347234
amount_msat: claimable_amt_msat,

‎lightning/src/ln/functional_test_utils.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -1380,10 +1380,10 @@ macro_rules! expect_payment_received {
13801380
let events = $node.node.get_and_clear_pending_events();
13811381
assert_eq!(events.len(), 1);
13821382
match events[0] {
1383-
$crate::util::events::Event::PaymentReceived {ref payment_hash, ref purpose, amount_msat, our_node_id } => {
1383+
$crate::util::events::Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, receiver_node_id } => {
13841384
assert_eq!($expected_payment_hash, *payment_hash);
13851385
assert_eq!($expected_recv_value, amount_msat);
1386-
assert_eq!($node.node.get_our_node_id(), our_node_id.unwrap());
1386+
assert_eq!($node.node.get_our_node_id(), receiver_node_id.unwrap());
13871387
match purpose {
13881388
$crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
13891389
assert_eq!(&$expected_payment_preimage, payment_preimage);
@@ -1661,9 +1661,9 @@ pub fn do_pass_along_path<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_p
16611661
if payment_received_expected {
16621662
assert_eq!(events_2.len(), 1);
16631663
match events_2[0] {
1664-
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, our_node_id } => {
1664+
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, receiver_node_id } => {
16651665
assert_eq!(our_payment_hash, *payment_hash);
1666-
assert_eq!(node.node.get_our_node_id(), our_node_id.unwrap());
1666+
assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
16671667
match &purpose {
16681668
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
16691669
assert_eq!(expected_preimage, *payment_preimage);

‎lightning/src/ln/functional_tests.rs

+6-6
Original file line numberDiff line numberDiff line change
@@ -1955,10 +1955,10 @@ fn test_channel_reserve_holding_cell_htlcs() {
19551955
let events = nodes[2].node.get_and_clear_pending_events();
19561956
assert_eq!(events.len(), 2);
19571957
match events[0] {
1958-
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, our_node_id } => {
1958+
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, receiver_node_id } => {
19591959
assert_eq!(our_payment_hash_21, *payment_hash);
19601960
assert_eq!(recv_value_21, amount_msat);
1961-
assert_eq!(nodes[2].node.get_our_node_id(), our_node_id.unwrap());
1961+
assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
19621962
match &purpose {
19631963
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
19641964
assert!(payment_preimage.is_none());
@@ -1970,10 +1970,10 @@ fn test_channel_reserve_holding_cell_htlcs() {
19701970
_ => panic!("Unexpected event"),
19711971
}
19721972
match events[1] {
1973-
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, our_node_id } => {
1973+
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, receiver_node_id } => {
19741974
assert_eq!(our_payment_hash_22, *payment_hash);
19751975
assert_eq!(recv_value_22, amount_msat);
1976-
assert_eq!(nodes[2].node.get_our_node_id(), our_node_id.unwrap());
1976+
assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
19771977
match &purpose {
19781978
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
19791979
assert!(payment_preimage.is_none());
@@ -3728,10 +3728,10 @@ fn do_test_drop_messages_peer_disconnect(messages_delivered: u8, simulate_broken
37283728
let events_2 = nodes[1].node.get_and_clear_pending_events();
37293729
assert_eq!(events_2.len(), 1);
37303730
match events_2[0] {
3731-
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, our_node_id } => {
3731+
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, receiver_node_id } => {
37323732
assert_eq!(payment_hash_1, *payment_hash);
37333733
assert_eq!(amount_msat, 1_000_000);
3734-
assert_eq!(our_node_id.unwrap(), nodes[1].node.get_our_node_id());
3734+
assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
37353735
match &purpose {
37363736
PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
37373737
assert!(payment_preimage.is_none());

‎lightning/src/util/events.rs

+14-14
Original file line numberDiff line numberDiff line change
@@ -249,8 +249,8 @@ pub enum Event {
249249
/// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
250250
/// [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
251251
PaymentReceived {
252-
/// The node that recieved the payment, ie our node
253-
our_node_id: Option<PublicKey>,
252+
/// The node that received the payment
253+
receiver_node_id: Option<PublicKey>,
254254
/// The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
255255
/// not stop you from registering duplicate payment hashes for inbound payments.
256256
payment_hash: PaymentHash,
@@ -275,8 +275,8 @@ pub enum Event {
275275
///
276276
/// [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
277277
PaymentClaimed {
278-
/// The node that recieved the payment, ie our node
279-
our_node_id: Option<PublicKey>,
278+
/// The node that received the payment
279+
receiver_node_id: Option<PublicKey>,
280280
/// The payment hash of the claimed payment. Note that LDK will not stop you from
281281
/// registering duplicate payment hashes for inbound payments.
282282
payment_hash: PaymentHash,
@@ -616,7 +616,7 @@ impl Writeable for Event {
616616
// We never write out FundingGenerationReady events as, upon disconnection, peers
617617
// drop any channels which have not yet exchanged funding_signed.
618618
},
619-
&Event::PaymentReceived { ref payment_hash, ref amount_msat, ref purpose, our_node_id } => {
619+
&Event::PaymentReceived { ref payment_hash, ref amount_msat, ref purpose, receiver_node_id } => {
620620
1u8.write(writer)?;
621621
let mut payment_secret = None;
622622
let payment_preimage;
@@ -635,7 +635,7 @@ impl Writeable for Event {
635635
(4, amount_msat, required),
636636
(6, 0u64, required), // user_payment_id required for compatibility with 0.0.103 and earlier
637637
(8, payment_preimage, option),
638-
(10, our_node_id, option),
638+
(9, receiver_node_id, option),
639639
});
640640
},
641641
&Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
@@ -726,13 +726,13 @@ impl Writeable for Event {
726726
// We never write the OpenChannelRequest events as, upon disconnection, peers
727727
// drop any channels which have not yet exchanged funding_signed.
728728
},
729-
&Event::PaymentClaimed { ref payment_hash, ref amount_msat, ref purpose, our_node_id } => {
729+
&Event::PaymentClaimed { ref payment_hash, ref amount_msat, ref purpose, receiver_node_id } => {
730730
19u8.write(writer)?;
731731
write_tlv_fields!(writer, {
732732
(0, payment_hash, required),
733733
(2, purpose, required),
734734
(4, amount_msat, required),
735-
(6, our_node_id, option),
735+
(7, receiver_node_id, option),
736736
});
737737
},
738738
&Event::ProbeSuccessful { ref payment_id, ref payment_hash, ref path } => {
@@ -778,15 +778,15 @@ impl MaybeReadable for Event {
778778
let mut payment_preimage = None;
779779
let mut payment_secret = None;
780780
let mut amount_msat = 0;
781-
let mut our_node_id = None;
781+
let mut receiver_node_id = None;
782782
let mut _user_payment_id = None::<u64>; // For compatibility with 0.0.103 and earlier
783783
read_tlv_fields!(reader, {
784784
(0, payment_hash, required),
785785
(2, payment_secret, option),
786786
(4, amount_msat, required),
787787
(6, _user_payment_id, option),
788788
(8, payment_preimage, option),
789-
(10, our_node_id, option),
789+
(11, receiver_node_id, option),
790790
});
791791
let purpose = match payment_secret {
792792
Some(secret) => PaymentPurpose::InvoicePayment {
@@ -797,7 +797,7 @@ impl MaybeReadable for Event {
797797
None => return Err(msgs::DecodeError::InvalidValue),
798798
};
799799
Ok(Some(Event::PaymentReceived {
800-
our_node_id,
800+
receiver_node_id,
801801
payment_hash,
802802
amount_msat,
803803
purpose,
@@ -967,17 +967,17 @@ impl MaybeReadable for Event {
967967
let mut payment_hash = PaymentHash([0; 32]);
968968
let mut purpose = None;
969969
let mut amount_msat = 0;
970-
let mut our_node_id = None;
970+
let mut receiver_node_id = None;
971971
read_tlv_fields!(reader, {
972972
(0, payment_hash, required),
973973
(2, purpose, ignorable),
974974
(4, amount_msat, required),
975-
(6, our_node_id, option),
975+
(7, receiver_node_id, option),
976976
});
977977
if purpose.is_none() { return Ok(None); }
978978

979979
Ok(Some(Event::PaymentClaimed {
980-
our_node_id,
980+
receiver_node_id,
981981
payment_hash,
982982
purpose: purpose.unwrap(),
983983
amount_msat,

0 commit comments

Comments
 (0)