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::sign::{EntropySource, NodeSigner, Recipient};
16 use crate::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason};
17 use crate::ln::{PaymentHash, PaymentSecret};
18 use crate::ln::channel::EXPIRE_PREV_CONFIG_TICKS;
19 use crate::ln::channelmanager::{HTLCForwardInfo, FailureCode, CLTV_FAR_FAR_AWAY, DISABLE_GOSSIP_TICKS, MIN_CLTV_EXPIRY_DELTA, PendingAddHTLCInfo, PendingHTLCInfo, PendingHTLCRouting, PaymentId, RecipientOnionFields};
20 use crate::ln::onion_utils;
21 use crate::routing::gossip::{NetworkUpdate, RoutingFees};
22 use crate::routing::router::{get_route, PaymentParameters, Route, RouteHint, RouteHintHop};
23 use crate::ln::features::{InitFeatures, Bolt11InvoiceFeatures};
25 use crate::ln::msgs::{ChannelMessageHandler, ChannelUpdate};
26 use crate::ln::wire::Encode;
27 use crate::util::ser::{Writeable, Writer, BigSize};
28 use crate::util::test_utils;
29 use crate::util::config::{UserConfig, ChannelConfig, MaxDustHTLCExposure};
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, reason: ref ev_reason } => {
217 assert_eq!(*payment_hash, ev_payment_hash);
218 assert_eq!(payment_id, ev_payment_id);
219 assert_eq!(if expected_retryable {
220 PaymentFailureReason::RetriesExhausted
222 PaymentFailureReason::RecipientRejected
223 }, ev_reason.unwrap());
225 _ => panic!("Unexpected second event"),
229 impl msgs::ChannelUpdate {
230 fn dummy(short_channel_id: u64) -> msgs::ChannelUpdate {
231 use bitcoin::secp256k1::ffi::Signature as FFISignature;
232 use bitcoin::secp256k1::ecdsa::Signature;
233 msgs::ChannelUpdate {
234 signature: Signature::from(unsafe { FFISignature::new() }),
235 contents: msgs::UnsignedChannelUpdate {
236 chain_hash: BlockHash::hash(&vec![0u8][..]),
240 cltv_expiry_delta: 0,
241 htlc_minimum_msat: 0,
242 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
244 fee_proportional_millionths: 0,
251 struct BogusOnionHopData {
254 impl BogusOnionHopData {
255 fn new(orig: msgs::OutboundOnionPayload) -> Self {
256 Self { data: orig.encode() }
259 impl Writeable for BogusOnionHopData {
260 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
261 writer.write_all(&self.data[..])
265 const BADONION: u16 = 0x8000;
266 const PERM: u16 = 0x4000;
267 const NODE: u16 = 0x2000;
268 const UPDATE: u16 = 0x1000;
271 fn test_fee_failures() {
272 // Tests that the fee required when forwarding remains consistent over time. This was
273 // previously broken, with forwarding fees floating based on the fee estimator at the time of
276 // When this test was written, the default base fee floated based on the HTLC count.
277 // It is now fixed, so we simply set the fee to the expected value here.
278 let mut config = test_default_channel_config();
279 config.channel_config.forwarding_fee_base_msat = 196;
281 let chanmon_cfgs = create_chanmon_cfgs(3);
282 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
283 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
284 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
285 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
288 let (route, payment_hash_success, payment_preimage_success, payment_secret_success) = get_route_and_payment_hash!(nodes[0], nodes[2], 40_000);
289 nodes[0].node.send_payment_with_route(&route, payment_hash_success,
290 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
291 check_added_monitors!(nodes[0], 1);
292 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
293 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
295 // If the hop gives fee_insufficient but enough fees were provided, then the previous hop
296 // malleated the payment before forwarding, taking funds when they shouldn't have.
297 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
298 let short_channel_id = channels[0].0.contents.short_channel_id;
299 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
300 msg.amount_msat -= 1;
301 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
303 // In an earlier version, we spuriously failed to forward payments if the expected feerate
304 // changed between the channel open and the payment.
306 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
310 let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
311 nodes[0].node.send_payment_with_route(&route, payment_hash_success,
312 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
313 check_added_monitors!(nodes[0], 1);
314 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
315 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
319 fn test_onion_failure() {
320 // When we check for amount_below_minimum below, we want to test that we're using the *right*
321 // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
322 // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
323 // This exposed a previous bug because we were using the wrong value all the way down in
324 // Channel::get_counterparty_htlc_minimum_msat().
325 let mut node_2_cfg: UserConfig = Default::default();
326 node_2_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
327 node_2_cfg.channel_handshake_config.announced_channel = true;
328 node_2_cfg.channel_handshake_limits.force_announced_channel_preference = false;
330 // When this test was written, the default base fee floated based on the HTLC count.
331 // It is now fixed, so we simply set the fee to the expected value here.
332 let mut config = test_default_channel_config();
333 config.channel_config.forwarding_fee_base_msat = 196;
335 let chanmon_cfgs = create_chanmon_cfgs(3);
336 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
337 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
338 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
339 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
340 for node in nodes.iter() {
341 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
343 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
345 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
347 // intermediate node failure
348 let short_channel_id = channels[1].0.contents.short_channel_id;
349 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
350 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
351 let cur_height = nodes[0].best_block_info().1 + 1;
352 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
353 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
354 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
355 let mut new_payloads = Vec::new();
356 for payload in onion_payloads.drain(..) {
357 new_payloads.push(BogusOnionHopData::new(payload));
359 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
360 // describing a length-1 TLV payload, which is obviously bogus.
361 new_payloads[0].data[0] = 1;
362 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
363 }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
365 // final node failure
366 let short_channel_id = channels[1].0.contents.short_channel_id;
367 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
368 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
369 let cur_height = nodes[0].best_block_info().1 + 1;
370 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
371 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
372 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
373 let mut new_payloads = Vec::new();
374 for payload in onion_payloads.drain(..) {
375 new_payloads.push(BogusOnionHopData::new(payload));
377 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
378 // length-1 TLV payload, which is obviously bogus.
379 new_payloads[1].data[0] = 1;
380 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
381 }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
383 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
384 // receiving simulated fail messages
385 // intermediate node failure
386 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
388 msg.amount_msat -= 1;
390 // and tamper returning error message
391 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
392 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
393 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), NODE|2, &[0;0]);
394 }, ||{}, true, Some(NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[0].pubkey, is_permanent: false}), Some(route.paths[0].hops[0].short_channel_id));
396 // final node failure
397 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
398 // and tamper returning error message
399 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
400 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
401 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), NODE|2, &[0;0]);
403 nodes[2].node.fail_htlc_backwards(&payment_hash);
404 }, true, Some(NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[1].pubkey, is_permanent: false}), Some(route.paths[0].hops[1].short_channel_id));
405 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
407 // intermediate node failure
408 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
409 msg.amount_msat -= 1;
411 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
412 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
413 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
414 }, ||{}, true, Some(PERM|NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[0].pubkey, is_permanent: true}), Some(route.paths[0].hops[0].short_channel_id));
416 // final node failure
417 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
418 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
419 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
420 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
422 nodes[2].node.fail_htlc_backwards(&payment_hash);
423 }, false, Some(PERM|NODE|2), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[1].pubkey, is_permanent: true}), Some(route.paths[0].hops[1].short_channel_id));
424 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
426 // intermediate node failure
427 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
428 msg.amount_msat -= 1;
430 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
431 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
432 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
434 nodes[2].node.fail_htlc_backwards(&payment_hash);
435 }, true, Some(PERM|NODE|3), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[0].pubkey, is_permanent: true}), Some(route.paths[0].hops[0].short_channel_id));
437 // final node failure
438 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
439 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
440 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
441 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
443 nodes[2].node.fail_htlc_backwards(&payment_hash);
444 }, false, Some(PERM|NODE|3), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[1].pubkey, is_permanent: true}), Some(route.paths[0].hops[1].short_channel_id));
445 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
447 // Our immediate peer sent UpdateFailMalformedHTLC because it couldn't understand the onion in
448 // the UpdateAddHTLC that we sent.
449 let short_channel_id = channels[0].0.contents.short_channel_id;
450 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
451 Some(BADONION|PERM|4), None, Some(short_channel_id));
453 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
454 Some(BADONION|PERM|5), None, Some(short_channel_id));
456 run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
457 Some(BADONION|PERM|6), None, Some(short_channel_id));
459 let short_channel_id = channels[1].0.contents.short_channel_id;
460 let chan_update = ChannelUpdate::dummy(short_channel_id);
462 let mut err_data = Vec::new();
463 err_data.extend_from_slice(&(chan_update.serialized_length() as u16 + 2).to_be_bytes());
464 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
465 err_data.extend_from_slice(&chan_update.encode());
466 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
467 msg.amount_msat -= 1;
469 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
470 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
471 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data);
472 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update.clone()}), Some(short_channel_id));
474 // Check we can still handle onion failures that include channel updates without a type prefix
475 let err_data_without_type = chan_update.encode_with_len();
476 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
477 msg.amount_msat -= 1;
479 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
480 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
481 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data_without_type);
482 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update}), Some(short_channel_id));
484 let short_channel_id = channels[1].0.contents.short_channel_id;
485 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
486 msg.amount_msat -= 1;
488 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
489 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
490 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|8, &[0;0]);
491 // short_channel_id from the processing node
492 }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
494 let short_channel_id = channels[1].0.contents.short_channel_id;
495 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
496 msg.amount_msat -= 1;
498 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
499 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
500 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|9, &[0;0]);
501 // short_channel_id from the processing node
502 }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
504 let mut bogus_route = route.clone();
505 bogus_route.paths[0].hops[1].short_channel_id -= 1;
506 let short_channel_id = bogus_route.paths[0].hops[1].short_channel_id;
507 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
508 Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent:true}), Some(short_channel_id));
510 let short_channel_id = channels[1].0.contents.short_channel_id;
511 let amt_to_forward = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[2].node.get_our_node_id())
512 .unwrap().lock().unwrap().channel_by_id.get(&channels[1].2).unwrap()
513 .context.get_counterparty_htlc_minimum_msat() - 1;
514 let mut bogus_route = route.clone();
515 let route_len = bogus_route.paths[0].hops.len();
516 bogus_route.paths[0].hops[route_len-1].fee_msat = amt_to_forward;
517 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(UPDATE|11), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
519 // Clear pending payments so that the following positive test has the correct payment hash.
520 for node in nodes.iter() {
521 node.node.clear_pending_payments();
524 // Test a positive test-case with one extra msat, meeting the minimum.
525 bogus_route.paths[0].hops[route_len-1].fee_msat = amt_to_forward + 1;
526 let preimage = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1).0;
527 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
529 let short_channel_id = channels[0].0.contents.short_channel_id;
530 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
531 msg.amount_msat -= 1;
532 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
534 let short_channel_id = channels[0].0.contents.short_channel_id;
535 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
536 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
537 msg.cltv_expiry -= 1;
538 }, || {}, true, Some(UPDATE|13), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
540 let short_channel_id = channels[1].0.contents.short_channel_id;
541 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
542 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
543 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
544 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
545 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
546 }, ||{}, true, Some(UPDATE|14), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
548 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
549 nodes[2].node.fail_htlc_backwards(&payment_hash);
550 }, false, Some(PERM|15), None, None);
551 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
553 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
554 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
555 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
556 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
557 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
558 }, || {}, false, Some(0x4000 | 15), None, None);
560 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
561 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
562 for f in pending_forwards.iter_mut() {
564 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
565 forward_info.outgoing_cltv_value -= 1,
570 }, true, Some(18), None, Some(channels[1].0.contents.short_channel_id));
572 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
573 // violate amt_to_forward > msg.amount_msat
574 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
575 for f in pending_forwards.iter_mut() {
577 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
578 forward_info.outgoing_amt_msat -= 1,
583 }, true, Some(19), None, Some(channels[1].0.contents.short_channel_id));
585 let short_channel_id = channels[1].0.contents.short_channel_id;
586 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
587 // disconnect event to the channel between nodes[1] ~ nodes[2]
588 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
589 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
590 }, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
591 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
592 // disconnect event to the channel between nodes[1] ~ nodes[2]
593 for _ in 0..DISABLE_GOSSIP_TICKS + 1 {
594 nodes[1].node.timer_tick_occurred();
595 nodes[2].node.timer_tick_occurred();
597 nodes[1].node.get_and_clear_pending_msg_events();
598 nodes[2].node.get_and_clear_pending_msg_events();
599 }, true, Some(UPDATE|20), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
600 reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[2]));
602 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
603 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
604 let mut route = route.clone();
605 let height = nodes[2].best_block_info().1;
606 route.paths[0].hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0].hops[0].cltv_expiry_delta + 1;
607 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
608 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(
609 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), height, &None).unwrap();
610 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
611 msg.cltv_expiry = htlc_cltv;
612 msg.onion_routing_packet = onion_packet;
613 }, ||{}, true, Some(21), Some(NetworkUpdate::NodeFailure{node_id: route.paths[0].hops[0].pubkey, is_permanent: true}), Some(route.paths[0].hops[0].short_channel_id));
615 run_onion_failure_test_with_fail_intercept("mpp_timeout", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
616 // Tamper returning error message
617 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
618 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
619 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), 23, &[0;0]);
621 nodes[2].node.fail_htlc_backwards(&payment_hash);
622 }, true, Some(23), None, None);
626 fn test_overshoot_final_cltv() {
627 let chanmon_cfgs = create_chanmon_cfgs(3);
628 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
629 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None; 3]);
630 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
631 create_announced_chan_between_nodes(&nodes, 0, 1);
632 create_announced_chan_between_nodes(&nodes, 1, 2);
633 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
635 let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
636 nodes[0].node.send_payment_with_route(&route, payment_hash, RecipientOnionFields::secret_only(payment_secret), payment_id).unwrap();
638 check_added_monitors!(nodes[0], 1);
639 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
640 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
641 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
642 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
644 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
645 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
646 for f in pending_forwards.iter_mut() {
648 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
649 forward_info.outgoing_cltv_value += 1,
654 expect_pending_htlcs_forwardable!(nodes[1]);
656 check_added_monitors!(&nodes[1], 1);
657 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
658 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
659 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
660 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
662 expect_pending_htlcs_forwardable!(nodes[2]);
663 expect_payment_claimable!(nodes[2], payment_hash, payment_secret, 40_000);
664 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
667 fn do_test_onion_failure_stale_channel_update(announced_channel: bool) {
668 // Create a network of three nodes and two channels connecting them. We'll be updating the
669 // HTLC relay policy of the second channel, causing forwarding failures at the first hop.
670 let mut config = UserConfig::default();
671 config.channel_handshake_config.announced_channel = announced_channel;
672 config.channel_handshake_limits.force_announced_channel_preference = false;
673 config.accept_forwards_to_priv_channels = !announced_channel;
674 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
675 let chanmon_cfgs = create_chanmon_cfgs(3);
678 let channel_manager_1_deserialized;
679 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
680 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]);
681 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
683 let other_channel = create_chan_between_nodes(
684 &nodes[0], &nodes[1],
686 let channel_to_update = if announced_channel {
687 let channel = create_announced_chan_between_nodes(
690 (channel.2, channel.0.contents.short_channel_id)
692 let channel = create_unannounced_chan_between_nodes_with_value(
693 &nodes, 1, 2, 100000, 10001,
695 (channel.0.channel_id, channel.0.short_channel_id_alias.unwrap())
697 let channel_to_update_counterparty = &nodes[2].node.get_our_node_id();
699 let default_config = ChannelConfig::default();
701 // A test payment should succeed as the ChannelConfig has not been changed yet.
702 const PAYMENT_AMT: u64 = 40000;
703 let (route, payment_hash, payment_preimage, payment_secret) = if announced_channel {
704 get_route_and_payment_hash!(nodes[0], nodes[2], PAYMENT_AMT)
706 let hop_hints = vec![RouteHint(vec![RouteHintHop {
707 src_node_id: nodes[1].node.get_our_node_id(),
708 short_channel_id: channel_to_update.1,
710 base_msat: default_config.forwarding_fee_base_msat,
711 proportional_millionths: default_config.forwarding_fee_proportional_millionths,
713 cltv_expiry_delta: default_config.cltv_expiry_delta,
714 htlc_maximum_msat: None,
715 htlc_minimum_msat: None,
717 let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty, TEST_FINAL_CLTV)
718 .with_bolt11_features(nodes[2].node.invoice_features()).unwrap()
719 .with_route_hints(hop_hints).unwrap();
720 get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT)
722 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
723 payment_hash, payment_secret);
724 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
726 // Closure to force expiry of a channel's previous config.
727 let expire_prev_config = || {
728 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
729 nodes[1].node.timer_tick_occurred();
733 // Closure to update and retrieve the latest ChannelUpdate.
734 let update_and_get_channel_update = |config: &ChannelConfig, expect_new_update: bool,
735 prev_update: Option<&msgs::ChannelUpdate>, should_expire_prev_config: bool| -> Option<msgs::ChannelUpdate> {
736 nodes[1].node.update_channel_config(
737 channel_to_update_counterparty, &[channel_to_update.0], config,
739 let events = nodes[1].node.get_and_clear_pending_msg_events();
740 assert_eq!(events.len(), expect_new_update as usize);
741 if !expect_new_update {
744 let new_update = match &events[0] {
745 MessageSendEvent::BroadcastChannelUpdate { msg } => {
746 assert!(announced_channel);
749 MessageSendEvent::SendChannelUpdate { node_id, msg } => {
750 assert_eq!(node_id, channel_to_update_counterparty);
751 assert!(!announced_channel);
754 _ => panic!("expected Broadcast/SendChannelUpdate event"),
756 if prev_update.is_some() {
757 assert!(new_update.contents.timestamp > prev_update.unwrap().contents.timestamp)
759 if should_expire_prev_config {
760 expire_prev_config();
765 // We'll be attempting to route payments using the default ChannelUpdate for channels. This will
766 // lead to onion failures at the first hop once we update the ChannelConfig for the
768 let expect_onion_failure = |name: &str, error_code: u16, channel_update: &msgs::ChannelUpdate| {
769 let short_channel_id = channel_to_update.1;
770 let network_update = NetworkUpdate::ChannelUpdateMessage { msg: channel_update.clone() };
771 run_onion_failure_test(
772 name, 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {}, true,
773 Some(error_code), Some(network_update), Some(short_channel_id),
777 // Updates to cltv_expiry_delta below MIN_CLTV_EXPIRY_DELTA should fail with APIMisuseError.
778 let mut invalid_config = default_config.clone();
779 invalid_config.cltv_expiry_delta = 0;
780 match nodes[1].node.update_channel_config(
781 channel_to_update_counterparty, &[channel_to_update.0], &invalid_config,
783 Err(APIError::APIMisuseError{ .. }) => {},
784 _ => panic!("unexpected result applying invalid cltv_expiry_delta"),
787 // Increase the base fee which should trigger a new ChannelUpdate.
788 let mut config = nodes[1].node.list_usable_channels().iter()
789 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
791 config.forwarding_fee_base_msat = u32::max_value();
792 let msg = update_and_get_channel_update(&config, true, None, false).unwrap();
794 // The old policy should still be in effect until a new block is connected.
795 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
796 payment_hash, payment_secret);
797 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
799 // Connect a block, which should expire the previous config, leading to a failure when
800 // forwarding the HTLC.
801 expire_prev_config();
802 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
804 // Redundant updates should not trigger a new ChannelUpdate.
805 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
807 // Similarly, updates that do not have an affect on ChannelUpdate should not trigger a new one.
808 config.force_close_avoidance_max_fee_satoshis *= 2;
809 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
811 // Reset the base fee to the default and increase the proportional fee which should trigger a
812 // new ChannelUpdate.
813 config.forwarding_fee_base_msat = default_config.forwarding_fee_base_msat;
814 config.cltv_expiry_delta = u16::max_value();
815 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
816 expect_onion_failure("incorrect_cltv_expiry", UPDATE|13, &msg);
818 // Reset the proportional fee and increase the CLTV expiry delta which should trigger a new
820 config.cltv_expiry_delta = default_config.cltv_expiry_delta;
821 config.forwarding_fee_proportional_millionths = u32::max_value();
822 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
823 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
825 // To test persistence of the updated config, we'll re-initialize the ChannelManager.
826 let config_after_restart = {
827 let chan_1_monitor_serialized = get_monitor!(nodes[1], other_channel.3).encode();
828 let chan_2_monitor_serialized = get_monitor!(nodes[1], channel_to_update.0).encode();
829 reload_node!(nodes[1], *nodes[1].node.get_current_default_configuration(), &nodes[1].node.encode(),
830 &[&chan_1_monitor_serialized, &chan_2_monitor_serialized], persister, chain_monitor, channel_manager_1_deserialized);
831 nodes[1].node.list_channels().iter()
832 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
835 assert_eq!(config, config_after_restart);
839 fn test_onion_failure_stale_channel_update() {
840 do_test_onion_failure_stale_channel_update(false);
841 do_test_onion_failure_stale_channel_update(true);
845 fn test_always_create_tlv_format_onion_payloads() {
846 // Verify that we always generate tlv onion format payloads, even if the features specifically
847 // specifies no support for variable length onions, as the legacy payload format has been
848 // deprecated in BOLT4.
849 let chanmon_cfgs = create_chanmon_cfgs(3);
850 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
852 // Set `node[1]`'s init features to features which return `false` for
853 // `supports_variable_length_onion()`
854 let mut no_variable_length_onion_features = InitFeatures::empty();
855 no_variable_length_onion_features.set_static_remote_key_required();
856 *node_cfgs[1].override_init_features.borrow_mut() = Some(no_variable_length_onion_features);
858 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
859 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
861 create_announced_chan_between_nodes(&nodes, 0, 1);
862 create_announced_chan_between_nodes(&nodes, 1, 2);
864 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
865 .with_bolt11_features(Bolt11InvoiceFeatures::empty()).unwrap();
866 let (route, _payment_hash, _payment_preimage, _payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, 40000);
868 let hops = &route.paths[0].hops;
869 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
870 assert!(!hops[0].node_features.supports_variable_length_onion());
871 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
872 assert!(!hops[1].node_features.supports_variable_length_onion());
874 let cur_height = nodes[0].best_block_info().1 + 1;
875 let (onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
876 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
878 match onion_payloads[0] {
879 msgs::OutboundOnionPayload::Forward {..} => {},
881 "Should have generated a `msgs::OnionHopDataFormat::NonFinalNode` payload for `hops[0]`,
882 despite that the features signals no support for variable length onions"
885 match onion_payloads[1] {
886 msgs::OutboundOnionPayload::Receive {..} => {},
888 "Should have generated a `msgs::OnionHopDataFormat::FinalNode` payload for `hops[1]`,
889 despite that the features signals no support for variable length onions"
894 fn do_test_fail_htlc_backwards_with_reason(failure_code: FailureCode) {
896 let chanmon_cfgs = create_chanmon_cfgs(2);
897 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
898 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
899 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
901 create_announced_chan_between_nodes(&nodes, 0, 1);
903 let payment_amount = 100_000;
904 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_amount);
905 nodes[0].node.send_payment_with_route(&route, payment_hash,
906 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
907 check_added_monitors!(nodes[0], 1);
909 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
910 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
911 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
912 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
914 expect_pending_htlcs_forwardable!(nodes[1]);
915 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, payment_amount);
916 nodes[1].node.fail_htlc_backwards_with_reason(&payment_hash, failure_code);
918 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash }]);
919 check_added_monitors!(nodes[1], 1);
921 let events = nodes[1].node.get_and_clear_pending_msg_events();
922 assert_eq!(events.len(), 1);
923 let (update_fail_htlc, commitment_signed) = match events[0] {
924 MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
925 assert!(update_add_htlcs.is_empty());
926 assert!(update_fulfill_htlcs.is_empty());
927 assert_eq!(update_fail_htlcs.len(), 1);
928 assert!(update_fail_malformed_htlcs.is_empty());
929 assert!(update_fee.is_none());
930 (update_fail_htlcs[0].clone(), commitment_signed)
932 _ => panic!("Unexpected event"),
935 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
936 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
938 let failure_data = match failure_code {
939 FailureCode::TemporaryNodeFailure => vec![],
940 FailureCode::RequiredNodeFeatureMissing => vec![],
941 FailureCode::IncorrectOrUnknownPaymentDetails => {
942 let mut htlc_msat_height_data = (payment_amount as u64).to_be_bytes().to_vec();
943 htlc_msat_height_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes());
944 htlc_msat_height_data
946 FailureCode::InvalidOnionPayload(data) => {
948 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
954 let failure_code = failure_code.into();
955 let permanent_flag = 0x4000;
956 let permanent_fail = (failure_code & permanent_flag) != 0;
957 expect_payment_failed!(nodes[0], payment_hash, permanent_fail, failure_code, failure_data);
962 fn test_fail_htlc_backwards_with_reason() {
963 do_test_fail_htlc_backwards_with_reason(FailureCode::TemporaryNodeFailure);
964 do_test_fail_htlc_backwards_with_reason(FailureCode::RequiredNodeFeatureMissing);
965 do_test_fail_htlc_backwards_with_reason(FailureCode::IncorrectOrUnknownPaymentDetails);
966 do_test_fail_htlc_backwards_with_reason(FailureCode::InvalidOnionPayload(Some((1 << 16, 42))));
967 do_test_fail_htlc_backwards_with_reason(FailureCode::InvalidOnionPayload(None));
970 macro_rules! get_phantom_route {
971 ($nodes: expr, $amt: expr, $channel: expr) => {{
972 let phantom_pubkey = $nodes[1].keys_manager.get_node_id(Recipient::PhantomNode).unwrap();
973 let phantom_route_hint = $nodes[1].node.get_phantom_route_hints();
974 let payment_params = PaymentParameters::from_node_id(phantom_pubkey, TEST_FINAL_CLTV)
975 .with_bolt11_features($nodes[1].node.invoice_features()).unwrap()
976 .with_route_hints(vec![RouteHint(vec![
978 src_node_id: $nodes[0].node.get_our_node_id(),
979 short_channel_id: $channel.0.contents.short_channel_id,
981 base_msat: $channel.0.contents.fee_base_msat,
982 proportional_millionths: $channel.0.contents.fee_proportional_millionths,
984 cltv_expiry_delta: $channel.0.contents.cltv_expiry_delta,
985 htlc_minimum_msat: None,
986 htlc_maximum_msat: None,
989 src_node_id: phantom_route_hint.real_node_pubkey,
990 short_channel_id: phantom_route_hint.phantom_scid,
993 proportional_millionths: 0,
995 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
996 htlc_minimum_msat: None,
997 htlc_maximum_msat: None,
1000 let scorer = test_utils::TestScorer::new();
1001 let network_graph = $nodes[0].network_graph.read_only();
1003 &$nodes[0].node.get_our_node_id(), &payment_params, &network_graph,
1004 Some(&$nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
1005 $amt, $nodes[0].logger, &scorer, &(), &[0u8; 32]
1006 ).unwrap(), phantom_route_hint.phantom_scid)
1011 fn test_phantom_onion_hmac_failure() {
1012 let chanmon_cfgs = create_chanmon_cfgs(2);
1013 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1014 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1015 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1017 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1020 let recv_value_msat = 10_000;
1021 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1022 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1024 // Route the HTLC through to the destination.
1025 nodes[0].node.send_payment_with_route(&route, payment_hash,
1026 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1027 check_added_monitors!(nodes[0], 1);
1028 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1029 let mut update_add = update_0.update_add_htlcs[0].clone();
1031 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1032 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1034 // Modify the payload so the phantom hop's HMAC is bogus.
1035 let sha256_of_onion = {
1036 let mut forward_htlcs = nodes[1].node.forward_htlcs.lock().unwrap();
1037 let mut pending_forward = forward_htlcs.get_mut(&phantom_scid).unwrap();
1038 match pending_forward[0] {
1039 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1040 forward_info: PendingHTLCInfo {
1041 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1045 onion_packet.hmac[onion_packet.hmac.len() - 1] ^= 1;
1046 Sha256::hash(&onion_packet.hop_data).into_inner().to_vec()
1048 _ => panic!("Unexpected forward"),
1051 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1052 nodes[1].node.process_pending_htlc_forwards();
1053 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1054 nodes[1].node.process_pending_htlc_forwards();
1055 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1056 check_added_monitors!(&nodes[1], 1);
1057 assert!(update_1.update_fail_htlcs.len() == 1);
1058 let fail_msg = update_1.update_fail_htlcs[0].clone();
1059 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1060 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1062 // Ensure the payment fails with the expected error.
1063 let mut fail_conditions = PaymentFailedConditions::new()
1064 .blamed_scid(phantom_scid)
1065 .blamed_chan_closed(true)
1066 .expected_htlc_error_data(0x8000 | 0x4000 | 5, &sha256_of_onion);
1067 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1071 fn test_phantom_invalid_onion_payload() {
1072 let chanmon_cfgs = create_chanmon_cfgs(2);
1073 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1074 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1075 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1077 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1080 let recv_value_msat = 10_000;
1081 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1082 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1084 // We'll use the session priv later when constructing an invalid onion packet.
1085 let session_priv = [3; 32];
1086 *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
1087 nodes[0].node.send_payment_with_route(&route, payment_hash,
1088 RecipientOnionFields::secret_only(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();
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);
1096 // Modify the onion packet to have an invalid payment amount.
1097 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1098 for f in pending_forwards.iter_mut() {
1100 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1101 forward_info: PendingHTLCInfo {
1102 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1106 // Construct the onion payloads for the entire route and an invalid amount.
1107 let height = nodes[0].best_block_info().1;
1108 let session_priv = SecretKey::from_slice(&session_priv).unwrap();
1109 let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
1110 let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(
1111 &route.paths[0], msgs::MAX_VALUE_MSAT + 1,
1112 RecipientOnionFields::secret_only(payment_secret), height + 1, &None).unwrap();
1113 // We only want to construct the onion packet for the last hop, not the entire route, so
1114 // remove the first hop's payload and its keys.
1115 onion_keys.remove(0);
1116 onion_payloads.remove(0);
1118 let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
1119 onion_packet.hop_data = new_onion_packet.hop_data;
1120 onion_packet.hmac = new_onion_packet.hmac;
1122 _ => panic!("Unexpected forward"),
1126 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1127 nodes[1].node.process_pending_htlc_forwards();
1128 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1129 nodes[1].node.process_pending_htlc_forwards();
1130 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1131 check_added_monitors!(&nodes[1], 1);
1132 assert!(update_1.update_fail_htlcs.len() == 1);
1133 let fail_msg = update_1.update_fail_htlcs[0].clone();
1134 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1135 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1137 // Ensure the payment fails with the expected error.
1138 let error_data = Vec::new();
1139 let mut fail_conditions = PaymentFailedConditions::new()
1140 .blamed_scid(phantom_scid)
1141 .blamed_chan_closed(true)
1142 .expected_htlc_error_data(0x4000 | 22, &error_data);
1143 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1147 fn test_phantom_final_incorrect_cltv_expiry() {
1148 let chanmon_cfgs = create_chanmon_cfgs(2);
1149 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1150 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1151 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1153 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1156 let recv_value_msat = 10_000;
1157 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1158 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1160 // Route the HTLC through to the destination.
1161 nodes[0].node.send_payment_with_route(&route, payment_hash,
1162 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1163 check_added_monitors!(nodes[0], 1);
1164 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1165 let mut update_add = update_0.update_add_htlcs[0].clone();
1167 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1168 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1170 // Modify the payload so the phantom hop's HMAC is bogus.
1171 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1172 for f in pending_forwards.iter_mut() {
1174 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1175 forward_info: PendingHTLCInfo { ref mut outgoing_cltv_value, .. }, ..
1177 *outgoing_cltv_value -= 1;
1179 _ => panic!("Unexpected forward"),
1183 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1184 nodes[1].node.process_pending_htlc_forwards();
1185 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1186 nodes[1].node.process_pending_htlc_forwards();
1187 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1188 check_added_monitors!(&nodes[1], 1);
1189 assert!(update_1.update_fail_htlcs.len() == 1);
1190 let fail_msg = update_1.update_fail_htlcs[0].clone();
1191 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1192 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1194 // Ensure the payment fails with the expected error.
1195 let expected_cltv: u32 = 80;
1196 let error_data = expected_cltv.to_be_bytes().to_vec();
1197 let mut fail_conditions = PaymentFailedConditions::new()
1198 .blamed_scid(phantom_scid)
1199 .expected_htlc_error_data(18, &error_data);
1200 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1204 fn test_phantom_failure_too_low_cltv() {
1205 let chanmon_cfgs = create_chanmon_cfgs(2);
1206 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1207 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1208 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1210 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1213 let recv_value_msat = 10_000;
1214 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1215 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1217 // Modify the route to have a too-low cltv.
1218 route.paths[0].hops[1].cltv_expiry_delta = 5;
1220 // Route the HTLC through to the destination.
1221 nodes[0].node.send_payment_with_route(&route, payment_hash,
1222 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1223 check_added_monitors!(nodes[0], 1);
1224 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1225 let mut update_add = update_0.update_add_htlcs[0].clone();
1227 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1228 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1230 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1231 nodes[1].node.process_pending_htlc_forwards();
1232 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1233 nodes[1].node.process_pending_htlc_forwards();
1234 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1235 check_added_monitors!(&nodes[1], 1);
1236 assert!(update_1.update_fail_htlcs.len() == 1);
1237 let fail_msg = update_1.update_fail_htlcs[0].clone();
1238 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1239 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1241 // Ensure the payment fails with the expected error.
1242 let mut error_data = recv_value_msat.to_be_bytes().to_vec();
1243 error_data.extend_from_slice(
1244 &nodes[0].node.best_block.read().unwrap().height().to_be_bytes(),
1246 let mut fail_conditions = PaymentFailedConditions::new()
1247 .blamed_scid(phantom_scid)
1248 .expected_htlc_error_data(0x4000 | 15, &error_data);
1249 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1253 fn test_phantom_failure_modified_cltv() {
1254 // Test that we fail back phantoms if the upstream node fiddled with the CLTV too much with the
1255 // correct error code.
1256 let chanmon_cfgs = create_chanmon_cfgs(2);
1257 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1258 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1259 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1261 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1264 let recv_value_msat = 10_000;
1265 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1266 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1268 // Route the HTLC through to the destination.
1269 nodes[0].node.send_payment_with_route(&route, payment_hash,
1270 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1271 check_added_monitors!(nodes[0], 1);
1272 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1273 let mut update_add = update_0.update_add_htlcs[0].clone();
1275 // Modify the route to have a too-low cltv.
1276 update_add.cltv_expiry -= 10;
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);
1281 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1282 assert!(update_1.update_fail_htlcs.len() == 1);
1283 let fail_msg = update_1.update_fail_htlcs[0].clone();
1284 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1285 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1287 // Ensure the payment fails with the expected error.
1288 let mut fail_conditions = PaymentFailedConditions::new()
1289 .blamed_scid(phantom_scid)
1290 .expected_htlc_error_data(0x2000 | 2, &[]);
1291 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1295 fn test_phantom_failure_expires_too_soon() {
1296 // Test that we fail back phantoms if the HTLC got delayed and we got blocks in between with
1297 // the correct error code.
1298 let chanmon_cfgs = create_chanmon_cfgs(2);
1299 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1300 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1301 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1303 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1306 let recv_value_msat = 10_000;
1307 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1308 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1310 // Route the HTLC through to the destination.
1311 nodes[0].node.send_payment_with_route(&route, payment_hash,
1312 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1313 check_added_monitors!(nodes[0], 1);
1314 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1315 let mut update_add = update_0.update_add_htlcs[0].clone();
1317 connect_blocks(&nodes[1], CLTV_FAR_FAR_AWAY);
1318 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1319 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1321 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1322 assert!(update_1.update_fail_htlcs.len() == 1);
1323 let fail_msg = update_1.update_fail_htlcs[0].clone();
1324 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1325 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1327 // Ensure the payment fails with the expected error.
1328 let mut fail_conditions = PaymentFailedConditions::new()
1329 .blamed_scid(phantom_scid)
1330 .expected_htlc_error_data(0x2000 | 2, &[]);
1331 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1335 fn test_phantom_failure_too_low_recv_amt() {
1336 let chanmon_cfgs = create_chanmon_cfgs(2);
1337 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1338 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1339 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1341 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1343 // Get the route with a too-low amount.
1344 let recv_amt_msat = 10_000;
1345 let bad_recv_amt_msat = recv_amt_msat - 10;
1346 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1347 let (mut route, phantom_scid) = get_phantom_route!(nodes, bad_recv_amt_msat, channel);
1349 // Route the HTLC through to the destination.
1350 nodes[0].node.send_payment_with_route(&route, payment_hash,
1351 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1352 check_added_monitors!(nodes[0], 1);
1353 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1354 let mut update_add = update_0.update_add_htlcs[0].clone();
1356 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1357 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1359 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1360 nodes[1].node.process_pending_htlc_forwards();
1361 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1362 nodes[1].node.process_pending_htlc_forwards();
1363 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
1364 nodes[1].node.process_pending_htlc_forwards();
1365 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1366 check_added_monitors!(&nodes[1], 1);
1367 assert!(update_1.update_fail_htlcs.len() == 1);
1368 let fail_msg = update_1.update_fail_htlcs[0].clone();
1369 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1370 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1372 // Ensure the payment fails with the expected error.
1373 let mut error_data = bad_recv_amt_msat.to_be_bytes().to_vec();
1374 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1375 let mut fail_conditions = PaymentFailedConditions::new()
1376 .blamed_scid(phantom_scid)
1377 .expected_htlc_error_data(0x4000 | 15, &error_data);
1378 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1382 fn test_phantom_dust_exposure_failure() {
1383 do_test_phantom_dust_exposure_failure(false);
1384 do_test_phantom_dust_exposure_failure(true);
1387 fn do_test_phantom_dust_exposure_failure(multiplier_dust_limit: bool) {
1388 // Set the max dust exposure to the dust limit.
1389 let max_dust_exposure = 546;
1390 let mut receiver_config = UserConfig::default();
1391 // Default test fee estimator rate is 253, so to set the max dust exposure to the dust limit,
1392 // we need to set the multiplier to 2.
1393 receiver_config.channel_config.max_dust_htlc_exposure =
1394 if multiplier_dust_limit { MaxDustHTLCExposure::FeeRateMultiplier(2) }
1395 else { MaxDustHTLCExposure::FixedLimitMsat(max_dust_exposure) };
1396 receiver_config.channel_handshake_config.announced_channel = true;
1398 let chanmon_cfgs = create_chanmon_cfgs(2);
1399 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1400 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(receiver_config)]);
1401 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1403 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1405 // Get the route with an amount exceeding the dust exposure threshold of nodes[1].
1406 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(max_dust_exposure + 1));
1407 let (mut route, _) = get_phantom_route!(nodes, max_dust_exposure + 1, channel);
1409 // Route the HTLC through to the destination.
1410 nodes[0].node.send_payment_with_route(&route, payment_hash,
1411 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1412 check_added_monitors!(nodes[0], 1);
1413 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1414 let mut update_add = update_0.update_add_htlcs[0].clone();
1416 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1417 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1419 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1420 assert!(update_1.update_fail_htlcs.len() == 1);
1421 let fail_msg = update_1.update_fail_htlcs[0].clone();
1422 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1423 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1425 // Ensure the payment fails with the expected error.
1426 let mut err_data = Vec::new();
1427 err_data.extend_from_slice(&(channel.1.serialized_length() as u16 + 2).to_be_bytes());
1428 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
1429 err_data.extend_from_slice(&channel.1.encode());
1431 let mut fail_conditions = PaymentFailedConditions::new()
1432 .blamed_scid(channel.0.contents.short_channel_id)
1433 .blamed_chan_closed(false)
1434 .expected_htlc_error_data(0x1000 | 7, &err_data);
1435 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1439 fn test_phantom_failure_reject_payment() {
1440 // Test that the user can successfully fail back a phantom node payment.
1441 let chanmon_cfgs = create_chanmon_cfgs(2);
1442 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1443 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1444 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1446 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1448 // Get the route with a too-low amount.
1449 let recv_amt_msat = 10_000;
1450 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1451 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_amt_msat, channel);
1453 // Route the HTLC through to the destination.
1454 nodes[0].node.send_payment_with_route(&route, payment_hash,
1455 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1456 check_added_monitors!(nodes[0], 1);
1457 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1458 let mut update_add = update_0.update_add_htlcs[0].clone();
1460 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1461 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1463 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1464 nodes[1].node.process_pending_htlc_forwards();
1465 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1466 nodes[1].node.process_pending_htlc_forwards();
1467 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, recv_amt_msat, None, route.paths[0].hops.last().unwrap().pubkey);
1468 nodes[1].node.fail_htlc_backwards(&payment_hash);
1469 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1470 nodes[1].node.process_pending_htlc_forwards();
1472 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1473 check_added_monitors!(&nodes[1], 1);
1474 assert!(update_1.update_fail_htlcs.len() == 1);
1475 let fail_msg = update_1.update_fail_htlcs[0].clone();
1476 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1477 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1479 // Ensure the payment fails with the expected error.
1480 let mut error_data = recv_amt_msat.to_be_bytes().to_vec();
1481 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1482 let mut fail_conditions = PaymentFailedConditions::new()
1483 .blamed_scid(phantom_scid)
1484 .expected_htlc_error_data(0x4000 | 15, &error_data);
1485 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);