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 ln::channelmanager::{BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, PaymentId, PaymentSendFailure};
18 use ln::features::{InitFeatures, InvoiceFeatures};
20 use ln::msgs::ChannelMessageHandler;
21 use routing::router::{PaymentParameters, get_route};
22 use util::events::{ClosureReason, Event, MessageSendEvent, MessageSendEventsProvider};
24 use util::errors::APIError;
25 use util::enforcing_trait_impls::EnforcingSigner;
26 use util::ser::{ReadableArgs, Writeable};
29 use bitcoin::{Block, BlockHeader, BlockHash};
33 use ln::functional_test_utils::*;
36 fn retry_single_path_payment() {
37 let chanmon_cfgs = create_chanmon_cfgs(3);
38 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
39 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
40 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
42 let _chan_0 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
43 let _chan_1 = create_announced_chan_between_nodes(&nodes, 2, 1, InitFeatures::known(), InitFeatures::known());
44 // Rebalance to find a route
45 send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
47 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100_000);
49 // Rebalance so that the first hop fails.
50 send_payment(&nodes[1], &vec!(&nodes[2])[..], 2_000_000);
52 // Make sure the payment fails on the first hop.
53 let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
54 check_added_monitors!(nodes[0], 1);
55 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
56 assert_eq!(events.len(), 1);
57 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
58 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
59 check_added_monitors!(nodes[1], 0);
60 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
61 expect_pending_htlcs_forwardable!(nodes[1]);
62 expect_pending_htlcs_forwardable!(&nodes[1]);
63 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
64 assert!(htlc_updates.update_add_htlcs.is_empty());
65 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
66 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
67 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
68 check_added_monitors!(nodes[1], 1);
69 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
70 commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false);
71 expect_payment_failed_conditions!(nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
73 // Rebalance the channel so the retry succeeds.
74 send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
76 // Mine two blocks (we expire retries after 3, so this will check that we don't expire early)
77 connect_blocks(&nodes[0], 2);
79 // Retry the payment and make sure it succeeds.
80 nodes[0].node.retry_payment(&route, payment_id).unwrap();
81 check_added_monitors!(nodes[0], 1);
82 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
83 assert_eq!(events.len(), 1);
84 pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], 100_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
85 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
90 let chanmon_cfgs = create_chanmon_cfgs(4);
91 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
92 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
93 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
95 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
96 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
97 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
98 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
100 let (mut route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
101 let path = route.paths[0].clone();
102 route.paths.push(path);
103 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
104 route.paths[0][0].short_channel_id = chan_1_id;
105 route.paths[0][1].short_channel_id = chan_3_id;
106 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
107 route.paths[1][0].short_channel_id = chan_2_id;
108 route.paths[1][1].short_channel_id = chan_4_id;
109 send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
110 fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
115 let chanmon_cfgs = create_chanmon_cfgs(4);
116 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
117 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
118 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
120 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
121 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
122 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
123 let chan_4_id = create_announced_chan_between_nodes(&nodes, 3, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
125 send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
127 let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 1_000_000);
128 let path = route.paths[0].clone();
129 route.paths.push(path);
130 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
131 route.paths[0][0].short_channel_id = chan_1_id;
132 route.paths[0][1].short_channel_id = chan_3_id;
133 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
134 route.paths[1][0].short_channel_id = chan_2_id;
135 route.paths[1][1].short_channel_id = chan_4_id;
137 // Initiate the MPP payment.
138 let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
139 check_added_monitors!(nodes[0], 2); // one monitor per path
140 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
141 assert_eq!(events.len(), 2);
143 // Pass half of the payment along the success path.
144 let success_path_msgs = events.remove(0);
145 pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), success_path_msgs, false, None);
147 // Add the HTLC along the first hop.
148 let fail_path_msgs_1 = events.remove(0);
149 let (update_add, commitment_signed) = match fail_path_msgs_1 {
150 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 } } => {
151 assert_eq!(update_add_htlcs.len(), 1);
152 assert!(update_fail_htlcs.is_empty());
153 assert!(update_fulfill_htlcs.is_empty());
154 assert!(update_fail_malformed_htlcs.is_empty());
155 assert!(update_fee.is_none());
156 (update_add_htlcs[0].clone(), commitment_signed.clone())
158 _ => panic!("Unexpected event"),
160 nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
161 commitment_signed_dance!(nodes[2], nodes[0], commitment_signed, false);
163 // Attempt to forward the payment and complete the 2nd path's failure.
164 expect_pending_htlcs_forwardable!(&nodes[2]);
165 expect_pending_htlcs_forwardable!(&nodes[2]);
166 let htlc_updates = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
167 assert!(htlc_updates.update_add_htlcs.is_empty());
168 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
169 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
170 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
171 check_added_monitors!(nodes[2], 1);
172 nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
173 commitment_signed_dance!(nodes[0], nodes[2], htlc_updates.commitment_signed, false);
174 expect_payment_failed_conditions!(nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
176 // Rebalance the channel so the second half of the payment can succeed.
177 send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
179 // Make sure it errors as expected given a too-large amount.
180 if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, payment_id) {
181 assert!(err.contains("over total_payment_amt_msat"));
182 } else { panic!("Unexpected error"); }
184 // Make sure it errors as expected given the wrong payment_id.
185 if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, PaymentId([0; 32])) {
186 assert!(err.contains("not found"));
187 } else { panic!("Unexpected error"); }
189 // Retry the second half of the payment and make sure it succeeds.
190 let mut path = route.clone();
191 path.paths.remove(0);
192 nodes[0].node.retry_payment(&path, payment_id).unwrap();
193 check_added_monitors!(nodes[0], 1);
194 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
195 assert_eq!(events.len(), 1);
196 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
197 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
201 fn retry_expired_payment() {
202 let chanmon_cfgs = create_chanmon_cfgs(3);
203 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
204 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
205 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
207 let _chan_0 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
208 let _chan_1 = create_announced_chan_between_nodes(&nodes, 2, 1, InitFeatures::known(), InitFeatures::known());
209 // Rebalance to find a route
210 send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
212 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100_000);
214 // Rebalance so that the first hop fails.
215 send_payment(&nodes[1], &vec!(&nodes[2])[..], 2_000_000);
217 // Make sure the payment fails on the first hop.
218 let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
219 check_added_monitors!(nodes[0], 1);
220 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
221 assert_eq!(events.len(), 1);
222 let mut payment_event = SendEvent::from_event(events.pop().unwrap());
223 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
224 check_added_monitors!(nodes[1], 0);
225 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
226 expect_pending_htlcs_forwardable!(nodes[1]);
227 expect_pending_htlcs_forwardable!(&nodes[1]);
228 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
229 assert!(htlc_updates.update_add_htlcs.is_empty());
230 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
231 assert!(htlc_updates.update_fulfill_htlcs.is_empty());
232 assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
233 check_added_monitors!(nodes[1], 1);
234 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
235 commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false);
236 expect_payment_failed!(nodes[0], payment_hash, false);
238 // Mine blocks so the payment will have expired.
239 connect_blocks(&nodes[0], 3);
241 // Retry the payment and make sure it errors as expected.
242 if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, payment_id) {
243 assert!(err.contains("not found"));
245 panic!("Unexpected error");
250 fn no_pending_leak_on_initial_send_failure() {
251 // In an earlier version of our payment tracking, we'd have a retry entry even when the initial
252 // HTLC for payment failed to send due to local channel errors (e.g. peer disconnected). In this
253 // case, the user wouldn't have a PaymentId to retry the payment with, but we'd think we have a
254 // pending payment forever and never time it out.
255 // Here we test exactly that - retrying a payment when a peer was disconnected on the first
256 // try, and then check that no pending payment is being tracked.
257 let chanmon_cfgs = create_chanmon_cfgs(2);
258 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
259 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
260 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
262 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
264 let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
266 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
267 nodes[1].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
269 unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)),
270 true, APIError::ChannelUnavailable { ref err },
271 assert_eq!(err, "Peer for first hop currently disconnected/pending monitor update!"));
273 assert!(!nodes[0].node.has_pending_payments());
276 fn do_retry_with_no_persist(confirm_before_reload: bool) {
277 // If we send a pending payment and `send_payment` returns success, we should always either
278 // return a payment failure event or a payment success event, and on failure the payment should
281 // In order to do so when the ChannelManager isn't immediately persisted (which is normal - its
282 // always persisted asynchronously), the ChannelManager has to reload some payment data from
283 // ChannelMonitor(s) in some cases. This tests that reloading.
285 // `confirm_before_reload` confirms the channel-closing commitment transaction on-chain prior
286 // to reloading the ChannelManager, increasing test coverage in ChannelMonitor HTLC tracking
287 // which has separate codepaths for "commitment transaction already confirmed" and not.
288 let chanmon_cfgs = create_chanmon_cfgs(3);
289 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
290 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
291 let persister: test_utils::TestPersister;
292 let new_chain_monitor: test_utils::TestChainMonitor;
293 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
294 let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
296 let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
297 let (_, _, chan_id_2, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
299 // Serialize the ChannelManager prior to sending payments
300 let nodes_0_serialized = nodes[0].node.encode();
302 // Send two payments - one which will get to nodes[2] and will be claimed, one which we'll time
304 let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 1_000_000);
305 let (payment_preimage_1, _, _, payment_id_1) = send_along_route(&nodes[0], route.clone(), &[&nodes[1], &nodes[2]], 1_000_000);
306 let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
307 check_added_monitors!(nodes[0], 1);
309 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
310 assert_eq!(events.len(), 1);
311 let payment_event = SendEvent::from_event(events.pop().unwrap());
312 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
314 // We relay the payment to nodes[1] while its disconnected from nodes[2], causing the payment
315 // to be returned immediately to nodes[0], without having nodes[2] fail the inbound payment
316 // which would prevent retry.
317 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
318 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
320 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
321 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
322 // nodes[1] now immediately fails the HTLC as the next-hop channel is disconnected
323 let _ = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
325 reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
327 let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan_id)[0].clone();
328 if confirm_before_reload {
329 mine_transaction(&nodes[0], &as_commitment_tx);
330 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
333 // The ChannelMonitor should always be the latest version, as we're required to persist it
334 // during the `commitment_signed_dance!()`.
335 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
336 get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
338 persister = test_utils::TestPersister::new();
339 let keys_manager = &chanmon_cfgs[0].keys_manager;
340 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);
341 nodes[0].chain_monitor = &new_chain_monitor;
342 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
343 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
344 &mut chan_0_monitor_read, keys_manager).unwrap();
345 assert!(chan_0_monitor_read.is_empty());
347 let mut nodes_0_read = &nodes_0_serialized[..];
348 let (_, nodes_0_deserialized_tmp) = {
349 let mut channel_monitors = HashMap::new();
350 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
351 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
352 default_config: test_default_channel_config(),
354 fee_estimator: node_cfgs[0].fee_estimator,
355 chain_monitor: nodes[0].chain_monitor,
356 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
357 logger: nodes[0].logger,
361 nodes_0_deserialized = nodes_0_deserialized_tmp;
362 assert!(nodes_0_read.is_empty());
364 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
365 nodes[0].node = &nodes_0_deserialized;
366 check_added_monitors!(nodes[0], 1);
368 // On reload, the ChannelManager should realize it is stale compared to the ChannelMonitor and
369 // force-close the channel.
370 check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager);
371 assert!(nodes[0].node.list_channels().is_empty());
372 assert!(nodes[0].node.has_pending_payments());
373 let as_broadcasted_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
374 assert_eq!(as_broadcasted_txn.len(), 1);
375 assert_eq!(as_broadcasted_txn[0], as_commitment_tx);
377 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
378 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known()});
379 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
381 // Now nodes[1] should send a channel reestablish, which nodes[0] will respond to with an
382 // error, as the channel has hit the chain.
383 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known()});
384 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
385 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
386 let as_err = nodes[0].node.get_and_clear_pending_msg_events();
387 assert_eq!(as_err.len(), 1);
389 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
390 assert_eq!(node_id, nodes[1].node.get_our_node_id());
391 nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), msg);
392 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Failed to find corresponding channel".to_string() });
393 check_added_monitors!(nodes[1], 1);
394 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
396 _ => panic!("Unexpected event"),
398 check_closed_broadcast!(nodes[1], false);
400 // Now claim the first payment, which should allow nodes[1] to claim the payment on-chain when
401 // we close in a moment.
402 nodes[2].node.claim_funds(payment_preimage_1);
403 check_added_monitors!(nodes[2], 1);
404 let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
405 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
406 check_added_monitors!(nodes[1], 1);
407 commitment_signed_dance!(nodes[1], nodes[2], htlc_fulfill_updates.commitment_signed, false);
409 if confirm_before_reload {
410 let best_block = nodes[0].blocks.lock().unwrap().last().unwrap().clone();
411 nodes[0].node.best_block_updated(&best_block.0, best_block.1);
414 // Create a new channel on which to retry the payment before we fail the payment via the
415 // HTLC-Timeout transaction. This avoids ChannelManager timing out the payment due to us
416 // connecting several blocks while creating the channel (implying time has passed).
417 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
418 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
420 mine_transaction(&nodes[1], &as_commitment_tx);
421 let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
422 assert_eq!(bs_htlc_claim_txn.len(), 1);
423 check_spends!(bs_htlc_claim_txn[0], as_commitment_tx);
424 expect_payment_forwarded!(nodes[1], None, false);
426 mine_transaction(&nodes[0], &as_commitment_tx);
427 mine_transaction(&nodes[0], &bs_htlc_claim_txn[0]);
428 expect_payment_sent!(nodes[0], payment_preimage_1);
429 connect_blocks(&nodes[0], TEST_FINAL_CLTV*4 + 20);
430 let as_htlc_timeout_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
431 check_spends!(as_htlc_timeout_txn[2], funding_tx);
432 check_spends!(as_htlc_timeout_txn[0], as_commitment_tx);
433 check_spends!(as_htlc_timeout_txn[1], as_commitment_tx);
434 assert_eq!(as_htlc_timeout_txn.len(), 3);
435 if as_htlc_timeout_txn[0].input[0].previous_output == bs_htlc_claim_txn[0].input[0].previous_output {
436 confirm_transaction(&nodes[0], &as_htlc_timeout_txn[1]);
438 confirm_transaction(&nodes[0], &as_htlc_timeout_txn[0]);
440 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
441 expect_payment_failed_conditions!(nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
443 // Finally, retry the payment (which was reloaded from the ChannelMonitor when nodes[0] was
444 // reloaded) via a route over the new channel, which work without issue and eventually be
445 // received and claimed at the recipient just like any other payment.
446 let (mut new_route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], 1_000_000);
448 // Update the fee on the middle hop to ensure PaymentSent events have the correct (retried) fee
449 // and not the original fee. We also update node[1]'s relevant config as
450 // do_claim_payment_along_route expects us to never overpay.
451 nodes[1].node.channel_state.lock().unwrap().by_id.get_mut(&chan_id_2).unwrap().config.forwarding_fee_base_msat += 100_000;
452 new_route.paths[0][0].fee_msat += 100_000;
454 assert!(nodes[0].node.retry_payment(&new_route, payment_id_1).is_err()); // Shouldn't be allowed to retry a fulfilled payment
455 nodes[0].node.retry_payment(&new_route, payment_id).unwrap();
456 check_added_monitors!(nodes[0], 1);
457 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
458 assert_eq!(events.len(), 1);
459 pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
460 do_claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
461 expect_payment_sent!(nodes[0], payment_preimage, Some(new_route.paths[0][0].fee_msat));
465 fn retry_with_no_persist() {
466 do_retry_with_no_persist(true);
467 do_retry_with_no_persist(false);
470 fn do_test_dup_htlc_onchain_fails_on_reload(persist_manager_post_event: bool, confirm_commitment_tx: bool, payment_timeout: bool) {
471 // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
472 // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
473 // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
474 // the ChannelMonitor tells it to.
476 // If, due to an on-chain event, an HTLC is failed/claimed, we should avoid providing the
477 // ChannelManager the HTLC event until after the monitor is re-persisted. This should prevent a
478 // duplicate HTLC fail/claim (e.g. via a PaymentPathFailed event).
479 let chanmon_cfgs = create_chanmon_cfgs(2);
480 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
481 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
482 let persister: test_utils::TestPersister;
483 let new_chain_monitor: test_utils::TestChainMonitor;
484 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
485 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
487 let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
489 // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
491 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
492 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
493 check_closed_broadcast!(nodes[0], true);
494 check_added_monitors!(nodes[0], 1);
495 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
497 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
498 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
500 // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
501 connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
502 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
503 assert_eq!(node_txn.len(), 3);
504 assert_eq!(node_txn[0], node_txn[1]);
505 check_spends!(node_txn[1], funding_tx);
506 check_spends!(node_txn[2], node_txn[1]);
507 let timeout_txn = vec![node_txn[2].clone()];
509 assert!(nodes[1].node.claim_funds(payment_preimage));
510 check_added_monitors!(nodes[1], 1);
512 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
513 connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone()]});
514 check_closed_broadcast!(nodes[1], true);
515 check_added_monitors!(nodes[1], 1);
516 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
517 let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
519 header.prev_blockhash = nodes[0].best_block_hash();
520 connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone()]});
522 if confirm_commitment_tx {
523 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
526 header.prev_blockhash = nodes[0].best_block_hash();
527 let claim_block = Block { header, txdata: if payment_timeout { timeout_txn } else { claim_txn } };
530 assert!(confirm_commitment_tx); // Otherwise we're spending below our CSV!
531 connect_block(&nodes[0], &claim_block);
532 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 2);
535 // Now connect the HTLC claim transaction with the ChainMonitor-generated ChannelMonitor update
536 // returning TemporaryFailure. This should cause the claim event to never make its way to the
538 chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clear();
539 chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
542 connect_blocks(&nodes[0], 1);
544 connect_block(&nodes[0], &claim_block);
547 let funding_txo = OutPoint { txid: funding_tx.txid(), index: 0 };
548 let mon_updates: Vec<_> = chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap()
549 .get_mut(&funding_txo).unwrap().drain().collect();
550 assert_eq!(mon_updates.len(), 1);
551 assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
552 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
554 // If we persist the ChannelManager here, we should get the PaymentSent event after
556 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
557 if !persist_manager_post_event {
558 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
561 // Now persist the ChannelMonitor and inform the ChainMonitor that we're done, generating the
562 // payment sent event.
563 chanmon_cfgs[0].persister.set_update_ret(Ok(()));
564 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
565 get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
566 nodes[0].chain_monitor.chain_monitor.channel_monitor_updated(funding_txo, mon_updates[0]).unwrap();
568 expect_payment_failed!(nodes[0], payment_hash, true);
570 expect_payment_sent!(nodes[0], payment_preimage);
573 // If we persist the ChannelManager after we get the PaymentSent event, we shouldn't get it
575 if persist_manager_post_event {
576 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
579 // Now reload nodes[0]...
580 persister = test_utils::TestPersister::new();
581 let keys_manager = &chanmon_cfgs[0].keys_manager;
582 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);
583 nodes[0].chain_monitor = &new_chain_monitor;
584 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
585 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
586 &mut chan_0_monitor_read, keys_manager).unwrap();
587 assert!(chan_0_monitor_read.is_empty());
589 let (_, nodes_0_deserialized_tmp) = {
590 let mut channel_monitors = HashMap::new();
591 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
592 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
593 ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
594 default_config: Default::default(),
596 fee_estimator: node_cfgs[0].fee_estimator,
597 chain_monitor: nodes[0].chain_monitor,
598 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
599 logger: nodes[0].logger,
603 nodes_0_deserialized = nodes_0_deserialized_tmp;
605 assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
606 check_added_monitors!(nodes[0], 1);
607 nodes[0].node = &nodes_0_deserialized;
609 if persist_manager_post_event {
610 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
611 } else if payment_timeout {
612 expect_payment_failed!(nodes[0], payment_hash, true);
614 expect_payment_sent!(nodes[0], payment_preimage);
617 // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
618 // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
619 // payment events should kick in, leaving us with no pending events here.
620 let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
621 nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
622 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
626 fn test_dup_htlc_onchain_fails_on_reload() {
627 do_test_dup_htlc_onchain_fails_on_reload(true, true, true);
628 do_test_dup_htlc_onchain_fails_on_reload(true, true, false);
629 do_test_dup_htlc_onchain_fails_on_reload(true, false, false);
630 do_test_dup_htlc_onchain_fails_on_reload(false, true, true);
631 do_test_dup_htlc_onchain_fails_on_reload(false, true, false);
632 do_test_dup_htlc_onchain_fails_on_reload(false, false, false);
636 fn test_fulfill_restart_failure() {
637 // When we receive an update_fulfill_htlc message, we immediately consider the HTLC fully
638 // fulfilled. At this point, the peer can reconnect and decide to either fulfill the HTLC
639 // again, or fail it, giving us free money.
641 // Of course probably they won't fail it and give us free money, but because we have code to
642 // handle it, we should test the logic for it anyway. We do that here.
643 let chanmon_cfgs = create_chanmon_cfgs(2);
644 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
645 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
646 let persister: test_utils::TestPersister;
647 let new_chain_monitor: test_utils::TestChainMonitor;
648 let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
649 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
651 let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
652 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
654 // The simplest way to get a failure after a fulfill is to reload nodes[1] from a state
655 // pre-fulfill, which we do by serializing it here.
656 let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
657 nodes[1].node.write(&mut chan_manager_serialized).unwrap();
658 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
659 get_monitor!(nodes[1], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
661 nodes[1].node.claim_funds(payment_preimage);
662 check_added_monitors!(nodes[1], 1);
663 let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
664 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
665 expect_payment_sent_without_paths!(nodes[0], payment_preimage);
667 // Now reload nodes[1]...
668 persister = test_utils::TestPersister::new();
669 let keys_manager = &chanmon_cfgs[1].keys_manager;
670 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);
671 nodes[1].chain_monitor = &new_chain_monitor;
672 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
673 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
674 &mut chan_0_monitor_read, keys_manager).unwrap();
675 assert!(chan_0_monitor_read.is_empty());
677 let (_, nodes_1_deserialized_tmp) = {
678 let mut channel_monitors = HashMap::new();
679 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
680 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
681 ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
682 default_config: Default::default(),
684 fee_estimator: node_cfgs[1].fee_estimator,
685 chain_monitor: nodes[1].chain_monitor,
686 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
687 logger: nodes[1].logger,
691 nodes_1_deserialized = nodes_1_deserialized_tmp;
693 assert!(nodes[1].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
694 check_added_monitors!(nodes[1], 1);
695 nodes[1].node = &nodes_1_deserialized;
697 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
698 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
700 nodes[1].node.fail_htlc_backwards(&payment_hash);
701 expect_pending_htlcs_forwardable!(nodes[1]);
702 check_added_monitors!(nodes[1], 1);
703 let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
704 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
705 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, false);
706 // nodes[0] shouldn't generate any events here, while it just got a payment failure completion
707 // it had already considered the payment fulfilled, and now they just got free money.
708 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
712 fn get_ldk_payment_preimage() {
713 // Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
714 let chanmon_cfgs = create_chanmon_cfgs(2);
715 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
716 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
717 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
718 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
720 let amt_msat = 60_000;
721 let expiry_secs = 60 * 60;
722 let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs).unwrap();
724 let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id())
725 .with_features(InvoiceFeatures::known());
726 let scorer = test_utils::TestScorer::with_fixed_penalty(0);
727 let route = get_route(
728 &nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph,
729 Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
730 amt_msat, TEST_FINAL_CLTV, nodes[0].logger, &scorer).unwrap();
731 let _payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
732 check_added_monitors!(nodes[0], 1);
734 // Make sure to use `get_payment_preimage`
735 let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
736 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
737 assert_eq!(events.len(), 1);
738 pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
739 claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);