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 //! Tests of the onion error messages/codes which are returned when routing a payment fails.
11 //! These tests work by standing up full nodes and route payments across the network, checking the
12 //! returned errors decode to the correct thing.
14 use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
15 use crate::chain::keysinterface::{KeysInterface, Recipient};
16 use crate::ln::{PaymentHash, PaymentSecret};
17 use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
18 use crate::ln::channelmanager::{self, HTLCForwardInfo, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId};
19 use crate::ln::onion_utils;
20 use crate::routing::gossip::{NetworkUpdate, RoutingFees};
21 use crate::routing::router::{get_route, PaymentParameters, Route, RouteHint, RouteHintHop};
22 use crate::ln::features::{InitFeatures, InvoiceFeatures};
24 use crate::ln::msgs::{ChannelMessageHandler, ChannelUpdate};
25 use crate::ln::wire::Encode;
26 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider};
27 use crate::util::ser::{Writeable, Writer};
28 use crate::util::{byte_utils, test_utils};
29 use crate::util::config::{UserConfig, ChannelConfig};
30 use crate::util::errors::APIError;
32 use bitcoin::hash_types::BlockHash;
34 use bitcoin::hashes::Hash;
35 use bitcoin::hashes::sha256::Hash as Sha256;
37 use bitcoin::secp256k1;
38 use bitcoin::secp256k1::Secp256k1;
39 use bitcoin::secp256k1::{PublicKey, SecretKey};
42 use crate::prelude::*;
43 use core::default::Default;
45 use crate::ln::functional_test_utils::*;
47 fn run_onion_failure_test<F1,F2>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, payment_secret: &PaymentSecret, callback_msg: F1, callback_node: F2, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<NetworkUpdate>, expected_short_channel_id: Option<u64>)
48 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
51 run_onion_failure_test_with_fail_intercept(_name, test_case, nodes, route, payment_hash, payment_secret, callback_msg, |_|{}, callback_node, expected_retryable, expected_error_code, expected_channel_update, expected_short_channel_id);
55 // 0: node1 fails backward
56 // 1: final node fails backward
57 // 2: payment completed but the user rejects the payment
58 // 3: final node fails backward (but tamper onion payloads from node0)
59 // 100: trigger error in the intermediate node and tamper returning fail_htlc
60 // 200: trigger error in the final node and tamper returning fail_htlc
61 fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, payment_secret: &PaymentSecret, mut callback_msg: F1, mut callback_fail: F2, mut callback_node: F3, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<NetworkUpdate>, expected_short_channel_id: Option<u64>)
62 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
63 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
66 macro_rules! expect_event {
67 ($node: expr, $event_type: path) => {{
68 let events = $node.node.get_and_clear_pending_events();
69 assert_eq!(events.len(), 1);
71 $event_type { .. } => {},
72 _ => panic!("Unexpected event"),
77 macro_rules! expect_htlc_forward {
79 expect_event!($node, Event::PendingHTLCsForwardable);
80 $node.node.process_pending_htlc_forwards();
84 // 0 ~~> 2 send payment
85 let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
86 nodes[0].node.send_payment(&route, *payment_hash, &Some(*payment_secret), payment_id).unwrap();
87 check_added_monitors!(nodes[0], 1);
88 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
89 // temper update_add (0 => 1)
90 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
91 if test_case == 0 || test_case == 3 || test_case == 100 {
92 callback_msg(&mut update_add_0);
95 // 0 => 1 update_add & CS
96 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
97 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
99 let update_1_0 = match test_case {
100 0|100 => { // intermediate node failure; fail backward to 0
101 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
102 assert!(update_1_0.update_fail_htlcs.len()+update_1_0.update_fail_malformed_htlcs.len()==1 && (update_1_0.update_fail_htlcs.len()==1 || update_1_0.update_fail_malformed_htlcs.len()==1));
105 1|2|3|200 => { // final node failure; forwarding to 2
106 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
108 if test_case != 200 {
111 expect_htlc_forward!(&nodes[1]);
113 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
114 check_added_monitors!(&nodes[1], 1);
115 assert_eq!(update_1.update_add_htlcs.len(), 1);
116 // tamper update_add (1 => 2)
117 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
118 if test_case != 3 && test_case != 200 {
119 callback_msg(&mut update_add_1);
123 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
124 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
126 if test_case == 2 || test_case == 200 {
127 expect_htlc_forward!(&nodes[2]);
128 expect_event!(&nodes[2], Event::PaymentReceived);
130 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
133 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
134 if test_case == 2 || test_case == 200 {
135 check_added_monitors!(&nodes[2], 1);
137 assert!(update_2_1.update_fail_htlcs.len() == 1);
139 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
140 if test_case == 200 {
141 callback_fail(&mut fail_msg);
145 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
146 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
148 // backward fail on 1
149 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
150 assert!(update_1_0.update_fail_htlcs.len() == 1);
156 // 1 => 0 commitment_signed_dance
157 if update_1_0.update_fail_htlcs.len() > 0 {
158 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
159 if test_case == 100 {
160 callback_fail(&mut fail_msg);
162 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
164 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
167 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
169 let events = nodes[0].node.get_and_clear_pending_events();
170 assert_eq!(events.len(), 1);
171 if let &Event::PaymentPathFailed { ref payment_failed_permanently, ref network_update, ref all_paths_failed, ref short_channel_id, ref error_code, .. } = &events[0] {
172 assert_eq!(*payment_failed_permanently, !expected_retryable);
173 assert_eq!(*all_paths_failed, true);
174 assert_eq!(*error_code, expected_error_code);
175 if expected_channel_update.is_some() {
176 match network_update {
177 Some(update) => match update {
178 &NetworkUpdate::ChannelUpdateMessage { .. } => {
179 if let NetworkUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
180 panic!("channel_update not found!");
183 &NetworkUpdate::ChannelFailure { ref short_channel_id, ref is_permanent } => {
184 if let NetworkUpdate::ChannelFailure { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
185 assert!(*short_channel_id == *expected_short_channel_id);
186 assert!(*is_permanent == *expected_is_permanent);
188 panic!("Unexpected message event");
191 &NetworkUpdate::NodeFailure { ref node_id, ref is_permanent } => {
192 if let NetworkUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
193 assert!(*node_id == *expected_node_id);
194 assert!(*is_permanent == *expected_is_permanent);
196 panic!("Unexpected message event");
200 None => panic!("Expected channel update"),
203 assert!(network_update.is_none());
205 if let Some(expected_short_channel_id) = expected_short_channel_id {
206 match short_channel_id {
207 Some(short_channel_id) => assert_eq!(*short_channel_id, expected_short_channel_id),
208 None => panic!("Expected short channel id"),
211 assert!(short_channel_id.is_none());
214 panic!("Unexpected event");
216 nodes[0].node.abandon_payment(payment_id);
217 let events = nodes[0].node.get_and_clear_pending_events();
218 assert_eq!(events.len(), 1);
220 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id } => {
221 assert_eq!(*payment_hash, ev_payment_hash);
222 assert_eq!(payment_id, ev_payment_id);
224 _ => panic!("Unexpected second event"),
228 impl msgs::ChannelUpdate {
229 fn dummy(short_channel_id: u64) -> msgs::ChannelUpdate {
230 use bitcoin::secp256k1::ffi::Signature as FFISignature;
231 use bitcoin::secp256k1::ecdsa::Signature;
232 msgs::ChannelUpdate {
233 signature: Signature::from(unsafe { FFISignature::new() }),
234 contents: msgs::UnsignedChannelUpdate {
235 chain_hash: BlockHash::hash(&vec![0u8][..]),
239 cltv_expiry_delta: 0,
240 htlc_minimum_msat: 0,
241 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
243 fee_proportional_millionths: 0,
250 struct BogusOnionHopData {
253 impl BogusOnionHopData {
254 fn new(orig: msgs::OnionHopData) -> Self {
255 Self { data: orig.encode() }
258 impl Writeable for BogusOnionHopData {
259 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
260 writer.write_all(&self.data[..])
264 const BADONION: u16 = 0x8000;
265 const PERM: u16 = 0x4000;
266 const NODE: u16 = 0x2000;
267 const UPDATE: u16 = 0x1000;
270 fn test_fee_failures() {
271 // Tests that the fee required when forwarding remains consistent over time. This was
272 // previously broken, with forwarding fees floating based on the fee estimator at the time of
275 // When this test was written, the default base fee floated based on the HTLC count.
276 // It is now fixed, so we simply set the fee to the expected value here.
277 let mut config = test_default_channel_config();
278 config.channel_config.forwarding_fee_base_msat = 196;
280 let chanmon_cfgs = create_chanmon_cfgs(3);
281 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
282 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
283 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
284 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()), create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features())];
287 let (route, payment_hash_success, payment_preimage_success, payment_secret_success) = get_route_and_payment_hash!(nodes[0], nodes[2], 40_000);
288 nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
289 check_added_monitors!(nodes[0], 1);
290 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
291 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
293 // If the hop gives fee_insufficient but enough fees were provided, then the previous hop
294 // malleated the payment before forwarding, taking funds when they shouldn't have.
295 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
296 let short_channel_id = channels[0].0.contents.short_channel_id;
297 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
298 msg.amount_msat -= 1;
299 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
301 // In an earlier version, we spuriously failed to forward payments if the expected feerate
302 // changed between the channel open and the payment.
304 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
308 let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
309 nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
310 check_added_monitors!(nodes[0], 1);
311 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
312 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
316 fn test_onion_failure() {
317 // When we check for amount_below_minimum below, we want to test that we're using the *right*
318 // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
319 // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
320 // This exposed a previous bug because we were using the wrong value all the way down in
321 // Channel::get_counterparty_htlc_minimum_msat().
322 let mut node_2_cfg: UserConfig = Default::default();
323 node_2_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
324 node_2_cfg.channel_handshake_config.announced_channel = true;
325 node_2_cfg.channel_handshake_limits.force_announced_channel_preference = false;
327 // When this test was written, the default base fee floated based on the HTLC count.
328 // It is now fixed, so we simply set the fee to the expected value here.
329 let mut config = test_default_channel_config();
330 config.channel_config.forwarding_fee_base_msat = 196;
332 let chanmon_cfgs = create_chanmon_cfgs(3);
333 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
334 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
335 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
336 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features()), create_announced_chan_between_nodes(&nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features())];
337 for node in nodes.iter() {
338 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
340 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
342 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
344 // intermediate node failure
345 let short_channel_id = channels[1].0.contents.short_channel_id;
346 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
347 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
348 let cur_height = nodes[0].best_block_info().1 + 1;
349 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
350 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
351 let mut new_payloads = Vec::new();
352 for payload in onion_payloads.drain(..) {
353 new_payloads.push(BogusOnionHopData::new(payload));
355 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
356 // describing a length-1 TLV payload, which is obviously bogus.
357 new_payloads[0].data[0] = 1;
358 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
359 }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
361 // final node failure
362 let short_channel_id = channels[1].0.contents.short_channel_id;
363 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
364 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
365 let cur_height = nodes[0].best_block_info().1 + 1;
366 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
367 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
368 let mut new_payloads = Vec::new();
369 for payload in onion_payloads.drain(..) {
370 new_payloads.push(BogusOnionHopData::new(payload));
372 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
373 // length-1 TLV payload, which is obviously bogus.
374 new_payloads[1].data[0] = 1;
375 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
376 }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
378 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
379 // receiving simulated fail messages
380 // intermediate node failure
381 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
383 msg.amount_msat -= 1;
385 // and tamper returning error message
386 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
387 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
388 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), NODE|2, &[0;0]);
389 }, ||{}, true, Some(NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}), Some(route.paths[0][0].short_channel_id));
391 // final node failure
392 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
393 // and tamper returning error message
394 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
395 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
396 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), NODE|2, &[0;0]);
398 nodes[2].node.fail_htlc_backwards(&payment_hash);
399 }, true, Some(NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}), Some(route.paths[0][1].short_channel_id));
400 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
402 // intermediate node failure
403 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
404 msg.amount_msat -= 1;
406 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
407 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
408 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
409 }, ||{}, true, Some(PERM|NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));
411 // final node failure
412 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
413 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
414 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
415 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
417 nodes[2].node.fail_htlc_backwards(&payment_hash);
418 }, false, Some(PERM|NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}), Some(route.paths[0][1].short_channel_id));
419 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
421 // intermediate node failure
422 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
423 msg.amount_msat -= 1;
425 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
426 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
427 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
429 nodes[2].node.fail_htlc_backwards(&payment_hash);
430 }, true, Some(PERM|NODE|3), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));
432 // final node failure
433 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
434 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
435 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
436 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
438 nodes[2].node.fail_htlc_backwards(&payment_hash);
439 }, false, Some(PERM|NODE|3), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}), Some(route.paths[0][1].short_channel_id));
440 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
442 // Our immediate peer sent UpdateFailMalformedHTLC because it couldn't understand the onion in
443 // the UpdateAddHTLC that we sent.
444 let short_channel_id = channels[0].0.contents.short_channel_id;
445 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
446 Some(BADONION|PERM|4), None, Some(short_channel_id));
448 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
449 Some(BADONION|PERM|5), None, Some(short_channel_id));
451 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
452 Some(BADONION|PERM|6), None, Some(short_channel_id));
454 let short_channel_id = channels[1].0.contents.short_channel_id;
455 let chan_update = ChannelUpdate::dummy(short_channel_id);
457 let mut err_data = Vec::new();
458 err_data.extend_from_slice(&(chan_update.serialized_length() as u16 + 2).to_be_bytes());
459 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
460 err_data.extend_from_slice(&chan_update.encode());
461 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
462 msg.amount_msat -= 1;
464 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
465 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
466 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data);
467 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update.clone()}), Some(short_channel_id));
469 // Check we can still handle onion failures that include channel updates without a type prefix
470 let err_data_without_type = chan_update.encode_with_len();
471 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
472 msg.amount_msat -= 1;
474 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
475 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
476 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data_without_type);
477 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update}), Some(short_channel_id));
479 let short_channel_id = channels[1].0.contents.short_channel_id;
480 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
481 msg.amount_msat -= 1;
483 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
484 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
485 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|8, &[0;0]);
486 // short_channel_id from the processing node
487 }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
489 let short_channel_id = channels[1].0.contents.short_channel_id;
490 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
491 msg.amount_msat -= 1;
493 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
494 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
495 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|9, &[0;0]);
496 // short_channel_id from the processing node
497 }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
499 let mut bogus_route = route.clone();
500 bogus_route.paths[0][1].short_channel_id -= 1;
501 let short_channel_id = bogus_route.paths[0][1].short_channel_id;
502 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
503 Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent:true}), Some(short_channel_id));
505 let short_channel_id = channels[1].0.contents.short_channel_id;
506 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_counterparty_htlc_minimum_msat() - 1;
507 let mut bogus_route = route.clone();
508 let route_len = bogus_route.paths[0].len();
509 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
510 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(UPDATE|11), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
512 // Clear pending payments so that the following positive test has the correct payment hash.
513 for node in nodes.iter() {
514 node.node.clear_pending_payments();
517 // Test a positive test-case with one extra msat, meeting the minimum.
518 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward + 1;
519 let preimage = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1).0;
520 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
522 let short_channel_id = channels[0].0.contents.short_channel_id;
523 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
524 msg.amount_msat -= 1;
525 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
527 let short_channel_id = channels[0].0.contents.short_channel_id;
528 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
529 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
530 msg.cltv_expiry -= 1;
531 }, || {}, true, Some(UPDATE|13), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
533 let short_channel_id = channels[1].0.contents.short_channel_id;
534 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
535 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
536 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
537 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
538 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
539 }, ||{}, true, Some(UPDATE|14), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
541 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
542 nodes[2].node.fail_htlc_backwards(&payment_hash);
543 }, false, Some(PERM|15), None, None);
544 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
546 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
547 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
548 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
549 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
550 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
551 }, || {}, true, Some(17), None, None);
553 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
554 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
555 for f in pending_forwards.iter_mut() {
557 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
558 forward_info.outgoing_cltv_value += 1,
563 }, true, Some(18), None, Some(channels[1].0.contents.short_channel_id));
565 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
566 // violate amt_to_forward > msg.amount_msat
567 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
568 for f in pending_forwards.iter_mut() {
570 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
571 forward_info.outgoing_amt_msat -= 1,
576 }, true, Some(19), None, Some(channels[1].0.contents.short_channel_id));
578 let short_channel_id = channels[1].0.contents.short_channel_id;
579 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
580 // disconnect event to the channel between nodes[1] ~ nodes[2]
581 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
582 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
583 }, true, Some(UPDATE|20), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
584 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
586 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
587 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
588 let mut route = route.clone();
589 let height = nodes[2].best_block_info().1;
590 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
591 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
592 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height, &None).unwrap();
593 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
594 msg.cltv_expiry = htlc_cltv;
595 msg.onion_routing_packet = onion_packet;
596 }, ||{}, true, Some(21), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));
598 run_onion_failure_test_with_fail_intercept("mpp_timeout", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
599 // Tamper returning error message
600 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
601 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
602 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), 23, &[0;0]);
604 nodes[2].node.fail_htlc_backwards(&payment_hash);
605 }, true, Some(23), None, None);
608 fn do_test_onion_failure_stale_channel_update(announced_channel: bool) {
609 // Create a network of three nodes and two channels connecting them. We'll be updating the
610 // HTLC relay policy of the second channel, causing forwarding failures at the first hop.
611 let mut config = UserConfig::default();
612 config.channel_handshake_config.announced_channel = announced_channel;
613 config.channel_handshake_limits.force_announced_channel_preference = false;
614 config.accept_forwards_to_priv_channels = !announced_channel;
615 let chanmon_cfgs = create_chanmon_cfgs(3);
618 let channel_manager_1_deserialized;
619 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
620 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]);
621 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
623 let other_channel = create_chan_between_nodes(
624 &nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features(),
626 let channel_to_update = if announced_channel {
627 let channel = create_announced_chan_between_nodes(
628 &nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features(),
630 (channel.2, channel.0.contents.short_channel_id)
632 let channel = create_unannounced_chan_between_nodes_with_value(
633 &nodes, 1, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features(),
635 (channel.0.channel_id, channel.0.short_channel_id_alias.unwrap())
637 let channel_to_update_counterparty = &nodes[2].node.get_our_node_id();
639 let default_config = ChannelConfig::default();
641 // A test payment should succeed as the ChannelConfig has not been changed yet.
642 const PAYMENT_AMT: u64 = 40000;
643 let (route, payment_hash, payment_preimage, payment_secret) = if announced_channel {
644 get_route_and_payment_hash!(nodes[0], nodes[2], PAYMENT_AMT)
646 let hop_hints = vec![RouteHint(vec![RouteHintHop {
647 src_node_id: nodes[1].node.get_our_node_id(),
648 short_channel_id: channel_to_update.1,
650 base_msat: default_config.forwarding_fee_base_msat,
651 proportional_millionths: default_config.forwarding_fee_proportional_millionths,
653 cltv_expiry_delta: default_config.cltv_expiry_delta,
654 htlc_maximum_msat: None,
655 htlc_minimum_msat: None,
657 let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty)
658 .with_features(channelmanager::provided_invoice_features())
659 .with_route_hints(hop_hints);
660 get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT, TEST_FINAL_CLTV)
662 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
663 payment_hash, payment_secret);
664 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
666 // Closure to force expiry of a channel's previous config.
667 let expire_prev_config = || {
668 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
669 nodes[1].node.timer_tick_occurred();
673 // Closure to update and retrieve the latest ChannelUpdate.
674 let update_and_get_channel_update = |config: &ChannelConfig, expect_new_update: bool,
675 prev_update: Option<&msgs::ChannelUpdate>, should_expire_prev_config: bool| -> Option<msgs::ChannelUpdate> {
676 nodes[1].node.update_channel_config(
677 channel_to_update_counterparty, &[channel_to_update.0], config,
679 let events = nodes[1].node.get_and_clear_pending_msg_events();
680 assert_eq!(events.len(), expect_new_update as usize);
681 if !expect_new_update {
684 let new_update = match &events[0] {
685 MessageSendEvent::BroadcastChannelUpdate { msg } => {
686 assert!(announced_channel);
689 MessageSendEvent::SendChannelUpdate { node_id, msg } => {
690 assert_eq!(node_id, channel_to_update_counterparty);
691 assert!(!announced_channel);
694 _ => panic!("expected Broadcast/SendChannelUpdate event"),
696 if prev_update.is_some() {
697 assert!(new_update.contents.timestamp > prev_update.unwrap().contents.timestamp)
699 if should_expire_prev_config {
700 expire_prev_config();
705 // We'll be attempting to route payments using the default ChannelUpdate for channels. This will
706 // lead to onion failures at the first hop once we update the ChannelConfig for the
708 let expect_onion_failure = |name: &str, error_code: u16, channel_update: &msgs::ChannelUpdate| {
709 let short_channel_id = channel_to_update.1;
710 let network_update = NetworkUpdate::ChannelUpdateMessage { msg: channel_update.clone() };
711 run_onion_failure_test(
712 name, 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {}, true,
713 Some(error_code), Some(network_update), Some(short_channel_id),
717 // Updates to cltv_expiry_delta below MIN_CLTV_EXPIRY_DELTA should fail with APIMisuseError.
718 let mut invalid_config = default_config.clone();
719 invalid_config.cltv_expiry_delta = 0;
720 match nodes[1].node.update_channel_config(
721 channel_to_update_counterparty, &[channel_to_update.0], &invalid_config,
723 Err(APIError::APIMisuseError{ .. }) => {},
724 _ => panic!("unexpected result applying invalid cltv_expiry_delta"),
727 // Increase the base fee which should trigger a new ChannelUpdate.
728 let mut config = nodes[1].node.list_usable_channels().iter()
729 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
731 config.forwarding_fee_base_msat = u32::max_value();
732 let msg = update_and_get_channel_update(&config, true, None, false).unwrap();
734 // The old policy should still be in effect until a new block is connected.
735 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
736 payment_hash, payment_secret);
737 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
739 // Connect a block, which should expire the previous config, leading to a failure when
740 // forwarding the HTLC.
741 expire_prev_config();
742 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
744 // Redundant updates should not trigger a new ChannelUpdate.
745 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
747 // Similarly, updates that do not have an affect on ChannelUpdate should not trigger a new one.
748 config.force_close_avoidance_max_fee_satoshis *= 2;
749 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
751 // Reset the base fee to the default and increase the proportional fee which should trigger a
752 // new ChannelUpdate.
753 config.forwarding_fee_base_msat = default_config.forwarding_fee_base_msat;
754 config.cltv_expiry_delta = u16::max_value();
755 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
756 expect_onion_failure("incorrect_cltv_expiry", UPDATE|13, &msg);
758 // Reset the proportional fee and increase the CLTV expiry delta which should trigger a new
760 config.cltv_expiry_delta = default_config.cltv_expiry_delta;
761 config.forwarding_fee_proportional_millionths = u32::max_value();
762 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
763 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
765 // To test persistence of the updated config, we'll re-initialize the ChannelManager.
766 let config_after_restart = {
767 let chan_1_monitor_serialized = get_monitor!(nodes[1], other_channel.3).encode();
768 let chan_2_monitor_serialized = get_monitor!(nodes[1], channel_to_update.0).encode();
769 reload_node!(nodes[1], *nodes[1].node.get_current_default_configuration(), &nodes[1].node.encode(),
770 &[&chan_1_monitor_serialized, &chan_2_monitor_serialized], persister, chain_monitor, channel_manager_1_deserialized);
771 nodes[1].node.list_channels().iter()
772 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
775 assert_eq!(config, config_after_restart);
779 fn test_onion_failure_stale_channel_update() {
780 do_test_onion_failure_stale_channel_update(false);
781 do_test_onion_failure_stale_channel_update(true);
785 fn test_always_create_tlv_format_onion_payloads() {
786 // Verify that we always generate tlv onion format payloads, even if the features specifically
787 // specifies no support for variable length onions, as the legacy payload format has been
788 // deprecated in BOLT4.
789 let chanmon_cfgs = create_chanmon_cfgs(3);
790 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
792 // Set `node[1]`'s config features to features which return `false` for
793 // `supports_variable_length_onion()`
794 let mut no_variable_length_onion_features = InitFeatures::empty();
795 no_variable_length_onion_features.set_static_remote_key_required();
796 let mut node_1_cfg = &mut node_cfgs[1];
797 node_1_cfg.features = no_variable_length_onion_features;
799 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
800 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
802 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::empty(), InitFeatures::empty());
803 create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::empty(), InitFeatures::empty());
805 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id())
806 .with_features(InvoiceFeatures::empty());
807 let (route, _payment_hash, _payment_preimage, _payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, 40000, TEST_FINAL_CLTV);
809 let hops = &route.paths[0];
810 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
811 assert!(!hops[0].node_features.supports_variable_length_onion());
812 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
813 assert!(!hops[1].node_features.supports_variable_length_onion());
815 let cur_height = nodes[0].best_block_info().1 + 1;
816 let (onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
818 match onion_payloads[0].format {
819 msgs::OnionHopDataFormat::NonFinalNode {..} => {},
821 "Should have generated a `msgs::OnionHopDataFormat::NonFinalNode` payload for `hops[0]`,
822 despite that the features signals no support for variable length onions"
825 match onion_payloads[1].format {
826 msgs::OnionHopDataFormat::FinalNode {..} => {},
828 "Should have generated a `msgs::OnionHopDataFormat::FinalNode` payload for `hops[1]`,
829 despite that the features signals no support for variable length onions"
834 macro_rules! get_phantom_route {
835 ($nodes: expr, $amt: expr, $channel: expr) => {{
836 let secp_ctx = Secp256k1::new();
837 let phantom_secret = $nodes[1].keys_manager.get_node_secret(Recipient::PhantomNode).unwrap();
838 let phantom_pubkey = PublicKey::from_secret_key(&secp_ctx, &phantom_secret);
839 let phantom_route_hint = $nodes[1].node.get_phantom_route_hints();
840 let payment_params = PaymentParameters::from_node_id(phantom_pubkey)
841 .with_features(channelmanager::provided_invoice_features())
842 .with_route_hints(vec![RouteHint(vec![
844 src_node_id: $nodes[0].node.get_our_node_id(),
845 short_channel_id: $channel.0.contents.short_channel_id,
847 base_msat: $channel.0.contents.fee_base_msat,
848 proportional_millionths: $channel.0.contents.fee_proportional_millionths,
850 cltv_expiry_delta: $channel.0.contents.cltv_expiry_delta,
851 htlc_minimum_msat: None,
852 htlc_maximum_msat: None,
855 src_node_id: phantom_route_hint.real_node_pubkey,
856 short_channel_id: phantom_route_hint.phantom_scid,
859 proportional_millionths: 0,
861 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
862 htlc_minimum_msat: None,
863 htlc_maximum_msat: None,
866 let scorer = test_utils::TestScorer::with_penalty(0);
867 let network_graph = $nodes[0].network_graph.read_only();
869 &$nodes[0].node.get_our_node_id(), &payment_params, &network_graph,
870 Some(&$nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
871 $amt, TEST_FINAL_CLTV, $nodes[0].logger, &scorer, &[0u8; 32]
872 ).unwrap(), phantom_route_hint.phantom_scid)
877 fn test_phantom_onion_hmac_failure() {
878 let chanmon_cfgs = create_chanmon_cfgs(2);
879 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
880 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
881 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
883 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
886 let recv_value_msat = 10_000;
887 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
888 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
890 // Route the HTLC through to the destination.
891 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
892 check_added_monitors!(nodes[0], 1);
893 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
894 let mut update_add = update_0.update_add_htlcs[0].clone();
896 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
897 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
899 // Modify the payload so the phantom hop's HMAC is bogus.
900 let sha256_of_onion = {
901 let mut forward_htlcs = nodes[1].node.forward_htlcs.lock().unwrap();
902 let mut pending_forward = forward_htlcs.get_mut(&phantom_scid).unwrap();
903 match pending_forward[0] {
904 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
905 forward_info: PendingHTLCInfo {
906 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
910 onion_packet.hmac[onion_packet.hmac.len() - 1] ^= 1;
911 Sha256::hash(&onion_packet.hop_data).into_inner().to_vec()
913 _ => panic!("Unexpected forward"),
916 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
917 nodes[1].node.process_pending_htlc_forwards();
918 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
919 nodes[1].node.process_pending_htlc_forwards();
920 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
921 check_added_monitors!(&nodes[1], 1);
922 assert!(update_1.update_fail_htlcs.len() == 1);
923 let fail_msg = update_1.update_fail_htlcs[0].clone();
924 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
925 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
927 // Ensure the payment fails with the expected error.
928 let mut fail_conditions = PaymentFailedConditions::new()
929 .blamed_scid(phantom_scid)
930 .blamed_chan_closed(true)
931 .expected_htlc_error_data(0x8000 | 0x4000 | 5, &sha256_of_onion);
932 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
936 fn test_phantom_invalid_onion_payload() {
937 let chanmon_cfgs = create_chanmon_cfgs(2);
938 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
939 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
940 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
942 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
945 let recv_value_msat = 10_000;
946 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
947 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
949 // We'll use the session priv later when constructing an invalid onion packet.
950 let session_priv = [3; 32];
951 *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
952 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
953 check_added_monitors!(nodes[0], 1);
954 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
955 let mut update_add = update_0.update_add_htlcs[0].clone();
957 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
958 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
960 // Modify the onion packet to have an invalid payment amount.
961 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
962 for f in pending_forwards.iter_mut() {
964 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
965 forward_info: PendingHTLCInfo {
966 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
970 // Construct the onion payloads for the entire route and an invalid amount.
971 let height = nodes[0].best_block_info().1;
972 let session_priv = SecretKey::from_slice(&session_priv).unwrap();
973 let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
974 let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(&route.paths[0], msgs::MAX_VALUE_MSAT + 1, &Some(payment_secret), height + 1, &None).unwrap();
975 // We only want to construct the onion packet for the last hop, not the entire route, so
976 // remove the first hop's payload and its keys.
977 onion_keys.remove(0);
978 onion_payloads.remove(0);
980 let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
981 onion_packet.hop_data = new_onion_packet.hop_data;
982 onion_packet.hmac = new_onion_packet.hmac;
984 _ => panic!("Unexpected forward"),
988 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
989 nodes[1].node.process_pending_htlc_forwards();
990 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
991 nodes[1].node.process_pending_htlc_forwards();
992 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
993 check_added_monitors!(&nodes[1], 1);
994 assert!(update_1.update_fail_htlcs.len() == 1);
995 let fail_msg = update_1.update_fail_htlcs[0].clone();
996 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
997 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
999 // Ensure the payment fails with the expected error.
1000 let error_data = Vec::new();
1001 let mut fail_conditions = PaymentFailedConditions::new()
1002 .blamed_scid(phantom_scid)
1003 .blamed_chan_closed(true)
1004 .expected_htlc_error_data(0x4000 | 22, &error_data);
1005 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1009 fn test_phantom_final_incorrect_cltv_expiry() {
1010 let chanmon_cfgs = create_chanmon_cfgs(2);
1011 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1012 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1013 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1015 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1018 let recv_value_msat = 10_000;
1019 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1020 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1022 // Route the HTLC through to the destination.
1023 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1024 check_added_monitors!(nodes[0], 1);
1025 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1026 let mut update_add = update_0.update_add_htlcs[0].clone();
1028 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1029 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1031 // Modify the payload so the phantom hop's HMAC is bogus.
1032 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1033 for f in pending_forwards.iter_mut() {
1035 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1036 forward_info: PendingHTLCInfo { ref mut outgoing_cltv_value, .. }, ..
1038 *outgoing_cltv_value += 1;
1040 _ => panic!("Unexpected forward"),
1044 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1045 nodes[1].node.process_pending_htlc_forwards();
1046 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1047 nodes[1].node.process_pending_htlc_forwards();
1048 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1049 check_added_monitors!(&nodes[1], 1);
1050 assert!(update_1.update_fail_htlcs.len() == 1);
1051 let fail_msg = update_1.update_fail_htlcs[0].clone();
1052 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1053 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1055 // Ensure the payment fails with the expected error.
1056 let expected_cltv = 82;
1057 let error_data = byte_utils::be32_to_array(expected_cltv).to_vec();
1058 let mut fail_conditions = PaymentFailedConditions::new()
1059 .blamed_scid(phantom_scid)
1060 .expected_htlc_error_data(18, &error_data);
1061 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1065 fn test_phantom_failure_too_low_cltv() {
1066 let chanmon_cfgs = create_chanmon_cfgs(2);
1067 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1068 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1069 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1071 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1074 let recv_value_msat = 10_000;
1075 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1076 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1078 // Modify the route to have a too-low cltv.
1079 route.paths[0][1].cltv_expiry_delta = 5;
1081 // Route the HTLC through to the destination.
1082 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1083 check_added_monitors!(nodes[0], 1);
1084 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1085 let mut update_add = update_0.update_add_htlcs[0].clone();
1087 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1088 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1090 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1091 nodes[1].node.process_pending_htlc_forwards();
1092 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1093 nodes[1].node.process_pending_htlc_forwards();
1094 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1095 check_added_monitors!(&nodes[1], 1);
1096 assert!(update_1.update_fail_htlcs.len() == 1);
1097 let fail_msg = update_1.update_fail_htlcs[0].clone();
1098 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1099 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1101 // Ensure the payment fails with the expected error.
1102 let error_data = Vec::new();
1103 let mut fail_conditions = PaymentFailedConditions::new()
1104 .blamed_scid(phantom_scid)
1105 .expected_htlc_error_data(17, &error_data);
1106 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1110 fn test_phantom_failure_too_low_recv_amt() {
1111 let chanmon_cfgs = create_chanmon_cfgs(2);
1112 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1113 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1114 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1116 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1118 // Get the route with a too-low amount.
1119 let recv_amt_msat = 10_000;
1120 let bad_recv_amt_msat = recv_amt_msat - 10;
1121 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1122 let (mut route, phantom_scid) = get_phantom_route!(nodes, bad_recv_amt_msat, channel);
1124 // Route the HTLC through to the destination.
1125 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1126 check_added_monitors!(nodes[0], 1);
1127 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1128 let mut update_add = update_0.update_add_htlcs[0].clone();
1130 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1131 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1133 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1134 nodes[1].node.process_pending_htlc_forwards();
1135 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1136 nodes[1].node.process_pending_htlc_forwards();
1137 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
1138 nodes[1].node.process_pending_htlc_forwards();
1139 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1140 check_added_monitors!(&nodes[1], 1);
1141 assert!(update_1.update_fail_htlcs.len() == 1);
1142 let fail_msg = update_1.update_fail_htlcs[0].clone();
1143 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1144 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1146 // Ensure the payment fails with the expected error.
1147 let mut error_data = byte_utils::be64_to_array(bad_recv_amt_msat).to_vec();
1148 error_data.extend_from_slice(
1149 &byte_utils::be32_to_array(nodes[1].node.best_block.read().unwrap().height()),
1151 let mut fail_conditions = PaymentFailedConditions::new()
1152 .blamed_scid(phantom_scid)
1153 .expected_htlc_error_data(0x4000 | 15, &error_data);
1154 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1158 fn test_phantom_dust_exposure_failure() {
1159 // Set the max dust exposure to the dust limit.
1160 let max_dust_exposure = 546;
1161 let mut receiver_config = UserConfig::default();
1162 receiver_config.channel_config.max_dust_htlc_exposure_msat = max_dust_exposure;
1163 receiver_config.channel_handshake_config.announced_channel = true;
1165 let chanmon_cfgs = create_chanmon_cfgs(2);
1166 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1167 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(receiver_config)]);
1168 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1170 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1172 // Get the route with an amount exceeding the dust exposure threshold of nodes[1].
1173 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(max_dust_exposure + 1));
1174 let (mut route, _) = get_phantom_route!(nodes, max_dust_exposure + 1, channel);
1176 // Route the HTLC through to the destination.
1177 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1178 check_added_monitors!(nodes[0], 1);
1179 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1180 let mut update_add = update_0.update_add_htlcs[0].clone();
1182 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1183 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1185 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1186 assert!(update_1.update_fail_htlcs.len() == 1);
1187 let fail_msg = update_1.update_fail_htlcs[0].clone();
1188 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1189 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1191 // Ensure the payment fails with the expected error.
1192 let mut err_data = Vec::new();
1193 err_data.extend_from_slice(&(channel.1.serialized_length() as u16 + 2).to_be_bytes());
1194 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
1195 err_data.extend_from_slice(&channel.1.encode());
1197 let mut fail_conditions = PaymentFailedConditions::new()
1198 .blamed_scid(channel.0.contents.short_channel_id)
1199 .blamed_chan_closed(false)
1200 .expected_htlc_error_data(0x1000 | 7, &err_data);
1201 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1205 fn test_phantom_failure_reject_payment() {
1206 // Test that the user can successfully fail back a phantom node payment.
1207 let chanmon_cfgs = create_chanmon_cfgs(2);
1208 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1209 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1210 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1212 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1214 // Get the route with a too-low amount.
1215 let recv_amt_msat = 10_000;
1216 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1217 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_amt_msat, channel);
1219 // Route the HTLC through to the destination.
1220 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1221 check_added_monitors!(nodes[0], 1);
1222 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1223 let mut update_add = update_0.update_add_htlcs[0].clone();
1225 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1226 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1228 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1229 nodes[1].node.process_pending_htlc_forwards();
1230 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1231 nodes[1].node.process_pending_htlc_forwards();
1232 expect_payment_received!(nodes[1], payment_hash, payment_secret, recv_amt_msat, None, route.paths[0].last().unwrap().pubkey);
1233 nodes[1].node.fail_htlc_backwards(&payment_hash);
1234 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1235 nodes[1].node.process_pending_htlc_forwards();
1237 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1238 check_added_monitors!(&nodes[1], 1);
1239 assert!(update_1.update_fail_htlcs.len() == 1);
1240 let fail_msg = update_1.update_fail_htlcs[0].clone();
1241 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1242 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1244 // Ensure the payment fails with the expected error.
1245 let mut error_data = byte_utils::be64_to_array(recv_amt_msat).to_vec();
1246 error_data.extend_from_slice(
1247 &byte_utils::be32_to_array(nodes[1].node.best_block.read().unwrap().height()),
1249 let mut fail_conditions = PaymentFailedConditions::new()
1250 .blamed_scid(phantom_scid)
1251 .expected_htlc_error_data(0x4000 | 15, &error_data);
1252 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);