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