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::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure};
17 use crate::ln::{PaymentHash, PaymentSecret};
18 use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
19 use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId};
20 use crate::ln::onion_utils;
21 use crate::routing::gossip::{NetworkUpdate, RoutingFees};
22 use crate::routing::router::{get_route, PaymentParameters, Route, RouteHint, RouteHintHop};
23 use crate::ln::features::{InitFeatures, InvoiceFeatures};
25 use crate::ln::msgs::{ChannelMessageHandler, ChannelUpdate};
26 use crate::ln::wire::Encode;
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 short_channel_id, ref error_code, failure: PathFailure::OnPath { ref network_update }, .. } = &events[0] {
171 assert_eq!(*payment_failed_permanently, !expected_retryable);
172 assert_eq!(*error_code, expected_error_code);
173 if expected_channel_update.is_some() {
174 match network_update {
175 Some(update) => match update {
176 &NetworkUpdate::ChannelUpdateMessage { .. } => {
177 if let NetworkUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
178 panic!("channel_update not found!");
181 &NetworkUpdate::ChannelFailure { ref short_channel_id, ref is_permanent } => {
182 if let NetworkUpdate::ChannelFailure { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
183 assert!(*short_channel_id == *expected_short_channel_id);
184 assert!(*is_permanent == *expected_is_permanent);
186 panic!("Unexpected message event");
189 &NetworkUpdate::NodeFailure { ref node_id, ref is_permanent } => {
190 if let NetworkUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
191 assert!(*node_id == *expected_node_id);
192 assert!(*is_permanent == *expected_is_permanent);
194 panic!("Unexpected message event");
198 None => panic!("Expected channel update"),
201 assert!(network_update.is_none());
203 if let Some(expected_short_channel_id) = expected_short_channel_id {
204 match short_channel_id {
205 Some(short_channel_id) => assert_eq!(*short_channel_id, expected_short_channel_id),
206 None => panic!("Expected short channel id"),
209 assert!(short_channel_id.is_none());
212 panic!("Unexpected event");
215 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id } => {
216 assert_eq!(*payment_hash, ev_payment_hash);
217 assert_eq!(payment_id, ev_payment_id);
219 _ => panic!("Unexpected second event"),
223 impl msgs::ChannelUpdate {
224 fn dummy(short_channel_id: u64) -> msgs::ChannelUpdate {
225 use bitcoin::secp256k1::ffi::Signature as FFISignature;
226 use bitcoin::secp256k1::ecdsa::Signature;
227 msgs::ChannelUpdate {
228 signature: Signature::from(unsafe { FFISignature::new() }),
229 contents: msgs::UnsignedChannelUpdate {
230 chain_hash: BlockHash::hash(&vec![0u8][..]),
234 cltv_expiry_delta: 0,
235 htlc_minimum_msat: 0,
236 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
238 fee_proportional_millionths: 0,
245 struct BogusOnionHopData {
248 impl BogusOnionHopData {
249 fn new(orig: msgs::OnionHopData) -> Self {
250 Self { data: orig.encode() }
253 impl Writeable for BogusOnionHopData {
254 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
255 writer.write_all(&self.data[..])
259 const BADONION: u16 = 0x8000;
260 const PERM: u16 = 0x4000;
261 const NODE: u16 = 0x2000;
262 const UPDATE: u16 = 0x1000;
265 fn test_fee_failures() {
266 // Tests that the fee required when forwarding remains consistent over time. This was
267 // previously broken, with forwarding fees floating based on the fee estimator at the time of
270 // When this test was written, the default base fee floated based on the HTLC count.
271 // It is now fixed, so we simply set the fee to the expected value here.
272 let mut config = test_default_channel_config();
273 config.channel_config.forwarding_fee_base_msat = 196;
275 let chanmon_cfgs = create_chanmon_cfgs(3);
276 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
277 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
278 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
279 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
282 let (route, payment_hash_success, payment_preimage_success, payment_secret_success) = get_route_and_payment_hash!(nodes[0], nodes[2], 40_000);
283 nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
284 check_added_monitors!(nodes[0], 1);
285 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
286 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
288 // If the hop gives fee_insufficient but enough fees were provided, then the previous hop
289 // malleated the payment before forwarding, taking funds when they shouldn't have.
290 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
291 let short_channel_id = channels[0].0.contents.short_channel_id;
292 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
293 msg.amount_msat -= 1;
294 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
296 // In an earlier version, we spuriously failed to forward payments if the expected feerate
297 // changed between the channel open and the payment.
299 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
303 let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
304 nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
305 check_added_monitors!(nodes[0], 1);
306 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
307 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
311 fn test_onion_failure() {
312 // When we check for amount_below_minimum below, we want to test that we're using the *right*
313 // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
314 // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
315 // This exposed a previous bug because we were using the wrong value all the way down in
316 // Channel::get_counterparty_htlc_minimum_msat().
317 let mut node_2_cfg: UserConfig = Default::default();
318 node_2_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
319 node_2_cfg.channel_handshake_config.announced_channel = true;
320 node_2_cfg.channel_handshake_limits.force_announced_channel_preference = false;
322 // When this test was written, the default base fee floated based on the HTLC count.
323 // It is now fixed, so we simply set the fee to the expected value here.
324 let mut config = test_default_channel_config();
325 config.channel_config.forwarding_fee_base_msat = 196;
327 let chanmon_cfgs = create_chanmon_cfgs(3);
328 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
329 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
330 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
331 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
332 for node in nodes.iter() {
333 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
335 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
337 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
339 // intermediate node failure
340 let short_channel_id = channels[1].0.contents.short_channel_id;
341 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
342 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
343 let cur_height = nodes[0].best_block_info().1 + 1;
344 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
345 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
346 let mut new_payloads = Vec::new();
347 for payload in onion_payloads.drain(..) {
348 new_payloads.push(BogusOnionHopData::new(payload));
350 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
351 // describing a length-1 TLV payload, which is obviously bogus.
352 new_payloads[0].data[0] = 1;
353 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
354 }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
356 // final node failure
357 let short_channel_id = channels[1].0.contents.short_channel_id;
358 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
359 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
360 let cur_height = nodes[0].best_block_info().1 + 1;
361 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
362 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
363 let mut new_payloads = Vec::new();
364 for payload in onion_payloads.drain(..) {
365 new_payloads.push(BogusOnionHopData::new(payload));
367 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
368 // length-1 TLV payload, which is obviously bogus.
369 new_payloads[1].data[0] = 1;
370 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
371 }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
373 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
374 // receiving simulated fail messages
375 // intermediate node failure
376 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
378 msg.amount_msat -= 1;
380 // and tamper returning error message
381 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
382 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
383 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), NODE|2, &[0;0]);
384 }, ||{}, 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));
386 // final node failure
387 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
388 // and tamper returning error message
389 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
390 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
391 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), NODE|2, &[0;0]);
393 nodes[2].node.fail_htlc_backwards(&payment_hash);
394 }, 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));
395 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
397 // intermediate node failure
398 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
399 msg.amount_msat -= 1;
401 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
402 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
403 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
404 }, ||{}, 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));
406 // final node failure
407 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
408 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
409 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
410 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
412 nodes[2].node.fail_htlc_backwards(&payment_hash);
413 }, 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));
414 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
416 // intermediate node failure
417 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
418 msg.amount_msat -= 1;
420 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
421 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
422 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
424 nodes[2].node.fail_htlc_backwards(&payment_hash);
425 }, 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));
427 // final node failure
428 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
429 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
430 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
431 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
433 nodes[2].node.fail_htlc_backwards(&payment_hash);
434 }, 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));
435 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
437 // Our immediate peer sent UpdateFailMalformedHTLC because it couldn't understand the onion in
438 // the UpdateAddHTLC that we sent.
439 let short_channel_id = channels[0].0.contents.short_channel_id;
440 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
441 Some(BADONION|PERM|4), None, Some(short_channel_id));
443 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
444 Some(BADONION|PERM|5), None, Some(short_channel_id));
446 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,
447 Some(BADONION|PERM|6), None, Some(short_channel_id));
449 let short_channel_id = channels[1].0.contents.short_channel_id;
450 let chan_update = ChannelUpdate::dummy(short_channel_id);
452 let mut err_data = Vec::new();
453 err_data.extend_from_slice(&(chan_update.serialized_length() as u16 + 2).to_be_bytes());
454 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
455 err_data.extend_from_slice(&chan_update.encode());
456 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
457 msg.amount_msat -= 1;
459 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
460 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
461 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data);
462 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update.clone()}), Some(short_channel_id));
464 // Check we can still handle onion failures that include channel updates without a type prefix
465 let err_data_without_type = chan_update.encode_with_len();
466 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
467 msg.amount_msat -= 1;
469 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
470 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
471 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data_without_type);
472 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update}), Some(short_channel_id));
474 let short_channel_id = channels[1].0.contents.short_channel_id;
475 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
476 msg.amount_msat -= 1;
478 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
479 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
480 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|8, &[0;0]);
481 // short_channel_id from the processing node
482 }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
484 let short_channel_id = channels[1].0.contents.short_channel_id;
485 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
486 msg.amount_msat -= 1;
488 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
489 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
490 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|9, &[0;0]);
491 // short_channel_id from the processing node
492 }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
494 let mut bogus_route = route.clone();
495 bogus_route.paths[0][1].short_channel_id -= 1;
496 let short_channel_id = bogus_route.paths[0][1].short_channel_id;
497 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
498 Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent:true}), Some(short_channel_id));
500 let short_channel_id = channels[1].0.contents.short_channel_id;
501 let amt_to_forward = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[2].node.get_our_node_id())
502 .unwrap().lock().unwrap().channel_by_id.get(&channels[1].2).unwrap()
503 .get_counterparty_htlc_minimum_msat() - 1;
504 let mut bogus_route = route.clone();
505 let route_len = bogus_route.paths[0].len();
506 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
507 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));
509 // Clear pending payments so that the following positive test has the correct payment hash.
510 for node in nodes.iter() {
511 node.node.clear_pending_payments();
514 // Test a positive test-case with one extra msat, meeting the minimum.
515 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward + 1;
516 let preimage = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1).0;
517 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
519 let short_channel_id = channels[0].0.contents.short_channel_id;
520 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
521 msg.amount_msat -= 1;
522 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
524 let short_channel_id = channels[0].0.contents.short_channel_id;
525 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
526 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
527 msg.cltv_expiry -= 1;
528 }, || {}, true, Some(UPDATE|13), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
530 let short_channel_id = channels[1].0.contents.short_channel_id;
531 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
532 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
533 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
534 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
535 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
536 }, ||{}, true, Some(UPDATE|14), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
538 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
539 nodes[2].node.fail_htlc_backwards(&payment_hash);
540 }, false, Some(PERM|15), None, None);
541 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
543 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
544 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
545 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
546 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
547 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
548 }, || {}, false, Some(0x4000 | 15), None, None);
550 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
551 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
552 for f in pending_forwards.iter_mut() {
554 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
555 forward_info.outgoing_cltv_value -= 1,
560 }, true, Some(18), None, Some(channels[1].0.contents.short_channel_id));
562 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
563 // violate amt_to_forward > msg.amount_msat
564 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
565 for f in pending_forwards.iter_mut() {
567 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
568 forward_info.outgoing_amt_msat -= 1,
573 }, true, Some(19), None, Some(channels[1].0.contents.short_channel_id));
575 let short_channel_id = channels[1].0.contents.short_channel_id;
576 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
577 // disconnect event to the channel between nodes[1] ~ nodes[2]
578 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
579 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
580 }, true, Some(UPDATE|20), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
581 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
583 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
584 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
585 let mut route = route.clone();
586 let height = nodes[2].best_block_info().1;
587 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
588 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
589 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height, &None).unwrap();
590 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
591 msg.cltv_expiry = htlc_cltv;
592 msg.onion_routing_packet = onion_packet;
593 }, ||{}, true, Some(21), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));
595 run_onion_failure_test_with_fail_intercept("mpp_timeout", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
596 // Tamper returning error message
597 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
598 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
599 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), 23, &[0;0]);
601 nodes[2].node.fail_htlc_backwards(&payment_hash);
602 }, true, Some(23), None, None);
606 fn test_overshoot_final_cltv() {
607 let chanmon_cfgs = create_chanmon_cfgs(3);
608 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
609 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None; 3]);
610 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
611 create_announced_chan_between_nodes(&nodes, 0, 1);
612 create_announced_chan_between_nodes(&nodes, 1, 2);
613 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
615 let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
616 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), payment_id).unwrap();
618 check_added_monitors!(nodes[0], 1);
619 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
620 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
621 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
622 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
624 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
625 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
626 for f in pending_forwards.iter_mut() {
628 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
629 forward_info.outgoing_cltv_value += 1,
634 expect_pending_htlcs_forwardable!(nodes[1]);
636 check_added_monitors!(&nodes[1], 1);
637 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
638 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
639 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
640 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
642 expect_pending_htlcs_forwardable!(nodes[2]);
643 expect_payment_claimable!(nodes[2], payment_hash, payment_secret, 40_000);
644 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
647 fn do_test_onion_failure_stale_channel_update(announced_channel: bool) {
648 // Create a network of three nodes and two channels connecting them. We'll be updating the
649 // HTLC relay policy of the second channel, causing forwarding failures at the first hop.
650 let mut config = UserConfig::default();
651 config.channel_handshake_config.announced_channel = announced_channel;
652 config.channel_handshake_limits.force_announced_channel_preference = false;
653 config.accept_forwards_to_priv_channels = !announced_channel;
654 let chanmon_cfgs = create_chanmon_cfgs(3);
657 let channel_manager_1_deserialized;
658 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
659 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]);
660 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
662 let other_channel = create_chan_between_nodes(
663 &nodes[0], &nodes[1],
665 let channel_to_update = if announced_channel {
666 let channel = create_announced_chan_between_nodes(
669 (channel.2, channel.0.contents.short_channel_id)
671 let channel = create_unannounced_chan_between_nodes_with_value(
672 &nodes, 1, 2, 100000, 10001,
674 (channel.0.channel_id, channel.0.short_channel_id_alias.unwrap())
676 let channel_to_update_counterparty = &nodes[2].node.get_our_node_id();
678 let default_config = ChannelConfig::default();
680 // A test payment should succeed as the ChannelConfig has not been changed yet.
681 const PAYMENT_AMT: u64 = 40000;
682 let (route, payment_hash, payment_preimage, payment_secret) = if announced_channel {
683 get_route_and_payment_hash!(nodes[0], nodes[2], PAYMENT_AMT)
685 let hop_hints = vec![RouteHint(vec![RouteHintHop {
686 src_node_id: nodes[1].node.get_our_node_id(),
687 short_channel_id: channel_to_update.1,
689 base_msat: default_config.forwarding_fee_base_msat,
690 proportional_millionths: default_config.forwarding_fee_proportional_millionths,
692 cltv_expiry_delta: default_config.cltv_expiry_delta,
693 htlc_maximum_msat: None,
694 htlc_minimum_msat: None,
696 let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty, TEST_FINAL_CLTV)
697 .with_features(nodes[2].node.invoice_features())
698 .with_route_hints(hop_hints);
699 get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT, TEST_FINAL_CLTV)
701 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
702 payment_hash, payment_secret);
703 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
705 // Closure to force expiry of a channel's previous config.
706 let expire_prev_config = || {
707 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
708 nodes[1].node.timer_tick_occurred();
712 // Closure to update and retrieve the latest ChannelUpdate.
713 let update_and_get_channel_update = |config: &ChannelConfig, expect_new_update: bool,
714 prev_update: Option<&msgs::ChannelUpdate>, should_expire_prev_config: bool| -> Option<msgs::ChannelUpdate> {
715 nodes[1].node.update_channel_config(
716 channel_to_update_counterparty, &[channel_to_update.0], config,
718 let events = nodes[1].node.get_and_clear_pending_msg_events();
719 assert_eq!(events.len(), expect_new_update as usize);
720 if !expect_new_update {
723 let new_update = match &events[0] {
724 MessageSendEvent::BroadcastChannelUpdate { msg } => {
725 assert!(announced_channel);
728 MessageSendEvent::SendChannelUpdate { node_id, msg } => {
729 assert_eq!(node_id, channel_to_update_counterparty);
730 assert!(!announced_channel);
733 _ => panic!("expected Broadcast/SendChannelUpdate event"),
735 if prev_update.is_some() {
736 assert!(new_update.contents.timestamp > prev_update.unwrap().contents.timestamp)
738 if should_expire_prev_config {
739 expire_prev_config();
744 // We'll be attempting to route payments using the default ChannelUpdate for channels. This will
745 // lead to onion failures at the first hop once we update the ChannelConfig for the
747 let expect_onion_failure = |name: &str, error_code: u16, channel_update: &msgs::ChannelUpdate| {
748 let short_channel_id = channel_to_update.1;
749 let network_update = NetworkUpdate::ChannelUpdateMessage { msg: channel_update.clone() };
750 run_onion_failure_test(
751 name, 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {}, true,
752 Some(error_code), Some(network_update), Some(short_channel_id),
756 // Updates to cltv_expiry_delta below MIN_CLTV_EXPIRY_DELTA should fail with APIMisuseError.
757 let mut invalid_config = default_config.clone();
758 invalid_config.cltv_expiry_delta = 0;
759 match nodes[1].node.update_channel_config(
760 channel_to_update_counterparty, &[channel_to_update.0], &invalid_config,
762 Err(APIError::APIMisuseError{ .. }) => {},
763 _ => panic!("unexpected result applying invalid cltv_expiry_delta"),
766 // Increase the base fee which should trigger a new ChannelUpdate.
767 let mut config = nodes[1].node.list_usable_channels().iter()
768 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
770 config.forwarding_fee_base_msat = u32::max_value();
771 let msg = update_and_get_channel_update(&config, true, None, false).unwrap();
773 // The old policy should still be in effect until a new block is connected.
774 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
775 payment_hash, payment_secret);
776 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
778 // Connect a block, which should expire the previous config, leading to a failure when
779 // forwarding the HTLC.
780 expire_prev_config();
781 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
783 // Redundant updates should not trigger a new ChannelUpdate.
784 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
786 // Similarly, updates that do not have an affect on ChannelUpdate should not trigger a new one.
787 config.force_close_avoidance_max_fee_satoshis *= 2;
788 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
790 // Reset the base fee to the default and increase the proportional fee which should trigger a
791 // new ChannelUpdate.
792 config.forwarding_fee_base_msat = default_config.forwarding_fee_base_msat;
793 config.cltv_expiry_delta = u16::max_value();
794 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
795 expect_onion_failure("incorrect_cltv_expiry", UPDATE|13, &msg);
797 // Reset the proportional fee and increase the CLTV expiry delta which should trigger a new
799 config.cltv_expiry_delta = default_config.cltv_expiry_delta;
800 config.forwarding_fee_proportional_millionths = u32::max_value();
801 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
802 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
804 // To test persistence of the updated config, we'll re-initialize the ChannelManager.
805 let config_after_restart = {
806 let chan_1_monitor_serialized = get_monitor!(nodes[1], other_channel.3).encode();
807 let chan_2_monitor_serialized = get_monitor!(nodes[1], channel_to_update.0).encode();
808 reload_node!(nodes[1], *nodes[1].node.get_current_default_configuration(), &nodes[1].node.encode(),
809 &[&chan_1_monitor_serialized, &chan_2_monitor_serialized], persister, chain_monitor, channel_manager_1_deserialized);
810 nodes[1].node.list_channels().iter()
811 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
814 assert_eq!(config, config_after_restart);
818 fn test_onion_failure_stale_channel_update() {
819 do_test_onion_failure_stale_channel_update(false);
820 do_test_onion_failure_stale_channel_update(true);
824 fn test_always_create_tlv_format_onion_payloads() {
825 // Verify that we always generate tlv onion format payloads, even if the features specifically
826 // specifies no support for variable length onions, as the legacy payload format has been
827 // deprecated in BOLT4.
828 let chanmon_cfgs = create_chanmon_cfgs(3);
829 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
831 // Set `node[1]`'s init features to features which return `false` for
832 // `supports_variable_length_onion()`
833 let mut no_variable_length_onion_features = InitFeatures::empty();
834 no_variable_length_onion_features.set_static_remote_key_required();
835 *node_cfgs[1].override_init_features.borrow_mut() = Some(no_variable_length_onion_features);
837 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
838 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
840 create_announced_chan_between_nodes(&nodes, 0, 1);
841 create_announced_chan_between_nodes(&nodes, 1, 2);
843 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
844 .with_features(InvoiceFeatures::empty());
845 let (route, _payment_hash, _payment_preimage, _payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, 40000, TEST_FINAL_CLTV);
847 let hops = &route.paths[0];
848 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
849 assert!(!hops[0].node_features.supports_variable_length_onion());
850 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
851 assert!(!hops[1].node_features.supports_variable_length_onion());
853 let cur_height = nodes[0].best_block_info().1 + 1;
854 let (onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
856 match onion_payloads[0].format {
857 msgs::OnionHopDataFormat::NonFinalNode {..} => {},
859 "Should have generated a `msgs::OnionHopDataFormat::NonFinalNode` payload for `hops[0]`,
860 despite that the features signals no support for variable length onions"
863 match onion_payloads[1].format {
864 msgs::OnionHopDataFormat::FinalNode {..} => {},
866 "Should have generated a `msgs::OnionHopDataFormat::FinalNode` payload for `hops[1]`,
867 despite that the features signals no support for variable length onions"
872 fn do_test_fail_htlc_backwards_with_reason(failure_code: FailureCode) {
874 let chanmon_cfgs = create_chanmon_cfgs(2);
875 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
876 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
877 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
879 create_announced_chan_between_nodes(&nodes, 0, 1);
881 let payment_amount = 100_000;
882 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_amount);
883 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
884 check_added_monitors!(nodes[0], 1);
886 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
887 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
888 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
889 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
891 expect_pending_htlcs_forwardable!(nodes[1]);
892 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, payment_amount);
893 nodes[1].node.fail_htlc_backwards_with_reason(&payment_hash, failure_code);
895 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash }]);
896 check_added_monitors!(nodes[1], 1);
898 let events = nodes[1].node.get_and_clear_pending_msg_events();
899 assert_eq!(events.len(), 1);
900 let (update_fail_htlc, commitment_signed) = match events[0] {
901 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 } } => {
902 assert!(update_add_htlcs.is_empty());
903 assert!(update_fulfill_htlcs.is_empty());
904 assert_eq!(update_fail_htlcs.len(), 1);
905 assert!(update_fail_malformed_htlcs.is_empty());
906 assert!(update_fee.is_none());
907 (update_fail_htlcs[0].clone(), commitment_signed)
909 _ => panic!("Unexpected event"),
912 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
913 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
915 let failure_data = match failure_code {
916 FailureCode::TemporaryNodeFailure => vec![],
917 FailureCode::RequiredNodeFeatureMissing => vec![],
918 FailureCode::IncorrectOrUnknownPaymentDetails => {
919 let mut htlc_msat_height_data = (payment_amount as u64).to_be_bytes().to_vec();
920 htlc_msat_height_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes());
921 htlc_msat_height_data
925 let failure_code = failure_code as u16;
926 let permanent_flag = 0x4000;
927 let permanent_fail = (failure_code & permanent_flag) != 0;
928 expect_payment_failed!(nodes[0], payment_hash, permanent_fail, failure_code, failure_data);
933 fn test_fail_htlc_backwards_with_reason() {
934 do_test_fail_htlc_backwards_with_reason(FailureCode::TemporaryNodeFailure);
935 do_test_fail_htlc_backwards_with_reason(FailureCode::RequiredNodeFeatureMissing);
936 do_test_fail_htlc_backwards_with_reason(FailureCode::IncorrectOrUnknownPaymentDetails);
939 macro_rules! get_phantom_route {
940 ($nodes: expr, $amt: expr, $channel: expr) => {{
941 let phantom_pubkey = $nodes[1].keys_manager.get_node_id(Recipient::PhantomNode).unwrap();
942 let phantom_route_hint = $nodes[1].node.get_phantom_route_hints();
943 let payment_params = PaymentParameters::from_node_id(phantom_pubkey, TEST_FINAL_CLTV)
944 .with_features($nodes[1].node.invoice_features())
945 .with_route_hints(vec![RouteHint(vec![
947 src_node_id: $nodes[0].node.get_our_node_id(),
948 short_channel_id: $channel.0.contents.short_channel_id,
950 base_msat: $channel.0.contents.fee_base_msat,
951 proportional_millionths: $channel.0.contents.fee_proportional_millionths,
953 cltv_expiry_delta: $channel.0.contents.cltv_expiry_delta,
954 htlc_minimum_msat: None,
955 htlc_maximum_msat: None,
958 src_node_id: phantom_route_hint.real_node_pubkey,
959 short_channel_id: phantom_route_hint.phantom_scid,
962 proportional_millionths: 0,
964 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
965 htlc_minimum_msat: None,
966 htlc_maximum_msat: None,
969 let scorer = test_utils::TestScorer::new();
970 let network_graph = $nodes[0].network_graph.read_only();
972 &$nodes[0].node.get_our_node_id(), &payment_params, &network_graph,
973 Some(&$nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
974 $amt, TEST_FINAL_CLTV, $nodes[0].logger, &scorer, &[0u8; 32]
975 ).unwrap(), phantom_route_hint.phantom_scid)
980 fn test_phantom_onion_hmac_failure() {
981 let chanmon_cfgs = create_chanmon_cfgs(2);
982 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
983 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
984 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
986 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
989 let recv_value_msat = 10_000;
990 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
991 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
993 // Route the HTLC through to the destination.
994 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
995 check_added_monitors!(nodes[0], 1);
996 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
997 let mut update_add = update_0.update_add_htlcs[0].clone();
999 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1000 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1002 // Modify the payload so the phantom hop's HMAC is bogus.
1003 let sha256_of_onion = {
1004 let mut forward_htlcs = nodes[1].node.forward_htlcs.lock().unwrap();
1005 let mut pending_forward = forward_htlcs.get_mut(&phantom_scid).unwrap();
1006 match pending_forward[0] {
1007 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1008 forward_info: PendingHTLCInfo {
1009 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1013 onion_packet.hmac[onion_packet.hmac.len() - 1] ^= 1;
1014 Sha256::hash(&onion_packet.hop_data).into_inner().to_vec()
1016 _ => panic!("Unexpected forward"),
1019 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1020 nodes[1].node.process_pending_htlc_forwards();
1021 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1022 nodes[1].node.process_pending_htlc_forwards();
1023 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1024 check_added_monitors!(&nodes[1], 1);
1025 assert!(update_1.update_fail_htlcs.len() == 1);
1026 let fail_msg = update_1.update_fail_htlcs[0].clone();
1027 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1028 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1030 // Ensure the payment fails with the expected error.
1031 let mut fail_conditions = PaymentFailedConditions::new()
1032 .blamed_scid(phantom_scid)
1033 .blamed_chan_closed(true)
1034 .expected_htlc_error_data(0x8000 | 0x4000 | 5, &sha256_of_onion);
1035 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1039 fn test_phantom_invalid_onion_payload() {
1040 let chanmon_cfgs = create_chanmon_cfgs(2);
1041 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1042 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1043 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1045 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1048 let recv_value_msat = 10_000;
1049 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1050 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1052 // We'll use the session priv later when constructing an invalid onion packet.
1053 let session_priv = [3; 32];
1054 *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
1055 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1056 check_added_monitors!(nodes[0], 1);
1057 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1058 let mut update_add = update_0.update_add_htlcs[0].clone();
1060 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1061 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1063 // Modify the onion packet to have an invalid payment amount.
1064 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1065 for f in pending_forwards.iter_mut() {
1067 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1068 forward_info: PendingHTLCInfo {
1069 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1073 // Construct the onion payloads for the entire route and an invalid amount.
1074 let height = nodes[0].best_block_info().1;
1075 let session_priv = SecretKey::from_slice(&session_priv).unwrap();
1076 let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
1077 let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(&route.paths[0], msgs::MAX_VALUE_MSAT + 1, &Some(payment_secret), height + 1, &None).unwrap();
1078 // We only want to construct the onion packet for the last hop, not the entire route, so
1079 // remove the first hop's payload and its keys.
1080 onion_keys.remove(0);
1081 onion_payloads.remove(0);
1083 let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1084 onion_packet.hop_data = new_onion_packet.hop_data;
1085 onion_packet.hmac = new_onion_packet.hmac;
1087 _ => panic!("Unexpected forward"),
1091 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1092 nodes[1].node.process_pending_htlc_forwards();
1093 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1094 nodes[1].node.process_pending_htlc_forwards();
1095 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1096 check_added_monitors!(&nodes[1], 1);
1097 assert!(update_1.update_fail_htlcs.len() == 1);
1098 let fail_msg = update_1.update_fail_htlcs[0].clone();
1099 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1100 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1102 // Ensure the payment fails with the expected error.
1103 let error_data = Vec::new();
1104 let mut fail_conditions = PaymentFailedConditions::new()
1105 .blamed_scid(phantom_scid)
1106 .blamed_chan_closed(true)
1107 .expected_htlc_error_data(0x4000 | 22, &error_data);
1108 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1112 fn test_phantom_final_incorrect_cltv_expiry() {
1113 let chanmon_cfgs = create_chanmon_cfgs(2);
1114 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1115 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1116 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1118 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1121 let recv_value_msat = 10_000;
1122 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1123 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1125 // Route the HTLC through to the destination.
1126 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1127 check_added_monitors!(nodes[0], 1);
1128 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1129 let mut update_add = update_0.update_add_htlcs[0].clone();
1131 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1132 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1134 // Modify the payload so the phantom hop's HMAC is bogus.
1135 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1136 for f in pending_forwards.iter_mut() {
1138 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1139 forward_info: PendingHTLCInfo { ref mut outgoing_cltv_value, .. }, ..
1141 *outgoing_cltv_value -= 1;
1143 _ => panic!("Unexpected forward"),
1147 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1148 nodes[1].node.process_pending_htlc_forwards();
1149 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1150 nodes[1].node.process_pending_htlc_forwards();
1151 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1152 check_added_monitors!(&nodes[1], 1);
1153 assert!(update_1.update_fail_htlcs.len() == 1);
1154 let fail_msg = update_1.update_fail_htlcs[0].clone();
1155 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1156 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1158 // Ensure the payment fails with the expected error.
1159 let expected_cltv: u32 = 80;
1160 let error_data = expected_cltv.to_be_bytes().to_vec();
1161 let mut fail_conditions = PaymentFailedConditions::new()
1162 .blamed_scid(phantom_scid)
1163 .expected_htlc_error_data(18, &error_data);
1164 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1168 fn test_phantom_failure_too_low_cltv() {
1169 let chanmon_cfgs = create_chanmon_cfgs(2);
1170 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1171 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1172 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1174 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1177 let recv_value_msat = 10_000;
1178 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1179 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1181 // Modify the route to have a too-low cltv.
1182 route.paths[0][1].cltv_expiry_delta = 5;
1184 // Route the HTLC through to the destination.
1185 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1186 check_added_monitors!(nodes[0], 1);
1187 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1188 let mut update_add = update_0.update_add_htlcs[0].clone();
1190 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1191 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1193 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1194 nodes[1].node.process_pending_htlc_forwards();
1195 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1196 nodes[1].node.process_pending_htlc_forwards();
1197 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1198 check_added_monitors!(&nodes[1], 1);
1199 assert!(update_1.update_fail_htlcs.len() == 1);
1200 let fail_msg = update_1.update_fail_htlcs[0].clone();
1201 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1202 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1204 // Ensure the payment fails with the expected error.
1205 let mut error_data = recv_value_msat.to_be_bytes().to_vec();
1206 error_data.extend_from_slice(
1207 &nodes[0].node.best_block.read().unwrap().height().to_be_bytes(),
1209 let mut fail_conditions = PaymentFailedConditions::new()
1210 .blamed_scid(phantom_scid)
1211 .expected_htlc_error_data(0x4000 | 15, &error_data);
1212 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1216 fn test_phantom_failure_modified_cltv() {
1217 // Test that we fail back phantoms if the upstream node fiddled with the CLTV too much with the
1218 // 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 // Modify the route to have a too-low cltv.
1238 update_add.cltv_expiry -= 10;
1240 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1241 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1243 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1244 assert!(update_1.update_fail_htlcs.len() == 1);
1245 let fail_msg = update_1.update_fail_htlcs[0].clone();
1246 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1247 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1249 // Ensure the payment fails with the expected error.
1250 let mut fail_conditions = PaymentFailedConditions::new()
1251 .blamed_scid(phantom_scid)
1252 .expected_htlc_error_data(0x2000 | 2, &[]);
1253 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1257 fn test_phantom_failure_expires_too_soon() {
1258 // Test that we fail back phantoms if the HTLC got delayed and we got blocks in between with
1259 // the correct error code.
1260 let chanmon_cfgs = create_chanmon_cfgs(2);
1261 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1262 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1263 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1265 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1268 let recv_value_msat = 10_000;
1269 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1270 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1272 // Route the HTLC through to the destination.
1273 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1274 check_added_monitors!(nodes[0], 1);
1275 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1276 let mut update_add = update_0.update_add_htlcs[0].clone();
1278 connect_blocks(&nodes[1], CLTV_FAR_FAR_AWAY);
1279 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1280 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1282 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1283 assert!(update_1.update_fail_htlcs.len() == 1);
1284 let fail_msg = update_1.update_fail_htlcs[0].clone();
1285 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1286 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1288 // Ensure the payment fails with the expected error.
1289 let mut fail_conditions = PaymentFailedConditions::new()
1290 .blamed_scid(phantom_scid)
1291 .expected_htlc_error_data(0x2000 | 2, &[]);
1292 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1296 fn test_phantom_failure_too_low_recv_amt() {
1297 let chanmon_cfgs = create_chanmon_cfgs(2);
1298 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1299 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1300 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1302 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1304 // Get the route with a too-low amount.
1305 let recv_amt_msat = 10_000;
1306 let bad_recv_amt_msat = recv_amt_msat - 10;
1307 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1308 let (mut route, phantom_scid) = get_phantom_route!(nodes, bad_recv_amt_msat, channel);
1310 // Route the HTLC through to the destination.
1311 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1312 check_added_monitors!(nodes[0], 1);
1313 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1314 let mut update_add = update_0.update_add_htlcs[0].clone();
1316 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1317 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1319 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1320 nodes[1].node.process_pending_htlc_forwards();
1321 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1322 nodes[1].node.process_pending_htlc_forwards();
1323 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
1324 nodes[1].node.process_pending_htlc_forwards();
1325 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1326 check_added_monitors!(&nodes[1], 1);
1327 assert!(update_1.update_fail_htlcs.len() == 1);
1328 let fail_msg = update_1.update_fail_htlcs[0].clone();
1329 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1330 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1332 // Ensure the payment fails with the expected error.
1333 let mut error_data = bad_recv_amt_msat.to_be_bytes().to_vec();
1334 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1335 let mut fail_conditions = PaymentFailedConditions::new()
1336 .blamed_scid(phantom_scid)
1337 .expected_htlc_error_data(0x4000 | 15, &error_data);
1338 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1342 fn test_phantom_dust_exposure_failure() {
1343 // Set the max dust exposure to the dust limit.
1344 let max_dust_exposure = 546;
1345 let mut receiver_config = UserConfig::default();
1346 receiver_config.channel_config.max_dust_htlc_exposure_msat = max_dust_exposure;
1347 receiver_config.channel_handshake_config.announced_channel = true;
1349 let chanmon_cfgs = create_chanmon_cfgs(2);
1350 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1351 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(receiver_config)]);
1352 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1354 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1356 // Get the route with an amount exceeding the dust exposure threshold of nodes[1].
1357 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(max_dust_exposure + 1));
1358 let (mut route, _) = get_phantom_route!(nodes, max_dust_exposure + 1, channel);
1360 // Route the HTLC through to the destination.
1361 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1362 check_added_monitors!(nodes[0], 1);
1363 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1364 let mut update_add = update_0.update_add_htlcs[0].clone();
1366 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1367 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1369 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1370 assert!(update_1.update_fail_htlcs.len() == 1);
1371 let fail_msg = update_1.update_fail_htlcs[0].clone();
1372 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1373 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1375 // Ensure the payment fails with the expected error.
1376 let mut err_data = Vec::new();
1377 err_data.extend_from_slice(&(channel.1.serialized_length() as u16 + 2).to_be_bytes());
1378 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
1379 err_data.extend_from_slice(&channel.1.encode());
1381 let mut fail_conditions = PaymentFailedConditions::new()
1382 .blamed_scid(channel.0.contents.short_channel_id)
1383 .blamed_chan_closed(false)
1384 .expected_htlc_error_data(0x1000 | 7, &err_data);
1385 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1389 fn test_phantom_failure_reject_payment() {
1390 // Test that the user can successfully fail back a phantom node payment.
1391 let chanmon_cfgs = create_chanmon_cfgs(2);
1392 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1393 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1394 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1396 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1398 // Get the route with a too-low amount.
1399 let recv_amt_msat = 10_000;
1400 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1401 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_amt_msat, channel);
1403 // Route the HTLC through to the destination.
1404 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
1405 check_added_monitors!(nodes[0], 1);
1406 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1407 let mut update_add = update_0.update_add_htlcs[0].clone();
1409 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1410 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1412 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1413 nodes[1].node.process_pending_htlc_forwards();
1414 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1415 nodes[1].node.process_pending_htlc_forwards();
1416 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, recv_amt_msat, None, route.paths[0].last().unwrap().pubkey);
1417 nodes[1].node.fail_htlc_backwards(&payment_hash);
1418 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1419 nodes[1].node.process_pending_htlc_forwards();
1421 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1422 check_added_monitors!(&nodes[1], 1);
1423 assert!(update_1.update_fail_htlcs.len() == 1);
1424 let fail_msg = update_1.update_fail_htlcs[0].clone();
1425 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1426 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1428 // Ensure the payment fails with the expected error.
1429 let mut error_data = recv_amt_msat.to_be_bytes().to_vec();
1430 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1431 let mut fail_conditions = PaymentFailedConditions::new()
1432 .blamed_scid(phantom_scid)
1433 .expected_htlc_error_data(0x4000 | 15, &error_data);
1434 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);