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, RouteParameters, 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, HashEngine};
35 use bitcoin::hashes::hmac::{Hmac, HmacEngine};
36 use bitcoin::hashes::sha256::Hash as Sha256;
38 use bitcoin::secp256k1;
39 use bitcoin::secp256k1::{Secp256k1, SecretKey};
42 use crate::prelude::*;
43 use core::default::Default;
45 use crate::ln::functional_test_utils::*;
47 fn run_onion_failure_test<F1,F2>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, payment_secret: &PaymentSecret, callback_msg: F1, callback_node: F2, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<NetworkUpdate>, expected_short_channel_id: Option<u64>)
48 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
51 run_onion_failure_test_with_fail_intercept(_name, test_case, nodes, route, payment_hash, payment_secret, callback_msg, |_|{}, callback_node, expected_retryable, expected_error_code, expected_channel_update, expected_short_channel_id);
55 // 0: node1 fails backward
56 // 1: final node fails backward
57 // 2: payment completed but the user rejects the payment
58 // 3: final node fails backward (but tamper onion payloads from node0)
59 // 100: trigger error in the intermediate node and tamper returning fail_htlc
60 // 200: trigger error in the final node and tamper returning fail_htlc
61 fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(
62 _name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash,
63 payment_secret: &PaymentSecret, mut callback_msg: F1, mut callback_fail: F2,
64 mut callback_node: F3, expected_retryable: bool, expected_error_code: Option<u16>,
65 expected_channel_update: Option<NetworkUpdate>, expected_short_channel_id: Option<u64>
67 where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
68 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
71 macro_rules! expect_event {
72 ($node: expr, $event_type: path) => {{
73 let events = $node.node.get_and_clear_pending_events();
74 assert_eq!(events.len(), 1);
76 $event_type { .. } => {},
77 _ => panic!("Unexpected event"),
82 macro_rules! expect_htlc_forward {
84 expect_event!($node, Event::PendingHTLCsForwardable);
85 $node.node.process_pending_htlc_forwards();
89 // 0 ~~> 2 send payment
90 let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
91 nodes[0].node.send_payment_with_route(&route, *payment_hash,
92 RecipientOnionFields::secret_only(*payment_secret), payment_id).unwrap();
93 check_added_monitors!(nodes[0], 1);
94 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
95 // temper update_add (0 => 1)
96 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
97 if test_case == 0 || test_case == 3 || test_case == 100 {
98 callback_msg(&mut update_add_0);
101 // 0 => 1 update_add & CS
102 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
103 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
105 let update_1_0 = match test_case {
106 0|100 => { // intermediate node failure; fail backward to 0
107 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
108 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));
111 1|2|3|200 => { // final node failure; forwarding to 2
112 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
114 if test_case != 200 {
117 expect_htlc_forward!(&nodes[1]);
119 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
120 check_added_monitors!(&nodes[1], 1);
121 assert_eq!(update_1.update_add_htlcs.len(), 1);
122 // tamper update_add (1 => 2)
123 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
124 if test_case != 3 && test_case != 200 {
125 callback_msg(&mut update_add_1);
129 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
130 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
132 if test_case == 2 || test_case == 200 {
133 expect_htlc_forward!(&nodes[2]);
134 expect_event!(&nodes[2], Event::PaymentClaimable);
136 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
139 let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
140 if test_case == 2 || test_case == 200 {
141 check_added_monitors!(&nodes[2], 1);
143 assert!(update_2_1.update_fail_htlcs.len() == 1);
145 let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
146 if test_case == 200 {
147 callback_fail(&mut fail_msg);
151 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
152 commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
154 // backward fail on 1
155 let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
156 assert!(update_1_0.update_fail_htlcs.len() == 1);
162 // 1 => 0 commitment_signed_dance
163 if update_1_0.update_fail_htlcs.len() > 0 {
164 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
165 if test_case == 100 {
166 callback_fail(&mut fail_msg);
168 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
170 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
173 commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
175 let events = nodes[0].node.get_and_clear_pending_events();
176 assert_eq!(events.len(), 2);
177 if let &Event::PaymentPathFailed { ref payment_failed_permanently, ref short_channel_id, ref error_code, failure: PathFailure::OnPath { ref network_update }, .. } = &events[0] {
178 assert_eq!(*payment_failed_permanently, !expected_retryable);
179 assert_eq!(*error_code, expected_error_code);
180 if expected_channel_update.is_some() {
181 match network_update {
182 Some(update) => match update {
183 &NetworkUpdate::ChannelUpdateMessage { .. } => {
184 if let NetworkUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
185 panic!("channel_update not found!");
188 &NetworkUpdate::ChannelFailure { ref short_channel_id, ref is_permanent } => {
189 if let NetworkUpdate::ChannelFailure { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
190 assert!(*short_channel_id == *expected_short_channel_id);
191 assert!(*is_permanent == *expected_is_permanent);
193 panic!("Unexpected message event");
196 &NetworkUpdate::NodeFailure { ref node_id, ref is_permanent } => {
197 if let NetworkUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
198 assert!(*node_id == *expected_node_id);
199 assert!(*is_permanent == *expected_is_permanent);
201 panic!("Unexpected message event");
205 None => panic!("Expected channel update"),
208 assert!(network_update.is_none());
210 if let Some(expected_short_channel_id) = expected_short_channel_id {
211 match short_channel_id {
212 Some(short_channel_id) => assert_eq!(*short_channel_id, expected_short_channel_id),
213 None => panic!("Expected short channel id"),
216 assert!(short_channel_id.is_none());
219 panic!("Unexpected event");
222 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id, reason: ref ev_reason } => {
223 assert_eq!(*payment_hash, ev_payment_hash);
224 assert_eq!(payment_id, ev_payment_id);
225 assert_eq!(if expected_retryable {
226 PaymentFailureReason::RetriesExhausted
228 PaymentFailureReason::RecipientRejected
229 }, ev_reason.unwrap());
231 _ => panic!("Unexpected second event"),
235 impl msgs::ChannelUpdate {
236 fn dummy(short_channel_id: u64) -> msgs::ChannelUpdate {
237 use bitcoin::secp256k1::ffi::Signature as FFISignature;
238 use bitcoin::secp256k1::ecdsa::Signature;
239 msgs::ChannelUpdate {
240 signature: Signature::from(unsafe { FFISignature::new() }),
241 contents: msgs::UnsignedChannelUpdate {
242 chain_hash: BlockHash::hash(&vec![0u8][..]),
246 cltv_expiry_delta: 0,
247 htlc_minimum_msat: 0,
248 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
250 fee_proportional_millionths: 0,
257 struct BogusOnionHopData {
260 impl BogusOnionHopData {
261 fn new(orig: msgs::OutboundOnionPayload) -> Self {
262 Self { data: orig.encode() }
265 impl Writeable for BogusOnionHopData {
266 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
267 writer.write_all(&self.data[..])
271 const BADONION: u16 = 0x8000;
272 const PERM: u16 = 0x4000;
273 const NODE: u16 = 0x2000;
274 const UPDATE: u16 = 0x1000;
277 fn test_fee_failures() {
278 // Tests that the fee required when forwarding remains consistent over time. This was
279 // previously broken, with forwarding fees floating based on the fee estimator at the time of
282 // When this test was written, the default base fee floated based on the HTLC count.
283 // It is now fixed, so we simply set the fee to the expected value here.
284 let mut config = test_default_channel_config();
285 config.channel_config.forwarding_fee_base_msat = 196;
287 let chanmon_cfgs = create_chanmon_cfgs(3);
288 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
289 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
290 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
291 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
294 let (route, payment_hash_success, payment_preimage_success, payment_secret_success) = get_route_and_payment_hash!(nodes[0], nodes[2], 40_000);
295 nodes[0].node.send_payment_with_route(&route, payment_hash_success,
296 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
297 check_added_monitors!(nodes[0], 1);
298 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
299 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
301 // If the hop gives fee_insufficient but enough fees were provided, then the previous hop
302 // malleated the payment before forwarding, taking funds when they shouldn't have.
303 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
304 let short_channel_id = channels[0].0.contents.short_channel_id;
305 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
306 msg.amount_msat -= 1;
307 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
309 // In an earlier version, we spuriously failed to forward payments if the expected feerate
310 // changed between the channel open and the payment.
312 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
316 let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
317 nodes[0].node.send_payment_with_route(&route, payment_hash_success,
318 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
319 check_added_monitors!(nodes[0], 1);
320 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
321 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
325 fn test_onion_failure() {
326 // When we check for amount_below_minimum below, we want to test that we're using the *right*
327 // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
328 // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
329 // This exposed a previous bug because we were using the wrong value all the way down in
330 // Channel::get_counterparty_htlc_minimum_msat().
331 let mut node_2_cfg: UserConfig = Default::default();
332 node_2_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
333 node_2_cfg.channel_handshake_config.announced_channel = true;
334 node_2_cfg.channel_handshake_limits.force_announced_channel_preference = false;
336 // When this test was written, the default base fee floated based on the HTLC count.
337 // It is now fixed, so we simply set the fee to the expected value here.
338 let mut config = test_default_channel_config();
339 config.channel_config.forwarding_fee_base_msat = 196;
341 let chanmon_cfgs = create_chanmon_cfgs(3);
342 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
343 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
344 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
345 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
346 for node in nodes.iter() {
347 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
349 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
351 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
353 // intermediate node failure
354 let short_channel_id = channels[1].0.contents.short_channel_id;
355 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
356 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
357 let cur_height = nodes[0].best_block_info().1 + 1;
358 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
359 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
360 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
361 let mut new_payloads = Vec::new();
362 for payload in onion_payloads.drain(..) {
363 new_payloads.push(BogusOnionHopData::new(payload));
365 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
366 // describing a length-1 TLV payload, which is obviously bogus.
367 new_payloads[0].data[0] = 1;
368 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
369 }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
371 // final node failure
372 let short_channel_id = channels[1].0.contents.short_channel_id;
373 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
374 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
375 let cur_height = nodes[0].best_block_info().1 + 1;
376 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
377 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
378 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
379 let mut new_payloads = Vec::new();
380 for payload in onion_payloads.drain(..) {
381 new_payloads.push(BogusOnionHopData::new(payload));
383 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
384 // length-1 TLV payload, which is obviously bogus.
385 new_payloads[1].data[0] = 1;
386 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
387 }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
389 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
390 // receiving simulated fail messages
391 // intermediate node failure
392 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
394 msg.amount_msat -= 1;
396 // and tamper returning error message
397 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
398 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
399 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), NODE|2, &[0;0]);
400 }, ||{}, 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));
402 // final node failure
403 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
404 // and tamper returning error message
405 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
406 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
407 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), NODE|2, &[0;0]);
409 nodes[2].node.fail_htlc_backwards(&payment_hash);
410 }, 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));
411 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
413 // intermediate node failure
414 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
415 msg.amount_msat -= 1;
417 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
418 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
419 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
420 }, ||{}, 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));
422 // final node failure
423 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
424 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
425 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
426 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
428 nodes[2].node.fail_htlc_backwards(&payment_hash);
429 }, 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));
430 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
432 // intermediate node failure
433 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
434 msg.amount_msat -= 1;
436 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
437 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
438 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
440 nodes[2].node.fail_htlc_backwards(&payment_hash);
441 }, 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));
443 // final node failure
444 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
445 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
446 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
447 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
449 nodes[2].node.fail_htlc_backwards(&payment_hash);
450 }, 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));
451 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
453 // Our immediate peer sent UpdateFailMalformedHTLC because it couldn't understand the onion in
454 // the UpdateAddHTLC that we sent.
455 let short_channel_id = channels[0].0.contents.short_channel_id;
456 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
457 Some(BADONION|PERM|4), None, Some(short_channel_id));
459 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
460 Some(BADONION|PERM|5), None, Some(short_channel_id));
462 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,
463 Some(BADONION|PERM|6), None, Some(short_channel_id));
465 let short_channel_id = channels[1].0.contents.short_channel_id;
466 let chan_update = ChannelUpdate::dummy(short_channel_id);
468 let mut err_data = Vec::new();
469 err_data.extend_from_slice(&(chan_update.serialized_length() as u16 + 2).to_be_bytes());
470 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
471 err_data.extend_from_slice(&chan_update.encode());
472 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
473 msg.amount_msat -= 1;
475 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
476 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
477 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data);
478 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update.clone()}), Some(short_channel_id));
480 // Check we can still handle onion failures that include channel updates without a type prefix
481 let err_data_without_type = chan_update.encode_with_len();
482 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
483 msg.amount_msat -= 1;
485 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
486 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
487 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data_without_type);
488 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update}), Some(short_channel_id));
490 let short_channel_id = channels[1].0.contents.short_channel_id;
491 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
492 msg.amount_msat -= 1;
494 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
495 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
496 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|8, &[0;0]);
497 // short_channel_id from the processing node
498 }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
500 let short_channel_id = channels[1].0.contents.short_channel_id;
501 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
502 msg.amount_msat -= 1;
504 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
505 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
506 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|9, &[0;0]);
507 // short_channel_id from the processing node
508 }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
510 let mut bogus_route = route.clone();
511 bogus_route.paths[0].hops[1].short_channel_id -= 1;
512 let short_channel_id = bogus_route.paths[0].hops[1].short_channel_id;
513 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
514 Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent:true}), Some(short_channel_id));
516 let short_channel_id = channels[1].0.contents.short_channel_id;
517 let amt_to_forward = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[2].node.get_our_node_id())
518 .unwrap().lock().unwrap().channel_by_id.get(&channels[1].2).unwrap()
519 .context().get_counterparty_htlc_minimum_msat() - 1;
520 let mut bogus_route = route.clone();
521 let route_len = bogus_route.paths[0].hops.len();
522 bogus_route.paths[0].hops[route_len-1].fee_msat = amt_to_forward;
523 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));
525 // Clear pending payments so that the following positive test has the correct payment hash.
526 for node in nodes.iter() {
527 node.node.clear_pending_payments();
530 // Test a positive test-case with one extra msat, meeting the minimum.
531 bogus_route.paths[0].hops[route_len-1].fee_msat = amt_to_forward + 1;
532 let preimage = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1).0;
533 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
535 let short_channel_id = channels[0].0.contents.short_channel_id;
536 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
537 msg.amount_msat -= 1;
538 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
540 let short_channel_id = channels[0].0.contents.short_channel_id;
541 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
542 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
543 msg.cltv_expiry -= 1;
544 }, || {}, true, Some(UPDATE|13), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
546 let short_channel_id = channels[1].0.contents.short_channel_id;
547 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
548 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
549 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
550 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
551 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
552 }, ||{}, true, Some(UPDATE|14), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
554 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
555 nodes[2].node.fail_htlc_backwards(&payment_hash);
556 }, false, Some(PERM|15), None, None);
557 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
559 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
560 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
561 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
562 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
563 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
564 }, || {}, false, Some(0x4000 | 15), None, None);
566 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
567 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
568 for f in pending_forwards.iter_mut() {
570 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
571 forward_info.outgoing_cltv_value -= 1,
576 }, true, Some(18), None, Some(channels[1].0.contents.short_channel_id));
578 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
579 // violate amt_to_forward > msg.amount_msat
580 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
581 for f in pending_forwards.iter_mut() {
583 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
584 forward_info.outgoing_amt_msat -= 1,
589 }, true, Some(19), None, Some(channels[1].0.contents.short_channel_id));
591 let short_channel_id = channels[1].0.contents.short_channel_id;
592 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
593 // disconnect event to the channel between nodes[1] ~ nodes[2]
594 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
595 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
596 }, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
597 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
598 // disconnect event to the channel between nodes[1] ~ nodes[2]
599 for _ in 0..DISABLE_GOSSIP_TICKS + 1 {
600 nodes[1].node.timer_tick_occurred();
601 nodes[2].node.timer_tick_occurred();
603 nodes[1].node.get_and_clear_pending_msg_events();
604 nodes[2].node.get_and_clear_pending_msg_events();
605 }, true, Some(UPDATE|20), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
606 reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[2]));
608 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
609 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
610 let mut route = route.clone();
611 let height = nodes[2].best_block_info().1;
612 route.paths[0].hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0].hops[0].cltv_expiry_delta + 1;
613 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
614 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(
615 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), height, &None).unwrap();
616 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
617 msg.cltv_expiry = htlc_cltv;
618 msg.onion_routing_packet = onion_packet;
619 }, ||{}, 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));
621 run_onion_failure_test_with_fail_intercept("mpp_timeout", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
622 // Tamper returning error message
623 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
624 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
625 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), 23, &[0;0]);
627 nodes[2].node.fail_htlc_backwards(&payment_hash);
628 }, true, Some(23), None, None);
630 run_onion_failure_test_with_fail_intercept("bogus err packet with valid hmac", 200, &nodes,
631 &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
632 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
633 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
634 let mut decoded_err_packet = msgs::DecodedOnionErrorPacket {
639 let um = onion_utils::gen_um_from_shared_secret(&onion_keys[1].shared_secret.as_ref());
640 let mut hmac = HmacEngine::<Sha256>::new(&um);
641 hmac.input(&decoded_err_packet.encode()[32..]);
642 decoded_err_packet.hmac = Hmac::from_engine(hmac).into_inner();
643 msg.reason = onion_utils::encrypt_failure_packet(
644 &onion_keys[1].shared_secret.as_ref(), &decoded_err_packet.encode()[..])
645 }, || nodes[2].node.fail_htlc_backwards(&payment_hash), false, None,
646 Some(NetworkUpdate::NodeFailure { node_id: route.paths[0].hops[1].pubkey, is_permanent: true }),
647 Some(channels[1].0.contents.short_channel_id));
648 run_onion_failure_test_with_fail_intercept("0-length channel update in UPDATE onion failure", 200, &nodes,
649 &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
650 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
651 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
652 let mut decoded_err_packet = msgs::DecodedOnionErrorPacket {
654 0x10, 0x7, // UPDATE|7
655 0x0, 0x0 // 0-len channel update
657 pad: vec![0; 255 - 4 /* 4-byte error message */],
660 let um = onion_utils::gen_um_from_shared_secret(&onion_keys[1].shared_secret.as_ref());
661 let mut hmac = HmacEngine::<Sha256>::new(&um);
662 hmac.input(&decoded_err_packet.encode()[32..]);
663 decoded_err_packet.hmac = Hmac::from_engine(hmac).into_inner();
664 msg.reason = onion_utils::encrypt_failure_packet(
665 &onion_keys[1].shared_secret.as_ref(), &decoded_err_packet.encode()[..])
666 }, || nodes[2].node.fail_htlc_backwards(&payment_hash), true, Some(0x1000|7),
667 Some(NetworkUpdate::ChannelFailure {
668 short_channel_id: channels[1].0.contents.short_channel_id,
671 Some(channels[1].0.contents.short_channel_id));
675 fn test_overshoot_final_cltv() {
676 let chanmon_cfgs = create_chanmon_cfgs(3);
677 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
678 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None; 3]);
679 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
680 create_announced_chan_between_nodes(&nodes, 0, 1);
681 create_announced_chan_between_nodes(&nodes, 1, 2);
682 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
684 let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
685 nodes[0].node.send_payment_with_route(&route, payment_hash, RecipientOnionFields::secret_only(payment_secret), payment_id).unwrap();
687 check_added_monitors!(nodes[0], 1);
688 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
689 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
690 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
691 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
693 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
694 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
695 for f in pending_forwards.iter_mut() {
697 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
698 forward_info.outgoing_cltv_value += 1,
703 expect_pending_htlcs_forwardable!(nodes[1]);
705 check_added_monitors!(&nodes[1], 1);
706 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
707 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
708 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
709 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
711 expect_pending_htlcs_forwardable!(nodes[2]);
712 expect_payment_claimable!(nodes[2], payment_hash, payment_secret, 40_000);
713 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
716 fn do_test_onion_failure_stale_channel_update(announced_channel: bool) {
717 // Create a network of three nodes and two channels connecting them. We'll be updating the
718 // HTLC relay policy of the second channel, causing forwarding failures at the first hop.
719 let mut config = UserConfig::default();
720 config.channel_handshake_config.announced_channel = announced_channel;
721 config.channel_handshake_limits.force_announced_channel_preference = false;
722 config.accept_forwards_to_priv_channels = !announced_channel;
723 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
724 let chanmon_cfgs = create_chanmon_cfgs(3);
725 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
728 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]);
729 let channel_manager_1_deserialized;
730 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
732 let other_channel = create_chan_between_nodes(
733 &nodes[0], &nodes[1],
735 let channel_to_update = if announced_channel {
736 let channel = create_announced_chan_between_nodes(
739 (channel.2, channel.0.contents.short_channel_id)
741 let channel = create_unannounced_chan_between_nodes_with_value(
742 &nodes, 1, 2, 100000, 10001,
744 (channel.0.channel_id, channel.0.short_channel_id_alias.unwrap())
746 let channel_to_update_counterparty = &nodes[2].node.get_our_node_id();
748 let default_config = ChannelConfig::default();
750 // A test payment should succeed as the ChannelConfig has not been changed yet.
751 const PAYMENT_AMT: u64 = 40000;
752 let (route, payment_hash, payment_preimage, payment_secret) = if announced_channel {
753 get_route_and_payment_hash!(nodes[0], nodes[2], PAYMENT_AMT)
755 let hop_hints = vec![RouteHint(vec![RouteHintHop {
756 src_node_id: nodes[1].node.get_our_node_id(),
757 short_channel_id: channel_to_update.1,
759 base_msat: default_config.forwarding_fee_base_msat,
760 proportional_millionths: default_config.forwarding_fee_proportional_millionths,
762 cltv_expiry_delta: default_config.cltv_expiry_delta,
763 htlc_maximum_msat: None,
764 htlc_minimum_msat: None,
766 let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty, TEST_FINAL_CLTV)
767 .with_bolt11_features(nodes[2].node.invoice_features()).unwrap()
768 .with_route_hints(hop_hints).unwrap();
769 get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT)
771 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
772 payment_hash, payment_secret);
773 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
775 // Closure to force expiry of a channel's previous config.
776 let expire_prev_config = || {
777 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
778 nodes[1].node.timer_tick_occurred();
782 // Closure to update and retrieve the latest ChannelUpdate.
783 let update_and_get_channel_update = |config: &ChannelConfig, expect_new_update: bool,
784 prev_update: Option<&msgs::ChannelUpdate>, should_expire_prev_config: bool| -> Option<msgs::ChannelUpdate> {
785 nodes[1].node.update_channel_config(
786 channel_to_update_counterparty, &[channel_to_update.0], config,
788 let events = nodes[1].node.get_and_clear_pending_msg_events();
789 assert_eq!(events.len(), expect_new_update as usize);
790 if !expect_new_update {
793 let new_update = match &events[0] {
794 MessageSendEvent::BroadcastChannelUpdate { msg } => {
795 assert!(announced_channel);
798 MessageSendEvent::SendChannelUpdate { node_id, msg } => {
799 assert_eq!(node_id, channel_to_update_counterparty);
800 assert!(!announced_channel);
803 _ => panic!("expected Broadcast/SendChannelUpdate event"),
805 if prev_update.is_some() {
806 assert!(new_update.contents.timestamp > prev_update.unwrap().contents.timestamp)
808 if should_expire_prev_config {
809 expire_prev_config();
814 // We'll be attempting to route payments using the default ChannelUpdate for channels. This will
815 // lead to onion failures at the first hop once we update the ChannelConfig for the
817 let expect_onion_failure = |name: &str, error_code: u16, channel_update: &msgs::ChannelUpdate| {
818 let short_channel_id = channel_to_update.1;
819 let network_update = NetworkUpdate::ChannelUpdateMessage { msg: channel_update.clone() };
820 run_onion_failure_test(
821 name, 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {}, true,
822 Some(error_code), Some(network_update), Some(short_channel_id),
826 // Updates to cltv_expiry_delta below MIN_CLTV_EXPIRY_DELTA should fail with APIMisuseError.
827 let mut invalid_config = default_config.clone();
828 invalid_config.cltv_expiry_delta = 0;
829 match nodes[1].node.update_channel_config(
830 channel_to_update_counterparty, &[channel_to_update.0], &invalid_config,
832 Err(APIError::APIMisuseError{ .. }) => {},
833 _ => panic!("unexpected result applying invalid cltv_expiry_delta"),
836 // Increase the base fee which should trigger a new ChannelUpdate.
837 let mut config = nodes[1].node.list_usable_channels().iter()
838 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
840 config.forwarding_fee_base_msat = u32::max_value();
841 let msg = update_and_get_channel_update(&config, true, None, false).unwrap();
843 // The old policy should still be in effect until a new block is connected.
844 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
845 payment_hash, payment_secret);
846 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
848 // Connect a block, which should expire the previous config, leading to a failure when
849 // forwarding the HTLC.
850 expire_prev_config();
851 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
853 // Redundant updates should not trigger a new ChannelUpdate.
854 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
856 // Similarly, updates that do not have an affect on ChannelUpdate should not trigger a new one.
857 config.force_close_avoidance_max_fee_satoshis *= 2;
858 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
860 // Reset the base fee to the default and increase the proportional fee which should trigger a
861 // new ChannelUpdate.
862 config.forwarding_fee_base_msat = default_config.forwarding_fee_base_msat;
863 config.cltv_expiry_delta = u16::max_value();
864 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
865 expect_onion_failure("incorrect_cltv_expiry", UPDATE|13, &msg);
867 // Reset the proportional fee and increase the CLTV expiry delta which should trigger a new
869 config.cltv_expiry_delta = default_config.cltv_expiry_delta;
870 config.forwarding_fee_proportional_millionths = u32::max_value();
871 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
872 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
874 // To test persistence of the updated config, we'll re-initialize the ChannelManager.
875 let config_after_restart = {
876 let chan_1_monitor_serialized = get_monitor!(nodes[1], other_channel.3).encode();
877 let chan_2_monitor_serialized = get_monitor!(nodes[1], channel_to_update.0).encode();
878 reload_node!(nodes[1], *nodes[1].node.get_current_default_configuration(), &nodes[1].node.encode(),
879 &[&chan_1_monitor_serialized, &chan_2_monitor_serialized], persister, chain_monitor, channel_manager_1_deserialized);
880 nodes[1].node.list_channels().iter()
881 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
884 assert_eq!(config, config_after_restart);
888 fn test_onion_failure_stale_channel_update() {
889 do_test_onion_failure_stale_channel_update(false);
890 do_test_onion_failure_stale_channel_update(true);
894 fn test_always_create_tlv_format_onion_payloads() {
895 // Verify that we always generate tlv onion format payloads, even if the features specifically
896 // specifies no support for variable length onions, as the legacy payload format has been
897 // deprecated in BOLT4.
898 let chanmon_cfgs = create_chanmon_cfgs(3);
899 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
901 // Set `node[1]`'s init features to features which return `false` for
902 // `supports_variable_length_onion()`
903 let mut no_variable_length_onion_features = InitFeatures::empty();
904 no_variable_length_onion_features.set_static_remote_key_required();
905 *node_cfgs[1].override_init_features.borrow_mut() = Some(no_variable_length_onion_features);
907 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
908 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
910 create_announced_chan_between_nodes(&nodes, 0, 1);
911 create_announced_chan_between_nodes(&nodes, 1, 2);
913 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
914 .with_bolt11_features(Bolt11InvoiceFeatures::empty()).unwrap();
915 let (route, _payment_hash, _payment_preimage, _payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, 40000);
917 let hops = &route.paths[0].hops;
918 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
919 assert!(!hops[0].node_features.supports_variable_length_onion());
920 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
921 assert!(!hops[1].node_features.supports_variable_length_onion());
923 let cur_height = nodes[0].best_block_info().1 + 1;
924 let (onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
925 &route.paths[0], 40000, RecipientOnionFields::spontaneous_empty(), cur_height, &None).unwrap();
927 match onion_payloads[0] {
928 msgs::OutboundOnionPayload::Forward {..} => {},
930 "Should have generated a `msgs::OnionHopDataFormat::NonFinalNode` payload for `hops[0]`,
931 despite that the features signals no support for variable length onions"
934 match onion_payloads[1] {
935 msgs::OutboundOnionPayload::Receive {..} => {},
937 "Should have generated a `msgs::OnionHopDataFormat::FinalNode` payload for `hops[1]`,
938 despite that the features signals no support for variable length onions"
943 fn do_test_fail_htlc_backwards_with_reason(failure_code: FailureCode) {
945 let chanmon_cfgs = create_chanmon_cfgs(2);
946 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
947 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
948 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
950 create_announced_chan_between_nodes(&nodes, 0, 1);
952 let payment_amount = 100_000;
953 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_amount);
954 nodes[0].node.send_payment_with_route(&route, payment_hash,
955 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
956 check_added_monitors!(nodes[0], 1);
958 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
959 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
960 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
961 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
963 expect_pending_htlcs_forwardable!(nodes[1]);
964 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, payment_amount);
965 nodes[1].node.fail_htlc_backwards_with_reason(&payment_hash, failure_code);
967 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash }]);
968 check_added_monitors!(nodes[1], 1);
970 let events = nodes[1].node.get_and_clear_pending_msg_events();
971 assert_eq!(events.len(), 1);
972 let (update_fail_htlc, commitment_signed) = match events[0] {
973 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 } } => {
974 assert!(update_add_htlcs.is_empty());
975 assert!(update_fulfill_htlcs.is_empty());
976 assert_eq!(update_fail_htlcs.len(), 1);
977 assert!(update_fail_malformed_htlcs.is_empty());
978 assert!(update_fee.is_none());
979 (update_fail_htlcs[0].clone(), commitment_signed)
981 _ => panic!("Unexpected event"),
984 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
985 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
987 let failure_data = match failure_code {
988 FailureCode::TemporaryNodeFailure => vec![],
989 FailureCode::RequiredNodeFeatureMissing => vec![],
990 FailureCode::IncorrectOrUnknownPaymentDetails => {
991 let mut htlc_msat_height_data = (payment_amount as u64).to_be_bytes().to_vec();
992 htlc_msat_height_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes());
993 htlc_msat_height_data
995 FailureCode::InvalidOnionPayload(data) => {
997 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
1003 let failure_code = failure_code.into();
1004 let permanent_flag = 0x4000;
1005 let permanent_fail = (failure_code & permanent_flag) != 0;
1006 expect_payment_failed!(nodes[0], payment_hash, permanent_fail, failure_code, failure_data);
1011 fn test_fail_htlc_backwards_with_reason() {
1012 do_test_fail_htlc_backwards_with_reason(FailureCode::TemporaryNodeFailure);
1013 do_test_fail_htlc_backwards_with_reason(FailureCode::RequiredNodeFeatureMissing);
1014 do_test_fail_htlc_backwards_with_reason(FailureCode::IncorrectOrUnknownPaymentDetails);
1015 do_test_fail_htlc_backwards_with_reason(FailureCode::InvalidOnionPayload(Some((1 << 16, 42))));
1016 do_test_fail_htlc_backwards_with_reason(FailureCode::InvalidOnionPayload(None));
1019 macro_rules! get_phantom_route {
1020 ($nodes: expr, $amt: expr, $channel: expr) => {{
1021 let phantom_pubkey = $nodes[1].keys_manager.get_node_id(Recipient::PhantomNode).unwrap();
1022 let phantom_route_hint = $nodes[1].node.get_phantom_route_hints();
1023 let payment_params = PaymentParameters::from_node_id(phantom_pubkey, TEST_FINAL_CLTV)
1024 .with_bolt11_features($nodes[1].node.invoice_features()).unwrap()
1025 .with_route_hints(vec![RouteHint(vec![
1027 src_node_id: $nodes[0].node.get_our_node_id(),
1028 short_channel_id: $channel.0.contents.short_channel_id,
1030 base_msat: $channel.0.contents.fee_base_msat,
1031 proportional_millionths: $channel.0.contents.fee_proportional_millionths,
1033 cltv_expiry_delta: $channel.0.contents.cltv_expiry_delta,
1034 htlc_minimum_msat: None,
1035 htlc_maximum_msat: None,
1038 src_node_id: phantom_route_hint.real_node_pubkey,
1039 short_channel_id: phantom_route_hint.phantom_scid,
1042 proportional_millionths: 0,
1044 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
1045 htlc_minimum_msat: None,
1046 htlc_maximum_msat: None,
1049 let scorer = test_utils::TestScorer::new();
1050 let network_graph = $nodes[0].network_graph.read_only();
1051 let route_params = RouteParameters::from_payment_params_and_value(payment_params, $amt);
1053 &$nodes[0].node.get_our_node_id(), &route_params, &network_graph,
1054 Some(&$nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
1055 $nodes[0].logger, &scorer, &(), &[0u8; 32]
1056 ).unwrap(), phantom_route_hint.phantom_scid)
1061 fn test_phantom_onion_hmac_failure() {
1062 let chanmon_cfgs = create_chanmon_cfgs(2);
1063 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1064 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1065 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1067 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1070 let recv_value_msat = 10_000;
1071 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1072 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1074 // Route the HTLC through to the destination.
1075 nodes[0].node.send_payment_with_route(&route, payment_hash,
1076 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1077 check_added_monitors!(nodes[0], 1);
1078 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1079 let mut update_add = update_0.update_add_htlcs[0].clone();
1081 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1082 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1084 // Modify the payload so the phantom hop's HMAC is bogus.
1085 let sha256_of_onion = {
1086 let mut forward_htlcs = nodes[1].node.forward_htlcs.lock().unwrap();
1087 let mut pending_forward = forward_htlcs.get_mut(&phantom_scid).unwrap();
1088 match pending_forward[0] {
1089 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1090 forward_info: PendingHTLCInfo {
1091 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1095 onion_packet.hmac[onion_packet.hmac.len() - 1] ^= 1;
1096 Sha256::hash(&onion_packet.hop_data).into_inner().to_vec()
1098 _ => panic!("Unexpected forward"),
1101 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1102 nodes[1].node.process_pending_htlc_forwards();
1103 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1104 nodes[1].node.process_pending_htlc_forwards();
1105 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1106 check_added_monitors!(&nodes[1], 1);
1107 assert!(update_1.update_fail_htlcs.len() == 1);
1108 let fail_msg = update_1.update_fail_htlcs[0].clone();
1109 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1110 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1112 // Ensure the payment fails with the expected error.
1113 let mut fail_conditions = PaymentFailedConditions::new()
1114 .blamed_scid(phantom_scid)
1115 .blamed_chan_closed(true)
1116 .expected_htlc_error_data(0x8000 | 0x4000 | 5, &sha256_of_onion);
1117 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1121 fn test_phantom_invalid_onion_payload() {
1122 let chanmon_cfgs = create_chanmon_cfgs(2);
1123 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1124 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1125 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1127 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1130 let recv_value_msat = 10_000;
1131 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1132 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1134 // We'll use the session priv later when constructing an invalid onion packet.
1135 let session_priv = [3; 32];
1136 *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
1137 nodes[0].node.send_payment_with_route(&route, payment_hash,
1138 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1139 check_added_monitors!(nodes[0], 1);
1140 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1141 let mut update_add = update_0.update_add_htlcs[0].clone();
1143 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1144 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1146 // Modify the onion packet to have an invalid payment amount.
1147 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1148 for f in pending_forwards.iter_mut() {
1150 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1151 forward_info: PendingHTLCInfo {
1152 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1156 // Construct the onion payloads for the entire route and an invalid amount.
1157 let height = nodes[0].best_block_info().1;
1158 let session_priv = SecretKey::from_slice(&session_priv).unwrap();
1159 let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
1160 let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(
1161 &route.paths[0], msgs::MAX_VALUE_MSAT + 1,
1162 RecipientOnionFields::secret_only(payment_secret), height + 1, &None).unwrap();
1163 // We only want to construct the onion packet for the last hop, not the entire route, so
1164 // remove the first hop's payload and its keys.
1165 onion_keys.remove(0);
1166 onion_payloads.remove(0);
1168 let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
1169 onion_packet.hop_data = new_onion_packet.hop_data;
1170 onion_packet.hmac = new_onion_packet.hmac;
1172 _ => panic!("Unexpected forward"),
1176 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1177 nodes[1].node.process_pending_htlc_forwards();
1178 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1179 nodes[1].node.process_pending_htlc_forwards();
1180 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1181 check_added_monitors!(&nodes[1], 1);
1182 assert!(update_1.update_fail_htlcs.len() == 1);
1183 let fail_msg = update_1.update_fail_htlcs[0].clone();
1184 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1185 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1187 // Ensure the payment fails with the expected error.
1188 let error_data = Vec::new();
1189 let mut fail_conditions = PaymentFailedConditions::new()
1190 .blamed_scid(phantom_scid)
1191 .blamed_chan_closed(true)
1192 .expected_htlc_error_data(0x4000 | 22, &error_data);
1193 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1197 fn test_phantom_final_incorrect_cltv_expiry() {
1198 let chanmon_cfgs = create_chanmon_cfgs(2);
1199 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1200 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1201 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1203 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1206 let recv_value_msat = 10_000;
1207 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1208 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1210 // Route the HTLC through to the destination.
1211 nodes[0].node.send_payment_with_route(&route, payment_hash,
1212 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1213 check_added_monitors!(nodes[0], 1);
1214 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1215 let mut update_add = update_0.update_add_htlcs[0].clone();
1217 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1218 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1220 // Modify the payload so the phantom hop's HMAC is bogus.
1221 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1222 for f in pending_forwards.iter_mut() {
1224 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1225 forward_info: PendingHTLCInfo { ref mut outgoing_cltv_value, .. }, ..
1227 *outgoing_cltv_value -= 1;
1229 _ => panic!("Unexpected forward"),
1233 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1234 nodes[1].node.process_pending_htlc_forwards();
1235 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1236 nodes[1].node.process_pending_htlc_forwards();
1237 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1238 check_added_monitors!(&nodes[1], 1);
1239 assert!(update_1.update_fail_htlcs.len() == 1);
1240 let fail_msg = update_1.update_fail_htlcs[0].clone();
1241 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1242 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1244 // Ensure the payment fails with the expected error.
1245 let expected_cltv: u32 = 80;
1246 let error_data = expected_cltv.to_be_bytes().to_vec();
1247 let mut fail_conditions = PaymentFailedConditions::new()
1248 .blamed_scid(phantom_scid)
1249 .expected_htlc_error_data(18, &error_data);
1250 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1254 fn test_phantom_failure_too_low_cltv() {
1255 let chanmon_cfgs = create_chanmon_cfgs(2);
1256 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1257 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1258 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1260 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1263 let recv_value_msat = 10_000;
1264 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1265 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1267 // Modify the route to have a too-low cltv.
1268 route.paths[0].hops[1].cltv_expiry_delta = 5;
1270 // Route the HTLC through to the destination.
1271 nodes[0].node.send_payment_with_route(&route, payment_hash,
1272 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1273 check_added_monitors!(nodes[0], 1);
1274 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1275 let mut update_add = update_0.update_add_htlcs[0].clone();
1277 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1278 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1280 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1281 nodes[1].node.process_pending_htlc_forwards();
1282 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1283 nodes[1].node.process_pending_htlc_forwards();
1284 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1285 check_added_monitors!(&nodes[1], 1);
1286 assert!(update_1.update_fail_htlcs.len() == 1);
1287 let fail_msg = update_1.update_fail_htlcs[0].clone();
1288 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1289 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1291 // Ensure the payment fails with the expected error.
1292 let mut error_data = recv_value_msat.to_be_bytes().to_vec();
1293 error_data.extend_from_slice(
1294 &nodes[0].node.best_block.read().unwrap().height().to_be_bytes(),
1296 let mut fail_conditions = PaymentFailedConditions::new()
1297 .blamed_scid(phantom_scid)
1298 .expected_htlc_error_data(0x4000 | 15, &error_data);
1299 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1303 fn test_phantom_failure_modified_cltv() {
1304 // Test that we fail back phantoms if the upstream node fiddled with the CLTV too much with the
1305 // correct error code.
1306 let chanmon_cfgs = create_chanmon_cfgs(2);
1307 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1308 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1309 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1311 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1314 let recv_value_msat = 10_000;
1315 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1316 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1318 // Route the HTLC through to the destination.
1319 nodes[0].node.send_payment_with_route(&route, payment_hash,
1320 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1321 check_added_monitors!(nodes[0], 1);
1322 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1323 let mut update_add = update_0.update_add_htlcs[0].clone();
1325 // Modify the route to have a too-low cltv.
1326 update_add.cltv_expiry -= 10;
1328 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1329 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1331 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1332 assert!(update_1.update_fail_htlcs.len() == 1);
1333 let fail_msg = update_1.update_fail_htlcs[0].clone();
1334 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1335 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1337 // Ensure the payment fails with the expected error.
1338 let mut fail_conditions = PaymentFailedConditions::new()
1339 .blamed_scid(phantom_scid)
1340 .expected_htlc_error_data(0x2000 | 2, &[]);
1341 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1345 fn test_phantom_failure_expires_too_soon() {
1346 // Test that we fail back phantoms if the HTLC got delayed and we got blocks in between with
1347 // the correct error code.
1348 let chanmon_cfgs = create_chanmon_cfgs(2);
1349 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1350 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1351 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1353 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1356 let recv_value_msat = 10_000;
1357 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1358 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1360 // Route the HTLC through to the destination.
1361 nodes[0].node.send_payment_with_route(&route, payment_hash,
1362 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1363 check_added_monitors!(nodes[0], 1);
1364 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1365 let mut update_add = update_0.update_add_htlcs[0].clone();
1367 connect_blocks(&nodes[1], CLTV_FAR_FAR_AWAY);
1368 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1369 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1371 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1372 assert!(update_1.update_fail_htlcs.len() == 1);
1373 let fail_msg = update_1.update_fail_htlcs[0].clone();
1374 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1375 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1377 // Ensure the payment fails with the expected error.
1378 let mut fail_conditions = PaymentFailedConditions::new()
1379 .blamed_scid(phantom_scid)
1380 .expected_htlc_error_data(0x2000 | 2, &[]);
1381 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1385 fn test_phantom_failure_too_low_recv_amt() {
1386 let chanmon_cfgs = create_chanmon_cfgs(2);
1387 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1388 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1389 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1391 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1393 // Get the route with a too-low amount.
1394 let recv_amt_msat = 10_000;
1395 let bad_recv_amt_msat = recv_amt_msat - 10;
1396 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1397 let (mut route, phantom_scid) = get_phantom_route!(nodes, bad_recv_amt_msat, channel);
1399 // Route the HTLC through to the destination.
1400 nodes[0].node.send_payment_with_route(&route, payment_hash,
1401 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1402 check_added_monitors!(nodes[0], 1);
1403 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1404 let mut update_add = update_0.update_add_htlcs[0].clone();
1406 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1407 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1409 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1410 nodes[1].node.process_pending_htlc_forwards();
1411 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1412 nodes[1].node.process_pending_htlc_forwards();
1413 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
1414 nodes[1].node.process_pending_htlc_forwards();
1415 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1416 check_added_monitors!(&nodes[1], 1);
1417 assert!(update_1.update_fail_htlcs.len() == 1);
1418 let fail_msg = update_1.update_fail_htlcs[0].clone();
1419 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1420 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1422 // Ensure the payment fails with the expected error.
1423 let mut error_data = bad_recv_amt_msat.to_be_bytes().to_vec();
1424 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1425 let mut fail_conditions = PaymentFailedConditions::new()
1426 .blamed_scid(phantom_scid)
1427 .expected_htlc_error_data(0x4000 | 15, &error_data);
1428 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1432 fn test_phantom_dust_exposure_failure() {
1433 do_test_phantom_dust_exposure_failure(false);
1434 do_test_phantom_dust_exposure_failure(true);
1437 fn do_test_phantom_dust_exposure_failure(multiplier_dust_limit: bool) {
1438 // Set the max dust exposure to the dust limit.
1439 let max_dust_exposure = 546;
1440 let mut receiver_config = UserConfig::default();
1441 // Default test fee estimator rate is 253, so to set the max dust exposure to the dust limit,
1442 // we need to set the multiplier to 2.
1443 receiver_config.channel_config.max_dust_htlc_exposure =
1444 if multiplier_dust_limit { MaxDustHTLCExposure::FeeRateMultiplier(2) }
1445 else { MaxDustHTLCExposure::FixedLimitMsat(max_dust_exposure) };
1446 receiver_config.channel_handshake_config.announced_channel = true;
1448 let chanmon_cfgs = create_chanmon_cfgs(2);
1449 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1450 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(receiver_config)]);
1451 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1453 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1455 // Get the route with an amount exceeding the dust exposure threshold of nodes[1].
1456 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(max_dust_exposure + 1));
1457 let (mut route, _) = get_phantom_route!(nodes, max_dust_exposure + 1, channel);
1459 // Route the HTLC through to the destination.
1460 nodes[0].node.send_payment_with_route(&route, payment_hash,
1461 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1462 check_added_monitors!(nodes[0], 1);
1463 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1464 let mut update_add = update_0.update_add_htlcs[0].clone();
1466 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1467 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1469 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1470 assert!(update_1.update_fail_htlcs.len() == 1);
1471 let fail_msg = update_1.update_fail_htlcs[0].clone();
1472 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1473 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1475 // Ensure the payment fails with the expected error.
1476 let mut err_data = Vec::new();
1477 err_data.extend_from_slice(&(channel.1.serialized_length() as u16 + 2).to_be_bytes());
1478 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
1479 err_data.extend_from_slice(&channel.1.encode());
1481 let mut fail_conditions = PaymentFailedConditions::new()
1482 .blamed_scid(channel.0.contents.short_channel_id)
1483 .blamed_chan_closed(false)
1484 .expected_htlc_error_data(0x1000 | 7, &err_data);
1485 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1489 fn test_phantom_failure_reject_payment() {
1490 // Test that the user can successfully fail back a phantom node payment.
1491 let chanmon_cfgs = create_chanmon_cfgs(2);
1492 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1493 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1494 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1496 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1498 // Get the route with a too-low amount.
1499 let recv_amt_msat = 10_000;
1500 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1501 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_amt_msat, channel);
1503 // Route the HTLC through to the destination.
1504 nodes[0].node.send_payment_with_route(&route, payment_hash,
1505 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1506 check_added_monitors!(nodes[0], 1);
1507 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1508 let mut update_add = update_0.update_add_htlcs[0].clone();
1510 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1511 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1513 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1514 nodes[1].node.process_pending_htlc_forwards();
1515 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1516 nodes[1].node.process_pending_htlc_forwards();
1517 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, recv_amt_msat, None, route.paths[0].hops.last().unwrap().pubkey);
1518 nodes[1].node.fail_htlc_backwards(&payment_hash);
1519 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1520 nodes[1].node.process_pending_htlc_forwards();
1522 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1523 check_added_monitors!(&nodes[1], 1);
1524 assert!(update_1.update_fail_htlcs.len() == 1);
1525 let fail_msg = update_1.update_fail_htlcs[0].clone();
1526 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1527 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1529 // Ensure the payment fails with the expected error.
1530 let mut error_data = recv_amt_msat.to_be_bytes().to_vec();
1531 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height().to_be_bytes());
1532 let mut fail_conditions = PaymentFailedConditions::new()
1533 .blamed_scid(phantom_scid)
1534 .expected_htlc_error_data(0x4000 | 15, &error_data);
1535 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);