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 that test the payment retry logic in ChannelManager, including various edge-cases around
11 //! serialization ordering between ChannelManager/ChannelMonitors and ensuring we can still retry
12 //! payments thereafter.
14 use crate::chain::{ChannelMonitorUpdateStatus, Confirm, Listen};
15 use crate::chain::channelmonitor::{ANTI_REORG_DELAY, HTLC_FAIL_BACK_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS};
16 use crate::sign::EntropySource;
17 use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentFailureReason, PaymentPurpose};
18 use crate::ln::channel::{EXPIRE_PREV_CONFIG_TICKS, commit_tx_fee_msat, get_holder_selected_channel_reserve_satoshis, ANCHOR_OUTPUT_VALUE_SATOSHI};
19 use crate::ln::channelmanager::{BREAKDOWN_TIMEOUT, MPP_TIMEOUT_TICKS, MIN_CLTV_EXPIRY_DELTA, PaymentId, PaymentSendFailure, RecentPaymentDetails, RecipientOnionFields, HTLCForwardInfo, PendingHTLCRouting, PendingAddHTLCInfo};
20 use crate::ln::features::{Bolt11InvoiceFeatures, ChannelTypeFeatures};
22 use crate::ln::types::{ChannelId, PaymentHash, PaymentSecret, PaymentPreimage};
23 use crate::ln::msgs::ChannelMessageHandler;
24 use crate::ln::onion_utils;
25 use crate::ln::outbound_payment::{IDEMPOTENCY_TIMEOUT_TICKS, Retry};
26 use crate::routing::gossip::{EffectiveCapacity, RoutingFees};
27 use crate::routing::router::{get_route, Path, PaymentParameters, Route, Router, RouteHint, RouteHintHop, RouteHop, RouteParameters, find_route};
28 use crate::routing::scoring::ChannelUsage;
29 use crate::util::config::UserConfig;
30 use crate::util::test_utils;
31 use crate::util::errors::APIError;
32 use crate::util::ser::Writeable;
33 use crate::util::string::UntrustedString;
35 use bitcoin::hashes::Hash;
36 use bitcoin::hashes::sha256::Hash as Sha256;
37 use bitcoin::network::constants::Network;
38 use bitcoin::secp256k1::{Secp256k1, SecretKey};
40 use crate::prelude::*;
42 use crate::ln::functional_test_utils;
43 use crate::ln::functional_test_utils::*;
44 use crate::routing::gossip::NodeId;
46 #[cfg(feature = "std")]
48 crate::util::time::tests::SinceEpoch,
49 std::time::{SystemTime, Instant, Duration},
54 let chanmon_cfgs = create_chanmon_cfgs(4);
55 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
56 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
57 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
59 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
60 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
61 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
62 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
64 let (mut route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
65 let path = route.paths[0].clone();
66 route.paths.push(path);
67 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
68 route.paths[0].hops[0].short_channel_id = chan_1_id;
69 route.paths[0].hops[1].short_channel_id = chan_3_id;
70 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
71 route.paths[1].hops[0].short_channel_id = chan_2_id;
72 route.paths[1].hops[1].short_channel_id = chan_4_id;
73 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
74 fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
79 let chanmon_cfgs = create_chanmon_cfgs(4);
80 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
81 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
82 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
84 let (chan_1_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 1);
85 let (chan_2_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 2);
86 let (chan_3_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 1, 3);
87 let (chan_4_update, _, chan_4_id, _) = create_announced_chan_between_nodes(&nodes, 3, 2);
89 send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
91 let amt_msat = 1_000_000;
92 let max_total_routing_fee_msat = 50_000;
93 let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
94 .with_bolt11_features(nodes[3].node.bolt11_invoice_features()).unwrap();
95 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(
96 nodes[0], nodes[3], payment_params, amt_msat, Some(max_total_routing_fee_msat));
97 let path = route.paths[0].clone();
98 route.paths.push(path);
99 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
100 route.paths[0].hops[0].short_channel_id = chan_1_update.contents.short_channel_id;
101 route.paths[0].hops[1].short_channel_id = chan_3_update.contents.short_channel_id;
102 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
103 route.paths[1].hops[0].short_channel_id = chan_2_update.contents.short_channel_id;
104 route.paths[1].hops[1].short_channel_id = chan_4_update.contents.short_channel_id;
106 // Initiate the MPP payment.
107 let payment_id = PaymentId(payment_hash.0);
108 let mut route_params = route.route_params.clone().unwrap();
110 nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
111 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
112 payment_id, route_params.clone(), Retry::Attempts(1)).unwrap();
113 check_added_monitors!(nodes[0], 2); // one monitor per path
114 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
115 assert_eq!(events.len(), 2);
117 // Pass half of the payment along the success path.
118 let success_path_msgs = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
119 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), success_path_msgs, false, None);
121 // Add the HTLC along the first hop.
122 let fail_path_msgs_1 = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
123 let send_event = SendEvent::from_event(fail_path_msgs_1);
124 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
125 commitment_signed_dance!(nodes[2], nodes[0], &send_event.commitment_msg, false);
127 // Attempt to forward the payment and complete the 2nd path's failure.
128 expect_pending_htlcs_forwardable!(&nodes[2]);
129 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[2], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_4_id }]);
130 let htlc_updates = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
131 assert!(htlc_updates.update_add_htlcs.is_empty());
132 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
133 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
134 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
135 check_added_monitors!(nodes[2], 1);
136 nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
137 commitment_signed_dance!(nodes[0], nodes[2], htlc_updates.commitment_signed, false);
138 let mut events = nodes[0].node.get_and_clear_pending_events();
140 Event::PendingHTLCsForwardable { .. } => {},
141 _ => panic!("Unexpected event")
144 expect_payment_failed_conditions_event(events, payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
146 // Rebalance the channel so the second half of the payment can succeed.
147 send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
149 // Retry the second half of the payment and make sure it succeeds.
150 route.paths.remove(0);
151 route_params.final_value_msat = 1_000_000;
152 route_params.payment_params.previously_failed_channels.push(chan_4_update.contents.short_channel_id);
153 // Check the remaining max total routing fee for the second attempt is 50_000 - 1_000 msat fee
154 // used by the first path
155 route_params.max_total_routing_fee_msat = Some(max_total_routing_fee_msat - 1_000);
156 route.route_params = Some(route_params.clone());
157 nodes[0].router.expect_find_route(route_params, Ok(route));
158 nodes[0].node.process_pending_htlc_forwards();
159 check_added_monitors!(nodes[0], 1);
160 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
161 assert_eq!(events.len(), 1);
162 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
163 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
167 fn mpp_retry_overpay() {
168 // We create an MPP scenario with two paths in which we need to overpay to reach
169 // htlc_minimum_msat. We then fail the overpaid path and check that on retry our
170 // max_total_routing_fee_msat only accounts for the path's fees, but not for the fees overpaid
171 // in the first attempt.
172 let chanmon_cfgs = create_chanmon_cfgs(4);
173 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
174 let mut user_config = test_default_channel_config();
175 user_config.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 100;
176 let mut limited_config_1 = user_config.clone();
177 limited_config_1.channel_handshake_config.our_htlc_minimum_msat = 35_000_000;
178 let mut limited_config_2 = user_config.clone();
179 limited_config_2.channel_handshake_config.our_htlc_minimum_msat = 34_500_000;
180 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs,
181 &[Some(user_config), Some(limited_config_1), Some(limited_config_2), Some(user_config)]);
182 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
184 let (chan_1_update, _, _, _) = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 40_000, 0);
185 let (chan_2_update, _, _, _) = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 40_000, 0);
186 let (_chan_3_update, _, _, _) = create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 40_000, 0);
187 let (chan_4_update, _, chan_4_id, _) = create_announced_chan_between_nodes_with_value(&nodes, 3, 2, 40_000, 0);
189 let amt_msat = 70_000_000;
190 let max_total_routing_fee_msat = Some(1_000_000);
192 let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
193 .with_bolt11_features(nodes[3].node.bolt11_invoice_features()).unwrap();
194 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(
195 nodes[0], nodes[3], payment_params, amt_msat, max_total_routing_fee_msat);
197 // Check we overpay on the second path which we're about to fail.
198 assert_eq!(chan_1_update.contents.fee_proportional_millionths, 0);
199 let overpaid_amount_1 = route.paths[0].fee_msat() as u32 - chan_1_update.contents.fee_base_msat;
200 assert_eq!(overpaid_amount_1, 0);
202 assert_eq!(chan_2_update.contents.fee_proportional_millionths, 0);
203 let overpaid_amount_2 = route.paths[1].fee_msat() as u32 - chan_2_update.contents.fee_base_msat;
205 let total_overpaid_amount = overpaid_amount_1 + overpaid_amount_2;
207 // Initiate the payment.
208 let payment_id = PaymentId(payment_hash.0);
209 let mut route_params = route.route_params.clone().unwrap();
211 nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
212 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
213 payment_id, route_params.clone(), Retry::Attempts(1)).unwrap();
214 check_added_monitors!(nodes[0], 2); // one monitor per path
215 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
216 assert_eq!(events.len(), 2);
218 // Pass half of the payment along the success path.
219 let success_path_msgs = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
220 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], amt_msat, payment_hash,
221 Some(payment_secret), success_path_msgs, false, None);
223 // Add the HTLC along the first hop.
224 let fail_path_msgs_1 = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
225 let send_event = SendEvent::from_event(fail_path_msgs_1);
226 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
227 commitment_signed_dance!(nodes[2], nodes[0], &send_event.commitment_msg, false);
229 // Attempt to forward the payment and complete the 2nd path's failure.
230 expect_pending_htlcs_forwardable!(&nodes[2]);
231 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[2],
232 vec![HTLCDestination::NextHopChannel {
233 node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_4_id
236 let htlc_updates = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
237 assert!(htlc_updates.update_add_htlcs.is_empty());
238 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
239 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
240 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
241 check_added_monitors!(nodes[2], 1);
242 nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(),
243 &htlc_updates.update_fail_htlcs[0]);
244 commitment_signed_dance!(nodes[0], nodes[2], htlc_updates.commitment_signed, false);
245 let mut events = nodes[0].node.get_and_clear_pending_events();
247 Event::PendingHTLCsForwardable { .. } => {},
248 _ => panic!("Unexpected event")
251 expect_payment_failed_conditions_event(events, payment_hash, false,
252 PaymentFailedConditions::new().mpp_parts_remain());
254 // Rebalance the channel so the second half of the payment can succeed.
255 send_payment(&nodes[3], &vec!(&nodes[2])[..], 38_000_000);
257 // Retry the second half of the payment and make sure it succeeds.
258 let first_path_value = route.paths[0].final_value_msat();
259 assert_eq!(first_path_value, 36_000_000);
261 route.paths.remove(0);
262 route_params.final_value_msat -= first_path_value;
263 route_params.payment_params.previously_failed_channels.push(chan_4_update.contents.short_channel_id);
264 // Check the remaining max total routing fee for the second attempt accounts only for 1_000 msat
265 // base fee, but not for overpaid value of the first try.
266 route_params.max_total_routing_fee_msat.as_mut().map(|m| *m -= 1000);
268 route.route_params = Some(route_params.clone());
269 nodes[0].router.expect_find_route(route_params, Ok(route));
270 nodes[0].node.process_pending_htlc_forwards();
272 check_added_monitors!(nodes[0], 1);
273 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
274 assert_eq!(events.len(), 1);
275 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], amt_msat, payment_hash,
276 Some(payment_secret), events.pop().unwrap(), true, None);
278 // Can't use claim_payment_along_route as it doesn't support overpayment, so we break out the
279 // individual steps here.
280 nodes[3].node.claim_funds(payment_preimage);
281 let extra_fees = vec![0, total_overpaid_amount];
282 let expected_route = &[&[&nodes[1], &nodes[3]][..], &[&nodes[2], &nodes[3]][..]];
283 let args = ClaimAlongRouteArgs::new(&nodes[0], &expected_route[..], payment_preimage)
284 .with_expected_min_htlc_overpay(extra_fees);
285 let expected_total_fee_msat = pass_claimed_payment_along_route(args);
286 expect_payment_sent!(&nodes[0], payment_preimage, Some(expected_total_fee_msat));
289 fn do_mpp_receive_timeout(send_partial_mpp: bool) {
290 let chanmon_cfgs = create_chanmon_cfgs(4);
291 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
292 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
293 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
295 let (chan_1_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 1);
296 let (chan_2_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 2);
297 let (chan_3_update, _, chan_3_id, _) = create_announced_chan_between_nodes(&nodes, 1, 3);
298 let (chan_4_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 2, 3);
300 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 100_000);
301 let path = route.paths[0].clone();
302 route.paths.push(path);
303 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
304 route.paths[0].hops[0].short_channel_id = chan_1_update.contents.short_channel_id;
305 route.paths[0].hops[1].short_channel_id = chan_3_update.contents.short_channel_id;
306 route.paths[1].hops[0].pubkey = nodes[2].node.get_our_node_id();
307 route.paths[1].hops[0].short_channel_id = chan_2_update.contents.short_channel_id;
308 route.paths[1].hops[1].short_channel_id = chan_4_update.contents.short_channel_id;
310 // Initiate the MPP payment.
311 nodes[0].node.send_payment_with_route(&route, payment_hash,
312 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
313 check_added_monitors!(nodes[0], 2); // one monitor per path
314 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
315 assert_eq!(events.len(), 2);
317 // Pass half of the payment along the first path.
318 let node_1_msgs = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
319 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 200_000, payment_hash, Some(payment_secret), node_1_msgs, false, None);
321 if send_partial_mpp {
322 // Time out the partial MPP
323 for _ in 0..MPP_TIMEOUT_TICKS {
324 nodes[3].node.timer_tick_occurred();
327 // Failed HTLC from node 3 -> 1
328 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], vec![HTLCDestination::FailedPayment { payment_hash }]);
329 let htlc_fail_updates_3_1 = get_htlc_update_msgs!(nodes[3], nodes[1].node.get_our_node_id());
330 assert_eq!(htlc_fail_updates_3_1.update_fail_htlcs.len(), 1);
331 nodes[1].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &htlc_fail_updates_3_1.update_fail_htlcs[0]);
332 check_added_monitors!(nodes[3], 1);
333 commitment_signed_dance!(nodes[1], nodes[3], htlc_fail_updates_3_1.commitment_signed, false);
335 // Failed HTLC from node 1 -> 0
336 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_3_id }]);
337 let htlc_fail_updates_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
338 assert_eq!(htlc_fail_updates_1_0.update_fail_htlcs.len(), 1);
339 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates_1_0.update_fail_htlcs[0]);
340 check_added_monitors!(nodes[1], 1);
341 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates_1_0.commitment_signed, false);
343 expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain().expected_htlc_error_data(23, &[][..]));
345 // Pass half of the payment along the second path.
346 let node_2_msgs = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
347 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash, Some(payment_secret), node_2_msgs, true, None);
349 // Even after MPP_TIMEOUT_TICKS we should not timeout the MPP if we have all the parts
350 for _ in 0..MPP_TIMEOUT_TICKS {
351 nodes[3].node.timer_tick_occurred();
354 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
359 fn mpp_receive_timeout() {
360 do_mpp_receive_timeout(true);
361 do_mpp_receive_timeout(false);
365 fn test_keysend_payments() {
366 do_test_keysend_payments(false, false);
367 do_test_keysend_payments(false, true);
368 do_test_keysend_payments(true, false);
369 do_test_keysend_payments(true, true);
372 fn do_test_keysend_payments(public_node: bool, with_retry: bool) {
373 let chanmon_cfgs = create_chanmon_cfgs(2);
374 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
375 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
376 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
379 create_announced_chan_between_nodes(&nodes, 0, 1);
381 create_chan_between_nodes(&nodes[0], &nodes[1]);
383 let payer_pubkey = nodes[0].node.get_our_node_id();
384 let payee_pubkey = nodes[1].node.get_our_node_id();
385 let route_params = RouteParameters::from_payment_params_and_value(
386 PaymentParameters::for_keysend(payee_pubkey, 40, false), 10000);
388 let network_graph = nodes[0].network_graph;
389 let channels = nodes[0].node.list_usable_channels();
390 let first_hops = channels.iter().collect::<Vec<_>>();
391 let first_hops = if public_node { None } else { Some(first_hops.as_slice()) };
393 let scorer = test_utils::TestScorer::new();
394 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
395 let route = find_route(
396 &payer_pubkey, &route_params, &network_graph, first_hops,
397 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
401 let test_preimage = PaymentPreimage([42; 32]);
403 nodes[0].node.send_spontaneous_payment_with_retry(Some(test_preimage),
404 RecipientOnionFields::spontaneous_empty(), PaymentId(test_preimage.0),
405 route_params, Retry::Attempts(1)).unwrap()
407 nodes[0].node.send_spontaneous_payment(&route, Some(test_preimage),
408 RecipientOnionFields::spontaneous_empty(), PaymentId(test_preimage.0)).unwrap()
411 check_added_monitors!(nodes[0], 1);
412 let send_event = SendEvent::from_node(&nodes[0]);
413 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
414 do_commitment_signed_dance(&nodes[1], &nodes[0], &send_event.commitment_msg, false, false);
415 expect_pending_htlcs_forwardable!(nodes[1]);
416 // Previously, a refactor caused us to stop including the payment preimage in the onion which
417 // is sent as a part of keysend payments. Thus, to be extra careful here, we scope the preimage
418 // above to demonstrate that we have no way to get the preimage at this point except by
419 // extracting it from the onion nodes[1] received.
420 let event = nodes[1].node.get_and_clear_pending_events();
421 assert_eq!(event.len(), 1);
422 if let Event::PaymentClaimable { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. } = event[0] {
423 claim_payment(&nodes[0], &[&nodes[1]], preimage);
428 fn test_mpp_keysend() {
429 let mut mpp_keysend_config = test_default_channel_config();
430 mpp_keysend_config.accept_mpp_keysend = true;
431 let chanmon_cfgs = create_chanmon_cfgs(4);
432 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
433 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, Some(mpp_keysend_config)]);
434 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
436 create_announced_chan_between_nodes(&nodes, 0, 1);
437 create_announced_chan_between_nodes(&nodes, 0, 2);
438 create_announced_chan_between_nodes(&nodes, 1, 3);
439 create_announced_chan_between_nodes(&nodes, 2, 3);
440 let network_graph = nodes[0].network_graph;
442 let payer_pubkey = nodes[0].node.get_our_node_id();
443 let payee_pubkey = nodes[3].node.get_our_node_id();
444 let recv_value = 15_000_000;
445 let route_params = RouteParameters::from_payment_params_and_value(
446 PaymentParameters::for_keysend(payee_pubkey, 40, true), recv_value);
447 let scorer = test_utils::TestScorer::new();
448 let random_seed_bytes = chanmon_cfgs[0].keys_manager.get_secure_random_bytes();
449 let route = find_route(&payer_pubkey, &route_params, &network_graph, None, nodes[0].logger,
450 &scorer, &Default::default(), &random_seed_bytes).unwrap();
452 let payment_preimage = PaymentPreimage([42; 32]);
453 let payment_secret = PaymentSecret(payment_preimage.0);
454 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage),
455 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_preimage.0)).unwrap();
456 check_added_monitors!(nodes[0], 2);
458 let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]];
459 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
460 assert_eq!(events.len(), 2);
462 let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
463 pass_along_path(&nodes[0], expected_route[0], recv_value, payment_hash.clone(),
464 Some(payment_secret), ev.clone(), false, Some(payment_preimage));
466 let ev = remove_first_msg_event_to_node(&nodes[2].node.get_our_node_id(), &mut events);
467 pass_along_path(&nodes[0], expected_route[1], recv_value, payment_hash.clone(),
468 Some(payment_secret), ev.clone(), true, Some(payment_preimage));
469 claim_payment_along_route(&nodes[0], expected_route, false, payment_preimage);
473 fn test_reject_mpp_keysend_htlc() {
474 // This test enforces that we reject MPP keysend HTLCs if our config states we don't support
475 // MPP keysend. When receiving a payment, if we don't support MPP keysend we'll reject the
476 // payment if it's keysend and has a payment secret, never reaching our payment validation
477 // logic. To check that we enforce rejecting MPP keysends in our payment logic, here we send
478 // keysend payments without payment secrets, then modify them by adding payment secrets in the
479 // final node in between receiving the HTLCs and actually processing them.
480 let mut reject_mpp_keysend_cfg = test_default_channel_config();
481 reject_mpp_keysend_cfg.accept_mpp_keysend = false;
483 let chanmon_cfgs = create_chanmon_cfgs(4);
484 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
485 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, Some(reject_mpp_keysend_cfg)]);
486 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
487 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
488 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
489 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
490 let (update_a, _, chan_4_channel_id, _) = create_announced_chan_between_nodes(&nodes, 2, 3);
491 let chan_4_id = update_a.contents.short_channel_id;
493 let (mut route, payment_hash, payment_preimage, _) = get_route_and_payment_hash!(nodes[0], nodes[3], amount);
495 // Pay along nodes[1]
496 route.paths[0].hops[0].pubkey = nodes[1].node.get_our_node_id();
497 route.paths[0].hops[0].short_channel_id = chan_1_id;
498 route.paths[0].hops[1].short_channel_id = chan_3_id;
500 let payment_id_0 = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
501 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), RecipientOnionFields::spontaneous_empty(), payment_id_0).unwrap();
502 check_added_monitors!(nodes[0], 1);
504 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
505 let update_add_0 = update_0.update_add_htlcs[0].clone();
506 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
507 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
508 expect_pending_htlcs_forwardable!(nodes[1]);
510 check_added_monitors!(&nodes[1], 1);
511 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[3].node.get_our_node_id());
512 let update_add_1 = update_1.update_add_htlcs[0].clone();
513 nodes[3].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
514 commitment_signed_dance!(nodes[3], nodes[1], update_1.commitment_signed, false, true);
516 assert!(nodes[3].node.get_and_clear_pending_msg_events().is_empty());
517 for (_, pending_forwards) in nodes[3].node.forward_htlcs.lock().unwrap().iter_mut() {
518 for f in pending_forwards.iter_mut() {
520 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) => {
521 match forward_info.routing {
522 PendingHTLCRouting::ReceiveKeysend { ref mut payment_data, .. } => {
523 *payment_data = Some(msgs::FinalOnionHopData {
524 payment_secret: PaymentSecret([42; 32]),
525 total_msat: amount * 2,
528 _ => panic!("Expected PendingHTLCRouting::ReceiveKeysend"),
535 expect_pending_htlcs_forwardable!(nodes[3]);
537 // Pay along nodes[2]
538 route.paths[0].hops[0].pubkey = nodes[2].node.get_our_node_id();
539 route.paths[0].hops[0].short_channel_id = chan_2_id;
540 route.paths[0].hops[1].short_channel_id = chan_4_id;
542 let payment_id_1 = PaymentId(nodes[0].keys_manager.backing.get_secure_random_bytes());
543 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), RecipientOnionFields::spontaneous_empty(), payment_id_1).unwrap();
544 check_added_monitors!(nodes[0], 1);
546 let update_2 = get_htlc_update_msgs!(nodes[0], nodes[2].node.get_our_node_id());
547 let update_add_2 = update_2.update_add_htlcs[0].clone();
548 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_2);
549 commitment_signed_dance!(nodes[2], nodes[0], &update_2.commitment_signed, false, true);
550 expect_pending_htlcs_forwardable!(nodes[2]);
552 check_added_monitors!(&nodes[2], 1);
553 let update_3 = get_htlc_update_msgs!(nodes[2], nodes[3].node.get_our_node_id());
554 let update_add_3 = update_3.update_add_htlcs[0].clone();
555 nodes[3].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &update_add_3);
556 commitment_signed_dance!(nodes[3], nodes[2], update_3.commitment_signed, false, true);
558 assert!(nodes[3].node.get_and_clear_pending_msg_events().is_empty());
559 for (_, pending_forwards) in nodes[3].node.forward_htlcs.lock().unwrap().iter_mut() {
560 for f in pending_forwards.iter_mut() {
562 &mut HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo { ref mut forward_info, .. }) => {
563 match forward_info.routing {
564 PendingHTLCRouting::ReceiveKeysend { ref mut payment_data, .. } => {
565 *payment_data = Some(msgs::FinalOnionHopData {
566 payment_secret: PaymentSecret([42; 32]),
567 total_msat: amount * 2,
570 _ => panic!("Expected PendingHTLCRouting::ReceiveKeysend"),
577 expect_pending_htlcs_forwardable!(nodes[3]);
578 check_added_monitors!(nodes[3], 1);
580 // Fail back along nodes[2]
581 let update_fail_0 = get_htlc_update_msgs!(&nodes[3], &nodes[2].node.get_our_node_id());
582 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &update_fail_0.update_fail_htlcs[0]);
583 commitment_signed_dance!(nodes[2], nodes[3], update_fail_0.commitment_signed, false);
584 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_4_channel_id }]);
585 check_added_monitors!(nodes[2], 1);
587 let update_fail_1 = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
588 nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &update_fail_1.update_fail_htlcs[0]);
589 commitment_signed_dance!(nodes[0], nodes[2], update_fail_1.commitment_signed, false);
591 expect_payment_failed_conditions(&nodes[0], payment_hash, true, PaymentFailedConditions::new());
592 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], vec![HTLCDestination::FailedPayment { payment_hash }]);
597 fn no_pending_leak_on_initial_send_failure() {
598 // In an earlier version of our payment tracking, we'd have a retry entry even when the initial
599 // HTLC for payment failed to send due to local channel errors (e.g. peer disconnected). In this
600 // case, the user wouldn't have a PaymentId to retry the payment with, but we'd think we have a
601 // pending payment forever and never time it out.
602 // Here we test exactly that - retrying a payment when a peer was disconnected on the first
603 // try, and then check that no pending payment is being tracked.
604 let chanmon_cfgs = create_chanmon_cfgs(2);
605 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
606 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
607 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
609 create_announced_chan_between_nodes(&nodes, 0, 1);
611 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
613 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
614 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
616 unwrap_send_err!(nodes[0].node.send_payment_with_route(&route, payment_hash,
617 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
618 ), true, APIError::ChannelUnavailable { ref err },
619 assert_eq!(err, "Peer for first hop currently disconnected"));
621 assert!(!nodes[0].node.has_pending_payments());
624 fn do_retry_with_no_persist(confirm_before_reload: bool) {
625 // If we send a pending payment and `send_payment` returns success, we should always either
626 // return a payment failure event or a payment success event, and on failure the payment should
629 // In order to do so when the ChannelManager isn't immediately persisted (which is normal - its
630 // always persisted asynchronously), the ChannelManager has to reload some payment data from
631 // ChannelMonitor(s) in some cases. This tests that reloading.
633 // `confirm_before_reload` confirms the channel-closing commitment transaction on-chain prior
634 // to reloading the ChannelManager, increasing test coverage in ChannelMonitor HTLC tracking
635 // which has separate codepaths for "commitment transaction already confirmed" and not.
636 let chanmon_cfgs = create_chanmon_cfgs(3);
637 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
639 let new_chain_monitor;
640 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
641 let nodes_0_deserialized;
642 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
644 let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
645 let (_, _, chan_id_2, _) = create_announced_chan_between_nodes(&nodes, 1, 2);
647 // Serialize the ChannelManager prior to sending payments
648 let nodes_0_serialized = nodes[0].node.encode();
650 // Send two payments - one which will get to nodes[2] and will be claimed, one which we'll time
652 let amt_msat = 1_000_000;
653 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);
654 let (payment_preimage_1, payment_hash_1, _, payment_id_1) = send_along_route(&nodes[0], route.clone(), &[&nodes[1], &nodes[2]], 1_000_000);
655 let route_params = route.route_params.unwrap().clone();
656 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
657 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
658 check_added_monitors!(nodes[0], 1);
660 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
661 assert_eq!(events.len(), 1);
662 let payment_event = SendEvent::from_event(events.pop().unwrap());
663 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
665 // We relay the payment to nodes[1] while its disconnected from nodes[2], causing the payment
666 // to be returned immediately to nodes[0], without having nodes[2] fail the inbound payment
667 // which would prevent retry.
668 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id());
669 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id());
671 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
672 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
673 // nodes[1] now immediately fails the HTLC as the next-hop channel is disconnected
674 let _ = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
676 reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[2]));
678 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan_id)[0].clone();
679 if confirm_before_reload {
680 mine_transaction(&nodes[0], &as_commitment_tx);
681 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
684 // The ChannelMonitor should always be the latest version, as we're required to persist it
685 // during the `commitment_signed_dance!()`.
686 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
687 reload_node!(nodes[0], test_default_channel_config(), &nodes_0_serialized, &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
689 // On reload, the ChannelManager should realize it is stale compared to the ChannelMonitor and
690 // force-close the channel.
691 check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager, [nodes[1].node.get_our_node_id()], 100000);
692 assert!(nodes[0].node.list_channels().is_empty());
693 assert!(nodes[0].node.has_pending_payments());
694 nodes[0].node.timer_tick_occurred();
695 if !confirm_before_reload {
696 let as_broadcasted_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
697 assert_eq!(as_broadcasted_txn.len(), 1);
698 assert_eq!(as_broadcasted_txn[0].txid(), as_commitment_tx.txid());
700 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
702 check_added_monitors!(nodes[0], 1);
704 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
705 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
706 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
708 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
710 // Now nodes[1] should send a channel reestablish, which nodes[0] will respond to with an
711 // error, as the channel has hit the chain.
712 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
713 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
715 let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
716 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
717 let as_err = nodes[0].node.get_and_clear_pending_msg_events();
718 assert_eq!(as_err.len(), 2);
720 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
721 assert_eq!(node_id, nodes[1].node.get_our_node_id());
722 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), msg);
723 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}",
724 &nodes[1].node.get_our_node_id())) }, [nodes[0].node.get_our_node_id()], 100000);
725 check_added_monitors!(nodes[1], 1);
726 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
728 _ => panic!("Unexpected event"),
730 check_closed_broadcast!(nodes[1], false);
732 // Now claim the first payment, which should allow nodes[1] to claim the payment on-chain when
733 // we close in a moment.
734 nodes[2].node.claim_funds(payment_preimage_1);
735 check_added_monitors!(nodes[2], 1);
736 expect_payment_claimed!(nodes[2], payment_hash_1, 1_000_000);
738 let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
739 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
740 check_added_monitors!(nodes[1], 1);
741 commitment_signed_dance!(nodes[1], nodes[2], htlc_fulfill_updates.commitment_signed, false);
742 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], None, true, false);
744 if confirm_before_reload {
745 let best_block = nodes[0].blocks.lock().unwrap().last().unwrap().clone();
746 nodes[0].node.best_block_updated(&best_block.0.header, best_block.1);
749 // Create a new channel on which to retry the payment before we fail the payment via the
750 // HTLC-Timeout transaction. This avoids ChannelManager timing out the payment due to us
751 // connecting several blocks while creating the channel (implying time has passed).
752 create_announced_chan_between_nodes(&nodes, 0, 1);
753 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
755 mine_transaction(&nodes[1], &as_commitment_tx);
756 let bs_htlc_claim_txn = {
757 let mut txn = nodes[1].tx_broadcaster.unique_txn_broadcast();
758 assert_eq!(txn.len(), 2);
759 check_spends!(txn[0], funding_tx);
760 check_spends!(txn[1], as_commitment_tx);
764 if !confirm_before_reload {
765 mine_transaction(&nodes[0], &as_commitment_tx);
766 let txn = nodes[0].tx_broadcaster.unique_txn_broadcast();
767 assert_eq!(txn.len(), 1);
768 assert_eq!(txn[0].txid(), as_commitment_tx.txid());
770 mine_transaction(&nodes[0], &bs_htlc_claim_txn);
771 expect_payment_sent(&nodes[0], payment_preimage_1, None, true, false);
772 connect_blocks(&nodes[0], TEST_FINAL_CLTV*4 + 20);
773 let (first_htlc_timeout_tx, second_htlc_timeout_tx) = {
774 let mut txn = nodes[0].tx_broadcaster.unique_txn_broadcast();
775 assert_eq!(txn.len(), 2);
776 (txn.remove(0), txn.remove(0))
778 check_spends!(first_htlc_timeout_tx, as_commitment_tx);
779 check_spends!(second_htlc_timeout_tx, as_commitment_tx);
780 if first_htlc_timeout_tx.input[0].previous_output == bs_htlc_claim_txn.input[0].previous_output {
781 confirm_transaction(&nodes[0], &second_htlc_timeout_tx);
783 confirm_transaction(&nodes[0], &first_htlc_timeout_tx);
785 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
786 expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new());
788 // Finally, retry the payment (which was reloaded from the ChannelMonitor when nodes[0] was
789 // reloaded) via a route over the new channel, which work without issue and eventually be
790 // received and claimed at the recipient just like any other payment.
791 let (mut new_route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], 1_000_000);
793 // Update the fee on the middle hop to ensure PaymentSent events have the correct (retried) fee
794 // and not the original fee. We also update node[1]'s relevant config as
795 // do_claim_payment_along_route expects us to never overpay.
797 let per_peer_state = nodes[1].node.per_peer_state.read().unwrap();
798 let mut peer_state = per_peer_state.get(&nodes[2].node.get_our_node_id())
799 .unwrap().lock().unwrap();
800 let mut channel = peer_state.channel_by_id.get_mut(&chan_id_2).unwrap();
801 let mut new_config = channel.context().config();
802 new_config.forwarding_fee_base_msat += 100_000;
803 channel.context_mut().update_config(&new_config);
804 new_route.paths[0].hops[0].fee_msat += 100_000;
807 // Force expiration of the channel's previous config.
808 for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
809 nodes[1].node.timer_tick_occurred();
812 assert!(nodes[0].node.send_payment_with_route(&new_route, payment_hash, // Shouldn't be allowed to retry a fulfilled payment
813 RecipientOnionFields::secret_only(payment_secret), payment_id_1).is_err());
814 nodes[0].node.send_payment_with_route(&new_route, payment_hash,
815 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
816 check_added_monitors!(nodes[0], 1);
817 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
818 assert_eq!(events.len(), 1);
819 pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
820 do_claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
821 expect_payment_sent!(nodes[0], payment_preimage, Some(new_route.paths[0].hops[0].fee_msat));
825 fn retry_with_no_persist() {
826 do_retry_with_no_persist(true);
827 do_retry_with_no_persist(false);
830 fn do_test_completed_payment_not_retryable_on_reload(use_dust: bool) {
831 // Test that an off-chain completed payment is not retryable on restart. This was previously
832 // broken for dust payments, but we test for both dust and non-dust payments.
834 // `use_dust` switches to using a dust HTLC, which results in the HTLC not having an on-chain
836 let chanmon_cfgs = create_chanmon_cfgs(3);
837 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
839 let mut manually_accept_config = test_default_channel_config();
840 manually_accept_config.manually_accept_inbound_channels = true;
843 let first_new_chain_monitor;
844 let second_persister;
845 let second_new_chain_monitor;
847 let third_new_chain_monitor;
849 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(manually_accept_config), None]);
850 let first_nodes_0_deserialized;
851 let second_nodes_0_deserialized;
852 let third_nodes_0_deserialized;
854 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
856 // Because we set nodes[1] to manually accept channels, just open a 0-conf channel.
857 let (funding_tx, chan_id) = open_zero_conf_channel(&nodes[0], &nodes[1], None);
858 confirm_transaction(&nodes[0], &funding_tx);
859 confirm_transaction(&nodes[1], &funding_tx);
860 // Ignore the announcement_signatures messages
861 nodes[0].node.get_and_clear_pending_msg_events();
862 nodes[1].node.get_and_clear_pending_msg_events();
863 let chan_id_2 = create_announced_chan_between_nodes(&nodes, 1, 2).2;
865 // Serialize the ChannelManager prior to sending payments
866 let mut nodes_0_serialized = nodes[0].node.encode();
868 let route = get_route_and_payment_hash!(nodes[0], nodes[2], if use_dust { 1_000 } else { 1_000_000 }).0;
869 let (payment_preimage, payment_hash, payment_secret, payment_id) = send_along_route(&nodes[0], route, &[&nodes[1], &nodes[2]], if use_dust { 1_000 } else { 1_000_000 });
871 // The ChannelMonitor should always be the latest version, as we're required to persist it
872 // during the `commitment_signed_dance!()`.
873 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
875 reload_node!(nodes[0], test_default_channel_config(), nodes_0_serialized, &[&chan_0_monitor_serialized], first_persister, first_new_chain_monitor, first_nodes_0_deserialized);
876 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
878 // On reload, the ChannelManager should realize it is stale compared to the ChannelMonitor and
879 // force-close the channel.
880 check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager, [nodes[1].node.get_our_node_id()], 100000);
881 nodes[0].node.timer_tick_occurred();
882 assert!(nodes[0].node.list_channels().is_empty());
883 assert!(nodes[0].node.has_pending_payments());
884 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
885 check_added_monitors!(nodes[0], 1);
887 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init {
888 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
890 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
892 // Now nodes[1] should send a channel reestablish, which nodes[0] will respond to with an
893 // error, as the channel has hit the chain.
894 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init {
895 features: nodes[0].node.init_features(), networks: None, remote_network_address: None
897 let bs_reestablish = get_chan_reestablish_msgs!(nodes[1], nodes[0]).pop().unwrap();
898 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
899 let as_err = nodes[0].node.get_and_clear_pending_msg_events();
900 assert_eq!(as_err.len(), 2);
901 let bs_commitment_tx;
903 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
904 assert_eq!(node_id, nodes[1].node.get_our_node_id());
905 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), msg);
906 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", &nodes[1].node.get_our_node_id())) }
907 , [nodes[0].node.get_our_node_id()], 100000);
908 check_added_monitors!(nodes[1], 1);
909 bs_commitment_tx = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
911 _ => panic!("Unexpected event"),
913 check_closed_broadcast!(nodes[1], false);
915 // Now fail back the payment from nodes[2] to nodes[1]. This doesn't really matter as the
916 // previous hop channel is already on-chain, but it makes nodes[2] willing to see additional
917 // incoming HTLCs with the same payment hash later.
918 nodes[2].node.fail_htlc_backwards(&payment_hash);
919 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], [HTLCDestination::FailedPayment { payment_hash }]);
920 check_added_monitors!(nodes[2], 1);
922 let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
923 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &htlc_fulfill_updates.update_fail_htlcs[0]);
924 commitment_signed_dance!(nodes[1], nodes[2], htlc_fulfill_updates.commitment_signed, false);
925 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1],
926 [HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_id_2 }]);
928 // Connect the HTLC-Timeout transaction, timing out the HTLC on both nodes (but not confirming
929 // the HTLC-Timeout transaction beyond 1 conf). For dust HTLCs, the HTLC is considered resolved
930 // after the commitment transaction, so always connect the commitment transaction.
931 mine_transaction(&nodes[0], &bs_commitment_tx[0]);
932 if nodes[0].connect_style.borrow().updates_best_block_first() {
933 let _ = nodes[0].tx_broadcaster.txn_broadcast();
935 mine_transaction(&nodes[1], &bs_commitment_tx[0]);
937 connect_blocks(&nodes[0], TEST_FINAL_CLTV + (MIN_CLTV_EXPIRY_DELTA as u32));
938 connect_blocks(&nodes[1], TEST_FINAL_CLTV + (MIN_CLTV_EXPIRY_DELTA as u32));
939 let as_htlc_timeout = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
940 assert_eq!(as_htlc_timeout.len(), 1);
941 check_spends!(as_htlc_timeout[0], bs_commitment_tx[0]);
943 mine_transaction(&nodes[0], &as_htlc_timeout[0]);
944 mine_transaction(&nodes[1], &as_htlc_timeout[0]);
946 if nodes[0].connect_style.borrow().updates_best_block_first() {
947 let _ = nodes[0].tx_broadcaster.txn_broadcast();
950 // Create a new channel on which to retry the payment before we fail the payment via the
951 // HTLC-Timeout transaction. This avoids ChannelManager timing out the payment due to us
952 // connecting several blocks while creating the channel (implying time has passed).
953 // We do this with a zero-conf channel to avoid connecting blocks as a side-effect.
954 let (_, chan_id_3) = open_zero_conf_channel(&nodes[0], &nodes[1], None);
955 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
957 // If we attempt to retry prior to the HTLC-Timeout (or commitment transaction, for dust HTLCs)
958 // confirming, we will fail as it's considered still-pending...
959 let (new_route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], if use_dust { 1_000 } else { 1_000_000 });
960 match nodes[0].node.send_payment_with_route(&new_route, payment_hash, RecipientOnionFields::secret_only(payment_secret), payment_id) {
961 Err(PaymentSendFailure::DuplicatePayment) => {},
962 _ => panic!("Unexpected error")
964 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
966 // After ANTI_REORG_DELAY confirmations, the HTLC should be failed and we can try the payment
967 // again. We serialize the node first as we'll then test retrying the HTLC after a restart
968 // (which should also still work).
969 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
970 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
971 expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new());
973 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
974 let chan_1_monitor_serialized = get_monitor!(nodes[0], chan_id_3).encode();
975 nodes_0_serialized = nodes[0].node.encode();
977 // After the payment failed, we're free to send it again.
978 assert!(nodes[0].node.send_payment_with_route(&new_route, payment_hash,
979 RecipientOnionFields::secret_only(payment_secret), payment_id).is_ok());
980 assert!(!nodes[0].node.get_and_clear_pending_msg_events().is_empty());
982 reload_node!(nodes[0], test_default_channel_config(), nodes_0_serialized, &[&chan_0_monitor_serialized, &chan_1_monitor_serialized], second_persister, second_new_chain_monitor, second_nodes_0_deserialized);
983 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
985 nodes[0].node.test_process_background_events();
986 check_added_monitors(&nodes[0], 1);
988 let mut reconnect_args = ReconnectArgs::new(&nodes[0], &nodes[1]);
989 reconnect_args.send_channel_ready = (true, true);
990 reconnect_nodes(reconnect_args);
992 // Now resend the payment, delivering the HTLC and actually claiming it this time. This ensures
993 // the payment is not (spuriously) listed as still pending.
994 assert!(nodes[0].node.send_payment_with_route(&new_route, payment_hash,
995 RecipientOnionFields::secret_only(payment_secret), payment_id).is_ok());
996 check_added_monitors!(nodes[0], 1);
997 pass_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], if use_dust { 1_000 } else { 1_000_000 }, payment_hash, payment_secret);
998 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
1000 match nodes[0].node.send_payment_with_route(&new_route, payment_hash, RecipientOnionFields::secret_only(payment_secret), payment_id) {
1001 Err(PaymentSendFailure::DuplicatePayment) => {},
1002 _ => panic!("Unexpected error")
1004 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1006 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
1007 let chan_1_monitor_serialized = get_monitor!(nodes[0], chan_id_3).encode();
1008 nodes_0_serialized = nodes[0].node.encode();
1010 // Check that after reload we can send the payment again (though we shouldn't, since it was
1011 // claimed previously).
1012 reload_node!(nodes[0], test_default_channel_config(), nodes_0_serialized, &[&chan_0_monitor_serialized, &chan_1_monitor_serialized], third_persister, third_new_chain_monitor, third_nodes_0_deserialized);
1013 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1015 nodes[0].node.test_process_background_events();
1016 check_added_monitors(&nodes[0], 1);
1018 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
1020 match nodes[0].node.send_payment_with_route(&new_route, payment_hash, RecipientOnionFields::secret_only(payment_secret), payment_id) {
1021 Err(PaymentSendFailure::DuplicatePayment) => {},
1022 _ => panic!("Unexpected error")
1024 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1028 fn test_completed_payment_not_retryable_on_reload() {
1029 do_test_completed_payment_not_retryable_on_reload(true);
1030 do_test_completed_payment_not_retryable_on_reload(false);
1033 fn do_test_dup_htlc_onchain_doesnt_fail_on_reload(persist_manager_post_event: bool, confirm_commitment_tx: bool, payment_timeout: bool) {
1034 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
1035 // dropped. From there, the ChannelManager relies on the ChannelMonitor having a copy of the
1036 // relevant fail-/claim-back data and processes the HTLC fail/claim when the ChannelMonitor tells
1039 // If, due to an on-chain event, an HTLC is failed/claimed, we provide the
1040 // ChannelManager with the HTLC event without waiting for ChannelMonitor persistence.
1041 // This might generate duplicate HTLC fail/claim (e.g. via a PaymentPathFailed event) on reload.
1042 let chanmon_cfgs = create_chanmon_cfgs(2);
1043 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1045 let new_chain_monitor;
1046 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1047 let nodes_0_deserialized;
1048 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1050 let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
1052 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
1054 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 10_000_000);
1055 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
1056 check_closed_broadcast!(nodes[0], true);
1057 check_added_monitors!(nodes[0], 1);
1058 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
1060 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1061 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id());
1063 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
1064 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
1065 let (commitment_tx, htlc_timeout_tx) = {
1066 let mut txn = nodes[0].tx_broadcaster.unique_txn_broadcast();
1067 assert_eq!(txn.len(), 2);
1068 check_spends!(txn[0], funding_tx);
1069 check_spends!(txn[1], txn[0]);
1070 (txn.remove(0), txn.remove(0))
1073 nodes[1].node.claim_funds(payment_preimage);
1074 check_added_monitors!(nodes[1], 1);
1075 expect_payment_claimed!(nodes[1], payment_hash, 10_000_000);
1077 mine_transaction(&nodes[1], &commitment_tx);
1078 check_closed_broadcast!(nodes[1], true);
1079 check_added_monitors!(nodes[1], 1);
1080 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
1081 let htlc_success_tx = {
1082 let mut txn = nodes[1].tx_broadcaster.txn_broadcast();
1083 assert_eq!(txn.len(), 1);
1084 check_spends!(txn[0], commitment_tx);
1088 mine_transaction(&nodes[0], &commitment_tx);
1090 if confirm_commitment_tx {
1091 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
1094 let claim_block = create_dummy_block(nodes[0].best_block_hash(), 42, if payment_timeout { vec![htlc_timeout_tx] } else { vec![htlc_success_tx] });
1096 if payment_timeout {
1097 assert!(confirm_commitment_tx); // Otherwise we're spending below our CSV!
1098 connect_block(&nodes[0], &claim_block);
1099 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 2);
1102 // Now connect the HTLC claim transaction with the ChainMonitor-generated ChannelMonitor update
1103 // returning InProgress. This should cause the claim event to never make its way to the
1105 chanmon_cfgs[0].persister.set_update_ret(ChannelMonitorUpdateStatus::InProgress);
1107 if payment_timeout {
1108 connect_blocks(&nodes[0], 1);
1110 connect_block(&nodes[0], &claim_block);
1113 // Note that we skip persisting ChannelMonitors. We should still be generating the payment sent
1114 // event without ChannelMonitor persistence. If we reset to a previous state on reload, the block
1115 // should be replayed and we'll regenerate the event.
1117 // If we persist the ChannelManager here, we should get the PaymentSent event after
1119 let mut chan_manager_serialized = Vec::new();
1120 if !persist_manager_post_event {
1121 chan_manager_serialized = nodes[0].node.encode();
1124 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
1125 if payment_timeout {
1126 expect_payment_failed!(nodes[0], payment_hash, false);
1128 expect_payment_sent(&nodes[0], payment_preimage, None, true, false);
1131 // If we persist the ChannelManager after we get the PaymentSent event, we shouldn't get it
1133 if persist_manager_post_event {
1134 chan_manager_serialized = nodes[0].node.encode();
1137 // Now reload nodes[0]...
1138 reload_node!(nodes[0], &chan_manager_serialized, &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
1140 if persist_manager_post_event {
1141 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1142 } else if payment_timeout {
1143 expect_payment_failed!(nodes[0], payment_hash, false);
1145 expect_payment_sent(&nodes[0], payment_preimage, None, true, false);
1148 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
1149 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
1150 // payment events should kick in, leaving us with no pending events here.
1151 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
1152 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
1153 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1154 check_added_monitors(&nodes[0], 1);
1158 fn test_dup_htlc_onchain_doesnt_fail_on_reload() {
1159 do_test_dup_htlc_onchain_doesnt_fail_on_reload(true, true, true);
1160 do_test_dup_htlc_onchain_doesnt_fail_on_reload(true, true, false);
1161 do_test_dup_htlc_onchain_doesnt_fail_on_reload(true, false, false);
1162 do_test_dup_htlc_onchain_doesnt_fail_on_reload(false, true, true);
1163 do_test_dup_htlc_onchain_doesnt_fail_on_reload(false, true, false);
1164 do_test_dup_htlc_onchain_doesnt_fail_on_reload(false, false, false);
1168 fn test_fulfill_restart_failure() {
1169 // When we receive an update_fulfill_htlc message, we immediately consider the HTLC fully
1170 // fulfilled. At this point, the peer can reconnect and decide to either fulfill the HTLC
1171 // again, or fail it, giving us free money.
1173 // Of course probably they won't fail it and give us free money, but because we have code to
1174 // handle it, we should test the logic for it anyway. We do that here.
1175 let chanmon_cfgs = create_chanmon_cfgs(2);
1176 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1178 let new_chain_monitor;
1179 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1180 let nodes_1_deserialized;
1181 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1183 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1184 let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
1186 // The simplest way to get a failure after a fulfill is to reload nodes[1] from a state
1187 // pre-fulfill, which we do by serializing it here.
1188 let chan_manager_serialized = nodes[1].node.encode();
1189 let chan_0_monitor_serialized = get_monitor!(nodes[1], chan_id).encode();
1191 nodes[1].node.claim_funds(payment_preimage);
1192 check_added_monitors!(nodes[1], 1);
1193 expect_payment_claimed!(nodes[1], payment_hash, 100_000);
1195 let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1196 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
1197 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
1199 // Now reload nodes[1]...
1200 reload_node!(nodes[1], &chan_manager_serialized, &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_1_deserialized);
1202 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id());
1203 reconnect_nodes(ReconnectArgs::new(&nodes[0], &nodes[1]));
1205 nodes[1].node.fail_htlc_backwards(&payment_hash);
1206 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
1207 check_added_monitors!(nodes[1], 1);
1208 let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1209 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
1210 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, false);
1211 // nodes[0] shouldn't generate any events here, while it just got a payment failure completion
1212 // it had already considered the payment fulfilled, and now they just got free money.
1213 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1217 fn get_ldk_payment_preimage() {
1218 // Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
1219 let chanmon_cfgs = create_chanmon_cfgs(2);
1220 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1221 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1222 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1223 create_announced_chan_between_nodes(&nodes, 0, 1);
1225 let amt_msat = 60_000;
1226 let expiry_secs = 60 * 60;
1227 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs, None).unwrap();
1229 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
1230 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
1231 let scorer = test_utils::TestScorer::new();
1232 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
1233 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1234 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
1235 let route = get_route( &nodes[0].node.get_our_node_id(), &route_params,
1236 &nodes[0].network_graph.read_only(),
1237 Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()), nodes[0].logger,
1238 &scorer, &Default::default(), &random_seed_bytes).unwrap();
1239 nodes[0].node.send_payment_with_route(&route, payment_hash,
1240 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1241 check_added_monitors!(nodes[0], 1);
1243 // Make sure to use `get_payment_preimage`
1244 let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
1245 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1246 assert_eq!(events.len(), 1);
1247 pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
1248 claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);
1252 fn sent_probe_is_probe_of_sending_node() {
1253 let chanmon_cfgs = create_chanmon_cfgs(3);
1254 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1255 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None, None]);
1256 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1258 create_announced_chan_between_nodes(&nodes, 0, 1);
1259 create_announced_chan_between_nodes(&nodes, 1, 2);
1261 // First check we refuse to build a single-hop probe
1262 let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
1263 assert!(nodes[0].node.send_probe(route.paths[0].clone()).is_err());
1265 // Then build an actual two-hop probing path
1266 let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], 100_000);
1268 match nodes[0].node.send_probe(route.paths[0].clone()) {
1269 Ok((payment_hash, payment_id)) => {
1270 assert!(nodes[0].node.payment_is_probe(&payment_hash, &payment_id));
1271 assert!(!nodes[1].node.payment_is_probe(&payment_hash, &payment_id));
1272 assert!(!nodes[2].node.payment_is_probe(&payment_hash, &payment_id));
1277 get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1278 check_added_monitors!(nodes[0], 1);
1282 fn successful_probe_yields_event() {
1283 let chanmon_cfgs = create_chanmon_cfgs(3);
1284 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1285 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None, None]);
1286 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1288 create_announced_chan_between_nodes(&nodes, 0, 1);
1289 create_announced_chan_between_nodes(&nodes, 1, 2);
1291 let recv_value = 100_000;
1292 let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], recv_value);
1294 let res = nodes[0].node.send_probe(route.paths[0].clone()).unwrap();
1296 let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[2]]];
1298 send_probe_along_route(&nodes[0], expected_route);
1300 expect_probe_successful_events(&nodes[0], vec![res]);
1302 assert!(!nodes[0].node.has_pending_payments());
1306 fn failed_probe_yields_event() {
1307 let chanmon_cfgs = create_chanmon_cfgs(3);
1308 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1309 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None, None]);
1310 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1312 create_announced_chan_between_nodes(&nodes, 0, 1);
1313 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 90000000);
1315 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), 42);
1317 let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], payment_params, 9_998_000);
1319 let (payment_hash, payment_id) = nodes[0].node.send_probe(route.paths[0].clone()).unwrap();
1321 // node[0] -- update_add_htlcs -> node[1]
1322 check_added_monitors!(nodes[0], 1);
1323 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1324 let probe_event = SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), updates);
1325 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &probe_event.msgs[0]);
1326 check_added_monitors!(nodes[1], 0);
1327 commitment_signed_dance!(nodes[1], nodes[0], probe_event.commitment_msg, false);
1328 expect_pending_htlcs_forwardable!(nodes[1]);
1330 // node[0] <- update_fail_htlcs -- node[1]
1331 check_added_monitors!(nodes[1], 1);
1332 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1333 // Skip the PendingHTLCsForwardable event
1334 let _events = nodes[1].node.get_and_clear_pending_events();
1335 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
1336 check_added_monitors!(nodes[0], 0);
1337 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
1339 let mut events = nodes[0].node.get_and_clear_pending_events();
1340 assert_eq!(events.len(), 1);
1341 match events.drain(..).next().unwrap() {
1342 crate::events::Event::ProbeFailed { payment_id: ev_pid, payment_hash: ev_ph, .. } => {
1343 assert_eq!(payment_id, ev_pid);
1344 assert_eq!(payment_hash, ev_ph);
1348 assert!(!nodes[0].node.has_pending_payments());
1352 fn onchain_failed_probe_yields_event() {
1353 // Tests that an attempt to probe over a channel that is eventaully closed results in a failure
1355 let chanmon_cfgs = create_chanmon_cfgs(3);
1356 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1357 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1358 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1360 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1361 create_announced_chan_between_nodes(&nodes, 1, 2);
1363 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), 42);
1365 // Send a dust HTLC, which will be treated as if it timed out once the channel hits the chain.
1366 let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], payment_params, 1_000);
1367 let (payment_hash, payment_id) = nodes[0].node.send_probe(route.paths[0].clone()).unwrap();
1369 // node[0] -- update_add_htlcs -> node[1]
1370 check_added_monitors!(nodes[0], 1);
1371 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1372 let probe_event = SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), updates);
1373 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &probe_event.msgs[0]);
1374 check_added_monitors!(nodes[1], 0);
1375 commitment_signed_dance!(nodes[1], nodes[0], probe_event.commitment_msg, false);
1376 expect_pending_htlcs_forwardable!(nodes[1]);
1378 check_added_monitors!(nodes[1], 1);
1379 let _ = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1381 // Don't bother forwarding the HTLC onwards and just confirm the force-close transaction on
1382 // Node A, which after 6 confirmations should result in a probe failure event.
1383 let bs_txn = get_local_commitment_txn!(nodes[1], chan_id);
1384 confirm_transaction(&nodes[0], &bs_txn[0]);
1385 check_closed_broadcast!(&nodes[0], true);
1386 check_added_monitors!(nodes[0], 1);
1388 let mut events = nodes[0].node.get_and_clear_pending_events();
1389 assert_eq!(events.len(), 2);
1390 let mut found_probe_failed = false;
1391 for event in events.drain(..) {
1393 Event::ProbeFailed { payment_id: ev_pid, payment_hash: ev_ph, .. } => {
1394 assert_eq!(payment_id, ev_pid);
1395 assert_eq!(payment_hash, ev_ph);
1396 found_probe_failed = true;
1398 Event::ChannelClosed { .. } => {},
1402 assert!(found_probe_failed);
1403 assert!(!nodes[0].node.has_pending_payments());
1407 fn preflight_probes_yield_event_skip_private_hop() {
1408 let chanmon_cfgs = create_chanmon_cfgs(5);
1409 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1411 // We alleviate the HTLC max-in-flight limit, as otherwise we'd always be limited through that.
1412 let mut no_htlc_limit_config = test_default_channel_config();
1413 no_htlc_limit_config.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 100;
1415 let user_configs = std::iter::repeat(no_htlc_limit_config).take(5).map(|c| Some(c)).collect::<Vec<Option<UserConfig>>>();
1416 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &user_configs);
1417 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1419 // Setup channel topology:
1420 // N0 -(1M:0)- N1 -(1M:0)- N2 -(70k:0)- N3 -(50k:0)- N4
1422 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
1423 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1_000_000, 0);
1424 create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 70_000, 0);
1425 create_unannounced_chan_between_nodes_with_value(&nodes, 3, 4, 50_000, 0);
1427 let mut invoice_features = Bolt11InvoiceFeatures::empty();
1428 invoice_features.set_basic_mpp_optional();
1430 let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
1431 .with_bolt11_features(invoice_features).unwrap();
1433 let recv_value = 50_000_000;
1434 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
1435 let res = nodes[0].node.send_preflight_probes(route_params, None).unwrap();
1437 let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[2], &nodes[3]]];
1439 assert_eq!(res.len(), expected_route.len());
1441 send_probe_along_route(&nodes[0], expected_route);
1443 expect_probe_successful_events(&nodes[0], res.clone());
1445 assert!(!nodes[0].node.has_pending_payments());
1449 fn preflight_probes_yield_event() {
1450 let chanmon_cfgs = create_chanmon_cfgs(4);
1451 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1453 // We alleviate the HTLC max-in-flight limit, as otherwise we'd always be limited through that.
1454 let mut no_htlc_limit_config = test_default_channel_config();
1455 no_htlc_limit_config.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 100;
1457 let user_configs = std::iter::repeat(no_htlc_limit_config).take(4).map(|c| Some(c)).collect::<Vec<Option<UserConfig>>>();
1458 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &user_configs);
1459 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1461 // Setup channel topology:
1462 // (1M:0)- N1 -(30k:0)
1466 // (1M:0)- N2 -(70k:0)
1468 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
1469 create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0);
1470 create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 30_000, 0);
1471 create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 70_000, 0);
1473 let mut invoice_features = Bolt11InvoiceFeatures::empty();
1474 invoice_features.set_basic_mpp_optional();
1476 let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
1477 .with_bolt11_features(invoice_features).unwrap();
1479 let recv_value = 50_000_000;
1480 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
1481 let res = nodes[0].node.send_preflight_probes(route_params, None).unwrap();
1483 let expected_route: &[&[&Node]] = &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]];
1485 assert_eq!(res.len(), expected_route.len());
1487 send_probe_along_route(&nodes[0], expected_route);
1489 expect_probe_successful_events(&nodes[0], res.clone());
1491 assert!(!nodes[0].node.has_pending_payments());
1495 fn preflight_probes_yield_event_and_skip() {
1496 let chanmon_cfgs = create_chanmon_cfgs(5);
1497 let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1499 // We alleviate the HTLC max-in-flight limit, as otherwise we'd always be limited through that.
1500 let mut no_htlc_limit_config = test_default_channel_config();
1501 no_htlc_limit_config.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 100;
1503 let user_configs = std::iter::repeat(no_htlc_limit_config).take(5).map(|c| Some(c)).collect::<Vec<Option<UserConfig>>>();
1504 let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &user_configs);
1505 let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1507 // Setup channel topology:
1508 // (30k:0)- N2 -(1M:0)
1510 // N0 -(100k:0)-> N1 N4
1512 // (70k:0)- N3 -(1M:0)
1514 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
1515 create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 30_000, 0);
1516 create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 70_000, 0);
1517 create_announced_chan_between_nodes_with_value(&nodes, 2, 4, 1_000_000, 0);
1518 create_announced_chan_between_nodes_with_value(&nodes, 3, 4, 1_000_000, 0);
1520 let mut invoice_features = Bolt11InvoiceFeatures::empty();
1521 invoice_features.set_basic_mpp_optional();
1523 let payment_params = PaymentParameters::from_node_id(nodes[4].node.get_our_node_id(), TEST_FINAL_CLTV)
1524 .with_bolt11_features(invoice_features).unwrap();
1526 let recv_value = 80_000_000;
1527 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
1528 let res = nodes[0].node.send_preflight_probes(route_params, None).unwrap();
1530 let expected_route : &[&[&Node]] = &[&[&nodes[1], &nodes[2], &nodes[4]]];
1532 // We check that only one probe was sent, the other one was skipped due to limited liquidity.
1533 assert_eq!(res.len(), 1);
1535 send_probe_along_route(&nodes[0], expected_route);
1537 expect_probe_successful_events(&nodes[0], res.clone());
1539 assert!(!nodes[0].node.has_pending_payments());
1543 fn claimed_send_payment_idempotent() {
1544 // Tests that `send_payment` (and friends) are (reasonably) idempotent.
1545 let chanmon_cfgs = create_chanmon_cfgs(2);
1546 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1547 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1548 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1550 create_announced_chan_between_nodes(&nodes, 0, 1).2;
1552 let (route, second_payment_hash, second_payment_preimage, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
1553 let (first_payment_preimage, _, _, payment_id) = send_along_route(&nodes[0], route.clone(), &[&nodes[1]], 100_000);
1555 macro_rules! check_send_rejected {
1557 // If we try to resend a new payment with a different payment_hash but with the same
1558 // payment_id, it should be rejected.
1559 let send_result = nodes[0].node.send_payment_with_route(&route, second_payment_hash,
1560 RecipientOnionFields::secret_only(second_payment_secret), payment_id);
1562 Err(PaymentSendFailure::DuplicatePayment) => {},
1563 _ => panic!("Unexpected send result: {:?}", send_result),
1566 // Further, if we try to send a spontaneous payment with the same payment_id it should
1567 // also be rejected.
1568 let send_result = nodes[0].node.send_spontaneous_payment(
1569 &route, None, RecipientOnionFields::spontaneous_empty(), payment_id);
1571 Err(PaymentSendFailure::DuplicatePayment) => {},
1572 _ => panic!("Unexpected send result: {:?}", send_result),
1577 check_send_rejected!();
1579 // Claim the payment backwards, but note that the PaymentSent event is still pending and has
1580 // not been seen by the user. At this point, from the user perspective nothing has changed, so
1581 // we must remain just as idempotent as we were before.
1582 do_claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, first_payment_preimage);
1584 for _ in 0..=IDEMPOTENCY_TIMEOUT_TICKS {
1585 nodes[0].node.timer_tick_occurred();
1588 check_send_rejected!();
1590 // Once the user sees and handles the `PaymentSent` event, we expect them to no longer call
1591 // `send_payment`, and our idempotency guarantees are off - they should have atomically marked
1592 // the payment complete. However, they could have called `send_payment` while the event was
1593 // being processed, leading to a race in our idempotency guarantees. Thus, even immediately
1594 // after the event is handled a duplicate payment should sitll be rejected.
1595 expect_payment_sent!(&nodes[0], first_payment_preimage, Some(0));
1596 check_send_rejected!();
1598 // If relatively little time has passed, a duplicate payment should still fail.
1599 nodes[0].node.timer_tick_occurred();
1600 check_send_rejected!();
1602 // However, after some time has passed (at least more than the one timer tick above), a
1603 // duplicate payment should go through, as ChannelManager should no longer have any remaining
1604 // references to the old payment data.
1605 for _ in 0..IDEMPOTENCY_TIMEOUT_TICKS {
1606 nodes[0].node.timer_tick_occurred();
1609 nodes[0].node.send_payment_with_route(&route, second_payment_hash,
1610 RecipientOnionFields::secret_only(second_payment_secret), payment_id).unwrap();
1611 check_added_monitors!(nodes[0], 1);
1612 pass_along_route(&nodes[0], &[&[&nodes[1]]], 100_000, second_payment_hash, second_payment_secret);
1613 claim_payment(&nodes[0], &[&nodes[1]], second_payment_preimage);
1617 fn abandoned_send_payment_idempotent() {
1618 // Tests that `send_payment` (and friends) allow duplicate PaymentIds immediately after
1620 let chanmon_cfgs = create_chanmon_cfgs(2);
1621 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1622 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1623 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1625 create_announced_chan_between_nodes(&nodes, 0, 1).2;
1627 let (route, second_payment_hash, second_payment_preimage, second_payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
1628 let (_, first_payment_hash, _, payment_id) = send_along_route(&nodes[0], route.clone(), &[&nodes[1]], 100_000);
1630 macro_rules! check_send_rejected {
1632 // If we try to resend a new payment with a different payment_hash but with the same
1633 // payment_id, it should be rejected.
1634 let send_result = nodes[0].node.send_payment_with_route(&route, second_payment_hash,
1635 RecipientOnionFields::secret_only(second_payment_secret), payment_id);
1637 Err(PaymentSendFailure::DuplicatePayment) => {},
1638 _ => panic!("Unexpected send result: {:?}", send_result),
1641 // Further, if we try to send a spontaneous payment with the same payment_id it should
1642 // also be rejected.
1643 let send_result = nodes[0].node.send_spontaneous_payment(
1644 &route, None, RecipientOnionFields::spontaneous_empty(), payment_id);
1646 Err(PaymentSendFailure::DuplicatePayment) => {},
1647 _ => panic!("Unexpected send result: {:?}", send_result),
1652 check_send_rejected!();
1654 nodes[1].node.fail_htlc_backwards(&first_payment_hash);
1655 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], [HTLCDestination::FailedPayment { payment_hash: first_payment_hash }]);
1657 // Until we abandon the payment upon path failure, no matter how many timer ticks pass, we still cannot reuse the
1659 for _ in 0..=IDEMPOTENCY_TIMEOUT_TICKS {
1660 nodes[0].node.timer_tick_occurred();
1662 check_send_rejected!();
1664 pass_failed_payment_back(&nodes[0], &[&[&nodes[1]]], false, first_payment_hash, PaymentFailureReason::RecipientRejected);
1666 // However, we can reuse the PaymentId immediately after we `abandon_payment` upon passing the
1667 // failed payment back.
1668 nodes[0].node.send_payment_with_route(&route, second_payment_hash,
1669 RecipientOnionFields::secret_only(second_payment_secret), payment_id).unwrap();
1670 check_added_monitors!(nodes[0], 1);
1671 pass_along_route(&nodes[0], &[&[&nodes[1]]], 100_000, second_payment_hash, second_payment_secret);
1672 claim_payment(&nodes[0], &[&nodes[1]], second_payment_preimage);
1675 #[derive(PartialEq)]
1676 enum InterceptTest {
1683 fn test_trivial_inflight_htlc_tracking(){
1684 // In this test, we test three scenarios:
1685 // (1) Sending + claiming a payment successfully should return `None` when querying InFlightHtlcs
1686 // (2) Sending a payment without claiming it should return the payment's value (500000) when querying InFlightHtlcs
1687 // (3) After we claim the payment sent in (2), InFlightHtlcs should return `None` for the query.
1688 let chanmon_cfgs = create_chanmon_cfgs(3);
1689 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1690 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1691 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1693 let (_, _, chan_1_id, _) = create_announced_chan_between_nodes(&nodes, 0, 1);
1694 let (_, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 1, 2);
1696 // Send and claim the payment. Inflight HTLCs should be empty.
1697 let (_, payment_hash, _, payment_id) = send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 500000);
1698 let inflight_htlcs = node_chanmgrs[0].compute_inflight_htlcs();
1700 let mut node_0_per_peer_lock;
1701 let mut node_0_peer_state_lock;
1702 let channel_1 = get_channel_ref!(&nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_1_id);
1704 let chan_1_used_liquidity = inflight_htlcs.used_liquidity_msat(
1705 &NodeId::from_pubkey(&nodes[0].node.get_our_node_id()) ,
1706 &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()),
1707 channel_1.context().get_short_channel_id().unwrap()
1709 assert_eq!(chan_1_used_liquidity, None);
1712 let mut node_1_per_peer_lock;
1713 let mut node_1_peer_state_lock;
1714 let channel_2 = get_channel_ref!(&nodes[1], nodes[2], node_1_per_peer_lock, node_1_peer_state_lock, chan_2_id);
1716 let chan_2_used_liquidity = inflight_htlcs.used_liquidity_msat(
1717 &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()) ,
1718 &NodeId::from_pubkey(&nodes[2].node.get_our_node_id()),
1719 channel_2.context().get_short_channel_id().unwrap()
1722 assert_eq!(chan_2_used_liquidity, None);
1724 let pending_payments = nodes[0].node.list_recent_payments();
1725 assert_eq!(pending_payments.len(), 1);
1726 assert_eq!(pending_payments[0], RecentPaymentDetails::Fulfilled { payment_hash: Some(payment_hash), payment_id });
1728 // Remove fulfilled payment
1729 for _ in 0..=IDEMPOTENCY_TIMEOUT_TICKS {
1730 nodes[0].node.timer_tick_occurred();
1733 // Send the payment, but do not claim it. Our inflight HTLCs should contain the pending payment.
1734 let (payment_preimage, payment_hash, _, payment_id) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 500000);
1735 let inflight_htlcs = node_chanmgrs[0].compute_inflight_htlcs();
1737 let mut node_0_per_peer_lock;
1738 let mut node_0_peer_state_lock;
1739 let channel_1 = get_channel_ref!(&nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_1_id);
1741 let chan_1_used_liquidity = inflight_htlcs.used_liquidity_msat(
1742 &NodeId::from_pubkey(&nodes[0].node.get_our_node_id()) ,
1743 &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()),
1744 channel_1.context().get_short_channel_id().unwrap()
1746 // First hop accounts for expected 1000 msat fee
1747 assert_eq!(chan_1_used_liquidity, Some(501000));
1750 let mut node_1_per_peer_lock;
1751 let mut node_1_peer_state_lock;
1752 let channel_2 = get_channel_ref!(&nodes[1], nodes[2], node_1_per_peer_lock, node_1_peer_state_lock, chan_2_id);
1754 let chan_2_used_liquidity = inflight_htlcs.used_liquidity_msat(
1755 &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()) ,
1756 &NodeId::from_pubkey(&nodes[2].node.get_our_node_id()),
1757 channel_2.context().get_short_channel_id().unwrap()
1760 assert_eq!(chan_2_used_liquidity, Some(500000));
1762 let pending_payments = nodes[0].node.list_recent_payments();
1763 assert_eq!(pending_payments.len(), 1);
1764 assert_eq!(pending_payments[0], RecentPaymentDetails::Pending { payment_id, payment_hash, total_msat: 500000 });
1766 // Now, let's claim the payment. This should result in the used liquidity to return `None`.
1767 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage);
1769 // Remove fulfilled payment
1770 for _ in 0..=IDEMPOTENCY_TIMEOUT_TICKS {
1771 nodes[0].node.timer_tick_occurred();
1774 let inflight_htlcs = node_chanmgrs[0].compute_inflight_htlcs();
1776 let mut node_0_per_peer_lock;
1777 let mut node_0_peer_state_lock;
1778 let channel_1 = get_channel_ref!(&nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, chan_1_id);
1780 let chan_1_used_liquidity = inflight_htlcs.used_liquidity_msat(
1781 &NodeId::from_pubkey(&nodes[0].node.get_our_node_id()) ,
1782 &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()),
1783 channel_1.context().get_short_channel_id().unwrap()
1785 assert_eq!(chan_1_used_liquidity, None);
1788 let mut node_1_per_peer_lock;
1789 let mut node_1_peer_state_lock;
1790 let channel_2 = get_channel_ref!(&nodes[1], nodes[2], node_1_per_peer_lock, node_1_peer_state_lock, chan_2_id);
1792 let chan_2_used_liquidity = inflight_htlcs.used_liquidity_msat(
1793 &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()) ,
1794 &NodeId::from_pubkey(&nodes[2].node.get_our_node_id()),
1795 channel_2.context().get_short_channel_id().unwrap()
1797 assert_eq!(chan_2_used_liquidity, None);
1800 let pending_payments = nodes[0].node.list_recent_payments();
1801 assert_eq!(pending_payments.len(), 0);
1805 fn test_holding_cell_inflight_htlcs() {
1806 let chanmon_cfgs = create_chanmon_cfgs(2);
1807 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1808 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1809 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1810 let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1812 let (route, payment_hash_1, _, payment_secret_1) = get_route_and_payment_hash!(nodes[0], nodes[1], 1000000);
1813 let (_, payment_hash_2, payment_secret_2) = get_payment_preimage_hash!(nodes[1]);
1815 // Queue up two payments - one will be delivered right away, one immediately goes into the
1816 // holding cell as nodes[0] is AwaitingRAA.
1818 nodes[0].node.send_payment_with_route(&route, payment_hash_1,
1819 RecipientOnionFields::secret_only(payment_secret_1), PaymentId(payment_hash_1.0)).unwrap();
1820 check_added_monitors!(nodes[0], 1);
1821 nodes[0].node.send_payment_with_route(&route, payment_hash_2,
1822 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
1823 check_added_monitors!(nodes[0], 0);
1826 let inflight_htlcs = node_chanmgrs[0].compute_inflight_htlcs();
1829 let mut node_0_per_peer_lock;
1830 let mut node_0_peer_state_lock;
1831 let channel = get_channel_ref!(&nodes[0], nodes[1], node_0_per_peer_lock, node_0_peer_state_lock, channel_id);
1833 let used_liquidity = inflight_htlcs.used_liquidity_msat(
1834 &NodeId::from_pubkey(&nodes[0].node.get_our_node_id()) ,
1835 &NodeId::from_pubkey(&nodes[1].node.get_our_node_id()),
1836 channel.context().get_short_channel_id().unwrap()
1839 assert_eq!(used_liquidity, Some(2000000));
1842 // Clear pending events so test doesn't throw a "Had excess message on node..." error
1843 nodes[0].node.get_and_clear_pending_msg_events();
1847 fn intercepted_payment() {
1848 // Test that detecting an intercept scid on payment forward will signal LDK to generate an
1849 // intercept event, which the LSP can then use to either (a) open a JIT channel to forward the
1850 // payment or (b) fail the payment.
1851 do_test_intercepted_payment(InterceptTest::Forward);
1852 do_test_intercepted_payment(InterceptTest::Fail);
1853 // Make sure that intercepted payments will be automatically failed back if too many blocks pass.
1854 do_test_intercepted_payment(InterceptTest::Timeout);
1857 fn do_test_intercepted_payment(test: InterceptTest) {
1858 let chanmon_cfgs = create_chanmon_cfgs(3);
1859 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1861 let mut zero_conf_chan_config = test_default_channel_config();
1862 zero_conf_chan_config.manually_accept_inbound_channels = true;
1863 let mut intercept_forwards_config = test_default_channel_config();
1864 intercept_forwards_config.accept_intercept_htlcs = true;
1865 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(intercept_forwards_config), Some(zero_conf_chan_config)]);
1867 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1868 let scorer = test_utils::TestScorer::new();
1869 let random_seed_bytes = chanmon_cfgs[0].keys_manager.get_secure_random_bytes();
1871 let _ = create_announced_chan_between_nodes(&nodes, 0, 1).2;
1873 let amt_msat = 100_000;
1874 let intercept_scid = nodes[1].node.get_intercept_scid();
1875 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
1876 .with_route_hints(vec![
1877 RouteHint(vec![RouteHintHop {
1878 src_node_id: nodes[1].node.get_our_node_id(),
1879 short_channel_id: intercept_scid,
1882 proportional_millionths: 0,
1884 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
1885 htlc_minimum_msat: None,
1886 htlc_maximum_msat: None,
1889 .with_bolt11_features(nodes[2].node.bolt11_invoice_features()).unwrap();
1890 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
1891 let route = get_route(
1892 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(), None,
1893 nodes[0].logger, &scorer, &Default::default(), &random_seed_bytes
1896 let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60, None).unwrap();
1897 nodes[0].node.send_payment_with_route(&route, payment_hash,
1898 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
1899 let payment_event = {
1901 let mut added_monitors = nodes[0].chain_monitor.added_monitors.lock().unwrap();
1902 assert_eq!(added_monitors.len(), 1);
1903 added_monitors.clear();
1905 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1906 assert_eq!(events.len(), 1);
1907 SendEvent::from_event(events.remove(0))
1909 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1910 commitment_signed_dance!(nodes[1], nodes[0], &payment_event.commitment_msg, false, true);
1912 // Check that we generate the PaymentIntercepted event when an intercept forward is detected.
1913 let events = nodes[1].node.get_and_clear_pending_events();
1914 assert_eq!(events.len(), 1);
1915 let (intercept_id, expected_outbound_amount_msat) = match events[0] {
1916 crate::events::Event::HTLCIntercepted {
1917 intercept_id, expected_outbound_amount_msat, payment_hash: pmt_hash, inbound_amount_msat, requested_next_hop_scid: short_channel_id
1919 assert_eq!(pmt_hash, payment_hash);
1920 assert_eq!(inbound_amount_msat, route.get_total_amount() + route.get_total_fees());
1921 assert_eq!(short_channel_id, intercept_scid);
1922 (intercept_id, expected_outbound_amount_msat)
1927 // Check for unknown channel id error.
1928 let unknown_chan_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &ChannelId::from_bytes([42; 32]), nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
1929 assert_eq!(unknown_chan_id_err , APIError::ChannelUnavailable {
1930 err: format!("Channel with id {} not found for the passed counterparty node_id {}",
1931 log_bytes!([42; 32]), nodes[2].node.get_our_node_id()) });
1933 if test == InterceptTest::Fail {
1934 // Ensure we can fail the intercepted payment back.
1935 nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap();
1936 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1], vec![HTLCDestination::UnknownNextHop { requested_forward_scid: intercept_scid }]);
1937 nodes[1].node.process_pending_htlc_forwards();
1938 let update_fail = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1939 check_added_monitors!(&nodes[1], 1);
1940 assert!(update_fail.update_fail_htlcs.len() == 1);
1941 let fail_msg = update_fail.update_fail_htlcs[0].clone();
1942 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
1943 commitment_signed_dance!(nodes[0], nodes[1], update_fail.commitment_signed, false);
1945 // Ensure the payment fails with the expected error.
1946 let fail_conditions = PaymentFailedConditions::new()
1947 .blamed_scid(intercept_scid)
1948 .blamed_chan_closed(true)
1949 .expected_htlc_error_data(0x4000 | 10, &[]);
1950 expect_payment_failed_conditions(&nodes[0], payment_hash, false, fail_conditions);
1951 } else if test == InterceptTest::Forward {
1952 // Check that we'll fail as expected when sending to a channel that isn't in `ChannelReady` yet.
1953 let temp_chan_id = nodes[1].node.create_channel(nodes[2].node.get_our_node_id(), 100_000, 0, 42, None, None).unwrap();
1954 let unusable_chan_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &temp_chan_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
1955 assert_eq!(unusable_chan_err , APIError::ChannelUnavailable {
1956 err: format!("Channel with id {} for the passed counterparty node_id {} is still opening.",
1957 temp_chan_id, nodes[2].node.get_our_node_id()) });
1958 assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
1960 // Open the just-in-time channel so the payment can then be forwarded.
1961 let (_, channel_id) = open_zero_conf_channel(&nodes[1], &nodes[2], None);
1963 // Finally, forward the intercepted payment through and claim it.
1964 nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap();
1965 expect_pending_htlcs_forwardable!(nodes[1]);
1967 let payment_event = {
1969 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
1970 assert_eq!(added_monitors.len(), 1);
1971 added_monitors.clear();
1973 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1974 assert_eq!(events.len(), 1);
1975 SendEvent::from_event(events.remove(0))
1977 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
1978 commitment_signed_dance!(nodes[2], nodes[1], &payment_event.commitment_msg, false, true);
1979 expect_pending_htlcs_forwardable!(nodes[2]);
1981 let payment_preimage = nodes[2].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
1982 expect_payment_claimable!(&nodes[2], payment_hash, payment_secret, amt_msat, Some(payment_preimage), nodes[2].node.get_our_node_id());
1983 do_claim_payment_along_route(&nodes[0], &vec!(&vec!(&nodes[1], &nodes[2])[..]), false, payment_preimage);
1984 let events = nodes[0].node.get_and_clear_pending_events();
1985 assert_eq!(events.len(), 2);
1987 Event::PaymentSent { payment_preimage: ref ev_preimage, payment_hash: ref ev_hash, ref fee_paid_msat, .. } => {
1988 assert_eq!(payment_preimage, *ev_preimage);
1989 assert_eq!(payment_hash, *ev_hash);
1990 assert_eq!(fee_paid_msat, &Some(1000));
1992 _ => panic!("Unexpected event")
1995 Event::PaymentPathSuccessful { payment_hash: hash, .. } => {
1996 assert_eq!(hash, Some(payment_hash));
1998 _ => panic!("Unexpected event")
2000 check_added_monitors(&nodes[0], 1);
2001 } else if test == InterceptTest::Timeout {
2002 let mut block = create_dummy_block(nodes[0].best_block_hash(), 42, Vec::new());
2003 connect_block(&nodes[0], &block);
2004 connect_block(&nodes[1], &block);
2005 for _ in 0..TEST_FINAL_CLTV {
2006 block.header.prev_blockhash = block.block_hash();
2007 connect_block(&nodes[0], &block);
2008 connect_block(&nodes[1], &block);
2010 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::InvalidForward { requested_forward_scid: intercept_scid }]);
2011 check_added_monitors!(nodes[1], 1);
2012 let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2013 assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
2014 assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
2015 assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
2016 assert!(htlc_timeout_updates.update_fee.is_none());
2018 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
2019 commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
2020 expect_payment_failed!(nodes[0], payment_hash, false, 0x2000 | 2, []);
2022 // Check for unknown intercept id error.
2023 let (_, channel_id) = open_zero_conf_channel(&nodes[1], &nodes[2], None);
2024 let unknown_intercept_id_err = nodes[1].node.forward_intercepted_htlc(intercept_id, &channel_id, nodes[2].node.get_our_node_id(), expected_outbound_amount_msat).unwrap_err();
2025 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
2026 let unknown_intercept_id_err = nodes[1].node.fail_intercepted_htlc(intercept_id).unwrap_err();
2027 assert_eq!(unknown_intercept_id_err , APIError::APIMisuseError { err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0)) });
2032 fn accept_underpaying_htlcs_config() {
2033 do_accept_underpaying_htlcs_config(1);
2034 do_accept_underpaying_htlcs_config(2);
2035 do_accept_underpaying_htlcs_config(3);
2038 fn do_accept_underpaying_htlcs_config(num_mpp_parts: usize) {
2039 let chanmon_cfgs = create_chanmon_cfgs(3);
2040 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2041 let mut intercept_forwards_config = test_default_channel_config();
2042 intercept_forwards_config.accept_intercept_htlcs = true;
2043 let mut underpay_config = test_default_channel_config();
2044 underpay_config.channel_config.accept_underpaying_htlcs = true;
2045 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, Some(intercept_forwards_config), Some(underpay_config)]);
2046 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2048 let mut chan_ids = Vec::new();
2049 for _ in 0..num_mpp_parts {
2050 let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000, 0);
2051 let channel_id = create_unannounced_chan_between_nodes_with_value(&nodes, 1, 2, 2_000_000, 0).0.channel_id;
2052 chan_ids.push(channel_id);
2055 // Send the initial payment.
2056 let amt_msat = 900_000;
2057 let skimmed_fee_msat = 20;
2058 let mut route_hints = Vec::new();
2059 for _ in 0..num_mpp_parts {
2060 route_hints.push(RouteHint(vec![RouteHintHop {
2061 src_node_id: nodes[1].node.get_our_node_id(),
2062 short_channel_id: nodes[1].node.get_intercept_scid(),
2065 proportional_millionths: 0,
2067 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA,
2068 htlc_minimum_msat: None,
2069 htlc_maximum_msat: Some(amt_msat / num_mpp_parts as u64 + 5),
2072 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
2073 .with_route_hints(route_hints).unwrap()
2074 .with_bolt11_features(nodes[2].node.bolt11_invoice_features()).unwrap();
2075 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2076 let (payment_hash, payment_secret) = nodes[2].node.create_inbound_payment(Some(amt_msat), 60 * 60, None).unwrap();
2077 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2078 PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
2079 check_added_monitors!(nodes[0], num_mpp_parts); // one monitor per path
2080 let mut events: Vec<SendEvent> = nodes[0].node.get_and_clear_pending_msg_events().into_iter().map(|e| SendEvent::from_event(e)).collect();
2081 assert_eq!(events.len(), num_mpp_parts);
2083 // Forward the intercepted payments.
2084 for (idx, ev) in events.into_iter().enumerate() {
2085 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &ev.msgs[0]);
2086 do_commitment_signed_dance(&nodes[1], &nodes[0], &ev.commitment_msg, false, true);
2088 let events = nodes[1].node.get_and_clear_pending_events();
2089 assert_eq!(events.len(), 1);
2090 let (intercept_id, expected_outbound_amt_msat) = match events[0] {
2091 crate::events::Event::HTLCIntercepted {
2092 intercept_id, expected_outbound_amount_msat, payment_hash: pmt_hash, ..
2094 assert_eq!(pmt_hash, payment_hash);
2095 (intercept_id, expected_outbound_amount_msat)
2099 nodes[1].node.forward_intercepted_htlc(intercept_id, &chan_ids[idx],
2100 nodes[2].node.get_our_node_id(), expected_outbound_amt_msat - skimmed_fee_msat).unwrap();
2101 expect_pending_htlcs_forwardable!(nodes[1]);
2102 let payment_event = {
2104 let mut added_monitors = nodes[1].chain_monitor.added_monitors.lock().unwrap();
2105 assert_eq!(added_monitors.len(), 1);
2106 added_monitors.clear();
2108 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2109 assert_eq!(events.len(), 1);
2110 SendEvent::from_event(events.remove(0))
2112 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
2113 do_commitment_signed_dance(&nodes[2], &nodes[1], &payment_event.commitment_msg, false, true);
2114 if idx == num_mpp_parts - 1 {
2115 expect_pending_htlcs_forwardable!(nodes[2]);
2119 // Claim the payment and check that the skimmed fee is as expected.
2120 let payment_preimage = nodes[2].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
2121 let events = nodes[2].node.get_and_clear_pending_events();
2122 assert_eq!(events.len(), 1);
2124 crate::events::Event::PaymentClaimable {
2125 ref payment_hash, ref purpose, amount_msat, counterparty_skimmed_fee_msat, receiver_node_id, ..
2127 assert_eq!(payment_hash, payment_hash);
2128 assert_eq!(amt_msat - skimmed_fee_msat * num_mpp_parts as u64, amount_msat);
2129 assert_eq!(skimmed_fee_msat * num_mpp_parts as u64, counterparty_skimmed_fee_msat);
2130 assert_eq!(nodes[2].node.get_our_node_id(), receiver_node_id.unwrap());
2132 crate::events::PaymentPurpose::Bolt11InvoicePayment {
2133 payment_preimage: ev_payment_preimage,
2134 payment_secret: ev_payment_secret,
2137 assert_eq!(payment_preimage, ev_payment_preimage.unwrap());
2138 assert_eq!(payment_secret, *ev_payment_secret);
2143 _ => panic!("Unexpected event"),
2145 let mut expected_paths_vecs = Vec::new();
2146 let mut expected_paths = Vec::new();
2147 for _ in 0..num_mpp_parts { expected_paths_vecs.push(vec!(&nodes[1], &nodes[2])); }
2148 for i in 0..num_mpp_parts { expected_paths.push(&expected_paths_vecs[i][..]); }
2149 expected_paths[0].last().unwrap().node.claim_funds(payment_preimage);
2150 let args = ClaimAlongRouteArgs::new(&nodes[0], &expected_paths[..], payment_preimage)
2151 .with_expected_extra_fees(vec![skimmed_fee_msat as u32; num_mpp_parts]);
2152 let total_fee_msat = pass_claimed_payment_along_route(args);
2153 // The sender doesn't know that the penultimate hop took an extra fee.
2154 expect_payment_sent(&nodes[0], payment_preimage,
2155 Some(Some(total_fee_msat - skimmed_fee_msat * num_mpp_parts as u64)), true, true);
2158 #[derive(PartialEq)]
2169 fn automatic_retries() {
2170 do_automatic_retries(AutoRetry::Success);
2171 do_automatic_retries(AutoRetry::Spontaneous);
2172 do_automatic_retries(AutoRetry::FailAttempts);
2173 do_automatic_retries(AutoRetry::FailTimeout);
2174 do_automatic_retries(AutoRetry::FailOnRestart);
2175 do_automatic_retries(AutoRetry::FailOnRetry);
2177 fn do_automatic_retries(test: AutoRetry) {
2178 // Test basic automatic payment retries in ChannelManager. See individual `test` variant comments
2180 let chanmon_cfgs = create_chanmon_cfgs(3);
2181 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2183 let new_chain_monitor;
2185 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2186 let node_0_deserialized;
2188 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2189 let channel_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1).2;
2190 let channel_id_2 = create_announced_chan_between_nodes(&nodes, 2, 1).2;
2192 // Marshall data to send the payment
2193 #[cfg(feature = "std")]
2194 let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2195 #[cfg(not(feature = "std"))]
2196 let payment_expiry_secs = 60 * 60;
2197 let amt_msat = 1000;
2198 let mut invoice_features = Bolt11InvoiceFeatures::empty();
2199 invoice_features.set_variable_length_onion_required();
2200 invoice_features.set_payment_secret_required();
2201 invoice_features.set_basic_mpp_optional();
2202 let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id(), TEST_FINAL_CLTV)
2203 .with_expiry_time(payment_expiry_secs as u64)
2204 .with_bolt11_features(invoice_features).unwrap();
2205 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2206 let (_, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);
2208 macro_rules! pass_failed_attempt_with_retry_along_path {
2209 ($failing_channel_id: expr, $expect_pending_htlcs_forwardable: expr) => {
2210 // Send a payment attempt that fails due to lack of liquidity on the second hop
2211 check_added_monitors!(nodes[0], 1);
2212 let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2213 let mut update_add = update_0.update_add_htlcs[0].clone();
2214 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
2215 commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
2216 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
2217 nodes[1].node.process_pending_htlc_forwards();
2218 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(nodes[1],
2219 vec![HTLCDestination::NextHopChannel {
2220 node_id: Some(nodes[2].node.get_our_node_id()),
2221 channel_id: $failing_channel_id,
2223 nodes[1].node.process_pending_htlc_forwards();
2224 let update_1 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2225 check_added_monitors!(&nodes[1], 1);
2226 assert!(update_1.update_fail_htlcs.len() == 1);
2227 let fail_msg = update_1.update_fail_htlcs[0].clone();
2228 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
2229 commitment_signed_dance!(nodes[0], nodes[1], update_1.commitment_signed, false);
2231 // Ensure the attempt fails and a new PendingHTLCsForwardable event is generated for the retry
2232 let mut events = nodes[0].node.get_and_clear_pending_events();
2233 assert_eq!(events.len(), 2);
2235 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently, .. } => {
2236 assert_eq!(payment_hash, ev_payment_hash);
2237 assert_eq!(payment_failed_permanently, false);
2239 _ => panic!("Unexpected event"),
2241 if $expect_pending_htlcs_forwardable {
2243 Event::PendingHTLCsForwardable { .. } => {},
2244 _ => panic!("Unexpected event"),
2248 Event::PaymentFailed { payment_hash: ev_payment_hash, .. } => {
2249 assert_eq!(payment_hash, ev_payment_hash);
2251 _ => panic!("Unexpected event"),
2257 if test == AutoRetry::Success {
2258 // Test that we can succeed on the first retry.
2259 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2260 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2261 pass_failed_attempt_with_retry_along_path!(channel_id_2, true);
2263 // Open a new channel with liquidity on the second hop so we can find a route for the retry
2264 // attempt, since the initial second hop channel will be excluded from pathfinding
2265 create_announced_chan_between_nodes(&nodes, 1, 2);
2267 // We retry payments in `process_pending_htlc_forwards`
2268 nodes[0].node.process_pending_htlc_forwards();
2269 check_added_monitors!(nodes[0], 1);
2270 let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2271 assert_eq!(msg_events.len(), 1);
2272 pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], amt_msat, payment_hash, Some(payment_secret), msg_events.pop().unwrap(), true, None);
2273 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
2274 } else if test == AutoRetry::Spontaneous {
2275 nodes[0].node.send_spontaneous_payment_with_retry(Some(payment_preimage),
2276 RecipientOnionFields::spontaneous_empty(), PaymentId(payment_hash.0), route_params,
2277 Retry::Attempts(1)).unwrap();
2278 pass_failed_attempt_with_retry_along_path!(channel_id_2, true);
2280 // Open a new channel with liquidity on the second hop so we can find a route for the retry
2281 // attempt, since the initial second hop channel will be excluded from pathfinding
2282 create_announced_chan_between_nodes(&nodes, 1, 2);
2284 // We retry payments in `process_pending_htlc_forwards`
2285 nodes[0].node.process_pending_htlc_forwards();
2286 check_added_monitors!(nodes[0], 1);
2287 let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2288 assert_eq!(msg_events.len(), 1);
2289 pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], amt_msat, payment_hash, None, msg_events.pop().unwrap(), true, Some(payment_preimage));
2290 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
2291 } else if test == AutoRetry::FailAttempts {
2292 // Ensure ChannelManager will not retry a payment if it has run out of payment attempts.
2293 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2294 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2295 pass_failed_attempt_with_retry_along_path!(channel_id_2, true);
2297 // Open a new channel with no liquidity on the second hop so we can find a (bad) route for
2298 // the retry attempt, since the initial second hop channel will be excluded from pathfinding
2299 let channel_id_3 = create_announced_chan_between_nodes(&nodes, 2, 1).2;
2301 // We retry payments in `process_pending_htlc_forwards`
2302 nodes[0].node.process_pending_htlc_forwards();
2303 pass_failed_attempt_with_retry_along_path!(channel_id_3, false);
2305 // Ensure we won't retry a second time.
2306 nodes[0].node.process_pending_htlc_forwards();
2307 let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2308 assert_eq!(msg_events.len(), 0);
2309 } else if test == AutoRetry::FailTimeout {
2310 #[cfg(feature = "std")] {
2311 // Ensure ChannelManager will not retry a payment if it times out due to Retry::Timeout.
2312 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2313 PaymentId(payment_hash.0), route_params, Retry::Timeout(Duration::from_secs(60))).unwrap();
2314 pass_failed_attempt_with_retry_along_path!(channel_id_2, true);
2316 // Advance the time so the second attempt fails due to timeout.
2317 SinceEpoch::advance(Duration::from_secs(61));
2319 // Make sure we don't retry again.
2320 nodes[0].node.process_pending_htlc_forwards();
2321 let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2322 assert_eq!(msg_events.len(), 0);
2324 let mut events = nodes[0].node.get_and_clear_pending_events();
2325 assert_eq!(events.len(), 1);
2327 Event::PaymentFailed { payment_hash: ref ev_payment_hash, payment_id: ref ev_payment_id, reason: ref ev_reason } => {
2328 assert_eq!(payment_hash, *ev_payment_hash);
2329 assert_eq!(PaymentId(payment_hash.0), *ev_payment_id);
2330 assert_eq!(PaymentFailureReason::RetriesExhausted, ev_reason.unwrap());
2332 _ => panic!("Unexpected event"),
2335 } else if test == AutoRetry::FailOnRestart {
2336 // Ensure ChannelManager will not retry a payment after restart, even if there were retry
2337 // attempts remaining prior to restart.
2338 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2339 PaymentId(payment_hash.0), route_params, Retry::Attempts(2)).unwrap();
2340 pass_failed_attempt_with_retry_along_path!(channel_id_2, true);
2342 // Open a new channel with no liquidity on the second hop so we can find a (bad) route for
2343 // the retry attempt, since the initial second hop channel will be excluded from pathfinding
2344 let channel_id_3 = create_announced_chan_between_nodes(&nodes, 2, 1).2;
2346 // Ensure the first retry attempt fails, with 1 retry attempt remaining
2347 nodes[0].node.process_pending_htlc_forwards();
2348 pass_failed_attempt_with_retry_along_path!(channel_id_3, true);
2350 // Restart the node and ensure that ChannelManager does not use its remaining retry attempt
2351 let node_encoded = nodes[0].node.encode();
2352 let chan_1_monitor_serialized = get_monitor!(nodes[0], channel_id_1).encode();
2353 reload_node!(nodes[0], node_encoded, &[&chan_1_monitor_serialized], persister, new_chain_monitor, node_0_deserialized);
2355 let mut events = nodes[0].node.get_and_clear_pending_events();
2356 expect_pending_htlcs_forwardable_from_events!(nodes[0], events, true);
2357 // Make sure we don't retry again.
2358 let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2359 assert_eq!(msg_events.len(), 0);
2361 let mut events = nodes[0].node.get_and_clear_pending_events();
2362 assert_eq!(events.len(), 1);
2364 Event::PaymentFailed { payment_hash: ref ev_payment_hash, payment_id: ref ev_payment_id, reason: ref ev_reason } => {
2365 assert_eq!(payment_hash, *ev_payment_hash);
2366 assert_eq!(PaymentId(payment_hash.0), *ev_payment_id);
2367 assert_eq!(PaymentFailureReason::RetriesExhausted, ev_reason.unwrap());
2369 _ => panic!("Unexpected event"),
2371 } else if test == AutoRetry::FailOnRetry {
2372 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2373 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2374 pass_failed_attempt_with_retry_along_path!(channel_id_2, true);
2376 // We retry payments in `process_pending_htlc_forwards`. Since our channel closed, we should
2377 // fail to find a route.
2378 nodes[0].node.process_pending_htlc_forwards();
2379 let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2380 assert_eq!(msg_events.len(), 0);
2382 let mut events = nodes[0].node.get_and_clear_pending_events();
2383 assert_eq!(events.len(), 1);
2385 Event::PaymentFailed { payment_hash: ref ev_payment_hash, payment_id: ref ev_payment_id, reason: ref ev_reason } => {
2386 assert_eq!(payment_hash, *ev_payment_hash);
2387 assert_eq!(PaymentId(payment_hash.0), *ev_payment_id);
2388 assert_eq!(PaymentFailureReason::RouteNotFound, ev_reason.unwrap());
2390 _ => panic!("Unexpected event"),
2396 fn auto_retry_partial_failure() {
2397 // Test that we'll retry appropriately on send partial failure and retry partial failure.
2398 let chanmon_cfgs = create_chanmon_cfgs(2);
2399 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2400 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2401 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2403 // Open three channels, the first has plenty of liquidity, the second and third have ~no
2404 // available liquidity, causing any outbound payments routed over it to fail immediately.
2405 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
2406 let chan_2_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 989_000_000).0.contents.short_channel_id;
2407 let chan_3_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 989_000_000).0.contents.short_channel_id;
2409 // Marshall data to send the payment
2410 let amt_msat = 10_000_000;
2411 let (_, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], amt_msat);
2412 #[cfg(feature = "std")]
2413 let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2414 #[cfg(not(feature = "std"))]
2415 let payment_expiry_secs = 60 * 60;
2416 let mut invoice_features = Bolt11InvoiceFeatures::empty();
2417 invoice_features.set_variable_length_onion_required();
2418 invoice_features.set_payment_secret_required();
2419 invoice_features.set_basic_mpp_optional();
2420 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
2421 .with_expiry_time(payment_expiry_secs as u64)
2422 .with_bolt11_features(invoice_features).unwrap();
2424 // Configure the initial send path
2425 let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2426 route_params.max_total_routing_fee_msat = None;
2428 let send_route = Route {
2430 Path { hops: vec![RouteHop {
2431 pubkey: nodes[1].node.get_our_node_id(),
2432 node_features: nodes[1].node.node_features(),
2433 short_channel_id: chan_1_id,
2434 channel_features: nodes[1].node.channel_features(),
2435 fee_msat: amt_msat / 2,
2436 cltv_expiry_delta: 100,
2437 maybe_announced_channel: true,
2438 }], blinded_tail: None },
2439 Path { hops: vec![RouteHop {
2440 pubkey: nodes[1].node.get_our_node_id(),
2441 node_features: nodes[1].node.node_features(),
2442 short_channel_id: chan_2_id,
2443 channel_features: nodes[1].node.channel_features(),
2444 fee_msat: amt_msat / 2,
2445 cltv_expiry_delta: 100,
2446 maybe_announced_channel: true,
2447 }], blinded_tail: None },
2449 route_params: Some(route_params.clone()),
2451 nodes[0].router.expect_find_route(route_params.clone(), Ok(send_route));
2453 // Configure the retry1 paths
2454 let mut payment_params = route_params.payment_params.clone();
2455 payment_params.previously_failed_channels.push(chan_2_id);
2456 let mut retry_1_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat / 2);
2457 retry_1_params.max_total_routing_fee_msat = None;
2459 let retry_1_route = Route {
2461 Path { hops: vec![RouteHop {
2462 pubkey: nodes[1].node.get_our_node_id(),
2463 node_features: nodes[1].node.node_features(),
2464 short_channel_id: chan_1_id,
2465 channel_features: nodes[1].node.channel_features(),
2466 fee_msat: amt_msat / 4,
2467 cltv_expiry_delta: 100,
2468 maybe_announced_channel: true,
2469 }], blinded_tail: None },
2470 Path { hops: vec![RouteHop {
2471 pubkey: nodes[1].node.get_our_node_id(),
2472 node_features: nodes[1].node.node_features(),
2473 short_channel_id: chan_3_id,
2474 channel_features: nodes[1].node.channel_features(),
2475 fee_msat: amt_msat / 4,
2476 cltv_expiry_delta: 100,
2477 maybe_announced_channel: true,
2478 }], blinded_tail: None },
2480 route_params: Some(retry_1_params.clone()),
2482 nodes[0].router.expect_find_route(retry_1_params.clone(), Ok(retry_1_route));
2484 // Configure the retry2 path
2485 let mut payment_params = retry_1_params.payment_params.clone();
2486 payment_params.previously_failed_channels.push(chan_3_id);
2487 let mut retry_2_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat / 4);
2488 retry_2_params.max_total_routing_fee_msat = None;
2490 let retry_2_route = Route {
2492 Path { hops: vec![RouteHop {
2493 pubkey: nodes[1].node.get_our_node_id(),
2494 node_features: nodes[1].node.node_features(),
2495 short_channel_id: chan_1_id,
2496 channel_features: nodes[1].node.channel_features(),
2497 fee_msat: amt_msat / 4,
2498 cltv_expiry_delta: 100,
2499 maybe_announced_channel: true,
2500 }], blinded_tail: None },
2502 route_params: Some(retry_2_params.clone()),
2504 nodes[0].router.expect_find_route(retry_2_params, Ok(retry_2_route));
2506 // Send a payment that will partially fail on send, then partially fail on retry, then succeed.
2507 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2508 PaymentId(payment_hash.0), route_params, Retry::Attempts(3)).unwrap();
2509 let payment_failed_events = nodes[0].node.get_and_clear_pending_events();
2510 assert_eq!(payment_failed_events.len(), 2);
2511 match payment_failed_events[0] {
2512 Event::PaymentPathFailed { .. } => {},
2513 _ => panic!("Unexpected event"),
2515 match payment_failed_events[1] {
2516 Event::PaymentPathFailed { .. } => {},
2517 _ => panic!("Unexpected event"),
2520 // Pass the first part of the payment along the path.
2521 check_added_monitors!(nodes[0], 1); // only one HTLC actually made it out
2522 let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
2524 // Only one HTLC/channel update actually made it out
2525 assert_eq!(msg_events.len(), 1);
2526 let mut payment_event = SendEvent::from_event(msg_events.remove(0));
2528 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2529 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
2530 check_added_monitors!(nodes[1], 1);
2531 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2533 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2534 check_added_monitors!(nodes[0], 1);
2535 let as_second_htlc_updates = SendEvent::from_node(&nodes[0]);
2537 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2538 check_added_monitors!(nodes[0], 1);
2539 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2541 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2542 check_added_monitors!(nodes[1], 1);
2544 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_second_htlc_updates.msgs[0]);
2545 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_second_htlc_updates.msgs[1]);
2546 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_htlc_updates.commitment_msg);
2547 check_added_monitors!(nodes[1], 1);
2548 let (bs_second_raa, bs_second_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2550 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2551 check_added_monitors!(nodes[0], 1);
2553 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_cs);
2554 check_added_monitors!(nodes[0], 1);
2555 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2557 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2558 check_added_monitors!(nodes[1], 1);
2560 expect_pending_htlcs_forwardable_ignore!(nodes[1]);
2561 nodes[1].node.process_pending_htlc_forwards();
2562 expect_payment_claimable!(nodes[1], payment_hash, payment_secret, amt_msat);
2563 nodes[1].node.claim_funds(payment_preimage);
2564 expect_payment_claimed!(nodes[1], payment_hash, amt_msat);
2565 let bs_claim_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2566 assert_eq!(bs_claim_update.update_fulfill_htlcs.len(), 1);
2568 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_claim_update.update_fulfill_htlcs[0]);
2569 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
2570 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_claim_update.commitment_signed);
2571 check_added_monitors!(nodes[0], 1);
2572 let (as_third_raa, as_third_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2574 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_third_raa);
2575 check_added_monitors!(nodes[1], 4);
2576 let bs_second_claim_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2578 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_third_cs);
2579 check_added_monitors!(nodes[1], 1);
2580 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2582 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
2583 check_added_monitors!(nodes[0], 1);
2584 expect_payment_path_successful!(nodes[0]);
2586 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_claim_update.update_fulfill_htlcs[0]);
2587 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_claim_update.update_fulfill_htlcs[1]);
2588 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_claim_update.commitment_signed);
2589 check_added_monitors!(nodes[0], 1);
2590 let (as_fourth_raa, as_fourth_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2592 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_fourth_raa);
2593 check_added_monitors!(nodes[1], 1);
2595 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_fourth_cs);
2596 check_added_monitors!(nodes[1], 1);
2597 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2599 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2600 check_added_monitors!(nodes[0], 1);
2601 let events = nodes[0].node.get_and_clear_pending_events();
2602 assert_eq!(events.len(), 2);
2603 if let Event::PaymentPathSuccessful { .. } = events[0] {} else { panic!(); }
2604 if let Event::PaymentPathSuccessful { .. } = events[1] {} else { panic!(); }
2608 fn auto_retry_zero_attempts_send_error() {
2609 let chanmon_cfgs = create_chanmon_cfgs(2);
2610 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2611 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2612 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2614 // Open a single channel that does not have sufficient liquidity for the payment we want to
2616 let chan_id = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 989_000_000).0.contents.short_channel_id;
2618 // Marshall data to send the payment
2619 let amt_msat = 10_000_000;
2620 let (_, payment_hash, payment_secret) = get_payment_preimage_hash(&nodes[1], Some(amt_msat), None);
2621 #[cfg(feature = "std")]
2622 let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2623 #[cfg(not(feature = "std"))]
2624 let payment_expiry_secs = 60 * 60;
2625 let mut invoice_features = Bolt11InvoiceFeatures::empty();
2626 invoice_features.set_variable_length_onion_required();
2627 invoice_features.set_payment_secret_required();
2628 invoice_features.set_basic_mpp_optional();
2629 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
2630 .with_expiry_time(payment_expiry_secs as u64)
2631 .with_bolt11_features(invoice_features).unwrap();
2632 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2634 // Override the route search to return a route, rather than failing at the route-finding step.
2635 let send_route = Route {
2637 Path { hops: vec![RouteHop {
2638 pubkey: nodes[1].node.get_our_node_id(),
2639 node_features: nodes[1].node.node_features(),
2640 short_channel_id: chan_id,
2641 channel_features: nodes[1].node.channel_features(),
2643 cltv_expiry_delta: 100,
2644 maybe_announced_channel: true,
2645 }], blinded_tail: None },
2647 route_params: Some(route_params.clone()),
2649 nodes[0].router.expect_find_route(route_params.clone(), Ok(send_route));
2651 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2652 PaymentId(payment_hash.0), route_params, Retry::Attempts(0)).unwrap();
2653 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2654 let events = nodes[0].node.get_and_clear_pending_events();
2655 assert_eq!(events.len(), 2);
2656 if let Event::PaymentPathFailed { .. } = events[0] { } else { panic!(); }
2657 if let Event::PaymentFailed { .. } = events[1] { } else { panic!(); }
2658 check_added_monitors!(nodes[0], 0);
2662 fn fails_paying_after_rejected_by_payee() {
2663 let chanmon_cfgs = create_chanmon_cfgs(2);
2664 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2665 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2666 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2668 create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
2670 // Marshall data to send the payment
2671 let amt_msat = 20_000;
2672 let (_, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], amt_msat);
2673 #[cfg(feature = "std")]
2674 let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2675 #[cfg(not(feature = "std"))]
2676 let payment_expiry_secs = 60 * 60;
2677 let mut invoice_features = Bolt11InvoiceFeatures::empty();
2678 invoice_features.set_variable_length_onion_required();
2679 invoice_features.set_payment_secret_required();
2680 invoice_features.set_basic_mpp_optional();
2681 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
2682 .with_expiry_time(payment_expiry_secs as u64)
2683 .with_bolt11_features(invoice_features).unwrap();
2684 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2686 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2687 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2688 check_added_monitors!(nodes[0], 1);
2689 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2690 assert_eq!(events.len(), 1);
2691 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
2692 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
2693 check_added_monitors!(nodes[1], 0);
2694 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
2695 expect_pending_htlcs_forwardable!(nodes[1]);
2696 expect_payment_claimable!(&nodes[1], payment_hash, payment_secret, amt_msat);
2698 nodes[1].node.fail_htlc_backwards(&payment_hash);
2699 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], [HTLCDestination::FailedPayment { payment_hash }]);
2700 pass_failed_payment_back(&nodes[0], &[&[&nodes[1]]], false, payment_hash, PaymentFailureReason::RecipientRejected);
2704 fn retry_multi_path_single_failed_payment() {
2705 // Tests that we can/will retry after a single path of an MPP payment failed immediately
2706 let chanmon_cfgs = create_chanmon_cfgs(2);
2707 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2708 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
2709 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2711 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
2712 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
2714 let amt_msat = 100_010_000;
2716 let (_, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], amt_msat);
2717 #[cfg(feature = "std")]
2718 let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2719 #[cfg(not(feature = "std"))]
2720 let payment_expiry_secs = 60 * 60;
2721 let mut invoice_features = Bolt11InvoiceFeatures::empty();
2722 invoice_features.set_variable_length_onion_required();
2723 invoice_features.set_payment_secret_required();
2724 invoice_features.set_basic_mpp_optional();
2725 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
2726 .with_expiry_time(payment_expiry_secs as u64)
2727 .with_bolt11_features(invoice_features).unwrap();
2728 let mut route_params = RouteParameters::from_payment_params_and_value(
2729 payment_params.clone(), amt_msat);
2730 route_params.max_total_routing_fee_msat = None;
2732 let chans = nodes[0].node.list_usable_channels();
2733 let mut route = Route {
2735 Path { hops: vec![RouteHop {
2736 pubkey: nodes[1].node.get_our_node_id(),
2737 node_features: nodes[1].node.node_features(),
2738 short_channel_id: chans[0].short_channel_id.unwrap(),
2739 channel_features: nodes[1].node.channel_features(),
2741 cltv_expiry_delta: 100,
2742 maybe_announced_channel: true,
2743 }], blinded_tail: None },
2744 Path { hops: vec![RouteHop {
2745 pubkey: nodes[1].node.get_our_node_id(),
2746 node_features: nodes[1].node.node_features(),
2747 short_channel_id: chans[1].short_channel_id.unwrap(),
2748 channel_features: nodes[1].node.channel_features(),
2749 fee_msat: 100_000_001, // Our default max-HTLC-value is 10% of the channel value, which this is one more than
2750 cltv_expiry_delta: 100,
2751 maybe_announced_channel: true,
2752 }], blinded_tail: None },
2754 route_params: Some(route_params.clone()),
2756 nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
2757 // On retry, split the payment across both channels.
2758 route.paths[0].hops[0].fee_msat = 50_000_001;
2759 route.paths[1].hops[0].fee_msat = 50_000_000;
2760 let mut pay_params = route.route_params.clone().unwrap().payment_params;
2761 pay_params.previously_failed_channels.push(chans[1].short_channel_id.unwrap());
2763 let mut retry_params = RouteParameters::from_payment_params_and_value(pay_params, 100_000_000);
2764 retry_params.max_total_routing_fee_msat = None;
2765 route.route_params = Some(retry_params.clone());
2766 nodes[0].router.expect_find_route(retry_params, Ok(route.clone()));
2769 let scorer = chanmon_cfgs[0].scorer.read().unwrap();
2770 // The initial send attempt, 2 paths
2771 scorer.expect_usage(chans[0].short_channel_id.unwrap(), ChannelUsage { amount_msat: 10_000, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown });
2772 scorer.expect_usage(chans[1].short_channel_id.unwrap(), ChannelUsage { amount_msat: 100_000_001, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown });
2773 // The retry, 2 paths. Ensure that the in-flight HTLC amount is factored in.
2774 scorer.expect_usage(chans[0].short_channel_id.unwrap(), ChannelUsage { amount_msat: 50_000_001, inflight_htlc_msat: 10_000, effective_capacity: EffectiveCapacity::Unknown });
2775 scorer.expect_usage(chans[1].short_channel_id.unwrap(), ChannelUsage { amount_msat: 50_000_000, inflight_htlc_msat: 0, effective_capacity: EffectiveCapacity::Unknown });
2778 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2779 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2780 let events = nodes[0].node.get_and_clear_pending_events();
2781 assert_eq!(events.len(), 1);
2783 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently: false,
2784 failure: PathFailure::InitialSend { err: APIError::ChannelUnavailable { .. }},
2785 short_channel_id: Some(expected_scid), .. } =>
2787 assert_eq!(payment_hash, ev_payment_hash);
2788 assert_eq!(expected_scid, route.paths[1].hops[0].short_channel_id);
2790 _ => panic!("Unexpected event"),
2792 let htlc_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2793 assert_eq!(htlc_msgs.len(), 2);
2794 check_added_monitors!(nodes[0], 2);
2798 fn immediate_retry_on_failure() {
2799 // Tests that we can/will retry immediately after a failure
2800 let chanmon_cfgs = create_chanmon_cfgs(2);
2801 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2802 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
2803 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2805 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
2806 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
2808 let amt_msat = 100_000_001;
2809 let (_, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], amt_msat);
2810 #[cfg(feature = "std")]
2811 let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2812 #[cfg(not(feature = "std"))]
2813 let payment_expiry_secs = 60 * 60;
2814 let mut invoice_features = Bolt11InvoiceFeatures::empty();
2815 invoice_features.set_variable_length_onion_required();
2816 invoice_features.set_payment_secret_required();
2817 invoice_features.set_basic_mpp_optional();
2818 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
2819 .with_expiry_time(payment_expiry_secs as u64)
2820 .with_bolt11_features(invoice_features).unwrap();
2821 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2823 let chans = nodes[0].node.list_usable_channels();
2824 let mut route = Route {
2826 Path { hops: vec![RouteHop {
2827 pubkey: nodes[1].node.get_our_node_id(),
2828 node_features: nodes[1].node.node_features(),
2829 short_channel_id: chans[0].short_channel_id.unwrap(),
2830 channel_features: nodes[1].node.channel_features(),
2831 fee_msat: 100_000_001, // Our default max-HTLC-value is 10% of the channel value, which this is one more than
2832 cltv_expiry_delta: 100,
2833 maybe_announced_channel: true,
2834 }], blinded_tail: None },
2836 route_params: Some(route_params.clone()),
2838 nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
2839 // On retry, split the payment across both channels.
2840 route.paths.push(route.paths[0].clone());
2841 route.paths[0].hops[0].short_channel_id = chans[1].short_channel_id.unwrap();
2842 route.paths[0].hops[0].fee_msat = 50_000_000;
2843 route.paths[1].hops[0].fee_msat = 50_000_001;
2844 let mut pay_params = route_params.payment_params.clone();
2845 pay_params.previously_failed_channels.push(chans[0].short_channel_id.unwrap());
2846 let retry_params = RouteParameters::from_payment_params_and_value(pay_params, amt_msat);
2847 route.route_params = Some(retry_params.clone());
2848 nodes[0].router.expect_find_route(retry_params, Ok(route.clone()));
2850 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2851 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2852 let events = nodes[0].node.get_and_clear_pending_events();
2853 assert_eq!(events.len(), 1);
2855 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently: false,
2856 failure: PathFailure::InitialSend { err: APIError::ChannelUnavailable { .. }},
2857 short_channel_id: Some(expected_scid), .. } =>
2859 assert_eq!(payment_hash, ev_payment_hash);
2860 assert_eq!(expected_scid, route.paths[1].hops[0].short_channel_id);
2862 _ => panic!("Unexpected event"),
2864 let htlc_msgs = nodes[0].node.get_and_clear_pending_msg_events();
2865 assert_eq!(htlc_msgs.len(), 2);
2866 check_added_monitors!(nodes[0], 2);
2870 fn no_extra_retries_on_back_to_back_fail() {
2871 // In a previous release, we had a race where we may exceed the payment retry count if we
2872 // get two failures in a row with the second indicating that all paths had failed (this field,
2873 // `all_paths_failed`, has since been removed).
2874 // Generally, when we give up trying to retry a payment, we don't know for sure what the
2875 // current state of the ChannelManager event queue is. Specifically, we cannot be sure that
2876 // there are not multiple additional `PaymentPathFailed` or even `PaymentSent` events
2877 // pending which we will see later. Thus, when we previously removed the retry tracking map
2878 // entry after a `all_paths_failed` `PaymentPathFailed` event, we may have dropped the
2879 // retry entry even though more events for the same payment were still pending. This led to
2880 // us retrying a payment again even though we'd already given up on it.
2882 // We now have a separate event - `PaymentFailed` which indicates no HTLCs remain and which
2883 // is used to remove the payment retry counter entries instead. This tests for the specific
2884 // excess-retry case while also testing `PaymentFailed` generation.
2886 let chanmon_cfgs = create_chanmon_cfgs(3);
2887 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2888 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2889 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2891 let chan_1_scid = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0).0.contents.short_channel_id;
2892 let chan_2_scid = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 0).0.contents.short_channel_id;
2894 let amt_msat = 200_000_000;
2895 let (_, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], amt_msat);
2896 #[cfg(feature = "std")]
2897 let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
2898 #[cfg(not(feature = "std"))]
2899 let payment_expiry_secs = 60 * 60;
2900 let mut invoice_features = Bolt11InvoiceFeatures::empty();
2901 invoice_features.set_variable_length_onion_required();
2902 invoice_features.set_payment_secret_required();
2903 invoice_features.set_basic_mpp_optional();
2904 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
2905 .with_expiry_time(payment_expiry_secs as u64)
2906 .with_bolt11_features(invoice_features).unwrap();
2907 let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
2908 route_params.max_total_routing_fee_msat = None;
2910 let mut route = Route {
2912 Path { hops: vec![RouteHop {
2913 pubkey: nodes[1].node.get_our_node_id(),
2914 node_features: nodes[1].node.node_features(),
2915 short_channel_id: chan_1_scid,
2916 channel_features: nodes[1].node.channel_features(),
2917 fee_msat: 0, // nodes[1] will fail the payment as we don't pay its fee
2918 cltv_expiry_delta: 100,
2919 maybe_announced_channel: true,
2921 pubkey: nodes[2].node.get_our_node_id(),
2922 node_features: nodes[2].node.node_features(),
2923 short_channel_id: chan_2_scid,
2924 channel_features: nodes[2].node.channel_features(),
2925 fee_msat: 100_000_000,
2926 cltv_expiry_delta: 100,
2927 maybe_announced_channel: true,
2928 }], blinded_tail: None },
2929 Path { hops: vec![RouteHop {
2930 pubkey: nodes[1].node.get_our_node_id(),
2931 node_features: nodes[1].node.node_features(),
2932 short_channel_id: chan_1_scid,
2933 channel_features: nodes[1].node.channel_features(),
2934 fee_msat: 0, // nodes[1] will fail the payment as we don't pay its fee
2935 cltv_expiry_delta: 100,
2936 maybe_announced_channel: true,
2938 pubkey: nodes[2].node.get_our_node_id(),
2939 node_features: nodes[2].node.node_features(),
2940 short_channel_id: chan_2_scid,
2941 channel_features: nodes[2].node.channel_features(),
2942 fee_msat: 100_000_000,
2943 cltv_expiry_delta: 100,
2944 maybe_announced_channel: true,
2945 }], blinded_tail: None }
2947 route_params: Some(route_params.clone()),
2949 route.route_params.as_mut().unwrap().max_total_routing_fee_msat = None;
2950 nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
2951 let mut second_payment_params = route_params.payment_params.clone();
2952 second_payment_params.previously_failed_channels = vec![chan_2_scid, chan_2_scid];
2953 // On retry, we'll only return one path
2954 route.paths.remove(1);
2955 route.paths[0].hops[1].fee_msat = amt_msat;
2956 let mut retry_params = RouteParameters::from_payment_params_and_value(second_payment_params, amt_msat);
2957 retry_params.max_total_routing_fee_msat = None;
2958 route.route_params = Some(retry_params.clone());
2959 nodes[0].router.expect_find_route(retry_params, Ok(route.clone()));
2961 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
2962 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
2963 let htlc_updates = SendEvent::from_node(&nodes[0]);
2964 check_added_monitors!(nodes[0], 1);
2965 assert_eq!(htlc_updates.msgs.len(), 1);
2967 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &htlc_updates.msgs[0]);
2968 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &htlc_updates.commitment_msg);
2969 check_added_monitors!(nodes[1], 1);
2970 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2972 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
2973 check_added_monitors!(nodes[0], 1);
2974 let second_htlc_updates = SendEvent::from_node(&nodes[0]);
2976 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
2977 check_added_monitors!(nodes[0], 1);
2978 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2980 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &second_htlc_updates.msgs[0]);
2981 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &second_htlc_updates.commitment_msg);
2982 check_added_monitors!(nodes[1], 1);
2983 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2985 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
2986 check_added_monitors!(nodes[1], 1);
2987 let bs_fail_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2989 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
2990 check_added_monitors!(nodes[0], 1);
2992 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_update.update_fail_htlcs[0]);
2993 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_fail_update.commitment_signed);
2994 check_added_monitors!(nodes[0], 1);
2995 let (as_second_raa, as_third_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2997 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
2998 check_added_monitors!(nodes[1], 1);
2999 let bs_second_fail_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3001 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_third_cs);
3002 check_added_monitors!(nodes[1], 1);
3003 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3005 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_second_fail_update.update_fail_htlcs[0]);
3006 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_fail_update.commitment_signed);
3007 check_added_monitors!(nodes[0], 1);
3009 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
3010 check_added_monitors!(nodes[0], 1);
3011 let (as_third_raa, as_fourth_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3013 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_third_raa);
3014 check_added_monitors!(nodes[1], 1);
3015 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_fourth_cs);
3016 check_added_monitors!(nodes[1], 1);
3017 let bs_fourth_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3019 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_fourth_raa);
3020 check_added_monitors!(nodes[0], 1);
3022 // At this point A has sent two HTLCs which both failed due to lack of fee. It now has two
3023 // pending `PaymentPathFailed` events, one with `all_paths_failed` unset, and the second
3026 // Previously, we retried payments in an event consumer, which would retry each
3027 // `PaymentPathFailed` individually. In that setup, we had retried the payment in response to
3028 // the first `PaymentPathFailed`, then seen the second `PaymentPathFailed` with
3029 // `all_paths_failed` set and assumed the payment was completely failed. We ultimately fixed it
3030 // by adding the `PaymentFailed` event.
3032 // Because we now retry payments as a batch, we simply return a single-path route in the
3033 // second, batched, request, have that fail, ensure the payment was abandoned.
3034 let mut events = nodes[0].node.get_and_clear_pending_events();
3035 assert_eq!(events.len(), 3);
3037 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently, .. } => {
3038 assert_eq!(payment_hash, ev_payment_hash);
3039 assert_eq!(payment_failed_permanently, false);
3041 _ => panic!("Unexpected event"),
3044 Event::PendingHTLCsForwardable { .. } => {},
3045 _ => panic!("Unexpected event"),
3048 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently, .. } => {
3049 assert_eq!(payment_hash, ev_payment_hash);
3050 assert_eq!(payment_failed_permanently, false);
3052 _ => panic!("Unexpected event"),
3055 nodes[0].node.process_pending_htlc_forwards();
3056 let retry_htlc_updates = SendEvent::from_node(&nodes[0]);
3057 check_added_monitors!(nodes[0], 1);
3059 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &retry_htlc_updates.msgs[0]);
3060 commitment_signed_dance!(nodes[1], nodes[0], &retry_htlc_updates.commitment_msg, false, true);
3061 let bs_fail_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3062 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_update.update_fail_htlcs[0]);
3063 commitment_signed_dance!(nodes[0], nodes[1], &bs_fail_update.commitment_signed, false, true);
3065 let mut events = nodes[0].node.get_and_clear_pending_events();
3066 assert_eq!(events.len(), 2);
3068 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently, .. } => {
3069 assert_eq!(payment_hash, ev_payment_hash);
3070 assert_eq!(payment_failed_permanently, false);
3072 _ => panic!("Unexpected event"),
3075 Event::PaymentFailed { payment_hash: ref ev_payment_hash, payment_id: ref ev_payment_id, reason: ref ev_reason } => {
3076 assert_eq!(payment_hash, *ev_payment_hash);
3077 assert_eq!(PaymentId(payment_hash.0), *ev_payment_id);
3078 assert_eq!(PaymentFailureReason::RetriesExhausted, ev_reason.unwrap());
3080 _ => panic!("Unexpected event"),
3085 fn test_simple_partial_retry() {
3086 // In the first version of the in-`ChannelManager` payment retries, retries were sent for the
3087 // full amount of the payment, rather than only the missing amount. Here we simply test for
3088 // this by sending a payment with two parts, failing one, and retrying the second. Note that
3089 // `TestRouter` will check that the `RouteParameters` (which contain the amount) matches the
3091 let chanmon_cfgs = create_chanmon_cfgs(3);
3092 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3093 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3094 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3096 let chan_1_scid = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0).0.contents.short_channel_id;
3097 let chan_2_scid = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 10_000_000, 0).0.contents.short_channel_id;
3099 let amt_msat = 200_000_000;
3100 let (_, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[2], amt_msat);
3101 #[cfg(feature = "std")]
3102 let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
3103 #[cfg(not(feature = "std"))]
3104 let payment_expiry_secs = 60 * 60;
3105 let mut invoice_features = Bolt11InvoiceFeatures::empty();
3106 invoice_features.set_variable_length_onion_required();
3107 invoice_features.set_payment_secret_required();
3108 invoice_features.set_basic_mpp_optional();
3109 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
3110 .with_expiry_time(payment_expiry_secs as u64)
3111 .with_bolt11_features(invoice_features).unwrap();
3112 let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
3113 route_params.max_total_routing_fee_msat = None;
3115 let mut route = Route {
3117 Path { hops: vec![RouteHop {
3118 pubkey: nodes[1].node.get_our_node_id(),
3119 node_features: nodes[1].node.node_features(),
3120 short_channel_id: chan_1_scid,
3121 channel_features: nodes[1].node.channel_features(),
3122 fee_msat: 0, // nodes[1] will fail the payment as we don't pay its fee
3123 cltv_expiry_delta: 100,
3124 maybe_announced_channel: true,
3126 pubkey: nodes[2].node.get_our_node_id(),
3127 node_features: nodes[2].node.node_features(),
3128 short_channel_id: chan_2_scid,
3129 channel_features: nodes[2].node.channel_features(),
3130 fee_msat: 100_000_000,
3131 cltv_expiry_delta: 100,
3132 maybe_announced_channel: true,
3133 }], blinded_tail: None },
3134 Path { hops: vec![RouteHop {
3135 pubkey: nodes[1].node.get_our_node_id(),
3136 node_features: nodes[1].node.node_features(),
3137 short_channel_id: chan_1_scid,
3138 channel_features: nodes[1].node.channel_features(),
3140 cltv_expiry_delta: 100,
3141 maybe_announced_channel: true,
3143 pubkey: nodes[2].node.get_our_node_id(),
3144 node_features: nodes[2].node.node_features(),
3145 short_channel_id: chan_2_scid,
3146 channel_features: nodes[2].node.channel_features(),
3147 fee_msat: 100_000_000,
3148 cltv_expiry_delta: 100,
3149 maybe_announced_channel: true,
3150 }], blinded_tail: None }
3152 route_params: Some(route_params.clone()),
3155 nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
3157 let mut second_payment_params = route_params.payment_params.clone();
3158 second_payment_params.previously_failed_channels = vec![chan_2_scid];
3159 // On retry, we'll only be asked for one path (or 100k sats)
3160 route.paths.remove(0);
3161 let mut retry_params = RouteParameters::from_payment_params_and_value(second_payment_params, amt_msat / 2);
3162 retry_params.max_total_routing_fee_msat = None;
3163 route.route_params = Some(retry_params.clone());
3164 nodes[0].router.expect_find_route(retry_params, Ok(route.clone()));
3166 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
3167 PaymentId(payment_hash.0), route_params, Retry::Attempts(1)).unwrap();
3168 let htlc_updates = SendEvent::from_node(&nodes[0]);
3169 check_added_monitors!(nodes[0], 1);
3170 assert_eq!(htlc_updates.msgs.len(), 1);
3172 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &htlc_updates.msgs[0]);
3173 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &htlc_updates.commitment_msg);
3174 check_added_monitors!(nodes[1], 1);
3175 let (bs_first_raa, bs_first_cs) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3177 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
3178 check_added_monitors!(nodes[0], 1);
3179 let second_htlc_updates = SendEvent::from_node(&nodes[0]);
3181 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_cs);
3182 check_added_monitors!(nodes[0], 1);
3183 let as_first_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3185 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &second_htlc_updates.msgs[0]);
3186 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &second_htlc_updates.commitment_msg);
3187 check_added_monitors!(nodes[1], 1);
3188 let bs_second_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3190 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
3191 check_added_monitors!(nodes[1], 1);
3192 let bs_fail_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3194 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_raa);
3195 check_added_monitors!(nodes[0], 1);
3197 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_update.update_fail_htlcs[0]);
3198 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_fail_update.commitment_signed);
3199 check_added_monitors!(nodes[0], 1);
3200 let (as_second_raa, as_third_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3202 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
3203 check_added_monitors!(nodes[1], 1);
3205 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_third_cs);
3206 check_added_monitors!(nodes[1], 1);
3208 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3210 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
3211 check_added_monitors!(nodes[0], 1);
3213 let mut events = nodes[0].node.get_and_clear_pending_events();
3214 assert_eq!(events.len(), 2);
3216 Event::PaymentPathFailed { payment_hash: ev_payment_hash, payment_failed_permanently, .. } => {
3217 assert_eq!(payment_hash, ev_payment_hash);
3218 assert_eq!(payment_failed_permanently, false);
3220 _ => panic!("Unexpected event"),
3223 Event::PendingHTLCsForwardable { .. } => {},
3224 _ => panic!("Unexpected event"),
3227 nodes[0].node.process_pending_htlc_forwards();
3228 let retry_htlc_updates = SendEvent::from_node(&nodes[0]);
3229 check_added_monitors!(nodes[0], 1);
3231 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &retry_htlc_updates.msgs[0]);
3232 commitment_signed_dance!(nodes[1], nodes[0], &retry_htlc_updates.commitment_msg, false, true);
3234 expect_pending_htlcs_forwardable!(nodes[1]);
3235 check_added_monitors!(nodes[1], 1);
3237 let bs_forward_update = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
3238 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[0]);
3239 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &bs_forward_update.update_add_htlcs[1]);
3240 commitment_signed_dance!(nodes[2], nodes[1], &bs_forward_update.commitment_signed, false);
3242 expect_pending_htlcs_forwardable!(nodes[2]);
3243 expect_payment_claimable!(nodes[2], payment_hash, payment_secret, amt_msat);
3247 #[cfg(feature = "std")]
3248 fn test_threaded_payment_retries() {
3249 // In the first version of the in-`ChannelManager` payment retries, retries weren't limited to
3250 // a single thread and would happily let multiple threads run retries at the same time. Because
3251 // retries are done by first calculating the amount we need to retry, then dropping the
3252 // relevant lock, then actually sending, we would happily let multiple threads retry the same
3253 // amount at the same time, overpaying our original HTLC!
3254 let chanmon_cfgs = create_chanmon_cfgs(4);
3255 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3256 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3257 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3259 // There is one mitigating guardrail when retrying payments - we can never over-pay by more
3260 // than 10% of the original value. Thus, we want all our retries to be below that. In order to
3261 // keep things simple, we route one HTLC for 0.1% of the payment over channel 1 and the rest
3262 // out over channel 3+4. This will let us ignore 99% of the payment value and deal with only
3264 let chan_1_scid = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 10_000_000, 0).0.contents.short_channel_id;
3265 create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 10_000_000, 0);
3266 let chan_3_scid = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 10_000_000, 0).0.contents.short_channel_id;
3267 let chan_4_scid = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 10_000_000, 0).0.contents.short_channel_id;
3269 let amt_msat = 100_000_000;
3270 let (_, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[2], amt_msat);
3271 #[cfg(feature = "std")]
3272 let payment_expiry_secs = SystemTime::UNIX_EPOCH.elapsed().unwrap().as_secs() + 60 * 60;
3273 #[cfg(not(feature = "std"))]
3274 let payment_expiry_secs = 60 * 60;
3275 let mut invoice_features = Bolt11InvoiceFeatures::empty();
3276 invoice_features.set_variable_length_onion_required();
3277 invoice_features.set_payment_secret_required();
3278 invoice_features.set_basic_mpp_optional();
3279 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id(), TEST_FINAL_CLTV)
3280 .with_expiry_time(payment_expiry_secs as u64)
3281 .with_bolt11_features(invoice_features).unwrap();
3282 let mut route_params = RouteParameters {
3283 payment_params, final_value_msat: amt_msat, max_total_routing_fee_msat: Some(500_000),
3286 let mut route = Route {
3288 Path { hops: vec![RouteHop {
3289 pubkey: nodes[1].node.get_our_node_id(),
3290 node_features: nodes[1].node.node_features(),
3291 short_channel_id: chan_1_scid,
3292 channel_features: nodes[1].node.channel_features(),
3294 cltv_expiry_delta: 100,
3295 maybe_announced_channel: true,
3297 pubkey: nodes[3].node.get_our_node_id(),
3298 node_features: nodes[2].node.node_features(),
3299 short_channel_id: 42, // Set a random SCID which nodes[1] will fail as unknown
3300 channel_features: nodes[2].node.channel_features(),
3301 fee_msat: amt_msat / 1000,
3302 cltv_expiry_delta: 100,
3303 maybe_announced_channel: true,
3304 }], blinded_tail: None },
3305 Path { hops: vec![RouteHop {
3306 pubkey: nodes[2].node.get_our_node_id(),
3307 node_features: nodes[2].node.node_features(),
3308 short_channel_id: chan_3_scid,
3309 channel_features: nodes[2].node.channel_features(),
3311 cltv_expiry_delta: 100,
3312 maybe_announced_channel: true,
3314 pubkey: nodes[3].node.get_our_node_id(),
3315 node_features: nodes[3].node.node_features(),
3316 short_channel_id: chan_4_scid,
3317 channel_features: nodes[3].node.channel_features(),
3318 fee_msat: amt_msat - amt_msat / 1000,
3319 cltv_expiry_delta: 100,
3320 maybe_announced_channel: true,
3321 }], blinded_tail: None }
3323 route_params: Some(route_params.clone()),
3325 nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
3327 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
3328 PaymentId(payment_hash.0), route_params.clone(), Retry::Attempts(0xdeadbeef)).unwrap();
3329 check_added_monitors!(nodes[0], 2);
3330 let mut send_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3331 assert_eq!(send_msg_events.len(), 2);
3332 send_msg_events.retain(|msg|
3333 if let MessageSendEvent::UpdateHTLCs { node_id, .. } = msg {
3334 // Drop the commitment update for nodes[2], we can just let that one sit pending
3336 *node_id == nodes[1].node.get_our_node_id()
3337 } else { panic!(); }
3340 // from here on out, the retry `RouteParameters` amount will be amt/1000
3341 route_params.final_value_msat /= 1000;
3342 route.route_params = Some(route_params.clone());
3345 let end_time = Instant::now() + Duration::from_secs(1);
3346 macro_rules! thread_body { () => { {
3347 // We really want std::thread::scope, but its not stable until 1.63. Until then, we get unsafe.
3348 let node_ref = NodePtr::from_node(&nodes[0]);
3351 let node_a = unsafe { &*node_ref.0 };
3352 while Instant::now() < end_time {
3353 node_a.node.get_and_clear_pending_events(); // wipe the PendingHTLCsForwardable
3354 // Ignore if we have any pending events, just always pretend we just got a
3355 // PendingHTLCsForwardable
3356 node_a.node.process_pending_htlc_forwards();
3360 let mut threads = Vec::new();
3361 for _ in 0..16 { threads.push(std::thread::spawn(thread_body!())); }
3363 // Back in the main thread, poll pending messages and make sure that we never have more than
3364 // one HTLC pending at a time. Note that the commitment_signed_dance will fail horribly if
3365 // there are HTLC messages shoved in while its running. This allows us to test that we never
3366 // generate an additional update_add_htlc until we've fully failed the first.
3367 let mut previously_failed_channels = Vec::new();
3369 assert_eq!(send_msg_events.len(), 1);
3370 let send_event = SendEvent::from_event(send_msg_events.pop().unwrap());
3371 assert_eq!(send_event.msgs.len(), 1);
3373 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]);
3374 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
3376 // Note that we only push one route into `expect_find_route` at a time, because that's all
3377 // the retries (should) need. If the bug is reintroduced "real" routes may be selected, but
3378 // we should still ultimately fail for the same reason - because we're trying to send too
3379 // many HTLCs at once.
3380 let mut new_route_params = route_params.clone();
3381 previously_failed_channels.push(route.paths[0].hops[1].short_channel_id);
3382 new_route_params.payment_params.previously_failed_channels = previously_failed_channels.clone();
3383 new_route_params.max_total_routing_fee_msat.as_mut().map(|m| *m -= 100_000);
3384 route.paths[0].hops[1].short_channel_id += 1;
3385 route.route_params = Some(new_route_params.clone());
3386 nodes[0].router.expect_find_route(new_route_params, Ok(route.clone()));
3388 let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3389 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
3390 // The "normal" commitment_signed_dance delivers the final RAA and then calls
3391 // `check_added_monitors` to ensure only the one RAA-generated monitor update was created.
3392 // This races with our other threads which may generate an add-HTLCs commitment update via
3393 // `process_pending_htlc_forwards`. Instead, we defer the monitor update check until after
3394 // *we've* called `process_pending_htlc_forwards` when its guaranteed to have two updates.
3395 let last_raa = commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true, false, true);
3396 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &last_raa);
3398 let cur_time = Instant::now();
3399 if cur_time > end_time {
3400 for thread in threads.drain(..) { thread.join().unwrap(); }
3403 // Make sure we have some events to handle when we go around...
3404 nodes[0].node.get_and_clear_pending_events(); // wipe the PendingHTLCsForwardable
3405 nodes[0].node.process_pending_htlc_forwards();
3406 send_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3407 check_added_monitors!(nodes[0], 2);
3409 if cur_time > end_time {
3415 fn do_no_missing_sent_on_reload(persist_manager_with_payment: bool, at_midpoint: bool) {
3416 // Test that if we reload in the middle of an HTLC claim commitment signed dance we'll still
3417 // receive the PaymentSent event even if the ChannelManager had no idea about the payment when
3418 // it was last persisted.
3419 let chanmon_cfgs = create_chanmon_cfgs(2);
3420 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3421 let (persister_a, persister_b, persister_c);
3422 let (chain_monitor_a, chain_monitor_b, chain_monitor_c);
3423 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3424 let (nodes_0_deserialized, nodes_0_deserialized_b, nodes_0_deserialized_c);
3425 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3427 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1).2;
3429 let mut nodes_0_serialized = Vec::new();
3430 if !persist_manager_with_payment {
3431 nodes_0_serialized = nodes[0].node.encode();
3434 let (our_payment_preimage, our_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
3436 if persist_manager_with_payment {
3437 nodes_0_serialized = nodes[0].node.encode();
3440 nodes[1].node.claim_funds(our_payment_preimage);
3441 check_added_monitors!(nodes[1], 1);
3442 expect_payment_claimed!(nodes[1], our_payment_hash, 1_000_000);
3445 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3446 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
3447 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed);
3448 check_added_monitors!(nodes[0], 1);
3450 let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3451 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
3452 commitment_signed_dance!(nodes[0], nodes[1], htlc_fulfill_updates.commitment_signed, false);
3453 // Ignore the PaymentSent event which is now pending on nodes[0] - if we were to handle it we'd
3454 // be expected to ignore the eventual conflicting PaymentFailed, but by not looking at it we
3455 // expect to get the PaymentSent again later.
3456 check_added_monitors(&nodes[0], 0);
3459 // The ChannelMonitor should always be the latest version, as we're required to persist it
3460 // during the commitment signed handling.
3461 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
3462 reload_node!(nodes[0], test_default_channel_config(), &nodes_0_serialized, &[&chan_0_monitor_serialized], persister_a, chain_monitor_a, nodes_0_deserialized);
3464 let events = nodes[0].node.get_and_clear_pending_events();
3465 assert_eq!(events.len(), 2);
3466 if let Event::ChannelClosed { reason: ClosureReason::OutdatedChannelManager, .. } = events[0] {} else { panic!(); }
3467 if let Event::PaymentSent { payment_preimage, .. } = events[1] { assert_eq!(payment_preimage, our_payment_preimage); } else { panic!(); }
3468 // Note that we don't get a PaymentPathSuccessful here as we leave the HTLC pending to avoid
3469 // the double-claim that would otherwise appear at the end of this test.
3470 nodes[0].node.timer_tick_occurred();
3471 let as_broadcasted_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3472 assert_eq!(as_broadcasted_txn.len(), 1);
3474 // Ensure that, even after some time, if we restart we still include *something* in the current
3475 // `ChannelManager` which prevents a `PaymentFailed` when we restart even if pending resolved
3476 // payments have since been timed out thanks to `IDEMPOTENCY_TIMEOUT_TICKS`.
3477 // A naive implementation of the fix here would wipe the pending payments set, causing a
3478 // failure event when we restart.
3479 for _ in 0..(IDEMPOTENCY_TIMEOUT_TICKS * 2) { nodes[0].node.timer_tick_occurred(); }
3481 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
3482 reload_node!(nodes[0], test_default_channel_config(), &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister_b, chain_monitor_b, nodes_0_deserialized_b);
3483 let events = nodes[0].node.get_and_clear_pending_events();
3484 assert!(events.is_empty());
3486 // Ensure that we don't generate any further events even after the channel-closing commitment
3487 // transaction is confirmed on-chain.
3488 confirm_transaction(&nodes[0], &as_broadcasted_txn[0]);
3489 for _ in 0..(IDEMPOTENCY_TIMEOUT_TICKS * 2) { nodes[0].node.timer_tick_occurred(); }
3491 let events = nodes[0].node.get_and_clear_pending_events();
3492 assert!(events.is_empty());
3494 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan_id).encode();
3495 reload_node!(nodes[0], test_default_channel_config(), &nodes[0].node.encode(), &[&chan_0_monitor_serialized], persister_c, chain_monitor_c, nodes_0_deserialized_c);
3496 let events = nodes[0].node.get_and_clear_pending_events();
3497 assert!(events.is_empty());
3498 check_added_monitors(&nodes[0], 1);
3502 fn no_missing_sent_on_midpoint_reload() {
3503 do_no_missing_sent_on_reload(false, true);
3504 do_no_missing_sent_on_reload(true, true);
3508 fn no_missing_sent_on_reload() {
3509 do_no_missing_sent_on_reload(false, false);
3510 do_no_missing_sent_on_reload(true, false);
3513 fn do_claim_from_closed_chan(fail_payment: bool) {
3514 // Previously, LDK would refuse to claim a payment if a channel on which the payment was
3515 // received had been closed between when the HTLC was received and when we went to claim it.
3516 // This makes sense in the payment case - why pay an on-chain fee to claim the HTLC when
3517 // presumably the sender may retry later. Long ago it also reduced total code in the claim
3520 // However, this doesn't make sense if you're trying to do an atomic swap or some other
3521 // protocol that requires atomicity with some other action - if your money got claimed
3522 // elsewhere you need to be able to claim the HTLC in lightning no matter what. Further, this
3523 // is an over-optimization - there should be a very, very low likelihood that a channel closes
3524 // between when we receive the last HTLC for a payment and the user goes to claim the payment.
3525 // Since we now have code to handle this anyway we should allow it.
3527 // Build 4 nodes and send an MPP payment across two paths. By building a route manually set the
3528 // CLTVs on the paths to different value resulting in a different claim deadline.
3529 let chanmon_cfgs = create_chanmon_cfgs(4);
3530 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3531 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3532 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3534 create_announced_chan_between_nodes(&nodes, 0, 1);
3535 create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0);
3536 let chan_bd = create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 1_000_000, 0).2;
3537 create_announced_chan_between_nodes(&nodes, 2, 3);
3539 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[3]);
3540 let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
3541 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
3542 let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, 10_000_000);
3543 let mut route = nodes[0].router.find_route(&nodes[0].node.get_our_node_id(), &route_params,
3544 None, nodes[0].node.compute_inflight_htlcs()).unwrap();
3545 // Make sure the route is ordered as the B->D path before C->D
3546 route.paths.sort_by(|a, _| if a.hops[0].pubkey == nodes[1].node.get_our_node_id() {
3547 std::cmp::Ordering::Less } else { std::cmp::Ordering::Greater });
3549 // Note that we add an extra 1 in the send pipeline to compensate for any blocks found while
3550 // the HTLC is being relayed.
3551 route.paths[0].hops[1].cltv_expiry_delta = TEST_FINAL_CLTV + 8;
3552 route.paths[1].hops[1].cltv_expiry_delta = TEST_FINAL_CLTV + 12;
3553 let final_cltv = nodes[0].best_block_info().1 + TEST_FINAL_CLTV + 8 + 1;
3555 nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
3556 nodes[0].node.send_payment(payment_hash, RecipientOnionFields::secret_only(payment_secret),
3557 PaymentId(payment_hash.0), route_params.clone(), Retry::Attempts(1)).unwrap();
3558 check_added_monitors(&nodes[0], 2);
3559 let mut send_msgs = nodes[0].node.get_and_clear_pending_msg_events();
3560 send_msgs.sort_by(|a, _| {
3562 if let MessageSendEvent::UpdateHTLCs { node_id, .. } = a { node_id } else { panic!() };
3563 let node_b_id = nodes[1].node.get_our_node_id();
3564 if *a_node_id == node_b_id { std::cmp::Ordering::Less } else { std::cmp::Ordering::Greater }
3567 assert_eq!(send_msgs.len(), 2);
3568 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 10_000_000,
3569 payment_hash, Some(payment_secret), send_msgs.remove(0), false, None);
3570 let receive_event = pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 10_000_000,
3571 payment_hash, Some(payment_secret), send_msgs.remove(0), true, None);
3573 match receive_event.unwrap() {
3574 Event::PaymentClaimable { claim_deadline, .. } => {
3575 assert_eq!(claim_deadline.unwrap(), final_cltv - HTLC_FAIL_BACK_BUFFER);
3580 // Ensure that the claim_deadline is correct, with the payment failing at exactly the given
3582 connect_blocks(&nodes[3], final_cltv - HTLC_FAIL_BACK_BUFFER - nodes[3].best_block_info().1
3583 - if fail_payment { 0 } else { 2 });
3585 // We fail the HTLC on the A->B->D path first as it expires 4 blocks earlier. We go ahead
3586 // and expire both immediately, though, by connecting another 4 blocks.
3587 let reason = HTLCDestination::FailedPayment { payment_hash };
3588 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[3], [reason.clone()]);
3589 connect_blocks(&nodes[3], 4);
3590 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[3], [reason]);
3591 pass_failed_payment_back(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash, PaymentFailureReason::RecipientRejected);
3593 nodes[1].node.force_close_broadcasting_latest_txn(&chan_bd, &nodes[3].node.get_our_node_id()).unwrap();
3594 check_closed_event!(&nodes[1], 1, ClosureReason::HolderForceClosed, false,
3595 [nodes[3].node.get_our_node_id()], 1000000);
3596 check_closed_broadcast(&nodes[1], 1, true);
3597 let bs_tx = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3598 assert_eq!(bs_tx.len(), 1);
3600 mine_transaction(&nodes[3], &bs_tx[0]);
3601 check_added_monitors(&nodes[3], 1);
3602 check_closed_broadcast(&nodes[3], 1, true);
3603 check_closed_event!(&nodes[3], 1, ClosureReason::CommitmentTxConfirmed, false,
3604 [nodes[1].node.get_our_node_id()], 1000000);
3606 nodes[3].node.claim_funds(payment_preimage);
3607 check_added_monitors(&nodes[3], 2);
3608 expect_payment_claimed!(nodes[3], payment_hash, 10_000_000);
3610 let ds_tx = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
3611 assert_eq!(ds_tx.len(), 1);
3612 check_spends!(&ds_tx[0], &bs_tx[0]);
3614 mine_transactions(&nodes[1], &[&bs_tx[0], &ds_tx[0]]);
3615 check_added_monitors(&nodes[1], 1);
3616 expect_payment_forwarded!(nodes[1], nodes[0], nodes[3], Some(1000), false, true);
3618 let bs_claims = nodes[1].node.get_and_clear_pending_msg_events();
3619 check_added_monitors(&nodes[1], 1);
3620 assert_eq!(bs_claims.len(), 1);
3621 if let MessageSendEvent::UpdateHTLCs { updates, .. } = &bs_claims[0] {
3622 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
3623 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false, true);
3624 } else { panic!(); }
3626 expect_payment_sent!(nodes[0], payment_preimage);
3628 let ds_claim_msgs = nodes[3].node.get_and_clear_pending_msg_events();
3629 assert_eq!(ds_claim_msgs.len(), 1);
3630 let cs_claim_msgs = if let MessageSendEvent::UpdateHTLCs { updates, .. } = &ds_claim_msgs[0] {
3631 nodes[2].node.handle_update_fulfill_htlc(&nodes[3].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
3632 let cs_claim_msgs = nodes[2].node.get_and_clear_pending_msg_events();
3633 check_added_monitors(&nodes[2], 1);
3634 commitment_signed_dance!(nodes[2], nodes[3], updates.commitment_signed, false, true);
3635 expect_payment_forwarded!(nodes[2], nodes[0], nodes[3], Some(1000), false, false);
3637 } else { panic!(); };
3639 assert_eq!(cs_claim_msgs.len(), 1);
3640 if let MessageSendEvent::UpdateHTLCs { updates, .. } = &cs_claim_msgs[0] {
3641 nodes[0].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
3642 commitment_signed_dance!(nodes[0], nodes[2], updates.commitment_signed, false, true);
3643 } else { panic!(); }
3645 expect_payment_path_successful!(nodes[0]);
3650 fn claim_from_closed_chan() {
3651 do_claim_from_closed_chan(true);
3652 do_claim_from_closed_chan(false);
3656 fn test_custom_tlvs_basic() {
3657 do_test_custom_tlvs(false, false, false);
3658 do_test_custom_tlvs(true, false, false);
3662 fn test_custom_tlvs_explicit_claim() {
3663 // Test that when receiving even custom TLVs the user must explicitly accept in case they
3665 do_test_custom_tlvs(false, true, false);
3666 do_test_custom_tlvs(false, true, true);
3669 fn do_test_custom_tlvs(spontaneous: bool, even_tlvs: bool, known_tlvs: bool) {
3670 let chanmon_cfgs = create_chanmon_cfgs(2);
3671 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3672 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None; 2]);
3673 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3675 create_announced_chan_between_nodes(&nodes, 0, 1);
3677 let amt_msat = 100_000;
3678 let (mut route, our_payment_hash, our_payment_preimage, our_payment_secret) = get_route_and_payment_hash!(&nodes[0], &nodes[1], amt_msat);
3679 let payment_id = PaymentId(our_payment_hash.0);
3680 let custom_tlvs = vec![
3681 (if even_tlvs { 5482373482 } else { 5482373483 }, vec![1, 2, 3, 4]),
3682 (5482373487, vec![0x42u8; 16]),
3684 let onion_fields = RecipientOnionFields {
3685 payment_secret: if spontaneous { None } else { Some(our_payment_secret) },
3686 payment_metadata: None,
3687 custom_tlvs: custom_tlvs.clone()
3690 nodes[0].node.send_spontaneous_payment(&route, Some(our_payment_preimage), onion_fields, payment_id).unwrap();
3692 nodes[0].node.send_payment_with_route(&route, our_payment_hash, onion_fields, payment_id).unwrap();
3694 check_added_monitors(&nodes[0], 1);
3696 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3697 let ev = remove_first_msg_event_to_node(&nodes[1].node.get_our_node_id(), &mut events);
3698 let mut payment_event = SendEvent::from_event(ev);
3700 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3701 check_added_monitors!(&nodes[1], 0);
3702 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3703 expect_pending_htlcs_forwardable!(nodes[1]);
3705 let events = nodes[1].node.get_and_clear_pending_events();
3706 assert_eq!(events.len(), 1);
3708 Event::PaymentClaimable { ref onion_fields, .. } => {
3709 assert_eq!(onion_fields.clone().unwrap().custom_tlvs().clone(), custom_tlvs);
3711 _ => panic!("Unexpected event"),
3714 match (known_tlvs, even_tlvs) {
3716 nodes[1].node.claim_funds_with_known_custom_tlvs(our_payment_preimage);
3717 let expected_total_fee_msat = pass_claimed_payment_along_route(ClaimAlongRouteArgs::new(&nodes[0], &[&[&nodes[1]]], our_payment_preimage));
3718 expect_payment_sent!(&nodes[0], our_payment_preimage, Some(expected_total_fee_msat));
3721 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
3724 nodes[1].node.claim_funds(our_payment_preimage);
3725 let expected_destinations = vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }];
3726 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], expected_destinations);
3727 pass_failed_payment_back(&nodes[0], &[&[&nodes[1]]], false, our_payment_hash, PaymentFailureReason::RecipientRejected);
3733 fn test_retry_custom_tlvs() {
3734 // Test that custom TLVs are successfully sent on retries
3735 let chanmon_cfgs = create_chanmon_cfgs(3);
3736 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3737 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3738 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3740 create_announced_chan_between_nodes(&nodes, 0, 1);
3741 let (chan_2_update, _, chan_2_id, _) = create_announced_chan_between_nodes(&nodes, 2, 1);
3744 send_payment(&nodes[2], &vec!(&nodes[1])[..], 1_500_000);
3746 let amt_msat = 1_000_000;
3747 let (mut route, payment_hash, payment_preimage, payment_secret) =
3748 get_route_and_payment_hash!(nodes[0], nodes[2], amt_msat);
3750 // Initiate the payment
3751 let payment_id = PaymentId(payment_hash.0);
3752 let mut route_params = route.route_params.clone().unwrap();
3754 let custom_tlvs = vec![((1 << 16) + 1, vec![0x42u8; 16])];
3755 let onion_fields = RecipientOnionFields::secret_only(payment_secret);
3756 let onion_fields = onion_fields.with_custom_tlvs(custom_tlvs.clone()).unwrap();
3758 nodes[0].router.expect_find_route(route_params.clone(), Ok(route.clone()));
3759 nodes[0].node.send_payment(payment_hash, onion_fields,
3760 payment_id, route_params.clone(), Retry::Attempts(1)).unwrap();
3761 check_added_monitors!(nodes[0], 1); // one monitor per path
3763 // Add the HTLC along the first hop.
3764 let htlc_updates = get_htlc_update_msgs(&nodes[0], &nodes[1].node.get_our_node_id());
3765 let msgs::CommitmentUpdate { update_add_htlcs, commitment_signed, .. } = htlc_updates;
3766 assert_eq!(update_add_htlcs.len(), 1);
3767 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_htlcs[0]);
3768 commitment_signed_dance!(nodes[1], nodes[0], commitment_signed, false);
3770 // Attempt to forward the payment and complete the path's failure.
3771 expect_pending_htlcs_forwardable!(&nodes[1]);
3772 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[1],
3773 vec![HTLCDestination::NextHopChannel {
3774 node_id: Some(nodes[2].node.get_our_node_id()),
3775 channel_id: chan_2_id
3777 check_added_monitors!(nodes[1], 1);
3779 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3780 let msgs::CommitmentUpdate { update_fail_htlcs, commitment_signed, .. } = htlc_updates;
3781 assert_eq!(update_fail_htlcs.len(), 1);
3782 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3783 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false);
3785 let mut events = nodes[0].node.get_and_clear_pending_events();
3787 Event::PendingHTLCsForwardable { .. } => {},
3788 _ => panic!("Unexpected event")
3791 expect_payment_failed_conditions_event(events, payment_hash, false,
3792 PaymentFailedConditions::new().mpp_parts_remain());
3794 // Rebalance the channel so the retry of the payment can succeed.
3795 send_payment(&nodes[2], &vec!(&nodes[1])[..], 1_500_000);
3797 // Retry the payment and make sure it succeeds
3798 route_params.payment_params.previously_failed_channels.push(chan_2_update.contents.short_channel_id);
3799 route.route_params = Some(route_params.clone());
3800 nodes[0].router.expect_find_route(route_params, Ok(route));
3801 nodes[0].node.process_pending_htlc_forwards();
3802 check_added_monitors!(nodes[0], 1);
3803 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3804 assert_eq!(events.len(), 1);
3805 let path = &[&nodes[1], &nodes[2]];
3806 let args = PassAlongPathArgs::new(&nodes[0], path, 1_000_000, payment_hash, events.pop().unwrap())
3807 .with_payment_secret(payment_secret)
3808 .with_custom_tlvs(custom_tlvs);
3809 do_pass_along_path(args);
3810 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
3814 fn test_custom_tlvs_consistency() {
3815 let even_type_1 = 1 << 16;
3816 let odd_type_1 = (1 << 16)+ 1;
3817 let even_type_2 = (1 << 16) + 2;
3818 let odd_type_2 = (1 << 16) + 3;
3819 let value_1 = || vec![1, 2, 3, 4];
3820 let differing_value_1 = || vec![1, 2, 3, 5];
3821 let value_2 = || vec![42u8; 16];
3823 // Drop missing odd tlvs
3824 do_test_custom_tlvs_consistency(
3825 vec![(odd_type_1, value_1()), (odd_type_2, value_2())],
3826 vec![(odd_type_1, value_1())],
3827 Some(vec![(odd_type_1, value_1())]),
3829 // Drop non-matching odd tlvs
3830 do_test_custom_tlvs_consistency(
3831 vec![(odd_type_1, value_1()), (odd_type_2, value_2())],
3832 vec![(odd_type_1, differing_value_1()), (odd_type_2, value_2())],
3833 Some(vec![(odd_type_2, value_2())]),
3835 // Fail missing even tlvs
3836 do_test_custom_tlvs_consistency(
3837 vec![(odd_type_1, value_1()), (even_type_2, value_2())],
3838 vec![(odd_type_1, value_1())],
3841 // Fail non-matching even tlvs
3842 do_test_custom_tlvs_consistency(
3843 vec![(even_type_1, value_1()), (odd_type_2, value_2())],
3844 vec![(even_type_1, differing_value_1()), (odd_type_2, value_2())],
3849 fn do_test_custom_tlvs_consistency(first_tlvs: Vec<(u64, Vec<u8>)>, second_tlvs: Vec<(u64, Vec<u8>)>,
3850 expected_receive_tlvs: Option<Vec<(u64, Vec<u8>)>>) {
3852 let chanmon_cfgs = create_chanmon_cfgs(4);
3853 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3854 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3855 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3857 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 0);
3858 create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 100_000, 0);
3859 create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 100_000, 0);
3860 let chan_2_3 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 100_000, 0);
3862 let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
3863 .with_bolt11_features(nodes[3].node.bolt11_invoice_features()).unwrap();
3864 let mut route = get_route!(nodes[0], payment_params, 15_000_000).unwrap();
3865 assert_eq!(route.paths.len(), 2);
3866 route.paths.sort_by(|path_a, _| {
3867 // Sort the path so that the path through nodes[1] comes first
3868 if path_a.hops[0].pubkey == nodes[1].node.get_our_node_id() {
3869 core::cmp::Ordering::Less } else { core::cmp::Ordering::Greater }
3872 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(&nodes[3]);
3873 let payment_id = PaymentId([42; 32]);
3874 let amt_msat = 15_000_000;
3877 let onion_fields = RecipientOnionFields {
3878 payment_secret: Some(our_payment_secret),
3879 payment_metadata: None,
3880 custom_tlvs: first_tlvs
3882 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash,
3883 onion_fields.clone(), payment_id, &route).unwrap();
3884 let cur_height = nodes[0].best_block_info().1;
3885 nodes[0].node.test_send_payment_along_path(&route.paths[0], &our_payment_hash,
3886 onion_fields.clone(), amt_msat, cur_height, payment_id,
3887 &None, session_privs[0]).unwrap();
3888 check_added_monitors!(nodes[0], 1);
3891 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3892 assert_eq!(events.len(), 1);
3893 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], amt_msat, our_payment_hash,
3894 Some(our_payment_secret), events.pop().unwrap(), false, None);
3896 assert!(nodes[3].node.get_and_clear_pending_events().is_empty());
3899 let onion_fields = RecipientOnionFields {
3900 payment_secret: Some(our_payment_secret),
3901 payment_metadata: None,
3902 custom_tlvs: second_tlvs
3904 nodes[0].node.test_send_payment_along_path(&route.paths[1], &our_payment_hash,
3905 onion_fields.clone(), amt_msat, cur_height, payment_id, &None, session_privs[1]).unwrap();
3906 check_added_monitors!(nodes[0], 1);
3909 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3910 assert_eq!(events.len(), 1);
3911 let payment_event = SendEvent::from_event(events.pop().unwrap());
3913 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3914 commitment_signed_dance!(nodes[2], nodes[0], payment_event.commitment_msg, false);
3916 expect_pending_htlcs_forwardable!(nodes[2]);
3917 check_added_monitors!(nodes[2], 1);
3919 let mut events = nodes[2].node.get_and_clear_pending_msg_events();
3920 assert_eq!(events.len(), 1);
3921 let payment_event = SendEvent::from_event(events.pop().unwrap());
3923 nodes[3].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &payment_event.msgs[0]);
3924 check_added_monitors!(nodes[3], 0);
3925 commitment_signed_dance!(nodes[3], nodes[2], payment_event.commitment_msg, true, true);
3927 expect_pending_htlcs_forwardable_ignore!(nodes[3]);
3928 nodes[3].node.process_pending_htlc_forwards();
3930 if let Some(expected_tlvs) = expected_receive_tlvs {
3931 // Claim and match expected
3932 let events = nodes[3].node.get_and_clear_pending_events();
3933 assert_eq!(events.len(), 1);
3935 Event::PaymentClaimable { ref onion_fields, .. } => {
3936 assert_eq!(onion_fields.clone().unwrap().custom_tlvs, expected_tlvs);
3938 _ => panic!("Unexpected event"),
3941 do_claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]],
3942 false, our_payment_preimage);
3943 expect_payment_sent(&nodes[0], our_payment_preimage, Some(Some(2000)), true, true);
3946 let expected_destinations = vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }];
3947 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], expected_destinations);
3948 check_added_monitors!(nodes[3], 1);
3950 let fail_updates_1 = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
3951 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &fail_updates_1.update_fail_htlcs[0]);
3952 commitment_signed_dance!(nodes[2], nodes[3], fail_updates_1.commitment_signed, false);
3954 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[2], vec![
3955 HTLCDestination::NextHopChannel {
3956 node_id: Some(nodes[3].node.get_our_node_id()),
3957 channel_id: chan_2_3.2
3959 check_added_monitors!(nodes[2], 1);
3961 let fail_updates_2 = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
3962 nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_updates_2.update_fail_htlcs[0]);
3963 commitment_signed_dance!(nodes[0], nodes[2], fail_updates_2.commitment_signed, false);
3965 expect_payment_failed_conditions(&nodes[0], our_payment_hash, true,
3966 PaymentFailedConditions::new().mpp_parts_remain());
3970 fn do_test_payment_metadata_consistency(do_reload: bool, do_modify: bool) {
3971 // Check that a payment metadata received on one HTLC that doesn't match the one received on
3972 // another results in the HTLC being rejected.
3974 // We first set up a diamond shaped network, allowing us to split a payment into two HTLCs, the
3975 // first of which we'll deliver and the second of which we'll fail and then re-send with
3976 // modified payment metadata, which will in turn result in it being failed by the recipient.
3977 let chanmon_cfgs = create_chanmon_cfgs(4);
3978 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3980 let new_chain_monitor;
3982 let mut config = test_default_channel_config();
3983 config.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 50;
3984 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, Some(config), Some(config), Some(config)]);
3985 let nodes_0_deserialized;
3987 let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3989 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
3990 let chan_id_bd = create_announced_chan_between_nodes_with_value(&nodes, 1, 3, 1_000_000, 0).2;
3991 create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1_000_000, 0);
3992 let chan_id_cd = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0).2;
3994 // Pay more than half of each channel's max, requiring MPP
3995 let amt_msat = 750_000_000;
3996 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!(nodes[3], Some(amt_msat));
3997 let payment_id = PaymentId(payment_hash.0);
3998 let payment_metadata = vec![44, 49, 52, 142];
4000 let payment_params = PaymentParameters::from_node_id(nodes[3].node.get_our_node_id(), TEST_FINAL_CLTV)
4001 .with_bolt11_features(nodes[1].node.bolt11_invoice_features()).unwrap();
4002 let mut route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
4004 // Send the MPP payment, delivering the updated commitment state to nodes[1].
4005 nodes[0].node.send_payment(payment_hash, RecipientOnionFields {
4006 payment_secret: Some(payment_secret), payment_metadata: Some(payment_metadata), custom_tlvs: vec![],
4007 }, payment_id, route_params.clone(), Retry::Attempts(1)).unwrap();
4008 check_added_monitors!(nodes[0], 2);
4010 let mut send_events = nodes[0].node.get_and_clear_pending_msg_events();
4011 assert_eq!(send_events.len(), 2);
4012 let first_send = SendEvent::from_event(send_events.pop().unwrap());
4013 let second_send = SendEvent::from_event(send_events.pop().unwrap());
4015 let (b_recv_ev, c_recv_ev) = if first_send.node_id == nodes[1].node.get_our_node_id() {
4016 (&first_send, &second_send)
4018 (&second_send, &first_send)
4020 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &b_recv_ev.msgs[0]);
4021 commitment_signed_dance!(nodes[1], nodes[0], b_recv_ev.commitment_msg, false, true);
4023 expect_pending_htlcs_forwardable!(nodes[1]);
4024 check_added_monitors(&nodes[1], 1);
4025 let b_forward_ev = SendEvent::from_node(&nodes[1]);
4026 nodes[3].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &b_forward_ev.msgs[0]);
4027 commitment_signed_dance!(nodes[3], nodes[1], b_forward_ev.commitment_msg, false, true);
4029 expect_pending_htlcs_forwardable!(nodes[3]);
4031 // Before delivering the second MPP HTLC to nodes[2], disconnect nodes[2] and nodes[3], which
4032 // will result in nodes[2] failing the HTLC back.
4033 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id());
4034 nodes[3].node.peer_disconnected(&nodes[2].node.get_our_node_id());
4036 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &c_recv_ev.msgs[0]);
4037 commitment_signed_dance!(nodes[2], nodes[0], c_recv_ev.commitment_msg, false, true);
4039 let cs_fail = get_htlc_update_msgs(&nodes[2], &nodes[0].node.get_our_node_id());
4040 nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &cs_fail.update_fail_htlcs[0]);
4041 commitment_signed_dance!(nodes[0], nodes[2], cs_fail.commitment_signed, false, true);
4043 let payment_fail_retryable_evs = nodes[0].node.get_and_clear_pending_events();
4044 assert_eq!(payment_fail_retryable_evs.len(), 2);
4045 if let Event::PaymentPathFailed { .. } = payment_fail_retryable_evs[0] {} else { panic!(); }
4046 if let Event::PendingHTLCsForwardable { .. } = payment_fail_retryable_evs[1] {} else { panic!(); }
4048 // Before we allow the HTLC to be retried, optionally change the payment_metadata we have
4049 // stored for our payment.
4051 nodes[0].node.test_set_payment_metadata(payment_id, Some(Vec::new()));
4054 // Optionally reload nodes[3] to check that the payment_metadata is properly serialized with
4055 // the payment state.
4057 let mon_bd = get_monitor!(nodes[3], chan_id_bd).encode();
4058 let mon_cd = get_monitor!(nodes[3], chan_id_cd).encode();
4059 reload_node!(nodes[3], config, &nodes[3].node.encode(), &[&mon_bd, &mon_cd],
4060 persister, new_chain_monitor, nodes_0_deserialized);
4061 nodes[1].node.peer_disconnected(&nodes[3].node.get_our_node_id());
4062 reconnect_nodes(ReconnectArgs::new(&nodes[1], &nodes[3]));
4064 let mut reconnect_args = ReconnectArgs::new(&nodes[2], &nodes[3]);
4065 reconnect_args.send_channel_ready = (true, true);
4066 reconnect_nodes(reconnect_args);
4068 // Create a new channel between C and D as A will refuse to retry on the existing one because
4070 let chan_id_cd_2 = create_announced_chan_between_nodes_with_value(&nodes, 2, 3, 1_000_000, 0).2;
4072 // Now retry the failed HTLC.
4073 nodes[0].node.process_pending_htlc_forwards();
4074 check_added_monitors(&nodes[0], 1);
4075 let as_resend = SendEvent::from_node(&nodes[0]);
4076 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resend.msgs[0]);
4077 commitment_signed_dance!(nodes[2], nodes[0], as_resend.commitment_msg, false, true);
4079 expect_pending_htlcs_forwardable!(nodes[2]);
4080 check_added_monitors(&nodes[2], 1);
4081 let cs_forward = SendEvent::from_node(&nodes[2]);
4082 nodes[3].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &cs_forward.msgs[0]);
4083 commitment_signed_dance!(nodes[3], nodes[2], cs_forward.commitment_msg, false, true);
4085 // Finally, check that nodes[3] does the correct thing - either accepting the payment or, if
4086 // the payment metadata was modified, failing only the one modified HTLC and retaining the
4089 expect_pending_htlcs_forwardable_ignore!(nodes[3]);
4090 nodes[3].node.process_pending_htlc_forwards();
4091 expect_pending_htlcs_forwardable_conditions(nodes[3].node.get_and_clear_pending_events(),
4092 &[HTLCDestination::FailedPayment {payment_hash}]);
4093 nodes[3].node.process_pending_htlc_forwards();
4095 check_added_monitors(&nodes[3], 1);
4096 let ds_fail = get_htlc_update_msgs(&nodes[3], &nodes[2].node.get_our_node_id());
4098 nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &ds_fail.update_fail_htlcs[0]);
4099 commitment_signed_dance!(nodes[2], nodes[3], ds_fail.commitment_signed, false, true);
4100 expect_pending_htlcs_forwardable_conditions(nodes[2].node.get_and_clear_pending_events(),
4101 &[HTLCDestination::NextHopChannel { node_id: Some(nodes[3].node.get_our_node_id()), channel_id: chan_id_cd_2 }]);
4103 expect_pending_htlcs_forwardable!(nodes[3]);
4104 expect_payment_claimable!(nodes[3], payment_hash, payment_secret, amt_msat);
4105 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
4110 fn test_payment_metadata_consistency() {
4111 do_test_payment_metadata_consistency(true, true);
4112 do_test_payment_metadata_consistency(true, false);
4113 do_test_payment_metadata_consistency(false, true);
4114 do_test_payment_metadata_consistency(false, false);
4118 fn test_htlc_forward_considers_anchor_outputs_value() {
4121 // 1) Forwarding nodes don't forward HTLCs that would cause their balance to dip below the
4122 // reserve when considering the value of anchor outputs.
4124 // 2) Recipients of `update_add_htlc` properly reject HTLCs that would cause the initiator's
4125 // balance to dip below the reserve when considering the value of anchor outputs.
4126 let mut config = test_default_channel_config();
4127 config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
4128 config.manually_accept_inbound_channels = true;
4129 config.channel_config.forwarding_fee_base_msat = 0;
4130 config.channel_config.forwarding_fee_proportional_millionths = 0;
4132 // Set up a test network of three nodes that replicates a production failure leading to the
4133 // discovery of this bug.
4134 let chanmon_cfgs = create_chanmon_cfgs(3);
4135 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4136 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[Some(config), Some(config), Some(config)]);
4137 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4139 const CHAN_AMT: u64 = 1_000_000;
4140 const PUSH_MSAT: u64 = 900_000_000;
4141 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, CHAN_AMT, 500_000_000);
4142 let (_, _, chan_id_2, _) = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, CHAN_AMT, PUSH_MSAT);
4144 let channel_reserve_msat = get_holder_selected_channel_reserve_satoshis(CHAN_AMT, &config) * 1000;
4145 let commitment_fee_msat = commit_tx_fee_msat(
4146 *nodes[1].fee_estimator.sat_per_kw.lock().unwrap(), 2, &ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()
4148 let anchor_outpus_value_msat = ANCHOR_OUTPUT_VALUE_SATOSHI * 2 * 1000;
4149 let sendable_balance_msat = CHAN_AMT * 1000 - PUSH_MSAT - channel_reserve_msat - commitment_fee_msat - anchor_outpus_value_msat;
4150 let channel_details = nodes[1].node.list_channels().into_iter().find(|channel| channel.channel_id == chan_id_2).unwrap();
4151 assert!(sendable_balance_msat >= channel_details.next_outbound_htlc_minimum_msat);
4152 assert!(sendable_balance_msat <= channel_details.next_outbound_htlc_limit_msat);
4154 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], sendable_balance_msat);
4155 send_payment(&nodes[2], &[&nodes[1], &nodes[0]], sendable_balance_msat);
4157 // Send out an HTLC that would cause the forwarding node to dip below its reserve when
4158 // considering the value of anchor outputs.
4159 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(
4160 nodes[0], nodes[2], sendable_balance_msat + anchor_outpus_value_msat
4162 nodes[0].node.send_payment_with_route(
4163 &route, payment_hash, RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)
4165 check_added_monitors!(nodes[0], 1);
4167 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4168 assert_eq!(events.len(), 1);
4169 let mut update_add_htlc = if let MessageSendEvent::UpdateHTLCs { updates, .. } = events.pop().unwrap() {
4170 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
4171 check_added_monitors(&nodes[1], 0);
4172 commitment_signed_dance!(nodes[1], nodes[0], &updates.commitment_signed, false);
4173 updates.update_add_htlcs[0].clone()
4175 panic!("Unexpected event");
4178 // The forwarding node should reject forwarding it as expected.
4179 expect_pending_htlcs_forwardable!(nodes[1]);
4180 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[1], vec![HTLCDestination::NextHopChannel {
4181 node_id: Some(nodes[2].node.get_our_node_id()),
4182 channel_id: chan_id_2
4184 check_added_monitors(&nodes[1], 1);
4186 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
4187 assert_eq!(events.len(), 1);
4188 if let MessageSendEvent::UpdateHTLCs { updates, .. } = events.pop().unwrap() {
4189 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4190 check_added_monitors(&nodes[0], 0);
4191 commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4193 panic!("Unexpected event");
4196 expect_payment_failed!(nodes[0], payment_hash, false);
4198 // Assume that the forwarding node did forward it, and make sure the recipient rejects it as an
4199 // invalid update and closes the channel.
4200 update_add_htlc.channel_id = chan_id_2;
4201 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
4202 check_closed_event(&nodes[2], 1, ClosureReason::ProcessingError {
4203 err: "Remote HTLC add would put them under remote reserve value".to_owned()
4204 }, false, &[nodes[1].node.get_our_node_id()], 1_000_000);
4205 check_closed_broadcast(&nodes[2], 1, true);
4206 check_added_monitors(&nodes[2], 1);
4210 fn peel_payment_onion_custom_tlvs() {
4211 let chanmon_cfgs = create_chanmon_cfgs(2);
4212 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4213 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4214 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4215 create_announced_chan_between_nodes(&nodes, 0, 1);
4216 let secp_ctx = Secp256k1::new();
4218 let amt_msat = 1000;
4219 let payment_params = PaymentParameters::for_keysend(nodes[1].node.get_our_node_id(),
4220 TEST_FINAL_CLTV, false);
4221 let route_params = RouteParameters::from_payment_params_and_value(payment_params, amt_msat);
4222 let route = functional_test_utils::get_route(&nodes[0], &route_params).unwrap();
4223 let mut recipient_onion = RecipientOnionFields::spontaneous_empty()
4224 .with_custom_tlvs(vec![(414141, vec![42; 1200])]).unwrap();
4225 let prng_seed = chanmon_cfgs[0].keys_manager.get_secure_random_bytes();
4226 let session_priv = SecretKey::from_slice(&prng_seed[..]).expect("RNG is busted");
4227 let keysend_preimage = PaymentPreimage([42; 32]);
4228 let payment_hash = PaymentHash(Sha256::hash(&keysend_preimage.0).to_byte_array());
4230 let (onion_routing_packet, first_hop_msat, cltv_expiry) = onion_utils::create_payment_onion(
4231 &secp_ctx, &route.paths[0], &session_priv, amt_msat, recipient_onion.clone(),
4232 nodes[0].best_block_info().1, &payment_hash, &Some(keysend_preimage), prng_seed
4235 let update_add = msgs::UpdateAddHTLC {
4236 channel_id: ChannelId([0; 32]),
4238 amount_msat: first_hop_msat,
4241 skimmed_fee_msat: None,
4242 onion_routing_packet,
4243 blinding_point: None,
4245 let peeled_onion = crate::ln::onion_payment::peel_payment_onion(
4246 &update_add, &&chanmon_cfgs[1].keys_manager, &&chanmon_cfgs[1].logger, &secp_ctx,
4247 nodes[1].best_block_info().1, true, false
4249 assert_eq!(peeled_onion.incoming_amt_msat, Some(amt_msat));
4250 match peeled_onion.routing {
4251 PendingHTLCRouting::ReceiveKeysend {
4252 payment_data, payment_metadata, custom_tlvs, ..
4254 #[cfg(not(c_bindings))]
4255 assert_eq!(&custom_tlvs, recipient_onion.custom_tlvs());
4257 assert_eq!(custom_tlvs, recipient_onion.custom_tlvs());
4258 assert!(payment_metadata.is_none());
4259 assert!(payment_data.is_none());