]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/onion_route_tests.rs
Add ability to set shutdown script when closing channel
[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 crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
15 use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
16 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason};
17 use crate::ln::{PaymentHash, PaymentSecret};
18 use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
19 use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, DISABLE_GOSSIP_TICKS, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId, RecipientOnionFields};
20 use crate::ln::onion_utils;
21 use crate::routing::gossip::{NetworkUpdate, RoutingFees};
22 use crate::routing::router::{get_route, PaymentParameters, Route, RouteHint, RouteHintHop};
23 use crate::ln::features::{InitFeatures, InvoiceFeatures};
24 use crate::ln::msgs;
25 use crate::ln::msgs::{ChannelMessageHandler, ChannelUpdate};
26 use crate::ln::wire::Encode;
27 use crate::util::ser::{Writeable, Writer};
28 use crate::util::test_utils;
29 use crate::util::config::{UserConfig, ChannelConfig};
30 use crate::util::errors::APIError;
31
32 use bitcoin::hash_types::BlockHash;
33
34 use bitcoin::hashes::Hash;
35 use bitcoin::hashes::sha256::Hash as Sha256;
36
37 use bitcoin::secp256k1;
38 use bitcoin::secp256k1::{Secp256k1, SecretKey};
39
40 use crate::io;
41 use crate::prelude::*;
42 use core::default::Default;
43
44 use crate::ln::functional_test_utils::*;
45
46 fn run_onion_failure_test<F1,F2>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, payment_secret: &PaymentSecret, callback_msg: F1, callback_node: F2, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<NetworkUpdate>, expected_short_channel_id: Option<u64>)
47         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
48                                 F2: FnMut(),
49 {
50         run_onion_failure_test_with_fail_intercept(_name, test_case, nodes, route, payment_hash, payment_secret, callback_msg, |_|{}, callback_node, expected_retryable, expected_error_code, expected_channel_update, expected_short_channel_id);
51 }
52
53 // test_case
54 // 0: node1 fails backward
55 // 1: final node fails backward
56 // 2: payment completed but the user rejects the payment
57 // 3: final node fails backward (but tamper onion payloads from node0)
58 // 100: trigger error in the intermediate node and tamper returning fail_htlc
59 // 200: trigger error in the final node and tamper returning fail_htlc
60 fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, payment_secret: &PaymentSecret, mut callback_msg: F1, mut callback_fail: F2, mut callback_node: F3, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<NetworkUpdate>, expected_short_channel_id: Option<u64>)
61         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
62                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
63                                 F3: FnMut(),
64 {
65         macro_rules! expect_event {
66                 ($node: expr, $event_type: path) => {{
67                         let events = $node.node.get_and_clear_pending_events();
68                         assert_eq!(events.len(), 1);
69                         match events[0] {
70                                 $event_type { .. } => {},
71                                 _ => panic!("Unexpected event"),
72                         }
73                 }}
74         }
75
76         macro_rules! expect_htlc_forward {
77                 ($node: expr) => {{
78                         expect_event!($node, Event::PendingHTLCsForwardable);
79                         $node.node.process_pending_htlc_forwards();
80                 }}
81         }
82
83         // 0 ~~> 2 send payment
84         let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
85         nodes[0].node.send_payment_with_route(&route, *payment_hash,
86                 RecipientOnionFields::secret_only(*payment_secret), payment_id).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);
93                 callback_node();
94         }
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);
98
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));
103                         update_1_0
104                 },
105                 1|2|3|200 => { // final node failure; forwarding to 2
106                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
107                         // forwarding on 1
108                         if test_case != 200 {
109                                 callback_node();
110                         }
111                         expect_htlc_forward!(&nodes[1]);
112
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);
120                         }
121
122                         // 1 => 2
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);
125
126                         if test_case == 2 || test_case == 200 {
127                                 expect_htlc_forward!(&nodes[2]);
128                                 expect_event!(&nodes[2], Event::PaymentClaimable);
129                                 callback_node();
130                                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
131                         }
132
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);
136                         }
137                         assert!(update_2_1.update_fail_htlcs.len() == 1);
138
139                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
140                         if test_case == 200 {
141                                 callback_fail(&mut fail_msg);
142                         }
143
144                         // 2 => 1
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);
147
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);
151                         update_1_0
152                 },
153                 _ => unreachable!(),
154         };
155
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);
161                 }
162                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
163         } else {
164                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
165         };
166
167         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
168
169         let events = nodes[0].node.get_and_clear_pending_events();
170         assert_eq!(events.len(), 2);
171         if let &Event::PaymentPathFailed { ref payment_failed_permanently, ref short_channel_id, ref error_code, failure: PathFailure::OnPath { ref network_update }, .. } = &events[0] {
172                 assert_eq!(*payment_failed_permanently, !expected_retryable);
173                 assert_eq!(*error_code, expected_error_code);
174                 if expected_channel_update.is_some() {
175                         match network_update {
176                                 Some(update) => match update {
177                                         &NetworkUpdate::ChannelUpdateMessage { .. } => {
178                                                 if let NetworkUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
179                                                         panic!("channel_update not found!");
180                                                 }
181                                         },
182                                         &NetworkUpdate::ChannelFailure { ref short_channel_id, ref is_permanent } => {
183                                                 if let NetworkUpdate::ChannelFailure { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
184                                                         assert!(*short_channel_id == *expected_short_channel_id);
185                                                         assert!(*is_permanent == *expected_is_permanent);
186                                                 } else {
187                                                         panic!("Unexpected message event");
188                                                 }
189                                         },
190                                         &NetworkUpdate::NodeFailure { ref node_id, ref is_permanent } => {
191                                                 if let NetworkUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
192                                                         assert!(*node_id == *expected_node_id);
193                                                         assert!(*is_permanent == *expected_is_permanent);
194                                                 } else {
195                                                         panic!("Unexpected message event");
196                                                 }
197                                         },
198                                 }
199                                 None => panic!("Expected channel update"),
200                         }
201                 } else {
202                         assert!(network_update.is_none());
203                 }
204                 if let Some(expected_short_channel_id) = expected_short_channel_id {
205                         match short_channel_id {
206                                 Some(short_channel_id) => assert_eq!(*short_channel_id, expected_short_channel_id),
207                                 None => panic!("Expected short channel id"),
208                         }
209                 } else {
210                         assert!(short_channel_id.is_none());
211                 }
212         } else {
213                 panic!("Unexpected event");
214         }
215         match events[1] {
216                 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id, reason: ref ev_reason } => {
217                         assert_eq!(*payment_hash, ev_payment_hash);
218                         assert_eq!(payment_id, ev_payment_id);
219                         assert_eq!(if expected_retryable {
220                                 PaymentFailureReason::RetriesExhausted
221                         } else {
222                                 PaymentFailureReason::RecipientRejected
223                         }, ev_reason.unwrap());
224                 }
225                 _ => panic!("Unexpected second event"),
226         }
227 }
228
229 impl msgs::ChannelUpdate {
230         fn dummy(short_channel_id: u64) -> msgs::ChannelUpdate {
231                 use bitcoin::secp256k1::ffi::Signature as FFISignature;
232                 use bitcoin::secp256k1::ecdsa::Signature;
233                 msgs::ChannelUpdate {
234                         signature: Signature::from(unsafe { FFISignature::new() }),
235                         contents: msgs::UnsignedChannelUpdate {
236                                 chain_hash: BlockHash::hash(&vec![0u8][..]),
237                                 short_channel_id,
238                                 timestamp: 0,
239                                 flags: 0,
240                                 cltv_expiry_delta: 0,
241                                 htlc_minimum_msat: 0,
242                                 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
243                                 fee_base_msat: 0,
244                                 fee_proportional_millionths: 0,
245                                 excess_data: vec![],
246                         }
247                 }
248         }
249 }
250
251 struct BogusOnionHopData {
252         data: Vec<u8>
253 }
254 impl BogusOnionHopData {
255         fn new(orig: msgs::OnionHopData) -> Self {
256                 Self { data: orig.encode() }
257         }
258 }
259 impl Writeable for BogusOnionHopData {
260         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
261                 writer.write_all(&self.data[..])
262         }
263 }
264
265 const BADONION: u16 = 0x8000;
266 const PERM: u16 = 0x4000;
267 const NODE: u16 = 0x2000;
268 const UPDATE: u16 = 0x1000;
269
270 #[test]
271 fn test_fee_failures() {
272         // Tests that the fee required when forwarding remains consistent over time. This was
273         // previously broken, with forwarding fees floating based on the fee estimator at the time of
274         // forwarding.
275         //
276         // When this test was written, the default base fee floated based on the HTLC count.
277         // It is now fixed, so we simply set the fee to the expected value here.
278         let mut config = test_default_channel_config();
279         config.channel_config.forwarding_fee_base_msat = 196;
280
281         let chanmon_cfgs = create_chanmon_cfgs(3);
282         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
283         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
284         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
285         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
286
287         // positive case
288         let (route, payment_hash_success, payment_preimage_success, payment_secret_success) = get_route_and_payment_hash!(nodes[0], nodes[2], 40_000);
289         nodes[0].node.send_payment_with_route(&route, payment_hash_success,
290                 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
291         check_added_monitors!(nodes[0], 1);
292         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
293         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
294
295         // If the hop gives fee_insufficient but enough fees were provided, then the previous hop
296         // malleated the payment before forwarding, taking funds when they shouldn't have.
297         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
298         let short_channel_id = channels[0].0.contents.short_channel_id;
299         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
300                 msg.amount_msat -= 1;
301         }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
302
303         // In an earlier version, we spuriously failed to forward payments if the expected feerate
304         // changed between the channel open and the payment.
305         {
306                 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
307                 *feerate_lock *= 2;
308         }
309
310         let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
311         nodes[0].node.send_payment_with_route(&route, payment_hash_success,
312                 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
313         check_added_monitors!(nodes[0], 1);
314         pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
315         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
316 }
317
318 #[test]
319 fn test_onion_failure() {
320         // When we check for amount_below_minimum below, we want to test that we're using the *right*
321         // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
322         // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
323         // This exposed a previous bug because we were using the wrong value all the way down in
324         // Channel::get_counterparty_htlc_minimum_msat().
325         let mut node_2_cfg: UserConfig = Default::default();
326         node_2_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
327         node_2_cfg.channel_handshake_config.announced_channel = true;
328         node_2_cfg.channel_handshake_limits.force_announced_channel_preference = false;
329
330         // When this test was written, the default base fee floated based on the HTLC count.
331         // It is now fixed, so we simply set the fee to the expected value here.
332         let mut config = test_default_channel_config();
333         config.channel_config.forwarding_fee_base_msat = 196;
334
335         let chanmon_cfgs = create_chanmon_cfgs(3);
336         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
337         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
338         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
339         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
340         for node in nodes.iter() {
341                 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
342         }
343         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
344         // positive case
345         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
346
347         // intermediate node failure
348         let short_channel_id = channels[1].0.contents.short_channel_id;
349         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
350                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
351                 let cur_height = nodes[0].best_block_info().1 + 1;
352                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
353                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
354                         &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
355                 let mut new_payloads = Vec::new();
356                 for payload in onion_payloads.drain(..) {
357                         new_payloads.push(BogusOnionHopData::new(payload));
358                 }
359                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
360                 // describing a length-1 TLV payload, which is obviously bogus.
361                 new_payloads[0].data[0] = 1;
362                 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
363         }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
364
365         // final node failure
366         let short_channel_id = channels[1].0.contents.short_channel_id;
367         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
368                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
369                 let cur_height = nodes[0].best_block_info().1 + 1;
370                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
371                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
372                         &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
373                 let mut new_payloads = Vec::new();
374                 for payload in onion_payloads.drain(..) {
375                         new_payloads.push(BogusOnionHopData::new(payload));
376                 }
377                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
378                 // length-1 TLV payload, which is obviously bogus.
379                 new_payloads[1].data[0] = 1;
380                 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
381         }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
382
383         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
384         // receiving simulated fail messages
385         // intermediate node failure
386         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
387                 // trigger error
388                 msg.amount_msat -= 1;
389         }, |msg| {
390                 // and tamper returning error message
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.as_ref(), NODE|2, &[0;0]);
394         }, ||{}, true, Some(NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[0].pubkey, is_permanent: false}), Some(route.paths[0].hops[0].short_channel_id));
395
396         // final node failure
397         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
398                 // and tamper returning error message
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[1].shared_secret.as_ref(), NODE|2, &[0;0]);
402         }, ||{
403                 nodes[2].node.fail_htlc_backwards(&payment_hash);
404         }, true, Some(NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[1].pubkey, is_permanent: false}), Some(route.paths[0].hops[1].short_channel_id));
405         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
406
407         // intermediate node failure
408         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
409                 msg.amount_msat -= 1;
410         }, |msg| {
411                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
412                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
413                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
414         }, ||{}, true, Some(PERM|NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[0].pubkey, is_permanent: true}), Some(route.paths[0].hops[0].short_channel_id));
415
416         // final node failure
417         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 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.as_ref(), PERM|NODE|2, &[0;0]);
421         }, ||{
422                 nodes[2].node.fail_htlc_backwards(&payment_hash);
423         }, false, Some(PERM|NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[1].pubkey, is_permanent: true}), Some(route.paths[0].hops[1].short_channel_id));
424         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
425
426         // intermediate node failure
427         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
428                 msg.amount_msat -= 1;
429         }, |msg| {
430                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
431                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
432                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
433         }, ||{
434                 nodes[2].node.fail_htlc_backwards(&payment_hash);
435         }, true, Some(PERM|NODE|3), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[0].pubkey, is_permanent: true}), Some(route.paths[0].hops[0].short_channel_id));
436
437         // final node failure
438         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
439                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
440                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
441                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
442         }, ||{
443                 nodes[2].node.fail_htlc_backwards(&payment_hash);
444         }, false, Some(PERM|NODE|3), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[1].pubkey, is_permanent: true}), Some(route.paths[0].hops[1].short_channel_id));
445         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
446
447         // Our immediate peer sent UpdateFailMalformedHTLC because it couldn't understand the onion in
448         // the UpdateAddHTLC that we sent.
449         let short_channel_id = channels[0].0.contents.short_channel_id;
450         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
451                 Some(BADONION|PERM|4), None, Some(short_channel_id));
452
453         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
454                 Some(BADONION|PERM|5), None, Some(short_channel_id));
455
456         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,
457                 Some(BADONION|PERM|6), None, Some(short_channel_id));
458
459         let short_channel_id = channels[1].0.contents.short_channel_id;
460         let chan_update = ChannelUpdate::dummy(short_channel_id);
461
462         let mut err_data = Vec::new();
463         err_data.extend_from_slice(&(chan_update.serialized_length() as u16 + 2).to_be_bytes());
464         err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
465         err_data.extend_from_slice(&chan_update.encode());
466         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
467                 msg.amount_msat -= 1;
468         }, |msg| {
469                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
470                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
471                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data);
472         }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update.clone()}), Some(short_channel_id));
473
474         // Check we can still handle onion failures that include channel updates without a type prefix
475         let err_data_without_type = chan_update.encode_with_len();
476         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
477                 msg.amount_msat -= 1;
478         }, |msg| {
479                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
480                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
481                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data_without_type);
482         }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update}), Some(short_channel_id));
483
484         let short_channel_id = channels[1].0.contents.short_channel_id;
485         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
486                 msg.amount_msat -= 1;
487         }, |msg| {
488                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
489                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
490                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|8, &[0;0]);
491                 // short_channel_id from the processing node
492         }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
493
494         let short_channel_id = channels[1].0.contents.short_channel_id;
495         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
496                 msg.amount_msat -= 1;
497         }, |msg| {
498                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
499                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
500                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|9, &[0;0]);
501                 // short_channel_id from the processing node
502         }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
503
504         let mut bogus_route = route.clone();
505         bogus_route.paths[0].hops[1].short_channel_id -= 1;
506         let short_channel_id = bogus_route.paths[0].hops[1].short_channel_id;
507         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
508           Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent:true}), Some(short_channel_id));
509
510         let short_channel_id = channels[1].0.contents.short_channel_id;
511         let amt_to_forward = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[2].node.get_our_node_id())
512                 .unwrap().lock().unwrap().channel_by_id.get(&channels[1].2).unwrap()
513                 .get_counterparty_htlc_minimum_msat() - 1;
514         let mut bogus_route = route.clone();
515         let route_len = bogus_route.paths[0].hops.len();
516         bogus_route.paths[0].hops[route_len-1].fee_msat = amt_to_forward;
517         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));
518
519         // Clear pending payments so that the following positive test has the correct payment hash.
520         for node in nodes.iter() {
521                 node.node.clear_pending_payments();
522         }
523
524         // Test a positive test-case with one extra msat, meeting the minimum.
525         bogus_route.paths[0].hops[route_len-1].fee_msat = amt_to_forward + 1;
526         let preimage = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1).0;
527         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
528
529         let short_channel_id = channels[0].0.contents.short_channel_id;
530         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
531                 msg.amount_msat -= 1;
532         }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
533
534         let short_channel_id = channels[0].0.contents.short_channel_id;
535         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
536                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
537                 msg.cltv_expiry -= 1;
538         }, || {}, true, Some(UPDATE|13), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
539
540         let short_channel_id = channels[1].0.contents.short_channel_id;
541         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
542                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
543                 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
544                 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
545                 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
546         }, ||{}, true, Some(UPDATE|14), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
547
548         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
549                 nodes[2].node.fail_htlc_backwards(&payment_hash);
550         }, false, Some(PERM|15), None, None);
551         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
552
553         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
554                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
555                 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
556                 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
557                 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
558         }, || {}, false, Some(0x4000 | 15), None, None);
559
560         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
561                 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
562                         for f in pending_forwards.iter_mut() {
563                                 match f {
564                                         &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
565                                                 forward_info.outgoing_cltv_value -= 1,
566                                         _ => {},
567                                 }
568                         }
569                 }
570         }, true, Some(18), None, Some(channels[1].0.contents.short_channel_id));
571
572         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
573                 // violate amt_to_forward > msg.amount_msat
574                 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
575                         for f in pending_forwards.iter_mut() {
576                                 match f {
577                                         &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
578                                                 forward_info.outgoing_amt_msat -= 1,
579                                         _ => {},
580                                 }
581                         }
582                 }
583         }, true, Some(19), None, Some(channels[1].0.contents.short_channel_id));
584
585         let short_channel_id = channels[1].0.contents.short_channel_id;
586         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
587                 // disconnect event to the channel between nodes[1] ~ nodes[2]
588                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
589                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
590         }, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
591         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
592                 // disconnect event to the channel between nodes[1] ~ nodes[2]
593                 for _ in 0..DISABLE_GOSSIP_TICKS + 1 {
594                         nodes[1].node.timer_tick_occurred();
595                         nodes[2].node.timer_tick_occurred();
596                 }
597                 nodes[1].node.get_and_clear_pending_msg_events();
598                 nodes[2].node.get_and_clear_pending_msg_events();
599         }, true, Some(UPDATE|20), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
600         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
601
602         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
603                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
604                 let mut route = route.clone();
605                 let height = nodes[2].best_block_info().1;
606                 route.paths[0].hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0].hops[0].cltv_expiry_delta + 1;
607                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
608                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(
609                         &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), height, &None).unwrap();
610                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
611                 msg.cltv_expiry = htlc_cltv;
612                 msg.onion_routing_packet = onion_packet;
613         }, ||{}, true, Some(21), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[0].pubkey, is_permanent: true}), Some(route.paths[0].hops[0].short_channel_id));
614
615         run_onion_failure_test_with_fail_intercept("mpp_timeout", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
616                 // Tamper returning error message
617                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
618                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
619                 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), 23, &[0;0]);
620         }, ||{
621                 nodes[2].node.fail_htlc_backwards(&payment_hash);
622         }, true, Some(23), None, None);
623 }
624
625 #[test]
626 fn test_overshoot_final_cltv() {
627         let chanmon_cfgs = create_chanmon_cfgs(3);
628         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
629         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None; 3]);
630         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
631         create_announced_chan_between_nodes(&nodes, 0, 1);
632         create_announced_chan_between_nodes(&nodes, 1, 2);
633         let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
634
635         let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
636         nodes[0].node.send_payment_with_route(&route, payment_hash, RecipientOnionFields::secret_only(payment_secret), payment_id).unwrap();
637
638         check_added_monitors!(nodes[0], 1);
639         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
640         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
641         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
642         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
643
644         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
645         for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
646                 for f in pending_forwards.iter_mut() {
647                         match f {
648                                 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
649                                         forward_info.outgoing_cltv_value += 1,
650                                 _ => {},
651                         }
652                 }
653         }
654         expect_pending_htlcs_forwardable!(nodes[1]);
655
656         check_added_monitors!(&nodes[1], 1);
657         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
658         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
659         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
660         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
661
662         expect_pending_htlcs_forwardable!(nodes[2]);
663         expect_payment_claimable!(nodes[2], payment_hash, payment_secret, 40_000);
664         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
665 }
666
667 fn do_test_onion_failure_stale_channel_update(announced_channel: bool) {
668         // Create a network of three nodes and two channels connecting them. We'll be updating the
669         // HTLC relay policy of the second channel, causing forwarding failures at the first hop.
670         let mut config = UserConfig::default();
671         config.channel_handshake_config.announced_channel = announced_channel;
672         config.channel_handshake_limits.force_announced_channel_preference = false;
673         config.accept_forwards_to_priv_channels = !announced_channel;
674         let chanmon_cfgs = create_chanmon_cfgs(3);
675         let persister;
676         let chain_monitor;
677         let channel_manager_1_deserialized;
678         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
679         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]);
680         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
681
682         let other_channel = create_chan_between_nodes(
683                 &nodes[0], &nodes[1],
684         );
685         let channel_to_update = if announced_channel {
686                 let channel = create_announced_chan_between_nodes(
687                         &nodes, 1, 2,
688                 );
689                 (channel.2, channel.0.contents.short_channel_id)
690         } else {
691                 let channel = create_unannounced_chan_between_nodes_with_value(
692                         &nodes, 1, 2, 100000, 10001,
693                 );
694                 (channel.0.channel_id, channel.0.short_channel_id_alias.unwrap())
695         };
696         let channel_to_update_counterparty = &nodes[2].node.get_our_node_id();
697
698         let default_config = ChannelConfig::default();
699
700         // A test payment should succeed as the ChannelConfig has not been changed yet.
701         const PAYMENT_AMT: u64 = 40000;
702         let (route, payment_hash, payment_preimage, payment_secret) = if announced_channel {
703                 get_route_and_payment_hash!(nodes[0], nodes[2], PAYMENT_AMT)
704         } else {
705                 let hop_hints = vec![RouteHint(vec![RouteHintHop {
706                         src_node_id: nodes[1].node.get_our_node_id(),
707                         short_channel_id: channel_to_update.1,
708                         fees: RoutingFees {
709                                 base_msat: default_config.forwarding_fee_base_msat,
710                                 proportional_millionths: default_config.forwarding_fee_proportional_millionths,
711                         },
712                         cltv_expiry_delta: default_config.cltv_expiry_delta,
713                         htlc_maximum_msat: None,
714                         htlc_minimum_msat: None,
715                 }])];
716                 let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty, TEST_FINAL_CLTV)
717                         .with_features(nodes[2].node.invoice_features())
718                         .with_route_hints(hop_hints);
719                 get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT)
720         };
721         send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
722                 payment_hash, payment_secret);
723         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
724
725         // Closure to force expiry of a channel's previous config.
726         let expire_prev_config = || {
727                 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
728                         nodes[1].node.timer_tick_occurred();
729                 }
730         };
731
732         // Closure to update and retrieve the latest ChannelUpdate.
733         let update_and_get_channel_update = |config: &ChannelConfig, expect_new_update: bool,
734                 prev_update: Option<&msgs::ChannelUpdate>, should_expire_prev_config: bool| -> Option<msgs::ChannelUpdate> {
735                 nodes[1].node.update_channel_config(
736                         channel_to_update_counterparty, &[channel_to_update.0], config,
737                 ).unwrap();
738                 let events = nodes[1].node.get_and_clear_pending_msg_events();
739                 assert_eq!(events.len(), expect_new_update as usize);
740                 if !expect_new_update {
741                         return None;
742                 }
743                 let new_update = match &events[0] {
744                         MessageSendEvent::BroadcastChannelUpdate { msg } => {
745                                 assert!(announced_channel);
746                                 msg.clone()
747                         },
748                         MessageSendEvent::SendChannelUpdate { node_id, msg } => {
749                                 assert_eq!(node_id, channel_to_update_counterparty);
750                                 assert!(!announced_channel);
751                                 msg.clone()
752                         },
753                         _ => panic!("expected Broadcast/SendChannelUpdate event"),
754                 };
755                 if prev_update.is_some() {
756                         assert!(new_update.contents.timestamp > prev_update.unwrap().contents.timestamp)
757                 }
758                 if should_expire_prev_config {
759                         expire_prev_config();
760                 }
761                 Some(new_update)
762         };
763
764         // We'll be attempting to route payments using the default ChannelUpdate for channels. This will
765         // lead to onion failures at the first hop once we update the ChannelConfig for the
766         // second hop.
767         let expect_onion_failure = |name: &str, error_code: u16, channel_update: &msgs::ChannelUpdate| {
768                 let short_channel_id = channel_to_update.1;
769                 let network_update = NetworkUpdate::ChannelUpdateMessage { msg: channel_update.clone() };
770                 run_onion_failure_test(
771                         name, 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {}, true,
772                         Some(error_code), Some(network_update), Some(short_channel_id),
773                 );
774         };
775
776         // Updates to cltv_expiry_delta below MIN_CLTV_EXPIRY_DELTA should fail with APIMisuseError.
777         let mut invalid_config = default_config.clone();
778         invalid_config.cltv_expiry_delta = 0;
779         match nodes[1].node.update_channel_config(
780                 channel_to_update_counterparty, &[channel_to_update.0], &invalid_config,
781         ) {
782                 Err(APIError::APIMisuseError{ .. }) => {},
783                 _ => panic!("unexpected result applying invalid cltv_expiry_delta"),
784         }
785
786         // Increase the base fee which should trigger a new ChannelUpdate.
787         let mut config = nodes[1].node.list_usable_channels().iter()
788                 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
789                 .config.unwrap();
790         config.forwarding_fee_base_msat = u32::max_value();
791         let msg = update_and_get_channel_update(&config, true, None, false).unwrap();
792
793         // The old policy should still be in effect until a new block is connected.
794         send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
795                 payment_hash, payment_secret);
796         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
797
798         // Connect a block, which should expire the previous config, leading to a failure when
799         // forwarding the HTLC.
800         expire_prev_config();
801         expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
802
803         // Redundant updates should not trigger a new ChannelUpdate.
804         assert!(update_and_get_channel_update(&config, false, None, false).is_none());
805
806         // Similarly, updates that do not have an affect on ChannelUpdate should not trigger a new one.
807         config.force_close_avoidance_max_fee_satoshis *= 2;
808         assert!(update_and_get_channel_update(&config, false, None, false).is_none());
809
810         // Reset the base fee to the default and increase the proportional fee which should trigger a
811         // new ChannelUpdate.
812         config.forwarding_fee_base_msat = default_config.forwarding_fee_base_msat;
813         config.cltv_expiry_delta = u16::max_value();
814         let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
815         expect_onion_failure("incorrect_cltv_expiry", UPDATE|13, &msg);
816
817         // Reset the proportional fee and increase the CLTV expiry delta which should trigger a new
818         // ChannelUpdate.
819         config.cltv_expiry_delta = default_config.cltv_expiry_delta;
820         config.forwarding_fee_proportional_millionths = u32::max_value();
821         let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
822         expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
823
824         // To test persistence of the updated config, we'll re-initialize the ChannelManager.
825         let config_after_restart = {
826                 let chan_1_monitor_serialized = get_monitor!(nodes[1], other_channel.3).encode();
827                 let chan_2_monitor_serialized = get_monitor!(nodes[1], channel_to_update.0).encode();
828                 reload_node!(nodes[1], *nodes[1].node.get_current_default_configuration(), &nodes[1].node.encode(),
829                         &[&chan_1_monitor_serialized, &chan_2_monitor_serialized], persister, chain_monitor, channel_manager_1_deserialized);
830                 nodes[1].node.list_channels().iter()
831                         .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
832                         .config.unwrap()
833         };
834         assert_eq!(config, config_after_restart);
835 }
836
837 #[test]
838 fn test_onion_failure_stale_channel_update() {
839         do_test_onion_failure_stale_channel_update(false);
840         do_test_onion_failure_stale_channel_update(true);
841 }
842
843 #[test]
844 fn test_always_create_tlv_format_onion_payloads() {
845         // Verify that we always generate tlv onion format payloads, even if the features specifically
846         // specifies no support for variable length onions, as the legacy payload format has been
847         // deprecated in BOLT4.
848         let chanmon_cfgs = create_chanmon_cfgs(3);
849         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
850
851         // Set `node[1]`'s init features to features which return `false` for
852         // `supports_variable_length_onion()`
853         let mut no_variable_length_onion_features = InitFeatures::empty();
854         no_variable_length_onion_features.set_static_remote_key_required();
855         *node_cfgs[1].override_init_features.borrow_mut() = Some(no_variable_length_onion_features);
856
857         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
858         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
859
860         create_announced_chan_between_nodes(&nodes, 0, 1);
861         create_announced_chan_between_nodes(&nodes, 1, 2);
862
863         let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
864                 .with_features(InvoiceFeatures::empty());
865         let (route, _payment_hash, _payment_preimage, _payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, 40000);
866
867         let hops = &route.paths[0].hops;
868         // Asserts that the first hop to `node[1]` signals no support for variable length onions.
869         assert!(!hops[0].node_features.supports_variable_length_onion());
870         // Asserts that the first hop to `node[1]` signals no support for variable length onions.
871         assert!(!hops[1].node_features.supports_variable_length_onion());
872
873         let cur_height = nodes[0].best_block_info().1 + 1;
874         let (onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
875                 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
876
877         match onion_payloads[0].format {
878                 msgs::OnionHopDataFormat::NonFinalNode {..} => {},
879                 _ => { panic!(
880                         "Should have generated a `msgs::OnionHopDataFormat::NonFinalNode` payload for `hops[0]`,
881                         despite that the features signals no support for variable length onions"
882                 )}
883         }
884         match onion_payloads[1].format {
885                 msgs::OnionHopDataFormat::FinalNode {..} => {},
886                 _ => {panic!(
887                         "Should have generated a `msgs::OnionHopDataFormat::FinalNode` payload for `hops[1]`,
888                         despite that the features signals no support for variable length onions"
889                 )}
890         }
891 }
892
893 fn do_test_fail_htlc_backwards_with_reason(failure_code: FailureCode) {
894
895         let chanmon_cfgs = create_chanmon_cfgs(2);
896         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
897         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
898         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
899
900         create_announced_chan_between_nodes(&nodes, 0, 1);
901
902         let payment_amount = 100_000;
903         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_amount);
904         nodes[0].node.send_payment_with_route(&route, payment_hash,
905                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
906         check_added_monitors!(nodes[0], 1);
907
908         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
909         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
910         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
911         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
912
913         expect_pending_htlcs_forwardable!(nodes[1]);
914         expect_payment_claimable!(nodes[1], payment_hash, payment_secret, payment_amount);
915         nodes[1].node.fail_htlc_backwards_with_reason(&payment_hash, failure_code);
916
917         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash }]);
918         check_added_monitors!(nodes[1], 1);
919
920         let events = nodes[1].node.get_and_clear_pending_msg_events();
921         assert_eq!(events.len(), 1);
922         let (update_fail_htlc, commitment_signed) = match events[0] {
923                 MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
924                         assert!(update_add_htlcs.is_empty());
925                         assert!(update_fulfill_htlcs.is_empty());
926                         assert_eq!(update_fail_htlcs.len(), 1);
927                         assert!(update_fail_malformed_htlcs.is_empty());
928                         assert!(update_fee.is_none());
929                         (update_fail_htlcs[0].clone(), commitment_signed)
930                 },
931                 _ => panic!("Unexpected event"),
932         };
933
934         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
935         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
936
937         let failure_data = match failure_code {
938                 FailureCode::TemporaryNodeFailure => vec![],
939                 FailureCode::RequiredNodeFeatureMissing => vec![],
940                 FailureCode::IncorrectOrUnknownPaymentDetails => {
941                         let mut htlc_msat_height_data = (payment_amount as u64).to_be_bytes().to_vec();
942                         htlc_msat_height_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes());
943                         htlc_msat_height_data
944                 }
945         };
946
947         let failure_code = failure_code as u16;
948         let permanent_flag = 0x4000;
949         let permanent_fail = (failure_code & permanent_flag) != 0;
950         expect_payment_failed!(nodes[0], payment_hash, permanent_fail, failure_code, failure_data);
951
952 }
953
954 #[test]
955 fn test_fail_htlc_backwards_with_reason() {
956         do_test_fail_htlc_backwards_with_reason(FailureCode::TemporaryNodeFailure);
957         do_test_fail_htlc_backwards_with_reason(FailureCode::RequiredNodeFeatureMissing);
958         do_test_fail_htlc_backwards_with_reason(FailureCode::IncorrectOrUnknownPaymentDetails);
959 }
960
961 macro_rules! get_phantom_route {
962         ($nodes: expr, $amt: expr, $channel: expr) => {{
963                 let phantom_pubkey = $nodes[1].keys_manager.get_node_id(Recipient::PhantomNode).unwrap();
964                 let phantom_route_hint = $nodes[1].node.get_phantom_route_hints();
965                 let payment_params = PaymentParameters::from_node_id(phantom_pubkey, TEST_FINAL_CLTV)
966                         .with_features($nodes[1].node.invoice_features())
967                         .with_route_hints(vec![RouteHint(vec![
968                                         RouteHintHop {
969                                                 src_node_id: $nodes[0].node.get_our_node_id(),
970                                                 short_channel_id: $channel.0.contents.short_channel_id,
971                                                 fees: RoutingFees {
972                                                         base_msat: $channel.0.contents.fee_base_msat,
973                                                         proportional_millionths: $channel.0.contents.fee_proportional_millionths,
974                                                 },
975                                                 cltv_expiry_delta: $channel.0.contents.cltv_expiry_delta,
976                                                 htlc_minimum_msat: None,
977                                                 htlc_maximum_msat: None,
978                                         },
979                                         RouteHintHop {
980                                                 src_node_id: phantom_route_hint.real_node_pubkey,
981                                                 short_channel_id: phantom_route_hint.phantom_scid,
982                                                 fees: RoutingFees {
983                                                         base_msat: 0,
984                                                         proportional_millionths: 0,
985                                                 },
986                                                 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
987                                                 htlc_minimum_msat: None,
988                                                 htlc_maximum_msat: None,
989                                         }
990                 ])]);
991                 let scorer = test_utils::TestScorer::new();
992                 let network_graph = $nodes[0].network_graph.read_only();
993                 (get_route(
994                         &$nodes[0].node.get_our_node_id(), &payment_params, &network_graph,
995                         Some(&$nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
996                         $amt, $nodes[0].logger, &scorer, &[0u8; 32]
997                 ).unwrap(), phantom_route_hint.phantom_scid)
998         }
999 }}
1000
1001 #[test]
1002 fn test_phantom_onion_hmac_failure() {
1003         let chanmon_cfgs = create_chanmon_cfgs(2);
1004         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1005         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1006         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1007
1008         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1009
1010         // Get the route.
1011         let recv_value_msat = 10_000;
1012         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1013         let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1014
1015         // Route the HTLC through to the destination.
1016         nodes[0].node.send_payment_with_route(&route, payment_hash,
1017                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1018         check_added_monitors!(nodes[0], 1);
1019         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1020         let mut update_add = update_0.update_add_htlcs[0].clone();
1021
1022         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1023         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1024
1025         // Modify the payload so the phantom hop's HMAC is bogus.
1026         let sha256_of_onion = {
1027                 let mut forward_htlcs = nodes[1].node.forward_htlcs.lock().unwrap();
1028                 let mut pending_forward = forward_htlcs.get_mut(&phantom_scid).unwrap();
1029                 match pending_forward[0] {
1030                         HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1031                                 forward_info: PendingHTLCInfo {
1032                                         routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1033                                         ..
1034                                 }, ..
1035                         }) => {
1036                                 onion_packet.hmac[onion_packet.hmac.len() - 1] ^= 1;
1037                                 Sha256::hash(&onion_packet.hop_data).into_inner().to_vec()
1038                         },
1039                         _ => panic!("Unexpected forward"),
1040                 }
1041         };
1042         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1043         nodes[1].node.process_pending_htlc_forwards();
1044         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1045         nodes[1].node.process_pending_htlc_forwards();
1046         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1047         check_added_monitors!(&nodes[1], 1);
1048         assert!(update_1.update_fail_htlcs.len() == 1);
1049         let fail_msg = update_1.update_fail_htlcs[0].clone();
1050         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1051         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1052
1053         // Ensure the payment fails with the expected error.
1054         let mut fail_conditions = PaymentFailedConditions::new()
1055                 .blamed_scid(phantom_scid)
1056                 .blamed_chan_closed(true)
1057                 .expected_htlc_error_data(0x8000 | 0x4000 | 5, &sha256_of_onion);
1058         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1059 }
1060
1061 #[test]
1062 fn test_phantom_invalid_onion_payload() {
1063         let chanmon_cfgs = create_chanmon_cfgs(2);
1064         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1065         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1066         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1067
1068         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1069
1070         // Get the route.
1071         let recv_value_msat = 10_000;
1072         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1073         let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1074
1075         // We'll use the session priv later when constructing an invalid onion packet.
1076         let session_priv = [3; 32];
1077         *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
1078         nodes[0].node.send_payment_with_route(&route, payment_hash,
1079                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1080         check_added_monitors!(nodes[0], 1);
1081         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1082         let mut update_add = update_0.update_add_htlcs[0].clone();
1083
1084         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1085         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1086
1087         // Modify the onion packet to have an invalid payment amount.
1088         for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1089                 for f in pending_forwards.iter_mut() {
1090                         match f {
1091                                 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1092                                         forward_info: PendingHTLCInfo {
1093                                                 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1094                                                 ..
1095                                         }, ..
1096                                 }) => {
1097                                         // Construct the onion payloads for the entire route and an invalid amount.
1098                                         let height = nodes[0].best_block_info().1;
1099                                         let session_priv = SecretKey::from_slice(&session_priv).unwrap();
1100                                         let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
1101                                         let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(
1102                                                 &route.paths[0], msgs::MAX_VALUE_MSAT + 1,
1103                                                 RecipientOnionFields::secret_only(payment_secret), height + 1, &None).unwrap();
1104                                         // We only want to construct the onion packet for the last hop, not the entire route, so
1105                                         // remove the first hop's payload and its keys.
1106                                         onion_keys.remove(0);
1107                                         onion_payloads.remove(0);
1108
1109                                         let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1110                                         onion_packet.hop_data = new_onion_packet.hop_data;
1111                                         onion_packet.hmac = new_onion_packet.hmac;
1112                                 },
1113                                 _ => panic!("Unexpected forward"),
1114                         }
1115                 }
1116         }
1117         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1118         nodes[1].node.process_pending_htlc_forwards();
1119         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1120         nodes[1].node.process_pending_htlc_forwards();
1121         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1122         check_added_monitors!(&nodes[1], 1);
1123         assert!(update_1.update_fail_htlcs.len() == 1);
1124         let fail_msg = update_1.update_fail_htlcs[0].clone();
1125         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1126         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1127
1128         // Ensure the payment fails with the expected error.
1129         let error_data = Vec::new();
1130         let mut fail_conditions = PaymentFailedConditions::new()
1131                 .blamed_scid(phantom_scid)
1132                 .blamed_chan_closed(true)
1133                 .expected_htlc_error_data(0x4000 | 22, &error_data);
1134         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1135 }
1136
1137 #[test]
1138 fn test_phantom_final_incorrect_cltv_expiry() {
1139         let chanmon_cfgs = create_chanmon_cfgs(2);
1140         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1141         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1142         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1143
1144         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1145
1146         // Get the route.
1147         let recv_value_msat = 10_000;
1148         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1149         let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1150
1151         // Route the HTLC through to the destination.
1152         nodes[0].node.send_payment_with_route(&route, payment_hash,
1153                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1154         check_added_monitors!(nodes[0], 1);
1155         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1156         let mut update_add = update_0.update_add_htlcs[0].clone();
1157
1158         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1159         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1160
1161         // Modify the payload so the phantom hop's HMAC is bogus.
1162         for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1163                 for f in pending_forwards.iter_mut() {
1164                         match f {
1165                                 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1166                                         forward_info: PendingHTLCInfo { ref mut outgoing_cltv_value, .. }, ..
1167                                 }) => {
1168                                         *outgoing_cltv_value -= 1;
1169                                 },
1170                                 _ => panic!("Unexpected forward"),
1171                         }
1172                 }
1173         }
1174         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1175         nodes[1].node.process_pending_htlc_forwards();
1176         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1177         nodes[1].node.process_pending_htlc_forwards();
1178         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1179         check_added_monitors!(&nodes[1], 1);
1180         assert!(update_1.update_fail_htlcs.len() == 1);
1181         let fail_msg = update_1.update_fail_htlcs[0].clone();
1182         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1183         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1184
1185         // Ensure the payment fails with the expected error.
1186         let expected_cltv: u32 = 80;
1187         let error_data = expected_cltv.to_be_bytes().to_vec();
1188         let mut fail_conditions = PaymentFailedConditions::new()
1189                 .blamed_scid(phantom_scid)
1190                 .expected_htlc_error_data(18, &error_data);
1191         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1192 }
1193
1194 #[test]
1195 fn test_phantom_failure_too_low_cltv() {
1196         let chanmon_cfgs = create_chanmon_cfgs(2);
1197         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1198         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1199         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1200
1201         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1202
1203         // Get the route.
1204         let recv_value_msat = 10_000;
1205         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1206         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1207
1208         // Modify the route to have a too-low cltv.
1209         route.paths[0].hops[1].cltv_expiry_delta = 5;
1210
1211         // Route the HTLC through to the destination.
1212         nodes[0].node.send_payment_with_route(&route, payment_hash,
1213                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1214         check_added_monitors!(nodes[0], 1);
1215         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1216         let mut update_add = update_0.update_add_htlcs[0].clone();
1217
1218         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1219         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1220
1221         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1222         nodes[1].node.process_pending_htlc_forwards();
1223         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1224         nodes[1].node.process_pending_htlc_forwards();
1225         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1226         check_added_monitors!(&nodes[1], 1);
1227         assert!(update_1.update_fail_htlcs.len() == 1);
1228         let fail_msg = update_1.update_fail_htlcs[0].clone();
1229         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1230         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1231
1232         // Ensure the payment fails with the expected error.
1233         let mut error_data = recv_value_msat.to_be_bytes().to_vec();
1234         error_data.extend_from_slice(
1235                 &nodes[0].node.best_block.read().unwrap().height().to_be_bytes(),
1236         );
1237         let mut fail_conditions = PaymentFailedConditions::new()
1238                 .blamed_scid(phantom_scid)
1239                 .expected_htlc_error_data(0x4000 | 15, &error_data);
1240         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1241 }
1242
1243 #[test]
1244 fn test_phantom_failure_modified_cltv() {
1245         // Test that we fail back phantoms if the upstream node fiddled with the CLTV too much with the
1246         // correct error code.
1247         let chanmon_cfgs = create_chanmon_cfgs(2);
1248         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1249         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1250         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1251
1252         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1253
1254         // Get the route.
1255         let recv_value_msat = 10_000;
1256         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1257         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1258
1259         // Route the HTLC through to the destination.
1260         nodes[0].node.send_payment_with_route(&route, payment_hash,
1261                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1262         check_added_monitors!(nodes[0], 1);
1263         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1264         let mut update_add = update_0.update_add_htlcs[0].clone();
1265
1266         // Modify the route to have a too-low cltv.
1267         update_add.cltv_expiry -= 10;
1268
1269         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1270         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1271
1272         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1273         assert!(update_1.update_fail_htlcs.len() == 1);
1274         let fail_msg = update_1.update_fail_htlcs[0].clone();
1275         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1276         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1277
1278         // Ensure the payment fails with the expected error.
1279         let mut fail_conditions = PaymentFailedConditions::new()
1280                 .blamed_scid(phantom_scid)
1281                 .expected_htlc_error_data(0x2000 | 2, &[]);
1282         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1283 }
1284
1285 #[test]
1286 fn test_phantom_failure_expires_too_soon() {
1287         // Test that we fail back phantoms if the HTLC got delayed and we got blocks in between with
1288         // the correct error code.
1289         let chanmon_cfgs = create_chanmon_cfgs(2);
1290         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1291         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1292         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1293
1294         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1295
1296         // Get the route.
1297         let recv_value_msat = 10_000;
1298         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1299         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1300
1301         // Route the HTLC through to the destination.
1302         nodes[0].node.send_payment_with_route(&route, payment_hash,
1303                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1304         check_added_monitors!(nodes[0], 1);
1305         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1306         let mut update_add = update_0.update_add_htlcs[0].clone();
1307
1308         connect_blocks(&nodes[1], CLTV_FAR_FAR_AWAY);
1309         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1310         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1311
1312         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1313         assert!(update_1.update_fail_htlcs.len() == 1);
1314         let fail_msg = update_1.update_fail_htlcs[0].clone();
1315         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1316         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1317
1318         // Ensure the payment fails with the expected error.
1319         let mut fail_conditions = PaymentFailedConditions::new()
1320                 .blamed_scid(phantom_scid)
1321                 .expected_htlc_error_data(0x2000 | 2, &[]);
1322         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1323 }
1324
1325 #[test]
1326 fn test_phantom_failure_too_low_recv_amt() {
1327         let chanmon_cfgs = create_chanmon_cfgs(2);
1328         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1329         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1330         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1331
1332         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1333
1334         // Get the route with a too-low amount.
1335         let recv_amt_msat = 10_000;
1336         let bad_recv_amt_msat = recv_amt_msat - 10;
1337         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1338         let (mut route, phantom_scid) = get_phantom_route!(nodes, bad_recv_amt_msat, channel);
1339
1340         // Route the HTLC through to the destination.
1341         nodes[0].node.send_payment_with_route(&route, payment_hash,
1342                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1343         check_added_monitors!(nodes[0], 1);
1344         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1345         let mut update_add = update_0.update_add_htlcs[0].clone();
1346
1347         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1348         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1349
1350         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1351         nodes[1].node.process_pending_htlc_forwards();
1352         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1353         nodes[1].node.process_pending_htlc_forwards();
1354         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
1355         nodes[1].node.process_pending_htlc_forwards();
1356         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1357         check_added_monitors!(&nodes[1], 1);
1358         assert!(update_1.update_fail_htlcs.len() == 1);
1359         let fail_msg = update_1.update_fail_htlcs[0].clone();
1360         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1361         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1362
1363         // Ensure the payment fails with the expected error.
1364         let mut error_data = bad_recv_amt_msat.to_be_bytes().to_vec();
1365         error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1366         let mut fail_conditions = PaymentFailedConditions::new()
1367                 .blamed_scid(phantom_scid)
1368                 .expected_htlc_error_data(0x4000 | 15, &error_data);
1369         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1370 }
1371
1372 #[test]
1373 fn test_phantom_dust_exposure_failure() {
1374         // Set the max dust exposure to the dust limit.
1375         let max_dust_exposure = 546;
1376         let mut receiver_config = UserConfig::default();
1377         receiver_config.channel_config.max_dust_htlc_exposure_msat = max_dust_exposure;
1378         receiver_config.channel_handshake_config.announced_channel = true;
1379
1380         let chanmon_cfgs = create_chanmon_cfgs(2);
1381         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1382         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(receiver_config)]);
1383         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1384
1385         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1386
1387         // Get the route with an amount exceeding the dust exposure threshold of nodes[1].
1388         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(max_dust_exposure + 1));
1389         let (mut route, _) = get_phantom_route!(nodes, max_dust_exposure + 1, channel);
1390
1391         // Route the HTLC through to the destination.
1392         nodes[0].node.send_payment_with_route(&route, payment_hash,
1393                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1394         check_added_monitors!(nodes[0], 1);
1395         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1396         let mut update_add = update_0.update_add_htlcs[0].clone();
1397
1398         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1399         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1400
1401         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1402         assert!(update_1.update_fail_htlcs.len() == 1);
1403         let fail_msg = update_1.update_fail_htlcs[0].clone();
1404         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1405         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1406
1407         // Ensure the payment fails with the expected error.
1408         let mut err_data = Vec::new();
1409         err_data.extend_from_slice(&(channel.1.serialized_length() as u16 + 2).to_be_bytes());
1410         err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
1411         err_data.extend_from_slice(&channel.1.encode());
1412
1413         let mut fail_conditions = PaymentFailedConditions::new()
1414                 .blamed_scid(channel.0.contents.short_channel_id)
1415                 .blamed_chan_closed(false)
1416                 .expected_htlc_error_data(0x1000 | 7, &err_data);
1417                 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1418 }
1419
1420 #[test]
1421 fn test_phantom_failure_reject_payment() {
1422         // Test that the user can successfully fail back a phantom node payment.
1423         let chanmon_cfgs = create_chanmon_cfgs(2);
1424         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1425         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1426         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1427
1428         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1429
1430         // Get the route with a too-low amount.
1431         let recv_amt_msat = 10_000;
1432         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1433         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_amt_msat, channel);
1434
1435         // Route the HTLC through to the destination.
1436         nodes[0].node.send_payment_with_route(&route, payment_hash,
1437                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1438         check_added_monitors!(nodes[0], 1);
1439         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1440         let mut update_add = update_0.update_add_htlcs[0].clone();
1441
1442         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1443         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1444
1445         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1446         nodes[1].node.process_pending_htlc_forwards();
1447         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1448         nodes[1].node.process_pending_htlc_forwards();
1449         expect_payment_claimable!(nodes[1], payment_hash, payment_secret, recv_amt_msat, None, route.paths[0].hops.last().unwrap().pubkey);
1450         nodes[1].node.fail_htlc_backwards(&payment_hash);
1451         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1452         nodes[1].node.process_pending_htlc_forwards();
1453
1454         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1455         check_added_monitors!(&nodes[1], 1);
1456         assert!(update_1.update_fail_htlcs.len() == 1);
1457         let fail_msg = update_1.update_fail_htlcs[0].clone();
1458         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1459         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1460
1461         // Ensure the payment fails with the expected error.
1462         let mut error_data = recv_amt_msat.to_be_bytes().to_vec();
1463         error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1464         let mut fail_conditions = PaymentFailedConditions::new()
1465                 .blamed_scid(phantom_scid)
1466                 .expected_htlc_error_data(0x4000 | 15, &error_data);
1467         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1468 }