_ Git - rust-lightning/blob - lightning/src/ln/blinded_payment_tests.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
  11 use crate::blinded_path::BlindedPath;
  12 use crate::blinded_path::payment::{ForwardNode, ForwardTlvs, PaymentConstraints, PaymentRelay, ReceiveTlvs};
  13 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PaymentFailureReason};
  14 use crate::ln::PaymentSecret;
  15 use crate::ln::channelmanager;
  16 use crate::ln::channelmanager::{PaymentId, RecipientOnionFields};
  17 use crate::ln::features::BlindedHopFeatures;
  18 use crate::ln::functional_test_utils::*;
  19 use crate::ln::msgs;
  20 use crate::ln::msgs::ChannelMessageHandler;
  21 use crate::ln::onion_utils;
  22 use crate::ln::onion_utils::INVALID_ONION_BLINDING;
  23 use crate::ln::outbound_payment::Retry;
  24 use crate::offers::invoice::BlindedPayInfo;
  25 use crate::prelude::*;
  26 use crate::routing::router::{Payee, PaymentParameters, RouteParameters};
  27 use crate::util::config::UserConfig;
  28 use crate::util::test_utils;
  29
  30 fn blinded_payment_path(
  31         payment_secret: PaymentSecret, node_ids: Vec<PublicKey>,
  32         channel_upds: &[&msgs::UnsignedChannelUpdate], keys_manager: &test_utils::TestKeysInterface
  33 ) -> (BlindedPayInfo, BlindedPath) {
  34         let mut intermediate_nodes = Vec::new();
  35         for (node_id, chan_upd) in node_ids.iter().zip(channel_upds) {
  36                 intermediate_nodes.push(ForwardNode {
  37                         node_id: *node_id,
  38                         tlvs: ForwardTlvs {
  39                                 short_channel_id: chan_upd.short_channel_id,
  40                                 payment_relay: PaymentRelay {
  41                                         cltv_expiry_delta: chan_upd.cltv_expiry_delta,
  42                                         fee_proportional_millionths: chan_upd.fee_proportional_millionths,
  43                                         fee_base_msat: chan_upd.fee_base_msat,
  44                                 },
  45                                 payment_constraints: PaymentConstraints {
  46                                         max_cltv_expiry: u32::max_value(),
  47                                         htlc_minimum_msat: chan_upd.htlc_minimum_msat,
  48                                 },
  49                                 features: BlindedHopFeatures::empty(),
  50                         },
  51                         htlc_maximum_msat: chan_upd.htlc_maximum_msat,
  52                 });
  53         }
  54         let payee_tlvs = ReceiveTlvs {
  55                 payment_secret,
  56                 payment_constraints: PaymentConstraints {
  57                         max_cltv_expiry: u32::max_value(),
  58                         htlc_minimum_msat: channel_upds.last().unwrap().htlc_minimum_msat,
  59                 },
  60         };
  61         let mut secp_ctx = Secp256k1::new();
  62         BlindedPath::new_for_payment(
  63                 &intermediate_nodes[..], *node_ids.last().unwrap(), payee_tlvs,
  64                 channel_upds.last().unwrap().htlc_maximum_msat, TEST_FINAL_CLTV as u16, keys_manager, &secp_ctx
  65         ).unwrap()
  66 }
  67
  68 pub fn get_blinded_route_parameters(
  69         amt_msat: u64, payment_secret: PaymentSecret, node_ids: Vec<PublicKey>,
  70         channel_upds: &[&msgs::UnsignedChannelUpdate], keys_manager: &test_utils::TestKeysInterface
  71 ) -> RouteParameters {
  72         RouteParameters::from_payment_params_and_value(
  73                 PaymentParameters::blinded(vec![
  74                         blinded_payment_path(payment_secret, node_ids, channel_upds, keys_manager)
  75                 ]), amt_msat
  76         )
  77 }
  78
  79 #[test]
  80 fn one_hop_blinded_path() {
  81         do_one_hop_blinded_path(true);
  82         do_one_hop_blinded_path(false);
  83 }
  84
  85 fn do_one_hop_blinded_path(success: bool) {
  86         let chanmon_cfgs = create_chanmon_cfgs(2);
  87         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  88         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  89         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  90         let chan_upd = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0).0.contents;
  91
  92         let amt_msat = 5000;
  93         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[1], Some(amt_msat), None);
  94         let payee_tlvs = ReceiveTlvs {
  95                 payment_secret,
  96                 payment_constraints: PaymentConstraints {
  97                         max_cltv_expiry: u32::max_value(),
  98                         htlc_minimum_msat: chan_upd.htlc_minimum_msat,
  99                 },
 100         };
 101         let mut secp_ctx = Secp256k1::new();
 102         let blinded_path = BlindedPath::one_hop_for_payment(
 103                 nodes[1].node.get_our_node_id(), payee_tlvs, TEST_FINAL_CLTV as u16,
 104                 &chanmon_cfgs[1].keys_manager, &secp_ctx
 105         ).unwrap();
 106
 107         let route_params = RouteParameters::from_payment_params_and_value(
 108                 PaymentParameters::blinded(vec![blinded_path]),
 109                 amt_msat,
 110         );
 111         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(),
 112         PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 113         check_added_monitors(&nodes[0], 1);
 114         pass_along_route(&nodes[0], &[&[&nodes[1]]], amt_msat, payment_hash, payment_secret);
 115         if success {
 116                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
 117         } else {
 118                 fail_payment(&nodes[0], &[&nodes[1]], payment_hash);
 119         }
 120 }
 121
 122 #[test]
 123 fn mpp_to_one_hop_blinded_path() {
 124         let chanmon_cfgs = create_chanmon_cfgs(4);
 125         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 126         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 127         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 128         let mut secp_ctx = Secp256k1::new();
 129
 130         create_announced_chan_between_nodes(&nodes, 0, 1);
 131         create_announced_chan_between_nodes(&nodes, 0, 2);
 132         let chan_upd_1_3 = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents;
 133         create_announced_chan_between_nodes(&nodes, 2, 3).0.contents;
 134
 135         let amt_msat = 15_000_000;
 136         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[3], Some(amt_msat), None);
 137         let payee_tlvs = ReceiveTlvs {
 138                 payment_secret,
 139                 payment_constraints: PaymentConstraints {
 140                         max_cltv_expiry: u32::max_value(),
 141                         htlc_minimum_msat: chan_upd_1_3.htlc_minimum_msat,
 142                 },
 143         };
 144         let blinded_path = BlindedPath::one_hop_for_payment(
 145                 nodes[3].node.get_our_node_id(), payee_tlvs, TEST_FINAL_CLTV as u16,
 146                 &chanmon_cfgs[3].keys_manager, &secp_ctx
 147         ).unwrap();
 148
 149         let bolt12_features =
 150                 channelmanager::provided_bolt12_invoice_features(&UserConfig::default());
 151         let route_params = RouteParameters::from_payment_params_and_value(
 152                 PaymentParameters::blinded(vec![blinded_path]).with_bolt12_features(bolt12_features).unwrap(),
 153                 amt_msat,
 154         );
 155         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 156         check_added_monitors(&nodes[0], 2);
 157
 158         let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]];
 159         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 160         assert_eq!(events.len(), 2);
 161
 162         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 163         pass_along_path(&nodes[0], expected_route[0], amt_msat, payment_hash.clone(),
 164                 Some(payment_secret), ev.clone(), false, None);
 165
 166         let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
 167         pass_along_path(&nodes[0], expected_route[1], amt_msat, payment_hash.clone(),
 168                 Some(payment_secret), ev.clone(), true, None);
 169         claim_payment_along_route(&nodes[0], expected_route, false, payment_preimage);
 170 }
 171
 172 #[test]
 173 fn mpp_to_three_hop_blinded_paths() {
 174         let chanmon_cfgs = create_chanmon_cfgs(6);
 175         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
 176         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
 177         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
 178
 179         // Create this network topology so node 0 MPP's over 2 3-hop blinded paths:
 180         //     n1 -- n3
 181         //    /        \
 182         // n0           n5
 183         //    \        /
 184         //     n2 -- n4
 185         create_announced_chan_between_nodes(&nodes, 0, 1);
 186         create_announced_chan_between_nodes(&nodes, 0, 2);
 187         let chan_upd_1_3 = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents;
 188         let chan_upd_2_4 = create_announced_chan_between_nodes(&nodes, 2, 4).0.contents;
 189         let chan_upd_3_5 = create_announced_chan_between_nodes(&nodes, 3, 5).0.contents;
 190         let chan_upd_4_5 = create_announced_chan_between_nodes(&nodes, 4, 5).0.contents;
 191
 192         let amt_msat = 15_000_000;
 193         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[5], Some(amt_msat), None);
 194         let route_params = {
 195                 let path_1_params = get_blinded_route_parameters(
 196                         amt_msat, payment_secret, vec![
 197                                 nodes[1].node.get_our_node_id(), nodes[3].node.get_our_node_id(),
 198                                 nodes[5].node.get_our_node_id()
 199                         ], &[&chan_upd_1_3, &chan_upd_3_5], &chanmon_cfgs[5].keys_manager
 200                 );
 201                 let path_2_params = get_blinded_route_parameters(
 202                         amt_msat, payment_secret, vec![
 203                                 nodes[2].node.get_our_node_id(), nodes[4].node.get_our_node_id(),
 204                                 nodes[5].node.get_our_node_id()
 205                         ], &[&chan_upd_2_4, &chan_upd_4_5], &chanmon_cfgs[5].keys_manager
 206                 );
 207                 let pay_params = PaymentParameters::blinded(
 208                         vec![
 209                                 path_1_params.payment_params.payee.blinded_route_hints()[0].clone(),
 210                                 path_2_params.payment_params.payee.blinded_route_hints()[0].clone()
 211                         ]
 212                 )
 213                         .with_bolt12_features(channelmanager::provided_bolt12_invoice_features(&UserConfig::default()))
 214                         .unwrap();
 215                 RouteParameters::from_payment_params_and_value(pay_params, amt_msat)
 216         };
 217
 218         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(),
 219                 PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 220         check_added_monitors(&nodes[0], 2);
 221
 222         let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[3], &nodes[5]], &[&nodes[2], &nodes[4], &nodes[5]]];
 223         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 224         assert_eq!(events.len(), 2);
 225
 226         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 227         pass_along_path(&nodes[0], expected_route[0], amt_msat, payment_hash.clone(),
 228                 Some(payment_secret), ev.clone(), false, None);
 229
 230         let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
 231         pass_along_path(&nodes[0], expected_route[1], amt_msat, payment_hash.clone(),
 232                 Some(payment_secret), ev.clone(), true, None);
 233         claim_payment_along_route(&nodes[0], expected_route, false, payment_preimage);
 234 }
 235
 236 enum ForwardCheckFail {
 237         // Fail a check on the inbound onion payload. In this case, we underflow when calculating the
 238         // outgoing cltv_expiry.
 239         InboundOnionCheck,
 240         // The forwarding node's payload is encoded as a receive, i.e. the next hop HMAC is [0; 32].
 241         ForwardPayloadEncodedAsReceive,
 242         // Fail a check on the outbound channel. In this case, our next-hop peer is offline.
 243         OutboundChannelCheck,
 244 }
 245
 246 #[test]
 247 fn forward_checks_failure() {
 248         do_forward_checks_failure(ForwardCheckFail::InboundOnionCheck);
 249         do_forward_checks_failure(ForwardCheckFail::ForwardPayloadEncodedAsReceive);
 250         do_forward_checks_failure(ForwardCheckFail::OutboundChannelCheck);
 251 }
 252
 253 fn do_forward_checks_failure(check: ForwardCheckFail) {
 254         // Ensure we'll fail backwards properly if a forwarding check fails on initial update_add
 255         // receipt.
 256         let chanmon_cfgs = create_chanmon_cfgs(3);
 257         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 258         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 259         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 260         // We need the session priv to construct a bogus onion packet later.
 261         *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
 262         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 263         let chan_upd_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0).0.contents;
 264
 265         let amt_msat = 5000;
 266         let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
 267         let route_params = get_blinded_route_parameters(amt_msat, payment_secret,
 268                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2],
 269                 &chanmon_cfgs[2].keys_manager);
 270
 271         let route = get_route(&nodes[0], &route_params).unwrap();
 272         node_cfgs[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
 273         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 274         check_added_monitors(&nodes[0], 1);
 275
 276         macro_rules! cause_error {
 277                 ($src_node_idx: expr, $target_node_idx: expr, $update_add: expr) => {
 278                         match check {
 279                                 ForwardCheckFail::InboundOnionCheck => {
 280                                         $update_add.cltv_expiry = 10; // causes outbound CLTV expiry to underflow
 281                                 },
 282                                 ForwardCheckFail::ForwardPayloadEncodedAsReceive => {
 283                                         let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 284                                         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 285                                         let cur_height = nodes[0].best_block_info().1;
 286                                         let (mut onion_payloads, ..) = onion_utils::build_onion_payloads(
 287                                                 &route.paths[0], amt_msat, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
 288                                         // Remove the receive payload so the blinded forward payload is encoded as a final payload
 289                                         // (i.e. next_hop_hmac == [0; 32])
 290                                         onion_payloads.pop();
 291                                         if $target_node_idx + 1 < nodes.len() {
 292                                                 onion_payloads.pop();
 293                                         }
 294                                         $update_add.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
 295                                 },
 296                                 ForwardCheckFail::OutboundChannelCheck => {
 297                                         // The intro node will see that the next-hop peer is disconnected and fail the HTLC backwards.
 298                                         nodes[$src_node_idx].node.peer_disconnected(&nodes[$target_node_idx].node.get_our_node_id());
 299                                 }
 300                         }
 301                 }
 302         }
 303
 304         let mut updates_0_1 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 305         let update_add = &mut updates_0_1.update_add_htlcs[0];
 306
 307         cause_error!(1, 2, update_add);
 308
 309         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
 310         check_added_monitors!(nodes[1], 0);
 311         do_commitment_signed_dance(&nodes[1], &nodes[0], &updates_0_1.commitment_signed, true, true);
 312
 313         let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 314         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
 315         do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
 316         expect_payment_failed_conditions(&nodes[0], payment_hash, false,
 317                 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
 318 }
 319
 320 #[test]
 321 fn failed_backwards_to_intro_node() {
 322         // Ensure the intro node will error backwards properly even if the downstream node did not blind
 323         // their error.
 324         let chanmon_cfgs = create_chanmon_cfgs(3);
 325         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 326         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 327         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 328         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 329         let chan_upd_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0).0.contents;
 330
 331         let amt_msat = 5000;
 332         let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
 333         let route_params = get_blinded_route_parameters(amt_msat, payment_secret,
 334                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2],
 335                 &chanmon_cfgs[2].keys_manager);
 336
 337         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 338         check_added_monitors(&nodes[0], 1);
 339
 340         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 341         assert_eq!(events.len(), 1);
 342         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 343         let mut payment_event = SendEvent::from_event(ev);
 344
 345         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 346         check_added_monitors!(nodes[1], 0);
 347         do_commitment_signed_dance(&nodes[1], &nodes[0], &payment_event.commitment_msg, false, false);
 348         expect_pending_htlcs_forwardable!(nodes[1]);
 349         check_added_monitors!(&nodes[1], 1);
 350
 351         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
 352         assert_eq!(events.len(), 1);
 353         let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
 354         let mut payment_event = SendEvent::from_event(ev);
 355
 356         // Ensure the final node fails to handle the HTLC.
 357         payment_event.msgs[0].onion_routing_packet.hop_data[0] ^= 1;
 358         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 359         check_added_monitors!(nodes[2], 0);
 360         do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event.commitment_msg, true, true);
 361         nodes[2].node.process_pending_htlc_forwards();
 362
 363         let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 364         let mut update_malformed = &mut updates.update_fail_malformed_htlcs[0];
 365         // Check that the final node encodes its failure correctly.
 366         assert_eq!(update_malformed.failure_code, INVALID_ONION_BLINDING);
 367         assert_eq!(update_malformed.sha256_of_onion, [0; 32]);
 368
 369         // Modify such the final hop does not correctly blind their error so we can ensure the intro node
 370         // converts it to the correct error.
 371         update_malformed.sha256_of_onion = [1; 32];
 372         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), update_malformed);
 373         do_commitment_signed_dance(&nodes[1], &nodes[2], &updates.commitment_signed, true, false);
 374
 375         let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 376         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
 377         do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
 378         expect_payment_failed_conditions(&nodes[0], payment_hash, false,
 379                 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
 380 }
 381
 382 enum ProcessPendingHTLCsCheck {
 383         FwdPeerDisconnected,
 384         FwdChannelClosed,
 385 }
 386
 387 #[test]
 388 fn forward_fail_in_process_pending_htlc_fwds() {
 389         do_forward_fail_in_process_pending_htlc_fwds(ProcessPendingHTLCsCheck::FwdPeerDisconnected);
 390         do_forward_fail_in_process_pending_htlc_fwds(ProcessPendingHTLCsCheck::FwdChannelClosed);
 391 }
 392 fn do_forward_fail_in_process_pending_htlc_fwds(check: ProcessPendingHTLCsCheck) {
 393         // Ensure the intro node will error backwards properly if the HTLC fails in
 394         // process_pending_htlc_forwards.
 395         let chanmon_cfgs = create_chanmon_cfgs(3);
 396         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 397         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 398         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 399         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 400         let (chan_upd_1_2, channel_id) = {
 401                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0);
 402                 (chan.0.contents, chan.2)
 403         };
 404
 405         let amt_msat = 5000;
 406         let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
 407         let route_params = get_blinded_route_parameters(amt_msat, payment_secret,
 408                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2],
 409                 &chanmon_cfgs[2].keys_manager);
 410
 411         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 412         check_added_monitors(&nodes[0], 1);
 413
 414         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 415         assert_eq!(events.len(), 1);
 416         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 417         let mut payment_event = SendEvent::from_event(ev);
 418
 419         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 420         check_added_monitors!(nodes[1], 0);
 421         do_commitment_signed_dance(&nodes[1], &nodes[0], &payment_event.commitment_msg, false, false);
 422
 423         match check {
 424                 ProcessPendingHTLCsCheck::FwdPeerDisconnected => {
 425                         // Disconnect the next-hop peer so when we go to forward in process_pending_htlc_forwards, the
 426                         // intro node will error backwards.
 427                         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
 428                         expect_pending_htlcs_forwardable!(nodes[1]);
 429                         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1],
 430                                 vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id }]);
 431                 },
 432                 ProcessPendingHTLCsCheck::FwdChannelClosed => {
 433                         // Force close the next-hop channel so when we go to forward in process_pending_htlc_forwards,
 434                         // the intro node will error backwards.
 435                         nodes[1].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[2].node.get_our_node_id()).unwrap();
 436                         let events = nodes[1].node.get_and_clear_pending_events();
 437                         match events[0] {
 438                                 crate::events::Event::PendingHTLCsForwardable { .. } => {},
 439                                 _ => panic!("Unexpected event {:?}", events),
 440                         };
 441                         match events[1] {
 442                                 crate::events::Event::ChannelClosed { .. } => {},
 443                                 _ => panic!("Unexpected event {:?}", events),
 444                         }
 445
 446                         nodes[1].node.process_pending_htlc_forwards();
 447                         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1],
 448                                 vec![HTLCDestination::UnknownNextHop { requested_forward_scid: chan_upd_1_2.short_channel_id }]);
 449                         check_closed_broadcast(&nodes[1], 1, true);
 450                         check_added_monitors!(nodes[1], 1);
 451                         nodes[1].node.process_pending_htlc_forwards();
 452                 },
 453         }
 454
 455         let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 456         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
 457         check_added_monitors!(nodes[1], 1);
 458         do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
 459
 460         expect_payment_failed_conditions(&nodes[0], payment_hash, false,
 461                 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
 462 }
 463
 464 #[test]
 465 fn blinded_intercept_payment() {
 466         do_blinded_intercept_payment(true);
 467         do_blinded_intercept_payment(false);
 468 }
 469 fn do_blinded_intercept_payment(intercept_node_fails: bool) {
 470         let chanmon_cfgs = create_chanmon_cfgs(3);
 471         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 472         let mut intercept_forwards_config = test_default_channel_config();
 473         intercept_forwards_config.accept_intercept_htlcs = true;
 474         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(intercept_forwards_config), None]);
 475         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 476         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 477         let (channel_id, chan_upd) = {
 478                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0);
 479                 (chan.2, chan.0.contents)
 480         };
 481
 482         let amt_msat = 5000;
 483         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
 484         let intercept_scid = nodes[1].node.get_intercept_scid();
 485         let mut intercept_chan_upd = chan_upd;
 486         intercept_chan_upd.short_channel_id = intercept_scid;
 487         let route_params = get_blinded_route_parameters(amt_msat, payment_secret,
 488                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&intercept_chan_upd],
 489                 &chanmon_cfgs[2].keys_manager);
 490
 491         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(),
 492         PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 493         check_added_monitors(&nodes[0], 1);
 494         let payment_event = {
 495                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 496                 assert_eq!(events.len(), 1);
 497                 SendEvent::from_event(events.remove(0))
 498         };
 499         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 500         commitment_signed_dance!(nodes[1], nodes[0], &payment_event.commitment_msg, false, true);
 501
 502         let events = nodes[1].node.get_and_clear_pending_events();
 503         assert_eq!(events.len(), 1);
 504         let (intercept_id, expected_outbound_amount_msat) = match events[0] {
 505                 crate::events::Event::HTLCIntercepted {
 506                         intercept_id, payment_hash: pmt_hash,
 507                         requested_next_hop_scid: short_channel_id, expected_outbound_amount_msat, ..
 508                 } => {
 509                         assert_eq!(pmt_hash, payment_hash);
 510                         assert_eq!(short_channel_id, intercept_scid);
 511                         (intercept_id, expected_outbound_amount_msat)
 512                 },
 513                 _ => panic!()
 514         };
 515
 516         if intercept_node_fails {
 517                 nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap();
 518                 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::UnknownNextHop { requested_forward_scid: intercept_scid }]);
 519                 nodes[1].node.process_pending_htlc_forwards();
 520                 let update_fail = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 521                 check_added_monitors!(&nodes[1], 1);
 522                 assert!(update_fail.update_fail_htlcs.len() == 1);
 523                 let fail_msg = update_fail.update_fail_htlcs[0].clone();
 524                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
 525                 commitment_signed_dance!(nodes[0], nodes[1], update_fail.commitment_signed, false);
 526                 expect_payment_failed_conditions(&nodes[0], payment_hash, false,
 527                         PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
 528                 return
 529         }
 530
 531         nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap();
 532         expect_pending_htlcs_forwardable!(nodes[1]);
 533
 534         let payment_event = {
 535                 {
 536                         let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 537                         assert_eq!(added_monitors.len(), 1);
 538                         added_monitors.clear();
 539                 }
 540                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
 541                 assert_eq!(events.len(), 1);
 542                 SendEvent::from_event(events.remove(0))
 543         };
 544         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 545         commitment_signed_dance!(nodes[2], nodes[1], &payment_event.commitment_msg, false, true);
 546         expect_pending_htlcs_forwardable!(nodes[2]);
 547
 548         expect_payment_claimable!(&nodes[2], payment_hash, payment_secret, amt_msat, None, nodes[2].node.get_our_node_id());
 549         do_claim_payment_along_route(&nodes[0], &vec!(&vec!(&nodes[1], &nodes[2])[..]), false, payment_preimage);
 550         expect_payment_sent(&nodes[0], payment_preimage, Some(Some(1000)), true, true);
 551 }
 552
 553 #[test]
 554 fn two_hop_blinded_path_success() {
 555         let chanmon_cfgs = create_chanmon_cfgs(3);
 556         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 557         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 558         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 559         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 560         let chan_upd_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0).0.contents;
 561
 562         let amt_msat = 5000;
 563         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
 564         let route_params = get_blinded_route_parameters(amt_msat, payment_secret,
 565                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2],
 566                 &chanmon_cfgs[2].keys_manager);
 567
 568         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 569         check_added_monitors(&nodes[0], 1);
 570         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], amt_msat, payment_hash, payment_secret);
 571         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
 572 }
 573
 574 #[test]
 575 fn three_hop_blinded_path_success() {
 576         let chanmon_cfgs = create_chanmon_cfgs(5);
 577         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
 578         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
 579         let mut nodes = create_network(5, &node_cfgs, &node_chanmgrs);
 580         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 581         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0);
 582         let chan_upd_2_3 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0).0.contents;
 583         let chan_upd_3_4 = create_announced_chan_between_nodes_with_value(&nodes, 3, 4, 1_000_000, 0).0.contents;
 584
 585         // Get all our nodes onto the same height so payments don't fail for CLTV violations.
 586         connect_blocks(&nodes[0], nodes[4].best_block_info().1 - nodes[0].best_block_info().1);
 587         connect_blocks(&nodes[1], nodes[4].best_block_info().1 - nodes[1].best_block_info().1);
 588         connect_blocks(&nodes[2], nodes[4].best_block_info().1 - nodes[2].best_block_info().1);
 589         assert_eq!(nodes[4].best_block_info().1, nodes[3].best_block_info().1);
 590
 591         let amt_msat = 5000;
 592         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[4], Some(amt_msat), None);
 593         let route_params = get_blinded_route_parameters(amt_msat, payment_secret,
 594                 nodes.iter().skip(2).map(|n| n.node.get_our_node_id()).collect(),
 595                 &[&chan_upd_2_3, &chan_upd_3_4], &chanmon_cfgs[4].keys_manager);
 596
 597         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 598         check_added_monitors(&nodes[0], 1);
 599         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2], &nodes[3], &nodes[4]]], amt_msat, payment_hash, payment_secret);
 600         claim_payment(&nodes[0], &[&nodes[1], &nodes[2], &nodes[3], &nodes[4]], payment_preimage);
 601 }
 602
 603 #[derive(PartialEq)]
 604 enum ReceiveCheckFail {
 605         // The recipient fails the payment upon `PaymentClaimable`.
 606         RecipientFail,
 607         // Failure to decode the recipient's onion payload.
 608         OnionDecodeFail,
 609         // The incoming HTLC did not satisfy our requirements; in this case it underpaid us according to
 610         // the expected receive amount in the onion.
 611         ReceiveRequirements,
 612         // The incoming HTLC errors when added to the Channel, in this case due to the HTLC being
 613         // delivered out-of-order with a shutdown message.
 614         ChannelCheck,
 615         // The HTLC is successfully added to the inbound channel but fails receive checks in
 616         // process_pending_htlc_forwards.
 617         ProcessPendingHTLCsCheck,
 618         // The HTLC violates the `PaymentConstraints` contained within the receiver's encrypted payload.
 619         PaymentConstraints,
 620 }
 621
 622 #[test]
 623 fn multi_hop_receiver_fail() {
 624         do_multi_hop_receiver_fail(ReceiveCheckFail::RecipientFail);
 625         do_multi_hop_receiver_fail(ReceiveCheckFail::OnionDecodeFail);
 626         do_multi_hop_receiver_fail(ReceiveCheckFail::ReceiveRequirements);
 627         do_multi_hop_receiver_fail(ReceiveCheckFail::ChannelCheck);
 628         do_multi_hop_receiver_fail(ReceiveCheckFail::ProcessPendingHTLCsCheck);
 629         do_multi_hop_receiver_fail(ReceiveCheckFail::PaymentConstraints);
 630 }
 631
 632 fn do_multi_hop_receiver_fail(check: ReceiveCheckFail) {
 633         // Test that the receiver to a multihop blinded path fails back correctly.
 634         let chanmon_cfgs = create_chanmon_cfgs(3);
 635         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 636         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 637         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 638         // We need the session priv to construct an invalid onion packet later.
 639         let session_priv = [3; 32];
 640         *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
 641         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 642         let (chan_upd_1_2, chan_id_1_2) = {
 643                 let (chan_upd, _, channel_id, ..) = create_announced_chan_between_nodes_with_value(
 644                         &nodes, 1, 2, 1_000_000, 0
 645                 );
 646                 (chan_upd.contents, channel_id)
 647         };
 648
 649         let amt_msat = 5000;
 650         let excess_final_cltv_delta_opt = if check == ReceiveCheckFail::ProcessPendingHTLCsCheck {
 651                 // Set the final CLTV expiry too low to trigger the failure in process_pending_htlc_forwards.
 652                 Some(TEST_FINAL_CLTV as u16 - 2)
 653         } else { None };
 654         let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), excess_final_cltv_delta_opt);
 655         let mut route_params = get_blinded_route_parameters(amt_msat, payment_secret,
 656                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2],
 657                 &chanmon_cfgs[2].keys_manager);
 658
 659         let route = if check == ReceiveCheckFail::ProcessPendingHTLCsCheck {
 660                 let mut route = get_route(&nodes[0], &route_params).unwrap();
 661                 // Set the final CLTV expiry too low to trigger the failure in process_pending_htlc_forwards.
 662                 route.paths[0].hops.last_mut().map(|h| h.cltv_expiry_delta += excess_final_cltv_delta_opt.unwrap() as u32);
 663                 route.paths[0].blinded_tail.as_mut().map(|bt| bt.excess_final_cltv_expiry_delta = excess_final_cltv_delta_opt.unwrap() as u32);
 664                 route
 665         } else if check == ReceiveCheckFail::PaymentConstraints {
 666                 // Create a blinded path where the receiver's encrypted payload has an htlc_minimum_msat that is
 667                 // violated by `amt_msat`, and stick it in the route_params without changing the corresponding
 668                 // BlindedPayInfo (to ensure pathfinding still succeeds).
 669                 let high_htlc_min_bp = {
 670                         let mut high_htlc_minimum_upd = chan_upd_1_2.clone();
 671                         high_htlc_minimum_upd.htlc_minimum_msat = amt_msat + 1000;
 672                         let high_htlc_min_params = get_blinded_route_parameters(amt_msat, payment_secret,
 673                                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&high_htlc_minimum_upd],
 674                                 &chanmon_cfgs[2].keys_manager);
 675                         if let Payee::Blinded { route_hints, .. } = high_htlc_min_params.payment_params.payee {
 676                                 route_hints[0].1.clone()
 677                         } else { panic!() }
 678                 };
 679                 if let Payee::Blinded { ref mut route_hints, .. } = route_params.payment_params.payee {
 680                         route_hints[0].1 = high_htlc_min_bp;
 681                 } else { panic!() }
 682                 find_route(&nodes[0], &route_params).unwrap()
 683         } else {
 684                 find_route(&nodes[0], &route_params).unwrap()
 685         };
 686         node_cfgs[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
 687         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 688         check_added_monitors(&nodes[0], 1);
 689
 690         let mut payment_event_0_1 = {
 691                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 692                 assert_eq!(events.len(), 1);
 693                 let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 694                 SendEvent::from_event(ev)
 695         };
 696         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_0_1.msgs[0]);
 697         check_added_monitors!(nodes[1], 0);
 698         do_commitment_signed_dance(&nodes[1], &nodes[0], &payment_event_0_1.commitment_msg, false, false);
 699         expect_pending_htlcs_forwardable!(nodes[1]);
 700         check_added_monitors!(&nodes[1], 1);
 701
 702         let mut payment_event_1_2 = {
 703                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
 704                 assert_eq!(events.len(), 1);
 705                 let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
 706                 SendEvent::from_event(ev)
 707         };
 708
 709         match check {
 710                 ReceiveCheckFail::RecipientFail => {
 711                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_1_2.msgs[0]);
 712                         check_added_monitors!(nodes[2], 0);
 713                         do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
 714                         expect_pending_htlcs_forwardable!(nodes[2]);
 715                         check_payment_claimable(
 716                                 &nodes[2].node.get_and_clear_pending_events()[0], payment_hash, payment_secret, amt_msat,
 717                                 None, nodes[2].node.get_our_node_id()
 718                         );
 719                         nodes[2].node.fail_htlc_backwards(&payment_hash);
 720                         expect_pending_htlcs_forwardable_conditions(
 721                                 nodes[2].node.get_and_clear_pending_events(), &[HTLCDestination::FailedPayment { payment_hash }]
 722                         );
 723                         nodes[2].node.process_pending_htlc_forwards();
 724                         check_added_monitors!(nodes[2], 1);
 725                 },
 726                 ReceiveCheckFail::OnionDecodeFail => {
 727                         let session_priv = SecretKey::from_slice(&session_priv).unwrap();
 728                         let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 729                         let cur_height = nodes[0].best_block_info().1;
 730                         let (mut onion_payloads, ..) = onion_utils::build_onion_payloads(
 731                                 &route.paths[0], amt_msat, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
 732
 733                         let update_add = &mut payment_event_1_2.msgs[0];
 734                         onion_payloads.last_mut().map(|p| {
 735                                 if let msgs::OutboundOnionPayload::BlindedReceive { ref mut intro_node_blinding_point, .. } = p {
 736                                         // The receiver should error if both the update_add blinding_point and the
 737                                         // intro_node_blinding_point are set.
 738                                         assert!(intro_node_blinding_point.is_none() && update_add.blinding_point.is_some());
 739                                         *intro_node_blinding_point = Some(PublicKey::from_slice(&[2; 33]).unwrap());
 740                                 } else { panic!() }
 741                         });
 742                         update_add.onion_routing_packet = onion_utils::construct_onion_packet(
 743                                 vec![onion_payloads.pop().unwrap()], vec![onion_keys.pop().unwrap()], [0; 32],
 744                                 &payment_hash
 745                         ).unwrap();
 746                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update_add);
 747                         check_added_monitors!(nodes[2], 0);
 748                         do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
 749                 },
 750                 ReceiveCheckFail::ReceiveRequirements => {
 751                         let update_add = &mut payment_event_1_2.msgs[0];
 752                         update_add.amount_msat -= 1;
 753                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update_add);
 754                         check_added_monitors!(nodes[2], 0);
 755                         do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
 756                 },
 757                 ReceiveCheckFail::ChannelCheck => {
 758                         nodes[2].node.close_channel(&chan_id_1_2, &nodes[1].node.get_our_node_id()).unwrap();
 759                         let node_2_shutdown = get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 760                         nodes[1].node.handle_shutdown(&nodes[2].node.get_our_node_id(), &node_2_shutdown);
 761                         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
 762
 763                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_1_2.msgs[0]);
 764                         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event_1_2.commitment_msg);
 765                         check_added_monitors!(nodes[2], 1);
 766
 767                         nodes[2].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 768                         commitment_signed_dance!(nodes[2], nodes[1], (), false, true, false, false);
 769                 },
 770                 ReceiveCheckFail::ProcessPendingHTLCsCheck => {
 771                         assert_eq!(payment_event_1_2.msgs[0].cltv_expiry, nodes[0].best_block_info().1 + 1 + excess_final_cltv_delta_opt.unwrap() as u32 + TEST_FINAL_CLTV);
 772                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_1_2.msgs[0]);
 773                         check_added_monitors!(nodes[2], 0);
 774                         do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
 775                         expect_pending_htlcs_forwardable!(nodes[2]);
 776                         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[2],
 777                                 vec![HTLCDestination::FailedPayment { payment_hash }]);
 778                         check_added_monitors!(nodes[2], 1);
 779                 },
 780                 ReceiveCheckFail::PaymentConstraints => {
 781                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_1_2.msgs[0]);
 782                         check_added_monitors!(nodes[2], 0);
 783                         do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
 784                 }
 785         }
 786
 787         let updates_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 788         assert_eq!(updates_2_1.update_fail_malformed_htlcs.len(), 1);
 789         let update_malformed = &updates_2_1.update_fail_malformed_htlcs[0];
 790         assert_eq!(update_malformed.sha256_of_onion, [0; 32]);
 791         assert_eq!(update_malformed.failure_code, INVALID_ONION_BLINDING);
 792         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), update_malformed);
 793         do_commitment_signed_dance(&nodes[1], &nodes[2], &updates_2_1.commitment_signed, true, false);
 794
 795         let updates_1_0 = if check == ReceiveCheckFail::ChannelCheck {
 796                 let events = nodes[1].node.get_and_clear_pending_msg_events();
 797                 assert_eq!(events.len(), 2);
 798                 events.into_iter().find_map(|ev| {
 799                         match ev {
 800                                 MessageSendEvent:: UpdateHTLCs { node_id, updates } => {
 801                                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
 802                                         return Some(updates)
 803                                 },
 804                                 MessageSendEvent::SendClosingSigned { .. } => None,
 805                                 _ => panic!()
 806                         }
 807                 }).unwrap()
 808         } else { get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()) };
 809         assert_eq!(updates_1_0.update_fail_htlcs.len(), 1);
 810         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_1_0.update_fail_htlcs[0]);
 811         do_commitment_signed_dance(&nodes[0], &nodes[1], &updates_1_0.commitment_signed, false, false);
 812         expect_payment_failed_conditions(&nodes[0], payment_hash, false,
 813                 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
 814 }
 815
 816 #[test]
 817 fn blinded_path_retries() {
 818         let chanmon_cfgs = create_chanmon_cfgs(4);
 819         // Make one blinded path's fees slightly higher so they are tried in a deterministic order.
 820         let mut higher_fee_chan_cfg = test_default_channel_config();
 821         higher_fee_chan_cfg.channel_config.forwarding_fee_base_msat += 1;
 822         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 823         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, Some(higher_fee_chan_cfg), None]);
 824         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 825
 826         // Create this network topology so nodes[0] has a blinded route hint to retry over.
 827         //      n1
 828         //    /    \
 829         // n0       n3
 830         //    \    /
 831         //      n2
 832         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 833         create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0);
 834         let chan_1_3 = create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 1_000_000, 0);
 835         let chan_2_3 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0);
 836
 837         let amt_msat = 5000;
 838         let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[3], Some(amt_msat), None);
 839         let route_params = {
 840                 let pay_params = PaymentParameters::blinded(
 841                         vec![
 842                                 blinded_payment_path(payment_secret,
 843                                         vec![nodes[1].node.get_our_node_id(), nodes[3].node.get_our_node_id()], &[&chan_1_3.0.contents],
 844                                         &chanmon_cfgs[3].keys_manager
 845                                 ),
 846                                 blinded_payment_path(payment_secret,
 847                                         vec![nodes[2].node.get_our_node_id(), nodes[3].node.get_our_node_id()], &[&chan_2_3.0.contents],
 848                                         &chanmon_cfgs[3].keys_manager
 849                                 ),
 850                         ]
 851                 )
 852                         .with_bolt12_features(channelmanager::provided_bolt12_invoice_features(&UserConfig::default()))
 853                         .unwrap();
 854                 RouteParameters::from_payment_params_and_value(pay_params, amt_msat)
 855         };
 856
 857         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params.clone(), Retry::Attempts(2)).unwrap();
 858         check_added_monitors(&nodes[0], 1);
 859         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]]], amt_msat, payment_hash, payment_secret);
 860
 861         macro_rules! fail_payment_back {
 862                 ($intro_node: expr) => {
 863                         nodes[3].node.fail_htlc_backwards(&payment_hash);
 864                         expect_pending_htlcs_forwardable_conditions(
 865                                 nodes[3].node.get_and_clear_pending_events(), &[HTLCDestination::FailedPayment { payment_hash }]
 866                         );
 867                         nodes[3].node.process_pending_htlc_forwards();
 868                         check_added_monitors!(nodes[3], 1);
 869
 870                         let updates = get_htlc_update_msgs!(nodes[3], $intro_node.node.get_our_node_id());
 871                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 1);
 872                         let update_malformed = &updates.update_fail_malformed_htlcs[0];
 873                         assert_eq!(update_malformed.sha256_of_onion, [0; 32]);
 874                         assert_eq!(update_malformed.failure_code, INVALID_ONION_BLINDING);
 875                         $intro_node.node.handle_update_fail_malformed_htlc(&nodes[3].node.get_our_node_id(), update_malformed);
 876                         do_commitment_signed_dance(&$intro_node, &nodes[3], &updates.commitment_signed, true, false);
 877
 878                         let updates =  get_htlc_update_msgs!($intro_node, nodes[0].node.get_our_node_id());
 879                         assert_eq!(updates.update_fail_htlcs.len(), 1);
 880                         nodes[0].node.handle_update_fail_htlc(&$intro_node.node.get_our_node_id(), &updates.update_fail_htlcs[0]);
 881                         do_commitment_signed_dance(&nodes[0], &$intro_node, &updates.commitment_signed, false, false);
 882
 883                         let mut events = nodes[0].node.get_and_clear_pending_events();
 884                         assert_eq!(events.len(), 2);
 885                         match events[0] {
 886                                 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently, ..  } => {
 887                                         assert_eq!(payment_hash, ev_payment_hash);
 888                                         assert_eq!(payment_failed_permanently, false);
 889                                 },
 890                                 _ => panic!("Unexpected event"),
 891                         }
 892                         match events[1] {
 893                                 Event::PendingHTLCsForwardable { .. } => {},
 894                                 _ => panic!("Unexpected event"),
 895                         }
 896                         nodes[0].node.process_pending_htlc_forwards();
 897                 }
 898         }
 899
 900         fail_payment_back!(nodes[1]);
 901
 902         // Pass the retry along.
 903         check_added_monitors!(nodes[0], 1);
 904         let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 905         assert_eq!(msg_events.len(), 1);
 906         pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], amt_msat, payment_hash, Some(payment_secret), msg_events.pop().unwrap(), true, None);
 907
 908         fail_payment_back!(nodes[2]);
 909         let evs = nodes[0].node.get_and_clear_pending_events();
 910         assert_eq!(evs.len(), 1);
 911         match evs[0] {
 912                 Event::PaymentFailed { payment_hash: ev_payment_hash, reason, .. } => {
 913                         assert_eq!(ev_payment_hash, payment_hash);
 914                         // We have 1 retry attempt remaining, but we're out of blinded paths to try.
 915                         assert_eq!(reason, Some(PaymentFailureReason::RouteNotFound));
 916                 },
 917                 _ => panic!()
 918         }
 919 }