Skip to content

Commit de2acc0

Browse files
TheBlueMattTheBlueMatt
authored
Merge pull request #1891 from tnull/2022-12-rename-payment-events
Rename `PaymentReceived` to `PaymentClaimable`
2 parents 14d2e97 + c17e9fb commit de2acc0

14 files changed

+112
-104
lines changed

‎fuzz/src/chanmon_consistency.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -843,24 +843,24 @@ pub fn do_test<Out: Output>(data: &[u8], underlying_out: Out) {
843843
let mut events = nodes[$node].get_and_clear_pending_events();
844844
// Sort events so that PendingHTLCsForwardable get processed last. This avoids a
845845
// case where we first process a PendingHTLCsForwardable, then claim/fail on a
846-
// PaymentReceived, claiming/failing two HTLCs, but leaving a just-generated
847-
// PaymentReceived event for the second HTLC in our pending_events (and breaking
846+
// PaymentClaimable, claiming/failing two HTLCs, but leaving a just-generated
847+
// PaymentClaimable event for the second HTLC in our pending_events (and breaking
848848
// our claim_set deduplication).
849849
events.sort_by(|a, b| {
850-
if let events::Event::PaymentReceived { .. } = a {
850+
if let events::Event::PaymentClaimable { .. } = a {
851851
if let events::Event::PendingHTLCsForwardable { .. } = b {
852852
Ordering::Less
853853
} else { Ordering::Equal }
854854
} else if let events::Event::PendingHTLCsForwardable { .. } = a {
855-
if let events::Event::PaymentReceived { .. } = b {
855+
if let events::Event::PaymentClaimable { .. } = b {
856856
Ordering::Greater
857857
} else { Ordering::Equal }
858858
} else { Ordering::Equal }
859859
});
860860
let had_events = !events.is_empty();
861861
for event in events.drain(..) {
862862
match event {
863-
events::Event::PaymentReceived { payment_hash, .. } => {
863+
events::Event::PaymentClaimable { payment_hash, .. } => {
864864
if claim_set.insert(payment_hash.0) {
865865
if $fail {
866866
nodes[$node].fail_htlc_backwards(&payment_hash);

‎fuzz/src/full_stack.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -646,7 +646,7 @@ pub fn do_test(data: &[u8], logger: &Arc<dyn Logger>) {
646646
Event::FundingGenerationReady { temporary_channel_id, counterparty_node_id, channel_value_satoshis, output_script, .. } => {
647647
pending_funding_generation.push((temporary_channel_id, counterparty_node_id, channel_value_satoshis, output_script));
648648
},
649-
Event::PaymentReceived { payment_hash, .. } => {
649+
Event::PaymentClaimable { payment_hash, .. } => {
650650
//TODO: enhance by fetching random amounts from fuzz input?
651651
payments_received.push(payment_hash);
652652
},

‎lightning-invoice/src/utils.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -957,7 +957,7 @@ mod test {
957957
nodes[fwd_idx].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
958958
commitment_signed_dance!(nodes[fwd_idx], nodes[0], &payment_event.commitment_msg, false, true);
959959

960-
// Note that we have to "forward pending HTLCs" twice before we see the PaymentReceived as
960+
// Note that we have to "forward pending HTLCs" twice before we see the PaymentClaimable as
961961
// this "emulates" the payment taking two hops, providing some privacy to make phantom node
962962
// payments "look real" by taking more time.
963963
expect_pending_htlcs_forwardable_ignore!(nodes[fwd_idx]);
@@ -966,7 +966,7 @@ mod test {
966966
nodes[fwd_idx].node.process_pending_htlc_forwards();
967967

968968
let payment_preimage_opt = if user_generated_pmt_hash { None } else { Some(payment_preimage) };
969-
expect_payment_received!(&nodes[fwd_idx], payment_hash, payment_secret, payment_amt, payment_preimage_opt, route.paths[0].last().unwrap().pubkey);
969+
expect_payment_claimable!(&nodes[fwd_idx], payment_hash, payment_secret, payment_amt, payment_preimage_opt, route.paths[0].last().unwrap().pubkey);
970970
do_claim_payment_along_route(&nodes[0], &vec!(&vec!(&nodes[fwd_idx])[..]), false, payment_preimage);
971971
let events = nodes[0].node.get_and_clear_pending_events();
972972
assert_eq!(events.len(), 2);

‎lightning/src/ln/chanmon_update_fail_tests.rs

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
200200
let events_3 = nodes[1].node.get_and_clear_pending_events();
201201
assert_eq!(events_3.len(), 1);
202202
match events_3[0] {
203-
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
203+
Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
204204
assert_eq!(payment_hash_1, *payment_hash);
205205
assert_eq!(amount_msat, 1_000_000);
206206
assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
@@ -569,7 +569,7 @@ fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
569569
let events_5 = nodes[1].node.get_and_clear_pending_events();
570570
assert_eq!(events_5.len(), 1);
571571
match events_5[0] {
572-
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
572+
Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
573573
assert_eq!(payment_hash_2, *payment_hash);
574574
assert_eq!(amount_msat, 1_000_000);
575575
assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
@@ -686,7 +686,7 @@ fn test_monitor_update_fail_cs() {
686686
let events = nodes[1].node.get_and_clear_pending_events();
687687
assert_eq!(events.len(), 1);
688688
match events[0] {
689-
Event::PaymentReceived { payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
689+
Event::PaymentClaimable { payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
690690
assert_eq!(payment_hash, our_payment_hash);
691691
assert_eq!(amount_msat, 1_000_000);
692692
assert_eq!(receiver_node_id.unwrap(), nodes[1].node.get_our_node_id());
@@ -743,7 +743,7 @@ fn test_monitor_update_fail_no_rebroadcast() {
743743
let events = nodes[1].node.get_and_clear_pending_events();
744744
assert_eq!(events.len(), 1);
745745
match events[0] {
746-
Event::PaymentReceived { payment_hash, .. } => {
746+
Event::PaymentClaimable { payment_hash, .. } => {
747747
assert_eq!(payment_hash, our_payment_hash);
748748
},
749749
_ => panic!("Unexpected event"),
@@ -814,12 +814,12 @@ fn test_monitor_update_raa_while_paused() {
814814
nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
815815
check_added_monitors!(nodes[0], 1);
816816
expect_pending_htlcs_forwardable!(nodes[0]);
817-
expect_payment_received!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
817+
expect_payment_claimable!(nodes[0], our_payment_hash_2, our_payment_secret_2, 1000000);
818818

819819
nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
820820
check_added_monitors!(nodes[1], 1);
821821
expect_pending_htlcs_forwardable!(nodes[1]);
822-
expect_payment_received!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
822+
expect_payment_claimable!(nodes[1], our_payment_hash_1, our_payment_secret_1, 1000000);
823823

824824
claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
825825
claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_2);
@@ -1049,11 +1049,11 @@ fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
10491049
let events_6 = nodes[2].node.get_and_clear_pending_events();
10501050
assert_eq!(events_6.len(), 2);
10511051
match events_6[0] {
1052-
Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
1052+
Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
10531053
_ => panic!("Unexpected event"),
10541054
};
10551055
match events_6[1] {
1056-
Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
1056+
Event::PaymentClaimable { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_3); },
10571057
_ => panic!("Unexpected event"),
10581058
};
10591059

@@ -1072,7 +1072,7 @@ fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
10721072
let events_9 = nodes[0].node.get_and_clear_pending_events();
10731073
assert_eq!(events_9.len(), 1);
10741074
match events_9[0] {
1075-
Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
1075+
Event::PaymentClaimable { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
10761076
_ => panic!("Unexpected event"),
10771077
};
10781078
claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
@@ -1240,7 +1240,7 @@ fn raa_no_response_awaiting_raa_state() {
12401240
check_added_monitors!(nodes[1], 0);
12411241
let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
12421242
expect_pending_htlcs_forwardable!(nodes[1]);
1243-
expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1243+
expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
12441244

12451245
// We send a third payment here, which is somewhat of a redundant test, but the
12461246
// chanmon_fail_consistency test required it to actually find the bug (by seeing out-of-sync
@@ -1269,7 +1269,7 @@ fn raa_no_response_awaiting_raa_state() {
12691269
nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
12701270
check_added_monitors!(nodes[1], 1);
12711271
expect_pending_htlcs_forwardable!(nodes[1]);
1272-
expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1272+
expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
12731273
let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
12741274

12751275
nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
@@ -1282,7 +1282,7 @@ fn raa_no_response_awaiting_raa_state() {
12821282
nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
12831283
check_added_monitors!(nodes[1], 1);
12841284
expect_pending_htlcs_forwardable!(nodes[1]);
1285-
expect_payment_received!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
1285+
expect_payment_claimable!(nodes[1], payment_hash_3, payment_secret_3, 1000000);
12861286

12871287
claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
12881288
claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
@@ -1394,7 +1394,7 @@ fn claim_while_disconnected_monitor_update_fail() {
13941394
check_added_monitors!(nodes[1], 1);
13951395

13961396
expect_pending_htlcs_forwardable!(nodes[1]);
1397-
expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1397+
expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
13981398

13991399
nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
14001400
check_added_monitors!(nodes[0], 1);
@@ -1469,7 +1469,7 @@ fn monitor_failed_no_reestablish_response() {
14691469
check_added_monitors!(nodes[1], 1);
14701470

14711471
expect_pending_htlcs_forwardable!(nodes[1]);
1472-
expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1472+
expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
14731473

14741474
claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
14751475
}
@@ -1550,7 +1550,7 @@ fn first_message_on_recv_ordering() {
15501550
check_added_monitors!(nodes[1], 0);
15511551

15521552
expect_pending_htlcs_forwardable!(nodes[1]);
1553-
expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
1553+
expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 1000000);
15541554

15551555
let bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
15561556
nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_responses.0);
@@ -1563,7 +1563,7 @@ fn first_message_on_recv_ordering() {
15631563
check_added_monitors!(nodes[1], 1);
15641564

15651565
expect_pending_htlcs_forwardable!(nodes[1]);
1566-
expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1566+
expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
15671567

15681568
claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
15691569
claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
@@ -1652,7 +1652,7 @@ fn test_monitor_update_fail_claim() {
16521652
let events = nodes[0].node.get_and_clear_pending_events();
16531653
assert_eq!(events.len(), 2);
16541654
match events[0] {
1655-
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id } => {
1655+
Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id } => {
16561656
assert_eq!(payment_hash_2, *payment_hash);
16571657
assert_eq!(1_000_000, amount_msat);
16581658
assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
@@ -1669,7 +1669,7 @@ fn test_monitor_update_fail_claim() {
16691669
_ => panic!("Unexpected event"),
16701670
}
16711671
match events[1] {
1672-
Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
1672+
Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id, via_user_channel_id: _ } => {
16731673
assert_eq!(payment_hash_3, *payment_hash);
16741674
assert_eq!(1_000_000, amount_msat);
16751675
assert_eq!(receiver_node_id.unwrap(), nodes[0].node.get_our_node_id());
@@ -1750,7 +1750,7 @@ fn test_monitor_update_on_pending_forwards() {
17501750
_ => panic!("Unexpected event"),
17511751
};
17521752
nodes[0].node.process_pending_htlc_forwards();
1753-
expect_payment_received!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
1753+
expect_payment_claimable!(nodes[0], payment_hash_2, payment_secret_2, 1000000);
17541754

17551755
claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_2);
17561756
}
@@ -1799,7 +1799,7 @@ fn monitor_update_claim_fail_no_response() {
17991799
nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
18001800
check_added_monitors!(nodes[1], 1);
18011801
expect_pending_htlcs_forwardable!(nodes[1]);
1802-
expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
1802+
expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 1000000);
18031803

18041804
let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
18051805
nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
@@ -2073,7 +2073,7 @@ fn test_pending_update_fee_ack_on_reconnect() {
20732073
check_added_monitors!(nodes[1], 1);
20742074

20752075
expect_pending_htlcs_forwardable!(nodes[0]);
2076-
expect_payment_received!(nodes[0], payment_hash, payment_secret, 1_000_000);
2076+
expect_payment_claimable!(nodes[0], payment_hash, payment_secret, 1_000_000);
20772077

20782078
claim_payment(&nodes[1], &[&nodes[0]], payment_preimage);
20792079
}
@@ -2368,7 +2368,7 @@ fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
23682368
let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
23692369
nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
23702370
expect_pending_htlcs_forwardable!(nodes[1]);
2371-
expect_payment_received!(nodes[1], payment_hash_1, payment_secret_1, 100000);
2371+
expect_payment_claimable!(nodes[1], payment_hash_1, payment_secret_1, 100000);
23722372
check_added_monitors!(nodes[1], 1);
23732373

23742374
commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
@@ -2385,7 +2385,7 @@ fn do_channel_holding_cell_serialize(disconnect: bool, reload_a: bool) {
23852385
};
23862386

23872387
nodes[1].node.process_pending_htlc_forwards();
2388-
expect_payment_received!(nodes[1], payment_hash_2, payment_secret_2, 100000);
2388+
expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 100000);
23892389

23902390
claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
23912391
claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);

0 commit comments

Comments
 (0)