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::types::{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};
24 use crate::ln::functional_test_utils::test_default_channel_config;
26 use crate::ln::msgs::{ChannelMessageHandler, ChannelUpdate, OutboundTrampolinePayload};
27 use crate::ln::wire::Encode;
28 use crate::util::ser::{Writeable, Writer, BigSize};
29 use crate::util::test_utils;
30 use crate::util::config::{UserConfig, ChannelConfig, MaxDustHTLCExposure};
31 use crate::util::errors::APIError;
33 use bitcoin::blockdata::constants::ChainHash;
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::{PublicKey, Secp256k1, SecretKey};
42 use crate::prelude::*;
43 use bitcoin::hashes::hex::FromHex;
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::ChannelFailure { ref short_channel_id, ref is_permanent } => {
184 if let NetworkUpdate::ChannelFailure { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
185 assert!(*short_channel_id == *expected_short_channel_id);
186 assert!(*is_permanent == *expected_is_permanent);
188 panic!("Unexpected message event");
191 &NetworkUpdate::NodeFailure { ref node_id, ref is_permanent } => {
192 if let NetworkUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
193 assert!(*node_id == *expected_node_id);
194 assert!(*is_permanent == *expected_is_permanent);
196 panic!("Unexpected message event");
200 None => panic!("Expected channel update"),
203 assert!(network_update.is_none());
205 if let Some(expected_short_channel_id) = expected_short_channel_id {
206 match short_channel_id {
207 Some(short_channel_id) => assert_eq!(*short_channel_id, expected_short_channel_id),
208 None => panic!("Expected short channel id"),
211 assert!(short_channel_id.is_none());
214 panic!("Unexpected event");
217 Event::PaymentFailed { payment_hash: ev_payment_hash, payment_id: ev_payment_id, reason: ref ev_reason } => {
218 assert_eq!(*payment_hash, ev_payment_hash);
219 assert_eq!(payment_id, ev_payment_id);
220 assert_eq!(if expected_retryable {
221 PaymentFailureReason::RetriesExhausted
223 PaymentFailureReason::RecipientRejected
224 }, ev_reason.unwrap());
226 _ => panic!("Unexpected second event"),
230 impl msgs::ChannelUpdate {
231 fn dummy(short_channel_id: u64) -> msgs::ChannelUpdate {
232 use bitcoin::hash_types::BlockHash;
233 use bitcoin::secp256k1::ffi::Signature as FFISignature;
234 use bitcoin::secp256k1::ecdsa::Signature;
235 msgs::ChannelUpdate {
236 signature: Signature::from(unsafe { FFISignature::new() }),
237 contents: msgs::UnsignedChannelUpdate {
238 chain_hash: ChainHash::from(BlockHash::hash(&vec![0u8][..]).as_ref()),
241 message_flags: 1, // Only must_be_one
243 cltv_expiry_delta: 0,
244 htlc_minimum_msat: 0,
245 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
247 fee_proportional_millionths: 0,
254 struct BogusOnionHopData {
257 impl BogusOnionHopData {
258 fn new(orig: msgs::OutboundOnionPayload) -> Self {
259 Self { data: orig.encode() }
262 impl Writeable for BogusOnionHopData {
263 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
264 writer.write_all(&self.data[..])
268 const BADONION: u16 = 0x8000;
269 const PERM: u16 = 0x4000;
270 const NODE: u16 = 0x2000;
271 const UPDATE: u16 = 0x1000;
274 fn test_fee_failures() {
275 // Tests that the fee required when forwarding remains consistent over time. This was
276 // previously broken, with forwarding fees floating based on the fee estimator at the time of
279 // When this test was written, the default base fee floated based on the HTLC count.
280 // It is now fixed, so we simply set the fee to the expected value here.
281 let mut config = test_default_channel_config();
282 config.channel_config.forwarding_fee_base_msat = 196;
284 let chanmon_cfgs = create_chanmon_cfgs(3);
285 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
286 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
287 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
288 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
291 let (route, payment_hash_success, payment_preimage_success, payment_secret_success) = get_route_and_payment_hash!(nodes[0], nodes[2], 40_000);
292 nodes[0].node.send_payment_with_route(&route, payment_hash_success,
293 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
294 check_added_monitors!(nodes[0], 1);
295 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
296 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
298 // If the hop gives fee_insufficient but enough fees were provided, then the previous hop
299 // malleated the payment before forwarding, taking funds when they shouldn't have. However,
300 // because we ignore channel update contents, we will still blame the 2nd channel.
301 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
302 let short_channel_id = channels[1].0.contents.short_channel_id;
303 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
304 msg.amount_msat -= 1;
305 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: false}), Some(short_channel_id));
307 // In an earlier version, we spuriously failed to forward payments if the expected feerate
308 // changed between the channel open and the payment.
310 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
314 let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
315 nodes[0].node.send_payment_with_route(&route, payment_hash_success,
316 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
317 check_added_monitors!(nodes[0], 1);
318 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
319 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
323 fn test_onion_failure() {
324 // When we check for amount_below_minimum below, we want to test that we're using the *right*
325 // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
326 // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
327 // This exposed a previous bug because we were using the wrong value all the way down in
328 // Channel::get_counterparty_htlc_minimum_msat().
329 let mut node_2_cfg: UserConfig = test_default_channel_config();
330 node_2_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
331 node_2_cfg.channel_handshake_config.announced_channel = true;
332 node_2_cfg.channel_handshake_limits.force_announced_channel_preference = false;
334 // When this test was written, the default base fee floated based on the HTLC count.
335 // It is now fixed, so we simply set the fee to the expected value here.
336 let mut config = test_default_channel_config();
337 config.channel_config.forwarding_fee_base_msat = 196;
339 let chanmon_cfgs = create_chanmon_cfgs(3);
340 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
341 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
342 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
343 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
344 for node in nodes.iter() {
345 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
347 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
349 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
351 // intermediate node failure
352 let short_channel_id = channels[1].0.contents.short_channel_id;
353 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
354 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
355 let cur_height = nodes[0].best_block_info().1 + 1;
356 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
357 let recipient_onion_fields = RecipientOnionFields::spontaneous_empty();
358 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
359 &route.paths[0], 40000, &recipient_onion_fields, cur_height, &None).unwrap();
360 let mut new_payloads = Vec::new();
361 for payload in onion_payloads.drain(..) {
362 new_payloads.push(BogusOnionHopData::new(payload));
364 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
365 // describing a length-1 TLV payload, which is obviously bogus.
366 new_payloads[0].data[0] = 1;
367 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
368 }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
370 // final node failure
371 let short_channel_id = channels[1].0.contents.short_channel_id;
372 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
373 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
374 let cur_height = nodes[0].best_block_info().1 + 1;
375 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
376 let recipient_onion_fields = RecipientOnionFields::spontaneous_empty();
377 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
378 &route.paths[0], 40000, &recipient_onion_fields, 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),
479 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: false }),
480 Some(short_channel_id));
482 // Check we can still handle onion failures that include channel updates without a type prefix
483 let err_data_without_type = chan_update.encode_with_len();
484 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
485 msg.amount_msat -= 1;
487 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
488 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
489 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data_without_type);
490 }, ||{}, true, Some(UPDATE|7),
491 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: false }),
492 Some(short_channel_id));
494 let short_channel_id = channels[1].0.contents.short_channel_id;
495 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 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|8, &[0;0]);
501 // short_channel_id from the processing node
502 }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
504 let short_channel_id = channels[1].0.contents.short_channel_id;
505 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
506 msg.amount_msat -= 1;
508 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
509 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
510 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|9, &[0;0]);
511 // short_channel_id from the processing node
512 }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
514 let mut bogus_route = route.clone();
515 bogus_route.paths[0].hops[1].short_channel_id -= 1;
516 let short_channel_id = bogus_route.paths[0].hops[1].short_channel_id;
517 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
518 Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent:true}), Some(short_channel_id));
520 let short_channel_id = channels[1].0.contents.short_channel_id;
521 let amt_to_forward = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[2].node.get_our_node_id())
522 .unwrap().lock().unwrap().channel_by_id.get(&channels[1].2).unwrap()
523 .context().get_counterparty_htlc_minimum_msat() - 1;
524 let mut bogus_route = route.clone();
525 let route_len = bogus_route.paths[0].hops.len();
526 bogus_route.paths[0].hops[route_len-1].fee_msat = amt_to_forward;
527 run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(UPDATE|11),
528 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: false }),
529 Some(short_channel_id));
531 // Clear pending payments so that the following positive test has the correct payment hash.
532 for node in nodes.iter() {
533 node.node.clear_pending_payments();
536 // Test a positive test-case with one extra msat, meeting the minimum.
537 bogus_route.paths[0].hops[route_len-1].fee_msat = amt_to_forward + 1;
538 let preimage = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1).0;
539 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
541 // We ignore channel update contents in onion errors, so will blame the 2nd channel even though
542 // the first node is the one that messed up.
543 let short_channel_id = channels[1].0.contents.short_channel_id;
544 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
545 msg.amount_msat -= 1;
546 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: false}), Some(short_channel_id));
548 let short_channel_id = channels[1].0.contents.short_channel_id;
549 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
550 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
551 msg.cltv_expiry -= 1;
552 }, || {}, true, Some(UPDATE|13), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: false}), Some(short_channel_id));
554 let short_channel_id = channels[1].0.contents.short_channel_id;
555 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
556 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
557 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
558 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
559 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
560 }, ||{}, true, Some(UPDATE|14),
561 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: false }),
562 Some(short_channel_id));
564 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
565 nodes[2].node.fail_htlc_backwards(&payment_hash);
566 }, false, Some(PERM|15), None, None);
567 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
569 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
570 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
571 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
572 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
573 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
574 }, || {}, false, Some(0x4000 | 15), None, None);
576 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
577 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
578 for f in pending_forwards.iter_mut() {
580 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
581 forward_info.outgoing_cltv_value -= 1,
586 }, true, Some(18), None, Some(channels[1].0.contents.short_channel_id));
588 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
589 // violate amt_to_forward > msg.amount_msat
590 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
591 for f in pending_forwards.iter_mut() {
593 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
594 forward_info.outgoing_amt_msat -= 1,
599 }, true, Some(19), None, Some(channels[1].0.contents.short_channel_id));
601 let short_channel_id = channels[1].0.contents.short_channel_id;
602 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
603 // disconnect event to the channel between nodes[1] ~ nodes[2]
604 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
605 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
606 }, true, Some(UPDATE|7),
607 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: false }),
608 Some(short_channel_id));
609 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
610 // disconnect event to the channel between nodes[1] ~ nodes[2]
611 for _ in 0..DISABLE_GOSSIP_TICKS + 1 {
612 nodes[1].node.timer_tick_occurred();
613 nodes[2].node.timer_tick_occurred();
615 nodes[1].node.get_and_clear_pending_msg_events();
616 nodes[2].node.get_and_clear_pending_msg_events();
617 }, true, Some(UPDATE|20),
618 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: false }),
619 Some(short_channel_id));
620 reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[2]));
622 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
623 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
624 let mut route = route.clone();
625 let height = nodes[2].best_block_info().1;
626 route.paths[0].hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0].hops[0].cltv_expiry_delta + 1;
627 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
628 let recipient_onion_fields = RecipientOnionFields::spontaneous_empty();
629 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(
630 &route.paths[0], 40000, &recipient_onion_fields, height, &None).unwrap();
631 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
632 msg.cltv_expiry = htlc_cltv;
633 msg.onion_routing_packet = onion_packet;
634 }, ||{}, 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));
636 run_onion_failure_test_with_fail_intercept("mpp_timeout", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
637 // Tamper returning error message
638 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
639 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
640 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), 23, &[0;0]);
642 nodes[2].node.fail_htlc_backwards(&payment_hash);
643 }, true, Some(23), None, None);
645 run_onion_failure_test_with_fail_intercept("bogus err packet with valid hmac", 200, &nodes,
646 &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
647 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
648 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
649 let mut decoded_err_packet = msgs::DecodedOnionErrorPacket {
654 let um = onion_utils::gen_um_from_shared_secret(&onion_keys[1].shared_secret.as_ref());
655 let mut hmac = HmacEngine::<Sha256>::new(&um);
656 hmac.input(&decoded_err_packet.encode()[32..]);
657 decoded_err_packet.hmac = Hmac::from_engine(hmac).to_byte_array();
658 msg.reason = onion_utils::encrypt_failure_packet(
659 &onion_keys[1].shared_secret.as_ref(), &decoded_err_packet.encode()[..])
660 }, || nodes[2].node.fail_htlc_backwards(&payment_hash), false, None,
661 Some(NetworkUpdate::NodeFailure { node_id: route.paths[0].hops[1].pubkey, is_permanent: true }),
662 Some(channels[1].0.contents.short_channel_id));
663 run_onion_failure_test_with_fail_intercept("0-length channel update in intermediate node UPDATE onion failure",
664 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
665 msg.amount_msat -= 1;
667 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
668 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
669 let mut decoded_err_packet = msgs::DecodedOnionErrorPacket {
671 0x10, 0x7, // UPDATE|7
672 0x0, 0x0 // 0-len channel update
674 pad: vec![0; 255 - 4 /* 4-byte error message */],
677 let um = onion_utils::gen_um_from_shared_secret(&onion_keys[0].shared_secret.as_ref());
678 let mut hmac = HmacEngine::<Sha256>::new(&um);
679 hmac.input(&decoded_err_packet.encode()[32..]);
680 decoded_err_packet.hmac = Hmac::from_engine(hmac).to_byte_array();
681 msg.reason = onion_utils::encrypt_failure_packet(
682 &onion_keys[0].shared_secret.as_ref(), &decoded_err_packet.encode()[..])
683 }, || {}, true, Some(0x1000|7),
684 Some(NetworkUpdate::ChannelFailure {
685 short_channel_id: channels[1].0.contents.short_channel_id,
688 Some(channels[1].0.contents.short_channel_id));
689 run_onion_failure_test_with_fail_intercept("0-length channel update in final node UPDATE onion failure",
690 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
691 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
692 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
693 let mut decoded_err_packet = msgs::DecodedOnionErrorPacket {
695 0x10, 0x7, // UPDATE|7
696 0x0, 0x0 // 0-len channel update
698 pad: vec![0; 255 - 4 /* 4-byte error message */],
701 let um = onion_utils::gen_um_from_shared_secret(&onion_keys[1].shared_secret.as_ref());
702 let mut hmac = HmacEngine::<Sha256>::new(&um);
703 hmac.input(&decoded_err_packet.encode()[32..]);
704 decoded_err_packet.hmac = Hmac::from_engine(hmac).to_byte_array();
705 msg.reason = onion_utils::encrypt_failure_packet(
706 &onion_keys[1].shared_secret.as_ref(), &decoded_err_packet.encode()[..])
707 }, || nodes[2].node.fail_htlc_backwards(&payment_hash), true, Some(0x1000|7),
708 Some(NetworkUpdate::ChannelFailure {
709 short_channel_id: channels[1].0.contents.short_channel_id,
712 Some(channels[1].0.contents.short_channel_id));
716 fn test_overshoot_final_cltv() {
717 let chanmon_cfgs = create_chanmon_cfgs(3);
718 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
719 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None; 3]);
720 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
721 create_announced_chan_between_nodes(&nodes, 0, 1);
722 create_announced_chan_between_nodes(&nodes, 1, 2);
723 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
725 let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
726 nodes[0].node.send_payment_with_route(&route, payment_hash, RecipientOnionFields::secret_only(payment_secret), payment_id).unwrap();
728 check_added_monitors!(nodes[0], 1);
729 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
730 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
731 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
732 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
734 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
735 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
736 for f in pending_forwards.iter_mut() {
738 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
739 forward_info.outgoing_cltv_value += 1,
744 expect_pending_htlcs_forwardable!(nodes[1]);
746 check_added_monitors!(&nodes[1], 1);
747 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
748 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
749 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
750 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
752 expect_pending_htlcs_forwardable!(nodes[2]);
753 expect_payment_claimable!(nodes[2], payment_hash, payment_secret, 40_000);
754 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
757 fn do_test_onion_failure_stale_channel_update(announced_channel: bool) {
758 // Create a network of three nodes and two channels connecting them. We'll be updating the
759 // HTLC relay policy of the second channel, causing forwarding failures at the first hop.
760 let mut config = UserConfig::default();
761 config.channel_handshake_config.announced_channel = announced_channel;
762 config.channel_handshake_limits.force_announced_channel_preference = false;
763 config.accept_forwards_to_priv_channels = !announced_channel;
764 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
765 let chanmon_cfgs = create_chanmon_cfgs(3);
766 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
769 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]);
770 let channel_manager_1_deserialized;
771 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
773 let other_channel = create_chan_between_nodes(
774 &nodes[0], &nodes[1],
776 let channel_to_update = if announced_channel {
777 let channel = create_announced_chan_between_nodes(
780 (channel.2, channel.0.contents.short_channel_id)
782 let channel = create_unannounced_chan_between_nodes_with_value(
783 &nodes, 1, 2, 100000, 10001,
785 (channel.0.channel_id, channel.0.short_channel_id_alias.unwrap())
787 let channel_to_update_counterparty = &nodes[2].node.get_our_node_id();
789 let default_config = ChannelConfig::default();
791 // A test payment should succeed as the ChannelConfig has not been changed yet.
792 const PAYMENT_AMT: u64 = 40000;
793 let (route, payment_hash, payment_preimage, payment_secret) = if announced_channel {
794 get_route_and_payment_hash!(nodes[0], nodes[2], PAYMENT_AMT)
796 let hop_hints = vec![RouteHint(vec![RouteHintHop {
797 src_node_id: nodes[1].node.get_our_node_id(),
798 short_channel_id: channel_to_update.1,
800 base_msat: default_config.forwarding_fee_base_msat,
801 proportional_millionths: default_config.forwarding_fee_proportional_millionths,
803 cltv_expiry_delta: default_config.cltv_expiry_delta,
804 htlc_maximum_msat: None,
805 htlc_minimum_msat: None,
807 let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty, TEST_FINAL_CLTV)
808 .with_bolt11_features(nodes[2].node.bolt11_invoice_features()).unwrap()
809 .with_route_hints(hop_hints).unwrap();
810 get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT)
812 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
813 payment_hash, payment_secret);
814 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
816 // Closure to force expiry of a channel's previous config.
817 let expire_prev_config = || {
818 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
819 nodes[1].node.timer_tick_occurred();
823 // Closure to update and retrieve the latest ChannelUpdate.
824 let update_and_get_channel_update = |config: &ChannelConfig, expect_new_update: bool,
825 prev_update: Option<&msgs::ChannelUpdate>, should_expire_prev_config: bool| -> Option<msgs::ChannelUpdate> {
826 nodes[1].node.update_channel_config(
827 channel_to_update_counterparty, &[channel_to_update.0], config,
829 let events = nodes[1].node.get_and_clear_pending_msg_events();
830 assert_eq!(events.len(), expect_new_update as usize);
831 if !expect_new_update {
834 let new_update = match &events[0] {
835 MessageSendEvent::BroadcastChannelUpdate { msg } => {
836 assert!(announced_channel);
839 MessageSendEvent::SendChannelUpdate { node_id, msg } => {
840 assert_eq!(node_id, channel_to_update_counterparty);
841 assert!(!announced_channel);
844 _ => panic!("expected Broadcast/SendChannelUpdate event"),
846 if prev_update.is_some() {
847 assert!(new_update.contents.timestamp > prev_update.unwrap().contents.timestamp)
849 if should_expire_prev_config {
850 expire_prev_config();
855 // We'll be attempting to route payments using the default ChannelUpdate for channels. This will
856 // lead to onion failures at the first hop once we update the ChannelConfig for the
858 let expect_onion_failure = |name: &str, error_code: u16| {
859 let short_channel_id = channel_to_update.1;
860 let network_update = NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: false };
861 run_onion_failure_test(
862 name, 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {}, true,
863 Some(error_code), Some(network_update), Some(short_channel_id),
867 // Updates to cltv_expiry_delta below MIN_CLTV_EXPIRY_DELTA should fail with APIMisuseError.
868 let mut invalid_config = default_config.clone();
869 invalid_config.cltv_expiry_delta = 0;
870 match nodes[1].node.update_channel_config(
871 channel_to_update_counterparty, &[channel_to_update.0], &invalid_config,
873 Err(APIError::APIMisuseError{ .. }) => {},
874 _ => panic!("unexpected result applying invalid cltv_expiry_delta"),
877 // Increase the base fee which should trigger a new ChannelUpdate.
878 let mut config = nodes[1].node.list_usable_channels().iter()
879 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
881 config.forwarding_fee_base_msat = u32::max_value();
882 let msg = update_and_get_channel_update(&config, true, None, false).unwrap();
884 // The old policy should still be in effect until a new block is connected.
885 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
886 payment_hash, payment_secret);
887 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
889 // Connect a block, which should expire the previous config, leading to a failure when
890 // forwarding the HTLC.
891 expire_prev_config();
892 expect_onion_failure("fee_insufficient", UPDATE|12);
894 // Redundant updates should not trigger a new ChannelUpdate.
895 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
897 // Similarly, updates that do not have an affect on ChannelUpdate should not trigger a new one.
898 config.force_close_avoidance_max_fee_satoshis *= 2;
899 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
901 // Reset the base fee to the default and increase the proportional fee which should trigger a
902 // new ChannelUpdate.
903 config.forwarding_fee_base_msat = default_config.forwarding_fee_base_msat;
904 config.cltv_expiry_delta = u16::max_value();
905 assert!(update_and_get_channel_update(&config, true, Some(&msg), true).is_some());
906 expect_onion_failure("incorrect_cltv_expiry", UPDATE|13);
908 // Reset the proportional fee and increase the CLTV expiry delta which should trigger a new
910 config.cltv_expiry_delta = default_config.cltv_expiry_delta;
911 config.forwarding_fee_proportional_millionths = u32::max_value();
912 assert!(update_and_get_channel_update(&config, true, Some(&msg), true).is_some());
913 expect_onion_failure("fee_insufficient", UPDATE|12);
915 // To test persistence of the updated config, we'll re-initialize the ChannelManager.
916 let config_after_restart = {
917 let chan_1_monitor_serialized = get_monitor!(nodes[1], other_channel.3).encode();
918 let chan_2_monitor_serialized = get_monitor!(nodes[1], channel_to_update.0).encode();
919 reload_node!(nodes[1], *nodes[1].node.get_current_default_configuration(), &nodes[1].node.encode(),
920 &[&chan_1_monitor_serialized, &chan_2_monitor_serialized], persister, chain_monitor, channel_manager_1_deserialized);
921 nodes[1].node.list_channels().iter()
922 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
925 assert_eq!(config, config_after_restart);
929 fn test_onion_failure_stale_channel_update() {
930 do_test_onion_failure_stale_channel_update(false);
931 do_test_onion_failure_stale_channel_update(true);
935 fn test_always_create_tlv_format_onion_payloads() {
936 // Verify that we always generate tlv onion format payloads, even if the features specifically
937 // specifies no support for variable length onions, as the legacy payload format has been
938 // deprecated in BOLT4.
939 let chanmon_cfgs = create_chanmon_cfgs(3);
940 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
942 // Set `node[1]`'s init features to features which return `false` for
943 // `supports_variable_length_onion()`
944 let mut no_variable_length_onion_features = InitFeatures::empty();
945 no_variable_length_onion_features.set_static_remote_key_required();
946 *node_cfgs[1].override_init_features.borrow_mut() = Some(no_variable_length_onion_features);
948 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
949 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
951 create_announced_chan_between_nodes(&nodes, 0, 1);
952 create_announced_chan_between_nodes(&nodes, 1, 2);
954 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
955 .with_bolt11_features(Bolt11InvoiceFeatures::empty()).unwrap();
956 let (route, _payment_hash, _payment_preimage, _payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, 40000);
958 let hops = &route.paths[0].hops;
959 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
960 assert!(!hops[0].node_features.supports_variable_length_onion());
961 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
962 assert!(!hops[1].node_features.supports_variable_length_onion());
964 let cur_height = nodes[0].best_block_info().1 + 1;
965 let recipient_onion_fields = RecipientOnionFields::spontaneous_empty();
966 let (onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
967 &route.paths[0], 40000, &recipient_onion_fields, cur_height, &None).unwrap();
969 match onion_payloads[0] {
970 msgs::OutboundOnionPayload::Forward {..} => {},
972 "Should have generated a `msgs::OnionHopDataFormat::NonFinalNode` payload for `hops[0]`,
973 despite that the features signals no support for variable length onions"
976 match onion_payloads[1] {
977 msgs::OutboundOnionPayload::Receive {..} => {},
979 "Should have generated a `msgs::OnionHopDataFormat::FinalNode` payload for `hops[1]`,
980 despite that the features signals no support for variable length onions"
986 fn test_trampoline_onion_payload_serialization() {
987 // As per https://github.com/lightning/bolts/blob/c01d2e6267d4a8d1095f0f1188970055a9a22d29/bolt04/trampoline-payment-onion-test.json#L3
988 let trampoline_payload = OutboundTrampolinePayload::Forward {
989 amt_to_forward: 100000000,
990 outgoing_cltv_value: 800000,
991 outgoing_node_id: PublicKey::from_slice(&<Vec<u8>>::from_hex("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()).unwrap(),
994 let slice_to_hex = |slice: &[u8]| {
996 .map(|b| format!("{:02x}", b).to_string())
1000 let carol_payload_hex = slice_to_hex(&trampoline_payload.encode());
1001 assert_eq!(carol_payload_hex, "2e020405f5e10004030c35000e2102edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145");
1004 fn do_test_fail_htlc_backwards_with_reason(failure_code: FailureCode) {
1006 let chanmon_cfgs = create_chanmon_cfgs(2);
1007 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1008 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1009 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1011 create_announced_chan_between_nodes(&nodes, 0, 1);
1013 let payment_amount = 100_000;
1014 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_amount);
1015 nodes[0].node.send_payment_with_route(&route, payment_hash,
1016 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1017 check_added_monitors!(nodes[0], 1);
1019 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1020 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
1021 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1022 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1024 expect_pending_htlcs_forwardable!(nodes[1]);
1025 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, payment_amount);
1026 nodes[1].node.fail_htlc_backwards_with_reason(&payment_hash, failure_code);
1028 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash }]);
1029 check_added_monitors!(nodes[1], 1);
1031 let events = nodes[1].node.get_and_clear_pending_msg_events();
1032 assert_eq!(events.len(), 1);
1033 let (update_fail_htlc, commitment_signed) = match events[0] {
1034 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 } } => {
1035 assert!(update_add_htlcs.is_empty());
1036 assert!(update_fulfill_htlcs.is_empty());
1037 assert_eq!(update_fail_htlcs.len(), 1);
1038 assert!(update_fail_malformed_htlcs.is_empty());
1039 assert!(update_fee.is_none());
1040 (update_fail_htlcs[0].clone(), commitment_signed)
1042 _ => panic!("Unexpected event"),
1045 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
1046 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
1048 let failure_data = match failure_code {
1049 FailureCode::TemporaryNodeFailure => vec![],
1050 FailureCode::RequiredNodeFeatureMissing => vec![],
1051 FailureCode::IncorrectOrUnknownPaymentDetails => {
1052 let mut htlc_msat_height_data = (payment_amount as u64).to_be_bytes().to_vec();
1053 htlc_msat_height_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes());
1054 htlc_msat_height_data
1056 FailureCode::InvalidOnionPayload(data) => {
1058 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
1064 let failure_code = failure_code.into();
1065 let permanent_flag = 0x4000;
1066 let permanent_fail = (failure_code & permanent_flag) != 0;
1067 expect_payment_failed!(nodes[0], payment_hash, permanent_fail, failure_code, failure_data);
1072 fn test_fail_htlc_backwards_with_reason() {
1073 do_test_fail_htlc_backwards_with_reason(FailureCode::TemporaryNodeFailure);
1074 do_test_fail_htlc_backwards_with_reason(FailureCode::RequiredNodeFeatureMissing);
1075 do_test_fail_htlc_backwards_with_reason(FailureCode::IncorrectOrUnknownPaymentDetails);
1076 do_test_fail_htlc_backwards_with_reason(FailureCode::InvalidOnionPayload(Some((1 << 16, 42))));
1077 do_test_fail_htlc_backwards_with_reason(FailureCode::InvalidOnionPayload(None));
1080 macro_rules! get_phantom_route {
1081 ($nodes: expr, $amt: expr, $channel: expr) => {{
1082 let phantom_pubkey = $nodes[1].keys_manager.get_node_id(Recipient::PhantomNode).unwrap();
1083 let phantom_route_hint = $nodes[1].node.get_phantom_route_hints();
1084 let payment_params = PaymentParameters::from_node_id(phantom_pubkey, TEST_FINAL_CLTV)
1085 .with_bolt11_features($nodes[1].node.bolt11_invoice_features()).unwrap()
1086 .with_route_hints(vec![RouteHint(vec![
1088 src_node_id: $nodes[0].node.get_our_node_id(),
1089 short_channel_id: $channel.0.contents.short_channel_id,
1091 base_msat: $channel.0.contents.fee_base_msat,
1092 proportional_millionths: $channel.0.contents.fee_proportional_millionths,
1094 cltv_expiry_delta: $channel.0.contents.cltv_expiry_delta,
1095 htlc_minimum_msat: None,
1096 htlc_maximum_msat: None,
1099 src_node_id: phantom_route_hint.real_node_pubkey,
1100 short_channel_id: phantom_route_hint.phantom_scid,
1103 proportional_millionths: 0,
1105 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
1106 htlc_minimum_msat: None,
1107 htlc_maximum_msat: None,
1110 let scorer = test_utils::TestScorer::new();
1111 let network_graph = $nodes[0].network_graph.read_only();
1112 let route_params = RouteParameters::from_payment_params_and_value(payment_params, $amt);
1114 &$nodes[0].node.get_our_node_id(), &route_params, &network_graph,
1115 Some(&$nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
1116 $nodes[0].logger, &scorer, &Default::default(), &[0u8; 32]
1117 ).unwrap(), phantom_route_hint.phantom_scid)
1122 fn test_phantom_onion_hmac_failure() {
1123 let chanmon_cfgs = create_chanmon_cfgs(2);
1124 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1125 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1126 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1128 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1131 let recv_value_msat = 10_000;
1132 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1133 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1135 // Route the HTLC through to the destination.
1136 nodes[0].node.send_payment_with_route(&route, payment_hash,
1137 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1138 check_added_monitors!(nodes[0], 1);
1139 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1140 let mut update_add = update_0.update_add_htlcs[0].clone();
1142 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1143 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1145 // Modify the payload so the phantom hop's HMAC is bogus.
1146 let sha256_of_onion = {
1147 let mut forward_htlcs = nodes[1].node.forward_htlcs.lock().unwrap();
1148 let mut pending_forward = forward_htlcs.get_mut(&phantom_scid).unwrap();
1149 match pending_forward[0] {
1150 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1151 forward_info: PendingHTLCInfo {
1152 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1156 onion_packet.hmac[onion_packet.hmac.len() - 1] ^= 1;
1157 Sha256::hash(&onion_packet.hop_data).to_byte_array().to_vec()
1159 _ => panic!("Unexpected forward"),
1162 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1163 nodes[1].node.process_pending_htlc_forwards();
1164 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1165 nodes[1].node.process_pending_htlc_forwards();
1166 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1167 check_added_monitors!(&nodes[1], 1);
1168 assert!(update_1.update_fail_htlcs.len() == 1);
1169 let fail_msg = update_1.update_fail_htlcs[0].clone();
1170 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1171 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1173 // Ensure the payment fails with the expected error.
1174 let mut fail_conditions = PaymentFailedConditions::new()
1175 .blamed_scid(phantom_scid)
1176 .blamed_chan_closed(true)
1177 .expected_htlc_error_data(0x8000 | 0x4000 | 5, &sha256_of_onion);
1178 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1182 fn test_phantom_invalid_onion_payload() {
1183 let chanmon_cfgs = create_chanmon_cfgs(2);
1184 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1185 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1186 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1188 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1191 let recv_value_msat = 10_000;
1192 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1193 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1195 // We'll use the session priv later when constructing an invalid onion packet.
1196 let session_priv = [3; 32];
1197 *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
1198 nodes[0].node.send_payment_with_route(&route, payment_hash,
1199 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1200 check_added_monitors!(nodes[0], 1);
1201 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1202 let mut update_add = update_0.update_add_htlcs[0].clone();
1204 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1205 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1207 // Modify the onion packet to have an invalid payment amount.
1208 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1209 for f in pending_forwards.iter_mut() {
1211 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1212 forward_info: PendingHTLCInfo {
1213 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1217 // Construct the onion payloads for the entire route and an invalid amount.
1218 let height = nodes[0].best_block_info().1;
1219 let session_priv = SecretKey::from_slice(&session_priv).unwrap();
1220 let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
1221 let recipient_onion_fields = RecipientOnionFields::secret_only(payment_secret);
1222 let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(
1223 &route.paths[0], msgs::MAX_VALUE_MSAT + 1,
1224 &recipient_onion_fields, height + 1, &None).unwrap();
1225 // We only want to construct the onion packet for the last hop, not the entire route, so
1226 // remove the first hop's payload and its keys.
1227 onion_keys.remove(0);
1228 onion_payloads.remove(0);
1230 let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
1231 onion_packet.hop_data = new_onion_packet.hop_data;
1232 onion_packet.hmac = new_onion_packet.hmac;
1234 _ => panic!("Unexpected forward"),
1238 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1239 nodes[1].node.process_pending_htlc_forwards();
1240 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1241 nodes[1].node.process_pending_htlc_forwards();
1242 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1243 check_added_monitors!(&nodes[1], 1);
1244 assert!(update_1.update_fail_htlcs.len() == 1);
1245 let fail_msg = update_1.update_fail_htlcs[0].clone();
1246 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1247 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1249 // Ensure the payment fails with the expected error.
1250 let error_data = Vec::new();
1251 let mut fail_conditions = PaymentFailedConditions::new()
1252 .blamed_scid(phantom_scid)
1253 .blamed_chan_closed(true)
1254 .expected_htlc_error_data(0x4000 | 22, &error_data);
1255 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1259 fn test_phantom_final_incorrect_cltv_expiry() {
1260 let chanmon_cfgs = create_chanmon_cfgs(2);
1261 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1262 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1263 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1265 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1268 let recv_value_msat = 10_000;
1269 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1270 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1272 // Route the HTLC through to the destination.
1273 nodes[0].node.send_payment_with_route(&route, payment_hash,
1274 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1275 check_added_monitors!(nodes[0], 1);
1276 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1277 let mut update_add = update_0.update_add_htlcs[0].clone();
1279 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1280 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1282 // Modify the payload so the phantom hop's HMAC is bogus.
1283 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1284 for f in pending_forwards.iter_mut() {
1286 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1287 forward_info: PendingHTLCInfo { ref mut outgoing_cltv_value, .. }, ..
1289 *outgoing_cltv_value -= 1;
1291 _ => panic!("Unexpected forward"),
1295 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1296 nodes[1].node.process_pending_htlc_forwards();
1297 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1298 nodes[1].node.process_pending_htlc_forwards();
1299 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1300 check_added_monitors!(&nodes[1], 1);
1301 assert!(update_1.update_fail_htlcs.len() == 1);
1302 let fail_msg = update_1.update_fail_htlcs[0].clone();
1303 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1304 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1306 // Ensure the payment fails with the expected error.
1307 let expected_cltv: u32 = 80;
1308 let error_data = expected_cltv.to_be_bytes().to_vec();
1309 let mut fail_conditions = PaymentFailedConditions::new()
1310 .blamed_scid(phantom_scid)
1311 .expected_htlc_error_data(18, &error_data);
1312 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1316 fn test_phantom_failure_too_low_cltv() {
1317 let chanmon_cfgs = create_chanmon_cfgs(2);
1318 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1319 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1320 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1322 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1325 let recv_value_msat = 10_000;
1326 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1327 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1329 // Modify the route to have a too-low cltv.
1330 route.paths[0].hops[1].cltv_expiry_delta = 5;
1332 // Route the HTLC through to the destination.
1333 nodes[0].node.send_payment_with_route(&route, payment_hash,
1334 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1335 check_added_monitors!(nodes[0], 1);
1336 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1337 let mut update_add = update_0.update_add_htlcs[0].clone();
1339 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1340 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1342 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1343 nodes[1].node.process_pending_htlc_forwards();
1344 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1345 nodes[1].node.process_pending_htlc_forwards();
1346 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1347 check_added_monitors!(&nodes[1], 1);
1348 assert!(update_1.update_fail_htlcs.len() == 1);
1349 let fail_msg = update_1.update_fail_htlcs[0].clone();
1350 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1351 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1353 // Ensure the payment fails with the expected error.
1354 let mut error_data = recv_value_msat.to_be_bytes().to_vec();
1355 error_data.extend_from_slice(
1356 &nodes[0].node.best_block.read().unwrap().height.to_be_bytes(),
1358 let mut fail_conditions = PaymentFailedConditions::new()
1359 .blamed_scid(phantom_scid)
1360 .expected_htlc_error_data(0x4000 | 15, &error_data);
1361 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1365 fn test_phantom_failure_modified_cltv() {
1366 // Test that we fail back phantoms if the upstream node fiddled with the CLTV too much with the
1367 // correct error code.
1368 let chanmon_cfgs = create_chanmon_cfgs(2);
1369 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1370 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1371 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1373 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1376 let recv_value_msat = 10_000;
1377 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1378 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1380 // Route the HTLC through to the destination.
1381 nodes[0].node.send_payment_with_route(&route, payment_hash,
1382 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1383 check_added_monitors!(nodes[0], 1);
1384 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1385 let mut update_add = update_0.update_add_htlcs[0].clone();
1387 // Modify the route to have a too-low cltv.
1388 update_add.cltv_expiry -= 10;
1390 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1391 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1393 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1394 assert!(update_1.update_fail_htlcs.len() == 1);
1395 let fail_msg = update_1.update_fail_htlcs[0].clone();
1396 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1397 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1399 // Ensure the payment fails with the expected error.
1400 let mut fail_conditions = PaymentFailedConditions::new()
1401 .blamed_scid(phantom_scid)
1402 .expected_htlc_error_data(0x2000 | 2, &[]);
1403 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1407 fn test_phantom_failure_expires_too_soon() {
1408 // Test that we fail back phantoms if the HTLC got delayed and we got blocks in between with
1409 // the correct error code.
1410 let chanmon_cfgs = create_chanmon_cfgs(2);
1411 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1412 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1413 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1415 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1418 let recv_value_msat = 10_000;
1419 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1420 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1422 // Route the HTLC through to the destination.
1423 nodes[0].node.send_payment_with_route(&route, payment_hash,
1424 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1425 check_added_monitors!(nodes[0], 1);
1426 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1427 let mut update_add = update_0.update_add_htlcs[0].clone();
1429 connect_blocks(&nodes[1], CLTV_FAR_FAR_AWAY);
1430 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1431 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1433 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1434 assert!(update_1.update_fail_htlcs.len() == 1);
1435 let fail_msg = update_1.update_fail_htlcs[0].clone();
1436 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1437 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1439 // Ensure the payment fails with the expected error.
1440 let mut fail_conditions = PaymentFailedConditions::new()
1441 .blamed_scid(phantom_scid)
1442 .expected_htlc_error_data(0x2000 | 2, &[]);
1443 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1447 fn test_phantom_failure_too_low_recv_amt() {
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, None]);
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 a too-low amount.
1456 let recv_amt_msat = 10_000;
1457 let bad_recv_amt_msat = recv_amt_msat - 10;
1458 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1459 let (mut route, phantom_scid) = get_phantom_route!(nodes, bad_recv_amt_msat, channel);
1461 // Route the HTLC through to the destination.
1462 nodes[0].node.send_payment_with_route(&route, payment_hash,
1463 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1464 check_added_monitors!(nodes[0], 1);
1465 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1466 let mut update_add = update_0.update_add_htlcs[0].clone();
1468 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1469 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1471 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1472 nodes[1].node.process_pending_htlc_forwards();
1473 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1474 nodes[1].node.process_pending_htlc_forwards();
1475 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
1476 nodes[1].node.process_pending_htlc_forwards();
1477 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1478 check_added_monitors!(&nodes[1], 1);
1479 assert!(update_1.update_fail_htlcs.len() == 1);
1480 let fail_msg = update_1.update_fail_htlcs[0].clone();
1481 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1482 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1484 // Ensure the payment fails with the expected error.
1485 let mut error_data = bad_recv_amt_msat.to_be_bytes().to_vec();
1486 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height.to_be_bytes());
1487 let mut fail_conditions = PaymentFailedConditions::new()
1488 .blamed_scid(phantom_scid)
1489 .expected_htlc_error_data(0x4000 | 15, &error_data);
1490 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1494 fn test_phantom_dust_exposure_failure() {
1495 do_test_phantom_dust_exposure_failure(false);
1496 do_test_phantom_dust_exposure_failure(true);
1499 fn do_test_phantom_dust_exposure_failure(multiplier_dust_limit: bool) {
1500 // Set the max dust exposure to the dust limit.
1501 let max_dust_exposure = 546;
1502 let mut receiver_config = UserConfig::default();
1503 // Default test fee estimator rate is 253, so to set the max dust exposure to the dust limit,
1504 // we need to set the multiplier to 2.
1505 receiver_config.channel_config.max_dust_htlc_exposure =
1506 if multiplier_dust_limit { MaxDustHTLCExposure::FeeRateMultiplier(2) }
1507 else { MaxDustHTLCExposure::FixedLimitMsat(max_dust_exposure) };
1508 receiver_config.channel_handshake_config.announced_channel = true;
1510 let chanmon_cfgs = create_chanmon_cfgs(2);
1511 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1512 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(receiver_config)]);
1513 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1515 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1517 // Get the route with an amount exceeding the dust exposure threshold of nodes[1].
1518 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(max_dust_exposure + 1));
1519 let (mut route, _) = get_phantom_route!(nodes, max_dust_exposure + 1, channel);
1521 // Route the HTLC through to the destination.
1522 nodes[0].node.send_payment_with_route(&route, payment_hash,
1523 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1524 check_added_monitors!(nodes[0], 1);
1525 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1526 let mut update_add = update_0.update_add_htlcs[0].clone();
1528 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1529 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1531 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1532 assert!(update_1.update_fail_htlcs.len() == 1);
1533 let fail_msg = update_1.update_fail_htlcs[0].clone();
1534 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1535 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1537 // Ensure the payment fails with the expected error.
1538 let mut err_data = Vec::new();
1539 err_data.extend_from_slice(&(channel.1.serialized_length() as u16 + 2).to_be_bytes());
1540 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
1541 err_data.extend_from_slice(&channel.1.encode());
1543 let mut fail_conditions = PaymentFailedConditions::new()
1544 .blamed_scid(route.paths[0].hops.last().as_ref().unwrap().short_channel_id)
1545 .blamed_chan_closed(false)
1546 .expected_htlc_error_data(0x1000 | 7, &err_data);
1547 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1551 fn test_phantom_failure_reject_payment() {
1552 // Test that the user can successfully fail back a phantom node payment.
1553 let chanmon_cfgs = create_chanmon_cfgs(2);
1554 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1555 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1556 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1558 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1560 // Get the route with a too-low amount.
1561 let recv_amt_msat = 10_000;
1562 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1563 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_amt_msat, channel);
1565 // Route the HTLC through to the destination.
1566 nodes[0].node.send_payment_with_route(&route, payment_hash,
1567 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1568 check_added_monitors!(nodes[0], 1);
1569 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1570 let mut update_add = update_0.update_add_htlcs[0].clone();
1572 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1573 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1575 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1576 nodes[1].node.process_pending_htlc_forwards();
1577 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1578 nodes[1].node.process_pending_htlc_forwards();
1579 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, recv_amt_msat, None, route.paths[0].hops.last().unwrap().pubkey);
1580 nodes[1].node.fail_htlc_backwards(&payment_hash);
1581 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1582 nodes[1].node.process_pending_htlc_forwards();
1584 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1585 check_added_monitors!(&nodes[1], 1);
1586 assert!(update_1.update_fail_htlcs.len() == 1);
1587 let fail_msg = update_1.update_fail_htlcs[0].clone();
1588 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1589 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1591 // Ensure the payment fails with the expected error.
1592 let mut error_data = recv_amt_msat.to_be_bytes().to_vec();
1593 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height.to_be_bytes());
1594 let mut fail_conditions = PaymentFailedConditions::new()
1595 .blamed_scid(phantom_scid)
1596 .expected_htlc_error_data(0x4000 | 15, &error_data);
1597 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);