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;
18 use routing::router::{Route, get_route};
19 use ln::features::{InitFeatures, InvoiceFeatures};
21 use ln::msgs::{ChannelMessageHandler, HTLCFailChannelUpdate, OptionalField};
23 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
24 use util::ser::{Writeable, Writer};
25 use util::config::UserConfig;
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;
38 use ln::functional_test_utils::*;
40 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<HTLCFailChannelUpdate>)
41 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
44 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);
48 // 0: node1 fails backward
49 // 1: final node fails backward
50 // 2: payment completed but the user rejects the payment
51 // 3: final node fails backward (but tamper onion payloads from node0)
52 // 100: trigger error in the intermediate node and tamper returning fail_htlc
53 // 200: trigger error in the final node and tamper returning fail_htlc
54 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<HTLCFailChannelUpdate>)
55 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
56 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
59 macro_rules! expect_event {
60 ($node: expr, $event_type: path) => {{
61 let events = $node.node.get_and_clear_pending_events();
62 assert_eq!(events.len(), 1);
64 $event_type { .. } => {},
65 _ => panic!("Unexpected event"),
70 macro_rules! expect_htlc_forward {
72 expect_event!($node, Event::PendingHTLCsForwardable);
73 $node.node.process_pending_htlc_forwards();
77 // 0 ~~> 2 send payment
78 nodes[0].node.send_payment(&route, payment_hash.clone(), &Some(*payment_secret)).unwrap();
79 check_added_monitors!(nodes[0], 1);
80 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
81 // temper update_add (0 => 1)
82 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
83 if test_case == 0 || test_case == 3 || test_case == 100 {
84 callback_msg(&mut update_add_0);
87 // 0 => 1 update_add & CS
88 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
89 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
91 let update_1_0 = match test_case {
92 0|100 => { // intermediate node failure; fail backward to 0
93 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
94 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 1|2|3|200 => { // final node failure; forwarding to 2
98 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
100 if test_case != 200 {
103 expect_htlc_forward!(&nodes[1]);
105 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
106 check_added_monitors!(&nodes[1], 1);
107 assert_eq!(update_1.update_add_htlcs.len(), 1);
108 // tamper update_add (1 => 2)
109 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
110 if test_case != 3 && test_case != 200 {
111 callback_msg(&mut update_add_1);
115 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
116 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
118 if test_case == 2 || test_case == 200 {
119 expect_htlc_forward!(&nodes[2]);
120 expect_event!(&nodes[2], Event::PaymentReceived);
122 expect_pending_htlcs_forwardable!(nodes[2]);
125 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
126 if test_case == 2 || test_case == 200 {
127 check_added_monitors!(&nodes[2], 1);
129 assert!(update_2_1.update_fail_htlcs.len() == 1);
131 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
132 if test_case == 200 {
133 callback_fail(&mut fail_msg);
137 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
138 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
140 // backward fail on 1
141 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
142 assert!(update_1_0.update_fail_htlcs.len() == 1);
148 // 1 => 0 commitment_signed_dance
149 if update_1_0.update_fail_htlcs.len() > 0 {
150 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
151 if test_case == 100 {
152 callback_fail(&mut fail_msg);
154 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
156 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
159 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
161 let events = nodes[0].node.get_and_clear_pending_events();
162 assert_eq!(events.len(), 1);
163 if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, error_data: _ } = &events[0] {
164 assert_eq!(*rejected_by_dest, !expected_retryable);
165 assert_eq!(*error_code, expected_error_code);
167 panic!("Uexpected event");
170 let events = nodes[0].node.get_and_clear_pending_msg_events();
171 if expected_channel_update.is_some() {
172 assert_eq!(events.len(), 1);
174 MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
176 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
177 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
178 panic!("channel_update not found!");
181 &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
182 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
183 assert!(*short_channel_id == *expected_short_channel_id);
184 assert!(*is_permanent == *expected_is_permanent);
186 panic!("Unexpected message event");
189 &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
190 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
191 assert!(*node_id == *expected_node_id);
192 assert!(*is_permanent == *expected_is_permanent);
194 panic!("Unexpected message event");
199 _ => panic!("Unexpected message event"),
202 assert_eq!(events.len(), 0);
206 impl msgs::ChannelUpdate {
207 fn dummy() -> msgs::ChannelUpdate {
208 use bitcoin::secp256k1::ffi::Signature as FFISignature;
209 use bitcoin::secp256k1::Signature;
210 msgs::ChannelUpdate {
211 signature: Signature::from(unsafe { FFISignature::new() }),
212 contents: msgs::UnsignedChannelUpdate {
213 chain_hash: BlockHash::hash(&vec![0u8][..]),
217 cltv_expiry_delta: 0,
218 htlc_minimum_msat: 0,
219 htlc_maximum_msat: OptionalField::Absent,
221 fee_proportional_millionths: 0,
228 struct BogusOnionHopData {
231 impl BogusOnionHopData {
232 fn new(orig: msgs::OnionHopData) -> Self {
233 Self { data: orig.encode() }
236 impl Writeable for BogusOnionHopData {
237 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
238 writer.write_all(&self.data[..])
243 fn test_onion_failure() {
244 use ln::msgs::ChannelUpdate;
245 use ln::channelmanager::CLTV_FAR_FAR_AWAY;
246 use bitcoin::secp256k1;
248 const BADONION: u16 = 0x8000;
249 const PERM: u16 = 0x4000;
250 const NODE: u16 = 0x2000;
251 const UPDATE: u16 = 0x1000;
253 // When we check for amount_below_minimum below, we want to test that we're using the *right*
254 // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
255 // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
256 // This exposed a previous bug because we were using the wrong value all the way down in
257 // Channel::get_counterparty_htlc_minimum_msat().
258 let mut node_2_cfg: UserConfig = Default::default();
259 node_2_cfg.own_channel_config.our_htlc_minimum_msat = 2000;
260 node_2_cfg.channel_options.announced_channel = true;
261 node_2_cfg.peer_channel_config_limits.force_announced_channel_preference = false;
263 let chanmon_cfgs = create_chanmon_cfgs(3);
264 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
265 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, Some(node_2_cfg)]);
266 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
267 for node in nodes.iter() {
268 *node.keys_manager.override_session_priv.lock().unwrap() = Some([3; 32]);
270 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())];
271 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
272 let logger = test_utils::TestLogger::new();
273 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 40000, TEST_FINAL_CLTV, &logger).unwrap();
275 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
277 // intermediate node failure
278 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
279 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
280 let cur_height = nodes[0].best_block_info().1 + 1;
281 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
282 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
283 let mut new_payloads = Vec::new();
284 for payload in onion_payloads.drain(..) {
285 new_payloads.push(BogusOnionHopData::new(payload));
287 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
288 // describing a length-1 TLV payload, which is obviously bogus.
289 new_payloads[0].data[0] = 1;
290 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
291 }, ||{}, 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
293 // final node failure
294 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
295 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
296 let cur_height = nodes[0].best_block_info().1 + 1;
297 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
298 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
299 let mut new_payloads = Vec::new();
300 for payload in onion_payloads.drain(..) {
301 new_payloads.push(BogusOnionHopData::new(payload));
303 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
304 // length-1 TLV payload, which is obviously bogus.
305 new_payloads[1].data[0] = 1;
306 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
307 }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
309 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
310 // receiving simulated fail messages
311 // intermediate node failure
312 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
314 msg.amount_msat -= 1;
316 // and tamper returning error message
317 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
318 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
319 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
320 }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
322 // final node failure
323 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
324 // and tamper returning error message
325 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
326 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
327 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
329 nodes[2].node.fail_htlc_backwards(&payment_hash);
330 }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
331 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
333 // intermediate node failure
334 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
335 msg.amount_msat -= 1;
337 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
338 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
339 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
340 }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
342 // final node failure
343 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
344 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
345 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
346 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
348 nodes[2].node.fail_htlc_backwards(&payment_hash);
349 }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
350 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
352 // intermediate node failure
353 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
354 msg.amount_msat -= 1;
356 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
357 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
358 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
360 nodes[2].node.fail_htlc_backwards(&payment_hash);
361 }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
363 // final node failure
364 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
365 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
366 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
367 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
369 nodes[2].node.fail_htlc_backwards(&payment_hash);
370 }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
371 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
373 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
374 Some(BADONION|PERM|4), None);
376 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
377 Some(BADONION|PERM|5), None);
379 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,
380 Some(BADONION|PERM|6), None);
382 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
383 msg.amount_msat -= 1;
385 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
386 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
387 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
388 }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
390 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
391 msg.amount_msat -= 1;
393 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
394 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
395 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
396 // short_channel_id from the processing node
397 }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
399 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
400 msg.amount_msat -= 1;
402 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
403 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
404 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
405 // short_channel_id from the processing node
406 }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
408 let mut bogus_route = route.clone();
409 bogus_route.paths[0][1].short_channel_id -= 1;
410 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
411 Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
413 let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_counterparty_htlc_minimum_msat() - 1;
414 let mut bogus_route = route.clone();
415 let route_len = bogus_route.paths[0].len();
416 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
417 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
419 // Test a positive test-case with one extra msat, meeting the minimum.
420 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward + 1;
421 let (preimage, _, _) = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1);
422 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
424 //TODO: with new config API, we will be able to generate both valid and
425 //invalid channel_update cases.
426 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
427 msg.amount_msat -= 1;
428 }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
430 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
431 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
432 msg.cltv_expiry -= 1;
433 }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
435 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
436 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
437 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
438 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
439 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
440 }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
442 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
443 nodes[2].node.fail_htlc_backwards(&payment_hash);
444 }, false, Some(PERM|15), None);
445 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
447 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
448 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
449 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
450 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
451 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
452 }, || {}, true, Some(17), None);
454 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
455 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
456 for f in pending_forwards.iter_mut() {
458 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
459 forward_info.outgoing_cltv_value += 1,
464 }, true, Some(18), None);
466 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
467 // violate amt_to_forward > msg.amount_msat
468 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
469 for f in pending_forwards.iter_mut() {
471 &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
472 forward_info.amt_to_forward -= 1,
477 }, true, Some(19), None);
479 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
480 // disconnect event to the channel between nodes[1] ~ nodes[2]
481 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
482 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
483 }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
484 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
486 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
487 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
488 let mut route = route.clone();
489 let height = nodes[2].best_block_info().1;
490 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
491 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
492 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
493 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
494 msg.cltv_expiry = htlc_cltv;
495 msg.onion_routing_packet = onion_packet;
496 }, ||{}, true, Some(21), None);