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 chain::{ChannelMonitorUpdateErr, Confirm, Listen, Watch};
15 use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor, LATENCY_GRACE_PERIOD_BLOCKS};
16 use chain::transaction::OutPoint;
17 use chain::keysinterface::KeysInterface;
18 use ln::channelmanager::{BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, MPP_TIMEOUT_TICKS, PaymentId, PaymentSendFailure};
19 use ln::features::{InitFeatures, InvoiceFeatures};
21 use ln::msgs::ChannelMessageHandler;
22 use routing::router::{PaymentParameters, get_route};
23 use util::events::{ClosureReason, Event, MessageSendEvent, MessageSendEventsProvider};
25 use util::errors::APIError;
26 use util::enforcing_trait_impls::EnforcingSigner;
27 use util::ser::{ReadableArgs, Writeable};
30 use bitcoin::{Block, BlockHeader, BlockHash};
31 use bitcoin::network::constants::Network;
35 use ln::functional_test_utils::*;
38 fn retry_single_path_payment() {
39 let chanmon_cfgs = create_chanmon_cfgs(3);
40 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
41 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
42 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
44 let _chan_0 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
45 let _chan_1 = create_announced_chan_between_nodes(&nodes, 2, 1, InitFeatures::known(), InitFeatures::known());
46 // Rebalance to find a route
47 send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
49 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100_000);
51 // Rebalance so that the first hop fails.
52 send_payment(&nodes[1], &vec!(&nodes[2])[..], 2_000_000);
54 // Make sure the payment fails on the first hop.
55 let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
56 check_added_monitors!(nodes[0], 1);
57 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
58 assert_eq!(events.len(), 1);
59 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
60 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
61 check_added_monitors!(nodes[1], 0);
62 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
63 expect_pending_htlcs_forwardable!(nodes[1]);
64 expect_pending_htlcs_forwardable!(&nodes[1]);
65 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
66 assert!(htlc_updates.update_add_htlcs.is_empty());
67 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
68 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
69 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
70 check_added_monitors!(nodes[1], 1);
71 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
72 commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false);
73 expect_payment_failed_conditions!(nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
75 // Rebalance the channel so the retry succeeds.
76 send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
78 // Mine two blocks (we expire retries after 3, so this will check that we don't expire early)
79 connect_blocks(&nodes[0], 2);
81 // Retry the payment and make sure it succeeds.
82 nodes[0].node.retry_payment(&route, payment_id).unwrap();
83 check_added_monitors!(nodes[0], 1);
84 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
85 assert_eq!(events.len(), 1);
86 pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], 100_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
87 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
92 let chanmon_cfgs = create_chanmon_cfgs(4);
93 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
94 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
95 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
97 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
98 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
99 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
100 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
102 let (mut route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
103 let path = route.paths[0].clone();
104 route.paths.push(path);
105 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
106 route.paths[0][0].short_channel_id = chan_1_id;
107 route.paths[0][1].short_channel_id = chan_3_id;
108 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
109 route.paths[1][0].short_channel_id = chan_2_id;
110 route.paths[1][1].short_channel_id = chan_4_id;
111 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
112 fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
117 let chanmon_cfgs = create_chanmon_cfgs(4);
118 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
119 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
120 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
122 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
123 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
124 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
125 let chan_4_id = create_announced_chan_between_nodes(&nodes, 3, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
127 send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
129 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 1_000_000);
130 let path = route.paths[0].clone();
131 route.paths.push(path);
132 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
133 route.paths[0][0].short_channel_id = chan_1_id;
134 route.paths[0][1].short_channel_id = chan_3_id;
135 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
136 route.paths[1][0].short_channel_id = chan_2_id;
137 route.paths[1][1].short_channel_id = chan_4_id;
139 // Initiate the MPP payment.
140 let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
141 check_added_monitors!(nodes[0], 2); // one monitor per path
142 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
143 assert_eq!(events.len(), 2);
145 // Pass half of the payment along the success path.
146 let success_path_msgs = events.remove(0);
147 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), success_path_msgs, false, None);
149 // Add the HTLC along the first hop.
150 let fail_path_msgs_1 = events.remove(0);
151 let (update_add, commitment_signed) = match fail_path_msgs_1 {
152 MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
153 assert_eq!(update_add_htlcs.len(), 1);
154 assert!(update_fail_htlcs.is_empty());
155 assert!(update_fulfill_htlcs.is_empty());
156 assert!(update_fail_malformed_htlcs.is_empty());
157 assert!(update_fee.is_none());
158 (update_add_htlcs[0].clone(), commitment_signed.clone())
160 _ => panic!("Unexpected event"),
162 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
163 commitment_signed_dance!(nodes[2], nodes[0], commitment_signed, false);
165 // Attempt to forward the payment and complete the 2nd path's failure.
166 expect_pending_htlcs_forwardable!(&nodes[2]);
167 expect_pending_htlcs_forwardable!(&nodes[2]);
168 let htlc_updates = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
169 assert!(htlc_updates.update_add_htlcs.is_empty());
170 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
171 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
172 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
173 check_added_monitors!(nodes[2], 1);
174 nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
175 commitment_signed_dance!(nodes[0], nodes[2], htlc_updates.commitment_signed, false);
176 expect_payment_failed_conditions!(nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
178 // Rebalance the channel so the second half of the payment can succeed.
179 send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
181 // Make sure it errors as expected given a too-large amount.
182 if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, payment_id) {
183 assert!(err.contains("over total_payment_amt_msat"));
184 } else { panic!("Unexpected error"); }
186 // Make sure it errors as expected given the wrong payment_id.
187 if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, PaymentId([0; 32])) {
188 assert!(err.contains("not found"));
189 } else { panic!("Unexpected error"); }
191 // Retry the second half of the payment and make sure it succeeds.
192 let mut path = route.clone();
193 path.paths.remove(0);
194 nodes[0].node.retry_payment(&path, payment_id).unwrap();
195 check_added_monitors!(nodes[0], 1);
196 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
197 assert_eq!(events.len(), 1);
198 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
199 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
202 fn do_mpp_receive_timeout(send_partial_mpp: bool) {
203 let chanmon_cfgs = create_chanmon_cfgs(4);
204 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
205 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
206 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
208 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
209 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
210 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
211 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
213 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 100_000);
214 let path = route.paths[0].clone();
215 route.paths.push(path);
216 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
217 route.paths[0][0].short_channel_id = chan_1_id;
218 route.paths[0][1].short_channel_id = chan_3_id;
219 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
220 route.paths[1][0].short_channel_id = chan_2_id;
221 route.paths[1][1].short_channel_id = chan_4_id;
223 // Initiate the MPP payment.
224 let _ = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
225 check_added_monitors!(nodes[0], 2); // one monitor per path
226 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
227 assert_eq!(events.len(), 2);
229 // Pass half of the payment along the first path.
230 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 200_000, payment_hash, Some(payment_secret), events.remove(0), false, None);
232 if send_partial_mpp {
233 // Time out the partial MPP
234 for _ in 0..MPP_TIMEOUT_TICKS {
235 nodes[3].node.timer_tick_occurred();
238 // Failed HTLC from node 3 -> 1
239 expect_pending_htlcs_forwardable!(nodes[3]);
240 let htlc_fail_updates_3_1 = get_htlc_update_msgs!(nodes[3], nodes[1].node.get_our_node_id());
241 assert_eq!(htlc_fail_updates_3_1.update_fail_htlcs.len(), 1);
242 nodes[1].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &htlc_fail_updates_3_1.update_fail_htlcs[0]);
243 check_added_monitors!(nodes[3], 1);
244 commitment_signed_dance!(nodes[1], nodes[3], htlc_fail_updates_3_1.commitment_signed, false);
246 // Failed HTLC from node 1 -> 0
247 expect_pending_htlcs_forwardable!(nodes[1]);
248 let htlc_fail_updates_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
249 assert_eq!(htlc_fail_updates_1_0.update_fail_htlcs.len(), 1);
250 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates_1_0.update_fail_htlcs[0]);
251 check_added_monitors!(nodes[1], 1);
252 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates_1_0.commitment_signed, false);
254 expect_payment_failed_conditions!(nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain().expected_htlc_error_data(23, &[][..]));
256 // Pass half of the payment along the second path.
257 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash, Some(payment_secret), events.remove(0), true, None);
259 // Even after MPP_TIMEOUT_TICKS we should not timeout the MPP if we have all the parts
260 for _ in 0..MPP_TIMEOUT_TICKS {
261 nodes[3].node.timer_tick_occurred();
264 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
269 fn mpp_receive_timeout() {
270 do_mpp_receive_timeout(true);
271 do_mpp_receive_timeout(false);
275 fn retry_expired_payment() {
276 let chanmon_cfgs = create_chanmon_cfgs(3);
277 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
278 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
279 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
281 let _chan_0 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
282 let _chan_1 = create_announced_chan_between_nodes(&nodes, 2, 1, InitFeatures::known(), InitFeatures::known());
283 // Rebalance to find a route
284 send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
286 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100_000);
288 // Rebalance so that the first hop fails.
289 send_payment(&nodes[1], &vec!(&nodes[2])[..], 2_000_000);
291 // Make sure the payment fails on the first hop.
292 let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
293 check_added_monitors!(nodes[0], 1);
294 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
295 assert_eq!(events.len(), 1);
296 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
297 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
298 check_added_monitors!(nodes[1], 0);
299 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
300 expect_pending_htlcs_forwardable!(nodes[1]);
301 expect_pending_htlcs_forwardable!(&nodes[1]);
302 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
303 assert!(htlc_updates.update_add_htlcs.is_empty());
304 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
305 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
306 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
307 check_added_monitors!(nodes[1], 1);
308 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
309 commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false);
310 expect_payment_failed!(nodes[0], payment_hash, false);
312 // Mine blocks so the payment will have expired.
313 connect_blocks(&nodes[0], 3);
315 // Retry the payment and make sure it errors as expected.
316 if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, payment_id) {
317 assert!(err.contains("not found"));
319 panic!("Unexpected error");
324 fn no_pending_leak_on_initial_send_failure() {
325 // In an earlier version of our payment tracking, we'd have a retry entry even when the initial
326 // HTLC for payment failed to send due to local channel errors (e.g. peer disconnected). In this
327 // case, the user wouldn't have a PaymentId to retry the payment with, but we'd think we have a
328 // pending payment forever and never time it out.
329 // Here we test exactly that - retrying a payment when a peer was disconnected on the first
330 // try, and then check that no pending payment is being tracked.
331 let chanmon_cfgs = create_chanmon_cfgs(2);
332 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
333 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
334 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
336 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
338 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
340 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
341 nodes[1].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
343 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)),
344 true, APIError::ChannelUnavailable { ref err },
345 assert_eq!(err, "Peer for first hop currently disconnected/pending monitor update!"));
347 assert!(!nodes[0].node.has_pending_payments());
350 fn do_retry_with_no_persist(confirm_before_reload: bool) {
351 // If we send a pending payment and `send_payment` returns success, we should always either
352 // return a payment failure event or a payment success event, and on failure the payment should
355 // In order to do so when the ChannelManager isn't immediately persisted (which is normal - its
356 // always persisted asynchronously), the ChannelManager has to reload some payment data from
357 // ChannelMonitor(s) in some cases. This tests that reloading.
359 // `confirm_before_reload` confirms the channel-closing commitment transaction on-chain prior
360 // to reloading the ChannelManager, increasing test coverage in ChannelMonitor HTLC tracking
361 // which has separate codepaths for "commitment transaction already confirmed" and not.
362 let chanmon_cfgs = create_chanmon_cfgs(3);
363 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
364 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
365 let persister: test_utils::TestPersister;
366 let new_chain_monitor: test_utils::TestChainMonitor;
367 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
368 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
370 let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
371 let (_, _, chan_id_2, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
373 // Serialize the ChannelManager prior to sending payments
374 let nodes_0_serialized = nodes[0].node.encode();
376 // Send two payments - one which will get to nodes[2] and will be claimed, one which we'll time
378 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 1_000_000);
379 let (payment_preimage_1, _, _, payment_id_1) = send_along_route(&nodes[0], route.clone(), &[&nodes[1], &nodes[2]], 1_000_000);
380 let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
381 check_added_monitors!(nodes[0], 1);
383 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
384 assert_eq!(events.len(), 1);
385 let payment_event = SendEvent::from_event(events.pop().unwrap());
386 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
388 // We relay the payment to nodes[1] while its disconnected from nodes[2], causing the payment
389 // to be returned immediately to nodes[0], without having nodes[2] fail the inbound payment
390 // which would prevent retry.
391 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
392 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
394 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
395 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
396 // nodes[1] now immediately fails the HTLC as the next-hop channel is disconnected
397 let _ = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
399 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
401 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan_id)[0].clone();
402 if confirm_before_reload {
403 mine_transaction(&nodes[0], &as_commitment_tx);
404 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
407 // The ChannelMonitor should always be the latest version, as we're required to persist it
408 // during the `commitment_signed_dance!()`.
409 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
410 get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
412 persister = test_utils::TestPersister::new();
413 let keys_manager = &chanmon_cfgs[0].keys_manager;
414 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
415 nodes[0].chain_monitor = &new_chain_monitor;
416 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
417 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
418 &mut chan_0_monitor_read, keys_manager).unwrap();
419 assert!(chan_0_monitor_read.is_empty());
421 let mut nodes_0_read = &nodes_0_serialized[..];
422 let (_, nodes_0_deserialized_tmp) = {
423 let mut channel_monitors = HashMap::new();
424 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
425 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
426 default_config: test_default_channel_config(),
428 fee_estimator: node_cfgs[0].fee_estimator,
429 chain_monitor: nodes[0].chain_monitor,
430 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
431 logger: nodes[0].logger,
435 nodes_0_deserialized = nodes_0_deserialized_tmp;
436 assert!(nodes_0_read.is_empty());
438 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
439 nodes[0].node = &nodes_0_deserialized;
440 check_added_monitors!(nodes[0], 1);
442 // On reload, the ChannelManager should realize it is stale compared to the ChannelMonitor and
443 // force-close the channel.
444 check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager);
445 assert!(nodes[0].node.list_channels().is_empty());
446 assert!(nodes[0].node.has_pending_payments());
447 let as_broadcasted_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
448 assert_eq!(as_broadcasted_txn.len(), 1);
449 assert_eq!(as_broadcasted_txn[0], as_commitment_tx);
451 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
452 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
453 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
455 // Now nodes[1] should send a channel reestablish, which nodes[0] will respond to with an
456 // error, as the channel has hit the chain.
457 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
458 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
459 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
460 let as_err = nodes[0].node.get_and_clear_pending_msg_events();
461 assert_eq!(as_err.len(), 1);
463 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
464 assert_eq!(node_id, nodes[1].node.get_our_node_id());
465 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), msg);
466 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Failed to find corresponding channel".to_string() });
467 check_added_monitors!(nodes[1], 1);
468 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
470 _ => panic!("Unexpected event"),
472 check_closed_broadcast!(nodes[1], false);
474 // Now claim the first payment, which should allow nodes[1] to claim the payment on-chain when
475 // we close in a moment.
476 nodes[2].node.claim_funds(payment_preimage_1);
477 check_added_monitors!(nodes[2], 1);
478 let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
479 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
480 check_added_monitors!(nodes[1], 1);
481 commitment_signed_dance!(nodes[1], nodes[2], htlc_fulfill_updates.commitment_signed, false);
483 if confirm_before_reload {
484 let best_block = nodes[0].blocks.lock().unwrap().last().unwrap().clone();
485 nodes[0].node.best_block_updated(&best_block.0, best_block.1);
488 // Create a new channel on which to retry the payment before we fail the payment via the
489 // HTLC-Timeout transaction. This avoids ChannelManager timing out the payment due to us
490 // connecting several blocks while creating the channel (implying time has passed).
491 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
492 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
494 mine_transaction(&nodes[1], &as_commitment_tx);
495 let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
496 assert_eq!(bs_htlc_claim_txn.len(), 1);
497 check_spends!(bs_htlc_claim_txn[0], as_commitment_tx);
498 expect_payment_forwarded!(nodes[1], nodes[0], None, false);
500 if !confirm_before_reload {
501 mine_transaction(&nodes[0], &as_commitment_tx);
503 mine_transaction(&nodes[0], &bs_htlc_claim_txn[0]);
504 expect_payment_sent!(nodes[0], payment_preimage_1);
505 connect_blocks(&nodes[0], TEST_FINAL_CLTV*4 + 20);
506 let as_htlc_timeout_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
507 check_spends!(as_htlc_timeout_txn[2], funding_tx);
508 check_spends!(as_htlc_timeout_txn[0], as_commitment_tx);
509 check_spends!(as_htlc_timeout_txn[1], as_commitment_tx);
510 assert_eq!(as_htlc_timeout_txn.len(), 3);
511 if as_htlc_timeout_txn[0].input[0].previous_output == bs_htlc_claim_txn[0].input[0].previous_output {
512 confirm_transaction(&nodes[0], &as_htlc_timeout_txn[1]);
514 confirm_transaction(&nodes[0], &as_htlc_timeout_txn[0]);
516 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
517 expect_payment_failed_conditions!(nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
519 // Finally, retry the payment (which was reloaded from the ChannelMonitor when nodes[0] was
520 // reloaded) via a route over the new channel, which work without issue and eventually be
521 // received and claimed at the recipient just like any other payment.
522 let (mut new_route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], 1_000_000);
524 // Update the fee on the middle hop to ensure PaymentSent events have the correct (retried) fee
525 // and not the original fee. We also update node[1]'s relevant config as
526 // do_claim_payment_along_route expects us to never overpay.
527 nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_id_2).unwrap().config.forwarding_fee_base_msat += 100_000;
528 new_route.paths[0][0].fee_msat += 100_000;
530 assert!(nodes[0].node.retry_payment(&new_route, payment_id_1).is_err()); // Shouldn't be allowed to retry a fulfilled payment
531 nodes[0].node.retry_payment(&new_route, payment_id).unwrap();
532 check_added_monitors!(nodes[0], 1);
533 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
534 assert_eq!(events.len(), 1);
535 pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
536 do_claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
537 expect_payment_sent!(nodes[0], payment_preimage, Some(new_route.paths[0][0].fee_msat));
541 fn retry_with_no_persist() {
542 do_retry_with_no_persist(true);
543 do_retry_with_no_persist(false);
546 fn do_test_dup_htlc_onchain_fails_on_reload(persist_manager_post_event: bool, confirm_commitment_tx: bool, payment_timeout: bool) {
547 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
548 // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
549 // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
550 // the ChannelMonitor tells it to.
552 // If, due to an on-chain event, an HTLC is failed/claimed, we should avoid providing the
553 // ChannelManager the HTLC event until after the monitor is re-persisted. This should prevent a
554 // duplicate HTLC fail/claim (e.g. via a PaymentPathFailed event).
555 let chanmon_cfgs = create_chanmon_cfgs(2);
556 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
557 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
558 let persister: test_utils::TestPersister;
559 let new_chain_monitor: test_utils::TestChainMonitor;
560 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
561 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
563 let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
565 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
567 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
568 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
569 check_closed_broadcast!(nodes[0], true);
570 check_added_monitors!(nodes[0], 1);
571 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
573 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
574 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
576 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
577 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
578 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
579 assert_eq!(node_txn.len(), 3);
580 assert_eq!(node_txn[0], node_txn[1]);
581 check_spends!(node_txn[1], funding_tx);
582 check_spends!(node_txn[2], node_txn[1]);
583 let timeout_txn = vec![node_txn[2].clone()];
585 assert!(nodes[1].node.claim_funds(payment_preimage));
586 check_added_monitors!(nodes[1], 1);
588 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
589 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone()]});
590 check_closed_broadcast!(nodes[1], true);
591 check_added_monitors!(nodes[1], 1);
592 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
593 let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
594 assert_eq!(claim_txn.len(), 3);
595 check_spends!(claim_txn[0], node_txn[1]);
596 check_spends!(claim_txn[1], funding_tx);
597 check_spends!(claim_txn[2], claim_txn[1]);
599 header.prev_blockhash = nodes[0].best_block_hash();
600 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone()]});
602 if confirm_commitment_tx {
603 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
606 header.prev_blockhash = nodes[0].best_block_hash();
607 let claim_block = Block { header, txdata: if payment_timeout { timeout_txn } else { vec![claim_txn[0].clone()] } };
610 assert!(confirm_commitment_tx); // Otherwise we're spending below our CSV!
611 connect_block(&nodes[0], &claim_block);
612 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 2);
615 // Now connect the HTLC claim transaction with the ChainMonitor-generated ChannelMonitor update
616 // returning TemporaryFailure. This should cause the claim event to never make its way to the
618 chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clear();
619 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
622 connect_blocks(&nodes[0], 1);
624 connect_block(&nodes[0], &claim_block);
627 let funding_txo = OutPoint { txid: funding_tx.txid(), index: 0 };
628 let mon_updates: Vec<_> = chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap()
629 .get_mut(&funding_txo).unwrap().drain().collect();
630 assert_eq!(mon_updates.len(), 1);
631 assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
632 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
634 // If we persist the ChannelManager here, we should get the PaymentSent event after
636 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
637 if !persist_manager_post_event {
638 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
641 // Now persist the ChannelMonitor and inform the ChainMonitor that we're done, generating the
642 // payment sent event.
643 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
644 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
645 get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
646 nodes[0].chain_monitor.chain_monitor.channel_monitor_updated(funding_txo, mon_updates[0]).unwrap();
648 expect_payment_failed!(nodes[0], payment_hash, true);
650 expect_payment_sent!(nodes[0], payment_preimage);
653 // If we persist the ChannelManager after we get the PaymentSent event, we shouldn't get it
655 if persist_manager_post_event {
656 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
659 // Now reload nodes[0]...
660 persister = test_utils::TestPersister::new();
661 let keys_manager = &chanmon_cfgs[0].keys_manager;
662 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
663 nodes[0].chain_monitor = &new_chain_monitor;
664 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
665 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
666 &mut chan_0_monitor_read, keys_manager).unwrap();
667 assert!(chan_0_monitor_read.is_empty());
669 let (_, nodes_0_deserialized_tmp) = {
670 let mut channel_monitors = HashMap::new();
671 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
672 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
673 ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
674 default_config: Default::default(),
676 fee_estimator: node_cfgs[0].fee_estimator,
677 chain_monitor: nodes[0].chain_monitor,
678 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
679 logger: nodes[0].logger,
683 nodes_0_deserialized = nodes_0_deserialized_tmp;
685 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
686 check_added_monitors!(nodes[0], 1);
687 nodes[0].node = &nodes_0_deserialized;
689 if persist_manager_post_event {
690 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
691 } else if payment_timeout {
692 expect_payment_failed!(nodes[0], payment_hash, true);
694 expect_payment_sent!(nodes[0], payment_preimage);
697 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
698 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
699 // payment events should kick in, leaving us with no pending events here.
700 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
701 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
702 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
706 fn test_dup_htlc_onchain_fails_on_reload() {
707 do_test_dup_htlc_onchain_fails_on_reload(true, true, true);
708 do_test_dup_htlc_onchain_fails_on_reload(true, true, false);
709 do_test_dup_htlc_onchain_fails_on_reload(true, false, false);
710 do_test_dup_htlc_onchain_fails_on_reload(false, true, true);
711 do_test_dup_htlc_onchain_fails_on_reload(false, true, false);
712 do_test_dup_htlc_onchain_fails_on_reload(false, false, false);
716 fn test_fulfill_restart_failure() {
717 // When we receive an update_fulfill_htlc message, we immediately consider the HTLC fully
718 // fulfilled. At this point, the peer can reconnect and decide to either fulfill the HTLC
719 // again, or fail it, giving us free money.
721 // Of course probably they won't fail it and give us free money, but because we have code to
722 // handle it, we should test the logic for it anyway. We do that here.
723 let chanmon_cfgs = create_chanmon_cfgs(2);
724 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
725 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
726 let persister: test_utils::TestPersister;
727 let new_chain_monitor: test_utils::TestChainMonitor;
728 let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
729 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
731 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
732 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
734 // The simplest way to get a failure after a fulfill is to reload nodes[1] from a state
735 // pre-fulfill, which we do by serializing it here.
736 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
737 nodes[1].node.write(&mut chan_manager_serialized).unwrap();
738 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
739 get_monitor!(nodes[1], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
741 nodes[1].node.claim_funds(payment_preimage);
742 check_added_monitors!(nodes[1], 1);
743 let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
744 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
745 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
747 // Now reload nodes[1]...
748 persister = test_utils::TestPersister::new();
749 let keys_manager = &chanmon_cfgs[1].keys_manager;
750 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[1].chain_source), nodes[1].tx_broadcaster.clone(), nodes[1].logger, node_cfgs[1].fee_estimator, &persister, keys_manager);
751 nodes[1].chain_monitor = &new_chain_monitor;
752 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
753 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
754 &mut chan_0_monitor_read, keys_manager).unwrap();
755 assert!(chan_0_monitor_read.is_empty());
757 let (_, nodes_1_deserialized_tmp) = {
758 let mut channel_monitors = HashMap::new();
759 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
760 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
761 ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
762 default_config: Default::default(),
764 fee_estimator: node_cfgs[1].fee_estimator,
765 chain_monitor: nodes[1].chain_monitor,
766 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
767 logger: nodes[1].logger,
771 nodes_1_deserialized = nodes_1_deserialized_tmp;
773 assert!(nodes[1].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
774 check_added_monitors!(nodes[1], 1);
775 nodes[1].node = &nodes_1_deserialized;
777 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
778 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
780 nodes[1].node.fail_htlc_backwards(&payment_hash);
781 expect_pending_htlcs_forwardable!(nodes[1]);
782 check_added_monitors!(nodes[1], 1);
783 let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
784 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
785 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, false);
786 // nodes[0] shouldn't generate any events here, while it just got a payment failure completion
787 // it had already considered the payment fulfilled, and now they just got free money.
788 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
792 fn get_ldk_payment_preimage() {
793 // Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
794 let chanmon_cfgs = create_chanmon_cfgs(2);
795 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
796 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
797 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
798 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
800 let amt_msat = 60_000;
801 let expiry_secs = 60 * 60;
802 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs).unwrap();
804 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id())
805 .with_features(InvoiceFeatures::known());
806 let scorer = test_utils::TestScorer::with_penalty(0);
807 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
808 let random_seed_bytes = keys_manager.get_secure_random_bytes();
809 let route = get_route(
810 &nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(),
811 Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
812 amt_msat, TEST_FINAL_CLTV, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
813 let _payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
814 check_added_monitors!(nodes[0], 1);
816 // Make sure to use `get_payment_preimage`
817 let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
818 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
819 assert_eq!(events.len(), 1);
820 pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
821 claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);