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