1 // This file is Copyright its original authors, visible in version control
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
10 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
11 use crate::blinded_path::BlindedPath;
12 use crate::blinded_path::payment::{ForwardNode, ForwardTlvs, PaymentConstraints, PaymentRelay, ReceiveTlvs};
13 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PaymentFailureReason};
14 use crate::ln::PaymentSecret;
15 use crate::ln::channelmanager;
16 use crate::ln::channelmanager::{PaymentId, RecipientOnionFields};
17 use crate::ln::features::BlindedHopFeatures;
18 use crate::ln::functional_test_utils::*;
20 use crate::ln::msgs::ChannelMessageHandler;
21 use crate::ln::onion_utils;
22 use crate::ln::onion_utils::INVALID_ONION_BLINDING;
23 use crate::ln::outbound_payment::Retry;
24 use crate::offers::invoice::BlindedPayInfo;
25 use crate::prelude::*;
26 use crate::routing::router::{Payee, PaymentParameters, RouteParameters};
27 use crate::util::config::UserConfig;
28 use crate::util::test_utils;
30 fn blinded_payment_path(
31 payment_secret: PaymentSecret, node_ids: Vec<PublicKey>,
32 channel_upds: &[&msgs::UnsignedChannelUpdate], keys_manager: &test_utils::TestKeysInterface
33 ) -> (BlindedPayInfo, BlindedPath) {
34 let mut intermediate_nodes = Vec::new();
35 for (node_id, chan_upd) in node_ids.iter().zip(channel_upds) {
36 intermediate_nodes.push(ForwardNode {
39 short_channel_id: chan_upd.short_channel_id,
40 payment_relay: PaymentRelay {
41 cltv_expiry_delta: chan_upd.cltv_expiry_delta,
42 fee_proportional_millionths: chan_upd.fee_proportional_millionths,
43 fee_base_msat: chan_upd.fee_base_msat,
45 payment_constraints: PaymentConstraints {
46 max_cltv_expiry: u32::max_value(),
47 htlc_minimum_msat: chan_upd.htlc_minimum_msat,
49 features: BlindedHopFeatures::empty(),
51 htlc_maximum_msat: chan_upd.htlc_maximum_msat,
54 let payee_tlvs = ReceiveTlvs {
56 payment_constraints: PaymentConstraints {
57 max_cltv_expiry: u32::max_value(),
58 htlc_minimum_msat: channel_upds.last().unwrap().htlc_minimum_msat,
61 let mut secp_ctx = Secp256k1::new();
62 BlindedPath::new_for_payment(
63 &intermediate_nodes[..], *node_ids.last().unwrap(), payee_tlvs,
64 channel_upds.last().unwrap().htlc_maximum_msat, TEST_FINAL_CLTV as u16, keys_manager, &secp_ctx
68 pub fn get_blinded_route_parameters(
69 amt_msat: u64, payment_secret: PaymentSecret, node_ids: Vec<PublicKey>,
70 channel_upds: &[&msgs::UnsignedChannelUpdate], keys_manager: &test_utils::TestKeysInterface
71 ) -> RouteParameters {
72 RouteParameters::from_payment_params_and_value(
73 PaymentParameters::blinded(vec![
74 blinded_payment_path(payment_secret, node_ids, channel_upds, keys_manager)
80 fn one_hop_blinded_path() {
81 do_one_hop_blinded_path(true);
82 do_one_hop_blinded_path(false);
85 fn do_one_hop_blinded_path(success: bool) {
86 let chanmon_cfgs = create_chanmon_cfgs(2);
87 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
88 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
89 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
90 let chan_upd = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0).0.contents;
93 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[1], Some(amt_msat), None);
94 let payee_tlvs = ReceiveTlvs {
96 payment_constraints: PaymentConstraints {
97 max_cltv_expiry: u32::max_value(),
98 htlc_minimum_msat: chan_upd.htlc_minimum_msat,
101 let mut secp_ctx = Secp256k1::new();
102 let blinded_path = BlindedPath::one_hop_for_payment(
103 nodes[1].node.get_our_node_id(), payee_tlvs, TEST_FINAL_CLTV as u16,
104 &chanmon_cfgs[1].keys_manager, &secp_ctx
107 let route_params = RouteParameters::from_payment_params_and_value(
108 PaymentParameters::blinded(vec![blinded_path]),
111 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(),
112 PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
113 check_added_monitors(&nodes[0], 1);
114 pass_along_route(&nodes[0], &[&[&nodes[1]]], amt_msat, payment_hash, payment_secret);
116 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
118 fail_payment(&nodes[0], &[&nodes[1]], payment_hash);
123 fn mpp_to_one_hop_blinded_path() {
124 let chanmon_cfgs = create_chanmon_cfgs(4);
125 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
126 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
127 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
128 let mut secp_ctx = Secp256k1::new();
130 create_announced_chan_between_nodes(&nodes, 0, 1);
131 create_announced_chan_between_nodes(&nodes, 0, 2);
132 let chan_upd_1_3 = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents;
133 create_announced_chan_between_nodes(&nodes, 2, 3).0.contents;
135 let amt_msat = 15_000_000;
136 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[3], Some(amt_msat), None);
137 let payee_tlvs = ReceiveTlvs {
139 payment_constraints: PaymentConstraints {
140 max_cltv_expiry: u32::max_value(),
141 htlc_minimum_msat: chan_upd_1_3.htlc_minimum_msat,
144 let blinded_path = BlindedPath::one_hop_for_payment(
145 nodes[3].node.get_our_node_id(), payee_tlvs, TEST_FINAL_CLTV as u16,
146 &chanmon_cfgs[3].keys_manager, &secp_ctx
149 let bolt12_features =
150 channelmanager::provided_bolt12_invoice_features(&UserConfig::default());
151 let route_params = RouteParameters::from_payment_params_and_value(
152 PaymentParameters::blinded(vec![blinded_path]).with_bolt12_features(bolt12_features).unwrap(),
155 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
156 check_added_monitors(&nodes[0], 2);
158 let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]];
159 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
160 assert_eq!(events.len(), 2);
162 let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
163 pass_along_path(&nodes[0], expected_route[0], amt_msat, payment_hash.clone(),
164 Some(payment_secret), ev.clone(), false, None);
166 let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
167 pass_along_path(&nodes[0], expected_route[1], amt_msat, payment_hash.clone(),
168 Some(payment_secret), ev.clone(), true, None);
169 claim_payment_along_route(&nodes[0], expected_route, false, payment_preimage);
173 fn mpp_to_three_hop_blinded_paths() {
174 let chanmon_cfgs = create_chanmon_cfgs(6);
175 let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
176 let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
177 let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
179 // Create this network topology so node 0 MPP's over 2 3-hop blinded paths:
185 create_announced_chan_between_nodes(&nodes, 0, 1);
186 create_announced_chan_between_nodes(&nodes, 0, 2);
187 let chan_upd_1_3 = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents;
188 let chan_upd_2_4 = create_announced_chan_between_nodes(&nodes, 2, 4).0.contents;
189 let chan_upd_3_5 = create_announced_chan_between_nodes(&nodes, 3, 5).0.contents;
190 let chan_upd_4_5 = create_announced_chan_between_nodes(&nodes, 4, 5).0.contents;
192 let amt_msat = 15_000_000;
193 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[5], Some(amt_msat), None);
195 let path_1_params = get_blinded_route_parameters(
196 amt_msat, payment_secret, vec![
197 nodes[1].node.get_our_node_id(), nodes[3].node.get_our_node_id(),
198 nodes[5].node.get_our_node_id()
199 ], &[&chan_upd_1_3, &chan_upd_3_5], &chanmon_cfgs[5].keys_manager
201 let path_2_params = get_blinded_route_parameters(
202 amt_msat, payment_secret, vec![
203 nodes[2].node.get_our_node_id(), nodes[4].node.get_our_node_id(),
204 nodes[5].node.get_our_node_id()
205 ], &[&chan_upd_2_4, &chan_upd_4_5], &chanmon_cfgs[5].keys_manager
207 let pay_params = PaymentParameters::blinded(
209 path_1_params.payment_params.payee.blinded_route_hints()[0].clone(),
210 path_2_params.payment_params.payee.blinded_route_hints()[0].clone()
213 .with_bolt12_features(channelmanager::provided_bolt12_invoice_features(&UserConfig::default()))
215 RouteParameters::from_payment_params_and_value(pay_params, amt_msat)
218 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(),
219 PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
220 check_added_monitors(&nodes[0], 2);
222 let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[3], &nodes[5]], &[&nodes[2], &nodes[4], &nodes[5]]];
223 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
224 assert_eq!(events.len(), 2);
226 let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
227 pass_along_path(&nodes[0], expected_route[0], amt_msat, payment_hash.clone(),
228 Some(payment_secret), ev.clone(), false, None);
230 let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
231 pass_along_path(&nodes[0], expected_route[1], amt_msat, payment_hash.clone(),
232 Some(payment_secret), ev.clone(), true, None);
233 claim_payment_along_route(&nodes[0], expected_route, false, payment_preimage);
236 enum ForwardCheckFail {
237 // Fail a check on the inbound onion payload. In this case, we underflow when calculating the
238 // outgoing cltv_expiry.
240 // The forwarding node's payload is encoded as a receive, i.e. the next hop HMAC is [0; 32].
241 ForwardPayloadEncodedAsReceive,
242 // Fail a check on the outbound channel. In this case, our next-hop peer is offline.
243 OutboundChannelCheck,
247 fn forward_checks_failure() {
248 do_forward_checks_failure(ForwardCheckFail::InboundOnionCheck);
249 do_forward_checks_failure(ForwardCheckFail::ForwardPayloadEncodedAsReceive);
250 do_forward_checks_failure(ForwardCheckFail::OutboundChannelCheck);
253 fn do_forward_checks_failure(check: ForwardCheckFail) {
254 // Ensure we'll fail backwards properly if a forwarding check fails on initial update_add
256 let chanmon_cfgs = create_chanmon_cfgs(3);
257 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
258 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
259 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
260 // We need the session priv to construct a bogus onion packet later.
261 *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
262 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
263 let chan_upd_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0).0.contents;
266 let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
267 let route_params = get_blinded_route_parameters(amt_msat, payment_secret,
268 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2],
269 &chanmon_cfgs[2].keys_manager);
271 let route = get_route(&nodes[0], &route_params).unwrap();
272 node_cfgs[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
273 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
274 check_added_monitors(&nodes[0], 1);
276 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
277 assert_eq!(events.len(), 1);
278 let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
279 let mut payment_event = SendEvent::from_event(ev);
281 let mut update_add = &mut payment_event.msgs[0];
283 ForwardCheckFail::InboundOnionCheck => {
284 update_add.cltv_expiry = 10; // causes outbound CLTV expiry to underflow
286 ForwardCheckFail::ForwardPayloadEncodedAsReceive => {
287 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
288 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
289 let cur_height = nodes[0].best_block_info().1;
290 let (mut onion_payloads, ..) = onion_utils::build_onion_payloads(
291 &route.paths[0], amt_msat, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
292 // Remove the receive payload so the blinded forward payload is encoded as a final payload
293 // (i.e. next_hop_hmac == [0; 32])
294 onion_payloads.pop();
295 update_add.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
297 ForwardCheckFail::OutboundChannelCheck => {
298 // The intro node will see that the next-hop peer is disconnected and fail the HTLC backwards.
299 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
302 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
303 check_added_monitors!(nodes[1], 0);
304 do_commitment_signed_dance(&nodes[1], &nodes[0], &payment_event.commitment_msg, true, true);
306 let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
307 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
308 do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
309 expect_payment_failed_conditions(&nodes[0], payment_hash, false,
310 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
314 fn failed_backwards_to_intro_node() {
315 // Ensure the intro node will error backwards properly even if the downstream node did not blind
317 let chanmon_cfgs = create_chanmon_cfgs(3);
318 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
319 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
320 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
321 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
322 let chan_upd_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0).0.contents;
325 let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
326 let route_params = get_blinded_route_parameters(amt_msat, payment_secret,
327 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2],
328 &chanmon_cfgs[2].keys_manager);
330 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
331 check_added_monitors(&nodes[0], 1);
333 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
334 assert_eq!(events.len(), 1);
335 let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
336 let mut payment_event = SendEvent::from_event(ev);
338 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
339 check_added_monitors!(nodes[1], 0);
340 do_commitment_signed_dance(&nodes[1], &nodes[0], &payment_event.commitment_msg, false, false);
341 expect_pending_htlcs_forwardable!(nodes[1]);
342 check_added_monitors!(&nodes[1], 1);
344 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
345 assert_eq!(events.len(), 1);
346 let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
347 let mut payment_event = SendEvent::from_event(ev);
349 // Ensure the final node fails to handle the HTLC.
350 payment_event.msgs[0].onion_routing_packet.hop_data[0] ^= 1;
351 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
352 check_added_monitors!(nodes[2], 0);
353 do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event.commitment_msg, true, true);
354 nodes[2].node.process_pending_htlc_forwards();
356 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
357 let mut update_malformed = &mut updates.update_fail_malformed_htlcs[0];
358 // Check that the final node encodes its failure correctly.
359 assert_eq!(update_malformed.failure_code, INVALID_ONION_BLINDING);
360 assert_eq!(update_malformed.sha256_of_onion, [0; 32]);
362 // Modify such the final hop does not correctly blind their error so we can ensure the intro node
363 // converts it to the correct error.
364 update_malformed.sha256_of_onion = [1; 32];
365 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), update_malformed);
366 do_commitment_signed_dance(&nodes[1], &nodes[2], &updates.commitment_signed, true, false);
368 let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
369 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
370 do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
371 expect_payment_failed_conditions(&nodes[0], payment_hash, false,
372 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
375 enum ProcessPendingHTLCsCheck {
381 fn forward_fail_in_process_pending_htlc_fwds() {
382 do_forward_fail_in_process_pending_htlc_fwds(ProcessPendingHTLCsCheck::FwdPeerDisconnected);
383 do_forward_fail_in_process_pending_htlc_fwds(ProcessPendingHTLCsCheck::FwdChannelClosed);
385 fn do_forward_fail_in_process_pending_htlc_fwds(check: ProcessPendingHTLCsCheck) {
386 // Ensure the intro node will error backwards properly if the HTLC fails in
387 // process_pending_htlc_forwards.
388 let chanmon_cfgs = create_chanmon_cfgs(3);
389 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
390 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
391 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
392 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
393 let (chan_upd_1_2, channel_id) = {
394 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0);
395 (chan.0.contents, chan.2)
399 let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
400 let route_params = get_blinded_route_parameters(amt_msat, payment_secret,
401 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2],
402 &chanmon_cfgs[2].keys_manager);
404 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
405 check_added_monitors(&nodes[0], 1);
407 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
408 assert_eq!(events.len(), 1);
409 let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
410 let mut payment_event = SendEvent::from_event(ev);
412 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
413 check_added_monitors!(nodes[1], 0);
414 do_commitment_signed_dance(&nodes[1], &nodes[0], &payment_event.commitment_msg, false, false);
417 ProcessPendingHTLCsCheck::FwdPeerDisconnected => {
418 // Disconnect the next-hop peer so when we go to forward in process_pending_htlc_forwards, the
419 // intro node will error backwards.
420 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
421 expect_pending_htlcs_forwardable!(nodes[1]);
422 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1],
423 vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id }]);
425 ProcessPendingHTLCsCheck::FwdChannelClosed => {
426 // Force close the next-hop channel so when we go to forward in process_pending_htlc_forwards,
427 // the intro node will error backwards.
428 nodes[1].node.force_close_broadcasting_latest_txn(&channel_id, &nodes[2].node.get_our_node_id()).unwrap();
429 let events = nodes[1].node.get_and_clear_pending_events();
431 crate::events::Event::PendingHTLCsForwardable { .. } => {},
432 _ => panic!("Unexpected event {:?}", events),
435 crate::events::Event::ChannelClosed { .. } => {},
436 _ => panic!("Unexpected event {:?}", events),
439 nodes[1].node.process_pending_htlc_forwards();
440 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1],
441 vec![HTLCDestination::UnknownNextHop { requested_forward_scid: chan_upd_1_2.short_channel_id }]);
442 check_closed_broadcast(&nodes[1], 1, true);
443 check_added_monitors!(nodes[1], 1);
444 nodes[1].node.process_pending_htlc_forwards();
448 let mut updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
449 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
450 check_added_monitors!(nodes[1], 1);
451 do_commitment_signed_dance(&nodes[0], &nodes[1], &updates.commitment_signed, false, false);
453 expect_payment_failed_conditions(&nodes[0], payment_hash, false,
454 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
458 fn blinded_intercept_payment() {
459 do_blinded_intercept_payment(true);
460 do_blinded_intercept_payment(false);
462 fn do_blinded_intercept_payment(intercept_node_fails: bool) {
463 let chanmon_cfgs = create_chanmon_cfgs(3);
464 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
465 let mut intercept_forwards_config = test_default_channel_config();
466 intercept_forwards_config.accept_intercept_htlcs = true;
467 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(intercept_forwards_config), None]);
468 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
469 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
470 let (channel_id, chan_upd) = {
471 let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0);
472 (chan.2, chan.0.contents)
476 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
477 let intercept_scid = nodes[1].node.get_intercept_scid();
478 let mut intercept_chan_upd = chan_upd;
479 intercept_chan_upd.short_channel_id = intercept_scid;
480 let route_params = get_blinded_route_parameters(amt_msat, payment_secret,
481 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&intercept_chan_upd],
482 &chanmon_cfgs[2].keys_manager);
484 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(),
485 PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
486 check_added_monitors(&nodes[0], 1);
487 let payment_event = {
488 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
489 assert_eq!(events.len(), 1);
490 SendEvent::from_event(events.remove(0))
492 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
493 commitment_signed_dance!(nodes[1], nodes[0], &payment_event.commitment_msg, false, true);
495 let events = nodes[1].node.get_and_clear_pending_events();
496 assert_eq!(events.len(), 1);
497 let (intercept_id, expected_outbound_amount_msat) = match events[0] {
498 crate::events::Event::HTLCIntercepted {
499 intercept_id, payment_hash: pmt_hash,
500 requested_next_hop_scid: short_channel_id, expected_outbound_amount_msat, ..
502 assert_eq!(pmt_hash, payment_hash);
503 assert_eq!(short_channel_id, intercept_scid);
504 (intercept_id, expected_outbound_amount_msat)
509 if intercept_node_fails {
510 nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap();
511 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::UnknownNextHop { requested_forward_scid: intercept_scid }]);
512 nodes[1].node.process_pending_htlc_forwards();
513 let update_fail = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
514 check_added_monitors!(&nodes[1], 1);
515 assert!(update_fail.update_fail_htlcs.len() == 1);
516 let fail_msg = update_fail.update_fail_htlcs[0].clone();
517 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
518 commitment_signed_dance!(nodes[0], nodes[1], update_fail.commitment_signed, false);
519 expect_payment_failed_conditions(&nodes[0], payment_hash, false,
520 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
524 nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap();
525 expect_pending_htlcs_forwardable!(nodes[1]);
527 let payment_event = {
529 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
530 assert_eq!(added_monitors.len(), 1);
531 added_monitors.clear();
533 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
534 assert_eq!(events.len(), 1);
535 SendEvent::from_event(events.remove(0))
537 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
538 commitment_signed_dance!(nodes[2], nodes[1], &payment_event.commitment_msg, false, true);
539 expect_pending_htlcs_forwardable!(nodes[2]);
541 expect_payment_claimable!(&nodes[2], payment_hash, payment_secret, amt_msat, None, nodes[2].node.get_our_node_id());
542 do_claim_payment_along_route(&nodes[0], &vec!(&vec!(&nodes[1], &nodes[2])[..]), false, payment_preimage);
543 expect_payment_sent(&nodes[0], payment_preimage, Some(Some(1000)), true, true);
547 fn two_hop_blinded_path_success() {
548 let chanmon_cfgs = create_chanmon_cfgs(3);
549 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
550 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
551 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
552 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
553 let chan_upd_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0).0.contents;
556 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), None);
557 let route_params = get_blinded_route_parameters(amt_msat, payment_secret,
558 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2],
559 &chanmon_cfgs[2].keys_manager);
561 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
562 check_added_monitors(&nodes[0], 1);
563 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], amt_msat, payment_hash, payment_secret);
564 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
568 fn three_hop_blinded_path_success() {
569 let chanmon_cfgs = create_chanmon_cfgs(5);
570 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
571 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
572 let mut nodes = create_network(5, &node_cfgs, &node_chanmgrs);
573 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
574 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0);
575 let chan_upd_2_3 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0).0.contents;
576 let chan_upd_3_4 = create_announced_chan_between_nodes_with_value(&nodes, 3, 4, 1_000_000, 0).0.contents;
578 // Get all our nodes onto the same height so payments don't fail for CLTV violations.
579 connect_blocks(&nodes[0], nodes[4].best_block_info().1 - nodes[0].best_block_info().1);
580 connect_blocks(&nodes[1], nodes[4].best_block_info().1 - nodes[1].best_block_info().1);
581 connect_blocks(&nodes[2], nodes[4].best_block_info().1 - nodes[2].best_block_info().1);
582 assert_eq!(nodes[4].best_block_info().1, nodes[3].best_block_info().1);
585 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[4], Some(amt_msat), None);
586 let route_params = get_blinded_route_parameters(amt_msat, payment_secret,
587 nodes.iter().skip(2).map(|n| n.node.get_our_node_id()).collect(),
588 &[&chan_upd_2_3, &chan_upd_3_4], &chanmon_cfgs[4].keys_manager);
590 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
591 check_added_monitors(&nodes[0], 1);
592 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2], &nodes[3], &nodes[4]]], amt_msat, payment_hash, payment_secret);
593 claim_payment(&nodes[0], &[&nodes[1], &nodes[2], &nodes[3], &nodes[4]], payment_preimage);
597 enum ReceiveCheckFail {
598 // The recipient fails the payment upon `PaymentClaimable`.
600 // Failure to decode the recipient's onion payload.
602 // The incoming HTLC did not satisfy our requirements; in this case it underpaid us according to
603 // the expected receive amount in the onion.
605 // The incoming HTLC errors when added to the Channel, in this case due to the HTLC being
606 // delivered out-of-order with a shutdown message.
608 // The HTLC is successfully added to the inbound channel but fails receive checks in
609 // process_pending_htlc_forwards.
610 ProcessPendingHTLCsCheck,
611 // The HTLC violates the `PaymentConstraints` contained within the receiver's encrypted payload.
616 fn multi_hop_receiver_fail() {
617 do_multi_hop_receiver_fail(ReceiveCheckFail::RecipientFail);
618 do_multi_hop_receiver_fail(ReceiveCheckFail::OnionDecodeFail);
619 do_multi_hop_receiver_fail(ReceiveCheckFail::ReceiveRequirements);
620 do_multi_hop_receiver_fail(ReceiveCheckFail::ChannelCheck);
621 do_multi_hop_receiver_fail(ReceiveCheckFail::ProcessPendingHTLCsCheck);
622 do_multi_hop_receiver_fail(ReceiveCheckFail::PaymentConstraints);
625 fn do_multi_hop_receiver_fail(check: ReceiveCheckFail) {
626 // Test that the receiver to a multihop blinded path fails back correctly.
627 let chanmon_cfgs = create_chanmon_cfgs(3);
628 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
629 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
630 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
631 // We need the session priv to construct an invalid onion packet later.
632 let session_priv = [3; 32];
633 *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
634 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
635 let (chan_upd_1_2, chan_id_1_2) = {
636 let (chan_upd, _, channel_id, ..) = create_announced_chan_between_nodes_with_value(
637 &nodes, 1, 2, 1_000_000, 0
639 (chan_upd.contents, channel_id)
643 let excess_final_cltv_delta_opt = if check == ReceiveCheckFail::ProcessPendingHTLCsCheck {
644 // Set the final CLTV expiry too low to trigger the failure in process_pending_htlc_forwards.
645 Some(TEST_FINAL_CLTV as u16 - 2)
647 let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[2], Some(amt_msat), excess_final_cltv_delta_opt);
648 let mut route_params = get_blinded_route_parameters(amt_msat, payment_secret,
649 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&chan_upd_1_2],
650 &chanmon_cfgs[2].keys_manager);
652 let route = if check == ReceiveCheckFail::ProcessPendingHTLCsCheck {
653 let mut route = get_route(&nodes[0], &route_params).unwrap();
654 // Set the final CLTV expiry too low to trigger the failure in process_pending_htlc_forwards.
655 route.paths[0].hops.last_mut().map(|h| h.cltv_expiry_delta += excess_final_cltv_delta_opt.unwrap() as u32);
656 route.paths[0].blinded_tail.as_mut().map(|bt| bt.excess_final_cltv_expiry_delta = excess_final_cltv_delta_opt.unwrap() as u32);
658 } else if check == ReceiveCheckFail::PaymentConstraints {
659 // Create a blinded path where the receiver's encrypted payload has an htlc_minimum_msat that is
660 // violated by `amt_msat`, and stick it in the route_params without changing the corresponding
661 // BlindedPayInfo (to ensure pathfinding still succeeds).
662 let high_htlc_min_bp = {
663 let mut high_htlc_minimum_upd = chan_upd_1_2.clone();
664 high_htlc_minimum_upd.htlc_minimum_msat = amt_msat + 1000;
665 let high_htlc_min_params = get_blinded_route_parameters(amt_msat, payment_secret,
666 nodes.iter().skip(1).map(|n| n.node.get_our_node_id()).collect(), &[&high_htlc_minimum_upd],
667 &chanmon_cfgs[2].keys_manager);
668 if let Payee::Blinded { route_hints, .. } = high_htlc_min_params.payment_params.payee {
669 route_hints[0].1.clone()
672 if let Payee::Blinded { ref mut route_hints, .. } = route_params.payment_params.payee {
673 route_hints[0].1 = high_htlc_min_bp;
675 find_route(&nodes[0], &route_params).unwrap()
677 find_route(&nodes[0], &route_params).unwrap()
679 node_cfgs[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
680 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
681 check_added_monitors(&nodes[0], 1);
683 let mut payment_event_0_1 = {
684 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
685 assert_eq!(events.len(), 1);
686 let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
687 SendEvent::from_event(ev)
689 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_0_1.msgs[0]);
690 check_added_monitors!(nodes[1], 0);
691 do_commitment_signed_dance(&nodes[1], &nodes[0], &payment_event_0_1.commitment_msg, false, false);
692 expect_pending_htlcs_forwardable!(nodes[1]);
693 check_added_monitors!(&nodes[1], 1);
695 let mut payment_event_1_2 = {
696 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
697 assert_eq!(events.len(), 1);
698 let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
699 SendEvent::from_event(ev)
703 ReceiveCheckFail::RecipientFail => {
704 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_1_2.msgs[0]);
705 check_added_monitors!(nodes[2], 0);
706 do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
707 expect_pending_htlcs_forwardable!(nodes[2]);
708 check_payment_claimable(
709 &nodes[2].node.get_and_clear_pending_events()[0], payment_hash, payment_secret, amt_msat,
710 None, nodes[2].node.get_our_node_id()
712 nodes[2].node.fail_htlc_backwards(&payment_hash);
713 expect_pending_htlcs_forwardable_conditions(
714 nodes[2].node.get_and_clear_pending_events(), &[HTLCDestination::FailedPayment { payment_hash }]
716 nodes[2].node.process_pending_htlc_forwards();
717 check_added_monitors!(nodes[2], 1);
719 ReceiveCheckFail::OnionDecodeFail => {
720 let session_priv = SecretKey::from_slice(&session_priv).unwrap();
721 let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
722 let cur_height = nodes[0].best_block_info().1;
723 let (mut onion_payloads, ..) = onion_utils::build_onion_payloads(
724 &route.paths[0], amt_msat, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
726 let update_add = &mut payment_event_1_2.msgs[0];
727 onion_payloads.last_mut().map(|p| {
728 if let msgs::OutboundOnionPayload::BlindedReceive { ref mut intro_node_blinding_point, .. } = p {
729 // The receiver should error if both the update_add blinding_point and the
730 // intro_node_blinding_point are set.
731 assert!(intro_node_blinding_point.is_none() && update_add.blinding_point.is_some());
732 *intro_node_blinding_point = Some(PublicKey::from_slice(&[2; 33]).unwrap());
735 update_add.onion_routing_packet = onion_utils::construct_onion_packet(
736 vec![onion_payloads.pop().unwrap()], vec![onion_keys.pop().unwrap()], [0; 32],
739 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update_add);
740 check_added_monitors!(nodes[2], 0);
741 do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
743 ReceiveCheckFail::ReceiveRequirements => {
744 let update_add = &mut payment_event_1_2.msgs[0];
745 update_add.amount_msat -= 1;
746 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update_add);
747 check_added_monitors!(nodes[2], 0);
748 do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
750 ReceiveCheckFail::ChannelCheck => {
751 nodes[2].node.close_channel(&chan_id_1_2, &nodes[1].node.get_our_node_id()).unwrap();
752 let node_2_shutdown = get_event_msg!(nodes[2], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
753 nodes[1].node.handle_shutdown(&nodes[2].node.get_our_node_id(), &node_2_shutdown);
754 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
756 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_1_2.msgs[0]);
757 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event_1_2.commitment_msg);
758 check_added_monitors!(nodes[2], 1);
760 nodes[2].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
761 commitment_signed_dance!(nodes[2], nodes[1], (), false, true, false, false);
763 ReceiveCheckFail::ProcessPendingHTLCsCheck => {
764 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);
765 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_1_2.msgs[0]);
766 check_added_monitors!(nodes[2], 0);
767 do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
768 expect_pending_htlcs_forwardable!(nodes[2]);
769 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[2],
770 vec![HTLCDestination::FailedPayment { payment_hash }]);
771 check_added_monitors!(nodes[2], 1);
773 ReceiveCheckFail::PaymentConstraints => {
774 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_1_2.msgs[0]);
775 check_added_monitors!(nodes[2], 0);
776 do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event_1_2.commitment_msg, true, true);
780 let updates_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
781 assert_eq!(updates_2_1.update_fail_malformed_htlcs.len(), 1);
782 let update_malformed = &updates_2_1.update_fail_malformed_htlcs[0];
783 assert_eq!(update_malformed.sha256_of_onion, [0; 32]);
784 assert_eq!(update_malformed.failure_code, INVALID_ONION_BLINDING);
785 nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), update_malformed);
786 do_commitment_signed_dance(&nodes[1], &nodes[2], &updates_2_1.commitment_signed, true, false);
788 let updates_1_0 = if check == ReceiveCheckFail::ChannelCheck {
789 let events = nodes[1].node.get_and_clear_pending_msg_events();
790 assert_eq!(events.len(), 2);
791 events.into_iter().find_map(|ev| {
793 MessageSendEvent:: UpdateHTLCs { node_id, updates } => {
794 assert_eq!(node_id, nodes[0].node.get_our_node_id());
797 MessageSendEvent::SendClosingSigned { .. } => None,
801 } else { get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id()) };
802 assert_eq!(updates_1_0.update_fail_htlcs.len(), 1);
803 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_1_0.update_fail_htlcs[0]);
804 do_commitment_signed_dance(&nodes[0], &nodes[1], &updates_1_0.commitment_signed, false, false);
805 expect_payment_failed_conditions(&nodes[0], payment_hash, false,
806 PaymentFailedConditions::new().expected_htlc_error_data(INVALID_ONION_BLINDING, &[0; 32]));
810 fn blinded_path_retries() {
811 let chanmon_cfgs = create_chanmon_cfgs(4);
812 // Make one blinded path's fees slightly higher so they are tried in a deterministic order.
813 let mut higher_fee_chan_cfg = test_default_channel_config();
814 higher_fee_chan_cfg.channel_config.forwarding_fee_base_msat += 1;
815 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
816 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, Some(higher_fee_chan_cfg), None]);
817 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
819 // Create this network topology so nodes[0] has a blinded route hint to retry over.
825 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
826 create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0);
827 let chan_1_3 = create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 1_000_000, 0);
828 let chan_2_3 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0);
831 let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[3], Some(amt_msat), None);
833 let pay_params = PaymentParameters::blinded(
835 blinded_payment_path(payment_secret,
836 vec![nodes[1].node.get_our_node_id(), nodes[3].node.get_our_node_id()], &[&chan_1_3.0.contents],
837 &chanmon_cfgs[3].keys_manager
839 blinded_payment_path(payment_secret,
840 vec![nodes[2].node.get_our_node_id(), nodes[3].node.get_our_node_id()], &[&chan_2_3.0.contents],
841 &chanmon_cfgs[3].keys_manager
845 .with_bolt12_features(channelmanager::provided_bolt12_invoice_features(&UserConfig::default()))
847 RouteParameters::from_payment_params_and_value(pay_params, amt_msat)
850 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params.clone(), Retry::Attempts(2)).unwrap();
851 check_added_monitors(&nodes[0], 1);
852 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]]], amt_msat, payment_hash, payment_secret);
854 macro_rules! fail_payment_back {
855 ($intro_node: expr) => {
856 nodes[3].node.fail_htlc_backwards(&payment_hash);
857 expect_pending_htlcs_forwardable_conditions(
858 nodes[3].node.get_and_clear_pending_events(), &[HTLCDestination::FailedPayment { payment_hash }]
860 nodes[3].node.process_pending_htlc_forwards();
861 check_added_monitors!(nodes[3], 1);
863 let updates = get_htlc_update_msgs!(nodes[3], $intro_node.node.get_our_node_id());
864 assert_eq!(updates.update_fail_malformed_htlcs.len(), 1);
865 let update_malformed = &updates.update_fail_malformed_htlcs[0];
866 assert_eq!(update_malformed.sha256_of_onion, [0; 32]);
867 assert_eq!(update_malformed.failure_code, INVALID_ONION_BLINDING);
868 $intro_node.node.handle_update_fail_malformed_htlc(&nodes[3].node.get_our_node_id(), update_malformed);
869 do_commitment_signed_dance(&$intro_node, &nodes[3], &updates.commitment_signed, true, false);
871 let updates = get_htlc_update_msgs!($intro_node, nodes[0].node.get_our_node_id());
872 assert_eq!(updates.update_fail_htlcs.len(), 1);
873 nodes[0].node.handle_update_fail_htlc(&$intro_node.node.get_our_node_id(), &updates.update_fail_htlcs[0]);
874 do_commitment_signed_dance(&nodes[0], &$intro_node, &updates.commitment_signed, false, false);
876 let mut events = nodes[0].node.get_and_clear_pending_events();
877 assert_eq!(events.len(), 2);
879 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently, .. } => {
880 assert_eq!(payment_hash, ev_payment_hash);
881 assert_eq!(payment_failed_permanently, false);
883 _ => panic!("Unexpected event"),
886 Event::PendingHTLCsForwardable { .. } => {},
887 _ => panic!("Unexpected event"),
889 nodes[0].node.process_pending_htlc_forwards();
893 fail_payment_back!(nodes[1]);
895 // Pass the retry along.
896 check_added_monitors!(nodes[0], 1);
897 let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
898 assert_eq!(msg_events.len(), 1);
899 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], amt_msat, payment_hash, Some(payment_secret), msg_events.pop().unwrap(), true, None);
901 fail_payment_back!(nodes[2]);
902 let evs = nodes[0].node.get_and_clear_pending_events();
903 assert_eq!(evs.len(), 1);
905 Event::PaymentFailed { payment_hash: ev_payment_hash, reason, .. } => {
906 assert_eq!(ev_payment_hash, payment_hash);
907 // We have 1 retry attempt remaining, but we're out of blinded paths to try.
908 assert_eq!(reason, Some(PaymentFailureReason::RouteNotFound));