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::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::hash_types::BlockHash;
238 use bitcoin::secp256k1::ffi::Signature as FFISignature;
239 use bitcoin::secp256k1::ecdsa::Signature;
240 msgs::ChannelUpdate {
241 signature: Signature::from(unsafe { FFISignature::new() }),
242 contents: msgs::UnsignedChannelUpdate {
243 chain_hash: ChainHash::from(BlockHash::hash(&vec![0u8][..]).as_ref()),
247 cltv_expiry_delta: 0,
248 htlc_minimum_msat: 0,
249 htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
251 fee_proportional_millionths: 0,
258 struct BogusOnionHopData {
261 impl BogusOnionHopData {
262 fn new(orig: msgs::OutboundOnionPayload) -> Self {
263 Self { data: orig.encode() }
266 impl Writeable for BogusOnionHopData {
267 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
268 writer.write_all(&self.data[..])
272 const BADONION: u16 = 0x8000;
273 const PERM: u16 = 0x4000;
274 const NODE: u16 = 0x2000;
275 const UPDATE: u16 = 0x1000;
278 fn test_fee_failures() {
279 // Tests that the fee required when forwarding remains consistent over time. This was
280 // previously broken, with forwarding fees floating based on the fee estimator at the time of
283 // When this test was written, the default base fee floated based on the HTLC count.
284 // It is now fixed, so we simply set the fee to the expected value here.
285 let mut config = test_default_channel_config();
286 config.channel_config.forwarding_fee_base_msat = 196;
288 let chanmon_cfgs = create_chanmon_cfgs(3);
289 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
290 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
291 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
292 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
295 let (route, payment_hash_success, payment_preimage_success, payment_secret_success) = get_route_and_payment_hash!(nodes[0], nodes[2], 40_000);
296 nodes[0].node.send_payment_with_route(&route, payment_hash_success,
297 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
298 check_added_monitors!(nodes[0], 1);
299 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
300 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
302 // If the hop gives fee_insufficient but enough fees were provided, then the previous hop
303 // malleated the payment before forwarding, taking funds when they shouldn't have.
304 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
305 let short_channel_id = channels[0].0.contents.short_channel_id;
306 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
307 msg.amount_msat -= 1;
308 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
310 // In an earlier version, we spuriously failed to forward payments if the expected feerate
311 // changed between the channel open and the payment.
313 let mut feerate_lock = chanmon_cfgs[1].fee_estimator.sat_per_kw.lock().unwrap();
317 let (payment_preimage_success, payment_hash_success, payment_secret_success) = get_payment_preimage_hash!(nodes[2]);
318 nodes[0].node.send_payment_with_route(&route, payment_hash_success,
319 RecipientOnionFields::secret_only(payment_secret_success), PaymentId(payment_hash_success.0)).unwrap();
320 check_added_monitors!(nodes[0], 1);
321 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], 40_000, payment_hash_success, payment_secret_success);
322 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_success);
326 fn test_onion_failure() {
327 // When we check for amount_below_minimum below, we want to test that we're using the *right*
328 // amount, thus we need different htlc_minimum_msat values. We set node[2]'s htlc_minimum_msat
329 // to 2000, which is above the default value of 1000 set in create_node_chanmgrs.
330 // This exposed a previous bug because we were using the wrong value all the way down in
331 // Channel::get_counterparty_htlc_minimum_msat().
332 let mut node_2_cfg: UserConfig = test_default_channel_config();
333 node_2_cfg.channel_handshake_config.our_htlc_minimum_msat = 2000;
334 node_2_cfg.channel_handshake_config.announced_channel = true;
335 node_2_cfg.channel_handshake_limits.force_announced_channel_preference = false;
337 // When this test was written, the default base fee floated based on the HTLC count.
338 // It is now fixed, so we simply set the fee to the expected value here.
339 let mut config = test_default_channel_config();
340 config.channel_config.forwarding_fee_base_msat = 196;
342 let chanmon_cfgs = create_chanmon_cfgs(3);
343 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
344 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(node_2_cfg)]);
345 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
346 let channels = [create_announced_chan_between_nodes(&nodes, 0, 1), create_announced_chan_between_nodes(&nodes, 1, 2)];
347 for node in nodes.iter() {
348 *node.keys_manager.override_random_bytes.lock().unwrap() = Some([3; 32]);
350 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
352 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000);
354 // intermediate node failure
355 let short_channel_id = channels[1].0.contents.short_channel_id;
356 run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
357 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
358 let cur_height = nodes[0].best_block_info().1 + 1;
359 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
360 let recipient_onion_fields = RecipientOnionFields::spontaneous_empty();
361 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
362 &route.paths[0], 40000, &recipient_onion_fields, cur_height, &None).unwrap();
363 let mut new_payloads = Vec::new();
364 for payload in onion_payloads.drain(..) {
365 new_payloads.push(BogusOnionHopData::new(payload));
367 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
368 // describing a length-1 TLV payload, which is obviously bogus.
369 new_payloads[0].data[0] = 1;
370 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
371 }, ||{}, true, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
373 // final node failure
374 let short_channel_id = channels[1].0.contents.short_channel_id;
375 run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, &payment_secret, |msg| {
376 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
377 let cur_height = nodes[0].best_block_info().1 + 1;
378 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
379 let recipient_onion_fields = RecipientOnionFields::spontaneous_empty();
380 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
381 &route.paths[0], 40000, &recipient_onion_fields, cur_height, &None).unwrap();
382 let mut new_payloads = Vec::new();
383 for payload in onion_payloads.drain(..) {
384 new_payloads.push(BogusOnionHopData::new(payload));
386 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
387 // length-1 TLV payload, which is obviously bogus.
388 new_payloads[1].data[0] = 1;
389 msg.onion_routing_packet = onion_utils::construct_onion_packet_with_writable_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
390 }, ||{}, false, Some(PERM|22), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
392 // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
393 // receiving simulated fail messages
394 // intermediate node failure
395 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
397 msg.amount_msat -= 1;
399 // and tamper returning error message
400 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
401 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
402 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), NODE|2, &[0;0]);
403 }, ||{}, 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));
405 // final node failure
406 run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
407 // and tamper returning error message
408 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
409 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
410 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), NODE|2, &[0;0]);
412 nodes[2].node.fail_htlc_backwards(&payment_hash);
413 }, 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));
414 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
416 // intermediate node failure
417 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
418 msg.amount_msat -= 1;
420 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
421 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
422 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
423 }, ||{}, 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));
425 // final node failure
426 run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
427 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
428 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
429 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|2, &[0;0]);
431 nodes[2].node.fail_htlc_backwards(&payment_hash);
432 }, 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));
433 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
435 // intermediate node failure
436 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
437 msg.amount_msat -= 1;
439 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
440 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
441 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
443 nodes[2].node.fail_htlc_backwards(&payment_hash);
444 }, 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));
446 // final node failure
447 run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
448 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
449 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
450 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), PERM|NODE|3, &[0;0]);
452 nodes[2].node.fail_htlc_backwards(&payment_hash);
453 }, 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));
454 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
456 // Our immediate peer sent UpdateFailMalformedHTLC because it couldn't understand the onion in
457 // the UpdateAddHTLC that we sent.
458 let short_channel_id = channels[0].0.contents.short_channel_id;
459 run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
460 Some(BADONION|PERM|4), None, Some(short_channel_id));
462 run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
463 Some(BADONION|PERM|5), None, Some(short_channel_id));
465 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,
466 Some(BADONION|PERM|6), None, Some(short_channel_id));
468 let short_channel_id = channels[1].0.contents.short_channel_id;
469 let chan_update = ChannelUpdate::dummy(short_channel_id);
471 let mut err_data = Vec::new();
472 err_data.extend_from_slice(&(chan_update.serialized_length() as u16 + 2).to_be_bytes());
473 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
474 err_data.extend_from_slice(&chan_update.encode());
475 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
476 msg.amount_msat -= 1;
478 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
479 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
480 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data);
481 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update.clone()}), Some(short_channel_id));
483 // Check we can still handle onion failures that include channel updates without a type prefix
484 let err_data_without_type = chan_update.encode_with_len();
485 run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
486 msg.amount_msat -= 1;
488 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
489 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
490 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), UPDATE|7, &err_data_without_type);
491 }, ||{}, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: chan_update}), Some(short_channel_id));
493 let short_channel_id = channels[1].0.contents.short_channel_id;
494 run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
495 msg.amount_msat -= 1;
497 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
498 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
499 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|8, &[0;0]);
500 // short_channel_id from the processing node
501 }, ||{}, true, Some(PERM|8), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
503 let short_channel_id = channels[1].0.contents.short_channel_id;
504 run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
505 msg.amount_msat -= 1;
507 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
508 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
509 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[0].shared_secret.as_ref(), PERM|9, &[0;0]);
510 // short_channel_id from the processing node
511 }, ||{}, true, Some(PERM|9), Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent: true}), Some(short_channel_id));
513 let mut bogus_route = route.clone();
514 bogus_route.paths[0].hops[1].short_channel_id -= 1;
515 let short_channel_id = bogus_route.paths[0].hops[1].short_channel_id;
516 run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, &payment_secret, |_| {}, ||{}, true, Some(PERM|10),
517 Some(NetworkUpdate::ChannelFailure{short_channel_id, is_permanent:true}), Some(short_channel_id));
519 let short_channel_id = channels[1].0.contents.short_channel_id;
520 let amt_to_forward = nodes[1].node.per_peer_state.read().unwrap().get(&nodes[2].node.get_our_node_id())
521 .unwrap().lock().unwrap().channel_by_id.get(&channels[1].2).unwrap()
522 .context().get_counterparty_htlc_minimum_msat() - 1;
523 let mut bogus_route = route.clone();
524 let route_len = bogus_route.paths[0].hops.len();
525 bogus_route.paths[0].hops[route_len-1].fee_msat = amt_to_forward;
526 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));
528 // Clear pending payments so that the following positive test has the correct payment hash.
529 for node in nodes.iter() {
530 node.node.clear_pending_payments();
533 // Test a positive test-case with one extra msat, meeting the minimum.
534 bogus_route.paths[0].hops[route_len-1].fee_msat = amt_to_forward + 1;
535 let preimage = send_along_route(&nodes[0], bogus_route, &[&nodes[1], &nodes[2]], amt_to_forward+1).0;
536 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], preimage);
538 let short_channel_id = channels[0].0.contents.short_channel_id;
539 run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
540 msg.amount_msat -= 1;
541 }, || {}, true, Some(UPDATE|12), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
543 let short_channel_id = channels[0].0.contents.short_channel_id;
544 run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
545 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
546 msg.cltv_expiry -= 1;
547 }, || {}, true, Some(UPDATE|13), Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent: true}), Some(short_channel_id));
549 let short_channel_id = channels[1].0.contents.short_channel_id;
550 run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
551 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
552 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
553 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
554 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
555 }, ||{}, true, Some(UPDATE|14), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
557 run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
558 nodes[2].node.fail_htlc_backwards(&payment_hash);
559 }, false, Some(PERM|15), None, None);
560 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[2]);
562 run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, &payment_secret, |msg| {
563 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
564 connect_blocks(&nodes[0], height - nodes[0].best_block_info().1);
565 connect_blocks(&nodes[1], height - nodes[1].best_block_info().1);
566 connect_blocks(&nodes[2], height - nodes[2].best_block_info().1);
567 }, || {}, false, Some(0x4000 | 15), None, None);
569 run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
570 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
571 for f in pending_forwards.iter_mut() {
573 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
574 forward_info.outgoing_cltv_value -= 1,
579 }, true, Some(18), None, Some(channels[1].0.contents.short_channel_id));
581 run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
582 // violate amt_to_forward > msg.amount_msat
583 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
584 for f in pending_forwards.iter_mut() {
586 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
587 forward_info.outgoing_amt_msat -= 1,
592 }, true, Some(19), None, Some(channels[1].0.contents.short_channel_id));
594 let short_channel_id = channels[1].0.contents.short_channel_id;
595 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
596 // disconnect event to the channel between nodes[1] ~ nodes[2]
597 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
598 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
599 }, true, Some(UPDATE|7), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
600 run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {
601 // disconnect event to the channel between nodes[1] ~ nodes[2]
602 for _ in 0..DISABLE_GOSSIP_TICKS + 1 {
603 nodes[1].node.timer_tick_occurred();
604 nodes[2].node.timer_tick_occurred();
606 nodes[1].node.get_and_clear_pending_msg_events();
607 nodes[2].node.get_and_clear_pending_msg_events();
608 }, true, Some(UPDATE|20), Some(NetworkUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy(short_channel_id)}), Some(short_channel_id));
609 reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[2]));
611 run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, &payment_secret, |msg| {
612 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
613 let mut route = route.clone();
614 let height = nodes[2].best_block_info().1;
615 route.paths[0].hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0].hops[0].cltv_expiry_delta + 1;
616 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
617 let recipient_onion_fields = RecipientOnionFields::spontaneous_empty();
618 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(
619 &route.paths[0], 40000, &recipient_onion_fields, height, &None).unwrap();
620 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
621 msg.cltv_expiry = htlc_cltv;
622 msg.onion_routing_packet = onion_packet;
623 }, ||{}, 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));
625 run_onion_failure_test_with_fail_intercept("mpp_timeout", 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
626 // Tamper returning error message
627 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
628 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
629 msg.reason = onion_utils::build_first_hop_failure_packet(onion_keys[1].shared_secret.as_ref(), 23, &[0;0]);
631 nodes[2].node.fail_htlc_backwards(&payment_hash);
632 }, true, Some(23), None, None);
634 run_onion_failure_test_with_fail_intercept("bogus err packet with valid hmac", 200, &nodes,
635 &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
636 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
637 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
638 let mut decoded_err_packet = msgs::DecodedOnionErrorPacket {
643 let um = onion_utils::gen_um_from_shared_secret(&onion_keys[1].shared_secret.as_ref());
644 let mut hmac = HmacEngine::<Sha256>::new(&um);
645 hmac.input(&decoded_err_packet.encode()[32..]);
646 decoded_err_packet.hmac = Hmac::from_engine(hmac).to_byte_array();
647 msg.reason = onion_utils::encrypt_failure_packet(
648 &onion_keys[1].shared_secret.as_ref(), &decoded_err_packet.encode()[..])
649 }, || nodes[2].node.fail_htlc_backwards(&payment_hash), false, None,
650 Some(NetworkUpdate::NodeFailure { node_id: route.paths[0].hops[1].pubkey, is_permanent: true }),
651 Some(channels[1].0.contents.short_channel_id));
652 run_onion_failure_test_with_fail_intercept("0-length channel update in intermediate node UPDATE onion failure",
653 100, &nodes, &route, &payment_hash, &payment_secret, |msg| {
654 msg.amount_msat -= 1;
656 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
657 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
658 let mut decoded_err_packet = msgs::DecodedOnionErrorPacket {
660 0x10, 0x7, // UPDATE|7
661 0x0, 0x0 // 0-len channel update
663 pad: vec![0; 255 - 4 /* 4-byte error message */],
666 let um = onion_utils::gen_um_from_shared_secret(&onion_keys[0].shared_secret.as_ref());
667 let mut hmac = HmacEngine::<Sha256>::new(&um);
668 hmac.input(&decoded_err_packet.encode()[32..]);
669 decoded_err_packet.hmac = Hmac::from_engine(hmac).to_byte_array();
670 msg.reason = onion_utils::encrypt_failure_packet(
671 &onion_keys[0].shared_secret.as_ref(), &decoded_err_packet.encode()[..])
672 }, || {}, true, Some(0x1000|7),
673 Some(NetworkUpdate::ChannelFailure {
674 short_channel_id: channels[1].0.contents.short_channel_id,
677 Some(channels[1].0.contents.short_channel_id));
678 run_onion_failure_test_with_fail_intercept("0-length channel update in final node UPDATE onion failure",
679 200, &nodes, &route, &payment_hash, &payment_secret, |_msg| {}, |msg| {
680 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
681 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
682 let mut decoded_err_packet = msgs::DecodedOnionErrorPacket {
684 0x10, 0x7, // UPDATE|7
685 0x0, 0x0 // 0-len channel update
687 pad: vec![0; 255 - 4 /* 4-byte error message */],
690 let um = onion_utils::gen_um_from_shared_secret(&onion_keys[1].shared_secret.as_ref());
691 let mut hmac = HmacEngine::<Sha256>::new(&um);
692 hmac.input(&decoded_err_packet.encode()[32..]);
693 decoded_err_packet.hmac = Hmac::from_engine(hmac).to_byte_array();
694 msg.reason = onion_utils::encrypt_failure_packet(
695 &onion_keys[1].shared_secret.as_ref(), &decoded_err_packet.encode()[..])
696 }, || nodes[2].node.fail_htlc_backwards(&payment_hash), true, Some(0x1000|7),
697 Some(NetworkUpdate::ChannelFailure {
698 short_channel_id: channels[1].0.contents.short_channel_id,
701 Some(channels[1].0.contents.short_channel_id));
705 fn test_overshoot_final_cltv() {
706 let chanmon_cfgs = create_chanmon_cfgs(3);
707 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
708 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None; 3]);
709 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
710 create_announced_chan_between_nodes(&nodes, 0, 1);
711 create_announced_chan_between_nodes(&nodes, 1, 2);
712 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 40000);
714 let payment_id = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
715 nodes[0].node.send_payment_with_route(&route, payment_hash, RecipientOnionFields::secret_only(payment_secret), payment_id).unwrap();
717 check_added_monitors!(nodes[0], 1);
718 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
719 let mut update_add_0 = update_0.update_add_htlcs[0].clone();
720 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
721 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
723 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
724 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
725 for f in pending_forwards.iter_mut() {
727 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) =>
728 forward_info.outgoing_cltv_value += 1,
733 expect_pending_htlcs_forwardable!(nodes[1]);
735 check_added_monitors!(&nodes[1], 1);
736 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
737 let mut update_add_1 = update_1.update_add_htlcs[0].clone();
738 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
739 commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
741 expect_pending_htlcs_forwardable!(nodes[2]);
742 expect_payment_claimable!(nodes[2], payment_hash, payment_secret, 40_000);
743 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
746 fn do_test_onion_failure_stale_channel_update(announced_channel: bool) {
747 // Create a network of three nodes and two channels connecting them. We'll be updating the
748 // HTLC relay policy of the second channel, causing forwarding failures at the first hop.
749 let mut config = UserConfig::default();
750 config.channel_handshake_config.announced_channel = announced_channel;
751 config.channel_handshake_limits.force_announced_channel_preference = false;
752 config.accept_forwards_to_priv_channels = !announced_channel;
753 config.channel_config.max_dust_htlc_exposure = MaxDustHTLCExposure::FeeRateMultiplier(5_000_000 / 253);
754 let chanmon_cfgs = create_chanmon_cfgs(3);
755 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
758 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(config), None]);
759 let channel_manager_1_deserialized;
760 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
762 let other_channel = create_chan_between_nodes(
763 &nodes[0], &nodes[1],
765 let channel_to_update = if announced_channel {
766 let channel = create_announced_chan_between_nodes(
769 (channel.2, channel.0.contents.short_channel_id)
771 let channel = create_unannounced_chan_between_nodes_with_value(
772 &nodes, 1, 2, 100000, 10001,
774 (channel.0.channel_id, channel.0.short_channel_id_alias.unwrap())
776 let channel_to_update_counterparty = &nodes[2].node.get_our_node_id();
778 let default_config = ChannelConfig::default();
780 // A test payment should succeed as the ChannelConfig has not been changed yet.
781 const PAYMENT_AMT: u64 = 40000;
782 let (route, payment_hash, payment_preimage, payment_secret) = if announced_channel {
783 get_route_and_payment_hash!(nodes[0], nodes[2], PAYMENT_AMT)
785 let hop_hints = vec![RouteHint(vec![RouteHintHop {
786 src_node_id: nodes[1].node.get_our_node_id(),
787 short_channel_id: channel_to_update.1,
789 base_msat: default_config.forwarding_fee_base_msat,
790 proportional_millionths: default_config.forwarding_fee_proportional_millionths,
792 cltv_expiry_delta: default_config.cltv_expiry_delta,
793 htlc_maximum_msat: None,
794 htlc_minimum_msat: None,
796 let payment_params = PaymentParameters::from_node_id(*channel_to_update_counterparty, TEST_FINAL_CLTV)
797 .with_bolt11_features(nodes[2].node.bolt11_invoice_features()).unwrap()
798 .with_route_hints(hop_hints).unwrap();
799 get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, PAYMENT_AMT)
801 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
802 payment_hash, payment_secret);
803 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
805 // Closure to force expiry of a channel's previous config.
806 let expire_prev_config = || {
807 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
808 nodes[1].node.timer_tick_occurred();
812 // Closure to update and retrieve the latest ChannelUpdate.
813 let update_and_get_channel_update = |config: &ChannelConfig, expect_new_update: bool,
814 prev_update: Option<&msgs::ChannelUpdate>, should_expire_prev_config: bool| -> Option<msgs::ChannelUpdate> {
815 nodes[1].node.update_channel_config(
816 channel_to_update_counterparty, &[channel_to_update.0], config,
818 let events = nodes[1].node.get_and_clear_pending_msg_events();
819 assert_eq!(events.len(), expect_new_update as usize);
820 if !expect_new_update {
823 let new_update = match &events[0] {
824 MessageSendEvent::BroadcastChannelUpdate { msg } => {
825 assert!(announced_channel);
828 MessageSendEvent::SendChannelUpdate { node_id, msg } => {
829 assert_eq!(node_id, channel_to_update_counterparty);
830 assert!(!announced_channel);
833 _ => panic!("expected Broadcast/SendChannelUpdate event"),
835 if prev_update.is_some() {
836 assert!(new_update.contents.timestamp > prev_update.unwrap().contents.timestamp)
838 if should_expire_prev_config {
839 expire_prev_config();
844 // We'll be attempting to route payments using the default ChannelUpdate for channels. This will
845 // lead to onion failures at the first hop once we update the ChannelConfig for the
847 let expect_onion_failure = |name: &str, error_code: u16, channel_update: &msgs::ChannelUpdate| {
848 let short_channel_id = channel_to_update.1;
849 let network_update = NetworkUpdate::ChannelUpdateMessage { msg: channel_update.clone() };
850 run_onion_failure_test(
851 name, 0, &nodes, &route, &payment_hash, &payment_secret, |_| {}, || {}, true,
852 Some(error_code), Some(network_update), Some(short_channel_id),
856 // Updates to cltv_expiry_delta below MIN_CLTV_EXPIRY_DELTA should fail with APIMisuseError.
857 let mut invalid_config = default_config.clone();
858 invalid_config.cltv_expiry_delta = 0;
859 match nodes[1].node.update_channel_config(
860 channel_to_update_counterparty, &[channel_to_update.0], &invalid_config,
862 Err(APIError::APIMisuseError{ .. }) => {},
863 _ => panic!("unexpected result applying invalid cltv_expiry_delta"),
866 // Increase the base fee which should trigger a new ChannelUpdate.
867 let mut config = nodes[1].node.list_usable_channels().iter()
868 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
870 config.forwarding_fee_base_msat = u32::max_value();
871 let msg = update_and_get_channel_update(&config, true, None, false).unwrap();
873 // The old policy should still be in effect until a new block is connected.
874 send_along_route_with_secret(&nodes[0], route.clone(), &[&[&nodes[1], &nodes[2]]], PAYMENT_AMT,
875 payment_hash, payment_secret);
876 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
878 // Connect a block, which should expire the previous config, leading to a failure when
879 // forwarding the HTLC.
880 expire_prev_config();
881 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
883 // Redundant updates should not trigger a new ChannelUpdate.
884 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
886 // Similarly, updates that do not have an affect on ChannelUpdate should not trigger a new one.
887 config.force_close_avoidance_max_fee_satoshis *= 2;
888 assert!(update_and_get_channel_update(&config, false, None, false).is_none());
890 // Reset the base fee to the default and increase the proportional fee which should trigger a
891 // new ChannelUpdate.
892 config.forwarding_fee_base_msat = default_config.forwarding_fee_base_msat;
893 config.cltv_expiry_delta = u16::max_value();
894 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
895 expect_onion_failure("incorrect_cltv_expiry", UPDATE|13, &msg);
897 // Reset the proportional fee and increase the CLTV expiry delta which should trigger a new
899 config.cltv_expiry_delta = default_config.cltv_expiry_delta;
900 config.forwarding_fee_proportional_millionths = u32::max_value();
901 let msg = update_and_get_channel_update(&config, true, Some(&msg), true).unwrap();
902 expect_onion_failure("fee_insufficient", UPDATE|12, &msg);
904 // To test persistence of the updated config, we'll re-initialize the ChannelManager.
905 let config_after_restart = {
906 let chan_1_monitor_serialized = get_monitor!(nodes[1], other_channel.3).encode();
907 let chan_2_monitor_serialized = get_monitor!(nodes[1], channel_to_update.0).encode();
908 reload_node!(nodes[1], *nodes[1].node.get_current_default_configuration(), &nodes[1].node.encode(),
909 &[&chan_1_monitor_serialized, &chan_2_monitor_serialized], persister, chain_monitor, channel_manager_1_deserialized);
910 nodes[1].node.list_channels().iter()
911 .find(|channel| channel.channel_id == channel_to_update.0).unwrap()
914 assert_eq!(config, config_after_restart);
918 fn test_onion_failure_stale_channel_update() {
919 do_test_onion_failure_stale_channel_update(false);
920 do_test_onion_failure_stale_channel_update(true);
924 fn test_always_create_tlv_format_onion_payloads() {
925 // Verify that we always generate tlv onion format payloads, even if the features specifically
926 // specifies no support for variable length onions, as the legacy payload format has been
927 // deprecated in BOLT4.
928 let chanmon_cfgs = create_chanmon_cfgs(3);
929 let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
931 // Set `node[1]`'s init features to features which return `false` for
932 // `supports_variable_length_onion()`
933 let mut no_variable_length_onion_features = InitFeatures::empty();
934 no_variable_length_onion_features.set_static_remote_key_required();
935 *node_cfgs[1].override_init_features.borrow_mut() = Some(no_variable_length_onion_features);
937 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
938 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
940 create_announced_chan_between_nodes(&nodes, 0, 1);
941 create_announced_chan_between_nodes(&nodes, 1, 2);
943 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
944 .with_bolt11_features(Bolt11InvoiceFeatures::empty()).unwrap();
945 let (route, _payment_hash, _payment_preimage, _payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], payment_params, 40000);
947 let hops = &route.paths[0].hops;
948 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
949 assert!(!hops[0].node_features.supports_variable_length_onion());
950 // Asserts that the first hop to `node[1]` signals no support for variable length onions.
951 assert!(!hops[1].node_features.supports_variable_length_onion());
953 let cur_height = nodes[0].best_block_info().1 + 1;
954 let recipient_onion_fields = RecipientOnionFields::spontaneous_empty();
955 let (onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(
956 &route.paths[0], 40000, &recipient_onion_fields, cur_height, &None).unwrap();
958 match onion_payloads[0] {
959 msgs::OutboundOnionPayload::Forward {..} => {},
961 "Should have generated a `msgs::OnionHopDataFormat::NonFinalNode` payload for `hops[0]`,
962 despite that the features signals no support for variable length onions"
965 match onion_payloads[1] {
966 msgs::OutboundOnionPayload::Receive {..} => {},
968 "Should have generated a `msgs::OnionHopDataFormat::FinalNode` payload for `hops[1]`,
969 despite that the features signals no support for variable length onions"
975 fn test_trampoline_onion_payload_serialization() {
976 // As per https://github.com/lightning/bolts/blob/c01d2e6267d4a8d1095f0f1188970055a9a22d29/bolt04/trampoline-payment-onion-test.json#L3
977 let trampoline_payload = OutboundTrampolinePayload::Forward {
978 amt_to_forward: 100000000,
979 outgoing_cltv_value: 800000,
980 outgoing_node_id: PublicKey::from_slice(&<Vec<u8>>::from_hex("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()).unwrap(),
983 let slice_to_hex = |slice: &[u8]| {
985 .map(|b| format!("{:02x}", b).to_string())
989 let carol_payload_hex = slice_to_hex(&trampoline_payload.encode());
990 assert_eq!(carol_payload_hex, "2e020405f5e10004030c35000e2102edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145");
993 fn do_test_fail_htlc_backwards_with_reason(failure_code: FailureCode) {
995 let chanmon_cfgs = create_chanmon_cfgs(2);
996 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
997 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
998 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1000 create_announced_chan_between_nodes(&nodes, 0, 1);
1002 let payment_amount = 100_000;
1003 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], payment_amount);
1004 nodes[0].node.send_payment_with_route(&route, payment_hash,
1005 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1006 check_added_monitors!(nodes[0], 1);
1008 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1009 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
1010 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1011 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1013 expect_pending_htlcs_forwardable!(nodes[1]);
1014 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, payment_amount);
1015 nodes[1].node.fail_htlc_backwards_with_reason(&payment_hash, failure_code);
1017 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash }]);
1018 check_added_monitors!(nodes[1], 1);
1020 let events = nodes[1].node.get_and_clear_pending_msg_events();
1021 assert_eq!(events.len(), 1);
1022 let (update_fail_htlc, commitment_signed) = match events[0] {
1023 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 } } => {
1024 assert!(update_add_htlcs.is_empty());
1025 assert!(update_fulfill_htlcs.is_empty());
1026 assert_eq!(update_fail_htlcs.len(), 1);
1027 assert!(update_fail_malformed_htlcs.is_empty());
1028 assert!(update_fee.is_none());
1029 (update_fail_htlcs[0].clone(), commitment_signed)
1031 _ => panic!("Unexpected event"),
1034 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
1035 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
1037 let failure_data = match failure_code {
1038 FailureCode::TemporaryNodeFailure => vec![],
1039 FailureCode::RequiredNodeFeatureMissing => vec![],
1040 FailureCode::IncorrectOrUnknownPaymentDetails => {
1041 let mut htlc_msat_height_data = (payment_amount as u64).to_be_bytes().to_vec();
1042 htlc_msat_height_data.extend_from_slice(&CHAN_CONFIRM_DEPTH.to_be_bytes());
1043 htlc_msat_height_data
1045 FailureCode::InvalidOnionPayload(data) => {
1047 Some((typ, offset)) => [BigSize(typ).encode(), offset.encode()].concat(),
1053 let failure_code = failure_code.into();
1054 let permanent_flag = 0x4000;
1055 let permanent_fail = (failure_code & permanent_flag) != 0;
1056 expect_payment_failed!(nodes[0], payment_hash, permanent_fail, failure_code, failure_data);
1061 fn test_fail_htlc_backwards_with_reason() {
1062 do_test_fail_htlc_backwards_with_reason(FailureCode::TemporaryNodeFailure);
1063 do_test_fail_htlc_backwards_with_reason(FailureCode::RequiredNodeFeatureMissing);
1064 do_test_fail_htlc_backwards_with_reason(FailureCode::IncorrectOrUnknownPaymentDetails);
1065 do_test_fail_htlc_backwards_with_reason(FailureCode::InvalidOnionPayload(Some((1 << 16, 42))));
1066 do_test_fail_htlc_backwards_with_reason(FailureCode::InvalidOnionPayload(None));
1069 macro_rules! get_phantom_route {
1070 ($nodes: expr, $amt: expr, $channel: expr) => {{
1071 let phantom_pubkey = $nodes[1].keys_manager.get_node_id(Recipient::PhantomNode).unwrap();
1072 let phantom_route_hint = $nodes[1].node.get_phantom_route_hints();
1073 let payment_params = PaymentParameters::from_node_id(phantom_pubkey, TEST_FINAL_CLTV)
1074 .with_bolt11_features($nodes[1].node.bolt11_invoice_features()).unwrap()
1075 .with_route_hints(vec![RouteHint(vec![
1077 src_node_id: $nodes[0].node.get_our_node_id(),
1078 short_channel_id: $channel.0.contents.short_channel_id,
1080 base_msat: $channel.0.contents.fee_base_msat,
1081 proportional_millionths: $channel.0.contents.fee_proportional_millionths,
1083 cltv_expiry_delta: $channel.0.contents.cltv_expiry_delta,
1084 htlc_minimum_msat: None,
1085 htlc_maximum_msat: None,
1088 src_node_id: phantom_route_hint.real_node_pubkey,
1089 short_channel_id: phantom_route_hint.phantom_scid,
1092 proportional_millionths: 0,
1094 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
1095 htlc_minimum_msat: None,
1096 htlc_maximum_msat: None,
1099 let scorer = test_utils::TestScorer::new();
1100 let network_graph = $nodes[0].network_graph.read_only();
1101 let route_params = RouteParameters::from_payment_params_and_value(payment_params, $amt);
1103 &$nodes[0].node.get_our_node_id(), &route_params, &network_graph,
1104 Some(&$nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
1105 $nodes[0].logger, &scorer, &Default::default(), &[0u8; 32]
1106 ).unwrap(), phantom_route_hint.phantom_scid)
1111 fn test_phantom_onion_hmac_failure() {
1112 let chanmon_cfgs = create_chanmon_cfgs(2);
1113 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1114 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1115 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1117 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1120 let recv_value_msat = 10_000;
1121 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1122 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1124 // Route the HTLC through to the destination.
1125 nodes[0].node.send_payment_with_route(&route, payment_hash,
1126 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1127 check_added_monitors!(nodes[0], 1);
1128 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1129 let mut update_add = update_0.update_add_htlcs[0].clone();
1131 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1132 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1134 // Modify the payload so the phantom hop's HMAC is bogus.
1135 let sha256_of_onion = {
1136 let mut forward_htlcs = nodes[1].node.forward_htlcs.lock().unwrap();
1137 let mut pending_forward = forward_htlcs.get_mut(&phantom_scid).unwrap();
1138 match pending_forward[0] {
1139 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1140 forward_info: PendingHTLCInfo {
1141 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1145 onion_packet.hmac[onion_packet.hmac.len() - 1] ^= 1;
1146 Sha256::hash(&onion_packet.hop_data).to_byte_array().to_vec()
1148 _ => panic!("Unexpected forward"),
1151 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1152 nodes[1].node.process_pending_htlc_forwards();
1153 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1154 nodes[1].node.process_pending_htlc_forwards();
1155 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1156 check_added_monitors!(&nodes[1], 1);
1157 assert!(update_1.update_fail_htlcs.len() == 1);
1158 let fail_msg = update_1.update_fail_htlcs[0].clone();
1159 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1160 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1162 // Ensure the payment fails with the expected error.
1163 let mut fail_conditions = PaymentFailedConditions::new()
1164 .blamed_scid(phantom_scid)
1165 .blamed_chan_closed(true)
1166 .expected_htlc_error_data(0x8000 | 0x4000 | 5, &sha256_of_onion);
1167 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1171 fn test_phantom_invalid_onion_payload() {
1172 let chanmon_cfgs = create_chanmon_cfgs(2);
1173 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1174 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1175 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1177 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1180 let recv_value_msat = 10_000;
1181 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1182 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1184 // We'll use the session priv later when constructing an invalid onion packet.
1185 let session_priv = [3; 32];
1186 *nodes[0].keys_manager.override_random_bytes.lock().unwrap() = Some(session_priv);
1187 nodes[0].node.send_payment_with_route(&route, payment_hash,
1188 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1189 check_added_monitors!(nodes[0], 1);
1190 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1191 let mut update_add = update_0.update_add_htlcs[0].clone();
1193 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1194 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1196 // Modify the onion packet to have an invalid payment amount.
1197 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1198 for f in pending_forwards.iter_mut() {
1200 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1201 forward_info: PendingHTLCInfo {
1202 routing: PendingHTLCRouting::Forward { ref mut onion_packet, .. },
1206 // Construct the onion payloads for the entire route and an invalid amount.
1207 let height = nodes[0].best_block_info().1;
1208 let session_priv = SecretKey::from_slice(&session_priv).unwrap();
1209 let mut onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
1210 let recipient_onion_fields = RecipientOnionFields::secret_only(payment_secret);
1211 let (mut onion_payloads, _, _) = onion_utils::build_onion_payloads(
1212 &route.paths[0], msgs::MAX_VALUE_MSAT + 1,
1213 &recipient_onion_fields, height + 1, &None).unwrap();
1214 // We only want to construct the onion packet for the last hop, not the entire route, so
1215 // remove the first hop's payload and its keys.
1216 onion_keys.remove(0);
1217 onion_payloads.remove(0);
1219 let new_onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash).unwrap();
1220 onion_packet.hop_data = new_onion_packet.hop_data;
1221 onion_packet.hmac = new_onion_packet.hmac;
1223 _ => panic!("Unexpected forward"),
1227 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1228 nodes[1].node.process_pending_htlc_forwards();
1229 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1230 nodes[1].node.process_pending_htlc_forwards();
1231 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1232 check_added_monitors!(&nodes[1], 1);
1233 assert!(update_1.update_fail_htlcs.len() == 1);
1234 let fail_msg = update_1.update_fail_htlcs[0].clone();
1235 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1236 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1238 // Ensure the payment fails with the expected error.
1239 let error_data = Vec::new();
1240 let mut fail_conditions = PaymentFailedConditions::new()
1241 .blamed_scid(phantom_scid)
1242 .blamed_chan_closed(true)
1243 .expected_htlc_error_data(0x4000 | 22, &error_data);
1244 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1248 fn test_phantom_final_incorrect_cltv_expiry() {
1249 let chanmon_cfgs = create_chanmon_cfgs(2);
1250 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1251 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1252 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1254 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1257 let recv_value_msat = 10_000;
1258 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1259 let (route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1261 // Route the HTLC through to the destination.
1262 nodes[0].node.send_payment_with_route(&route, payment_hash,
1263 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1264 check_added_monitors!(nodes[0], 1);
1265 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1266 let mut update_add = update_0.update_add_htlcs[0].clone();
1268 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1269 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1271 // Modify the payload so the phantom hop's HMAC is bogus.
1272 for (_, pending_forwards) in nodes[1].node.forward_htlcs.lock().unwrap().iter_mut() {
1273 for f in pending_forwards.iter_mut() {
1275 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
1276 forward_info: PendingHTLCInfo { ref mut outgoing_cltv_value, .. }, ..
1278 *outgoing_cltv_value -= 1;
1280 _ => panic!("Unexpected forward"),
1284 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1285 nodes[1].node.process_pending_htlc_forwards();
1286 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1287 nodes[1].node.process_pending_htlc_forwards();
1288 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1289 check_added_monitors!(&nodes[1], 1);
1290 assert!(update_1.update_fail_htlcs.len() == 1);
1291 let fail_msg = update_1.update_fail_htlcs[0].clone();
1292 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1293 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1295 // Ensure the payment fails with the expected error.
1296 let expected_cltv: u32 = 80;
1297 let error_data = expected_cltv.to_be_bytes().to_vec();
1298 let mut fail_conditions = PaymentFailedConditions::new()
1299 .blamed_scid(phantom_scid)
1300 .expected_htlc_error_data(18, &error_data);
1301 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1305 fn test_phantom_failure_too_low_cltv() {
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 // Modify the route to have a too-low cltv.
1319 route.paths[0].hops[1].cltv_expiry_delta = 5;
1321 // Route the HTLC through to the destination.
1322 nodes[0].node.send_payment_with_route(&route, payment_hash,
1323 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1324 check_added_monitors!(nodes[0], 1);
1325 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1326 let mut update_add = update_0.update_add_htlcs[0].clone();
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 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1332 nodes[1].node.process_pending_htlc_forwards();
1333 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1334 nodes[1].node.process_pending_htlc_forwards();
1335 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1336 check_added_monitors!(&nodes[1], 1);
1337 assert!(update_1.update_fail_htlcs.len() == 1);
1338 let fail_msg = update_1.update_fail_htlcs[0].clone();
1339 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1340 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1342 // Ensure the payment fails with the expected error.
1343 let mut error_data = recv_value_msat.to_be_bytes().to_vec();
1344 error_data.extend_from_slice(
1345 &nodes[0].node.best_block.read().unwrap().height.to_be_bytes(),
1347 let mut fail_conditions = PaymentFailedConditions::new()
1348 .blamed_scid(phantom_scid)
1349 .expected_htlc_error_data(0x4000 | 15, &error_data);
1350 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1354 fn test_phantom_failure_modified_cltv() {
1355 // Test that we fail back phantoms if the upstream node fiddled with the CLTV too much with the
1356 // correct error code.
1357 let chanmon_cfgs = create_chanmon_cfgs(2);
1358 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1359 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1360 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1362 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1365 let recv_value_msat = 10_000;
1366 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1367 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1369 // Route the HTLC through to the destination.
1370 nodes[0].node.send_payment_with_route(&route, payment_hash,
1371 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1372 check_added_monitors!(nodes[0], 1);
1373 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1374 let mut update_add = update_0.update_add_htlcs[0].clone();
1376 // Modify the route to have a too-low cltv.
1377 update_add.cltv_expiry -= 10;
1379 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1380 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1382 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1383 assert!(update_1.update_fail_htlcs.len() == 1);
1384 let fail_msg = update_1.update_fail_htlcs[0].clone();
1385 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1386 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1388 // Ensure the payment fails with the expected error.
1389 let mut fail_conditions = PaymentFailedConditions::new()
1390 .blamed_scid(phantom_scid)
1391 .expected_htlc_error_data(0x2000 | 2, &[]);
1392 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1396 fn test_phantom_failure_expires_too_soon() {
1397 // Test that we fail back phantoms if the HTLC got delayed and we got blocks in between with
1398 // the correct error code.
1399 let chanmon_cfgs = create_chanmon_cfgs(2);
1400 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1401 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1402 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1404 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1407 let recv_value_msat = 10_000;
1408 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_value_msat));
1409 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_value_msat, channel);
1411 // Route the HTLC through to the destination.
1412 nodes[0].node.send_payment_with_route(&route, payment_hash,
1413 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1414 check_added_monitors!(nodes[0], 1);
1415 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1416 let mut update_add = update_0.update_add_htlcs[0].clone();
1418 connect_blocks(&nodes[1], CLTV_FAR_FAR_AWAY);
1419 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1420 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1422 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1423 assert!(update_1.update_fail_htlcs.len() == 1);
1424 let fail_msg = update_1.update_fail_htlcs[0].clone();
1425 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1426 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1428 // Ensure the payment fails with the expected error.
1429 let mut fail_conditions = PaymentFailedConditions::new()
1430 .blamed_scid(phantom_scid)
1431 .expected_htlc_error_data(0x2000 | 2, &[]);
1432 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1436 fn test_phantom_failure_too_low_recv_amt() {
1437 let chanmon_cfgs = create_chanmon_cfgs(2);
1438 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1439 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1440 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1442 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1444 // Get the route with a too-low amount.
1445 let recv_amt_msat = 10_000;
1446 let bad_recv_amt_msat = recv_amt_msat - 10;
1447 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1448 let (mut route, phantom_scid) = get_phantom_route!(nodes, bad_recv_amt_msat, channel);
1450 // Route the HTLC through to the destination.
1451 nodes[0].node.send_payment_with_route(&route, payment_hash,
1452 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1453 check_added_monitors!(nodes[0], 1);
1454 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1455 let mut update_add = update_0.update_add_htlcs[0].clone();
1457 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1458 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1460 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1461 nodes[1].node.process_pending_htlc_forwards();
1462 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1463 nodes[1].node.process_pending_htlc_forwards();
1464 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }]);
1465 nodes[1].node.process_pending_htlc_forwards();
1466 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1467 check_added_monitors!(&nodes[1], 1);
1468 assert!(update_1.update_fail_htlcs.len() == 1);
1469 let fail_msg = update_1.update_fail_htlcs[0].clone();
1470 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1471 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1473 // Ensure the payment fails with the expected error.
1474 let mut error_data = bad_recv_amt_msat.to_be_bytes().to_vec();
1475 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height.to_be_bytes());
1476 let mut fail_conditions = PaymentFailedConditions::new()
1477 .blamed_scid(phantom_scid)
1478 .expected_htlc_error_data(0x4000 | 15, &error_data);
1479 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);
1483 fn test_phantom_dust_exposure_failure() {
1484 do_test_phantom_dust_exposure_failure(false);
1485 do_test_phantom_dust_exposure_failure(true);
1488 fn do_test_phantom_dust_exposure_failure(multiplier_dust_limit: bool) {
1489 // Set the max dust exposure to the dust limit.
1490 let max_dust_exposure = 546;
1491 let mut receiver_config = UserConfig::default();
1492 // Default test fee estimator rate is 253, so to set the max dust exposure to the dust limit,
1493 // we need to set the multiplier to 2.
1494 receiver_config.channel_config.max_dust_htlc_exposure =
1495 if multiplier_dust_limit { MaxDustHTLCExposure::FeeRateMultiplier(2) }
1496 else { MaxDustHTLCExposure::FixedLimitMsat(max_dust_exposure) };
1497 receiver_config.channel_handshake_config.announced_channel = true;
1499 let chanmon_cfgs = create_chanmon_cfgs(2);
1500 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1501 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(receiver_config)]);
1502 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1504 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1506 // Get the route with an amount exceeding the dust exposure threshold of nodes[1].
1507 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(max_dust_exposure + 1));
1508 let (mut route, _) = get_phantom_route!(nodes, max_dust_exposure + 1, channel);
1510 // Route the HTLC through to the destination.
1511 nodes[0].node.send_payment_with_route(&route, payment_hash,
1512 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1513 check_added_monitors!(nodes[0], 1);
1514 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1515 let mut update_add = update_0.update_add_htlcs[0].clone();
1517 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1518 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1520 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1521 assert!(update_1.update_fail_htlcs.len() == 1);
1522 let fail_msg = update_1.update_fail_htlcs[0].clone();
1523 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1524 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1526 // Ensure the payment fails with the expected error.
1527 let mut err_data = Vec::new();
1528 err_data.extend_from_slice(&(channel.1.serialized_length() as u16 + 2).to_be_bytes());
1529 err_data.extend_from_slice(&ChannelUpdate::TYPE.to_be_bytes());
1530 err_data.extend_from_slice(&channel.1.encode());
1532 let mut fail_conditions = PaymentFailedConditions::new()
1533 .blamed_scid(channel.0.contents.short_channel_id)
1534 .blamed_chan_closed(false)
1535 .expected_htlc_error_data(0x1000 | 7, &err_data);
1536 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1540 fn test_phantom_failure_reject_payment() {
1541 // Test that the user can successfully fail back a phantom node payment.
1542 let chanmon_cfgs = create_chanmon_cfgs(2);
1543 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1544 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1545 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1547 let channel = create_announced_chan_between_nodes(&nodes, 0, 1);
1549 // Get the route with a too-low amount.
1550 let recv_amt_msat = 10_000;
1551 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[1], Some(recv_amt_msat));
1552 let (mut route, phantom_scid) = get_phantom_route!(nodes, recv_amt_msat, channel);
1554 // Route the HTLC through to the destination.
1555 nodes[0].node.send_payment_with_route(&route, payment_hash,
1556 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1557 check_added_monitors!(nodes[0], 1);
1558 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1559 let mut update_add = update_0.update_add_htlcs[0].clone();
1561 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
1562 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
1564 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1565 nodes[1].node.process_pending_htlc_forwards();
1566 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
1567 nodes[1].node.process_pending_htlc_forwards();
1568 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, recv_amt_msat, None, route.paths[0].hops.last().unwrap().pubkey);
1569 nodes[1].node.fail_htlc_backwards(&payment_hash);
1570 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1571 nodes[1].node.process_pending_htlc_forwards();
1573 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1574 check_added_monitors!(&nodes[1], 1);
1575 assert!(update_1.update_fail_htlcs.len() == 1);
1576 let fail_msg = update_1.update_fail_htlcs[0].clone();
1577 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1578 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
1580 // Ensure the payment fails with the expected error.
1581 let mut error_data = recv_amt_msat.to_be_bytes().to_vec();
1582 error_data.extend_from_slice(&nodes[1].node.best_block.read().unwrap().height.to_be_bytes());
1583 let mut fail_conditions = PaymentFailedConditions::new()
1584 .blamed_scid(phantom_scid)
1585 .expected_htlc_error_data(0x4000 | 15, &error_data);
1586 expect_payment_failed_conditions(&nodes[0], payment_hash, true, fail_conditions);