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