]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/onion_route_tests.rs
Add counterparty_node_id & channel_capacity to ChannelClosed
[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::sign::{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, Bolt11InvoiceFeatures};
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, MaxDustHTLCExposure};
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).unwrap();
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).unwrap();
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                 .context.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(ReconnectArgs::new(&nodes[1], &nodes[2]));
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).unwrap();
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         config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
675         let chanmon_cfgs = create_chanmon_cfgs(3);
676         let persister;
677         let chain_monitor;
678         let channel_manager_1_deserialized;
679         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
680         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]);
681         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
682
683         let other_channel = create_chan_between_nodes(
684                 &nodes[0], &nodes[1],
685         );
686         let channel_to_update = if announced_channel {
687                 let channel = create_announced_chan_between_nodes(
688                         &nodes, 1, 2,
689                 );
690                 (channel.2, channel.0.contents.short_channel_id)
691         } else {
692                 let channel = create_unannounced_chan_between_nodes_with_value(
693                         &nodes, 1, 2, 100000, 10001,
694                 );
695                 (channel.0.channel_id, channel.0.short_channel_id_alias.unwrap())
696         };
697         let channel_to_update_counterparty = &nodes[2].node.get_our_node_id();
698
699         let default_config = ChannelConfig::default();
700
701         // A test payment should succeed as the ChannelConfig has not been changed yet.
702         const PAYMENT_AMT: u64 = 40000;
703         let (route, payment_hash, payment_preimage, payment_secret) = if announced_channel {
704                 get_route_and_payment_hash!(nodes[0], nodes[2], PAYMENT_AMT)
705         } else {
706                 let hop_hints = vec![RouteHint(vec![RouteHintHop {
707                         src_node_id: nodes[1].node.get_our_node_id(),
708                         short_channel_id: channel_to_update.1,
709                         fees: RoutingFees {
710                                 base_msat: default_config.forwarding_fee_base_msat,
711                                 proportional_millionths: default_config.forwarding_fee_proportional_millionths,
712                         },
713                         cltv_expiry_delta: default_config.cltv_expiry_delta,
714                         htlc_maximum_msat: None,
715                         htlc_minimum_msat: None,
716                 }])];
717                 let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty, TEST_FINAL_CLTV)
718                         .with_bolt11_features(nodes[2].node.invoice_features()).unwrap()
719                         .with_route_hints(hop_hints).unwrap();
720                 get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT)
721         };
722         send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
723                 payment_hash, payment_secret);
724         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
725
726         // Closure to force expiry of a channel's previous config.
727         let expire_prev_config = || {
728                 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
729                         nodes[1].node.timer_tick_occurred();
730                 }
731         };
732
733         // Closure to update and retrieve the latest ChannelUpdate.
734         let update_and_get_channel_update = |config: &ChannelConfig, expect_new_update: bool,
735                 prev_update: Option<&msgs::ChannelUpdate>, should_expire_prev_config: bool| -> Option<msgs::ChannelUpdate> {
736                 nodes[1].node.update_channel_config(
737                         channel_to_update_counterparty, &[channel_to_update.0], config,
738                 ).unwrap();
739                 let events = nodes[1].node.get_and_clear_pending_msg_events();
740                 assert_eq!(events.len(), expect_new_update as usize);
741                 if !expect_new_update {
742                         return None;
743                 }
744                 let new_update = match &events[0] {
745                         MessageSendEvent::BroadcastChannelUpdate { msg } => {
746                                 assert!(announced_channel);
747                                 msg.clone()
748                         },
749                         MessageSendEvent::SendChannelUpdate { node_id, msg } => {
750                                 assert_eq!(node_id, channel_to_update_counterparty);
751                                 assert!(!announced_channel);
752                                 msg.clone()
753                         },
754                         _ => panic!("expected Broadcast/SendChannelUpdate event"),
755                 };
756                 if prev_update.is_some() {
757                         assert!(new_update.contents.timestamp > prev_update.unwrap().contents.timestamp)
758                 }
759                 if should_expire_prev_config {
760                         expire_prev_config();
761                 }
762                 Some(new_update)
763         };
764
765         // We'll be attempting to route payments using the default ChannelUpdate for channels. This will
766         // lead to onion failures at the first hop once we update the ChannelConfig for the
767         // second hop.
768         let expect_onion_failure = |name: &str, error_code: u16, channel_update: &msgs::ChannelUpdate| {
769                 let short_channel_id = channel_to_update.1;
770                 let network_update = NetworkUpdate::ChannelUpdateMessage { msg: channel_update.clone() };
771                 run_onion_failure_test(
772                         name, 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {}, true,
773                         Some(error_code), Some(network_update), Some(short_channel_id),
774                 );
775         };
776
777         // Updates to cltv_expiry_delta below MIN_CLTV_EXPIRY_DELTA should fail with APIMisuseError.
778         let mut invalid_config = default_config.clone();
779         invalid_config.cltv_expiry_delta = 0;
780         match nodes[1].node.update_channel_config(
781                 channel_to_update_counterparty, &[channel_to_update.0], &invalid_config,
782         ) {
783                 Err(APIError::APIMisuseError{ .. }) => {},
784                 _ => panic!("unexpected result applying invalid cltv_expiry_delta"),
785         }
786
787         // Increase the base fee which should trigger a new ChannelUpdate.
788         let mut config = nodes[1].node.list_usable_channels().iter()
789                 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
790                 .config.unwrap();
791         config.forwarding_fee_base_msat = u32::max_value();
792         let msg = update_and_get_channel_update(&config, true, None, false).unwrap();
793
794         // The old policy should still be in effect until a new block is connected.
795         send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
796                 payment_hash, payment_secret);
797         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
798
799         // Connect a block, which should expire the previous config, leading to a failure when
800         // forwarding the HTLC.
801         expire_prev_config();
802         expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
803
804         // Redundant updates should not trigger a new ChannelUpdate.
805         assert!(update_and_get_channel_update(&config, false, None, false).is_none());
806
807         // Similarly, updates that do not have an affect on ChannelUpdate should not trigger a new one.
808         config.force_close_avoidance_max_fee_satoshis *= 2;
809         assert!(update_and_get_channel_update(&config, false, None, false).is_none());
810
811         // Reset the base fee to the default and increase the proportional fee which should trigger a
812         // new ChannelUpdate.
813         config.forwarding_fee_base_msat = default_config.forwarding_fee_base_msat;
814         config.cltv_expiry_delta = u16::max_value();
815         let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
816         expect_onion_failure("incorrect_cltv_expiry", UPDATE|13, &msg);
817
818         // Reset the proportional fee and increase the CLTV expiry delta which should trigger a new
819         // ChannelUpdate.
820         config.cltv_expiry_delta = default_config.cltv_expiry_delta;
821         config.forwarding_fee_proportional_millionths = u32::max_value();
822         let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
823         expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
824
825         // To test persistence of the updated config, we'll re-initialize the ChannelManager.
826         let config_after_restart = {
827                 let chan_1_monitor_serialized = get_monitor!(nodes[1], other_channel.3).encode();
828                 let chan_2_monitor_serialized = get_monitor!(nodes[1], channel_to_update.0).encode();
829                 reload_node!(nodes[1], *nodes[1].node.get_current_default_configuration(), &nodes[1].node.encode(),
830                         &[&chan_1_monitor_serialized, &chan_2_monitor_serialized], persister, chain_monitor, channel_manager_1_deserialized);
831                 nodes[1].node.list_channels().iter()
832                         .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
833                         .config.unwrap()
834         };
835         assert_eq!(config, config_after_restart);
836 }
837
838 #[test]
839 fn test_onion_failure_stale_channel_update() {
840         do_test_onion_failure_stale_channel_update(false);
841         do_test_onion_failure_stale_channel_update(true);
842 }
843
844 #[test]
845 fn test_always_create_tlv_format_onion_payloads() {
846         // Verify that we always generate tlv onion format payloads, even if the features specifically
847         // specifies no support for variable length onions, as the legacy payload format has been
848         // deprecated in BOLT4.
849         let chanmon_cfgs = create_chanmon_cfgs(3);
850         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
851
852         // Set `node[1]`'s init features to features which return `false` for
853         // `supports_variable_length_onion()`
854         let mut no_variable_length_onion_features = InitFeatures::empty();
855         no_variable_length_onion_features.set_static_remote_key_required();
856         *node_cfgs[1].override_init_features.borrow_mut() = Some(no_variable_length_onion_features);
857
858         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
859         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
860
861         create_announced_chan_between_nodes(&nodes, 0, 1);
862         create_announced_chan_between_nodes(&nodes, 1, 2);
863
864         let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
865                 .with_bolt11_features(Bolt11InvoiceFeatures::empty()).unwrap();
866         let (route, _payment_hash, _payment_preimage, _payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, 40000);
867
868         let hops = &route.paths[0].hops;
869         // Asserts that the first hop to `node[1]` signals no support for variable length onions.
870         assert!(!hops[0].node_features.supports_variable_length_onion());
871         // Asserts that the first hop to `node[1]` signals no support for variable length onions.
872         assert!(!hops[1].node_features.supports_variable_length_onion());
873
874         let cur_height = nodes[0].best_block_info().1 + 1;
875         let (onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
876                 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
877
878         match onion_payloads[0].format {
879                 msgs::OnionHopDataFormat::NonFinalNode {..} => {},
880                 _ => { panic!(
881                         "Should have generated a `msgs::OnionHopDataFormat::NonFinalNode` payload for `hops[0]`,
882                         despite that the features signals no support for variable length onions"
883                 )}
884         }
885         match onion_payloads[1].format {
886                 msgs::OnionHopDataFormat::FinalNode {..} => {},
887                 _ => {panic!(
888                         "Should have generated a `msgs::OnionHopDataFormat::FinalNode` payload for `hops[1]`,
889                         despite that the features signals no support for variable length onions"
890                 )}
891         }
892 }
893
894 fn do_test_fail_htlc_backwards_with_reason(failure_code: FailureCode) {
895
896         let chanmon_cfgs = create_chanmon_cfgs(2);
897         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
898         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
899         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
900
901         create_announced_chan_between_nodes(&nodes, 0, 1);
902
903         let payment_amount = 100_000;
904         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_amount);
905         nodes[0].node.send_payment_with_route(&route, payment_hash,
906                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
907         check_added_monitors!(nodes[0], 1);
908
909         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
910         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
911         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
912         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
913
914         expect_pending_htlcs_forwardable!(nodes[1]);
915         expect_payment_claimable!(nodes[1], payment_hash, payment_secret, payment_amount);
916         nodes[1].node.fail_htlc_backwards_with_reason(&payment_hash, failure_code);
917
918         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash }]);
919         check_added_monitors!(nodes[1], 1);
920
921         let events = nodes[1].node.get_and_clear_pending_msg_events();
922         assert_eq!(events.len(), 1);
923         let (update_fail_htlc, commitment_signed) = match events[0] {
924                 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 } } => {
925                         assert!(update_add_htlcs.is_empty());
926                         assert!(update_fulfill_htlcs.is_empty());
927                         assert_eq!(update_fail_htlcs.len(), 1);
928                         assert!(update_fail_malformed_htlcs.is_empty());
929                         assert!(update_fee.is_none());
930                         (update_fail_htlcs[0].clone(), commitment_signed)
931                 },
932                 _ => panic!("Unexpected event"),
933         };
934
935         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
936         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
937
938         let failure_data = match failure_code {
939                 FailureCode::TemporaryNodeFailure => vec![],
940                 FailureCode::RequiredNodeFeatureMissing => vec![],
941                 FailureCode::IncorrectOrUnknownPaymentDetails => {
942                         let mut htlc_msat_height_data = (payment_amount as u64).to_be_bytes().to_vec();
943                         htlc_msat_height_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes());
944                         htlc_msat_height_data
945                 }
946         };
947
948         let failure_code = failure_code as u16;
949         let permanent_flag = 0x4000;
950         let permanent_fail = (failure_code & permanent_flag) != 0;
951         expect_payment_failed!(nodes[0], payment_hash, permanent_fail, failure_code, failure_data);
952
953 }
954
955 #[test]
956 fn test_fail_htlc_backwards_with_reason() {
957         do_test_fail_htlc_backwards_with_reason(FailureCode::TemporaryNodeFailure);
958         do_test_fail_htlc_backwards_with_reason(FailureCode::RequiredNodeFeatureMissing);
959         do_test_fail_htlc_backwards_with_reason(FailureCode::IncorrectOrUnknownPaymentDetails);
960 }
961
962 macro_rules! get_phantom_route {
963         ($nodes: expr, $amt: expr, $channel: expr) => {{
964                 let phantom_pubkey = $nodes[1].keys_manager.get_node_id(Recipient::PhantomNode).unwrap();
965                 let phantom_route_hint = $nodes[1].node.get_phantom_route_hints();
966                 let payment_params = PaymentParameters::from_node_id(phantom_pubkey, TEST_FINAL_CLTV)
967                         .with_bolt11_features($nodes[1].node.invoice_features()).unwrap()
968                         .with_route_hints(vec![RouteHint(vec![
969                                         RouteHintHop {
970                                                 src_node_id: $nodes[0].node.get_our_node_id(),
971                                                 short_channel_id: $channel.0.contents.short_channel_id,
972                                                 fees: RoutingFees {
973                                                         base_msat: $channel.0.contents.fee_base_msat,
974                                                         proportional_millionths: $channel.0.contents.fee_proportional_millionths,
975                                                 },
976                                                 cltv_expiry_delta: $channel.0.contents.cltv_expiry_delta,
977                                                 htlc_minimum_msat: None,
978                                                 htlc_maximum_msat: None,
979                                         },
980                                         RouteHintHop {
981                                                 src_node_id: phantom_route_hint.real_node_pubkey,
982                                                 short_channel_id: phantom_route_hint.phantom_scid,
983                                                 fees: RoutingFees {
984                                                         base_msat: 0,
985                                                         proportional_millionths: 0,
986                                                 },
987                                                 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
988                                                 htlc_minimum_msat: None,
989                                                 htlc_maximum_msat: None,
990                                         }
991                 ])]).unwrap();
992                 let scorer = test_utils::TestScorer::new();
993                 let network_graph = $nodes[0].network_graph.read_only();
994                 (get_route(
995                         &$nodes[0].node.get_our_node_id(), &payment_params, &network_graph,
996                         Some(&$nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
997                         $amt, $nodes[0].logger, &scorer, &(), &[0u8; 32]
998                 ).unwrap(), phantom_route_hint.phantom_scid)
999         }
1000 }}
1001
1002 #[test]
1003 fn test_phantom_onion_hmac_failure() {
1004         let chanmon_cfgs = create_chanmon_cfgs(2);
1005         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1006         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1007         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1008
1009         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1010
1011         // Get the route.
1012         let recv_value_msat = 10_000;
1013         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1014         let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1015
1016         // Route the HTLC through to the destination.
1017         nodes[0].node.send_payment_with_route(&route, payment_hash,
1018                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1019         check_added_monitors!(nodes[0], 1);
1020         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1021         let mut update_add = update_0.update_add_htlcs[0].clone();
1022
1023         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1024         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1025
1026         // Modify the payload so the phantom hop's HMAC is bogus.
1027         let sha256_of_onion = {
1028                 let mut forward_htlcs = nodes[1].node.forward_htlcs.lock().unwrap();
1029                 let mut pending_forward = forward_htlcs.get_mut(&phantom_scid).unwrap();
1030                 match pending_forward[0] {
1031                         HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1032                                 forward_info: PendingHTLCInfo {
1033                                         routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1034                                         ..
1035                                 }, ..
1036                         }) => {
1037                                 onion_packet.hmac[onion_packet.hmac.len() - 1] ^= 1;
1038                                 Sha256::hash(&onion_packet.hop_data).into_inner().to_vec()
1039                         },
1040                         _ => panic!("Unexpected forward"),
1041                 }
1042         };
1043         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1044         nodes[1].node.process_pending_htlc_forwards();
1045         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1046         nodes[1].node.process_pending_htlc_forwards();
1047         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1048         check_added_monitors!(&nodes[1], 1);
1049         assert!(update_1.update_fail_htlcs.len() == 1);
1050         let fail_msg = update_1.update_fail_htlcs[0].clone();
1051         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1052         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1053
1054         // Ensure the payment fails with the expected error.
1055         let mut fail_conditions = PaymentFailedConditions::new()
1056                 .blamed_scid(phantom_scid)
1057                 .blamed_chan_closed(true)
1058                 .expected_htlc_error_data(0x8000 | 0x4000 | 5, &sha256_of_onion);
1059         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1060 }
1061
1062 #[test]
1063 fn test_phantom_invalid_onion_payload() {
1064         let chanmon_cfgs = create_chanmon_cfgs(2);
1065         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1066         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1067         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1068
1069         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1070
1071         // Get the route.
1072         let recv_value_msat = 10_000;
1073         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1074         let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1075
1076         // We'll use the session priv later when constructing an invalid onion packet.
1077         let session_priv = [3; 32];
1078         *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
1079         nodes[0].node.send_payment_with_route(&route, payment_hash,
1080                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1081         check_added_monitors!(nodes[0], 1);
1082         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1083         let mut update_add = update_0.update_add_htlcs[0].clone();
1084
1085         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1086         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1087
1088         // Modify the onion packet to have an invalid payment amount.
1089         for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1090                 for f in pending_forwards.iter_mut() {
1091                         match f {
1092                                 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1093                                         forward_info: PendingHTLCInfo {
1094                                                 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1095                                                 ..
1096                                         }, ..
1097                                 }) => {
1098                                         // Construct the onion payloads for the entire route and an invalid amount.
1099                                         let height = nodes[0].best_block_info().1;
1100                                         let session_priv = SecretKey::from_slice(&session_priv).unwrap();
1101                                         let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
1102                                         let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(
1103                                                 &route.paths[0], msgs::MAX_VALUE_MSAT + 1,
1104                                                 RecipientOnionFields::secret_only(payment_secret), height + 1, &None).unwrap();
1105                                         // We only want to construct the onion packet for the last hop, not the entire route, so
1106                                         // remove the first hop's payload and its keys.
1107                                         onion_keys.remove(0);
1108                                         onion_payloads.remove(0);
1109
1110                                         let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
1111                                         onion_packet.hop_data = new_onion_packet.hop_data;
1112                                         onion_packet.hmac = new_onion_packet.hmac;
1113                                 },
1114                                 _ => panic!("Unexpected forward"),
1115                         }
1116                 }
1117         }
1118         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1119         nodes[1].node.process_pending_htlc_forwards();
1120         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1121         nodes[1].node.process_pending_htlc_forwards();
1122         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1123         check_added_monitors!(&nodes[1], 1);
1124         assert!(update_1.update_fail_htlcs.len() == 1);
1125         let fail_msg = update_1.update_fail_htlcs[0].clone();
1126         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1127         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1128
1129         // Ensure the payment fails with the expected error.
1130         let error_data = Vec::new();
1131         let mut fail_conditions = PaymentFailedConditions::new()
1132                 .blamed_scid(phantom_scid)
1133                 .blamed_chan_closed(true)
1134                 .expected_htlc_error_data(0x4000 | 22, &error_data);
1135         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1136 }
1137
1138 #[test]
1139 fn test_phantom_final_incorrect_cltv_expiry() {
1140         let chanmon_cfgs = create_chanmon_cfgs(2);
1141         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1142         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1143         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1144
1145         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1146
1147         // Get the route.
1148         let recv_value_msat = 10_000;
1149         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1150         let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1151
1152         // Route the HTLC through to the destination.
1153         nodes[0].node.send_payment_with_route(&route, payment_hash,
1154                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1155         check_added_monitors!(nodes[0], 1);
1156         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1157         let mut update_add = update_0.update_add_htlcs[0].clone();
1158
1159         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1160         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1161
1162         // Modify the payload so the phantom hop's HMAC is bogus.
1163         for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1164                 for f in pending_forwards.iter_mut() {
1165                         match f {
1166                                 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1167                                         forward_info: PendingHTLCInfo { ref mut outgoing_cltv_value, .. }, ..
1168                                 }) => {
1169                                         *outgoing_cltv_value -= 1;
1170                                 },
1171                                 _ => panic!("Unexpected forward"),
1172                         }
1173                 }
1174         }
1175         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1176         nodes[1].node.process_pending_htlc_forwards();
1177         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1178         nodes[1].node.process_pending_htlc_forwards();
1179         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1180         check_added_monitors!(&nodes[1], 1);
1181         assert!(update_1.update_fail_htlcs.len() == 1);
1182         let fail_msg = update_1.update_fail_htlcs[0].clone();
1183         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1184         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1185
1186         // Ensure the payment fails with the expected error.
1187         let expected_cltv: u32 = 80;
1188         let error_data = expected_cltv.to_be_bytes().to_vec();
1189         let mut fail_conditions = PaymentFailedConditions::new()
1190                 .blamed_scid(phantom_scid)
1191                 .expected_htlc_error_data(18, &error_data);
1192         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1193 }
1194
1195 #[test]
1196 fn test_phantom_failure_too_low_cltv() {
1197         let chanmon_cfgs = create_chanmon_cfgs(2);
1198         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1199         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1200         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1201
1202         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1203
1204         // Get the route.
1205         let recv_value_msat = 10_000;
1206         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1207         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1208
1209         // Modify the route to have a too-low cltv.
1210         route.paths[0].hops[1].cltv_expiry_delta = 5;
1211
1212         // Route the HTLC through to the destination.
1213         nodes[0].node.send_payment_with_route(&route, payment_hash,
1214                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1215         check_added_monitors!(nodes[0], 1);
1216         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1217         let mut update_add = update_0.update_add_htlcs[0].clone();
1218
1219         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1220         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1221
1222         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1223         nodes[1].node.process_pending_htlc_forwards();
1224         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1225         nodes[1].node.process_pending_htlc_forwards();
1226         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1227         check_added_monitors!(&nodes[1], 1);
1228         assert!(update_1.update_fail_htlcs.len() == 1);
1229         let fail_msg = update_1.update_fail_htlcs[0].clone();
1230         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1231         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1232
1233         // Ensure the payment fails with the expected error.
1234         let mut error_data = recv_value_msat.to_be_bytes().to_vec();
1235         error_data.extend_from_slice(
1236                 &nodes[0].node.best_block.read().unwrap().height().to_be_bytes(),
1237         );
1238         let mut fail_conditions = PaymentFailedConditions::new()
1239                 .blamed_scid(phantom_scid)
1240                 .expected_htlc_error_data(0x4000 | 15, &error_data);
1241         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1242 }
1243
1244 #[test]
1245 fn test_phantom_failure_modified_cltv() {
1246         // Test that we fail back phantoms if the upstream node fiddled with the CLTV too much with the
1247         // correct error code.
1248         let chanmon_cfgs = create_chanmon_cfgs(2);
1249         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1250         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1251         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1252
1253         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1254
1255         // Get the route.
1256         let recv_value_msat = 10_000;
1257         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1258         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1259
1260         // Route the HTLC through to the destination.
1261         nodes[0].node.send_payment_with_route(&route, payment_hash,
1262                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1263         check_added_monitors!(nodes[0], 1);
1264         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1265         let mut update_add = update_0.update_add_htlcs[0].clone();
1266
1267         // Modify the route to have a too-low cltv.
1268         update_add.cltv_expiry -= 10;
1269
1270         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1271         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1272
1273         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1274         assert!(update_1.update_fail_htlcs.len() == 1);
1275         let fail_msg = update_1.update_fail_htlcs[0].clone();
1276         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1277         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1278
1279         // Ensure the payment fails with the expected error.
1280         let mut fail_conditions = PaymentFailedConditions::new()
1281                 .blamed_scid(phantom_scid)
1282                 .expected_htlc_error_data(0x2000 | 2, &[]);
1283         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1284 }
1285
1286 #[test]
1287 fn test_phantom_failure_expires_too_soon() {
1288         // Test that we fail back phantoms if the HTLC got delayed and we got blocks in between with
1289         // the correct error code.
1290         let chanmon_cfgs = create_chanmon_cfgs(2);
1291         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1292         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1293         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1294
1295         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1296
1297         // Get the route.
1298         let recv_value_msat = 10_000;
1299         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1300         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1301
1302         // Route the HTLC through to the destination.
1303         nodes[0].node.send_payment_with_route(&route, payment_hash,
1304                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1305         check_added_monitors!(nodes[0], 1);
1306         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1307         let mut update_add = update_0.update_add_htlcs[0].clone();
1308
1309         connect_blocks(&nodes[1], CLTV_FAR_FAR_AWAY);
1310         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1311         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1312
1313         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1314         assert!(update_1.update_fail_htlcs.len() == 1);
1315         let fail_msg = update_1.update_fail_htlcs[0].clone();
1316         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1317         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1318
1319         // Ensure the payment fails with the expected error.
1320         let mut fail_conditions = PaymentFailedConditions::new()
1321                 .blamed_scid(phantom_scid)
1322                 .expected_htlc_error_data(0x2000 | 2, &[]);
1323         expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1324 }
1325
1326 #[test]
1327 fn test_phantom_failure_too_low_recv_amt() {
1328         let chanmon_cfgs = create_chanmon_cfgs(2);
1329         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1330         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1331         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1332
1333         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1334
1335         // Get the route with a too-low amount.
1336         let recv_amt_msat = 10_000;
1337         let bad_recv_amt_msat = recv_amt_msat - 10;
1338         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1339         let (mut route, phantom_scid) = get_phantom_route!(nodes, bad_recv_amt_msat, channel);
1340
1341         // Route the HTLC through to the destination.
1342         nodes[0].node.send_payment_with_route(&route, payment_hash,
1343                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1344         check_added_monitors!(nodes[0], 1);
1345         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1346         let mut update_add = update_0.update_add_htlcs[0].clone();
1347
1348         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1349         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1350
1351         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1352         nodes[1].node.process_pending_htlc_forwards();
1353         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1354         nodes[1].node.process_pending_htlc_forwards();
1355         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
1356         nodes[1].node.process_pending_htlc_forwards();
1357         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1358         check_added_monitors!(&nodes[1], 1);
1359         assert!(update_1.update_fail_htlcs.len() == 1);
1360         let fail_msg = update_1.update_fail_htlcs[0].clone();
1361         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1362         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1363
1364         // Ensure the payment fails with the expected error.
1365         let mut error_data = bad_recv_amt_msat.to_be_bytes().to_vec();
1366         error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1367         let mut fail_conditions = PaymentFailedConditions::new()
1368                 .blamed_scid(phantom_scid)
1369                 .expected_htlc_error_data(0x4000 | 15, &error_data);
1370         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1371 }
1372
1373 #[test]
1374 fn test_phantom_dust_exposure_failure() {
1375         do_test_phantom_dust_exposure_failure(false);
1376         do_test_phantom_dust_exposure_failure(true);
1377 }
1378
1379 fn do_test_phantom_dust_exposure_failure(multiplier_dust_limit: bool) {
1380         // Set the max dust exposure to the dust limit.
1381         let max_dust_exposure = 546;
1382         let mut receiver_config = UserConfig::default();
1383         // Default test fee estimator rate is 253, so to set the max dust exposure to the dust limit,
1384         // we need to set the multiplier to 2.
1385         receiver_config.channel_config.max_dust_htlc_exposure =
1386                 if multiplier_dust_limit { MaxDustHTLCExposure::FeeRateMultiplier(2) }
1387                 else { MaxDustHTLCExposure::FixedLimitMsat(max_dust_exposure) };
1388         receiver_config.channel_handshake_config.announced_channel = true;
1389
1390         let chanmon_cfgs = create_chanmon_cfgs(2);
1391         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1392         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(receiver_config)]);
1393         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1394
1395         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1396
1397         // Get the route with an amount exceeding the dust exposure threshold of nodes[1].
1398         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(max_dust_exposure + 1));
1399         let (mut route, _) = get_phantom_route!(nodes, max_dust_exposure + 1, channel);
1400
1401         // Route the HTLC through to the destination.
1402         nodes[0].node.send_payment_with_route(&route, payment_hash,
1403                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1404         check_added_monitors!(nodes[0], 1);
1405         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1406         let mut update_add = update_0.update_add_htlcs[0].clone();
1407
1408         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1409         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1410
1411         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1412         assert!(update_1.update_fail_htlcs.len() == 1);
1413         let fail_msg = update_1.update_fail_htlcs[0].clone();
1414         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1415         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1416
1417         // Ensure the payment fails with the expected error.
1418         let mut err_data = Vec::new();
1419         err_data.extend_from_slice(&(channel.1.serialized_length() as u16 + 2).to_be_bytes());
1420         err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
1421         err_data.extend_from_slice(&channel.1.encode());
1422
1423         let mut fail_conditions = PaymentFailedConditions::new()
1424                 .blamed_scid(channel.0.contents.short_channel_id)
1425                 .blamed_chan_closed(false)
1426                 .expected_htlc_error_data(0x1000 | 7, &err_data);
1427                 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1428 }
1429
1430 #[test]
1431 fn test_phantom_failure_reject_payment() {
1432         // Test that the user can successfully fail back a phantom node payment.
1433         let chanmon_cfgs = create_chanmon_cfgs(2);
1434         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1435         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1436         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1437
1438         let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1439
1440         // Get the route with a too-low amount.
1441         let recv_amt_msat = 10_000;
1442         let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1443         let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_amt_msat, channel);
1444
1445         // Route the HTLC through to the destination.
1446         nodes[0].node.send_payment_with_route(&route, payment_hash,
1447                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1448         check_added_monitors!(nodes[0], 1);
1449         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1450         let mut update_add = update_0.update_add_htlcs[0].clone();
1451
1452         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1453         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1454
1455         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1456         nodes[1].node.process_pending_htlc_forwards();
1457         expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1458         nodes[1].node.process_pending_htlc_forwards();
1459         expect_payment_claimable!(nodes[1], payment_hash, payment_secret, recv_amt_msat, None, route.paths[0].hops.last().unwrap().pubkey);
1460         nodes[1].node.fail_htlc_backwards(&payment_hash);
1461         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1462         nodes[1].node.process_pending_htlc_forwards();
1463
1464         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1465         check_added_monitors!(&nodes[1], 1);
1466         assert!(update_1.update_fail_htlcs.len() == 1);
1467         let fail_msg = update_1.update_fail_htlcs[0].clone();
1468         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1469         commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1470
1471         // Ensure the payment fails with the expected error.
1472         let mut error_data = recv_amt_msat.to_be_bytes().to_vec();
1473         error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1474         let mut fail_conditions = PaymentFailedConditions::new()
1475                 .blamed_scid(phantom_scid)
1476                 .expected_htlc_error_data(0x4000 | 15, &error_data);
1477         expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1478 }