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::{EntropySource, NodeSigner, Recipient};
16 use crate::ln::{PaymentHash, PaymentSecret};
17 use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
18 use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, 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::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, SecretKey};
41 use crate::prelude::*;
42 use core::default::Default;
44 use crate::ln::functional_test_utils::*;
46 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>)
47 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
50 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);
54 // 0: node1 fails backward
55 // 1: final node fails backward
56 // 2: payment completed but the user rejects the payment
57 // 3: final node fails backward (but tamper onion payloads from node0)
58 // 100: trigger error in the intermediate node and tamper returning fail_htlc
59 // 200: trigger error in the final node and tamper returning fail_htlc
60 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>)
61 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
62 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
65 macro_rules! expect_event {
66 ($node: expr, $event_type: path) => {{
67 let events = $node.node.get_and_clear_pending_events();
68 assert_eq!(events.len(), 1);
70 $event_type { .. } => {},
71 _ => panic!("Unexpected event"),
76 macro_rules! expect_htlc_forward {
78 expect_event!($node, Event::PendingHTLCsForwardable);
79 $node.node.process_pending_htlc_forwards();
83 // 0 ~~> 2 send payment
84 let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
85 nodes[0].node.send_payment(&route, *payment_hash, &Some(*payment_secret), payment_id).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::PaymentClaimable);
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(), 2);
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");
216 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id } => {
217 assert_eq!(*payment_hash, ev_payment_hash);
218 assert_eq!(payment_id, ev_payment_id);
220 _ => panic!("Unexpected second event"),
224 impl msgs::ChannelUpdate {
225 fn dummy(short_channel_id: u64) -> msgs::ChannelUpdate {
226 use bitcoin::secp256k1::ffi::Signature as FFISignature;
227 use bitcoin::secp256k1::ecdsa::Signature;
228 msgs::ChannelUpdate {
229 signature: Signature::from(unsafe { FFISignature::new() }),
230 contents: msgs::UnsignedChannelUpdate {
231 chain_hash: BlockHash::hash(&vec![0u8][..]),
235 cltv_expiry_delta: 0,
236 htlc_minimum_msat: 0,
237 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
239 fee_proportional_millionths: 0,
246 struct BogusOnionHopData {
249 impl BogusOnionHopData {
250 fn new(orig: msgs::OnionHopData) -> Self {
251 Self { data: orig.encode() }
254 impl Writeable for BogusOnionHopData {
255 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
256 writer.write_all(&self.data[..])
260 const BADONION: u16 = 0x8000;
261 const PERM: u16 = 0x4000;
262 const NODE: u16 = 0x2000;
263 const UPDATE: u16 = 0x1000;
266 fn test_fee_failures() {
267 // Tests that the fee required when forwarding remains consistent over time. This was
268 // previously broken, with forwarding fees floating based on the fee estimator at the time of
271 // When this test was written, the default base fee floated based on the HTLC count.
272 // It is now fixed, so we simply set the fee to the expected value here.
273 let mut config = test_default_channel_config();
274 config.channel_config.forwarding_fee_base_msat = 196;
276 let chanmon_cfgs = create_chanmon_cfgs(3);
277 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
278 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
279 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
280 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
283 let (route, payment_hash_success, payment_preimage_success, payment_secret_success) = get_route_and_payment_hash!(nodes[0], nodes[2], 40_000);
284 nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
285 check_added_monitors!(nodes[0], 1);
286 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
287 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
289 // If the hop gives fee_insufficient but enough fees were provided, then the previous hop
290 // malleated the payment before forwarding, taking funds when they shouldn't have.
291 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
292 let short_channel_id = channels[0].0.contents.short_channel_id;
293 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
294 msg.amount_msat -= 1;
295 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
297 // In an earlier version, we spuriously failed to forward payments if the expected feerate
298 // changed between the channel open and the payment.
300 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
304 let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
305 nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
306 check_added_monitors!(nodes[0], 1);
307 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
308 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
312 fn test_onion_failure() {
313 // When we check for amount_below_minimum below, we want to test that we're using the *right*
314 // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
315 // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
316 // This exposed a previous bug because we were using the wrong value all the way down in
317 // Channel::get_counterparty_htlc_minimum_msat().
318 let mut node_2_cfg: UserConfig = Default::default();
319 node_2_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
320 node_2_cfg.channel_handshake_config.announced_channel = true;
321 node_2_cfg.channel_handshake_limits.force_announced_channel_preference = false;
323 // When this test was written, the default base fee floated based on the HTLC count.
324 // It is now fixed, so we simply set the fee to the expected value here.
325 let mut config = test_default_channel_config();
326 config.channel_config.forwarding_fee_base_msat = 196;
328 let chanmon_cfgs = create_chanmon_cfgs(3);
329 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
330 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
331 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
332 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
333 for node in nodes.iter() {
334 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
336 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
338 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
340 // intermediate node failure
341 let short_channel_id = channels[1].0.contents.short_channel_id;
342 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
343 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
344 let cur_height = nodes[0].best_block_info().1 + 1;
345 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
346 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
347 let mut new_payloads = Vec::new();
348 for payload in onion_payloads.drain(..) {
349 new_payloads.push(BogusOnionHopData::new(payload));
351 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
352 // describing a length-1 TLV payload, which is obviously bogus.
353 new_payloads[0].data[0] = 1;
354 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
355 }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
357 // final node failure
358 let short_channel_id = channels[1].0.contents.short_channel_id;
359 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
360 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
361 let cur_height = nodes[0].best_block_info().1 + 1;
362 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
363 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
364 let mut new_payloads = Vec::new();
365 for payload in onion_payloads.drain(..) {
366 new_payloads.push(BogusOnionHopData::new(payload));
368 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
369 // length-1 TLV payload, which is obviously bogus.
370 new_payloads[1].data[0] = 1;
371 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
372 }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
374 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
375 // receiving simulated fail messages
376 // intermediate node failure
377 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
379 msg.amount_msat -= 1;
381 // and tamper returning error message
382 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
383 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
384 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), NODE|2, &[0;0]);
385 }, ||{}, 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));
387 // final node failure
388 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
389 // and tamper returning error message
390 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
391 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
392 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), NODE|2, &[0;0]);
394 nodes[2].node.fail_htlc_backwards(&payment_hash);
395 }, 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));
396 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
398 // intermediate node failure
399 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
400 msg.amount_msat -= 1;
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[0].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
405 }, ||{}, 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));
407 // final node failure
408 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
409 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
410 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
411 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
413 nodes[2].node.fail_htlc_backwards(&payment_hash);
414 }, 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));
415 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
417 // intermediate node failure
418 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
419 msg.amount_msat -= 1;
421 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
422 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
423 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
425 nodes[2].node.fail_htlc_backwards(&payment_hash);
426 }, 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));
428 // final node failure
429 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
430 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
431 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
432 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
434 nodes[2].node.fail_htlc_backwards(&payment_hash);
435 }, 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));
436 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
438 // Our immediate peer sent UpdateFailMalformedHTLC because it couldn't understand the onion in
439 // the UpdateAddHTLC that we sent.
440 let short_channel_id = channels[0].0.contents.short_channel_id;
441 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
442 Some(BADONION|PERM|4), None, Some(short_channel_id));
444 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
445 Some(BADONION|PERM|5), None, Some(short_channel_id));
447 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,
448 Some(BADONION|PERM|6), None, Some(short_channel_id));
450 let short_channel_id = channels[1].0.contents.short_channel_id;
451 let chan_update = ChannelUpdate::dummy(short_channel_id);
453 let mut err_data = Vec::new();
454 err_data.extend_from_slice(&(chan_update.serialized_length() as u16 + 2).to_be_bytes());
455 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
456 err_data.extend_from_slice(&chan_update.encode());
457 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
458 msg.amount_msat -= 1;
460 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
461 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
462 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data);
463 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update.clone()}), Some(short_channel_id));
465 // Check we can still handle onion failures that include channel updates without a type prefix
466 let err_data_without_type = chan_update.encode_with_len();
467 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
468 msg.amount_msat -= 1;
470 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
471 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
472 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data_without_type);
473 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update}), Some(short_channel_id));
475 let short_channel_id = channels[1].0.contents.short_channel_id;
476 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
477 msg.amount_msat -= 1;
479 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
480 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
481 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|8, &[0;0]);
482 // short_channel_id from the processing node
483 }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
485 let short_channel_id = channels[1].0.contents.short_channel_id;
486 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
487 msg.amount_msat -= 1;
489 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
490 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
491 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|9, &[0;0]);
492 // short_channel_id from the processing node
493 }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
495 let mut bogus_route = route.clone();
496 bogus_route.paths[0][1].short_channel_id -= 1;
497 let short_channel_id = bogus_route.paths[0][1].short_channel_id;
498 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
499 Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent:true}), Some(short_channel_id));
501 let short_channel_id = channels[1].0.contents.short_channel_id;
502 let amt_to_forward = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[2].node.get_our_node_id())
503 .unwrap().lock().unwrap().channel_by_id.get(&channels[1].2).unwrap()
504 .get_counterparty_htlc_minimum_msat() - 1;
505 let mut bogus_route = route.clone();
506 let route_len = bogus_route.paths[0].len();
507 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
508 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));
510 // Clear pending payments so that the following positive test has the correct payment hash.
511 for node in nodes.iter() {
512 node.node.clear_pending_payments();
515 // Test a positive test-case with one extra msat, meeting the minimum.
516 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward + 1;
517 let preimage = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1).0;
518 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
520 let short_channel_id = channels[0].0.contents.short_channel_id;
521 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
522 msg.amount_msat -= 1;
523 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
525 let short_channel_id = channels[0].0.contents.short_channel_id;
526 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
527 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
528 msg.cltv_expiry -= 1;
529 }, || {}, true, Some(UPDATE|13), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
531 let short_channel_id = channels[1].0.contents.short_channel_id;
532 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
533 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
534 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
535 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
536 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
537 }, ||{}, true, Some(UPDATE|14), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
539 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
540 nodes[2].node.fail_htlc_backwards(&payment_hash);
541 }, false, Some(PERM|15), None, None);
542 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
544 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
545 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
546 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
547 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
548 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
549 }, || {}, false, Some(0x4000 | 15), None, None);
551 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
552 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
553 for f in pending_forwards.iter_mut() {
555 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
556 forward_info.outgoing_cltv_value += 1,
561 }, true, Some(18), None, Some(channels[1].0.contents.short_channel_id));
563 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
564 // violate amt_to_forward > msg.amount_msat
565 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
566 for f in pending_forwards.iter_mut() {
568 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
569 forward_info.outgoing_amt_msat -= 1,
574 }, true, Some(19), None, Some(channels[1].0.contents.short_channel_id));
576 let short_channel_id = channels[1].0.contents.short_channel_id;
577 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
578 // disconnect event to the channel between nodes[1] ~ nodes[2]
579 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
580 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
581 }, true, Some(UPDATE|20), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
582 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
584 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
585 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
586 let mut route = route.clone();
587 let height = nodes[2].best_block_info().1;
588 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
589 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
590 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height, &None).unwrap();
591 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
592 msg.cltv_expiry = htlc_cltv;
593 msg.onion_routing_packet = onion_packet;
594 }, ||{}, true, Some(21), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));
596 run_onion_failure_test_with_fail_intercept("mpp_timeout", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
597 // Tamper returning error message
598 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
599 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
600 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), 23, &[0;0]);
602 nodes[2].node.fail_htlc_backwards(&payment_hash);
603 }, true, Some(23), None, None);
606 fn do_test_onion_failure_stale_channel_update(announced_channel: bool) {
607 // Create a network of three nodes and two channels connecting them. We'll be updating the
608 // HTLC relay policy of the second channel, causing forwarding failures at the first hop.
609 let mut config = UserConfig::default();
610 config.channel_handshake_config.announced_channel = announced_channel;
611 config.channel_handshake_limits.force_announced_channel_preference = false;
612 config.accept_forwards_to_priv_channels = !announced_channel;
613 let chanmon_cfgs = create_chanmon_cfgs(3);
616 let channel_manager_1_deserialized;
617 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
618 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]);
619 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
621 let other_channel = create_chan_between_nodes(
622 &nodes[0], &nodes[1],
624 let channel_to_update = if announced_channel {
625 let channel = create_announced_chan_between_nodes(
628 (channel.2, channel.0.contents.short_channel_id)
630 let channel = create_unannounced_chan_between_nodes_with_value(
631 &nodes, 1, 2, 100000, 10001,
633 (channel.0.channel_id, channel.0.short_channel_id_alias.unwrap())
635 let channel_to_update_counterparty = &nodes[2].node.get_our_node_id();
637 let default_config = ChannelConfig::default();
639 // A test payment should succeed as the ChannelConfig has not been changed yet.
640 const PAYMENT_AMT: u64 = 40000;
641 let (route, payment_hash, payment_preimage, payment_secret) = if announced_channel {
642 get_route_and_payment_hash!(nodes[0], nodes[2], PAYMENT_AMT)
644 let hop_hints = vec![RouteHint(vec![RouteHintHop {
645 src_node_id: nodes[1].node.get_our_node_id(),
646 short_channel_id: channel_to_update.1,
648 base_msat: default_config.forwarding_fee_base_msat,
649 proportional_millionths: default_config.forwarding_fee_proportional_millionths,
651 cltv_expiry_delta: default_config.cltv_expiry_delta,
652 htlc_maximum_msat: None,
653 htlc_minimum_msat: None,
655 let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty, TEST_FINAL_CLTV)
656 .with_features(nodes[2].node.invoice_features())
657 .with_route_hints(hop_hints);
658 get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT, TEST_FINAL_CLTV)
660 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
661 payment_hash, payment_secret);
662 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
664 // Closure to force expiry of a channel's previous config.
665 let expire_prev_config = || {
666 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
667 nodes[1].node.timer_tick_occurred();
671 // Closure to update and retrieve the latest ChannelUpdate.
672 let update_and_get_channel_update = |config: &ChannelConfig, expect_new_update: bool,
673 prev_update: Option<&msgs::ChannelUpdate>, should_expire_prev_config: bool| -> Option<msgs::ChannelUpdate> {
674 nodes[1].node.update_channel_config(
675 channel_to_update_counterparty, &[channel_to_update.0], config,
677 let events = nodes[1].node.get_and_clear_pending_msg_events();
678 assert_eq!(events.len(), expect_new_update as usize);
679 if !expect_new_update {
682 let new_update = match &events[0] {
683 MessageSendEvent::BroadcastChannelUpdate { msg } => {
684 assert!(announced_channel);
687 MessageSendEvent::SendChannelUpdate { node_id, msg } => {
688 assert_eq!(node_id, channel_to_update_counterparty);
689 assert!(!announced_channel);
692 _ => panic!("expected Broadcast/SendChannelUpdate event"),
694 if prev_update.is_some() {
695 assert!(new_update.contents.timestamp > prev_update.unwrap().contents.timestamp)
697 if should_expire_prev_config {
698 expire_prev_config();
703 // We'll be attempting to route payments using the default ChannelUpdate for channels. This will
704 // lead to onion failures at the first hop once we update the ChannelConfig for the
706 let expect_onion_failure = |name: &str, error_code: u16, channel_update: &msgs::ChannelUpdate| {
707 let short_channel_id = channel_to_update.1;
708 let network_update = NetworkUpdate::ChannelUpdateMessage { msg: channel_update.clone() };
709 run_onion_failure_test(
710 name, 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {}, true,
711 Some(error_code), Some(network_update), Some(short_channel_id),
715 // Updates to cltv_expiry_delta below MIN_CLTV_EXPIRY_DELTA should fail with APIMisuseError.
716 let mut invalid_config = default_config.clone();
717 invalid_config.cltv_expiry_delta = 0;
718 match nodes[1].node.update_channel_config(
719 channel_to_update_counterparty, &[channel_to_update.0], &invalid_config,
721 Err(APIError::APIMisuseError{ .. }) => {},
722 _ => panic!("unexpected result applying invalid cltv_expiry_delta"),
725 // Increase the base fee which should trigger a new ChannelUpdate.
726 let mut config = nodes[1].node.list_usable_channels().iter()
727 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
729 config.forwarding_fee_base_msat = u32::max_value();
730 let msg = update_and_get_channel_update(&config, true, None, false).unwrap();
732 // The old policy should still be in effect until a new block is connected.
733 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
734 payment_hash, payment_secret);
735 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
737 // Connect a block, which should expire the previous config, leading to a failure when
738 // forwarding the HTLC.
739 expire_prev_config();
740 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
742 // Redundant updates should not trigger a new ChannelUpdate.
743 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
745 // Similarly, updates that do not have an affect on ChannelUpdate should not trigger a new one.
746 config.force_close_avoidance_max_fee_satoshis *= 2;
747 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
749 // Reset the base fee to the default and increase the proportional fee which should trigger a
750 // new ChannelUpdate.
751 config.forwarding_fee_base_msat = default_config.forwarding_fee_base_msat;
752 config.cltv_expiry_delta = u16::max_value();
753 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
754 expect_onion_failure("incorrect_cltv_expiry", UPDATE|13, &msg);
756 // Reset the proportional fee and increase the CLTV expiry delta which should trigger a new
758 config.cltv_expiry_delta = default_config.cltv_expiry_delta;
759 config.forwarding_fee_proportional_millionths = u32::max_value();
760 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
761 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
763 // To test persistence of the updated config, we'll re-initialize the ChannelManager.
764 let config_after_restart = {
765 let chan_1_monitor_serialized = get_monitor!(nodes[1], other_channel.3).encode();
766 let chan_2_monitor_serialized = get_monitor!(nodes[1], channel_to_update.0).encode();
767 reload_node!(nodes[1], *nodes[1].node.get_current_default_configuration(), &nodes[1].node.encode(),
768 &[&chan_1_monitor_serialized, &chan_2_monitor_serialized], persister, chain_monitor, channel_manager_1_deserialized);
769 nodes[1].node.list_channels().iter()
770 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
773 assert_eq!(config, config_after_restart);
777 fn test_onion_failure_stale_channel_update() {
778 do_test_onion_failure_stale_channel_update(false);
779 do_test_onion_failure_stale_channel_update(true);
783 fn test_always_create_tlv_format_onion_payloads() {
784 // Verify that we always generate tlv onion format payloads, even if the features specifically
785 // specifies no support for variable length onions, as the legacy payload format has been
786 // deprecated in BOLT4.
787 let chanmon_cfgs = create_chanmon_cfgs(3);
788 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
790 // Set `node[1]`'s init features to features which return `false` for
791 // `supports_variable_length_onion()`
792 let mut no_variable_length_onion_features = InitFeatures::empty();
793 no_variable_length_onion_features.set_static_remote_key_required();
794 *node_cfgs[1].override_init_features.borrow_mut() = Some(no_variable_length_onion_features);
796 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
797 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
799 create_announced_chan_between_nodes(&nodes, 0, 1);
800 create_announced_chan_between_nodes(&nodes, 1, 2);
802 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
803 .with_features(InvoiceFeatures::empty());
804 let (route, _payment_hash, _payment_preimage, _payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, 40000, TEST_FINAL_CLTV);
806 let hops = &route.paths[0];
807 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
808 assert!(!hops[0].node_features.supports_variable_length_onion());
809 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
810 assert!(!hops[1].node_features.supports_variable_length_onion());
812 let cur_height = nodes[0].best_block_info().1 + 1;
813 let (onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
815 match onion_payloads[0].format {
816 msgs::OnionHopDataFormat::NonFinalNode {..} => {},
818 "Should have generated a `msgs::OnionHopDataFormat::NonFinalNode` payload for `hops[0]`,
819 despite that the features signals no support for variable length onions"
822 match onion_payloads[1].format {
823 msgs::OnionHopDataFormat::FinalNode {..} => {},
825 "Should have generated a `msgs::OnionHopDataFormat::FinalNode` payload for `hops[1]`,
826 despite that the features signals no support for variable length onions"
831 fn do_test_fail_htlc_backwards_with_reason(failure_code: FailureCode) {
833 let chanmon_cfgs = create_chanmon_cfgs(2);
834 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
835 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
836 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
838 create_announced_chan_between_nodes(&nodes, 0, 1);
840 let payment_amount = 100_000;
841 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_amount);
842 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
843 check_added_monitors!(nodes[0], 1);
845 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
846 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
847 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
848 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
850 expect_pending_htlcs_forwardable!(nodes[1]);
851 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, payment_amount);
852 nodes[1].node.fail_htlc_backwards_with_reason(&payment_hash, &failure_code);
854 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash }]);
855 check_added_monitors!(nodes[1], 1);
857 let events = nodes[1].node.get_and_clear_pending_msg_events();
858 assert_eq!(events.len(), 1);
859 let (update_fail_htlc, commitment_signed) = match events[0] {
860 MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
861 assert!(update_add_htlcs.is_empty());
862 assert!(update_fulfill_htlcs.is_empty());
863 assert_eq!(update_fail_htlcs.len(), 1);
864 assert!(update_fail_malformed_htlcs.is_empty());
865 assert!(update_fee.is_none());
866 (update_fail_htlcs[0].clone(), commitment_signed)
868 _ => panic!("Unexpected event"),
871 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
872 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
874 let failure_data = match failure_code {
875 FailureCode::TemporaryNodeFailure => vec![],
876 FailureCode::RequiredNodeFeatureMissing => vec![],
877 FailureCode::IncorrectOrUnknownPaymentDetails => {
878 let mut htlc_msat_height_data = (payment_amount as u64).to_be_bytes().to_vec();
879 htlc_msat_height_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes());
880 htlc_msat_height_data
884 let failure_code = failure_code as u16;
885 let permanent_flag = 0x4000;
886 let permanent_fail = (failure_code & permanent_flag) != 0;
887 expect_payment_failed!(nodes[0], payment_hash, permanent_fail, failure_code, failure_data);
892 fn test_fail_htlc_backwards_with_reason() {
893 do_test_fail_htlc_backwards_with_reason(FailureCode::TemporaryNodeFailure);
894 do_test_fail_htlc_backwards_with_reason(FailureCode::RequiredNodeFeatureMissing);
895 do_test_fail_htlc_backwards_with_reason(FailureCode::IncorrectOrUnknownPaymentDetails);
898 macro_rules! get_phantom_route {
899 ($nodes: expr, $amt: expr, $channel: expr) => {{
900 let phantom_pubkey = $nodes[1].keys_manager.get_node_id(Recipient::PhantomNode).unwrap();
901 let phantom_route_hint = $nodes[1].node.get_phantom_route_hints();
902 let payment_params = PaymentParameters::from_node_id(phantom_pubkey, TEST_FINAL_CLTV)
903 .with_features($nodes[1].node.invoice_features())
904 .with_route_hints(vec![RouteHint(vec![
906 src_node_id: $nodes[0].node.get_our_node_id(),
907 short_channel_id: $channel.0.contents.short_channel_id,
909 base_msat: $channel.0.contents.fee_base_msat,
910 proportional_millionths: $channel.0.contents.fee_proportional_millionths,
912 cltv_expiry_delta: $channel.0.contents.cltv_expiry_delta,
913 htlc_minimum_msat: None,
914 htlc_maximum_msat: None,
917 src_node_id: phantom_route_hint.real_node_pubkey,
918 short_channel_id: phantom_route_hint.phantom_scid,
921 proportional_millionths: 0,
923 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
924 htlc_minimum_msat: None,
925 htlc_maximum_msat: None,
928 let scorer = test_utils::TestScorer::new();
929 let network_graph = $nodes[0].network_graph.read_only();
931 &$nodes[0].node.get_our_node_id(), &payment_params, &network_graph,
932 Some(&$nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
933 $amt, TEST_FINAL_CLTV, $nodes[0].logger, &scorer, &[0u8; 32]
934 ).unwrap(), phantom_route_hint.phantom_scid)
939 fn test_phantom_onion_hmac_failure() {
940 let chanmon_cfgs = create_chanmon_cfgs(2);
941 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
942 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
943 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
945 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
948 let recv_value_msat = 10_000;
949 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
950 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
952 // Route the HTLC through to the destination.
953 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
954 check_added_monitors!(nodes[0], 1);
955 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
956 let mut update_add = update_0.update_add_htlcs[0].clone();
958 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
959 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
961 // Modify the payload so the phantom hop's HMAC is bogus.
962 let sha256_of_onion = {
963 let mut forward_htlcs = nodes[1].node.forward_htlcs.lock().unwrap();
964 let mut pending_forward = forward_htlcs.get_mut(&phantom_scid).unwrap();
965 match pending_forward[0] {
966 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
967 forward_info: PendingHTLCInfo {
968 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
972 onion_packet.hmac[onion_packet.hmac.len() - 1] ^= 1;
973 Sha256::hash(&onion_packet.hop_data).into_inner().to_vec()
975 _ => panic!("Unexpected forward"),
978 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
979 nodes[1].node.process_pending_htlc_forwards();
980 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
981 nodes[1].node.process_pending_htlc_forwards();
982 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
983 check_added_monitors!(&nodes[1], 1);
984 assert!(update_1.update_fail_htlcs.len() == 1);
985 let fail_msg = update_1.update_fail_htlcs[0].clone();
986 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
987 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
989 // Ensure the payment fails with the expected error.
990 let mut fail_conditions = PaymentFailedConditions::new()
991 .blamed_scid(phantom_scid)
992 .blamed_chan_closed(true)
993 .expected_htlc_error_data(0x8000 | 0x4000 | 5, &sha256_of_onion);
994 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
998 fn test_phantom_invalid_onion_payload() {
999 let chanmon_cfgs = create_chanmon_cfgs(2);
1000 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1001 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1002 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1004 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1007 let recv_value_msat = 10_000;
1008 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1009 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1011 // We'll use the session priv later when constructing an invalid onion packet.
1012 let session_priv = [3; 32];
1013 *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
1014 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1015 check_added_monitors!(nodes[0], 1);
1016 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1017 let mut update_add = update_0.update_add_htlcs[0].clone();
1019 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1020 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1022 // Modify the onion packet to have an invalid payment amount.
1023 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1024 for f in pending_forwards.iter_mut() {
1026 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1027 forward_info: PendingHTLCInfo {
1028 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1032 // Construct the onion payloads for the entire route and an invalid amount.
1033 let height = nodes[0].best_block_info().1;
1034 let session_priv = SecretKey::from_slice(&session_priv).unwrap();
1035 let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
1036 let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(&route.paths[0], msgs::MAX_VALUE_MSAT + 1, &Some(payment_secret), height + 1, &None).unwrap();
1037 // We only want to construct the onion packet for the last hop, not the entire route, so
1038 // remove the first hop's payload and its keys.
1039 onion_keys.remove(0);
1040 onion_payloads.remove(0);
1042 let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1043 onion_packet.hop_data = new_onion_packet.hop_data;
1044 onion_packet.hmac = new_onion_packet.hmac;
1046 _ => panic!("Unexpected forward"),
1050 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1051 nodes[1].node.process_pending_htlc_forwards();
1052 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1053 nodes[1].node.process_pending_htlc_forwards();
1054 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1055 check_added_monitors!(&nodes[1], 1);
1056 assert!(update_1.update_fail_htlcs.len() == 1);
1057 let fail_msg = update_1.update_fail_htlcs[0].clone();
1058 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1059 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1061 // Ensure the payment fails with the expected error.
1062 let error_data = Vec::new();
1063 let mut fail_conditions = PaymentFailedConditions::new()
1064 .blamed_scid(phantom_scid)
1065 .blamed_chan_closed(true)
1066 .expected_htlc_error_data(0x4000 | 22, &error_data);
1067 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1071 fn test_phantom_final_incorrect_cltv_expiry() {
1072 let chanmon_cfgs = create_chanmon_cfgs(2);
1073 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1074 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1075 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1077 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1080 let recv_value_msat = 10_000;
1081 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1082 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1084 // Route the HTLC through to the destination.
1085 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1086 check_added_monitors!(nodes[0], 1);
1087 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1088 let mut update_add = update_0.update_add_htlcs[0].clone();
1090 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1091 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1093 // Modify the payload so the phantom hop's HMAC is bogus.
1094 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1095 for f in pending_forwards.iter_mut() {
1097 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1098 forward_info: PendingHTLCInfo { ref mut outgoing_cltv_value, .. }, ..
1100 *outgoing_cltv_value += 1;
1102 _ => panic!("Unexpected forward"),
1106 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1107 nodes[1].node.process_pending_htlc_forwards();
1108 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1109 nodes[1].node.process_pending_htlc_forwards();
1110 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1111 check_added_monitors!(&nodes[1], 1);
1112 assert!(update_1.update_fail_htlcs.len() == 1);
1113 let fail_msg = update_1.update_fail_htlcs[0].clone();
1114 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1115 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1117 // Ensure the payment fails with the expected error.
1118 let expected_cltv: u32 = 82;
1119 let error_data = expected_cltv.to_be_bytes().to_vec();
1120 let mut fail_conditions = PaymentFailedConditions::new()
1121 .blamed_scid(phantom_scid)
1122 .expected_htlc_error_data(18, &error_data);
1123 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1127 fn test_phantom_failure_too_low_cltv() {
1128 let chanmon_cfgs = create_chanmon_cfgs(2);
1129 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1130 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1131 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1133 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1136 let recv_value_msat = 10_000;
1137 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1138 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1140 // Modify the route to have a too-low cltv.
1141 route.paths[0][1].cltv_expiry_delta = 5;
1143 // Route the HTLC through to the destination.
1144 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1145 check_added_monitors!(nodes[0], 1);
1146 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1147 let mut update_add = update_0.update_add_htlcs[0].clone();
1149 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1150 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1152 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1153 nodes[1].node.process_pending_htlc_forwards();
1154 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1155 nodes[1].node.process_pending_htlc_forwards();
1156 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1157 check_added_monitors!(&nodes[1], 1);
1158 assert!(update_1.update_fail_htlcs.len() == 1);
1159 let fail_msg = update_1.update_fail_htlcs[0].clone();
1160 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1161 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1163 // Ensure the payment fails with the expected error.
1164 let mut error_data = recv_value_msat.to_be_bytes().to_vec();
1165 error_data.extend_from_slice(
1166 &nodes[0].node.best_block.read().unwrap().height().to_be_bytes(),
1168 let mut fail_conditions = PaymentFailedConditions::new()
1169 .blamed_scid(phantom_scid)
1170 .expected_htlc_error_data(0x4000 | 15, &error_data);
1171 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1175 fn test_phantom_failure_modified_cltv() {
1176 // Test that we fail back phantoms if the upstream node fiddled with the CLTV too much with the
1177 // correct error code.
1178 let chanmon_cfgs = create_chanmon_cfgs(2);
1179 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1180 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1181 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1183 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1186 let recv_value_msat = 10_000;
1187 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1188 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1190 // Route the HTLC through to the destination.
1191 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1192 check_added_monitors!(nodes[0], 1);
1193 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1194 let mut update_add = update_0.update_add_htlcs[0].clone();
1196 // Modify the route to have a too-low cltv.
1197 update_add.cltv_expiry -= 10;
1199 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1200 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1202 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1203 assert!(update_1.update_fail_htlcs.len() == 1);
1204 let fail_msg = update_1.update_fail_htlcs[0].clone();
1205 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1206 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1208 // Ensure the payment fails with the expected error.
1209 let mut fail_conditions = PaymentFailedConditions::new()
1210 .blamed_scid(phantom_scid)
1211 .expected_htlc_error_data(0x2000 | 2, &[]);
1212 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1216 fn test_phantom_failure_expires_too_soon() {
1217 // Test that we fail back phantoms if the HTLC got delayed and we got blocks in between with
1218 // the correct error code.
1219 let chanmon_cfgs = create_chanmon_cfgs(2);
1220 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1221 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1222 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1224 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1227 let recv_value_msat = 10_000;
1228 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1229 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1231 // Route the HTLC through to the destination.
1232 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1233 check_added_monitors!(nodes[0], 1);
1234 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1235 let mut update_add = update_0.update_add_htlcs[0].clone();
1237 connect_blocks(&nodes[1], CLTV_FAR_FAR_AWAY);
1238 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1239 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1241 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1242 assert!(update_1.update_fail_htlcs.len() == 1);
1243 let fail_msg = update_1.update_fail_htlcs[0].clone();
1244 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1245 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1247 // Ensure the payment fails with the expected error.
1248 let mut fail_conditions = PaymentFailedConditions::new()
1249 .blamed_scid(phantom_scid)
1250 .expected_htlc_error_data(0x2000 | 2, &[]);
1251 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1255 fn test_phantom_failure_too_low_recv_amt() {
1256 let chanmon_cfgs = create_chanmon_cfgs(2);
1257 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1258 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1259 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1261 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1263 // Get the route with a too-low amount.
1264 let recv_amt_msat = 10_000;
1265 let bad_recv_amt_msat = recv_amt_msat - 10;
1266 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1267 let (mut route, phantom_scid) = get_phantom_route!(nodes, bad_recv_amt_msat, channel);
1269 // Route the HTLC through to the destination.
1270 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1271 check_added_monitors!(nodes[0], 1);
1272 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1273 let mut update_add = update_0.update_add_htlcs[0].clone();
1275 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1276 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1278 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1279 nodes[1].node.process_pending_htlc_forwards();
1280 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1281 nodes[1].node.process_pending_htlc_forwards();
1282 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
1283 nodes[1].node.process_pending_htlc_forwards();
1284 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1285 check_added_monitors!(&nodes[1], 1);
1286 assert!(update_1.update_fail_htlcs.len() == 1);
1287 let fail_msg = update_1.update_fail_htlcs[0].clone();
1288 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1289 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1291 // Ensure the payment fails with the expected error.
1292 let mut error_data = bad_recv_amt_msat.to_be_bytes().to_vec();
1293 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1294 let mut fail_conditions = PaymentFailedConditions::new()
1295 .blamed_scid(phantom_scid)
1296 .expected_htlc_error_data(0x4000 | 15, &error_data);
1297 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1301 fn test_phantom_dust_exposure_failure() {
1302 // Set the max dust exposure to the dust limit.
1303 let max_dust_exposure = 546;
1304 let mut receiver_config = UserConfig::default();
1305 receiver_config.channel_config.max_dust_htlc_exposure_msat = max_dust_exposure;
1306 receiver_config.channel_handshake_config.announced_channel = true;
1308 let chanmon_cfgs = create_chanmon_cfgs(2);
1309 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1310 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(receiver_config)]);
1311 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1313 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1315 // Get the route with an amount exceeding the dust exposure threshold of nodes[1].
1316 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(max_dust_exposure + 1));
1317 let (mut route, _) = get_phantom_route!(nodes, max_dust_exposure + 1, channel);
1319 // Route the HTLC through to the destination.
1320 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1321 check_added_monitors!(nodes[0], 1);
1322 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1323 let mut update_add = update_0.update_add_htlcs[0].clone();
1325 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1326 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1328 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1329 assert!(update_1.update_fail_htlcs.len() == 1);
1330 let fail_msg = update_1.update_fail_htlcs[0].clone();
1331 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1332 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1334 // Ensure the payment fails with the expected error.
1335 let mut err_data = Vec::new();
1336 err_data.extend_from_slice(&(channel.1.serialized_length() as u16 + 2).to_be_bytes());
1337 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
1338 err_data.extend_from_slice(&channel.1.encode());
1340 let mut fail_conditions = PaymentFailedConditions::new()
1341 .blamed_scid(channel.0.contents.short_channel_id)
1342 .blamed_chan_closed(false)
1343 .expected_htlc_error_data(0x1000 | 7, &err_data);
1344 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1348 fn test_phantom_failure_reject_payment() {
1349 // Test that the user can successfully fail back a phantom node payment.
1350 let chanmon_cfgs = create_chanmon_cfgs(2);
1351 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1352 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1353 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1355 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1357 // Get the route with a too-low amount.
1358 let recv_amt_msat = 10_000;
1359 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1360 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_amt_msat, channel);
1362 // Route the HTLC through to the destination.
1363 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1364 check_added_monitors!(nodes[0], 1);
1365 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1366 let mut update_add = update_0.update_add_htlcs[0].clone();
1368 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1369 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1371 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1372 nodes[1].node.process_pending_htlc_forwards();
1373 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1374 nodes[1].node.process_pending_htlc_forwards();
1375 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, recv_amt_msat, None, route.paths[0].last().unwrap().pubkey);
1376 nodes[1].node.fail_htlc_backwards(&payment_hash);
1377 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1378 nodes[1].node.process_pending_htlc_forwards();
1380 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1381 check_added_monitors!(&nodes[1], 1);
1382 assert!(update_1.update_fail_htlcs.len() == 1);
1383 let fail_msg = update_1.update_fail_htlcs[0].clone();
1384 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1385 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1387 // Ensure the payment fails with the expected error.
1388 let mut error_data = recv_amt_msat.to_be_bytes().to_vec();
1389 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1390 let mut fail_conditions = PaymentFailedConditions::new()
1391 .blamed_scid(phantom_scid)
1392 .expected_htlc_error_data(0x4000 | 15, &error_data);
1393 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);