]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/payment_tests.rs
785edecebbe3d0b7eddb0f0f6de2011f895fdde1
[rust-lightning] / lightning / src / ln / payment_tests.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
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
8 // licenses.
9
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.
13
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::channel::EXPIRE_PREV_CONFIG_TICKS;
19 use ln::channelmanager::{BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, MPP_TIMEOUT_TICKS, PaymentId, PaymentSendFailure};
20 use ln::features::{InitFeatures, InvoiceFeatures};
21 use ln::msgs;
22 use ln::msgs::ChannelMessageHandler;
23 use routing::router::{PaymentParameters, get_route};
24 use util::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider};
25 use util::test_utils;
26 use util::errors::APIError;
27 use util::enforcing_trait_impls::EnforcingSigner;
28 use util::ser::{ReadableArgs, Writeable};
29 use io;
30
31 use bitcoin::{Block, BlockHeader, BlockHash};
32 use bitcoin::network::constants::Network;
33
34 use prelude::*;
35
36 use ln::functional_test_utils::*;
37
38 #[test]
39 fn retry_single_path_payment() {
40         let chanmon_cfgs = create_chanmon_cfgs(3);
41         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
42         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
43         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
44
45         let _chan_0 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
46         let chan_1 = create_announced_chan_between_nodes(&nodes, 2, 1, InitFeatures::known(), InitFeatures::known());
47         // Rebalance to find a route
48         send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
49
50         let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100_000);
51
52         // Rebalance so that the first hop fails.
53         send_payment(&nodes[1], &vec!(&nodes[2])[..], 2_000_000);
54
55         // Make sure the payment fails on the first hop.
56         let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
57         check_added_monitors!(nodes[0], 1);
58         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
59         assert_eq!(events.len(), 1);
60         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
61         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
62         check_added_monitors!(nodes[1], 0);
63         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
64         expect_pending_htlcs_forwardable!(nodes[1]);
65         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_1.2 }]);
66         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
67         assert!(htlc_updates.update_add_htlcs.is_empty());
68         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
69         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
70         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
71         check_added_monitors!(nodes[1], 1);
72         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
73         commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false);
74         expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
75
76         // Rebalance the channel so the retry succeeds.
77         send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
78
79         // Mine two blocks (we expire retries after 3, so this will check that we don't expire early)
80         connect_blocks(&nodes[0], 2);
81
82         // Retry the payment and make sure it succeeds.
83         nodes[0].node.retry_payment(&route, payment_id).unwrap();
84         check_added_monitors!(nodes[0], 1);
85         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
86         assert_eq!(events.len(), 1);
87         pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], 100_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
88         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
89 }
90
91 #[test]
92 fn mpp_failure() {
93         let chanmon_cfgs = create_chanmon_cfgs(4);
94         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
95         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
96         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
97
98         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
99         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
100         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
101         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
102
103         let (mut route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
104         let path = route.paths[0].clone();
105         route.paths.push(path);
106         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
107         route.paths[0][0].short_channel_id = chan_1_id;
108         route.paths[0][1].short_channel_id = chan_3_id;
109         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
110         route.paths[1][0].short_channel_id = chan_2_id;
111         route.paths[1][1].short_channel_id = chan_4_id;
112         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, payment_secret);
113         fail_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_hash);
114 }
115
116 #[test]
117 fn mpp_retry() {
118         let chanmon_cfgs = create_chanmon_cfgs(4);
119         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
120         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
121         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
122
123         let (chan_1_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
124         let (chan_2_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
125         let (chan_3_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
126         let (chan_4_update, _, chan_4_id, _) = create_announced_chan_between_nodes(&nodes, 3, 2, InitFeatures::known(), InitFeatures::known());
127         // Rebalance
128         send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
129
130         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 1_000_000);
131         let path = route.paths[0].clone();
132         route.paths.push(path);
133         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
134         route.paths[0][0].short_channel_id = chan_1_update.contents.short_channel_id;
135         route.paths[0][1].short_channel_id = chan_3_update.contents.short_channel_id;
136         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
137         route.paths[1][0].short_channel_id = chan_2_update.contents.short_channel_id;
138         route.paths[1][1].short_channel_id = chan_4_update.contents.short_channel_id;
139
140         // Initiate the MPP payment.
141         let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
142         check_added_monitors!(nodes[0], 2); // one monitor per path
143         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
144         assert_eq!(events.len(), 2);
145
146         // Pass half of the payment along the success path.
147         let success_path_msgs = events.remove(0);
148         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), success_path_msgs, false, None);
149
150         // Add the HTLC along the first hop.
151         let fail_path_msgs_1 = events.remove(0);
152         let (update_add, commitment_signed) = match fail_path_msgs_1 {
153                 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 } } => {
154                         assert_eq!(update_add_htlcs.len(), 1);
155                         assert!(update_fail_htlcs.is_empty());
156                         assert!(update_fulfill_htlcs.is_empty());
157                         assert!(update_fail_malformed_htlcs.is_empty());
158                         assert!(update_fee.is_none());
159                         (update_add_htlcs[0].clone(), commitment_signed.clone())
160                 },
161                 _ => panic!("Unexpected event"),
162         };
163         nodes[2].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add);
164         commitment_signed_dance!(nodes[2], nodes[0], commitment_signed, false);
165
166         // Attempt to forward the payment and complete the 2nd path's failure.
167         expect_pending_htlcs_forwardable!(&nodes[2]);
168         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 }]);
169         let htlc_updates = get_htlc_update_msgs!(nodes[2], nodes[0].node.get_our_node_id());
170         assert!(htlc_updates.update_add_htlcs.is_empty());
171         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
172         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
173         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
174         check_added_monitors!(nodes[2], 1);
175         nodes[0].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
176         commitment_signed_dance!(nodes[0], nodes[2], htlc_updates.commitment_signed, false);
177         expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
178
179         // Rebalance the channel so the second half of the payment can succeed.
180         send_payment(&nodes[3], &vec!(&nodes[2])[..], 1_500_000);
181
182         // Make sure it errors as expected given a too-large amount.
183         if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, payment_id) {
184                 assert!(err.contains("over total_payment_amt_msat"));
185         } else { panic!("Unexpected error"); }
186
187         // Make sure it errors as expected given the wrong payment_id.
188         if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, PaymentId([0; 32])) {
189                 assert!(err.contains("not found"));
190         } else { panic!("Unexpected error"); }
191
192         // Retry the second half of the payment and make sure it succeeds.
193         let mut path = route.clone();
194         path.paths.remove(0);
195         nodes[0].node.retry_payment(&path, payment_id).unwrap();
196         check_added_monitors!(nodes[0], 1);
197         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
198         assert_eq!(events.len(), 1);
199         pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 2_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
200         claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
201 }
202
203 fn do_mpp_receive_timeout(send_partial_mpp: bool) {
204         let chanmon_cfgs = create_chanmon_cfgs(4);
205         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
206         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
207         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
208
209         let (chan_1_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
210         let (chan_2_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
211         let (chan_3_update, _, chan_3_id, _) = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
212         let (chan_4_update, _, _, _) = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
213
214         let (mut route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[3], 100_000);
215         let path = route.paths[0].clone();
216         route.paths.push(path);
217         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
218         route.paths[0][0].short_channel_id = chan_1_update.contents.short_channel_id;
219         route.paths[0][1].short_channel_id = chan_3_update.contents.short_channel_id;
220         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
221         route.paths[1][0].short_channel_id = chan_2_update.contents.short_channel_id;
222         route.paths[1][1].short_channel_id = chan_4_update.contents.short_channel_id;
223
224         // Initiate the MPP payment.
225         let _ = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
226         check_added_monitors!(nodes[0], 2); // one monitor per path
227         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
228         assert_eq!(events.len(), 2);
229
230         // Pass half of the payment along the first path.
231         pass_along_path(&nodes[0], &[&nodes[1], &nodes[3]], 200_000, payment_hash, Some(payment_secret), events.remove(0), false, None);
232
233         if send_partial_mpp {
234                 // Time out the partial MPP
235                 for _ in 0..MPP_TIMEOUT_TICKS {
236                         nodes[3].node.timer_tick_occurred();
237                 }
238
239                 // Failed HTLC from node 3 -> 1
240                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[3], vec![HTLCDestination::FailedPayment { payment_hash }]);
241                 let htlc_fail_updates_3_1 = get_htlc_update_msgs!(nodes[3], nodes[1].node.get_our_node_id());
242                 assert_eq!(htlc_fail_updates_3_1.update_fail_htlcs.len(), 1);
243                 nodes[1].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &htlc_fail_updates_3_1.update_fail_htlcs[0]);
244                 check_added_monitors!(nodes[3], 1);
245                 commitment_signed_dance!(nodes[1], nodes[3], htlc_fail_updates_3_1.commitment_signed, false);
246
247                 // Failed HTLC from node 1 -> 0
248                 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 }]);
249                 let htlc_fail_updates_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
250                 assert_eq!(htlc_fail_updates_1_0.update_fail_htlcs.len(), 1);
251                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates_1_0.update_fail_htlcs[0]);
252                 check_added_monitors!(nodes[1], 1);
253                 commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates_1_0.commitment_signed, false);
254
255                 expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain().expected_htlc_error_data(23, &[][..]));
256         } else {
257                 // Pass half of the payment along the second path.
258                 pass_along_path(&nodes[0], &[&nodes[2], &nodes[3]], 200_000, payment_hash, Some(payment_secret), events.remove(0), true, None);
259
260                 // Even after MPP_TIMEOUT_TICKS we should not timeout the MPP if we have all the parts
261                 for _ in 0..MPP_TIMEOUT_TICKS {
262                         nodes[3].node.timer_tick_occurred();
263                 }
264
265                 claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage);
266         }
267 }
268
269 #[test]
270 fn mpp_receive_timeout() {
271         do_mpp_receive_timeout(true);
272         do_mpp_receive_timeout(false);
273 }
274
275 #[test]
276 fn retry_expired_payment() {
277         let chanmon_cfgs = create_chanmon_cfgs(3);
278         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
279         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
280         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
281
282         let _chan_0 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
283         let chan_1 = create_announced_chan_between_nodes(&nodes, 2, 1, InitFeatures::known(), InitFeatures::known());
284         // Rebalance to find a route
285         send_payment(&nodes[2], &vec!(&nodes[1])[..], 3_000_000);
286
287         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 100_000);
288
289         // Rebalance so that the first hop fails.
290         send_payment(&nodes[1], &vec!(&nodes[2])[..], 2_000_000);
291
292         // Make sure the payment fails on the first hop.
293         let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
294         check_added_monitors!(nodes[0], 1);
295         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
296         assert_eq!(events.len(), 1);
297         let mut payment_event = SendEvent::from_event(events.pop().unwrap());
298         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
299         check_added_monitors!(nodes[1], 0);
300         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
301         expect_pending_htlcs_forwardable!(nodes[1]);
302         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(&nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_1.2 }]);
303         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
304         assert!(htlc_updates.update_add_htlcs.is_empty());
305         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
306         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
307         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
308         check_added_monitors!(nodes[1], 1);
309         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
310         commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false);
311         expect_payment_failed!(nodes[0], payment_hash, false);
312
313         // Mine blocks so the payment will have expired.
314         connect_blocks(&nodes[0], 3);
315
316         // Retry the payment and make sure it errors as expected.
317         if let Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError { err })) = nodes[0].node.retry_payment(&route, payment_id) {
318                 assert!(err.contains("not found"));
319         } else {
320                 panic!("Unexpected error");
321         }
322 }
323
324 #[test]
325 fn no_pending_leak_on_initial_send_failure() {
326         // In an earlier version of our payment tracking, we'd have a retry entry even when the initial
327         // HTLC for payment failed to send due to local channel errors (e.g. peer disconnected). In this
328         // case, the user wouldn't have a PaymentId to retry the payment with, but we'd think we have a
329         // pending payment forever and never time it out.
330         // Here we test exactly that - retrying a payment when a peer was disconnected on the first
331         // try, and then check that no pending payment is being tracked.
332         let chanmon_cfgs = create_chanmon_cfgs(2);
333         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
334         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
335         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
336
337         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
338
339         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 100_000);
340
341         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
342         nodes[1].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
343
344         unwrap_send_err!(nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)),
345                 true, APIError::ChannelUnavailable { ref err },
346                 assert_eq!(err, "Peer for first hop currently disconnected/pending monitor update!"));
347
348         assert!(!nodes[0].node.has_pending_payments());
349 }
350
351 fn do_retry_with_no_persist(confirm_before_reload: bool) {
352         // If we send a pending payment and `send_payment` returns success, we should always either
353         // return a payment failure event or a payment success event, and on failure the payment should
354         // be retryable.
355         //
356         // In order to do so when the ChannelManager isn't immediately persisted (which is normal - its
357         // always persisted asynchronously), the ChannelManager has to reload some payment data from
358         // ChannelMonitor(s) in some cases. This tests that reloading.
359         //
360         // `confirm_before_reload` confirms the channel-closing commitment transaction on-chain prior
361         // to reloading the ChannelManager, increasing test coverage in ChannelMonitor HTLC tracking
362         // which has separate codepaths for "commitment transaction already confirmed" and not.
363         let chanmon_cfgs = create_chanmon_cfgs(3);
364         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
365         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
366         let persister: test_utils::TestPersister;
367         let new_chain_monitor: test_utils::TestChainMonitor;
368         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
369         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
370
371         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
372         let (_, _, chan_id_2, _) = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
373
374         // Serialize the ChannelManager prior to sending payments
375         let nodes_0_serialized = nodes[0].node.encode();
376
377         // Send two payments - one which will get to nodes[2] and will be claimed, one which we'll time
378         // out and retry.
379         let (route, payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 1_000_000);
380         let (payment_preimage_1, payment_hash_1, _, payment_id_1) = send_along_route(&nodes[0], route.clone(), &[&nodes[1], &nodes[2]], 1_000_000);
381         let payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
382         check_added_monitors!(nodes[0], 1);
383
384         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
385         assert_eq!(events.len(), 1);
386         let payment_event = SendEvent::from_event(events.pop().unwrap());
387         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
388
389         // We relay the payment to nodes[1] while its disconnected from nodes[2], causing the payment
390         // to be returned immediately to nodes[0], without having nodes[2] fail the inbound payment
391         // which would prevent retry.
392         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
393         nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
394
395         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
396         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false, true);
397         // nodes[1] now immediately fails the HTLC as the next-hop channel is disconnected
398         let _ = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
399
400         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
401
402         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan_id)[0].clone();
403         if confirm_before_reload {
404                 mine_transaction(&nodes[0], &as_commitment_tx);
405                 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
406         }
407
408         // The ChannelMonitor should always be the latest version, as we're required to persist it
409         // during the `commitment_signed_dance!()`.
410         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
411         get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
412
413         persister = test_utils::TestPersister::new();
414         let keys_manager = &chanmon_cfgs[0].keys_manager;
415         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);
416         nodes[0].chain_monitor = &new_chain_monitor;
417         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
418         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
419                 &mut chan_0_monitor_read, keys_manager).unwrap();
420         assert!(chan_0_monitor_read.is_empty());
421
422         let mut nodes_0_read = &nodes_0_serialized[..];
423         let (_, nodes_0_deserialized_tmp) = {
424                 let mut channel_monitors = HashMap::new();
425                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
426                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
427                         default_config: test_default_channel_config(),
428                         keys_manager,
429                         fee_estimator: node_cfgs[0].fee_estimator,
430                         chain_monitor: nodes[0].chain_monitor,
431                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
432                         logger: nodes[0].logger,
433                         channel_monitors,
434                 }).unwrap()
435         };
436         nodes_0_deserialized = nodes_0_deserialized_tmp;
437         assert!(nodes_0_read.is_empty());
438
439         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
440         nodes[0].node = &nodes_0_deserialized;
441         check_added_monitors!(nodes[0], 1);
442
443         // On reload, the ChannelManager should realize it is stale compared to the ChannelMonitor and
444         // force-close the channel.
445         check_closed_event!(nodes[0], 1, ClosureReason::OutdatedChannelManager);
446         assert!(nodes[0].node.list_channels().is_empty());
447         assert!(nodes[0].node.has_pending_payments());
448         let as_broadcasted_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
449         assert_eq!(as_broadcasted_txn.len(), 1);
450         assert_eq!(as_broadcasted_txn[0], as_commitment_tx);
451
452         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
453         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
454         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
455
456         // Now nodes[1] should send a channel reestablish, which nodes[0] will respond to with an
457         // error, as the channel has hit the chain.
458         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
459         let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
460         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish);
461         let as_err = nodes[0].node.get_and_clear_pending_msg_events();
462         assert_eq!(as_err.len(), 1);
463         match as_err[0] {
464                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
465                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
466                         nodes[1].node.handle_error(&nodes[0].node.get_our_node_id(), msg);
467                         check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Failed to find corresponding channel".to_string() });
468                         check_added_monitors!(nodes[1], 1);
469                         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
470                 },
471                 _ => panic!("Unexpected event"),
472         }
473         check_closed_broadcast!(nodes[1], false);
474
475         // Now claim the first payment, which should allow nodes[1] to claim the payment on-chain when
476         // we close in a moment.
477         nodes[2].node.claim_funds(payment_preimage_1);
478         check_added_monitors!(nodes[2], 1);
479         expect_payment_claimed!(nodes[2], payment_hash_1, 1_000_000);
480
481         let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
482         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
483         check_added_monitors!(nodes[1], 1);
484         commitment_signed_dance!(nodes[1], nodes[2], htlc_fulfill_updates.commitment_signed, false);
485
486         if confirm_before_reload {
487                 let best_block = nodes[0].blocks.lock().unwrap().last().unwrap().clone();
488                 nodes[0].node.best_block_updated(&best_block.0.header, best_block.1);
489         }
490
491         // Create a new channel on which to retry the payment before we fail the payment via the
492         // HTLC-Timeout transaction. This avoids ChannelManager timing out the payment due to us
493         // connecting several blocks while creating the channel (implying time has passed).
494         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
495         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
496
497         mine_transaction(&nodes[1], &as_commitment_tx);
498         let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
499         assert_eq!(bs_htlc_claim_txn.len(), 1);
500         check_spends!(bs_htlc_claim_txn[0], as_commitment_tx);
501         expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], None, false, false);
502
503         if !confirm_before_reload {
504                 mine_transaction(&nodes[0], &as_commitment_tx);
505         }
506         mine_transaction(&nodes[0], &bs_htlc_claim_txn[0]);
507         expect_payment_sent!(nodes[0], payment_preimage_1);
508         connect_blocks(&nodes[0], TEST_FINAL_CLTV*4 + 20);
509         let as_htlc_timeout_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
510         assert_eq!(as_htlc_timeout_txn.len(), 3);
511         let (first_htlc_timeout_tx, second_htlc_timeout_tx) = if as_htlc_timeout_txn[0] == as_commitment_tx {
512                 (&as_htlc_timeout_txn[1], &as_htlc_timeout_txn[2])
513         } else {
514                 assert_eq!(as_htlc_timeout_txn[2], as_commitment_tx);
515                 (&as_htlc_timeout_txn[0], &as_htlc_timeout_txn[1])
516         };
517         check_spends!(first_htlc_timeout_tx, as_commitment_tx);
518         check_spends!(second_htlc_timeout_tx, as_commitment_tx);
519         if first_htlc_timeout_tx.input[0].previous_output == bs_htlc_claim_txn[0].input[0].previous_output {
520                 confirm_transaction(&nodes[0], &second_htlc_timeout_tx);
521         } else {
522                 confirm_transaction(&nodes[0], &first_htlc_timeout_tx);
523         }
524         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
525         expect_payment_failed_conditions(&nodes[0], payment_hash, false, PaymentFailedConditions::new().mpp_parts_remain());
526
527         // Finally, retry the payment (which was reloaded from the ChannelMonitor when nodes[0] was
528         // reloaded) via a route over the new channel, which work without issue and eventually be
529         // received and claimed at the recipient just like any other payment.
530         let (mut new_route, _, _, _) = get_route_and_payment_hash!(nodes[0], nodes[2], 1_000_000);
531
532         // Update the fee on the middle hop to ensure PaymentSent events have the correct (retried) fee
533         // and not the original fee. We also update node[1]'s relevant config as
534         // do_claim_payment_along_route expects us to never overpay.
535         {
536                 let mut channel_state = nodes[1].node.channel_state.lock().unwrap();
537                 let mut channel = channel_state.by_id.get_mut(&chan_id_2).unwrap();
538                 let mut new_config = channel.config();
539                 new_config.forwarding_fee_base_msat += 100_000;
540                 channel.update_config(&new_config);
541                 new_route.paths[0][0].fee_msat += 100_000;
542         }
543
544         // Force expiration of the channel's previous config.
545         for _ in 0..EXPIRE_PREV_CONFIG_TICKS {
546                 nodes[1].node.timer_tick_occurred();
547         }
548
549         assert!(nodes[0].node.retry_payment(&new_route, payment_id_1).is_err()); // Shouldn't be allowed to retry a fulfilled payment
550         nodes[0].node.retry_payment(&new_route, payment_id).unwrap();
551         check_added_monitors!(nodes[0], 1);
552         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
553         assert_eq!(events.len(), 1);
554         pass_along_path(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000, payment_hash, Some(payment_secret), events.pop().unwrap(), true, None);
555         do_claim_payment_along_route(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage);
556         expect_payment_sent!(nodes[0], payment_preimage, Some(new_route.paths[0][0].fee_msat));
557 }
558
559 #[test]
560 fn retry_with_no_persist() {
561         do_retry_with_no_persist(true);
562         do_retry_with_no_persist(false);
563 }
564
565 fn do_test_dup_htlc_onchain_fails_on_reload(persist_manager_post_event: bool, confirm_commitment_tx: bool, payment_timeout: bool) {
566         // When a Channel is closed, any outbound HTLCs which were relayed through it are simply
567         // dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
568         // having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
569         // the ChannelMonitor tells it to.
570         //
571         // If, due to an on-chain event, an HTLC is failed/claimed, we should avoid providing the
572         // ChannelManager the HTLC event until after the monitor is re-persisted. This should prevent a
573         // duplicate HTLC fail/claim (e.g. via a PaymentPathFailed event).
574         let chanmon_cfgs = create_chanmon_cfgs(2);
575         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
576         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
577         let persister: test_utils::TestPersister;
578         let new_chain_monitor: test_utils::TestChainMonitor;
579         let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
580         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
581
582         let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
583
584         // Route a payment, but force-close the channel before the HTLC fulfill message arrives at
585         // nodes[0].
586         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000_000);
587         nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
588         check_closed_broadcast!(nodes[0], true);
589         check_added_monitors!(nodes[0], 1);
590         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
591
592         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
593         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
594
595         // Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
596         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
597         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
598         assert_eq!(node_txn.len(), 3);
599         assert_eq!(node_txn[0], node_txn[1]);
600         check_spends!(node_txn[1], funding_tx);
601         check_spends!(node_txn[2], node_txn[1]);
602         let timeout_txn = vec![node_txn[2].clone()];
603
604         nodes[1].node.claim_funds(payment_preimage);
605         check_added_monitors!(nodes[1], 1);
606         expect_payment_claimed!(nodes[1], payment_hash, 10_000_000);
607
608         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
609         connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone()]});
610         check_closed_broadcast!(nodes[1], true);
611         check_added_monitors!(nodes[1], 1);
612         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
613         let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
614         assert_eq!(claim_txn.len(), 3);
615         check_spends!(claim_txn[0], node_txn[1]);
616         check_spends!(claim_txn[1], funding_tx);
617         check_spends!(claim_txn[2], claim_txn[1]);
618
619         header.prev_blockhash = nodes[0].best_block_hash();
620         connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone()]});
621
622         if confirm_commitment_tx {
623                 connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
624         }
625
626         header.prev_blockhash = nodes[0].best_block_hash();
627         let claim_block = Block { header, txdata: if payment_timeout { timeout_txn } else { vec![claim_txn[0].clone()] } };
628
629         if payment_timeout {
630                 assert!(confirm_commitment_tx); // Otherwise we're spending below our CSV!
631                 connect_block(&nodes[0], &claim_block);
632                 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 2);
633         }
634
635         // Now connect the HTLC claim transaction with the ChainMonitor-generated ChannelMonitor update
636         // returning TemporaryFailure. This should cause the claim event to never make its way to the
637         // ChannelManager.
638         chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clear();
639         chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
640
641         if payment_timeout {
642                 connect_blocks(&nodes[0], 1);
643         } else {
644                 connect_block(&nodes[0], &claim_block);
645         }
646
647         let funding_txo = OutPoint { txid: funding_tx.txid(), index: 0 };
648         let mon_updates: Vec<_> = chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap()
649                 .get_mut(&funding_txo).unwrap().drain().collect();
650         // If we are using chain::Confirm instead of chain::Listen, we will get the same update twice
651         assert!(mon_updates.len() == 1 || mon_updates.len() == 2);
652         assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
653         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
654
655         // If we persist the ChannelManager here, we should get the PaymentSent event after
656         // deserialization.
657         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
658         if !persist_manager_post_event {
659                 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
660         }
661
662         // Now persist the ChannelMonitor and inform the ChainMonitor that we're done, generating the
663         // payment sent event.
664         chanmon_cfgs[0].persister.set_update_ret(Ok(()));
665         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
666         get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
667         for update in mon_updates {
668                 nodes[0].chain_monitor.chain_monitor.channel_monitor_updated(funding_txo, update).unwrap();
669         }
670         if payment_timeout {
671                 expect_payment_failed!(nodes[0], payment_hash, true);
672         } else {
673                 expect_payment_sent!(nodes[0], payment_preimage);
674         }
675
676         // If we persist the ChannelManager after we get the PaymentSent event, we shouldn't get it
677         // twice.
678         if persist_manager_post_event {
679                 nodes[0].node.write(&mut chan_manager_serialized).unwrap();
680         }
681
682         // Now reload nodes[0]...
683         persister = test_utils::TestPersister::new();
684         let keys_manager = &chanmon_cfgs[0].keys_manager;
685         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);
686         nodes[0].chain_monitor = &new_chain_monitor;
687         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
688         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
689                 &mut chan_0_monitor_read, keys_manager).unwrap();
690         assert!(chan_0_monitor_read.is_empty());
691
692         let (_, nodes_0_deserialized_tmp) = {
693                 let mut channel_monitors = HashMap::new();
694                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
695                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
696                         ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
697                                 default_config: Default::default(),
698                                 keys_manager,
699                                 fee_estimator: node_cfgs[0].fee_estimator,
700                                 chain_monitor: nodes[0].chain_monitor,
701                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
702                                 logger: nodes[0].logger,
703                                 channel_monitors,
704                         }).unwrap()
705         };
706         nodes_0_deserialized = nodes_0_deserialized_tmp;
707
708         assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
709         check_added_monitors!(nodes[0], 1);
710         nodes[0].node = &nodes_0_deserialized;
711
712         if persist_manager_post_event {
713                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
714         } else if payment_timeout {
715                 expect_payment_failed!(nodes[0], payment_hash, true);
716         } else {
717                 expect_payment_sent!(nodes[0], payment_preimage);
718         }
719
720         // Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
721         // which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
722         // payment events should kick in, leaving us with no pending events here.
723         let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
724         nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
725         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
726 }
727
728 #[test]
729 fn test_dup_htlc_onchain_fails_on_reload() {
730         do_test_dup_htlc_onchain_fails_on_reload(true, true, true);
731         do_test_dup_htlc_onchain_fails_on_reload(true, true, false);
732         do_test_dup_htlc_onchain_fails_on_reload(true, false, false);
733         do_test_dup_htlc_onchain_fails_on_reload(false, true, true);
734         do_test_dup_htlc_onchain_fails_on_reload(false, true, false);
735         do_test_dup_htlc_onchain_fails_on_reload(false, false, false);
736 }
737
738 #[test]
739 fn test_fulfill_restart_failure() {
740         // When we receive an update_fulfill_htlc message, we immediately consider the HTLC fully
741         // fulfilled. At this point, the peer can reconnect and decide to either fulfill the HTLC
742         // again, or fail it, giving us free money.
743         //
744         // Of course probably they won't fail it and give us free money, but because we have code to
745         // handle it, we should test the logic for it anyway. We do that here.
746         let chanmon_cfgs = create_chanmon_cfgs(2);
747         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
748         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
749         let persister: test_utils::TestPersister;
750         let new_chain_monitor: test_utils::TestChainMonitor;
751         let nodes_1_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
752         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
753
754         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
755         let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 100_000);
756
757         // The simplest way to get a failure after a fulfill is to reload nodes[1] from a state
758         // pre-fulfill, which we do by serializing it here.
759         let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
760         nodes[1].node.write(&mut chan_manager_serialized).unwrap();
761         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
762         get_monitor!(nodes[1], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
763
764         nodes[1].node.claim_funds(payment_preimage);
765         check_added_monitors!(nodes[1], 1);
766         expect_payment_claimed!(nodes[1], payment_hash, 100_000);
767
768         let htlc_fulfill_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
769         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_fulfill_updates.update_fulfill_htlcs[0]);
770         expect_payment_sent_without_paths!(nodes[0], payment_preimage);
771
772         // Now reload nodes[1]...
773         persister = test_utils::TestPersister::new();
774         let keys_manager = &chanmon_cfgs[1].keys_manager;
775         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);
776         nodes[1].chain_monitor = &new_chain_monitor;
777         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
778         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
779                 &mut chan_0_monitor_read, keys_manager).unwrap();
780         assert!(chan_0_monitor_read.is_empty());
781
782         let (_, nodes_1_deserialized_tmp) = {
783                 let mut channel_monitors = HashMap::new();
784                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
785                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
786                         ::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
787                                 default_config: Default::default(),
788                                 keys_manager,
789                                 fee_estimator: node_cfgs[1].fee_estimator,
790                                 chain_monitor: nodes[1].chain_monitor,
791                                 tx_broadcaster: nodes[1].tx_broadcaster.clone(),
792                                 logger: nodes[1].logger,
793                                 channel_monitors,
794                         }).unwrap()
795         };
796         nodes_1_deserialized = nodes_1_deserialized_tmp;
797
798         assert!(nodes[1].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
799         check_added_monitors!(nodes[1], 1);
800         nodes[1].node = &nodes_1_deserialized;
801
802         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
803         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
804
805         nodes[1].node.fail_htlc_backwards(&payment_hash);
806         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
807         check_added_monitors!(nodes[1], 1);
808         let htlc_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
809         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_fail_updates.update_fail_htlcs[0]);
810         commitment_signed_dance!(nodes[0], nodes[1], htlc_fail_updates.commitment_signed, false);
811         // nodes[0] shouldn't generate any events here, while it just got a payment failure completion
812         // it had already considered the payment fulfilled, and now they just got free money.
813         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
814 }
815
816 #[test]
817 fn get_ldk_payment_preimage() {
818         // Ensure that `ChannelManager::get_payment_preimage` can successfully be used to claim a payment.
819         let chanmon_cfgs = create_chanmon_cfgs(2);
820         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
821         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
822         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
823         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
824
825         let amt_msat = 60_000;
826         let expiry_secs = 60 * 60;
827         let (payment_hash, payment_secret) = nodes[1].node.create_inbound_payment(Some(amt_msat), expiry_secs).unwrap();
828
829         let payment_params = PaymentParameters::from_node_id(nodes[1].node.get_our_node_id())
830                 .with_features(InvoiceFeatures::known());
831         let scorer = test_utils::TestScorer::with_penalty(0);
832         let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
833         let random_seed_bytes = keys_manager.get_secure_random_bytes();
834         let route = get_route(
835                 &nodes[0].node.get_our_node_id(), &payment_params, &nodes[0].network_graph.read_only(),
836                 Some(&nodes[0].node.list_usable_channels().iter().collect::<Vec<_>>()),
837                 amt_msat, TEST_FINAL_CLTV, nodes[0].logger, &scorer, &random_seed_bytes).unwrap();
838         let _payment_id = nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
839         check_added_monitors!(nodes[0], 1);
840
841         // Make sure to use `get_payment_preimage`
842         let payment_preimage = nodes[1].node.get_payment_preimage(payment_hash, payment_secret).unwrap();
843         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
844         assert_eq!(events.len(), 1);
845         pass_along_path(&nodes[0], &[&nodes[1]], amt_msat, payment_hash, Some(payment_secret), events.pop().unwrap(), true, Some(payment_preimage));
846         claim_payment_along_route(&nodes[0], &[&[&nodes[1]]], false, payment_preimage);
847 }
848
849 #[test]
850 fn sent_probe_is_probe_of_sending_node() {
851         let chanmon_cfgs = create_chanmon_cfgs(3);
852         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
853         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None, None]);
854         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
855
856         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
857         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
858
859         // First check we refuse to build a single-hop probe
860         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
861         assert!(nodes[0].node.send_probe(route.paths[0].clone()).is_err());
862
863         // Then build an actual two-hop probing path
864         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], 100_000);
865
866         match nodes[0].node.send_probe(route.paths[0].clone()) {
867                 Ok((payment_hash, payment_id)) => {
868                         assert!(nodes[0].node.payment_is_probe(&payment_hash, &payment_id));
869                         assert!(!nodes[1].node.payment_is_probe(&payment_hash, &payment_id));
870                         assert!(!nodes[2].node.payment_is_probe(&payment_hash, &payment_id));
871                 },
872                 _ => panic!(),
873         }
874
875         get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
876         check_added_monitors!(nodes[0], 1);
877 }
878
879 #[test]
880 fn successful_probe_yields_event() {
881         let chanmon_cfgs = create_chanmon_cfgs(3);
882         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
883         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None, None]);
884         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
885
886         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
887         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
888
889         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], 100_000);
890
891         let (payment_hash, payment_id) = nodes[0].node.send_probe(route.paths[0].clone()).unwrap();
892
893         // node[0] -- update_add_htlcs -> node[1]
894         check_added_monitors!(nodes[0], 1);
895         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
896         let probe_event = SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), updates);
897         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &probe_event.msgs[0]);
898         check_added_monitors!(nodes[1], 0);
899         commitment_signed_dance!(nodes[1], nodes[0], probe_event.commitment_msg, false);
900         expect_pending_htlcs_forwardable!(nodes[1]);
901
902         // node[1] -- update_add_htlcs -> node[2]
903         check_added_monitors!(nodes[1], 1);
904         let updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
905         let probe_event = SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), updates);
906         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &probe_event.msgs[0]);
907         check_added_monitors!(nodes[2], 0);
908         commitment_signed_dance!(nodes[2], nodes[1], probe_event.commitment_msg, true, true);
909
910         // node[1] <- update_fail_htlcs -- node[2]
911         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
912         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
913         check_added_monitors!(nodes[1], 0);
914         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, true);
915
916         // node[0] <- update_fail_htlcs -- node[1]
917         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
918         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
919         check_added_monitors!(nodes[0], 0);
920         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
921
922         let mut events = nodes[0].node.get_and_clear_pending_events();
923         assert_eq!(events.len(), 1);
924         match events.drain(..).next().unwrap() {
925                 crate::util::events::Event::ProbeSuccessful { payment_id: ev_pid, payment_hash: ev_ph, .. } => {
926                         assert_eq!(payment_id, ev_pid);
927                         assert_eq!(payment_hash, ev_ph);
928                 },
929                 _ => panic!(),
930         };
931 }
932
933 #[test]
934 fn failed_probe_yields_event() {
935         let chanmon_cfgs = create_chanmon_cfgs(3);
936         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
937         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None, None]);
938         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
939
940         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
941         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 90000000, InitFeatures::known(), InitFeatures::known());
942
943         let payment_params = PaymentParameters::from_node_id(nodes[2].node.get_our_node_id());
944
945         let (route, _, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[2], &payment_params, 9_998_000, 42);
946
947         let (payment_hash, payment_id) = nodes[0].node.send_probe(route.paths[0].clone()).unwrap();
948
949         // node[0] -- update_add_htlcs -> node[1]
950         check_added_monitors!(nodes[0], 1);
951         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
952         let probe_event = SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), updates);
953         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &probe_event.msgs[0]);
954         check_added_monitors!(nodes[1], 0);
955         commitment_signed_dance!(nodes[1], nodes[0], probe_event.commitment_msg, false);
956         expect_pending_htlcs_forwardable!(nodes[1]);
957
958         // node[0] <- update_fail_htlcs -- node[1]
959         check_added_monitors!(nodes[1], 1);
960         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
961         // Skip the PendingHTLCsForwardable event
962         let _events = nodes[1].node.get_and_clear_pending_events();
963         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
964         check_added_monitors!(nodes[0], 0);
965         commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
966
967         let mut events = nodes[0].node.get_and_clear_pending_events();
968         assert_eq!(events.len(), 1);
969         match events.drain(..).next().unwrap() {
970                 crate::util::events::Event::ProbeFailed { payment_id: ev_pid, payment_hash: ev_ph, .. } => {
971                         assert_eq!(payment_id, ev_pid);
972                         assert_eq!(payment_hash, ev_ph);
973                 },
974                 _ => panic!(),
975         };
976 }