Merge pull request #2387 from vladimirfomene/add_extra_fields_to_ChannelClosed_event
[rust-lightning] / lightning / src / ln / payment_tests.rs
index 86f29d96034d631f7011c79461d9ccbefa9150e3..f93c287399eda2d2a99ca561f0d2032b47bcaded 100644 (file)
@@ -274,22 +274,31 @@ fn do_test_keysend_payments(public_node: bool, with_retry: bool) {
                nodes[0].logger, &scorer, &(), &random_seed_bytes
        ).unwrap();
 
-       let test_preimage = PaymentPreimage([42; 32]);
-       let payment_hash = if with_retry {
-               nodes[0].node.send_spontaneous_payment_with_retry(Some(test_preimage),
-                       RecipientOnionFields::spontaneous_empty(), PaymentId(test_preimage.0),
-                       route_params, Retry::Attempts(1)).unwrap()
-       } else {
-               nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage),
-                       RecipientOnionFields::spontaneous_empty(), PaymentId(test_preimage.0)).unwrap()
-       };
+       {
+               let test_preimage = PaymentPreimage([42; 32]);
+               if with_retry {
+                       nodes[0].node.send_spontaneous_payment_with_retry(Some(test_preimage),
+                               RecipientOnionFields::spontaneous_empty(), PaymentId(test_preimage.0),
+                               route_params, Retry::Attempts(1)).unwrap()
+               } else {
+                       nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage),
+                               RecipientOnionFields::spontaneous_empty(), PaymentId(test_preimage.0)).unwrap()
+               };
+       }
        check_added_monitors!(nodes[0], 1);
-       let mut events = nodes[0].node.get_and_clear_pending_msg_events();
-       assert_eq!(events.len(), 1);
-       let event = events.pop().unwrap();
-       let path = vec![&nodes[1]];
-       pass_along_path(&nodes[0], &path, 10000, payment_hash, None, event, true, Some(test_preimage));
-       claim_payment(&nodes[0], &path, test_preimage);
+       let send_event = SendEvent::from_node(&nodes[0]);
+       nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
+       do_commitment_signed_dance(&nodes[1], &nodes[0], &send_event.commitment_msg, false, false);
+       expect_pending_htlcs_forwardable!(nodes[1]);
+       // Previously, a refactor caused us to stop including the payment preimage in the onion which
+       // is sent as a part of keysend payments. Thus, to be extra careful here, we scope the preimage
+       // above to demonstrate that we have no way to get the preimage at this point except by
+       // extracting it from the onion nodes[1] received.
+       let event = nodes[1].node.get_and_clear_pending_events();
+       assert_eq!(event.len(), 1);
+       if let Event::PaymentClaimable { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. } = event[0] {
+               claim_payment(&nodes[0], &[&nodes[1]], preimage);
+       } else { panic!(); }
 }
 
 #[test]
@@ -561,7 +570,7 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
 
        // On reload, the ChannelManager should realize it is stale compared to the ChannelMonitor and
        // force-close the channel.
-       check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager);
+       check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager, [nodes[1].node.get_our_node_id()], 100000);
        assert!(nodes[0].node.list_channels().is_empty());
        assert!(nodes[0].node.has_pending_payments());
        nodes[0].node.timer_tick_occurred();
@@ -593,7 +602,8 @@ fn do_retry_with_no_persist(confirm_before_reload: bool) {
                MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
                        assert_eq!(node_id, nodes[1].node.get_our_node_id());
                        nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), msg);
-                       check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", &nodes[1].node.get_our_node_id())) });
+                       check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", 
+                               &nodes[1].node.get_our_node_id())) }, [nodes[0].node.get_our_node_id()], 100000);
                        check_added_monitors!(nodes[1], 1);
                        assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
                },
@@ -742,7 +752,7 @@ fn do_test_completed_payment_not_retryable_on_reload(use_dust: bool) {
 
        // On reload, the ChannelManager should realize it is stale compared to the ChannelMonitor and
        // force-close the channel.
-       check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager);
+       check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager, [nodes[1].node.get_our_node_id()], 100000);
        nodes[0].node.timer_tick_occurred();
        assert!(nodes[0].node.list_channels().is_empty());
        assert!(nodes[0].node.has_pending_payments());
