_ 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, PaymentContext, PaymentRelay, ReceiveTlvs};
  13 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PaymentFailureReason};
  14 use crate::ln::types::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, IDEMPOTENCY_TIMEOUT_TICKS};
  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, intro_node_min_htlc: u64, intro_node_max_htlc: u64,
  32         node_ids: Vec<PublicKey>, channel_upds: &[&msgs::UnsignedChannelUpdate],
  33         keys_manager: &test_utils::TestKeysInterface
  34 ) -> (BlindedPayInfo, BlindedPath) {
  35         let mut intermediate_nodes = Vec::new();
  36         let mut intro_node_min_htlc_opt = Some(intro_node_min_htlc);
  37         let mut intro_node_max_htlc_opt = Some(intro_node_max_htlc);
  38         for (idx, (node_id, chan_upd)) in node_ids.iter().zip(channel_upds).enumerate() {
  39                 intermediate_nodes.push(ForwardNode {
  40                         node_id: *node_id,
  41                         tlvs: ForwardTlvs {
  42                                 short_channel_id: chan_upd.short_channel_id,
  43                                 payment_relay: PaymentRelay {
  44                                         cltv_expiry_delta: chan_upd.cltv_expiry_delta,
  45                                         fee_proportional_millionths: chan_upd.fee_proportional_millionths,
  46                                         fee_base_msat: chan_upd.fee_base_msat,
  47                                 },
  48                                 payment_constraints: PaymentConstraints {
  49                                         max_cltv_expiry: u32::max_value(),
  50                                         htlc_minimum_msat: intro_node_min_htlc_opt.take()
  51                                                 .unwrap_or_else(|| channel_upds[idx - 1].htlc_minimum_msat),
  52                                 },
  53                                 features: BlindedHopFeatures::empty(),
  54                         },
  55                         htlc_maximum_msat: intro_node_max_htlc_opt.take()
  56                                 .unwrap_or_else(|| channel_upds[idx - 1].htlc_maximum_msat),
  57                 });
  58         }
  59         let payee_tlvs = ReceiveTlvs {
  60                 payment_secret,
  61                 payment_constraints: PaymentConstraints {
  62                         max_cltv_expiry: u32::max_value(),
  63                         htlc_minimum_msat:
  64                                 intro_node_min_htlc_opt.unwrap_or_else(|| channel_upds.last().unwrap().htlc_minimum_msat),
  65                 },
  66                 payment_context: PaymentContext::unknown(),
  67         };
  68         let mut secp_ctx = Secp256k1::new();
  69         BlindedPath::new_for_payment(
  70                 &intermediate_nodes[..], *node_ids.last().unwrap(), payee_tlvs,
  71                 intro_node_max_htlc_opt.unwrap_or_else(|| channel_upds.last().unwrap().htlc_maximum_msat),
  72                 TEST_FINAL_CLTV as u16, keys_manager, &secp_ctx
  73         ).unwrap()
  74 }
  75
  76 pub fn get_blinded_route_parameters(
  77         amt_msat: u64, payment_secret: PaymentSecret, intro_node_min_htlc: u64, intro_node_max_htlc: u64,
  78         node_ids: Vec<PublicKey>, channel_upds: &[&msgs::UnsignedChannelUpdate],
  79         keys_manager: &test_utils::TestKeysInterface
  80 ) -> RouteParameters {
  81         RouteParameters::from_payment_params_and_value(
  82                 PaymentParameters::blinded(vec![
  83                         blinded_payment_path(
  84                                 payment_secret, intro_node_min_htlc, intro_node_max_htlc, node_ids, channel_upds,
  85                                 keys_manager
  86                         )
  87                 ]), amt_msat
  88         )
  89 }
  90
  91 #[test]
  92 fn one_hop_blinded_path() {
  93         do_one_hop_blinded_path(true);
  94         do_one_hop_blinded_path(false);
  95 }
  96
  97 fn do_one_hop_blinded_path(success: bool) {
  98         let chanmon_cfgs = create_chanmon_cfgs(2);
  99         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 100         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 101         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 102         let chan_upd = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0).0.contents;
 103
 104         let amt_msat = 5000;
 105         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[1], Some(amt_msat), None);
 106         let payee_tlvs = ReceiveTlvs {
 107                 payment_secret,
 108                 payment_constraints: PaymentConstraints {
 109                         max_cltv_expiry: u32::max_value(),
 110                         htlc_minimum_msat: chan_upd.htlc_minimum_msat,
 111                 },
 112                 payment_context: PaymentContext::unknown(),
 113         };
 114         let mut secp_ctx = Secp256k1::new();
 115         let blinded_path = BlindedPath::one_hop_for_payment(
 116                 nodes[1].node.get_our_node_id(), payee_tlvs, TEST_FINAL_CLTV as u16,
 117                 &chanmon_cfgs[1].keys_manager, &secp_ctx
 118         ).unwrap();
 119
 120         let route_params = RouteParameters::from_payment_params_and_value(
 121                 PaymentParameters::blinded(vec![blinded_path]),
 122                 amt_msat,
 123         );
 124         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(),
 125         PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 126         check_added_monitors(&nodes[0], 1);
 127         pass_along_route(&nodes[0], &[&[&nodes[1]]], amt_msat, payment_hash, payment_secret);
 128         if success {
 129                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
 130         } else {
 131                 fail_payment(&nodes[0], &[&nodes[1]], payment_hash);
 132         }
 133 }
 134
 135 #[test]
 136 fn mpp_to_one_hop_blinded_path() {
 137         let chanmon_cfgs = create_chanmon_cfgs(4);
 138         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 139         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 140         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 141         let mut secp_ctx = Secp256k1::new();
 142
 143         create_announced_chan_between_nodes(&nodes, 0, 1);
 144         create_announced_chan_between_nodes(&nodes, 0, 2);
 145         let chan_upd_1_3 = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents;
 146         create_announced_chan_between_nodes(&nodes, 2, 3).0.contents;
 147
 148         let amt_msat = 15_000_000;
 149         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[3], Some(amt_msat), None);
 150         let payee_tlvs = ReceiveTlvs {
 151                 payment_secret,
 152                 payment_constraints: PaymentConstraints {
 153                         max_cltv_expiry: u32::max_value(),
 154                         htlc_minimum_msat: chan_upd_1_3.htlc_minimum_msat,
 155                 },
 156                 payment_context: PaymentContext::unknown(),
 157         };
 158         let blinded_path = BlindedPath::one_hop_for_payment(
 159                 nodes[3].node.get_our_node_id(), payee_tlvs, TEST_FINAL_CLTV as u16,
 160                 &chanmon_cfgs[3].keys_manager, &secp_ctx
 161         ).unwrap();
 162
 163         let bolt12_features =
 164                 channelmanager::provided_bolt12_invoice_features(&UserConfig::default());
 165         let route_params = RouteParameters::from_payment_params_and_value(
 166                 PaymentParameters::blinded(vec![blinded_path]).with_bolt12_features(bolt12_features).unwrap(),
 167                 amt_msat,
 168         );
 169         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 170         check_added_monitors(&nodes[0], 2);
 171
 172         let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]];
 173         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 174         assert_eq!(events.len(), 2);
 175
 176         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 177         pass_along_path(&nodes[0], expected_route[0], amt_msat, payment_hash.clone(),
 178                 Some(payment_secret), ev.clone(), false, None);
 179
 180         let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
 181         pass_along_path(&nodes[0], expected_route[1], amt_msat, payment_hash.clone(),
 182                 Some(payment_secret), ev.clone(), true, None);
 183         claim_payment_along_route(&nodes[0], expected_route, false, payment_preimage);
 184 }
 185
 186 #[test]
 187 fn mpp_to_three_hop_blinded_paths() {
 188         let chanmon_cfgs = create_chanmon_cfgs(6);
 189         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
 190         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
 191         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
 192
 193         // Create this network topology so node 0 MPP's over 2 3-hop blinded paths:
 194         //     n1 -- n3
 195         //    /        \
 196         // n0           n5
 197         //    \        /
 198         //     n2 -- n4
 199         create_announced_chan_between_nodes(&nodes, 0, 1);
 200         create_announced_chan_between_nodes(&nodes, 0, 2);
 201         let chan_upd_1_3 = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents;
 202         let chan_upd_2_4 = create_announced_chan_between_nodes(&nodes, 2, 4).0.contents;
 203         let chan_upd_3_5 = create_announced_chan_between_nodes(&nodes, 3, 5).0.contents;
 204         let chan_upd_4_5 = create_announced_chan_between_nodes(&nodes, 4, 5).0.contents;
 205
 206         let amt_msat = 15_000_000;
 207         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[5], Some(amt_msat), None);
 208         let route_params = {
 209                 let path_1_params = get_blinded_route_parameters(
 210                         amt_msat, payment_secret, 1, 1_0000_0000, vec![
 211                                 nodes[1].node.get_our_node_id(), nodes[3].node.get_our_node_id(),
 212                                 nodes[5].node.get_our_node_id()
 213                         ], &[&chan_upd_1_3, &chan_upd_3_5], &chanmon_cfgs[5].keys_manager
 214                 );
 215                 let path_2_params = get_blinded_route_parameters(
 216                         amt_msat, payment_secret, 1, 1_0000_0000, vec![
 217                                 nodes[2].node.get_our_node_id(), nodes[4].node.get_our_node_id(),
 218                                 nodes[5].node.get_our_node_id()
 219                         ], &[&chan_upd_2_4, &chan_upd_4_5], &chanmon_cfgs[5].keys_manager
 220                 );
 221                 let pay_params = PaymentParameters::blinded(
 222                         vec![
 223                                 path_1_params.payment_params.payee.blinded_route_hints()[0].clone(),
 224                                 path_2_params.payment_params.payee.blinded_route_hints()[0].clone()
 225                         ]
 226                 )
 227                         .with_bolt12_features(channelmanager::provided_bolt12_invoice_features(&UserConfig::default()))
 228                         .unwrap();
 229                 RouteParameters::from_payment_params_and_value(pay_params, amt_msat)
 230         };
 231
 232         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(),
 233                 PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 234         check_added_monitors(&nodes[0], 2);
 235
 236         let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[3], &nodes[5]], &[&nodes[2], &nodes[4], &nodes[5]]];
 237         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 238         assert_eq!(events.len(), 2);
 239
 240         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 241         pass_along_path(&nodes[0], expected_route[0], amt_msat, payment_hash.clone(),
 242                 Some(payment_secret), ev.clone(), false, None);
 243
 244         let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
 245         pass_along_path(&nodes[0], expected_route[1], amt_msat, payment_hash.clone(),
 246                 Some(payment_secret), ev.clone(), true, None);
 247         claim_payment_along_route(&nodes[0], expected_route, false, payment_preimage);
 248 }
 249
 250 enum ForwardCheckFail {
 251         // Fail a check on the inbound onion payload. In this case, we underflow when calculating the
 252         // outgoing cltv_expiry.
 253         InboundOnionCheck,
 254         // The forwarding node's payload is encoded as a receive, i.e. the next hop HMAC is [0; 32].
 255         ForwardPayloadEncodedAsReceive,
 256         // Fail a check on the outbound channel. In this case, our next-hop peer is offline.
 257         OutboundChannelCheck,
 258 }
 259
 260 #[test]
 261 fn forward_checks_failure() {
 262         do_forward_checks_failure(ForwardCheckFail::InboundOnionCheck, true);
 263         do_forward_checks_failure(ForwardCheckFail::InboundOnionCheck, false);
 264         do_forward_checks_failure(ForwardCheckFail::ForwardPayloadEncodedAsReceive, true);
 265         do_forward_checks_failure(ForwardCheckFail::ForwardPayloadEncodedAsReceive, false);
 266         do_forward_checks_failure(ForwardCheckFail::OutboundChannelCheck, true);
 267         do_forward_checks_failure(ForwardCheckFail::OutboundChannelCheck, false);
 268 }
 269
 270 fn do_forward_checks_failure(check: ForwardCheckFail, intro_fails: bool) {
 271         // Ensure we'll fail backwards properly if a forwarding check fails on initial update_add
 272         // receipt.
 273         let chanmon_cfgs = create_chanmon_cfgs(4);
 274         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 275         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 276         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 277         // We need the session priv to construct a bogus onion packet later.
 278         *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
 279         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 280         let chan_upd_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0).0.contents;
 281         let chan_upd_2_3 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0).0.contents;
 282
 283         let amt_msat = 5000;
 284         let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[3], Some(amt_msat), None);
 285         let mut route_params = get_blinded_route_parameters(amt_msat, payment_secret, 1, 1_0000_0000,
 286                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(),
 287                 &[&chan_upd_1_2, &chan_upd_2_3], &chanmon_cfgs[3].keys_manager);
 288         route_params.payment_params.max_path_length = 18;
 289
 290         let route = get_route(&nodes[0], &route_params).unwrap();
 291         node_cfgs[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
 292         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 293         check_added_monitors(&nodes[0], 1);
 294
 295         macro_rules! cause_error {
 296                 ($src_node_idx: expr, $target_node_idx: expr, $update_add: expr) => {
 297                         match check {
 298                                 ForwardCheckFail::InboundOnionCheck => {
 299                                         $update_add.cltv_expiry = 10; // causes outbound CLTV expiry to underflow
 300                                 },
 301                                 ForwardCheckFail::ForwardPayloadEncodedAsReceive => {
 302                                         let recipient_onion_fields = RecipientOnionFields::spontaneous_empty();
 303                                         let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
 304                                         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 305                                         let cur_height = nodes[0].best_block_info().1;
 306                                         let (mut onion_payloads, ..) = onion_utils::build_onion_payloads(
 307                                                 &route.paths[0], amt_msat, &recipient_onion_fields, cur_height, &None).unwrap();
 308                                         // Remove the receive payload so the blinded forward payload is encoded as a final payload
 309                                         // (i.e. next_hop_hmac == [0; 32])
 310                                         onion_payloads.pop();
 311                                         if $target_node_idx + 1 < nodes.len() {
 312                                                 onion_payloads.pop();
 313                                         }
 314                                         $update_add.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
 315                                 },
 316                                 ForwardCheckFail::OutboundChannelCheck => {
 317                                         // The intro node will see that the next-hop peer is disconnected and fail the HTLC backwards.
 318                                         nodes[$src_node_idx].node.peer_disconnected(&nodes[$target_node_idx].node.get_our_node_id());
 319                                 }
 320                         }
 321                 }
 322         }
 323
 324         let mut updates_0_1 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 325         let update_add = &mut updates_0_1.update_add_htlcs[0];
 326
 327         if intro_fails {
 328                 cause_error!(1, 2, update_add);
 329         }
 330
 331         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
 332         check_added_monitors!(nodes[1], 0);
 333         do_commitment_signed_dance(&nodes[1], &nodes[0], &updates_0_1.commitment_signed, true, true);
 334
 335         if intro_fails {
 336                 let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 337                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
 338                 do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
 339                 expect_payment_failed_conditions(&nodes[0], payment_hash, false,
 340                         PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
 341                 return
 342         }
 343
 344         expect_pending_htlcs_forwardable!(nodes[1]);
 345         check_added_monitors!(nodes[1], 1);
 346
 347         let mut updates_1_2 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
 348         let mut update_add = &mut updates_1_2.update_add_htlcs[0];
 349
 350         cause_error!(2, 3, update_add);
 351
 352         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add);
 353         check_added_monitors!(nodes[2], 0);
 354         do_commitment_signed_dance(&nodes[2], &nodes[1], &updates_1_2.commitment_signed, true, true);
 355
 356         let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 357         let update_malformed = &mut updates.update_fail_malformed_htlcs[0];
 358         assert_eq!(update_malformed.failure_code, INVALID_ONION_BLINDING);
 359         assert_eq!(update_malformed.sha256_of_onion, [0; 32]);
 360
 361         // Ensure the intro node will properly blind the error if its downstream node failed to do so.
 362         update_malformed.sha256_of_onion = [1; 32];
 363         update_malformed.failure_code = INVALID_ONION_BLINDING ^ 1;
 364         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), update_malformed);
 365         do_commitment_signed_dance(&nodes[1], &nodes[2], &updates.commitment_signed, true, false);
 366
 367         let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 368         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
 369         do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
 370         expect_payment_failed_conditions(&nodes[0], payment_hash, false,
 371                 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
 372 }
 373
 374 #[test]
 375 fn failed_backwards_to_intro_node() {
 376         // Ensure the intro node will error backwards properly even if the downstream node did not blind
 377         // their error.
 378         let chanmon_cfgs = create_chanmon_cfgs(3);
 379         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 380         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 381         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 382         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 383         let chan_upd_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0).0.contents;
 384
 385         let amt_msat = 5000;
 386         let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
 387         let route_params = get_blinded_route_parameters(amt_msat, payment_secret, 1, 1_0000_0000,
 388                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2],
 389                 &chanmon_cfgs[2].keys_manager);
 390
 391         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 392         check_added_monitors(&nodes[0], 1);
 393
 394         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 395         assert_eq!(events.len(), 1);
 396         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 397         let mut payment_event = SendEvent::from_event(ev);
 398
 399         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 400         check_added_monitors!(nodes[1], 0);
 401         do_commitment_signed_dance(&nodes[1], &nodes[0], &payment_event.commitment_msg, false, false);
 402         expect_pending_htlcs_forwardable!(nodes[1]);
 403         check_added_monitors!(&nodes[1], 1);
 404
 405         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
 406         assert_eq!(events.len(), 1);
 407         let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
 408         let mut payment_event = SendEvent::from_event(ev);
 409
 410         // Ensure the final node fails to handle the HTLC.
 411         payment_event.msgs[0].onion_routing_packet.hop_data[0] ^= 1;
 412         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 413         check_added_monitors!(nodes[2], 0);
 414         do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event.commitment_msg, true, true);
 415         nodes[2].node.process_pending_htlc_forwards();
 416
 417         let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 418         let mut update_malformed = &mut updates.update_fail_malformed_htlcs[0];
 419         // Check that the final node encodes its failure correctly.
 420         assert_eq!(update_malformed.failure_code, INVALID_ONION_BLINDING);
 421         assert_eq!(update_malformed.sha256_of_onion, [0; 32]);
 422
 423         // Modify such the final hop does not correctly blind their error so we can ensure the intro node
 424         // converts it to the correct error.
 425         update_malformed.sha256_of_onion = [1; 32];
 426         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), update_malformed);
 427         do_commitment_signed_dance(&nodes[1], &nodes[2], &updates.commitment_signed, true, false);
 428
 429         let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 430         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
 431         do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
 432         expect_payment_failed_conditions(&nodes[0], payment_hash, false,
 433                 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
 434 }
 435
 436 enum ProcessPendingHTLCsCheck {
 437         FwdPeerDisconnected,
 438         FwdChannelClosed,
 439 }
 440
 441 #[test]
 442 fn forward_fail_in_process_pending_htlc_fwds() {
 443         do_forward_fail_in_process_pending_htlc_fwds(ProcessPendingHTLCsCheck::FwdPeerDisconnected, true);
 444         do_forward_fail_in_process_pending_htlc_fwds(ProcessPendingHTLCsCheck::FwdPeerDisconnected, false);
 445         do_forward_fail_in_process_pending_htlc_fwds(ProcessPendingHTLCsCheck::FwdChannelClosed, true);
 446         do_forward_fail_in_process_pending_htlc_fwds(ProcessPendingHTLCsCheck::FwdChannelClosed, false);
 447 }
 448 fn do_forward_fail_in_process_pending_htlc_fwds(check: ProcessPendingHTLCsCheck, intro_fails: bool) {
 449         // Ensure the intro node will error backwards properly if the HTLC fails in
 450         // process_pending_htlc_forwards.
 451         let chanmon_cfgs = create_chanmon_cfgs(4);
 452         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 453         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 454         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 455         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 456         let (chan_upd_1_2, chan_id_1_2) = {
 457                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0);
 458                 (chan.0.contents, chan.2)
 459         };
 460         let (chan_upd_2_3, chan_id_2_3) = {
 461                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0);
 462                 (chan.0.contents, chan.2)
 463         };
 464
 465         let amt_msat = 5000;
 466         let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
 467         let route_params = get_blinded_route_parameters(amt_msat, payment_secret, 1, 1_0000_0000,
 468                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2, &chan_upd_2_3],
 469                 &chanmon_cfgs[2].keys_manager);
 470
 471         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 472         check_added_monitors(&nodes[0], 1);
 473
 474         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 475         assert_eq!(events.len(), 1);
 476         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 477         let mut payment_event = SendEvent::from_event(ev);
 478
 479         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 480         check_added_monitors!(nodes[1], 0);
 481         do_commitment_signed_dance(&nodes[1], &nodes[0], &payment_event.commitment_msg, false, false);
 482
 483         macro_rules! cause_error {
 484                 ($prev_node: expr, $curr_node: expr, $next_node: expr, $failed_chan_id: expr, $failed_scid: expr) => {
 485                         match check {
 486                                 ProcessPendingHTLCsCheck::FwdPeerDisconnected => {
 487                                         // Disconnect the next-hop peer so when we go to forward in process_pending_htlc_forwards, the
 488                                         // intro node will error backwards.
 489                                         $curr_node.node.peer_disconnected(&$next_node.node.get_our_node_id());
 490                                         expect_pending_htlcs_forwardable!($curr_node);
 491                                         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($curr_node,
 492                                                 vec![HTLCDestination::NextHopChannel { node_id: Some($next_node.node.get_our_node_id()), channel_id: $failed_chan_id }]);
 493                                 },
 494                                 ProcessPendingHTLCsCheck::FwdChannelClosed => {
 495                                         // Force close the next-hop channel so when we go to forward in process_pending_htlc_forwards,
 496                                         // the intro node will error backwards.
 497                                         $curr_node.node.force_close_broadcasting_latest_txn(&$failed_chan_id, &$next_node.node.get_our_node_id()).unwrap();
 498                                         let events = $curr_node.node.get_and_clear_pending_events();
 499                                         match events[0] {
 500                                                 crate::events::Event::PendingHTLCsForwardable { .. } => {},
 501                                                 _ => panic!("Unexpected event {:?}", events),
 502                                         };
 503                                         match events[1] {
 504                                                 crate::events::Event::ChannelClosed { .. } => {},
 505                                                 _ => panic!("Unexpected event {:?}", events),
 506                                         }
 507
 508                                         $curr_node.node.process_pending_htlc_forwards();
 509                                         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($curr_node,
 510                                                 vec![HTLCDestination::UnknownNextHop { requested_forward_scid: $failed_scid }]);
 511                                         check_closed_broadcast(&$curr_node, 1, true);
 512                                         check_added_monitors!($curr_node, 1);
 513                                         $curr_node.node.process_pending_htlc_forwards();
 514                                 },
 515                         }
 516                 }
 517         }
 518
 519         if intro_fails {
 520                 cause_error!(nodes[0], nodes[1], nodes[2], chan_id_1_2, chan_upd_1_2.short_channel_id);
 521                 let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 522                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
 523                 check_added_monitors!(nodes[1], 1);
 524                 do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
 525
 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         expect_pending_htlcs_forwardable!(nodes[1]);
 532         check_added_monitors!(nodes[1], 1);
 533
 534         let mut updates_1_2 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
 535         let mut update_add = &mut updates_1_2.update_add_htlcs[0];
 536         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add);
 537         check_added_monitors!(nodes[2], 0);
 538         do_commitment_signed_dance(&nodes[2], &nodes[1], &updates_1_2.commitment_signed, true, true);
 539
 540         cause_error!(nodes[1], nodes[2], nodes[3], chan_id_2_3, chan_upd_2_3.short_channel_id);
 541         check_added_monitors!(nodes[2], 1);
 542
 543         let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 544         let update_malformed = &mut updates.update_fail_malformed_htlcs[0];
 545         assert_eq!(update_malformed.failure_code, INVALID_ONION_BLINDING);
 546         assert_eq!(update_malformed.sha256_of_onion, [0; 32]);
 547
 548         // Ensure the intro node will properly blind the error if its downstream node failed to do so.
 549         update_malformed.sha256_of_onion = [1; 32];
 550         update_malformed.failure_code = INVALID_ONION_BLINDING ^ 1;
 551         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), update_malformed);
 552         do_commitment_signed_dance(&nodes[1], &nodes[2], &updates.commitment_signed, true, false);
 553
 554         let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 555         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
 556         do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
 557         expect_payment_failed_conditions(&nodes[0], payment_hash, false,
 558                 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
 559 }
 560
 561 #[test]
 562 fn blinded_intercept_payment() {
 563         do_blinded_intercept_payment(true);
 564         do_blinded_intercept_payment(false);
 565 }
 566 fn do_blinded_intercept_payment(intercept_node_fails: bool) {
 567         let chanmon_cfgs = create_chanmon_cfgs(3);
 568         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 569         let mut intercept_forwards_config = test_default_channel_config();
 570         intercept_forwards_config.accept_intercept_htlcs = true;
 571         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(intercept_forwards_config), None]);
 572         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 573         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 574         let (channel_id, chan_upd) = {
 575                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0);
 576                 (chan.2, chan.0.contents)
 577         };
 578
 579         let amt_msat = 5000;
 580         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
 581         let intercept_scid = nodes[1].node.get_intercept_scid();
 582         let mut intercept_chan_upd = chan_upd;
 583         intercept_chan_upd.short_channel_id = intercept_scid;
 584         let route_params = get_blinded_route_parameters(amt_msat, payment_secret, 1, 1_0000_0000,
 585                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&intercept_chan_upd],
 586                 &chanmon_cfgs[2].keys_manager);
 587
 588         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(),
 589         PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 590         check_added_monitors(&nodes[0], 1);
 591         let payment_event = {
 592                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 593                 assert_eq!(events.len(), 1);
 594                 SendEvent::from_event(events.remove(0))
 595         };
 596         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
 597         commitment_signed_dance!(nodes[1], nodes[0], &payment_event.commitment_msg, false, true);
 598
 599         let events = nodes[1].node.get_and_clear_pending_events();
 600         assert_eq!(events.len(), 1);
 601         let (intercept_id, expected_outbound_amount_msat) = match events[0] {
 602                 crate::events::Event::HTLCIntercepted {
 603                         intercept_id, payment_hash: pmt_hash,
 604                         requested_next_hop_scid: short_channel_id, expected_outbound_amount_msat, ..
 605                 } => {
 606                         assert_eq!(pmt_hash, payment_hash);
 607                         assert_eq!(short_channel_id, intercept_scid);
 608                         (intercept_id, expected_outbound_amount_msat)
 609                 },
 610                 _ => panic!()
 611         };
 612
 613         if intercept_node_fails {
 614                 nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap();
 615                 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::UnknownNextHop { requested_forward_scid: intercept_scid }]);
 616                 nodes[1].node.process_pending_htlc_forwards();
 617                 let update_fail = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 618                 check_added_monitors!(&nodes[1], 1);
 619                 assert!(update_fail.update_fail_htlcs.len() == 1);
 620                 let fail_msg = update_fail.update_fail_htlcs[0].clone();
 621                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
 622                 commitment_signed_dance!(nodes[0], nodes[1], update_fail.commitment_signed, false);
 623                 expect_payment_failed_conditions(&nodes[0], payment_hash, false,
 624                         PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
 625                 return
 626         }
 627
 628         nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap();
 629         expect_pending_htlcs_forwardable!(nodes[1]);
 630
 631         let payment_event = {
 632                 {
 633                         let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
 634                         assert_eq!(added_monitors.len(), 1);
 635                         added_monitors.clear();
 636                 }
 637                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
 638                 assert_eq!(events.len(), 1);
 639                 SendEvent::from_event(events.remove(0))
 640         };
 641         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 642         commitment_signed_dance!(nodes[2], nodes[1], &payment_event.commitment_msg, false, true);
 643         expect_pending_htlcs_forwardable!(nodes[2]);
 644
 645         expect_payment_claimable!(&nodes[2], payment_hash, payment_secret, amt_msat, None, nodes[2].node.get_our_node_id());
 646         do_claim_payment_along_route(
 647                 ClaimAlongRouteArgs::new(&nodes[0], &[&[&nodes[1], &nodes[2]]], payment_preimage)
 648         );
 649         expect_payment_sent(&nodes[0], payment_preimage, Some(Some(1000)), true, true);
 650 }
 651
 652 #[test]
 653 fn two_hop_blinded_path_success() {
 654         let chanmon_cfgs = create_chanmon_cfgs(3);
 655         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 656         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 657         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 658         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 659         let chan_upd_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0).0.contents;
 660
 661         let amt_msat = 5000;
 662         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
 663         let route_params = get_blinded_route_parameters(amt_msat, payment_secret, 1, 1_0000_0000,
 664                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2],
 665                 &chanmon_cfgs[2].keys_manager);
 666
 667         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 668         check_added_monitors(&nodes[0], 1);
 669         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], amt_msat, payment_hash, payment_secret);
 670         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
 671 }
 672
 673 #[test]
 674 fn three_hop_blinded_path_success() {
 675         let chanmon_cfgs = create_chanmon_cfgs(5);
 676         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
 677         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
 678         let mut nodes = create_network(5, &node_cfgs, &node_chanmgrs);
 679         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 680         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0);
 681         let chan_upd_2_3 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0).0.contents;
 682         let chan_upd_3_4 = create_announced_chan_between_nodes_with_value(&nodes, 3, 4, 1_000_000, 0).0.contents;
 683
 684         // Get all our nodes onto the same height so payments don't fail for CLTV violations.
 685         connect_blocks(&nodes[0], nodes[4].best_block_info().1 - nodes[0].best_block_info().1);
 686         connect_blocks(&nodes[1], nodes[4].best_block_info().1 - nodes[1].best_block_info().1);
 687         connect_blocks(&nodes[2], nodes[4].best_block_info().1 - nodes[2].best_block_info().1);
 688         assert_eq!(nodes[4].best_block_info().1, nodes[3].best_block_info().1);
 689
 690         let amt_msat = 5000;
 691         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[4], Some(amt_msat), None);
 692         let route_params = get_blinded_route_parameters(amt_msat, payment_secret, 1, 1_0000_0000,
 693                 nodes.iter().skip(2).map(|n| n.node.get_our_node_id()).collect(),
 694                 &[&chan_upd_2_3, &chan_upd_3_4], &chanmon_cfgs[4].keys_manager);
 695
 696         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 697         check_added_monitors(&nodes[0], 1);
 698         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2], &nodes[3], &nodes[4]]], amt_msat, payment_hash, payment_secret);
 699         claim_payment(&nodes[0], &[&nodes[1], &nodes[2], &nodes[3], &nodes[4]], payment_preimage);
 700 }
 701
 702 #[test]
 703 fn three_hop_blinded_path_fail() {
 704         // Test that an intermediate blinded forwarding node gets failed back to with
 705         // malformed and also fails back themselves with malformed.
 706         let chanmon_cfgs = create_chanmon_cfgs(4);
 707         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 708         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
 709         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 710         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 711         let chan_upd_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0).0.contents;
 712         let chan_upd_2_3 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0).0.contents;
 713
 714         let amt_msat = 5000;
 715         let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[3], Some(amt_msat), None);
 716         let route_params = get_blinded_route_parameters(amt_msat, payment_secret, 1, 1_0000_0000,
 717                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(),
 718                 &[&chan_upd_1_2, &chan_upd_2_3], &chanmon_cfgs[3].keys_manager);
 719
 720         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 721         check_added_monitors(&nodes[0], 1);
 722         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2], &nodes[3]]], amt_msat, payment_hash, payment_secret);
 723
 724         nodes[3].node.fail_htlc_backwards(&payment_hash);
 725         expect_pending_htlcs_forwardable_conditions(
 726                 nodes[3].node.get_and_clear_pending_events(), &[HTLCDestination::FailedPayment { payment_hash }]
 727         );
 728         nodes[3].node.process_pending_htlc_forwards();
 729         check_added_monitors!(nodes[3], 1);
 730
 731         let updates_3_2 = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
 732         assert_eq!(updates_3_2.update_fail_malformed_htlcs.len(), 1);
 733         let update_malformed = &updates_3_2.update_fail_malformed_htlcs[0];
 734         assert_eq!(update_malformed.sha256_of_onion, [0; 32]);
 735         assert_eq!(update_malformed.failure_code, INVALID_ONION_BLINDING);
 736         nodes[2].node.handle_update_fail_malformed_htlc(&nodes[3].node.get_our_node_id(), update_malformed);
 737         do_commitment_signed_dance(&nodes[2], &nodes[3], &updates_3_2.commitment_signed, true, false);
 738
 739         let updates_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 740         assert_eq!(updates_2_1.update_fail_malformed_htlcs.len(), 1);
 741         let update_malformed = &updates_2_1.update_fail_malformed_htlcs[0];
 742         assert_eq!(update_malformed.sha256_of_onion, [0; 32]);
 743         assert_eq!(update_malformed.failure_code, INVALID_ONION_BLINDING);
 744         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), update_malformed);
 745         do_commitment_signed_dance(&nodes[1], &nodes[2], &updates_2_1.commitment_signed, true, false);
 746
 747         let updates_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 748         assert_eq!(updates_1_0.update_fail_htlcs.len(), 1);
 749         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_1_0.update_fail_htlcs[0]);
 750         do_commitment_signed_dance(&nodes[0], &nodes[1], &updates_1_0.commitment_signed, false, false);
 751         expect_payment_failed_conditions(&nodes[0], payment_hash, false,
 752                 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
 753 }
 754
 755 #[derive(PartialEq)]
 756 enum ReceiveCheckFail {
 757         // The recipient fails the payment upon `PaymentClaimable`.
 758         RecipientFail,
 759         // Failure to decode the recipient's onion payload.
 760         OnionDecodeFail,
 761         // The incoming HTLC did not satisfy our requirements; in this case it underpaid us according to
 762         // the expected receive amount in the onion.
 763         ReceiveRequirements,
 764         // The incoming HTLC errors when added to the Channel, in this case due to the HTLC being
 765         // delivered out-of-order with a shutdown message.
 766         ChannelCheck,
 767         // The HTLC is successfully added to the inbound channel but fails receive checks in
 768         // process_pending_htlc_forwards.
 769         ProcessPendingHTLCsCheck,
 770         // The HTLC violates the `PaymentConstraints` contained within the receiver's encrypted payload.
 771         PaymentConstraints,
 772 }
 773
 774 #[test]
 775 fn multi_hop_receiver_fail() {
 776         do_multi_hop_receiver_fail(ReceiveCheckFail::RecipientFail);
 777         do_multi_hop_receiver_fail(ReceiveCheckFail::OnionDecodeFail);
 778         do_multi_hop_receiver_fail(ReceiveCheckFail::ReceiveRequirements);
 779         do_multi_hop_receiver_fail(ReceiveCheckFail::ChannelCheck);
 780         do_multi_hop_receiver_fail(ReceiveCheckFail::ProcessPendingHTLCsCheck);
 781         do_multi_hop_receiver_fail(ReceiveCheckFail::PaymentConstraints);
 782 }
 783
 784 fn do_multi_hop_receiver_fail(check: ReceiveCheckFail) {
 785         // Test that the receiver to a multihop blinded path fails back correctly.
 786         let chanmon_cfgs = create_chanmon_cfgs(3);
 787         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 788         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 789         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 790         // We need the session priv to construct an invalid onion packet later.
 791         let session_priv = [3; 32];
 792         *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
 793         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 794         let (chan_upd_1_2, chan_id_1_2) = {
 795                 let (chan_upd, _, channel_id, ..) = create_announced_chan_between_nodes_with_value(
 796                         &nodes, 1, 2, 1_000_000, 0
 797                 );
 798                 (chan_upd.contents, channel_id)
 799         };
 800
 801         let amt_msat = 5000;
 802         let excess_final_cltv_delta_opt = if check == ReceiveCheckFail::ProcessPendingHTLCsCheck {
 803                 // Set the final CLTV expiry too low to trigger the failure in process_pending_htlc_forwards.
 804                 Some(TEST_FINAL_CLTV as u16 - 2)
 805         } else { None };
 806         let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), excess_final_cltv_delta_opt);
 807         let mut route_params = get_blinded_route_parameters(amt_msat, payment_secret, 1, 1_0000_0000,
 808                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2],
 809                 &chanmon_cfgs[2].keys_manager);
 810
 811         let route = if check == ReceiveCheckFail::ProcessPendingHTLCsCheck {
 812                 let mut route = get_route(&nodes[0], &route_params).unwrap();
 813                 // Set the final CLTV expiry too low to trigger the failure in process_pending_htlc_forwards.
 814                 route.paths[0].hops.last_mut().map(|h| h.cltv_expiry_delta += excess_final_cltv_delta_opt.unwrap() as u32);
 815                 route.paths[0].blinded_tail.as_mut().map(|bt| bt.excess_final_cltv_expiry_delta = excess_final_cltv_delta_opt.unwrap() as u32);
 816                 route
 817         } else if check == ReceiveCheckFail::PaymentConstraints {
 818                 // Create a blinded path where the receiver's encrypted payload has an htlc_minimum_msat that is
 819                 // violated by `amt_msat`, and stick it in the route_params without changing the corresponding
 820                 // BlindedPayInfo (to ensure pathfinding still succeeds).
 821                 let high_htlc_min_bp = {
 822                         let mut high_htlc_minimum_upd = chan_upd_1_2.clone();
 823                         high_htlc_minimum_upd.htlc_minimum_msat = amt_msat + 1000;
 824                         let high_htlc_min_params = get_blinded_route_parameters(amt_msat, payment_secret, 1, 1_0000_0000,
 825                                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&high_htlc_minimum_upd],
 826                                 &chanmon_cfgs[2].keys_manager);
 827                         if let Payee::Blinded { route_hints, .. } = high_htlc_min_params.payment_params.payee {
 828                                 route_hints[0].1.clone()
 829                         } else { panic!() }
 830                 };
 831                 if let Payee::Blinded { ref mut route_hints, .. } = route_params.payment_params.payee {
 832                         route_hints[0].1 = high_htlc_min_bp;
 833                 } else { panic!() }
 834                 find_route(&nodes[0], &route_params).unwrap()
 835         } else {
 836                 find_route(&nodes[0], &route_params).unwrap()
 837         };
 838         node_cfgs[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
 839         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
 840         check_added_monitors(&nodes[0], 1);
 841
 842         let mut payment_event_0_1 = {
 843                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
 844                 assert_eq!(events.len(), 1);
 845                 let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
 846                 SendEvent::from_event(ev)
 847         };
 848         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_0_1.msgs[0]);
 849         check_added_monitors!(nodes[1], 0);
 850         do_commitment_signed_dance(&nodes[1], &nodes[0], &payment_event_0_1.commitment_msg, false, false);
 851         expect_pending_htlcs_forwardable!(nodes[1]);
 852         check_added_monitors!(&nodes[1], 1);
 853
 854         let mut payment_event_1_2 = {
 855                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
 856                 assert_eq!(events.len(), 1);
 857                 let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
 858                 SendEvent::from_event(ev)
 859         };
 860
 861         match check {
 862                 ReceiveCheckFail::RecipientFail => {
 863                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_1_2.msgs[0]);
 864                         check_added_monitors!(nodes[2], 0);
 865                         do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
 866                         expect_pending_htlcs_forwardable!(nodes[2]);
 867                         check_payment_claimable(
 868                                 &nodes[2].node.get_and_clear_pending_events()[0], payment_hash, payment_secret, amt_msat,
 869                                 None, nodes[2].node.get_our_node_id()
 870                         );
 871                         nodes[2].node.fail_htlc_backwards(&payment_hash);
 872                         expect_pending_htlcs_forwardable_conditions(
 873                                 nodes[2].node.get_and_clear_pending_events(), &[HTLCDestination::FailedPayment { payment_hash }]
 874                         );
 875                         nodes[2].node.process_pending_htlc_forwards();
 876                         check_added_monitors!(nodes[2], 1);
 877                 },
 878                 ReceiveCheckFail::OnionDecodeFail => {
 879                         let session_priv = SecretKey::from_slice(&session_priv).unwrap();
 880                         let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
 881                         let cur_height = nodes[0].best_block_info().1;
 882                         let recipient_onion_fields = RecipientOnionFields::spontaneous_empty();
 883                         let (mut onion_payloads, ..) = onion_utils::build_onion_payloads(
 884                                 &route.paths[0], amt_msat, &recipient_onion_fields, cur_height, &None).unwrap();
 885
 886                         let update_add = &mut payment_event_1_2.msgs[0];
 887                         onion_payloads.last_mut().map(|p| {
 888                                 if let msgs::OutboundOnionPayload::BlindedReceive { ref mut intro_node_blinding_point, .. } = p {
 889                                         // The receiver should error if both the update_add blinding_point and the
 890                                         // intro_node_blinding_point are set.
 891                                         assert!(intro_node_blinding_point.is_none() && update_add.blinding_point.is_some());
 892                                         *intro_node_blinding_point = Some(PublicKey::from_slice(&[2; 33]).unwrap());
 893                                 } else { panic!() }
 894                         });
 895                         update_add.onion_routing_packet = onion_utils::construct_onion_packet(
 896                                 vec![onion_payloads.pop().unwrap()], vec![onion_keys.pop().unwrap()], [0; 32],
 897                                 &payment_hash
 898                         ).unwrap();
 899                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update_add);
 900                         check_added_monitors!(nodes[2], 0);
 901                         do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
 902                 },
 903                 ReceiveCheckFail::ReceiveRequirements => {
 904                         let update_add = &mut payment_event_1_2.msgs[0];
 905                         update_add.amount_msat -= 1;
 906                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update_add);
 907                         check_added_monitors!(nodes[2], 0);
 908                         do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
 909                 },
 910                 ReceiveCheckFail::ChannelCheck => {
 911                         nodes[2].node.close_channel(&chan_id_1_2, &nodes[1].node.get_our_node_id()).unwrap();
 912                         let node_2_shutdown = get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 913                         nodes[1].node.handle_shutdown(&nodes[2].node.get_our_node_id(), &node_2_shutdown);
 914                         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
 915
 916                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_1_2.msgs[0]);
 917                         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event_1_2.commitment_msg);
 918                         check_added_monitors!(nodes[2], 1);
 919
 920                         nodes[2].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 921                         commitment_signed_dance!(nodes[2], nodes[1], (), false, true, false, false);
 922                 },
 923                 ReceiveCheckFail::ProcessPendingHTLCsCheck => {
 924                         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);
 925                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_1_2.msgs[0]);
 926                         check_added_monitors!(nodes[2], 0);
 927                         do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
 928                         expect_pending_htlcs_forwardable!(nodes[2]);
 929                         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[2],
 930                                 vec![HTLCDestination::FailedPayment { payment_hash }]);
 931                         check_added_monitors!(nodes[2], 1);
 932                 },
 933                 ReceiveCheckFail::PaymentConstraints => {
 934                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_1_2.msgs[0]);
 935                         check_added_monitors!(nodes[2], 0);
 936                         do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
 937                 }
 938         }
 939
 940         let updates_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 941         assert_eq!(updates_2_1.update_fail_malformed_htlcs.len(), 1);
 942         let update_malformed = &updates_2_1.update_fail_malformed_htlcs[0];
 943         assert_eq!(update_malformed.sha256_of_onion, [0; 32]);
 944         assert_eq!(update_malformed.failure_code, INVALID_ONION_BLINDING);
 945         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), update_malformed);
 946         do_commitment_signed_dance(&nodes[1], &nodes[2], &updates_2_1.commitment_signed, true, false);
 947
 948         let updates_1_0 = if check == ReceiveCheckFail::ChannelCheck {
 949                 let events = nodes[1].node.get_and_clear_pending_msg_events();
 950                 assert_eq!(events.len(), 2);
 951                 events.into_iter().find_map(|ev| {
 952                         match ev {
 953                                 MessageSendEvent:: UpdateHTLCs { node_id, updates } => {
 954                                         assert_eq!(node_id, nodes[0].node.get_our_node_id());
 955                                         return Some(updates)
 956                                 },
 957                                 MessageSendEvent::SendClosingSigned { .. } => None,
 958                                 _ => panic!()
 959                         }
 960                 }).unwrap()
 961         } else { get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()) };
 962         assert_eq!(updates_1_0.update_fail_htlcs.len(), 1);
 963         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_1_0.update_fail_htlcs[0]);
 964         do_commitment_signed_dance(&nodes[0], &nodes[1], &updates_1_0.commitment_signed, false, false);
 965         expect_payment_failed_conditions(&nodes[0], payment_hash, false,
 966                 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
 967 }
 968
 969 #[test]
 970 fn blinded_path_retries() {
 971         let chanmon_cfgs = create_chanmon_cfgs(4);
 972         // Make one blinded path's fees slightly higher so they are tried in a deterministic order.
 973         let mut higher_fee_chan_cfg = test_default_channel_config();
 974         higher_fee_chan_cfg.channel_config.forwarding_fee_base_msat += 1;
 975         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
 976         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, Some(higher_fee_chan_cfg), None]);
 977         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
 978
 979         // Create this network topology so nodes[0] has a blinded route hint to retry over.
 980         //      n1
 981         //    /    \
 982         // n0       n3
 983         //    \    /
 984         //      n2
 985         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 986         create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0);
 987         let chan_1_3 = create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 1_000_000, 0);
 988         let chan_2_3 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0);
 989
 990         let amt_msat = 5000;
 991         let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[3], Some(amt_msat), None);
 992         let route_params = {
 993                 let pay_params = PaymentParameters::blinded(
 994                         vec![
 995                                 blinded_payment_path(payment_secret, 1, 1_0000_0000,
 996                                         vec![nodes[1].node.get_our_node_id(), nodes[3].node.get_our_node_id()], &[&chan_1_3.0.contents],
 997                                         &chanmon_cfgs[3].keys_manager
 998                                 ),
 999                                 blinded_payment_path(payment_secret, 1, 1_0000_0000,
1000                                         vec![nodes[2].node.get_our_node_id(), nodes[3].node.get_our_node_id()], &[&chan_2_3.0.contents],
1001                                         &chanmon_cfgs[3].keys_manager
1002                                 ),
1003                         ]
1004                 )
1005                         .with_bolt12_features(channelmanager::provided_bolt12_invoice_features(&UserConfig::default()))
1006                         .unwrap();
1007                 RouteParameters::from_payment_params_and_value(pay_params, amt_msat)
1008         };
1009
1010         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params.clone(), Retry::Attempts(2)).unwrap();
1011         check_added_monitors(&nodes[0], 1);
1012         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]]], amt_msat, payment_hash, payment_secret);
1013
1014         macro_rules! fail_payment_back {
1015                 ($intro_node: expr) => {
1016                         nodes[3].node.fail_htlc_backwards(&payment_hash);
1017                         expect_pending_htlcs_forwardable_conditions(
1018                                 nodes[3].node.get_and_clear_pending_events(), &[HTLCDestination::FailedPayment { payment_hash }]
1019                         );
1020                         nodes[3].node.process_pending_htlc_forwards();
1021                         check_added_monitors!(nodes[3], 1);
1022
1023                         let updates = get_htlc_update_msgs!(nodes[3], $intro_node.node.get_our_node_id());
1024                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 1);
1025                         let update_malformed = &updates.update_fail_malformed_htlcs[0];
1026                         assert_eq!(update_malformed.sha256_of_onion, [0; 32]);
1027                         assert_eq!(update_malformed.failure_code, INVALID_ONION_BLINDING);
1028                         $intro_node.node.handle_update_fail_malformed_htlc(&nodes[3].node.get_our_node_id(), update_malformed);
1029                         do_commitment_signed_dance(&$intro_node, &nodes[3], &updates.commitment_signed, true, false);
1030
1031                         let updates =  get_htlc_update_msgs!($intro_node, nodes[0].node.get_our_node_id());
1032                         assert_eq!(updates.update_fail_htlcs.len(), 1);
1033                         nodes[0].node.handle_update_fail_htlc(&$intro_node.node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1034                         do_commitment_signed_dance(&nodes[0], &$intro_node, &updates.commitment_signed, false, false);
1035
1036                         let mut events = nodes[0].node.get_and_clear_pending_events();
1037                         assert_eq!(events.len(), 2);
1038                         match events[0] {
1039                                 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently, ..  } => {
1040                                         assert_eq!(payment_hash, ev_payment_hash);
1041                                         assert_eq!(payment_failed_permanently, false);
1042                                 },
1043                                 _ => panic!("Unexpected event"),
1044                         }
1045                         match events[1] {
1046                                 Event::PendingHTLCsForwardable { .. } => {},
1047                                 _ => panic!("Unexpected event"),
1048                         }
1049                         nodes[0].node.process_pending_htlc_forwards();
1050                 }
1051         }
1052
1053         fail_payment_back!(nodes[1]);
1054
1055         // Pass the retry along.
1056         check_added_monitors!(nodes[0], 1);
1057         let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
1058         assert_eq!(msg_events.len(), 1);
1059         pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], amt_msat, payment_hash, Some(payment_secret), msg_events.pop().unwrap(), true, None);
1060
1061         fail_payment_back!(nodes[2]);
1062         let evs = nodes[0].node.get_and_clear_pending_events();
1063         assert_eq!(evs.len(), 1);
1064         match evs[0] {
1065                 Event::PaymentFailed { payment_hash: ev_payment_hash, reason, .. } => {
1066                         assert_eq!(ev_payment_hash, payment_hash);
1067                         // We have 1 retry attempt remaining, but we're out of blinded paths to try.
1068                         assert_eq!(reason, Some(PaymentFailureReason::RouteNotFound));
1069                 },
1070                 _ => panic!()
1071         }
1072 }
1073
1074 #[test]
1075 fn min_htlc() {
1076         // The min htlc of a blinded path is the max (htlc_min - following_fees) along the path. Make sure
1077         // the payment succeeds when we calculate the min htlc this way.
1078         let chanmon_cfgs = create_chanmon_cfgs(4);
1079         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1080         let mut node_1_cfg = test_default_channel_config();
1081         node_1_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
1082         node_1_cfg.channel_config.forwarding_fee_base_msat = 1000;
1083         node_1_cfg.channel_config.forwarding_fee_proportional_millionths = 100_000;
1084         let mut node_2_cfg = test_default_channel_config();
1085         node_2_cfg.channel_handshake_config.our_htlc_minimum_msat = 5000;
1086         node_2_cfg.channel_config.forwarding_fee_base_msat = 200;
1087         node_2_cfg.channel_config.forwarding_fee_proportional_millionths = 150_000;
1088         let mut node_3_cfg = test_default_channel_config();
1089         node_3_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
1090         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, Some(node_1_cfg), Some(node_2_cfg), Some(node_3_cfg)]);
1091         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1092         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
1093         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0);
1094         let chan_2_3 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0);
1095
1096         let min_htlc_msat = {
1097                 // The min htlc for this setup is nodes[2]'s htlc_minimum_msat minus the
1098                 // following fees.
1099                 let post_base_fee = chan_2_3.1.contents.htlc_minimum_msat - chan_2_3.0.contents.fee_base_msat as u64;
1100                 let prop_fee = chan_2_3.0.contents.fee_proportional_millionths as u64;
1101                 (post_base_fee * 1_000_000 + 1_000_000 + prop_fee - 1) / (prop_fee + 1_000_000)
1102         };
1103         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[3], Some(min_htlc_msat), None);
1104         let mut route_params = get_blinded_route_parameters(
1105                 min_htlc_msat, payment_secret, chan_1_2.1.contents.htlc_minimum_msat,
1106                 chan_1_2.1.contents.htlc_maximum_msat, vec![nodes[1].node.get_our_node_id(),
1107                 nodes[2].node.get_our_node_id(), nodes[3].node.get_our_node_id()],
1108                 &[&chan_1_2.0.contents, &chan_2_3.0.contents], &chanmon_cfgs[3].keys_manager);
1109         assert_eq!(min_htlc_msat,
1110                 route_params.payment_params.payee.blinded_route_hints()[0].0.htlc_minimum_msat);
1111
1112         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params.clone(), Retry::Attempts(0)).unwrap();
1113         check_added_monitors(&nodes[0], 1);
1114         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2], &nodes[3]]], min_htlc_msat, payment_hash, payment_secret);
1115         claim_payment(&nodes[0], &[&nodes[1], &nodes[2], &nodes[3]], payment_preimage);
1116
1117         // Paying 1 less than the min fails.
1118         for _ in 0..IDEMPOTENCY_TIMEOUT_TICKS + 1 {
1119                 nodes[0].node.timer_tick_occurred();
1120         }
1121         if let Payee::Blinded { ref mut route_hints, .. } = route_params.payment_params.payee {
1122                 route_hints[0].0.htlc_minimum_msat -= 1;
1123         } else { panic!() }
1124         route_params.final_value_msat -= 1;
1125         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
1126         check_added_monitors(&nodes[0], 1);
1127
1128         let mut payment_event_0_1 = {
1129                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1130                 assert_eq!(events.len(), 1);
1131                 let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
1132                 SendEvent::from_event(ev)
1133         };
1134         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_0_1.msgs[0]);
1135         check_added_monitors!(nodes[1], 0);
1136         do_commitment_signed_dance(&nodes[1], &nodes[0], &payment_event_0_1.commitment_msg, true, true);
1137         let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1138         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1139         do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
1140         expect_payment_failed_conditions(&nodes[0], payment_hash, false,
1141                 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
1142 }
1143
1144 #[test]
1145 fn conditionally_round_fwd_amt() {
1146         // Previously, the (rng-found) feerates below caught a bug where an intermediate node would
1147         // calculate an amt_to_forward that underpaid them by 1 msat, caused by rounding up the outbound
1148         // amount on top of an already rounded-up total routing fee. Ensure that we'll conditionally round
1149         // down intermediate nodes' outbound amounts based on whether rounding up will result in
1150         // undercharging for relay.
1151         let chanmon_cfgs = create_chanmon_cfgs(5);
1152         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1153
1154         let mut node_1_cfg = test_default_channel_config();
1155         node_1_cfg.channel_config.forwarding_fee_base_msat = 247371;
1156         node_1_cfg.channel_config.forwarding_fee_proportional_millionths = 86552;
1157
1158         let mut node_2_cfg = test_default_channel_config();
1159         node_2_cfg.channel_config.forwarding_fee_base_msat = 198921;
1160         node_2_cfg.channel_config.forwarding_fee_proportional_millionths = 681759;
1161
1162         let mut node_3_cfg = test_default_channel_config();
1163         node_3_cfg.channel_config.forwarding_fee_base_msat = 132845;
1164         node_3_cfg.channel_config.forwarding_fee_proportional_millionths = 552561;
1165
1166         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, Some(node_1_cfg), Some(node_2_cfg), Some(node_3_cfg), None]);
1167         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1168         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
1169         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0);
1170         let chan_2_3 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0);
1171         let chan_3_4 = create_announced_chan_between_nodes_with_value(&nodes, 3, 4, 1_000_000, 0);
1172
1173         let amt_msat = 100_000;
1174         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[4], Some(amt_msat), None);
1175         let mut route_params = get_blinded_route_parameters(amt_msat, payment_secret,
1176                 chan_1_2.1.contents.htlc_minimum_msat, chan_1_2.1.contents.htlc_maximum_msat,
1177                 vec![nodes[1].node.get_our_node_id(), nodes[2].node.get_our_node_id(),
1178                 nodes[3].node.get_our_node_id(), nodes[4].node.get_our_node_id()],
1179                 &[&chan_1_2.0.contents, &chan_2_3.0.contents, &chan_3_4.0.contents],
1180                 &chanmon_cfgs[4].keys_manager);
1181         route_params.max_total_routing_fee_msat = None;
1182
1183         nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
1184         check_added_monitors(&nodes[0], 1);
1185         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2], &nodes[3], &nodes[4]]], amt_msat, payment_hash, payment_secret);
1186         nodes[4].node.claim_funds(payment_preimage);
1187         let expected_path = &[&nodes[1], &nodes[2], &nodes[3], &nodes[4]];
1188         let expected_route = &[&expected_path[..]];
1189         let mut args = ClaimAlongRouteArgs::new(&nodes[0], &expected_route[..], payment_preimage)
1190                 .allow_1_msat_fee_overpay();
1191         let expected_fee = pass_claimed_payment_along_route(args);
1192         expect_payment_sent(&nodes[0], payment_preimage, Some(Some(expected_fee)), true, true);
1193 }
1194
1195 #[test]
1196 fn blinded_keysend() {
1197         let mut mpp_keysend_config = test_default_channel_config();
1198         mpp_keysend_config.accept_mpp_keysend = true;
1199         let chanmon_cfgs = create_chanmon_cfgs(3);
1200         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1201         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, Some(mpp_keysend_config)]);
1202         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1203         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
1204         let chan_upd_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0).0.contents;
1205
1206         let amt_msat = 5000;
1207         let (keysend_preimage, _, payment_secret) = get_payment_preimage_hash(&nodes[2], None, None);
1208         let route_params = get_blinded_route_parameters(amt_msat, payment_secret, 1,
1209                 1_0000_0000,
1210                 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(),
1211                 &[&chan_upd_1_2], &chanmon_cfgs[2].keys_manager);
1212
1213         let payment_hash = nodes[0].node.send_spontaneous_payment_with_retry(Some(keysend_preimage), RecipientOnionFields::spontaneous_empty(), PaymentId(keysend_preimage.0), route_params, Retry::Attempts(0)).unwrap();
1214         check_added_monitors(&nodes[0], 1);
1215
1216         let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[2]]];
1217         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1218         assert_eq!(events.len(), 1);
1219
1220         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
1221         pass_along_path(&nodes[0], expected_route[0], amt_msat, payment_hash, Some(payment_secret), ev.clone(), true, Some(keysend_preimage));
1222         claim_payment_along_route(&nodes[0], expected_route, false, keysend_preimage);
1223 }
1224
1225 #[test]
1226 fn blinded_mpp_keysend() {
1227         let mut mpp_keysend_config = test_default_channel_config();
1228         mpp_keysend_config.accept_mpp_keysend = true;
1229         let chanmon_cfgs = create_chanmon_cfgs(4);
1230         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1231         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, Some(mpp_keysend_config)]);
1232         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1233
1234         create_announced_chan_between_nodes(&nodes, 0, 1);
1235         create_announced_chan_between_nodes(&nodes, 0, 2);
1236         let chan_1_3 = create_announced_chan_between_nodes(&nodes, 1, 3);
1237         let chan_2_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
1238
1239         let amt_msat = 15_000_000;
1240         let (keysend_preimage, _, payment_secret) = get_payment_preimage_hash(&nodes[3], None, None);
1241         let route_params = {
1242                 let pay_params = PaymentParameters::blinded(
1243                         vec![
1244                                 blinded_payment_path(payment_secret, 1, 1_0000_0000,
1245                                         vec![nodes[1].node.get_our_node_id(), nodes[3].node.get_our_node_id()], &[&chan_1_3.0.contents],
1246                                         &chanmon_cfgs[3].keys_manager
1247                                 ),
1248                                 blinded_payment_path(payment_secret, 1, 1_0000_0000,
1249                                         vec![nodes[2].node.get_our_node_id(), nodes[3].node.get_our_node_id()], &[&chan_2_3.0.contents],
1250                                         &chanmon_cfgs[3].keys_manager
1251                                 ),
1252                         ]
1253                 )
1254                         .with_bolt12_features(channelmanager::provided_bolt12_invoice_features(&UserConfig::default()))
1255                         .unwrap();
1256                 RouteParameters::from_payment_params_and_value(pay_params, amt_msat)
1257         };
1258
1259         let payment_hash = nodes[0].node.send_spontaneous_payment_with_retry(Some(keysend_preimage), RecipientOnionFields::spontaneous_empty(), PaymentId(keysend_preimage.0), route_params, Retry::Attempts(0)).unwrap();
1260         check_added_monitors!(nodes[0], 2);
1261
1262         let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]];
1263         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1264         assert_eq!(events.len(), 2);
1265
1266         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
1267         pass_along_path(&nodes[0], expected_route[0], amt_msat, payment_hash.clone(),
1268                 Some(payment_secret), ev.clone(), false, Some(keysend_preimage));
1269
1270         let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
1271         pass_along_path(&nodes[0], expected_route[1], amt_msat, payment_hash.clone(),
1272                 Some(payment_secret), ev.clone(), true, Some(keysend_preimage));
1273         claim_payment_along_route(&nodes[0], expected_route, false, keysend_preimage);
1274 }
1275
1276 #[test]
1277 fn custom_tlvs_to_blinded_path() {
1278         let chanmon_cfgs = create_chanmon_cfgs(2);
1279         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1280         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1281         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1282         let chan_upd = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0).0.contents;
1283
1284         let amt_msat = 5000;
1285         let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[1], Some(amt_msat), None);
1286         let payee_tlvs = ReceiveTlvs {
1287                 payment_secret,
1288                 payment_constraints: PaymentConstraints {
1289                         max_cltv_expiry: u32::max_value(),
1290                         htlc_minimum_msat: chan_upd.htlc_minimum_msat,
1291                 },
1292                 payment_context: PaymentContext::unknown(),
1293         };
1294         let mut secp_ctx = Secp256k1::new();
1295         let blinded_path = BlindedPath::one_hop_for_payment(
1296                 nodes[1].node.get_our_node_id(), payee_tlvs, TEST_FINAL_CLTV as u16,
1297                 &chanmon_cfgs[1].keys_manager, &secp_ctx
1298         ).unwrap();
1299
1300         let route_params = RouteParameters::from_payment_params_and_value(
1301                 PaymentParameters::blinded(vec![blinded_path]),
1302                 amt_msat,
1303         );
1304
1305         let recipient_onion_fields = RecipientOnionFields::spontaneous_empty()
1306                 .with_custom_tlvs(vec![((1 << 16) + 1, vec![42, 42])])
1307                 .unwrap();
1308         nodes[0].node.send_payment(payment_hash, recipient_onion_fields.clone(),
1309                 PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
1310         check_added_monitors(&nodes[0], 1);
1311
1312         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1313         assert_eq!(events.len(), 1);
1314         let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
1315
1316         let path = &[&nodes[1]];
1317         let args = PassAlongPathArgs::new(&nodes[0], path, amt_msat, payment_hash, ev)
1318                 .with_payment_secret(payment_secret)
1319                 .with_custom_tlvs(recipient_onion_fields.custom_tlvs.clone());
1320         do_pass_along_path(args);
1321         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
1322 }