_ Git - rust-lightning/blob - lightning/src/ln/onion_route_tests.rs

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