1 // This file is Copyright its original authors, visible in version control
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
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.
14 use crate::chain::channelmonitor::{CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
15 use crate::chain::keysinterface::{EntropySource, NodeSigner, Recipient};
16 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure};
17 use crate::ln::{PaymentHash, PaymentSecret};
18 use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
19 use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId, RecipientOnionFields};
20 use crate::ln::onion_utils;
21 use crate::routing::gossip::{NetworkUpdate, RoutingFees};
22 use crate::routing::router::{get_route, PaymentParameters, Route, RouteHint, RouteHintHop};
23 use crate::ln::features::{InitFeatures, InvoiceFeatures};
25 use crate::ln::msgs::{ChannelMessageHandler, ChannelUpdate};
26 use crate::ln::wire::Encode;
27 use crate::util::ser::{Writeable, Writer};
28 use crate::util::test_utils;
29 use crate::util::config::{UserConfig, ChannelConfig};
30 use crate::util::errors::APIError;
32 use bitcoin::hash_types::BlockHash;
34 use bitcoin::hashes::Hash;
35 use bitcoin::hashes::sha256::Hash as Sha256;
37 use bitcoin::secp256k1;
38 use bitcoin::secp256k1::{Secp256k1, SecretKey};
41 use crate::prelude::*;
42 use core::default::Default;
44 use crate::ln::functional_test_utils::*;
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),
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);
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),
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);
70 $event_type { .. } => {},
71 _ => panic!("Unexpected event"),
76 macro_rules! expect_htlc_forward {
78 expect_event!($node, Event::PendingHTLCsForwardable);
79 $node.node.process_pending_htlc_forwards();
83 // 0 ~~> 2 send payment
84 let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
85 nodes[0].node.send_payment_with_route(&route, *payment_hash,
86 RecipientOnionFields::secret_only(*payment_secret), payment_id).unwrap();
87 check_added_monitors!(nodes[0], 1);
88 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
89 // temper update_add (0 => 1)
90 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
91 if test_case == 0 || test_case == 3 || test_case == 100 {
92 callback_msg(&mut update_add_0);
95 // 0 => 1 update_add & CS
96 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
97 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
99 let update_1_0 = match test_case {
100 0|100 => { // intermediate node failure; fail backward to 0
101 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
102 assert!(update_1_0.update_fail_htlcs.len()+update_1_0.update_fail_malformed_htlcs.len()==1 && (update_1_0.update_fail_htlcs.len()==1 || update_1_0.update_fail_malformed_htlcs.len()==1));
105 1|2|3|200 => { // final node failure; forwarding to 2
106 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
108 if test_case != 200 {
111 expect_htlc_forward!(&nodes[1]);
113 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
114 check_added_monitors!(&nodes[1], 1);
115 assert_eq!(update_1.update_add_htlcs.len(), 1);
116 // tamper update_add (1 => 2)
117 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
118 if test_case != 3 && test_case != 200 {
119 callback_msg(&mut update_add_1);
123 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
124 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
126 if test_case == 2 || test_case == 200 {
127 expect_htlc_forward!(&nodes[2]);
128 expect_event!(&nodes[2], Event::PaymentClaimable);
130 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
133 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
134 if test_case == 2 || test_case == 200 {
135 check_added_monitors!(&nodes[2], 1);
137 assert!(update_2_1.update_fail_htlcs.len() == 1);
139 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
140 if test_case == 200 {
141 callback_fail(&mut fail_msg);
145 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
146 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
148 // backward fail on 1
149 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
150 assert!(update_1_0.update_fail_htlcs.len() == 1);
156 // 1 => 0 commitment_signed_dance
157 if update_1_0.update_fail_htlcs.len() > 0 {
158 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
159 if test_case == 100 {
160 callback_fail(&mut fail_msg);
162 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
164 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
167 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
169 let events = nodes[0].node.get_and_clear_pending_events();
170 assert_eq!(events.len(), 2);
171 if let &Event::PaymentPathFailed { ref payment_failed_permanently, ref short_channel_id, ref error_code, failure: PathFailure::OnPath { ref network_update }, .. } = &events[0] {
172 assert_eq!(*payment_failed_permanently, !expected_retryable);
173 assert_eq!(*error_code, expected_error_code);
174 if expected_channel_update.is_some() {
175 match network_update {
176 Some(update) => match update {
177 &NetworkUpdate::ChannelUpdateMessage { .. } => {
178 if let NetworkUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
179 panic!("channel_update not found!");
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);
187 panic!("Unexpected message event");
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);
195 panic!("Unexpected message event");
199 None => panic!("Expected channel update"),
202 assert!(network_update.is_none());
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"),
210 assert!(short_channel_id.is_none());
213 panic!("Unexpected event");
216 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id } => {
217 assert_eq!(*payment_hash, ev_payment_hash);
218 assert_eq!(payment_id, ev_payment_id);
220 _ => panic!("Unexpected second event"),
224 impl msgs::ChannelUpdate {
225 fn dummy(short_channel_id: u64) -> msgs::ChannelUpdate {
226 use bitcoin::secp256k1::ffi::Signature as FFISignature;
227 use bitcoin::secp256k1::ecdsa::Signature;
228 msgs::ChannelUpdate {
229 signature: Signature::from(unsafe { FFISignature::new() }),
230 contents: msgs::UnsignedChannelUpdate {
231 chain_hash: BlockHash::hash(&vec![0u8][..]),
235 cltv_expiry_delta: 0,
236 htlc_minimum_msat: 0,
237 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
239 fee_proportional_millionths: 0,
246 struct BogusOnionHopData {
249 impl BogusOnionHopData {
250 fn new(orig: msgs::OnionHopData) -> Self {
251 Self { data: orig.encode() }
254 impl Writeable for BogusOnionHopData {
255 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
256 writer.write_all(&self.data[..])
260 const BADONION: u16 = 0x8000;
261 const PERM: u16 = 0x4000;
262 const NODE: u16 = 0x2000;
263 const UPDATE: u16 = 0x1000;
266 fn test_fee_failures() {
267 // Tests that the fee required when forwarding remains consistent over time. This was
268 // previously broken, with forwarding fees floating based on the fee estimator at the time of
271 // When this test was written, the default base fee floated based on the HTLC count.
272 // It is now fixed, so we simply set the fee to the expected value here.
273 let mut config = test_default_channel_config();
274 config.channel_config.forwarding_fee_base_msat = 196;
276 let chanmon_cfgs = create_chanmon_cfgs(3);
277 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
278 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
279 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
280 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
283 let (route, payment_hash_success, payment_preimage_success, payment_secret_success) = get_route_and_payment_hash!(nodes[0], nodes[2], 40_000);
284 nodes[0].node.send_payment_with_route(&route, payment_hash_success,
285 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
286 check_added_monitors!(nodes[0], 1);
287 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
288 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
290 // If the hop gives fee_insufficient but enough fees were provided, then the previous hop
291 // malleated the payment before forwarding, taking funds when they shouldn't have.
292 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
293 let short_channel_id = channels[0].0.contents.short_channel_id;
294 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
295 msg.amount_msat -= 1;
296 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
298 // In an earlier version, we spuriously failed to forward payments if the expected feerate
299 // changed between the channel open and the payment.
301 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
305 let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
306 nodes[0].node.send_payment_with_route(&route, payment_hash_success,
307 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
308 check_added_monitors!(nodes[0], 1);
309 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
310 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
314 fn test_onion_failure() {
315 // When we check for amount_below_minimum below, we want to test that we're using the *right*
316 // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
317 // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
318 // This exposed a previous bug because we were using the wrong value all the way down in
319 // Channel::get_counterparty_htlc_minimum_msat().
320 let mut node_2_cfg: UserConfig = Default::default();
321 node_2_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
322 node_2_cfg.channel_handshake_config.announced_channel = true;
323 node_2_cfg.channel_handshake_limits.force_announced_channel_preference = false;
325 // When this test was written, the default base fee floated based on the HTLC count.
326 // It is now fixed, so we simply set the fee to the expected value here.
327 let mut config = test_default_channel_config();
328 config.channel_config.forwarding_fee_base_msat = 196;
330 let chanmon_cfgs = create_chanmon_cfgs(3);
331 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
332 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
333 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
334 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
335 for node in nodes.iter() {
336 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
338 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
340 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
342 // intermediate node failure
343 let short_channel_id = channels[1].0.contents.short_channel_id;
344 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
345 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
346 let cur_height = nodes[0].best_block_info().1 + 1;
347 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
348 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
349 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), 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));
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));
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(
367 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
368 let mut new_payloads = Vec::new();
369 for payload in onion_payloads.drain(..) {
370 new_payloads.push(BogusOnionHopData::new(payload));
372 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
373 // length-1 TLV payload, which is obviously bogus.
374 new_payloads[1].data[0] = 1;
375 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
376 }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
378 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
379 // receiving simulated fail messages
380 // intermediate node failure
381 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
383 msg.amount_msat -= 1;
385 // and tamper returning error message
386 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
387 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
388 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), NODE|2, &[0;0]);
389 }, ||{}, true, Some(NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}), Some(route.paths[0][0].short_channel_id));
391 // final node failure
392 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
393 // and tamper returning error message
394 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
395 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
396 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), NODE|2, &[0;0]);
398 nodes[2].node.fail_htlc_backwards(&payment_hash);
399 }, true, Some(NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}), Some(route.paths[0][1].short_channel_id));
400 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
402 // intermediate node failure
403 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
404 msg.amount_msat -= 1;
406 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
407 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
408 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
409 }, ||{}, true, Some(PERM|NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));
411 // final node failure
412 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
413 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
414 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
415 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
417 nodes[2].node.fail_htlc_backwards(&payment_hash);
418 }, false, Some(PERM|NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}), Some(route.paths[0][1].short_channel_id));
419 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
421 // intermediate node failure
422 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
423 msg.amount_msat -= 1;
425 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
426 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
427 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
429 nodes[2].node.fail_htlc_backwards(&payment_hash);
430 }, true, Some(PERM|NODE|3), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));
432 // final node failure
433 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
434 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
435 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
436 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
438 nodes[2].node.fail_htlc_backwards(&payment_hash);
439 }, false, Some(PERM|NODE|3), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}), Some(route.paths[0][1].short_channel_id));
440 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
442 // Our immediate peer sent UpdateFailMalformedHTLC because it couldn't understand the onion in
443 // the UpdateAddHTLC that we sent.
444 let short_channel_id = channels[0].0.contents.short_channel_id;
445 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
446 Some(BADONION|PERM|4), None, Some(short_channel_id));
448 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
449 Some(BADONION|PERM|5), None, Some(short_channel_id));
451 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
452 Some(BADONION|PERM|6), None, Some(short_channel_id));
454 let short_channel_id = channels[1].0.contents.short_channel_id;
455 let chan_update = ChannelUpdate::dummy(short_channel_id);
457 let mut err_data = Vec::new();
458 err_data.extend_from_slice(&(chan_update.serialized_length() as u16 + 2).to_be_bytes());
459 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
460 err_data.extend_from_slice(&chan_update.encode());
461 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
462 msg.amount_msat -= 1;
464 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
465 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
466 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data);
467 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update.clone()}), Some(short_channel_id));
469 // Check we can still handle onion failures that include channel updates without a type prefix
470 let err_data_without_type = chan_update.encode_with_len();
471 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
472 msg.amount_msat -= 1;
474 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
475 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
476 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data_without_type);
477 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update}), Some(short_channel_id));
479 let short_channel_id = channels[1].0.contents.short_channel_id;
480 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
481 msg.amount_msat -= 1;
483 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
484 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
485 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|8, &[0;0]);
486 // short_channel_id from the processing node
487 }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
489 let short_channel_id = channels[1].0.contents.short_channel_id;
490 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
491 msg.amount_msat -= 1;
493 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
494 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
495 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|9, &[0;0]);
496 // short_channel_id from the processing node
497 }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
499 let mut bogus_route = route.clone();
500 bogus_route.paths[0][1].short_channel_id -= 1;
501 let short_channel_id = bogus_route.paths[0][1].short_channel_id;
502 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
503 Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent:true}), Some(short_channel_id));
505 let short_channel_id = channels[1].0.contents.short_channel_id;
506 let amt_to_forward = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[2].node.get_our_node_id())
507 .unwrap().lock().unwrap().channel_by_id.get(&channels[1].2).unwrap()
508 .get_counterparty_htlc_minimum_msat() - 1;
509 let mut bogus_route = route.clone();
510 let route_len = bogus_route.paths[0].len();
511 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
512 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(UPDATE|11), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
514 // Clear pending payments so that the following positive test has the correct payment hash.
515 for node in nodes.iter() {
516 node.node.clear_pending_payments();
519 // Test a positive test-case with one extra msat, meeting the minimum.
520 bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward + 1;
521 let preimage = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1).0;
522 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
524 let short_channel_id = channels[0].0.contents.short_channel_id;
525 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
526 msg.amount_msat -= 1;
527 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
529 let short_channel_id = channels[0].0.contents.short_channel_id;
530 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
531 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
532 msg.cltv_expiry -= 1;
533 }, || {}, true, Some(UPDATE|13), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
535 let short_channel_id = channels[1].0.contents.short_channel_id;
536 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
537 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
538 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
539 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
540 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
541 }, ||{}, true, Some(UPDATE|14), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
543 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
544 nodes[2].node.fail_htlc_backwards(&payment_hash);
545 }, false, Some(PERM|15), None, None);
546 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
548 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
549 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
550 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
551 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
552 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
553 }, || {}, false, Some(0x4000 | 15), None, None);
555 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
556 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
557 for f in pending_forwards.iter_mut() {
559 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
560 forward_info.outgoing_cltv_value -= 1,
565 }, true, Some(18), None, Some(channels[1].0.contents.short_channel_id));
567 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
568 // violate amt_to_forward > msg.amount_msat
569 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
570 for f in pending_forwards.iter_mut() {
572 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
573 forward_info.outgoing_amt_msat -= 1,
578 }, true, Some(19), None, Some(channels[1].0.contents.short_channel_id));
580 let short_channel_id = channels[1].0.contents.short_channel_id;
581 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
582 // disconnect event to the channel between nodes[1] ~ nodes[2]
583 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
584 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
585 }, true, Some(UPDATE|20), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
586 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
588 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
589 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
590 let mut route = route.clone();
591 let height = nodes[2].best_block_info().1;
592 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
593 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
594 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(
595 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), height, &None).unwrap();
596 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
597 msg.cltv_expiry = htlc_cltv;
598 msg.onion_routing_packet = onion_packet;
599 }, ||{}, true, Some(21), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}), Some(route.paths[0][0].short_channel_id));
601 run_onion_failure_test_with_fail_intercept("mpp_timeout", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
602 // Tamper returning error message
603 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
604 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
605 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), 23, &[0;0]);
607 nodes[2].node.fail_htlc_backwards(&payment_hash);
608 }, true, Some(23), None, None);
612 fn test_overshoot_final_cltv() {
613 let chanmon_cfgs = create_chanmon_cfgs(3);
614 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
615 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None; 3]);
616 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
617 create_announced_chan_between_nodes(&nodes, 0, 1);
618 create_announced_chan_between_nodes(&nodes, 1, 2);
619 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
621 let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
622 nodes[0].node.send_payment_with_route(&route, payment_hash, RecipientOnionFields::secret_only(payment_secret), payment_id).unwrap();
624 check_added_monitors!(nodes[0], 1);
625 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
626 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
627 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
628 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
630 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
631 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
632 for f in pending_forwards.iter_mut() {
634 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
635 forward_info.outgoing_cltv_value += 1,
640 expect_pending_htlcs_forwardable!(nodes[1]);
642 check_added_monitors!(&nodes[1], 1);
643 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
644 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
645 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
646 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
648 expect_pending_htlcs_forwardable!(nodes[2]);
649 expect_payment_claimable!(nodes[2], payment_hash, payment_secret, 40_000);
650 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
653 fn do_test_onion_failure_stale_channel_update(announced_channel: bool) {
654 // Create a network of three nodes and two channels connecting them. We'll be updating the
655 // HTLC relay policy of the second channel, causing forwarding failures at the first hop.
656 let mut config = UserConfig::default();
657 config.channel_handshake_config.announced_channel = announced_channel;
658 config.channel_handshake_limits.force_announced_channel_preference = false;
659 config.accept_forwards_to_priv_channels = !announced_channel;
660 let chanmon_cfgs = create_chanmon_cfgs(3);
663 let channel_manager_1_deserialized;
664 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
665 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]);
666 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
668 let other_channel = create_chan_between_nodes(
669 &nodes[0], &nodes[1],
671 let channel_to_update = if announced_channel {
672 let channel = create_announced_chan_between_nodes(
675 (channel.2, channel.0.contents.short_channel_id)
677 let channel = create_unannounced_chan_between_nodes_with_value(
678 &nodes, 1, 2, 100000, 10001,
680 (channel.0.channel_id, channel.0.short_channel_id_alias.unwrap())
682 let channel_to_update_counterparty = &nodes[2].node.get_our_node_id();
684 let default_config = ChannelConfig::default();
686 // A test payment should succeed as the ChannelConfig has not been changed yet.
687 const PAYMENT_AMT: u64 = 40000;
688 let (route, payment_hash, payment_preimage, payment_secret) = if announced_channel {
689 get_route_and_payment_hash!(nodes[0], nodes[2], PAYMENT_AMT)
691 let hop_hints = vec![RouteHint(vec![RouteHintHop {
692 src_node_id: nodes[1].node.get_our_node_id(),
693 short_channel_id: channel_to_update.1,
695 base_msat: default_config.forwarding_fee_base_msat,
696 proportional_millionths: default_config.forwarding_fee_proportional_millionths,
698 cltv_expiry_delta: default_config.cltv_expiry_delta,
699 htlc_maximum_msat: None,
700 htlc_minimum_msat: None,
702 let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty, TEST_FINAL_CLTV)
703 .with_features(nodes[2].node.invoice_features())
704 .with_route_hints(hop_hints);
705 get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT, TEST_FINAL_CLTV)
707 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
708 payment_hash, payment_secret);
709 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
711 // Closure to force expiry of a channel's previous config.
712 let expire_prev_config = || {
713 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
714 nodes[1].node.timer_tick_occurred();
718 // Closure to update and retrieve the latest ChannelUpdate.
719 let update_and_get_channel_update = |config: &ChannelConfig, expect_new_update: bool,
720 prev_update: Option<&msgs::ChannelUpdate>, should_expire_prev_config: bool| -> Option<msgs::ChannelUpdate> {
721 nodes[1].node.update_channel_config(
722 channel_to_update_counterparty, &[channel_to_update.0], config,
724 let events = nodes[1].node.get_and_clear_pending_msg_events();
725 assert_eq!(events.len(), expect_new_update as usize);
726 if !expect_new_update {
729 let new_update = match &events[0] {
730 MessageSendEvent::BroadcastChannelUpdate { msg } => {
731 assert!(announced_channel);
734 MessageSendEvent::SendChannelUpdate { node_id, msg } => {
735 assert_eq!(node_id, channel_to_update_counterparty);
736 assert!(!announced_channel);
739 _ => panic!("expected Broadcast/SendChannelUpdate event"),
741 if prev_update.is_some() {
742 assert!(new_update.contents.timestamp > prev_update.unwrap().contents.timestamp)
744 if should_expire_prev_config {
745 expire_prev_config();
750 // We'll be attempting to route payments using the default ChannelUpdate for channels. This will
751 // lead to onion failures at the first hop once we update the ChannelConfig for the
753 let expect_onion_failure = |name: &str, error_code: u16, channel_update: &msgs::ChannelUpdate| {
754 let short_channel_id = channel_to_update.1;
755 let network_update = NetworkUpdate::ChannelUpdateMessage { msg: channel_update.clone() };
756 run_onion_failure_test(
757 name, 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {}, true,
758 Some(error_code), Some(network_update), Some(short_channel_id),
762 // Updates to cltv_expiry_delta below MIN_CLTV_EXPIRY_DELTA should fail with APIMisuseError.
763 let mut invalid_config = default_config.clone();
764 invalid_config.cltv_expiry_delta = 0;
765 match nodes[1].node.update_channel_config(
766 channel_to_update_counterparty, &[channel_to_update.0], &invalid_config,
768 Err(APIError::APIMisuseError{ .. }) => {},
769 _ => panic!("unexpected result applying invalid cltv_expiry_delta"),
772 // Increase the base fee which should trigger a new ChannelUpdate.
773 let mut config = nodes[1].node.list_usable_channels().iter()
774 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
776 config.forwarding_fee_base_msat = u32::max_value();
777 let msg = update_and_get_channel_update(&config, true, None, false).unwrap();
779 // The old policy should still be in effect until a new block is connected.
780 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
781 payment_hash, payment_secret);
782 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
784 // Connect a block, which should expire the previous config, leading to a failure when
785 // forwarding the HTLC.
786 expire_prev_config();
787 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
789 // Redundant updates should not trigger a new ChannelUpdate.
790 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
792 // Similarly, updates that do not have an affect on ChannelUpdate should not trigger a new one.
793 config.force_close_avoidance_max_fee_satoshis *= 2;
794 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
796 // Reset the base fee to the default and increase the proportional fee which should trigger a
797 // new ChannelUpdate.
798 config.forwarding_fee_base_msat = default_config.forwarding_fee_base_msat;
799 config.cltv_expiry_delta = u16::max_value();
800 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
801 expect_onion_failure("incorrect_cltv_expiry", UPDATE|13, &msg);
803 // Reset the proportional fee and increase the CLTV expiry delta which should trigger a new
805 config.cltv_expiry_delta = default_config.cltv_expiry_delta;
806 config.forwarding_fee_proportional_millionths = u32::max_value();
807 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
808 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
810 // To test persistence of the updated config, we'll re-initialize the ChannelManager.
811 let config_after_restart = {
812 let chan_1_monitor_serialized = get_monitor!(nodes[1], other_channel.3).encode();
813 let chan_2_monitor_serialized = get_monitor!(nodes[1], channel_to_update.0).encode();
814 reload_node!(nodes[1], *nodes[1].node.get_current_default_configuration(), &nodes[1].node.encode(),
815 &[&chan_1_monitor_serialized, &chan_2_monitor_serialized], persister, chain_monitor, channel_manager_1_deserialized);
816 nodes[1].node.list_channels().iter()
817 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
820 assert_eq!(config, config_after_restart);
824 fn test_onion_failure_stale_channel_update() {
825 do_test_onion_failure_stale_channel_update(false);
826 do_test_onion_failure_stale_channel_update(true);
830 fn test_always_create_tlv_format_onion_payloads() {
831 // Verify that we always generate tlv onion format payloads, even if the features specifically
832 // specifies no support for variable length onions, as the legacy payload format has been
833 // deprecated in BOLT4.
834 let chanmon_cfgs = create_chanmon_cfgs(3);
835 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
837 // Set `node[1]`'s init features to features which return `false` for
838 // `supports_variable_length_onion()`
839 let mut no_variable_length_onion_features = InitFeatures::empty();
840 no_variable_length_onion_features.set_static_remote_key_required();
841 *node_cfgs[1].override_init_features.borrow_mut() = Some(no_variable_length_onion_features);
843 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
844 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
846 create_announced_chan_between_nodes(&nodes, 0, 1);
847 create_announced_chan_between_nodes(&nodes, 1, 2);
849 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
850 .with_features(InvoiceFeatures::empty());
851 let (route, _payment_hash, _payment_preimage, _payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, 40000, TEST_FINAL_CLTV);
853 let hops = &route.paths[0];
854 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
855 assert!(!hops[0].node_features.supports_variable_length_onion());
856 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
857 assert!(!hops[1].node_features.supports_variable_length_onion());
859 let cur_height = nodes[0].best_block_info().1 + 1;
860 let (onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
861 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
863 match onion_payloads[0].format {
864 msgs::OnionHopDataFormat::NonFinalNode {..} => {},
866 "Should have generated a `msgs::OnionHopDataFormat::NonFinalNode` payload for `hops[0]`,
867 despite that the features signals no support for variable length onions"
870 match onion_payloads[1].format {
871 msgs::OnionHopDataFormat::FinalNode {..} => {},
873 "Should have generated a `msgs::OnionHopDataFormat::FinalNode` payload for `hops[1]`,
874 despite that the features signals no support for variable length onions"
879 fn do_test_fail_htlc_backwards_with_reason(failure_code: FailureCode) {
881 let chanmon_cfgs = create_chanmon_cfgs(2);
882 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
883 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
884 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
886 create_announced_chan_between_nodes(&nodes, 0, 1);
888 let payment_amount = 100_000;
889 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_amount);
890 nodes[0].node.send_payment_with_route(&route, payment_hash,
891 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
892 check_added_monitors!(nodes[0], 1);
894 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
895 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
896 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
897 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
899 expect_pending_htlcs_forwardable!(nodes[1]);
900 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, payment_amount);
901 nodes[1].node.fail_htlc_backwards_with_reason(&payment_hash, failure_code);
903 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash }]);
904 check_added_monitors!(nodes[1], 1);
906 let events = nodes[1].node.get_and_clear_pending_msg_events();
907 assert_eq!(events.len(), 1);
908 let (update_fail_htlc, commitment_signed) = match events[0] {
909 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 } } => {
910 assert!(update_add_htlcs.is_empty());
911 assert!(update_fulfill_htlcs.is_empty());
912 assert_eq!(update_fail_htlcs.len(), 1);
913 assert!(update_fail_malformed_htlcs.is_empty());
914 assert!(update_fee.is_none());
915 (update_fail_htlcs[0].clone(), commitment_signed)
917 _ => panic!("Unexpected event"),
920 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
921 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
923 let failure_data = match failure_code {
924 FailureCode::TemporaryNodeFailure => vec![],
925 FailureCode::RequiredNodeFeatureMissing => vec![],
926 FailureCode::IncorrectOrUnknownPaymentDetails => {
927 let mut htlc_msat_height_data = (payment_amount as u64).to_be_bytes().to_vec();
928 htlc_msat_height_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes());
929 htlc_msat_height_data
933 let failure_code = failure_code as u16;
934 let permanent_flag = 0x4000;
935 let permanent_fail = (failure_code & permanent_flag) != 0;
936 expect_payment_failed!(nodes[0], payment_hash, permanent_fail, failure_code, failure_data);
941 fn test_fail_htlc_backwards_with_reason() {
942 do_test_fail_htlc_backwards_with_reason(FailureCode::TemporaryNodeFailure);
943 do_test_fail_htlc_backwards_with_reason(FailureCode::RequiredNodeFeatureMissing);
944 do_test_fail_htlc_backwards_with_reason(FailureCode::IncorrectOrUnknownPaymentDetails);
947 macro_rules! get_phantom_route {
948 ($nodes: expr, $amt: expr, $channel: expr) => {{
949 let phantom_pubkey = $nodes[1].keys_manager.get_node_id(Recipient::PhantomNode).unwrap();
950 let phantom_route_hint = $nodes[1].node.get_phantom_route_hints();
951 let payment_params = PaymentParameters::from_node_id(phantom_pubkey, TEST_FINAL_CLTV)
952 .with_features($nodes[1].node.invoice_features())
953 .with_route_hints(vec![RouteHint(vec![
955 src_node_id: $nodes[0].node.get_our_node_id(),
956 short_channel_id: $channel.0.contents.short_channel_id,
958 base_msat: $channel.0.contents.fee_base_msat,
959 proportional_millionths: $channel.0.contents.fee_proportional_millionths,
961 cltv_expiry_delta: $channel.0.contents.cltv_expiry_delta,
962 htlc_minimum_msat: None,
963 htlc_maximum_msat: None,
966 src_node_id: phantom_route_hint.real_node_pubkey,
967 short_channel_id: phantom_route_hint.phantom_scid,
970 proportional_millionths: 0,
972 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
973 htlc_minimum_msat: None,
974 htlc_maximum_msat: None,
977 let scorer = test_utils::TestScorer::new();
978 let network_graph = $nodes[0].network_graph.read_only();
980 &$nodes[0].node.get_our_node_id(), &payment_params, &network_graph,
981 Some(&$nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
982 $amt, TEST_FINAL_CLTV, $nodes[0].logger, &scorer, &[0u8; 32]
983 ).unwrap(), phantom_route_hint.phantom_scid)
988 fn test_phantom_onion_hmac_failure() {
989 let chanmon_cfgs = create_chanmon_cfgs(2);
990 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
991 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
992 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
994 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
997 let recv_value_msat = 10_000;
998 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
999 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1001 // Route the HTLC through to the destination.
1002 nodes[0].node.send_payment_with_route(&route, payment_hash,
1003 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1004 check_added_monitors!(nodes[0], 1);
1005 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1006 let mut update_add = update_0.update_add_htlcs[0].clone();
1008 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1009 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1011 // Modify the payload so the phantom hop's HMAC is bogus.
1012 let sha256_of_onion = {
1013 let mut forward_htlcs = nodes[1].node.forward_htlcs.lock().unwrap();
1014 let mut pending_forward = forward_htlcs.get_mut(&phantom_scid).unwrap();
1015 match pending_forward[0] {
1016 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1017 forward_info: PendingHTLCInfo {
1018 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1022 onion_packet.hmac[onion_packet.hmac.len() - 1] ^= 1;
1023 Sha256::hash(&onion_packet.hop_data).into_inner().to_vec()
1025 _ => panic!("Unexpected forward"),
1028 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1029 nodes[1].node.process_pending_htlc_forwards();
1030 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1031 nodes[1].node.process_pending_htlc_forwards();
1032 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1033 check_added_monitors!(&nodes[1], 1);
1034 assert!(update_1.update_fail_htlcs.len() == 1);
1035 let fail_msg = update_1.update_fail_htlcs[0].clone();
1036 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1037 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1039 // Ensure the payment fails with the expected error.
1040 let mut fail_conditions = PaymentFailedConditions::new()
1041 .blamed_scid(phantom_scid)
1042 .blamed_chan_closed(true)
1043 .expected_htlc_error_data(0x8000 | 0x4000 | 5, &sha256_of_onion);
1044 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1048 fn test_phantom_invalid_onion_payload() {
1049 let chanmon_cfgs = create_chanmon_cfgs(2);
1050 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1051 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1052 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1054 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1057 let recv_value_msat = 10_000;
1058 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1059 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1061 // We'll use the session priv later when constructing an invalid onion packet.
1062 let session_priv = [3; 32];
1063 *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
1064 nodes[0].node.send_payment_with_route(&route, payment_hash,
1065 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1066 check_added_monitors!(nodes[0], 1);
1067 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1068 let mut update_add = update_0.update_add_htlcs[0].clone();
1070 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1071 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1073 // Modify the onion packet to have an invalid payment amount.
1074 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1075 for f in pending_forwards.iter_mut() {
1077 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1078 forward_info: PendingHTLCInfo {
1079 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1083 // Construct the onion payloads for the entire route and an invalid amount.
1084 let height = nodes[0].best_block_info().1;
1085 let session_priv = SecretKey::from_slice(&session_priv).unwrap();
1086 let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
1087 let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(
1088 &route.paths[0], msgs::MAX_VALUE_MSAT + 1,
1089 RecipientOnionFields::secret_only(payment_secret), height + 1, &None).unwrap();
1090 // We only want to construct the onion packet for the last hop, not the entire route, so
1091 // remove the first hop's payload and its keys.
1092 onion_keys.remove(0);
1093 onion_payloads.remove(0);
1095 let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1096 onion_packet.hop_data = new_onion_packet.hop_data;
1097 onion_packet.hmac = new_onion_packet.hmac;
1099 _ => panic!("Unexpected forward"),
1103 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1104 nodes[1].node.process_pending_htlc_forwards();
1105 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1106 nodes[1].node.process_pending_htlc_forwards();
1107 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1108 check_added_monitors!(&nodes[1], 1);
1109 assert!(update_1.update_fail_htlcs.len() == 1);
1110 let fail_msg = update_1.update_fail_htlcs[0].clone();
1111 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1112 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1114 // Ensure the payment fails with the expected error.
1115 let error_data = Vec::new();
1116 let mut fail_conditions = PaymentFailedConditions::new()
1117 .blamed_scid(phantom_scid)
1118 .blamed_chan_closed(true)
1119 .expected_htlc_error_data(0x4000 | 22, &error_data);
1120 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1124 fn test_phantom_final_incorrect_cltv_expiry() {
1125 let chanmon_cfgs = create_chanmon_cfgs(2);
1126 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1127 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1128 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1130 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1133 let recv_value_msat = 10_000;
1134 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1135 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1137 // Route the HTLC through to the destination.
1138 nodes[0].node.send_payment_with_route(&route, payment_hash,
1139 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1140 check_added_monitors!(nodes[0], 1);
1141 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1142 let mut update_add = update_0.update_add_htlcs[0].clone();
1144 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1145 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1147 // Modify the payload so the phantom hop's HMAC is bogus.
1148 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1149 for f in pending_forwards.iter_mut() {
1151 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1152 forward_info: PendingHTLCInfo { ref mut outgoing_cltv_value, .. }, ..
1154 *outgoing_cltv_value -= 1;
1156 _ => panic!("Unexpected forward"),
1160 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1161 nodes[1].node.process_pending_htlc_forwards();
1162 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1163 nodes[1].node.process_pending_htlc_forwards();
1164 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1165 check_added_monitors!(&nodes[1], 1);
1166 assert!(update_1.update_fail_htlcs.len() == 1);
1167 let fail_msg = update_1.update_fail_htlcs[0].clone();
1168 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1169 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1171 // Ensure the payment fails with the expected error.
1172 let expected_cltv: u32 = 80;
1173 let error_data = expected_cltv.to_be_bytes().to_vec();
1174 let mut fail_conditions = PaymentFailedConditions::new()
1175 .blamed_scid(phantom_scid)
1176 .expected_htlc_error_data(18, &error_data);
1177 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1181 fn test_phantom_failure_too_low_cltv() {
1182 let chanmon_cfgs = create_chanmon_cfgs(2);
1183 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1184 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1185 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1187 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1190 let recv_value_msat = 10_000;
1191 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1192 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1194 // Modify the route to have a too-low cltv.
1195 route.paths[0][1].cltv_expiry_delta = 5;
1197 // Route the HTLC through to the destination.
1198 nodes[0].node.send_payment_with_route(&route, payment_hash,
1199 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1200 check_added_monitors!(nodes[0], 1);
1201 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1202 let mut update_add = update_0.update_add_htlcs[0].clone();
1204 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1205 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1207 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1208 nodes[1].node.process_pending_htlc_forwards();
1209 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1210 nodes[1].node.process_pending_htlc_forwards();
1211 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1212 check_added_monitors!(&nodes[1], 1);
1213 assert!(update_1.update_fail_htlcs.len() == 1);
1214 let fail_msg = update_1.update_fail_htlcs[0].clone();
1215 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1216 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1218 // Ensure the payment fails with the expected error.
1219 let mut error_data = recv_value_msat.to_be_bytes().to_vec();
1220 error_data.extend_from_slice(
1221 &nodes[0].node.best_block.read().unwrap().height().to_be_bytes(),
1223 let mut fail_conditions = PaymentFailedConditions::new()
1224 .blamed_scid(phantom_scid)
1225 .expected_htlc_error_data(0x4000 | 15, &error_data);
1226 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1230 fn test_phantom_failure_modified_cltv() {
1231 // Test that we fail back phantoms if the upstream node fiddled with the CLTV too much with the
1232 // correct error code.
1233 let chanmon_cfgs = create_chanmon_cfgs(2);
1234 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1235 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1236 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1238 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1241 let recv_value_msat = 10_000;
1242 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1243 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1245 // Route the HTLC through to the destination.
1246 nodes[0].node.send_payment_with_route(&route, payment_hash,
1247 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1248 check_added_monitors!(nodes[0], 1);
1249 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1250 let mut update_add = update_0.update_add_htlcs[0].clone();
1252 // Modify the route to have a too-low cltv.
1253 update_add.cltv_expiry -= 10;
1255 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1256 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1258 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1259 assert!(update_1.update_fail_htlcs.len() == 1);
1260 let fail_msg = update_1.update_fail_htlcs[0].clone();
1261 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1262 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1264 // Ensure the payment fails with the expected error.
1265 let mut fail_conditions = PaymentFailedConditions::new()
1266 .blamed_scid(phantom_scid)
1267 .expected_htlc_error_data(0x2000 | 2, &[]);
1268 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1272 fn test_phantom_failure_expires_too_soon() {
1273 // Test that we fail back phantoms if the HTLC got delayed and we got blocks in between with
1274 // the correct error code.
1275 let chanmon_cfgs = create_chanmon_cfgs(2);
1276 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1277 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1278 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1280 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1283 let recv_value_msat = 10_000;
1284 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1285 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1287 // Route the HTLC through to the destination.
1288 nodes[0].node.send_payment_with_route(&route, payment_hash,
1289 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1290 check_added_monitors!(nodes[0], 1);
1291 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1292 let mut update_add = update_0.update_add_htlcs[0].clone();
1294 connect_blocks(&nodes[1], CLTV_FAR_FAR_AWAY);
1295 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1296 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1298 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1299 assert!(update_1.update_fail_htlcs.len() == 1);
1300 let fail_msg = update_1.update_fail_htlcs[0].clone();
1301 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1302 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1304 // Ensure the payment fails with the expected error.
1305 let mut fail_conditions = PaymentFailedConditions::new()
1306 .blamed_scid(phantom_scid)
1307 .expected_htlc_error_data(0x2000 | 2, &[]);
1308 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1312 fn test_phantom_failure_too_low_recv_amt() {
1313 let chanmon_cfgs = create_chanmon_cfgs(2);
1314 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1315 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1316 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1318 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1320 // Get the route with a too-low amount.
1321 let recv_amt_msat = 10_000;
1322 let bad_recv_amt_msat = recv_amt_msat - 10;
1323 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1324 let (mut route, phantom_scid) = get_phantom_route!(nodes, bad_recv_amt_msat, channel);
1326 // Route the HTLC through to the destination.
1327 nodes[0].node.send_payment_with_route(&route, payment_hash,
1328 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1329 check_added_monitors!(nodes[0], 1);
1330 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1331 let mut update_add = update_0.update_add_htlcs[0].clone();
1333 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1334 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1336 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1337 nodes[1].node.process_pending_htlc_forwards();
1338 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1339 nodes[1].node.process_pending_htlc_forwards();
1340 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
1341 nodes[1].node.process_pending_htlc_forwards();
1342 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1343 check_added_monitors!(&nodes[1], 1);
1344 assert!(update_1.update_fail_htlcs.len() == 1);
1345 let fail_msg = update_1.update_fail_htlcs[0].clone();
1346 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1347 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1349 // Ensure the payment fails with the expected error.
1350 let mut error_data = bad_recv_amt_msat.to_be_bytes().to_vec();
1351 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1352 let mut fail_conditions = PaymentFailedConditions::new()
1353 .blamed_scid(phantom_scid)
1354 .expected_htlc_error_data(0x4000 | 15, &error_data);
1355 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1359 fn test_phantom_dust_exposure_failure() {
1360 // Set the max dust exposure to the dust limit.
1361 let max_dust_exposure = 546;
1362 let mut receiver_config = UserConfig::default();
1363 receiver_config.channel_config.max_dust_htlc_exposure_msat = max_dust_exposure;
1364 receiver_config.channel_handshake_config.announced_channel = true;
1366 let chanmon_cfgs = create_chanmon_cfgs(2);
1367 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1368 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(receiver_config)]);
1369 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1371 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1373 // Get the route with an amount exceeding the dust exposure threshold of nodes[1].
1374 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(max_dust_exposure + 1));
1375 let (mut route, _) = get_phantom_route!(nodes, max_dust_exposure + 1, channel);
1377 // Route the HTLC through to the destination.
1378 nodes[0].node.send_payment_with_route(&route, payment_hash,
1379 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1380 check_added_monitors!(nodes[0], 1);
1381 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1382 let mut update_add = update_0.update_add_htlcs[0].clone();
1384 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1385 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1387 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1388 assert!(update_1.update_fail_htlcs.len() == 1);
1389 let fail_msg = update_1.update_fail_htlcs[0].clone();
1390 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1391 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1393 // Ensure the payment fails with the expected error.
1394 let mut err_data = Vec::new();
1395 err_data.extend_from_slice(&(channel.1.serialized_length() as u16 + 2).to_be_bytes());
1396 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
1397 err_data.extend_from_slice(&channel.1.encode());
1399 let mut fail_conditions = PaymentFailedConditions::new()
1400 .blamed_scid(channel.0.contents.short_channel_id)
1401 .blamed_chan_closed(false)
1402 .expected_htlc_error_data(0x1000 | 7, &err_data);
1403 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1407 fn test_phantom_failure_reject_payment() {
1408 // Test that the user can successfully fail back a phantom node payment.
1409 let chanmon_cfgs = create_chanmon_cfgs(2);
1410 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1411 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1412 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1414 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1416 // Get the route with a too-low amount.
1417 let recv_amt_msat = 10_000;
1418 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1419 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_amt_msat, channel);
1421 // Route the HTLC through to the destination.
1422 nodes[0].node.send_payment_with_route(&route, payment_hash,
1423 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1424 check_added_monitors!(nodes[0], 1);
1425 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1426 let mut update_add = update_0.update_add_htlcs[0].clone();
1428 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1429 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1431 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1432 nodes[1].node.process_pending_htlc_forwards();
1433 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1434 nodes[1].node.process_pending_htlc_forwards();
1435 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, recv_amt_msat, None, route.paths[0].last().unwrap().pubkey);
1436 nodes[1].node.fail_htlc_backwards(&payment_hash);
1437 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1438 nodes[1].node.process_pending_htlc_forwards();
1440 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1441 check_added_monitors!(&nodes[1], 1);
1442 assert!(update_1.update_fail_htlcs.len() == 1);
1443 let fail_msg = update_1.update_fail_htlcs[0].clone();
1444 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1445 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1447 // Ensure the payment fails with the expected error.
1448 let mut error_data = recv_amt_msat.to_be_bytes().to_vec();
1449 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1450 let mut fail_conditions = PaymentFailedConditions::new()
1451 .blamed_scid(phantom_scid)
1452 .expected_htlc_error_data(0x4000 | 15, &error_data);
1453 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);