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