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 ln::channelmanager::{HTLCForwardInfo, PaymentPreimage, PaymentHash};
15 use ln::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
17 use routing::router::{Route, get_route};
18 use ln::features::InitFeatures;
20 use ln::msgs::{ChannelMessageHandler, HTLCFailChannelUpdate, OptionalField};
22 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
23 use util::ser::{Writeable, Writer};
24 use util::config::UserConfig;
26 use bitcoin::blockdata::block::BlockHeader;
27 use bitcoin::hash_types::BlockHash;
29 use bitcoin::hashes::sha256::Hash as Sha256;
30 use bitcoin::hashes::Hash;
32 use bitcoin::secp256k1::Secp256k1;
33 use bitcoin::secp256k1::key::SecretKey;
35 use std::default::Default;
36 use std::sync::atomic::Ordering;
39 use ln::functional_test_utils::*;
41 fn run_onion_failure_test<F1,F2>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, callback_msg: F1, callback_node: F2, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
42 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
45 run_onion_failure_test_with_fail_intercept(_name, test_case, nodes, route, payment_hash, callback_msg, |_|{}, callback_node, expected_retryable, expected_error_code, expected_channel_update);
49 // 0: node1 fails backward
50 // 1: final node fails backward
51 // 2: payment completed but the user rejects the payment
52 // 3: final node fails backward (but tamper onion payloads from node0)
53 // 100: trigger error in the intermediate node and tamper returning fail_htlc
54 // 200: trigger error in the final node and tamper returning fail_htlc
55 fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, mut callback_msg: F1, mut callback_fail: F2, mut callback_node: F3, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
56 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
57 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
62 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
63 for ix in 0..nodes.len() {
64 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
67 macro_rules! expect_event {
68 ($node: expr, $event_type: path) => {{
69 let events = $node.node.get_and_clear_pending_events();
70 assert_eq!(events.len(), 1);
72 $event_type { .. } => {},
73 _ => panic!("Unexpected event"),
78 macro_rules! expect_htlc_forward {
80 expect_event!($node, Event::PendingHTLCsForwardable);
81 $node.node.process_pending_htlc_forwards();
85 // 0 ~~> 2 send payment
86 nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
87 check_added_monitors!(nodes[0], 1);
88 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
89 // temper update_add (0 => 1)
90 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
91 if test_case == 0 || test_case == 3 || test_case == 100 {
92 callback_msg(&mut update_add_0);
95 // 0 => 1 update_add & CS
96 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
97 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
99 let update_1_0 = match test_case {
100 0|100 => { // intermediate node failure; fail backward to 0
101 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
102 assert!(update_1_0.update_fail_htlcs.len()+update_1_0.update_fail_malformed_htlcs.len()==1 && (update_1_0.update_fail_htlcs.len()==1 || update_1_0.update_fail_malformed_htlcs.len()==1));
105 1|2|3|200 => { // final node failure; forwarding to 2
106 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
108 if test_case != 200 {
111 expect_htlc_forward!(&nodes[1]);
113 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
114 check_added_monitors!(&nodes[1], 1);
115 assert_eq!(update_1.update_add_htlcs.len(), 1);
116 // tamper update_add (1 => 2)
117 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
118 if test_case != 3 && test_case != 200 {
119 callback_msg(&mut update_add_1);
123 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
124 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
126 if test_case == 2 || test_case == 200 {
127 expect_htlc_forward!(&nodes[2]);
128 expect_event!(&nodes[2], Event::PaymentReceived);
130 expect_pending_htlcs_forwardable!(nodes[2]);
133 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
134 if test_case == 2 || test_case == 200 {
135 check_added_monitors!(&nodes[2], 1);
137 assert!(update_2_1.update_fail_htlcs.len() == 1);
139 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
140 if test_case == 200 {
141 callback_fail(&mut fail_msg);
145 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
146 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
148 // backward fail on 1
149 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
150 assert!(update_1_0.update_fail_htlcs.len() == 1);
156 // 1 => 0 commitment_signed_dance
157 if update_1_0.update_fail_htlcs.len() > 0 {
158 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
159 if test_case == 100 {
160 callback_fail(&mut fail_msg);
162 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
164 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
167 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
169 let events = nodes[0].node.get_and_clear_pending_events();
170 assert_eq!(events.len(), 1);
171 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, error_data: _ } = &events[0] {
172 assert_eq!(*rejected_by_dest, !expected_retryable);
173 assert_eq!(*error_code, expected_error_code);
175 panic!("Uexpected event");
178 let events = nodes[0].node.get_and_clear_pending_msg_events();
179 if expected_channel_update.is_some() {
180 assert_eq!(events.len(), 1);
182 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
184 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
185 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
186 panic!("channel_update not found!");
189 &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
190 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
191 assert!(*short_channel_id == *expected_short_channel_id);
192 assert!(*is_permanent == *expected_is_permanent);
194 panic!("Unexpected message event");
197 &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
198 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
199 assert!(*node_id == *expected_node_id);
200 assert!(*is_permanent == *expected_is_permanent);
202 panic!("Unexpected message event");
207 _ => panic!("Unexpected message event"),
210 assert_eq!(events.len(), 0);
214 impl msgs::ChannelUpdate {
215 fn dummy() -> msgs::ChannelUpdate {
216 use bitcoin::secp256k1::ffi::Signature as FFISignature;
217 use bitcoin::secp256k1::Signature;
218 msgs::ChannelUpdate {
219 signature: Signature::from(FFISignature::new()),
220 contents: msgs::UnsignedChannelUpdate {
221 chain_hash: BlockHash::hash(&vec![0u8][..]),
225 cltv_expiry_delta: 0,
226 htlc_minimum_msat: 0,
227 htlc_maximum_msat: OptionalField::Absent,
229 fee_proportional_millionths: 0,
236 struct BogusOnionHopData {
239 impl BogusOnionHopData {
240 fn new(orig: msgs::OnionHopData) -> Self {
241 Self { data: orig.encode() }
244 impl Writeable for BogusOnionHopData {
245 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
246 writer.write_all(&self.data[..])
251 fn test_onion_failure() {
252 use ln::msgs::ChannelUpdate;
253 use ln::channelmanager::CLTV_FAR_FAR_AWAY;
254 use bitcoin::secp256k1;
256 const BADONION: u16 = 0x8000;
257 const PERM: u16 = 0x4000;
258 const NODE: u16 = 0x2000;
259 const UPDATE: u16 = 0x1000;
261 // When we check for amount_below_minimum below, we want to test that we're using the *right*
262 // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
263 // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
264 // This exposed a previous bug because we were using the wrong value all the way down in
265 // Channel::get_counterparty_htlc_minimum_msat().
266 let mut node_2_cfg: UserConfig = Default::default();
267 node_2_cfg.own_channel_config.our_htlc_minimum_msat = 2000;
268 node_2_cfg.channel_options.announced_channel = true;
269 node_2_cfg.peer_channel_config_limits.force_announced_channel_preference = false;
271 let chanmon_cfgs = create_chanmon_cfgs(3);
272 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
273 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, Some(node_2_cfg)]);
274 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
275 for node in nodes.iter() {
276 *node.keys_manager.override_session_priv.lock().unwrap() = Some([3; 32]);
278 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())];
279 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
280 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
281 let logger = test_utils::TestLogger::new();
282 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap();
284 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
286 // intermediate node failure
287 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
288 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
289 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
290 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
291 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
292 let mut new_payloads = Vec::new();
293 for payload in onion_payloads.drain(..) {
294 new_payloads.push(BogusOnionHopData::new(payload));
296 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
297 // describing a length-1 TLV payload, which is obviously bogus.
298 new_payloads[0].data[0] = 1;
299 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
300 }, ||{}, true, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
302 // final node failure
303 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
304 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
305 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
306 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
307 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
308 let mut new_payloads = Vec::new();
309 for payload in onion_payloads.drain(..) {
310 new_payloads.push(BogusOnionHopData::new(payload));
312 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
313 // length-1 TLV payload, which is obviously bogus.
314 new_payloads[1].data[0] = 1;
315 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
316 }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
318 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
319 // receiving simulated fail messages
320 // intermediate node failure
321 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
323 msg.amount_msat -= 1;
325 // and tamper returning error message
326 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
327 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
328 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
329 }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
331 // final node failure
332 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
333 // and tamper returning error message
334 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
335 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
336 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
338 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
339 }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
341 // intermediate node failure
342 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
343 msg.amount_msat -= 1;
345 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
346 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
347 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
348 }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
350 // final node failure
351 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
352 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
353 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
354 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
356 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
357 }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
359 // intermediate node failure
360 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
361 msg.amount_msat -= 1;
363 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
364 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
365 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
367 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
368 }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
370 // final node failure
371 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
372 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
373 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
374 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
376 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
377 }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
379 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
380 Some(BADONION|PERM|4), None);
382 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
383 Some(BADONION|PERM|5), None);
385 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
386 Some(BADONION|PERM|6), None);
388 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
389 msg.amount_msat -= 1;
391 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
392 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
393 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
394 }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
396 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
397 msg.amount_msat -= 1;
399 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
400 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
401 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
402 // short_channel_id from the processing node
403 }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
405 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
406 msg.amount_msat -= 1;
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[0].shared_secret[..], PERM|9, &[0;0]);
411 // short_channel_id from the processing node
412 }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
414 let mut bogus_route = route.clone();
415 bogus_route.paths[0][1].short_channel_id -= 1;
416 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
417 Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
419 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_counterparty_htlc_minimum_msat() - 1;
420 let mut bogus_route = route.clone();
421 let route_len = bogus_route.paths[0].len();
422 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
423 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
425 // Test a positive test-case with one extra msat, meeting the minimum.
426 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward + 1;
427 let (preimage, _) = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1);
428 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage, amt_to_forward+1);
430 //TODO: with new config API, we will be able to generate both valid and
431 //invalid channel_update cases.
432 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
433 msg.amount_msat -= 1;
434 }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
436 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
437 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
438 msg.cltv_expiry -= 1;
439 }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
441 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
442 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
443 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
445 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
446 }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
448 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
449 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
450 }, false, Some(PERM|15), None);
452 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
453 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
454 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
456 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
457 }, || {}, true, Some(17), None);
459 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
460 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
461 for f in pending_forwards.iter_mut() {
463 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
464 forward_info.outgoing_cltv_value += 1,
469 }, true, Some(18), None);
471 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
472 // violate amt_to_forward > msg.amount_msat
473 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
474 for f in pending_forwards.iter_mut() {
476 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
477 forward_info.amt_to_forward -= 1,
482 }, true, Some(19), None);
484 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
485 // disconnect event to the channel between nodes[1] ~ nodes[2]
486 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
487 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
488 }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
489 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
491 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
492 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
493 let mut route = route.clone();
495 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
496 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
497 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
498 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
499 msg.cltv_expiry = htlc_cltv;
500 msg.onion_routing_packet = onion_packet;
501 }, ||{}, true, Some(21), None);