@@ -768,7 +778,8 @@ fn do_test_completed_payment_not_retryable_on_reload(use_dust: bool) {
                MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
                        assert_eq!(node_id, nodes[1].node.get_our_node_id());
                        nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), msg);
-                       check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", &nodes[1].node.get_our_node_id())) });
+                       check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", &nodes[1].node.get_our_node_id())) }
+                               , [nodes[0].node.get_our_node_id()], 100000);
                        check_added_monitors!(nodes[1], 1);
                        bs_commitment_tx = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
                },
@@ -916,7 +927,7 @@ fn do_test_dup_htlc_onchain_fails_on_reload(persist_manager_post_event: bool, co
        nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
        check_closed_broadcast!(nodes[0], true);
        check_added_monitors!(nodes[0], 1);
-       check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
+       check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
 
        nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
        nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
@@ -937,7 +948,7 @@ fn do_test_dup_htlc_onchain_fails_on_reload(persist_manager_post_event: bool, co
        connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, vec![node_txn[1].clone()]));
        check_closed_broadcast!(nodes[1], true);
        check_added_monitors!(nodes[1], 1);
-       check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
+       check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
        let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
        assert_eq!(claim_txn.len(), 1);
        check_spends!(claim_txn[0], node_txn[1]);
@@ -3326,7 +3337,8 @@ fn do_claim_from_closed_chan(fail_payment: bool) {
                pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash, PaymentFailureReason::RecipientRejected);
        } else {
                nodes[1].node.force_close_broadcasting_latest_txn(&chan_bd, &nodes[3].node.get_our_node_id()).unwrap();
-               check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed, false);
+               check_closed_event!(&nodes[1], 1, ClosureReason::HolderForceClosed, false,
+                       [nodes[3].node.get_our_node_id()], 1000000);
                check_closed_broadcast(&nodes[1], 1, true);
                let bs_tx = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
                assert_eq!(bs_tx.len(), 1);
@@ -3334,7 +3346,8 @@ fn do_claim_from_closed_chan(fail_payment: bool) {
                mine_transaction(&nodes[3], &bs_tx[0]);
                check_added_monitors(&nodes[3], 1);
                check_closed_broadcast(&nodes[3], 1, true);
-               check_closed_event(&nodes[3], 1, ClosureReason::CommitmentTxConfirmed, false);
+               check_closed_event!(&nodes[3], 1, ClosureReason::CommitmentTxConfirmed, false,
+                       [nodes[1].node.get_our_node_id()], 1000000);
 
                nodes[3].node.claim_funds(payment_preimage);
                check_added_monitors(&nodes[3], 2);
@@ -3386,12 +3399,20 @@ fn claim_from_closed_chan() {
 }
 
 #[test]
-fn test_custom_tlvs() {
-       do_test_custom_tlvs(true);
-       do_test_custom_tlvs(false);
+fn test_custom_tlvs_basic() {
+       do_test_custom_tlvs(false, false, false);
+       do_test_custom_tlvs(true, false, false);
+}
+
+#[test]
+fn test_custom_tlvs_explicit_claim() {
+       // Test that when receiving even custom TLVs the user must explicitly accept in case they
+       // are unknown.
+       do_test_custom_tlvs(false, true, false);
+       do_test_custom_tlvs(false, true, true);
 }
 
-fn do_test_custom_tlvs(spontaneous: bool) {
+fn do_test_custom_tlvs(spontaneous: bool, even_tlvs: bool, known_tlvs: bool) {
        let chanmon_cfgs = create_chanmon_cfgs(2);
        let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
        let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None; 2]);
@@ -3403,7 +3424,7 @@ fn do_test_custom_tlvs(spontaneous: bool) {
        let (mut route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(&nodes[0], &nodes[1], amt_msat);
        let payment_id = PaymentId(our_payment_hash.0);
        let custom_tlvs = vec![
-               (5482373483, vec![1, 2, 3, 4]),
+               (if even_tlvs { 5482373482 } else { 5482373483 }, vec![1, 2, 3, 4]),
                (5482373487, vec![0x42u8; 16]),
        ];
        let onion_fields = RecipientOnionFields {
@@ -3446,7 +3467,22 @@ fn do_test_custom_tlvs(spontaneous: bool) {
                _ => panic!("Unexpected event"),
        }
 
-       claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
+       match (known_tlvs, even_tlvs) {
+               (true, _) => {
+                       nodes[1].node.claim_funds_with_known_custom_tlvs(our_payment_preimage);
+                       let expected_total_fee_msat = pass_claimed_payment_along_route(&nodes[0], &[&[&nodes[1]]], &[0; 1], false, our_payment_preimage);
+                       expect_payment_sent!(&nodes[0], our_payment_preimage, Some(expected_total_fee_msat));
+               },
+               (false, false) => {
+                       claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
+               },
+               (false, true) => {
+                       nodes[1].node.claim_funds(our_payment_preimage);
+                       let expected_destinations = vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }];
+                       expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], expected_destinations);
+                       pass_failed_payment_back(&nodes[0], &[&[&nodes[1]]], false, our_payment_hash, PaymentFailureReason::RecipientRejected);
+               }
+       }
 }
 
 #[test]
