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 chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
15 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
16 use ln::channelmanager::{HTLCForwardInfo, CLTV_FAR_FAR_AWAY};
18 use routing::router::{Route, get_route};
19 use routing::network_graph::NetworkUpdate;
20 use ln::features::{InitFeatures, InvoiceFeatures};
22 use ln::msgs::{ChannelMessageHandler, ChannelUpdate, OptionalField};
24 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
25 use util::ser::{Writeable, Writer};
26 use util::config::UserConfig;
28 use bitcoin::hash_types::BlockHash;
30 use bitcoin::hashes::sha256::Hash as Sha256;
31 use bitcoin::hashes::Hash;
33 use bitcoin::secp256k1;
34 use bitcoin::secp256k1::Secp256k1;
35 use bitcoin::secp256k1::key::SecretKey;
39 use core::default::Default;
41 use ln::functional_test_utils::*;
43 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>)
44 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
47 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);
51 // 0: node1 fails backward
52 // 1: final node fails backward
53 // 2: payment completed but the user rejects the payment
54 // 3: final node fails backward (but tamper onion payloads from node0)
55 // 100: trigger error in the intermediate node and tamper returning fail_htlc
56 // 200: trigger error in the final node and tamper returning fail_htlc
57 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>)
58 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
59 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
62 macro_rules! expect_event {
63 ($node: expr, $event_type: path) => {{
64 let events = $node.node.get_and_clear_pending_events();
65 assert_eq!(events.len(), 1);
67 $event_type { .. } => {},
68 _ => panic!("Unexpected event"),
73 macro_rules! expect_htlc_forward {
75 expect_event!($node, Event::PendingHTLCsForwardable);
76 $node.node.process_pending_htlc_forwards();
80 // 0 ~~> 2 send payment
81 nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(*payment_secret)).unwrap();
82 check_added_monitors!(nodes[0], 1);
83 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
84 // temper update_add (0 => 1)
85 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
86 if test_case == 0 || test_case == 3 || test_case == 100 {
87 callback_msg(&mut update_add_0);
90 // 0 => 1 update_add & CS
91 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
92 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
94 let update_1_0 = match test_case {
95 0|100 => { // intermediate node failure; fail backward to 0
96 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
97 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));
100 1|2|3|200 => { // final node failure; forwarding to 2
101 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
103 if test_case != 200 {
106 expect_htlc_forward!(&nodes[1]);
108 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
109 check_added_monitors!(&nodes[1], 1);
110 assert_eq!(update_1.update_add_htlcs.len(), 1);
111 // tamper update_add (1 => 2)
112 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
113 if test_case != 3 && test_case != 200 {
114 callback_msg(&mut update_add_1);
118 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
119 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
121 if test_case == 2 || test_case == 200 {
122 expect_htlc_forward!(&nodes[2]);
123 expect_event!(&nodes[2], Event::PaymentReceived);
125 expect_pending_htlcs_forwardable!(nodes[2]);
128 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
129 if test_case == 2 || test_case == 200 {
130 check_added_monitors!(&nodes[2], 1);
132 assert!(update_2_1.update_fail_htlcs.len() == 1);
134 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
135 if test_case == 200 {
136 callback_fail(&mut fail_msg);
140 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
141 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
143 // backward fail on 1
144 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
145 assert!(update_1_0.update_fail_htlcs.len() == 1);
151 // 1 => 0 commitment_signed_dance
152 if update_1_0.update_fail_htlcs.len() > 0 {
153 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
154 if test_case == 100 {
155 callback_fail(&mut fail_msg);
157 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
159 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
162 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
164 let events = nodes[0].node.get_and_clear_pending_events();
165 assert_eq!(events.len(), 1);
166 if let &Event::PaymentPathFailed { payment_hash: _, ref rejected_by_dest, ref network_update, ref all_paths_failed, path: _, ref short_channel_id, ref error_code, error_data: _ } = &events[0] {
167 assert_eq!(*rejected_by_dest, !expected_retryable);
168 assert_eq!(*all_paths_failed, true);
169 assert_eq!(*error_code, expected_error_code);
170 if expected_channel_update.is_some() {
171 match network_update {
172 Some(update) => match update {
173 &NetworkUpdate::ChannelUpdateMessage { .. } => {
174 if let NetworkUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
175 panic!("channel_update not found!");
178 &NetworkUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
179 if let NetworkUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
180 assert!(*short_channel_id == *expected_short_channel_id);
181 assert!(*is_permanent == *expected_is_permanent);
183 panic!("Unexpected message event");
186 &NetworkUpdate::NodeFailure { ref node_id, ref is_permanent } => {
187 if let NetworkUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
188 assert!(*node_id == *expected_node_id);
189 assert!(*is_permanent == *expected_is_permanent);
191 panic!("Unexpected message event");
195 None => panic!("Expected channel update"),
198 assert!(network_update.is_none());
200 if let Some(expected_short_channel_id) = expected_short_channel_id {
201 match short_channel_id {
202 Some(short_channel_id) => assert_eq!(*short_channel_id, expected_short_channel_id),
203 None => panic!("Expected short channel id"),
206 assert!(short_channel_id.is_none());
209 panic!("Unexpected event");
213 impl msgs::ChannelUpdate {
214 fn dummy(short_channel_id: u64) -> msgs::ChannelUpdate {
215 use bitcoin::secp256k1::ffi::Signature as FFISignature;
216 use bitcoin::secp256k1::Signature;
217 msgs::ChannelUpdate {
218 signature: Signature::from(unsafe { FFISignature::new() }),
219 contents: msgs::UnsignedChannelUpdate {
220 chain_hash: BlockHash::hash(&vec![0u8][..]),
224 cltv_expiry_delta: 0,
225 htlc_minimum_msat: 0,
226 htlc_maximum_msat: OptionalField::Absent,
228 fee_proportional_millionths: 0,
235 struct BogusOnionHopData {
238 impl BogusOnionHopData {
239 fn new(orig: msgs::OnionHopData) -> Self {
240 Self { data: orig.encode() }
243 impl Writeable for BogusOnionHopData {
244 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
245 writer.write_all(&self.data[..])
249 const BADONION: u16 = 0x8000;
250 const PERM: u16 = 0x4000;
251 const NODE: u16 = 0x2000;
252 const UPDATE: u16 = 0x1000;
255 fn test_fee_failures() {
256 // Tests that the fee required when forwarding remains consistent over time. This was
257 // previously broken, with forwarding fees floating based on the fee estimator at the time of
260 // When this test was written, the default base fee floated based on the HTLC count.
261 // It is now fixed, so we simply set the fee to the expected value here.
262 let mut config = test_default_channel_config();
263 config.channel_options.forwarding_fee_base_msat = 196;
265 let chanmon_cfgs = create_chanmon_cfgs(3);
266 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
267 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
268 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
269 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known())];
270 let logger = test_utils::TestLogger::new();
271 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40_000, TEST_FINAL_CLTV, &logger).unwrap();
274 let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
275 nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success)).unwrap();
276 check_added_monitors!(nodes[0], 1);
277 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
278 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
280 // If the hop gives fee_insufficient but enough fees were provided, then the previous hop
281 // malleated the payment before forwarding, taking funds when they shouldn't have.
282 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
283 let short_channel_id = channels[0].0.contents.short_channel_id;
284 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
285 msg.amount_msat -= 1;
286 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelClosed { short_channel_id, is_permanent: true}), Some(short_channel_id));
288 // In an earlier version, we spuriously failed to forward payments if the expected feerate
289 // changed between the channel open and the payment.
291 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
295 let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
296 nodes[0].node.send_payment(&route, payment_hash_success, &Some(payment_secret_success)).unwrap();
297 check_added_monitors!(nodes[0], 1);
298 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
299 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
303 fn test_onion_failure() {
304 // When we check for amount_below_minimum below, we want to test that we're using the *right*
305 // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
306 // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
307 // This exposed a previous bug because we were using the wrong value all the way down in
308 // Channel::get_counterparty_htlc_minimum_msat().
309 let mut node_2_cfg: UserConfig = Default::default();
310 node_2_cfg.own_channel_config.our_htlc_minimum_msat = 2000;
311 node_2_cfg.channel_options.announced_channel = true;
312 node_2_cfg.peer_channel_config_limits.force_announced_channel_preference = false;
314 // When this test was written, the default base fee floated based on the HTLC count.
315 // It is now fixed, so we simply set the fee to the expected value here.
316 let mut config = test_default_channel_config();
317 config.channel_options.forwarding_fee_base_msat = 196;
319 let chanmon_cfgs = create_chanmon_cfgs(3);
320 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
321 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
322 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
323 for node in nodes.iter() {
324 *node.keys_manager.override_session_priv.lock().unwrap() = Some([3; 32]);
326 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known())];
327 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
328 let logger = test_utils::TestLogger::new();
329 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap();
331 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
333 // intermediate node failure
334 let short_channel_id = channels[1].0.contents.short_channel_id;
335 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
336 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
337 let cur_height = nodes[0].best_block_info().1 + 1;
338 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
339 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
340 let mut new_payloads = Vec::new();
341 for payload in onion_payloads.drain(..) {
342 new_payloads.push(BogusOnionHopData::new(payload));
344 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
345 // describing a length-1 TLV payload, which is obviously bogus.
346 new_payloads[0].data[0] = 1;
347 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
348 }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelClosed{short_channel_id, is_permanent: true}), Some(short_channel_id));
350 // final node failure
351 let short_channel_id = channels[1].0.contents.short_channel_id;
352 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
353 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
354 let cur_height = nodes[0].best_block_info().1 + 1;
355 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
356 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height, &None).unwrap();
357 let mut new_payloads = Vec::new();
358 for payload in onion_payloads.drain(..) {
359 new_payloads.push(BogusOnionHopData::new(payload));
361 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
362 // length-1 TLV payload, which is obviously bogus.
363 new_payloads[1].data[0] = 1;
364 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
365 }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelClosed{short_channel_id, is_permanent: true}), Some(short_channel_id));
367 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
368 // receiving simulated fail messages
369 // intermediate node failure
370 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
372 msg.amount_msat -= 1;
374 // and tamper returning error message
375 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
376 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
377 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
378 }, ||{}, true, Some(NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}), Some(route.paths[0][0].short_channel_id));
380 // final node failure
381 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
382 // and tamper returning error message
383 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
384 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
385 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
387 nodes[2].node.fail_htlc_backwards(&payment_hash);
388 }, true, Some(NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}), Some(route.paths[0][1].short_channel_id));
389 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
391 // intermediate node failure
392 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
393 msg.amount_msat -= 1;
395 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
396 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
397 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
398 }, ||{}, true, Some(PERM|NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));
400 // final node failure
401 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
402 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
403 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
404 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
406 nodes[2].node.fail_htlc_backwards(&payment_hash);
407 }, false, Some(PERM|NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}), Some(route.paths[0][1].short_channel_id));
408 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
410 // intermediate node failure
411 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
412 msg.amount_msat -= 1;
414 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
415 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
416 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
418 nodes[2].node.fail_htlc_backwards(&payment_hash);
419 }, true, Some(PERM|NODE|3), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));
421 // final node failure
422 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
423 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
424 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
425 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
427 nodes[2].node.fail_htlc_backwards(&payment_hash);
428 }, false, Some(PERM|NODE|3), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}), Some(route.paths[0][1].short_channel_id));
429 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
431 // Our immediate peer sent UpdateFailMalformedHTLC because it couldn't understand the onion in
432 // the UpdateAddHTLC that we sent.
433 let short_channel_id = channels[0].0.contents.short_channel_id;
434 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
435 Some(BADONION|PERM|4), None, Some(short_channel_id));
437 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
438 Some(BADONION|PERM|5), None, Some(short_channel_id));
440 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
441 Some(BADONION|PERM|6), None, Some(short_channel_id));
443 let short_channel_id = channels[1].0.contents.short_channel_id;
444 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
445 msg.amount_msat -= 1;
447 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
448 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
449 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy(short_channel_id).encode_with_len()[..]);
450 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
452 let short_channel_id = channels[1].0.contents.short_channel_id;
453 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
454 msg.amount_msat -= 1;
456 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
457 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
458 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
459 // short_channel_id from the processing node
460 }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelClosed{short_channel_id, is_permanent: true}), Some(short_channel_id));
462 let short_channel_id = channels[1].0.contents.short_channel_id;
463 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
464 msg.amount_msat -= 1;
466 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
467 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
468 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
469 // short_channel_id from the processing node
470 }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelClosed{short_channel_id, is_permanent: true}), Some(short_channel_id));
472 let mut bogus_route = route.clone();
473 bogus_route.paths[0][1].short_channel_id -= 1;
474 let short_channel_id = bogus_route.paths[0][1].short_channel_id;
475 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
476 Some(NetworkUpdate::ChannelClosed{short_channel_id, is_permanent:true}), Some(short_channel_id));
478 let short_channel_id = channels[1].0.contents.short_channel_id;
479 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_counterparty_htlc_minimum_msat() - 1;
480 let mut bogus_route = route.clone();
481 let route_len = bogus_route.paths[0].len();
482 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
483 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));
485 // Test a positive test-case with one extra msat, meeting the minimum.
486 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward + 1;
487 let (preimage, _, _) = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1);
488 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
490 //TODO: with new config API, we will be able to generate both valid and
491 //invalid channel_update cases.
492 let short_channel_id = channels[0].0.contents.short_channel_id;
493 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
494 msg.amount_msat -= 1;
495 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelClosed { short_channel_id, is_permanent: true}), Some(short_channel_id));
497 let short_channel_id = channels[0].0.contents.short_channel_id;
498 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
499 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
500 msg.cltv_expiry -= 1;
501 }, || {}, true, Some(UPDATE|13), Some(NetworkUpdate::ChannelClosed { short_channel_id, is_permanent: true}), Some(short_channel_id));
503 let short_channel_id = channels[1].0.contents.short_channel_id;
504 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
505 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
506 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
507 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
508 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
509 }, ||{}, true, Some(UPDATE|14), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
511 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
512 nodes[2].node.fail_htlc_backwards(&payment_hash);
513 }, false, Some(PERM|15), None, None);
514 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
516 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
517 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
518 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
519 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
520 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
521 }, || {}, true, Some(17), None, None);
523 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
524 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
525 for f in pending_forwards.iter_mut() {
527 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
528 forward_info.outgoing_cltv_value += 1,
533 }, true, Some(18), None, Some(channels[1].0.contents.short_channel_id));
535 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
536 // violate amt_to_forward > msg.amount_msat
537 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
538 for f in pending_forwards.iter_mut() {
540 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
541 forward_info.amt_to_forward -= 1,
546 }, true, Some(19), None, Some(channels[1].0.contents.short_channel_id));
548 let short_channel_id = channels[1].0.contents.short_channel_id;
549 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
550 // disconnect event to the channel between nodes[1] ~ nodes[2]
551 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
552 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
553 }, true, Some(UPDATE|20), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
554 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
556 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
557 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
558 let mut route = route.clone();
559 let height = nodes[2].best_block_info().1;
560 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
561 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
562 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height, &None).unwrap();
563 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
564 msg.cltv_expiry = htlc_cltv;
565 msg.onion_routing_packet = onion_packet;
566 }, ||{}, true, Some(21), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));