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::{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, ChannelManager, ChannelManagerReadArgs, HTLCForwardInfo, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingHTLCInfo, PendingHTLCRouting};
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;
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::{ReadableArgs, 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 nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(*payment_secret)).unwrap();
86 check_added_monitors!(nodes[0], 1);
87 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
88 // temper update_add (0 => 1)
89 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
90 if test_case == 0 || test_case == 3 || test_case == 100 {
91 callback_msg(&mut update_add_0);
94 // 0 => 1 update_add & CS
95 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
96 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
98 let update_1_0 = match test_case {
99 0|100 => { // intermediate node failure; fail backward to 0
100 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
101 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));
104 1|2|3|200 => { // final node failure; forwarding to 2
105 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
107 if test_case != 200 {
110 expect_htlc_forward!(&nodes[1]);
112 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
113 check_added_monitors!(&nodes[1], 1);
114 assert_eq!(update_1.update_add_htlcs.len(), 1);
115 // tamper update_add (1 => 2)
116 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
117 if test_case != 3 && test_case != 200 {
118 callback_msg(&mut update_add_1);
122 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
123 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
125 if test_case == 2 || test_case == 200 {
126 expect_htlc_forward!(&nodes[2]);
127 expect_event!(&nodes[2], Event::PaymentReceived);
129 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
132 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
133 if test_case == 2 || test_case == 200 {
134 check_added_monitors!(&nodes[2], 1);
136 assert!(update_2_1.update_fail_htlcs.len() == 1);
138 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
139 if test_case == 200 {
140 callback_fail(&mut fail_msg);
144 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
145 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
147 // backward fail on 1
148 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
149 assert!(update_1_0.update_fail_htlcs.len() == 1);
155 // 1 => 0 commitment_signed_dance
156 if update_1_0.update_fail_htlcs.len() > 0 {
157 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
158 if test_case == 100 {
159 callback_fail(&mut fail_msg);
161 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
163 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
166 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
168 let events = nodes[0].node.get_and_clear_pending_events();
169 assert_eq!(events.len(), 1);
170 if let &Event::PaymentPathFailed { ref payment_failed_permanently, ref network_update, ref all_paths_failed, ref short_channel_id, ref error_code, .. } = &events[0] {
171 assert_eq!(*payment_failed_permanently, !expected_retryable);
172 assert_eq!(*all_paths_failed, true);
173 assert_eq!(*error_code, expected_error_code);
174 if expected_channel_update.is_some() {
175 match network_update {
176 Some(update) => match update {
177 &NetworkUpdate::ChannelUpdateMessage { .. } => {
178 if let NetworkUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
179 panic!("channel_update not found!");
182 &NetworkUpdate::ChannelFailure { ref short_channel_id, ref is_permanent } => {
183 if let NetworkUpdate::ChannelFailure { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
184 assert!(*short_channel_id == *expected_short_channel_id);
185 assert!(*is_permanent == *expected_is_permanent);
187 panic!("Unexpected message event");
190 &NetworkUpdate::NodeFailure { ref node_id, ref is_permanent } => {
191 if let NetworkUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
192 assert!(*node_id == *expected_node_id);
193 assert!(*is_permanent == *expected_is_permanent);
195 panic!("Unexpected message event");
199 None => panic!("Expected channel update"),
202 assert!(network_update.is_none());
204 if let Some(expected_short_channel_id) = expected_short_channel_id {
205 match short_channel_id {
206 Some(short_channel_id) => assert_eq!(*short_channel_id, expected_short_channel_id),
207 None => panic!("Expected short channel id"),
210 assert!(short_channel_id.is_none());
213 panic!("Unexpected event");
217 impl msgs::ChannelUpdate {
218 fn dummy(short_channel_id: u64) -> msgs::ChannelUpdate {
219 use bitcoin::secp256k1::ffi::Signature as FFISignature;
220 use bitcoin::secp256k1::ecdsa::Signature;
221 msgs::ChannelUpdate {
222 signature: Signature::from(unsafe { FFISignature::new() }),
223 contents: msgs::UnsignedChannelUpdate {
224 chain_hash: BlockHash::hash(&vec![0u8][..]),
228 cltv_expiry_delta: 0,
229 htlc_minimum_msat: 0,
230 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
232 fee_proportional_millionths: 0,
239 struct BogusOnionHopData {
242 impl BogusOnionHopData {
243 fn new(orig: msgs::OnionHopData) -> Self {
244 Self { data: orig.encode() }
247 impl Writeable for BogusOnionHopData {
248 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
249 writer.write_all(&self.data[..])
253 const BADONION: u16 = 0x8000;
254 const PERM: u16 = 0x4000;
255 const NODE: u16 = 0x2000;
256 const UPDATE: u16 = 0x1000;
259 fn test_fee_failures() {
260 // Tests that the fee required when forwarding remains consistent over time. This was
261 // previously broken, with forwarding fees floating based on the fee estimator at the time of
264 // When this test was written, the default base fee floated based on the HTLC count.
265 // It is now fixed, so we simply set the fee to the expected value here.
266 let mut config = test_default_channel_config();
267 config.channel_config.forwarding_fee_base_msat = 196;
269 let chanmon_cfgs = create_chanmon_cfgs(3);
270 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
271 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
272 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
273 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())];
276 let (route, payment_hash_success, payment_preimage_success, payment_secret_success) = get_route_and_payment_hash!(nodes[0], nodes[2], 40_000);
277 nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success)).unwrap();
278 check_added_monitors!(nodes[0], 1);
279 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
280 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
282 // If the hop gives fee_insufficient but enough fees were provided, then the previous hop
283 // malleated the payment before forwarding, taking funds when they shouldn't have.
284 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
285 let short_channel_id = channels[0].0.contents.short_channel_id;
286 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
287 msg.amount_msat -= 1;
288 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
290 // In an earlier version, we spuriously failed to forward payments if the expected feerate
291 // changed between the channel open and the payment.
293 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
297 let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
298 nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success)).unwrap();
299 check_added_monitors!(nodes[0], 1);
300 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
301 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
305 fn test_onion_failure() {
306 // When we check for amount_below_minimum below, we want to test that we're using the *right*
307 // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
308 // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
309 // This exposed a previous bug because we were using the wrong value all the way down in
310 // Channel::get_counterparty_htlc_minimum_msat().
311 let mut node_2_cfg: UserConfig = Default::default();
312 node_2_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
313 node_2_cfg.channel_handshake_config.announced_channel = true;
314 node_2_cfg.channel_handshake_limits.force_announced_channel_preference = false;
316 // When this test was written, the default base fee floated based on the HTLC count.
317 // It is now fixed, so we simply set the fee to the expected value here.
318 let mut config = test_default_channel_config();
319 config.channel_config.forwarding_fee_base_msat = 196;
321 let chanmon_cfgs = create_chanmon_cfgs(3);
322 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
323 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
324 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
325 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())];
326 for node in nodes.iter() {
327 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
329 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
331 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
333 // intermediate node failure
334 let short_channel_id = channels[1].0.contents.short_channel_id;
335 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
336 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
337 let cur_height = nodes[0].best_block_info().1 + 1;
338 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
339 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
340 let mut new_payloads = Vec::new();
341 for payload in onion_payloads.drain(..) {
342 new_payloads.push(BogusOnionHopData::new(payload));
344 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
345 // describing a length-1 TLV payload, which is obviously bogus.
346 new_payloads[0].data[0] = 1;
347 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
348 }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
350 // final node failure
351 let short_channel_id = channels[1].0.contents.short_channel_id;
352 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
353 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
354 let cur_height = nodes[0].best_block_info().1 + 1;
355 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
356 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
357 let mut new_payloads = Vec::new();
358 for payload in onion_payloads.drain(..) {
359 new_payloads.push(BogusOnionHopData::new(payload));
361 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
362 // length-1 TLV payload, which is obviously bogus.
363 new_payloads[1].data[0] = 1;
364 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
365 }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
367 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
368 // receiving simulated fail messages
369 // intermediate node failure
370 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
372 msg.amount_msat -= 1;
374 // and tamper returning error message
375 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
376 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
377 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), NODE|2, &[0;0]);
378 }, ||{}, 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));
380 // final node failure
381 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
382 // and tamper returning error message
383 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
384 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
385 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), NODE|2, &[0;0]);
387 nodes[2].node.fail_htlc_backwards(&payment_hash);
388 }, 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));
389 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
391 // intermediate node failure
392 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
393 msg.amount_msat -= 1;
395 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
396 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
397 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
398 }, ||{}, 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));
400 // final node failure
401 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
402 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
403 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
404 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
406 nodes[2].node.fail_htlc_backwards(&payment_hash);
407 }, 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));
408 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
410 // intermediate node failure
411 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
412 msg.amount_msat -= 1;
414 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
415 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
416 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
418 nodes[2].node.fail_htlc_backwards(&payment_hash);
419 }, 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));
421 // final node failure
422 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
423 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
424 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
425 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
427 nodes[2].node.fail_htlc_backwards(&payment_hash);
428 }, 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));
429 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
431 // Our immediate peer sent UpdateFailMalformedHTLC because it couldn't understand the onion in
432 // the UpdateAddHTLC that we sent.
433 let short_channel_id = channels[0].0.contents.short_channel_id;
434 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
435 Some(BADONION|PERM|4), None, Some(short_channel_id));
437 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
438 Some(BADONION|PERM|5), None, Some(short_channel_id));
440 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,
441 Some(BADONION|PERM|6), None, Some(short_channel_id));
443 let short_channel_id = channels[1].0.contents.short_channel_id;
444 let chan_update = ChannelUpdate::dummy(short_channel_id);
446 let mut err_data = Vec::new();
447 err_data.extend_from_slice(&(chan_update.serialized_length() as u16 + 2).to_be_bytes());
448 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
449 err_data.extend_from_slice(&chan_update.encode());
450 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
451 msg.amount_msat -= 1;
453 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
454 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
455 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data);
456 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update.clone()}), Some(short_channel_id));
458 // Check we can still handle onion failures that include channel updates without a type prefix
459 let err_data_without_type = chan_update.encode_with_len();
460 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
461 msg.amount_msat -= 1;
463 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
464 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
465 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data_without_type);
466 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update}), Some(short_channel_id));
468 let short_channel_id = channels[1].0.contents.short_channel_id;
469 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
470 msg.amount_msat -= 1;
472 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
473 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
474 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|8, &[0;0]);
475 // short_channel_id from the processing node
476 }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
478 let short_channel_id = channels[1].0.contents.short_channel_id;
479 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
480 msg.amount_msat -= 1;
482 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
483 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
484 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|9, &[0;0]);
485 // short_channel_id from the processing node
486 }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
488 let mut bogus_route = route.clone();
489 bogus_route.paths[0][1].short_channel_id -= 1;
490 let short_channel_id = bogus_route.paths[0][1].short_channel_id;
491 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
492 Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent:true}), Some(short_channel_id));
494 let short_channel_id = channels[1].0.contents.short_channel_id;
495 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_counterparty_htlc_minimum_msat() - 1;
496 let mut bogus_route = route.clone();
497 let route_len = bogus_route.paths[0].len();
498 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
499 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));
501 // Clear pending payments so that the following positive test has the correct payment hash.
502 for node in nodes.iter() {
503 node.node.clear_pending_payments();
506 // Test a positive test-case with one extra msat, meeting the minimum.
507 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward + 1;
508 let preimage = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1).0;
509 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
511 let short_channel_id = channels[0].0.contents.short_channel_id;
512 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
513 msg.amount_msat -= 1;
514 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
516 let short_channel_id = channels[0].0.contents.short_channel_id;
517 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
518 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
519 msg.cltv_expiry -= 1;
520 }, || {}, true, Some(UPDATE|13), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
522 let short_channel_id = channels[1].0.contents.short_channel_id;
523 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
524 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
525 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
526 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
527 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
528 }, ||{}, true, Some(UPDATE|14), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
530 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
531 nodes[2].node.fail_htlc_backwards(&payment_hash);
532 }, false, Some(PERM|15), None, None);
533 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
535 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
536 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
537 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
538 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
539 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
540 }, || {}, true, Some(17), None, None);
542 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
543 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
544 for f in pending_forwards.iter_mut() {
546 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
547 forward_info.outgoing_cltv_value += 1,
552 }, true, Some(18), None, Some(channels[1].0.contents.short_channel_id));
554 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
555 // violate amt_to_forward > msg.amount_msat
556 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
557 for f in pending_forwards.iter_mut() {
559 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
560 forward_info.amt_to_forward -= 1,
565 }, true, Some(19), None, Some(channels[1].0.contents.short_channel_id));
567 let short_channel_id = channels[1].0.contents.short_channel_id;
568 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
569 // disconnect event to the channel between nodes[1] ~ nodes[2]
570 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
571 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
572 }, true, Some(UPDATE|20), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
573 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
575 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
576 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
577 let mut route = route.clone();
578 let height = nodes[2].best_block_info().1;
579 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
580 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
581 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height, &None).unwrap();
582 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
583 msg.cltv_expiry = htlc_cltv;
584 msg.onion_routing_packet = onion_packet;
585 }, ||{}, true, Some(21), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));
587 run_onion_failure_test_with_fail_intercept("mpp_timeout", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
588 // Tamper returning error message
589 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
590 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
591 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), 23, &[0;0]);
593 nodes[2].node.fail_htlc_backwards(&payment_hash);
594 }, true, Some(23), None, None);
597 fn do_test_onion_failure_stale_channel_update(announced_channel: bool) {
598 // Create a network of three nodes and two channels connecting them. We'll be updating the
599 // HTLC relay policy of the second channel, causing forwarding failures at the first hop.
600 let mut config = UserConfig::default();
601 config.channel_handshake_config.announced_channel = announced_channel;
602 config.channel_handshake_limits.force_announced_channel_preference = false;
603 config.accept_forwards_to_priv_channels = !announced_channel;
604 let chanmon_cfgs = create_chanmon_cfgs(3);
605 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
606 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]);
607 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
609 let other_channel = create_chan_between_nodes(
610 &nodes[0], &nodes[1], channelmanager::provided_init_features(), channelmanager::provided_init_features(),
612 let channel_to_update = if announced_channel {
613 let channel = create_announced_chan_between_nodes(
614 &nodes, 1, 2, channelmanager::provided_init_features(), channelmanager::provided_init_features(),
616 (channel.2, channel.0.contents.short_channel_id)
618 let channel = create_unannounced_chan_between_nodes_with_value(
619 &nodes, 1, 2, 100000, 10001, channelmanager::provided_init_features(), channelmanager::provided_init_features(),
621 (channel.0.channel_id, channel.0.short_channel_id_alias.unwrap())
623 let channel_to_update_counterparty = &nodes[2].node.get_our_node_id();
625 let default_config = ChannelConfig::default();
627 // A test payment should succeed as the ChannelConfig has not been changed yet.
628 const PAYMENT_AMT: u64 = 40000;
629 let (route, payment_hash, payment_preimage, payment_secret) = if announced_channel {
630 get_route_and_payment_hash!(nodes[0], nodes[2], PAYMENT_AMT)
632 let hop_hints = vec![RouteHint(vec![RouteHintHop {
633 src_node_id: nodes[1].node.get_our_node_id(),
634 short_channel_id: channel_to_update.1,
636 base_msat: default_config.forwarding_fee_base_msat,
637 proportional_millionths: default_config.forwarding_fee_proportional_millionths,
639 cltv_expiry_delta: default_config.cltv_expiry_delta,
640 htlc_maximum_msat: None,
641 htlc_minimum_msat: None,
643 let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty)
644 .with_features(channelmanager::provided_invoice_features())
645 .with_route_hints(hop_hints);
646 get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT, TEST_FINAL_CLTV)
648 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
649 payment_hash, payment_secret);
650 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
652 // Closure to force expiry of a channel's previous config.
653 let expire_prev_config = || {
654 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
655 nodes[1].node.timer_tick_occurred();
659 // Closure to update and retrieve the latest ChannelUpdate.
660 let update_and_get_channel_update = |config: &ChannelConfig, expect_new_update: bool,
661 prev_update: Option<&msgs::ChannelUpdate>, should_expire_prev_config: bool| -> Option<msgs::ChannelUpdate> {
662 nodes[1].node.update_channel_config(
663 channel_to_update_counterparty, &[channel_to_update.0], config,
665 let events = nodes[1].node.get_and_clear_pending_msg_events();
666 assert_eq!(events.len(), expect_new_update as usize);
667 if !expect_new_update {
670 let new_update = match &events[0] {
671 MessageSendEvent::BroadcastChannelUpdate { msg } => {
672 assert!(announced_channel);
675 MessageSendEvent::SendChannelUpdate { node_id, msg } => {
676 assert_eq!(node_id, channel_to_update_counterparty);
677 assert!(!announced_channel);
680 _ => panic!("expected Broadcast/SendChannelUpdate event"),
682 if prev_update.is_some() {
683 assert!(new_update.contents.timestamp > prev_update.unwrap().contents.timestamp)
685 if should_expire_prev_config {
686 expire_prev_config();
691 // We'll be attempting to route payments using the default ChannelUpdate for channels. This will
692 // lead to onion failures at the first hop once we update the ChannelConfig for the
694 let expect_onion_failure = |name: &str, error_code: u16, channel_update: &msgs::ChannelUpdate| {
695 let short_channel_id = channel_to_update.1;
696 let network_update = NetworkUpdate::ChannelUpdateMessage { msg: channel_update.clone() };
697 run_onion_failure_test(
698 name, 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {}, true,
699 Some(error_code), Some(network_update), Some(short_channel_id),
703 // Updates to cltv_expiry_delta below MIN_CLTV_EXPIRY_DELTA should fail with APIMisuseError.
704 let mut invalid_config = default_config.clone();
705 invalid_config.cltv_expiry_delta = 0;
706 match nodes[1].node.update_channel_config(
707 channel_to_update_counterparty, &[channel_to_update.0], &invalid_config,
709 Err(APIError::APIMisuseError{ .. }) => {},
710 _ => panic!("unexpected result applying invalid cltv_expiry_delta"),
713 // Increase the base fee which should trigger a new ChannelUpdate.
714 let mut config = nodes[1].node.list_usable_channels().iter()
715 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
717 config.forwarding_fee_base_msat = u32::max_value();
718 let msg = update_and_get_channel_update(&config, true, None, false).unwrap();
720 // The old policy should still be in effect until a new block is connected.
721 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
722 payment_hash, payment_secret);
723 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
725 // Connect a block, which should expire the previous config, leading to a failure when
726 // forwarding the HTLC.
727 expire_prev_config();
728 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
730 // Redundant updates should not trigger a new ChannelUpdate.
731 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
733 // Similarly, updates that do not have an affect on ChannelUpdate should not trigger a new one.
734 config.force_close_avoidance_max_fee_satoshis *= 2;
735 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
737 // Reset the base fee to the default and increase the proportional fee which should trigger a
738 // new ChannelUpdate.
739 config.forwarding_fee_base_msat = default_config.forwarding_fee_base_msat;
740 config.cltv_expiry_delta = u16::max_value();
741 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
742 expect_onion_failure("incorrect_cltv_expiry", UPDATE|13, &msg);
744 // Reset the proportional fee and increase the CLTV expiry delta which should trigger a new
746 config.cltv_expiry_delta = default_config.cltv_expiry_delta;
747 config.forwarding_fee_proportional_millionths = u32::max_value();
748 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
749 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
751 // To test persistence of the updated config, we'll re-initialize the ChannelManager.
752 let config_after_restart = {
753 let persister = test_utils::TestPersister::new();
754 let chain_monitor = test_utils::TestChainMonitor::new(
755 Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger,
756 node_cfgs[1].fee_estimator, &persister, nodes[1].keys_manager,
759 let mut chanmon_1 = <(_, ChannelMonitor<_>)>::read(
760 &mut &get_monitor!(nodes[1], other_channel.3).encode()[..], nodes[1].keys_manager,
762 let mut chanmon_2 = <(_, ChannelMonitor<_>)>::read(
763 &mut &get_monitor!(nodes[1], channel_to_update.0).encode()[..], nodes[1].keys_manager,
765 let mut channel_monitors = HashMap::new();
766 channel_monitors.insert(chanmon_1.get_funding_txo().0, &mut chanmon_1);
767 channel_monitors.insert(chanmon_2.get_funding_txo().0, &mut chanmon_2);
769 let chanmgr = <(_, ChannelManager<_, _, _, _, _, _>)>::read(
770 &mut &nodes[1].node.encode()[..], ChannelManagerReadArgs {
771 default_config: *nodes[1].node.get_current_default_configuration(),
772 keys_manager: nodes[1].keys_manager,
773 fee_estimator: node_cfgs[1].fee_estimator,
774 chain_monitor: &chain_monitor,
775 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
776 logger: nodes[1].logger,
777 channel_monitors: channel_monitors,
780 chanmgr.list_channels().iter()
781 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
784 assert_eq!(config, config_after_restart);
788 fn test_onion_failure_stale_channel_update() {
789 do_test_onion_failure_stale_channel_update(false);
790 do_test_onion_failure_stale_channel_update(true);
793 macro_rules! get_phantom_route {
794 ($nodes: expr, $amt: expr, $channel: expr) => {{
795 let secp_ctx = Secp256k1::new();
796 let phantom_secret = $nodes[1].keys_manager.get_node_secret(Recipient::PhantomNode).unwrap();
797 let phantom_pubkey = PublicKey::from_secret_key(&secp_ctx, &phantom_secret);
798 let phantom_route_hint = $nodes[1].node.get_phantom_route_hints();
799 let payment_params = PaymentParameters::from_node_id(phantom_pubkey)
800 .with_features(channelmanager::provided_invoice_features())
801 .with_route_hints(vec![RouteHint(vec![
803 src_node_id: $nodes[0].node.get_our_node_id(),
804 short_channel_id: $channel.0.contents.short_channel_id,
806 base_msat: $channel.0.contents.fee_base_msat,
807 proportional_millionths: $channel.0.contents.fee_proportional_millionths,
809 cltv_expiry_delta: $channel.0.contents.cltv_expiry_delta,
810 htlc_minimum_msat: None,
811 htlc_maximum_msat: None,
814 src_node_id: phantom_route_hint.real_node_pubkey,
815 short_channel_id: phantom_route_hint.phantom_scid,
818 proportional_millionths: 0,
820 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
821 htlc_minimum_msat: None,
822 htlc_maximum_msat: None,
825 let scorer = test_utils::TestScorer::with_penalty(0);
826 let network_graph = $nodes[0].network_graph.read_only();
828 &$nodes[0].node.get_our_node_id(), &payment_params, &network_graph,
829 Some(&$nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
830 $amt, TEST_FINAL_CLTV, $nodes[0].logger, &scorer, &[0u8; 32]
831 ).unwrap(), phantom_route_hint.phantom_scid)
836 fn test_phantom_onion_hmac_failure() {
837 let chanmon_cfgs = create_chanmon_cfgs(2);
838 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
839 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
840 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
842 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
845 let recv_value_msat = 10_000;
846 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
847 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
849 // Route the HTLC through to the destination.
850 nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
851 check_added_monitors!(nodes[0], 1);
852 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
853 let mut update_add = update_0.update_add_htlcs[0].clone();
855 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
856 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
858 // Modify the payload so the phantom hop's HMAC is bogus.
859 let sha256_of_onion = {
860 let mut forward_htlcs = nodes[1].node.forward_htlcs.lock().unwrap();
861 let mut pending_forward = forward_htlcs.get_mut(&phantom_scid).unwrap();
862 match pending_forward[0] {
863 HTLCForwardInfo::AddHTLC {
864 forward_info: PendingHTLCInfo {
865 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
869 onion_packet.hmac[onion_packet.hmac.len() - 1] ^= 1;
870 Sha256::hash(&onion_packet.hop_data).into_inner().to_vec()
872 _ => panic!("Unexpected forward"),
875 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
876 nodes[1].node.process_pending_htlc_forwards();
877 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
878 nodes[1].node.process_pending_htlc_forwards();
879 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
880 check_added_monitors!(&nodes[1], 1);
881 assert!(update_1.update_fail_htlcs.len() == 1);
882 let fail_msg = update_1.update_fail_htlcs[0].clone();
883 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
884 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
886 // Ensure the payment fails with the expected error.
887 let mut fail_conditions = PaymentFailedConditions::new()
888 .blamed_scid(phantom_scid)
889 .blamed_chan_closed(true)
890 .expected_htlc_error_data(0x8000 | 0x4000 | 5, &sha256_of_onion);
891 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
895 fn test_phantom_invalid_onion_payload() {
896 let chanmon_cfgs = create_chanmon_cfgs(2);
897 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
898 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
899 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
901 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
904 let recv_value_msat = 10_000;
905 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
906 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
908 // We'll use the session priv later when constructing an invalid onion packet.
909 let session_priv = [3; 32];
910 *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
911 nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
912 check_added_monitors!(nodes[0], 1);
913 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
914 let mut update_add = update_0.update_add_htlcs[0].clone();
916 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
917 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
919 // Modify the onion packet to have an invalid payment amount.
920 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
921 for f in pending_forwards.iter_mut() {
923 &mut HTLCForwardInfo::AddHTLC {
924 forward_info: PendingHTLCInfo {
925 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
929 // Construct the onion payloads for the entire route and an invalid amount.
930 let height = nodes[0].best_block_info().1;
931 let session_priv = SecretKey::from_slice(&session_priv).unwrap();
932 let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
933 let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(&route.paths[0], msgs::MAX_VALUE_MSAT + 1, &Some(payment_secret), height + 1, &None).unwrap();
934 // We only want to construct the onion packet for the last hop, not the entire route, so
935 // remove the first hop's payload and its keys.
936 onion_keys.remove(0);
937 onion_payloads.remove(0);
939 let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
940 onion_packet.hop_data = new_onion_packet.hop_data;
941 onion_packet.hmac = new_onion_packet.hmac;
943 _ => panic!("Unexpected forward"),
947 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
948 nodes[1].node.process_pending_htlc_forwards();
949 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
950 nodes[1].node.process_pending_htlc_forwards();
951 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
952 check_added_monitors!(&nodes[1], 1);
953 assert!(update_1.update_fail_htlcs.len() == 1);
954 let fail_msg = update_1.update_fail_htlcs[0].clone();
955 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
956 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
958 // Ensure the payment fails with the expected error.
959 let error_data = Vec::new();
960 let mut fail_conditions = PaymentFailedConditions::new()
961 .blamed_scid(phantom_scid)
962 .blamed_chan_closed(true)
963 .expected_htlc_error_data(0x4000 | 22, &error_data);
964 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
968 fn test_phantom_final_incorrect_cltv_expiry() {
969 let chanmon_cfgs = create_chanmon_cfgs(2);
970 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
971 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
972 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
974 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
977 let recv_value_msat = 10_000;
978 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
979 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
981 // Route the HTLC through to the destination.
982 nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
983 check_added_monitors!(nodes[0], 1);
984 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
985 let mut update_add = update_0.update_add_htlcs[0].clone();
987 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
988 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
990 // Modify the payload so the phantom hop's HMAC is bogus.
991 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
992 for f in pending_forwards.iter_mut() {
994 &mut HTLCForwardInfo::AddHTLC {
995 forward_info: PendingHTLCInfo { ref mut outgoing_cltv_value, .. }, ..
997 *outgoing_cltv_value += 1;
999 _ => panic!("Unexpected forward"),
1003 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1004 nodes[1].node.process_pending_htlc_forwards();
1005 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1006 nodes[1].node.process_pending_htlc_forwards();
1007 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1008 check_added_monitors!(&nodes[1], 1);
1009 assert!(update_1.update_fail_htlcs.len() == 1);
1010 let fail_msg = update_1.update_fail_htlcs[0].clone();
1011 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1012 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1014 // Ensure the payment fails with the expected error.
1015 let expected_cltv = 82;
1016 let error_data = byte_utils::be32_to_array(expected_cltv).to_vec();
1017 let mut fail_conditions = PaymentFailedConditions::new()
1018 .blamed_scid(phantom_scid)
1019 .expected_htlc_error_data(18, &error_data);
1020 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1024 fn test_phantom_failure_too_low_cltv() {
1025 let chanmon_cfgs = create_chanmon_cfgs(2);
1026 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1027 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1028 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1030 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1033 let recv_value_msat = 10_000;
1034 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1035 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1037 // Modify the route to have a too-low cltv.
1038 route.paths[0][1].cltv_expiry_delta = 5;
1040 // Route the HTLC through to the destination.
1041 nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
1042 check_added_monitors!(nodes[0], 1);
1043 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1044 let mut update_add = update_0.update_add_htlcs[0].clone();
1046 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1047 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1049 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1050 nodes[1].node.process_pending_htlc_forwards();
1051 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1052 nodes[1].node.process_pending_htlc_forwards();
1053 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1054 check_added_monitors!(&nodes[1], 1);
1055 assert!(update_1.update_fail_htlcs.len() == 1);
1056 let fail_msg = update_1.update_fail_htlcs[0].clone();
1057 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1058 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1060 // Ensure the payment fails with the expected error.
1061 let error_data = Vec::new();
1062 let mut fail_conditions = PaymentFailedConditions::new()
1063 .blamed_scid(phantom_scid)
1064 .expected_htlc_error_data(17, &error_data);
1065 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1069 fn test_phantom_failure_too_low_recv_amt() {
1070 let chanmon_cfgs = create_chanmon_cfgs(2);
1071 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1072 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1073 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1075 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1077 // Get the route with a too-low amount.
1078 let recv_amt_msat = 10_000;
1079 let bad_recv_amt_msat = recv_amt_msat - 10;
1080 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1081 let (mut route, phantom_scid) = get_phantom_route!(nodes, bad_recv_amt_msat, channel);
1083 // Route the HTLC through to the destination.
1084 nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
1085 check_added_monitors!(nodes[0], 1);
1086 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1087 let mut update_add = update_0.update_add_htlcs[0].clone();
1089 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1090 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1092 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1093 nodes[1].node.process_pending_htlc_forwards();
1094 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1095 nodes[1].node.process_pending_htlc_forwards();
1096 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
1097 nodes[1].node.process_pending_htlc_forwards();
1098 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1099 check_added_monitors!(&nodes[1], 1);
1100 assert!(update_1.update_fail_htlcs.len() == 1);
1101 let fail_msg = update_1.update_fail_htlcs[0].clone();
1102 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1103 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1105 // Ensure the payment fails with the expected error.
1106 let mut error_data = byte_utils::be64_to_array(bad_recv_amt_msat).to_vec();
1107 error_data.extend_from_slice(
1108 &byte_utils::be32_to_array(nodes[1].node.best_block.read().unwrap().height()),
1110 let mut fail_conditions = PaymentFailedConditions::new()
1111 .blamed_scid(phantom_scid)
1112 .expected_htlc_error_data(0x4000 | 15, &error_data);
1113 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1117 fn test_phantom_dust_exposure_failure() {
1118 // Set the max dust exposure to the dust limit.
1119 let max_dust_exposure = 546;
1120 let mut receiver_config = UserConfig::default();
1121 receiver_config.channel_config.max_dust_htlc_exposure_msat = max_dust_exposure;
1122 receiver_config.channel_handshake_config.announced_channel = true;
1124 let chanmon_cfgs = create_chanmon_cfgs(2);
1125 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1126 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(receiver_config)]);
1127 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1129 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1131 // Get the route with an amount exceeding the dust exposure threshold of nodes[1].
1132 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(max_dust_exposure + 1));
1133 let (mut route, _) = get_phantom_route!(nodes, max_dust_exposure + 1, channel);
1135 // Route the HTLC through to the destination.
1136 nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
1137 check_added_monitors!(nodes[0], 1);
1138 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1139 let mut update_add = update_0.update_add_htlcs[0].clone();
1141 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1142 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1144 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1145 assert!(update_1.update_fail_htlcs.len() == 1);
1146 let fail_msg = update_1.update_fail_htlcs[0].clone();
1147 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1148 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1150 // Ensure the payment fails with the expected error.
1151 let mut err_data = Vec::new();
1152 err_data.extend_from_slice(&(channel.1.serialized_length() as u16 + 2).to_be_bytes());
1153 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
1154 err_data.extend_from_slice(&channel.1.encode());
1156 let mut fail_conditions = PaymentFailedConditions::new()
1157 .blamed_scid(channel.0.contents.short_channel_id)
1158 .blamed_chan_closed(false)
1159 .expected_htlc_error_data(0x1000 | 7, &err_data);
1160 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1164 fn test_phantom_failure_reject_payment() {
1165 // Test that the user can successfully fail back a phantom node payment.
1166 let chanmon_cfgs = create_chanmon_cfgs(2);
1167 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1168 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1169 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1171 let channel = create_announced_chan_between_nodes(&nodes, 0, 1, channelmanager::provided_init_features(), channelmanager::provided_init_features());
1173 // Get the route with a too-low amount.
1174 let recv_amt_msat = 10_000;
1175 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1176 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_amt_msat, channel);
1178 // Route the HTLC through to the destination.
1179 nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(payment_secret)).unwrap();
1180 check_added_monitors!(nodes[0], 1);
1181 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1182 let mut update_add = update_0.update_add_htlcs[0].clone();
1184 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1185 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1187 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1188 nodes[1].node.process_pending_htlc_forwards();
1189 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1190 nodes[1].node.process_pending_htlc_forwards();
1191 expect_payment_received!(nodes[1], payment_hash, payment_secret, recv_amt_msat);
1192 nodes[1].node.fail_htlc_backwards(&payment_hash);
1193 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1194 nodes[1].node.process_pending_htlc_forwards();
1196 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1197 check_added_monitors!(&nodes[1], 1);
1198 assert!(update_1.update_fail_htlcs.len() == 1);
1199 let fail_msg = update_1.update_fail_htlcs[0].clone();
1200 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1201 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1203 // Ensure the payment fails with the expected error.
1204 let mut error_data = byte_utils::be64_to_array(recv_amt_msat).to_vec();
1205 error_data.extend_from_slice(
1206 &byte_utils::be32_to_array(nodes[1].node.best_block.read().unwrap().height()),
1208 let mut fail_conditions = PaymentFailedConditions::new()
1209 .blamed_scid(phantom_scid)
1210 .expected_htlc_error_data(0x4000 | 15, &error_data);
1211 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);