@@ -3549,6 +3585,167 @@ fn test_retry_custom_tlvs() {
        claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
 }
 
+#[test]
+fn test_custom_tlvs_consistency() {
+       let even_type_1 = 1 << 16;
+       let odd_type_1  = (1 << 16)+ 1;
+       let even_type_2 = (1 << 16) + 2;
+       let odd_type_2  = (1 << 16) + 3;
+       let value_1 = || vec![1, 2, 3, 4];
+       let differing_value_1 = || vec![1, 2, 3, 5];
+       let value_2 = || vec![42u8; 16];
+
+       // Drop missing odd tlvs
+       do_test_custom_tlvs_consistency(
+               vec![(odd_type_1, value_1()), (odd_type_2, value_2())],
+               vec![(odd_type_1, value_1())],
+               Some(vec![(odd_type_1, value_1())]),
+       );
+       // Drop non-matching odd tlvs
+       do_test_custom_tlvs_consistency(
+               vec![(odd_type_1, value_1()), (odd_type_2, value_2())],
+               vec![(odd_type_1, differing_value_1()), (odd_type_2, value_2())],
+               Some(vec![(odd_type_2, value_2())]),
+       );
+       // Fail missing even tlvs
+       do_test_custom_tlvs_consistency(
+               vec![(odd_type_1, value_1()), (even_type_2, value_2())],
+               vec![(odd_type_1, value_1())],
+               None,
+       );
+       // Fail non-matching even tlvs
+       do_test_custom_tlvs_consistency(
+               vec![(even_type_1, value_1()), (odd_type_2, value_2())],
+               vec![(even_type_1, differing_value_1()), (odd_type_2, value_2())],
+               None,
+       );
+}
+
+fn do_test_custom_tlvs_consistency(first_tlvs: Vec<(u64, Vec<u8>)>, second_tlvs: Vec<(u64, Vec<u8>)>,
+       expected_receive_tlvs: Option<Vec<(u64, Vec<u8>)>>) {
+
+       let chanmon_cfgs = create_chanmon_cfgs(4);
+       let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
+       let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
+       let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
+
+       create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
+       create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100_000, 0);
+       create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 100_000, 0);
+       let chan_2_3 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 100_000, 0);
+
+       let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
+               .with_bolt11_features(nodes[3].node.invoice_features()).unwrap();
+       let mut route = get_route!(nodes[0], payment_params, 15_000_000).unwrap();
+       assert_eq!(route.paths.len(), 2);
+       route.paths.sort_by(|path_a, _| {
+               // Sort the path so that the path through nodes[1] comes first
+               if path_a.hops[0].pubkey == nodes[1].node.get_our_node_id() {
+                       core::cmp::Ordering::Less } else { core::cmp::Ordering::Greater }
+       });
+
+       let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(&nodes[3]);
+       let payment_id = PaymentId([42; 32]);
+       let amt_msat = 15_000_000;
+
+       // Send first part
+       let onion_fields = RecipientOnionFields {
+               payment_secret: Some(our_payment_secret),
+               payment_metadata: None,
+               custom_tlvs: first_tlvs
+       };
+       let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
+                       onion_fields.clone(), payment_id, &route).unwrap();
+       let cur_height = nodes[0].best_block_info().1;
+       nodes[0].node.test_send_payment_along_path(&route.paths[0], &our_payment_hash,
+               onion_fields.clone(), amt_msat, cur_height, payment_id,
+               &None, session_privs[0]).unwrap();
+       check_added_monitors!(nodes[0], 1);
+
+       {
+               let mut events = nodes[0].node.get_and_clear_pending_msg_events();
+               assert_eq!(events.len(), 1);
+               pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], amt_msat, our_payment_hash, Some(our_payment_secret), events.pop().unwrap(), false, None);
+       }
+       assert!(nodes[3].node.get_and_clear_pending_events().is_empty());
+
+       // Send second part
+       let onion_fields = RecipientOnionFields {
+               payment_secret: Some(our_payment_secret),
+               payment_metadata: None,
+               custom_tlvs: second_tlvs
+       };
+       nodes[0].node.test_send_payment_along_path(&route.paths[1], &our_payment_hash,
+               onion_fields.clone(), amt_msat, cur_height, payment_id, &None, session_privs[1]).unwrap();
+       check_added_monitors!(nodes[0], 1);
+
+       {
+               let mut events = nodes[0].node.get_and_clear_pending_msg_events();
+               assert_eq!(events.len(), 1);
+               let payment_event = SendEvent::from_event(events.pop().unwrap());
+
+               nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
+               commitment_signed_dance!(nodes[2], nodes[0], payment_event.commitment_msg, false);
+
+               expect_pending_htlcs_forwardable!(nodes[2]);
+               check_added_monitors!(nodes[2], 1);
+
+               let mut events = nodes[2].node.get_and_clear_pending_msg_events();
+               assert_eq!(events.len(), 1);
+               let payment_event = SendEvent::from_event(events.pop().unwrap());
+
+               nodes[3].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
+               check_added_monitors!(nodes[3], 0);
+               commitment_signed_dance!(nodes[3], nodes[2], payment_event.commitment_msg, true, true);
+       }
+       expect_pending_htlcs_forwardable_ignore!(nodes[3]);
+       nodes[3].node.process_pending_htlc_forwards();
+
+       if let Some(expected_tlvs) = expected_receive_tlvs {
+               // Claim and match expected
+               let events = nodes[3].node.get_and_clear_pending_events();
+               println!("events: {:?}", events);
+               assert_eq!(events.len(), 1);
+               match events[0] {
+                       Event::PaymentClaimable { ref purpose, amount_msat, ref onion_fields, .. } => {
+                               match &purpose {
+                                       PaymentPurpose::InvoicePayment { payment_secret, .. } => {
+                                               assert_eq!(our_payment_secret, *payment_secret);
+                                               assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
+                                       },
+                                       PaymentPurpose::SpontaneousPayment(payment_preimage) => {
+                                               assert_eq!(our_payment_preimage, *payment_preimage);
+                                       },
+                               }
+                               assert_eq!(amount_msat, amt_msat);
+                               assert_eq!(onion_fields.clone().unwrap().custom_tlvs, expected_tlvs);
+                       },
+                       _ => panic!("Unexpected event"),
+               }
+
+               do_claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, our_payment_preimage);
+               expect_payment_sent(&nodes[0], our_payment_preimage, Some(Some(2000)), true);
+       } else {
+               // Expect fail back
+               let expected_destinations = vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }];
+               expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], expected_destinations);
+               check_added_monitors!(nodes[3], 1);
+
+               let fail_updates_1 = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
+               nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
+               commitment_signed_dance!(nodes[2], nodes[3], fail_updates_1.commitment_signed, false);
+
+               expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_2_3.2 }]);
+               check_added_monitors!(nodes[2], 1);
+
+               let fail_updates_2 = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
+               nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_updates_2.update_fail_htlcs[0]);
+               commitment_signed_dance!(nodes[0], nodes[2], fail_updates_2.commitment_signed, false);
+
+               expect_payment_failed_conditions(&nodes[0], our_payment_hash, true, PaymentFailedConditions::new().mpp_parts_remain());
+       }
+}
+
 fn do_test_payment_metadata_consistency(do_reload: bool, do_modify: bool) {
        // Check that a payment metadata received on one HTLC that doesn't match the one received on
        // another results in the HTLC being rejected.