]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/reorg_tests.rs
Add an immediately-freeing `MonitorUpdateCompletionAction`.
[rust-lightning] / lightning / src / ln / reorg_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 //! Further functional tests which test blockchain reorganizations.
11
12 use crate::chain::chaininterface::LowerBoundedFeeEstimator;
13 use crate::chain::channelmonitor::{ANTI_REORG_DELAY, LATENCY_GRACE_PERIOD_BLOCKS};
14 use crate::chain::transaction::OutPoint;
15 use crate::chain::Confirm;
16 use crate::events::{Event, MessageSendEventsProvider, ClosureReason, HTLCDestination, MessageSendEvent};
17 use crate::ln::msgs::{ChannelMessageHandler, Init};
18 use crate::util::test_utils;
19 use crate::util::ser::Writeable;
20 use crate::util::string::UntrustedString;
21
22 use bitcoin::blockdata::script::Builder;
23 use bitcoin::blockdata::opcodes;
24 use bitcoin::secp256k1::Secp256k1;
25
26 use crate::prelude::*;
27
28 use crate::ln::functional_test_utils::*;
29
30 fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
31         // Our on-chain HTLC-claim learning has a few properties worth testing:
32         //  * If an upstream HTLC is claimed with a preimage (both against our own commitment
33         //    transaction our counterparty's), we claim it backwards immediately.
34         //  * If an upstream HTLC is claimed with a timeout, we delay ANTI_REORG_DELAY before failing
35         //    it backwards to ensure our counterparty can't claim with a preimage in a reorg.
36         //
37         // Here we test both properties in any combination based on the two bools passed in as
38         // arguments.
39         //
40         // If local_commitment is set, we first broadcast a local commitment containing an offered HTLC
41         // and an HTLC-Timeout tx, otherwise we broadcast a remote commitment containing a received
42         // HTLC and a local HTLC-Timeout tx spending it.
43         //
44         // We then either allow these transactions to confirm (if !claim) or we wait until one block
45         // before they otherwise would and reorg them out, confirming an HTLC-Success tx instead.
46         let chanmon_cfgs = create_chanmon_cfgs(3);
47         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
48         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
49         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
50
51         create_announced_chan_between_nodes(&nodes, 0, 1);
52         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
53
54         // Make sure all nodes are at the same starting height
55         connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
56         connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
57         connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
58
59         let (our_payment_preimage, our_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
60
61         // Provide preimage to node 2 by claiming payment
62         nodes[2].node.claim_funds(our_payment_preimage);
63         expect_payment_claimed!(nodes[2], our_payment_hash, 1_000_000);
64         check_added_monitors!(nodes[2], 1);
65         get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
66
67         let claim_txn = if local_commitment {
68                 // Broadcast node 1 commitment txn to broadcast the HTLC-Timeout
69                 let node_1_commitment_txn = get_local_commitment_txn!(nodes[1], chan_2.2);
70                 assert_eq!(node_1_commitment_txn.len(), 2); // 1 local commitment tx, 1 Outbound HTLC-Timeout
71                 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-self and Offered HTLC (to-remote/to-node-3 is dust)
72                 check_spends!(node_1_commitment_txn[0], chan_2.3);
73                 check_spends!(node_1_commitment_txn[1], node_1_commitment_txn[0]);
74
75                 // Give node 2 node 1's transactions and get its response (claiming the HTLC instead).
76                 connect_block(&nodes[2], &create_dummy_block(nodes[2].best_block_hash(), 42, node_1_commitment_txn.clone()));
77                 check_added_monitors!(nodes[2], 1);
78                 check_closed_broadcast!(nodes[2], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
79                 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
80                 let node_2_commitment_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
81                 assert_eq!(node_2_commitment_txn.len(), 1); // ChannelMonitor: 1 offered HTLC-Claim
82                 check_spends!(node_2_commitment_txn[0], node_1_commitment_txn[0]);
83
84                 // Make sure node 1's height is the same as the !local_commitment case
85                 connect_blocks(&nodes[1], 1);
86                 // Confirm node 1's commitment txn (and HTLC-Timeout) on node 1
87                 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, node_1_commitment_txn.clone()));
88
89                 // ...but return node 1's commitment tx in case claim is set and we're preparing to reorg
90                 vec![node_1_commitment_txn[0].clone(), node_2_commitment_txn[0].clone()]
91         } else {
92                 // Broadcast node 2 commitment txn
93                 let mut node_2_commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
94                 assert_eq!(node_2_commitment_txn.len(), 2); // 1 local commitment tx, 1 Received HTLC-Claim
95                 assert_eq!(node_2_commitment_txn[0].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
96                 check_spends!(node_2_commitment_txn[0], chan_2.3);
97                 check_spends!(node_2_commitment_txn[1], node_2_commitment_txn[0]);
98
99                 // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
100                 mine_transaction(&nodes[1], &node_2_commitment_txn[0]);
101                 connect_blocks(&nodes[1], TEST_FINAL_CLTV); // Confirm blocks until the HTLC expires
102                 let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
103                 assert_eq!(node_1_commitment_txn.len(), 1); // ChannelMonitor: 1 offered HTLC-Timeout
104                 check_spends!(node_1_commitment_txn[0], node_2_commitment_txn[0]);
105
106                 // Confirm node 1's HTLC-Timeout on node 1
107                 mine_transaction(&nodes[1], &node_1_commitment_txn[0]);
108                 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
109                 vec![node_2_commitment_txn.pop().unwrap()]
110         };
111         check_added_monitors!(nodes[1], 1);
112         check_closed_broadcast!(nodes[1], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
113         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[2].node.get_our_node_id()], 100000);
114         // Connect ANTI_REORG_DELAY - 2 blocks, giving us a confirmation count of ANTI_REORG_DELAY - 1.
115         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
116         check_added_monitors!(nodes[1], 0);
117         assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
118
119         if claim {
120                 // Disconnect Node 1's HTLC-Timeout which was connected above
121                 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
122
123                 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, claim_txn));
124
125                 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
126                 // probe it for events, so we probe non-message events here (which should just be the
127                 // PaymentForwarded event).
128                 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), true, true);
129         } else {
130                 // Confirm the timeout tx and check that we fail the HTLC backwards
131                 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, Vec::new()));
132                 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_2.2 }]);
133         }
134
135         check_added_monitors!(nodes[1], 1);
136         // Which should result in an immediate claim/fail of the HTLC:
137         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
138         if claim {
139                 assert_eq!(htlc_updates.update_fulfill_htlcs.len(), 1);
140                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fulfill_htlcs[0]);
141         } else {
142                 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
143                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
144         }
145         commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false, true);
146         if claim {
147                 expect_payment_sent!(nodes[0], our_payment_preimage);
148         } else {
149                 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
150         }
151 }
152
153 #[test]
154 fn test_onchain_htlc_claim_reorg_local_commitment() {
155         do_test_onchain_htlc_reorg(true, true);
156 }
157 #[test]
158 fn test_onchain_htlc_timeout_delay_local_commitment() {
159         do_test_onchain_htlc_reorg(true, false);
160 }
161 #[test]
162 fn test_onchain_htlc_claim_reorg_remote_commitment() {
163         do_test_onchain_htlc_reorg(false, true);
164 }
165 #[test]
166 fn test_onchain_htlc_timeout_delay_remote_commitment() {
167         do_test_onchain_htlc_reorg(false, false);
168 }
169
170 #[test]
171 fn test_counterparty_revoked_reorg() {
172         // Test what happens when a revoked counterparty transaction is broadcast but then reorg'd out
173         // of the main chain. Specifically, HTLCs in the latest commitment transaction which are not
174         // included in the revoked commitment transaction should not be considered failed, and should
175         // still be claim-from-able after the reorg.
176         let chanmon_cfgs = create_chanmon_cfgs(2);
177         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
178         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
179         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
180
181         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000);
182
183         // Get the initial commitment transaction for broadcast, before any HTLCs are added at all.
184         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
185         assert_eq!(revoked_local_txn.len(), 1);
186
187         // Now add two HTLCs in each direction, one dust and one not.
188         route_payment(&nodes[0], &[&nodes[1]], 5_000_000);
189         route_payment(&nodes[0], &[&nodes[1]], 5_000);
190         let (payment_preimage_3, payment_hash_3, ..) = route_payment(&nodes[1], &[&nodes[0]], 4_000_000);
191         let payment_hash_4 = route_payment(&nodes[1], &[&nodes[0]], 4_000).1;
192
193         nodes[0].node.claim_funds(payment_preimage_3);
194         let _ = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
195         check_added_monitors!(nodes[0], 1);
196         expect_payment_claimed!(nodes[0], payment_hash_3, 4_000_000);
197
198         let mut unrevoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
199         assert_eq!(unrevoked_local_txn.len(), 3); // commitment + 2 HTLC txn
200         // Sort the unrevoked transactions in reverse order, ie commitment tx, then HTLC 1 then HTLC 3
201         unrevoked_local_txn.sort_unstable_by_key(|tx| 1_000_000 - tx.output.iter().map(|outp| outp.value).sum::<u64>());
202
203         // Now mine A's old commitment transaction, which should close the channel, but take no action
204         // on any of the HTLCs, at least until we get six confirmations (which we won't get).
205         mine_transaction(&nodes[1], &revoked_local_txn[0]);
206         check_added_monitors!(nodes[1], 1);
207         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 1000000);
208         check_closed_broadcast!(nodes[1], true);
209
210         // Connect up to one block before the revoked transaction would be considered final, then do a
211         // reorg that disconnects the full chain and goes up to the height at which the revoked
212         // transaction would be final.
213         let theoretical_conf_height = nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1;
214         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
215         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
216         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
217
218         disconnect_all_blocks(&nodes[1]);
219         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
220         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
221
222         connect_blocks(&nodes[1], theoretical_conf_height);
223         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
224         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
225
226         // Now connect A's latest commitment transaction instead and resolve the HTLCs
227         mine_transaction(&nodes[1], &unrevoked_local_txn[0]);
228         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
229         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
230
231         // Connect the HTLC claim transaction for HTLC 3
232         mine_transaction(&nodes[1], &unrevoked_local_txn[2]);
233         expect_payment_sent(&nodes[1], payment_preimage_3, None, true, false);
234         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
235
236         // Connect blocks to confirm the unrevoked commitment transaction
237         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
238         expect_payment_failed!(nodes[1], payment_hash_4, false);
239 }
240
241 fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, use_funding_unconfirmed: bool, connect_style: ConnectStyle) {
242         // After creating a chan between nodes, we disconnect all blocks previously seen to force a
243         // channel close on nodes[0] side. We also use this to provide very basic testing of logic
244         // around freeing background events which store monitor updates during block_[dis]connected.
245         let chanmon_cfgs = create_chanmon_cfgs(2);
246         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
247         let persister;
248         let new_chain_monitor;
249
250         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
251         let nodes_0_deserialized;
252
253         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
254         *nodes[0].connect_style.borrow_mut() = connect_style;
255
256         let chan_conf_height = core::cmp::max(nodes[0].best_block_info().1 + 1, nodes[1].best_block_info().1 + 1);
257         let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
258
259         {
260                 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
261                 let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
262                 assert_eq!(peer_state.channel_by_id.len(), 1);
263                 assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 2);
264         }
265
266         assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(10));
267         assert_eq!(nodes[1].node.list_channels()[0].confirmations, Some(10));
268
269         if !reorg_after_reload {
270                 if use_funding_unconfirmed {
271                         let relevant_txids = nodes[0].node.get_relevant_txids();
272                         assert_eq!(relevant_txids.len(), 1);
273                         let block_hash_opt = relevant_txids[0].1;
274                         let expected_hash = nodes[0].get_block_header(chan_conf_height).block_hash();
275                         assert_eq!(block_hash_opt, Some(expected_hash));
276                         let txid = relevant_txids[0].0;
277                         assert_eq!(txid, chan.3.txid());
278                         nodes[0].node.transaction_unconfirmed(&txid);
279                         assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
280                 } else if connect_style == ConnectStyle::FullBlockViaListen {
281                         disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
282                         assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
283                         assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(1));
284                         disconnect_blocks(&nodes[0], 1);
285                         assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
286                 } else {
287                         disconnect_all_blocks(&nodes[0]);
288                         assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
289                 }
290
291                 let relevant_txids = nodes[0].node.get_relevant_txids();
292                 assert_eq!(relevant_txids.len(), 0);
293
294                 {
295                         let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
296                         let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
297                         assert_eq!(peer_state.channel_by_id.len(), 0);
298                         assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 0);
299                 }
300         }
301
302         if reload_node {
303                 // Since we currently have a background event pending, it's good to test that we survive a
304                 // serialization roundtrip. Further, this tests the somewhat awkward edge-case of dropping
305                 // the Channel object from the ChannelManager, but still having a monitor event pending for
306                 // it when we go to deserialize, and then use the ChannelManager.
307                 let nodes_0_serialized = nodes[0].node.encode();
308                 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan.2).encode();
309
310                 reload_node!(nodes[0], *nodes[0].node.get_current_default_configuration(), &nodes_0_serialized, &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
311                 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
312         }
313
314         if reorg_after_reload {
315                 if use_funding_unconfirmed {
316                         let relevant_txids = nodes[0].node.get_relevant_txids();
317                         assert_eq!(relevant_txids.len(), 1);
318                         let block_hash_opt = relevant_txids[0].1;
319                         let expected_hash = nodes[0].get_block_header(chan_conf_height).block_hash();
320                         assert_eq!(block_hash_opt, Some(expected_hash));
321                         let txid = relevant_txids[0].0;
322                         assert_eq!(txid, chan.3.txid());
323                         nodes[0].node.transaction_unconfirmed(&txid);
324                         assert_eq!(nodes[0].node.list_channels().len(), 0);
325                 } else if connect_style == ConnectStyle::FullBlockViaListen {
326                         disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
327                         assert_eq!(nodes[0].node.list_channels().len(), 1);
328                         assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(1));
329                         disconnect_blocks(&nodes[0], 1);
330                         assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
331                 } else {
332                         disconnect_all_blocks(&nodes[0]);
333                         assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
334                 }
335
336                 let relevant_txids = nodes[0].node.get_relevant_txids();
337                 assert_eq!(relevant_txids.len(), 0);
338
339                 {
340                         let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
341                         let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
342                         assert_eq!(peer_state.channel_by_id.len(), 0);
343                         assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 0);
344                 }
345         }
346         // With expect_channel_force_closed set the TestChainMonitor will enforce that the next update
347         // is a ChannelForcClosed on the right channel with should_broadcast set.
348         *nodes[0].chain_monitor.expect_channel_force_closed.lock().unwrap() = Some((chan.2, true));
349         nodes[0].node.test_process_background_events(); // Required to free the pending background monitor update
350         check_added_monitors!(nodes[0], 1);
351         let expected_err = "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.";
352         if reorg_after_reload || !reload_node {
353                 handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Channel closed because of an exception: Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.");
354                 check_added_monitors!(nodes[1], 1);
355                 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Channel closed because of an exception: {}", expected_err)) }
356                         , [nodes[0].node.get_our_node_id()], 100000);
357         }
358
359         check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: expected_err.to_owned() },
360                 [nodes[1].node.get_our_node_id()], 100000);
361         assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
362         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
363
364         // Now check that we can create a new channel
365         if reload_node && nodes[0].node.per_peer_state.read().unwrap().len() == 0 {
366                 // If we dropped the channel before reloading the node, nodes[1] was also dropped from
367                 // nodes[0] storage, and hence not connected again on startup. We therefore need to
368                 // reconnect to the node before attempting to create a new channel.
369                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &Init {
370                         features: nodes[1].node.init_features(), networks: None, remote_network_address: None
371                 }, true).unwrap();
372         }
373         create_announced_chan_between_nodes(&nodes, 0, 1);
374         send_payment(&nodes[0], &[&nodes[1]], 8000000);
375 }
376
377 #[test]
378 fn test_unconf_chan() {
379         do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
380         do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
381         do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
382         do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
383
384         do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
385         do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
386         do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
387         do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
388 }
389
390 #[test]
391 fn test_unconf_chan_via_listen() {
392         do_test_unconf_chan(true, true, false, ConnectStyle::FullBlockViaListen);
393         do_test_unconf_chan(false, true, false, ConnectStyle::FullBlockViaListen);
394         do_test_unconf_chan(true, false, false, ConnectStyle::FullBlockViaListen);
395         do_test_unconf_chan(false, false, false, ConnectStyle::FullBlockViaListen);
396 }
397
398 #[test]
399 fn test_unconf_chan_via_funding_unconfirmed() {
400         do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
401         do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
402         do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
403         do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
404
405         do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
406         do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
407         do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
408         do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
409
410         do_test_unconf_chan(true, true, true, ConnectStyle::FullBlockViaListen);
411         do_test_unconf_chan(false, true, true, ConnectStyle::FullBlockViaListen);
412         do_test_unconf_chan(true, false, true, ConnectStyle::FullBlockViaListen);
413         do_test_unconf_chan(false, false, true, ConnectStyle::FullBlockViaListen);
414 }
415
416 #[test]
417 fn test_set_outpoints_partial_claiming() {
418         // - remote party claim tx, new bump tx
419         // - disconnect remote claiming tx, new bump
420         // - disconnect tx, see no tx anymore
421         let chanmon_cfgs = create_chanmon_cfgs(2);
422         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
423         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
424         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
425
426         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
427         let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
428         let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
429
430         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
431         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
432         assert_eq!(remote_txn.len(), 3);
433         assert_eq!(remote_txn[0].output.len(), 4);
434         assert_eq!(remote_txn[0].input.len(), 1);
435         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
436         check_spends!(remote_txn[1], remote_txn[0]);
437         check_spends!(remote_txn[2], remote_txn[0]);
438
439         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
440         // Provide node A with both preimage
441         nodes[0].node.claim_funds(payment_preimage_1);
442         expect_payment_claimed!(nodes[0], payment_hash_1, 3_000_000);
443         nodes[0].node.claim_funds(payment_preimage_2);
444         expect_payment_claimed!(nodes[0], payment_hash_2, 3_000_000);
445         check_added_monitors!(nodes[0], 2);
446         nodes[0].node.get_and_clear_pending_msg_events();
447
448         // Connect blocks on node A commitment transaction
449         mine_transaction(&nodes[0], &remote_txn[0]);
450         check_closed_broadcast!(nodes[0], true);
451         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 1000000);
452         check_added_monitors!(nodes[0], 1);
453         // Verify node A broadcast tx claiming both HTLCs
454         {
455                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
456                 // ChannelMonitor: claim tx
457                 assert_eq!(node_txn.len(), 1);
458                 check_spends!(node_txn[0], remote_txn[0]);
459                 assert_eq!(node_txn[0].input.len(), 2);
460                 node_txn.clear();
461         }
462
463         // Connect blocks on node B
464         connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
465         check_closed_broadcast!(nodes[1], true);
466         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 1000000);
467         check_added_monitors!(nodes[1], 1);
468         // Verify node B broadcast 2 HTLC-timeout txn
469         let partial_claim_tx = {
470                 let mut node_txn = nodes[1].tx_broadcaster.unique_txn_broadcast();
471                 assert_eq!(node_txn.len(), 3);
472                 check_spends!(node_txn[0], chan.3);
473                 check_spends!(node_txn[1], node_txn[0]);
474                 check_spends!(node_txn[2], node_txn[0]);
475                 assert_eq!(node_txn[1].input.len(), 1);
476                 assert_eq!(node_txn[2].input.len(), 1);
477                 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
478                 node_txn.remove(1)
479         };
480
481         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
482         mine_transaction(&nodes[0], &partial_claim_tx);
483         {
484                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
485                 assert_eq!(node_txn.len(), 1);
486                 check_spends!(node_txn[0], remote_txn[0]);
487                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
488                 node_txn.clear();
489         }
490         nodes[0].node.get_and_clear_pending_msg_events();
491
492         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
493         disconnect_blocks(&nodes[0], 1);
494         {
495                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
496                 assert_eq!(node_txn.len(), 1);
497                 check_spends!(node_txn[0], remote_txn[0]);
498                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
499                 node_txn.clear();
500         }
501
502         //// Disconnect one more block and then reconnect multiple no transaction should be generated
503         disconnect_blocks(&nodes[0], 1);
504         connect_blocks(&nodes[0], 15);
505         {
506                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
507                 assert_eq!(node_txn.len(), 0);
508                 node_txn.clear();
509         }
510 }
511
512 fn do_test_to_remote_after_local_detection(style: ConnectStyle) {
513         // In previous code, detection of to_remote outputs in a counterparty commitment transaction
514         // was dependent on whether a local commitment transaction had been seen on-chain previously.
515         // This resulted in some edge cases around not being able to generate a SpendableOutput event
516         // after a reorg.
517         //
518         // Here, we test this by first confirming one set of commitment transactions, then
519         // disconnecting them and reconnecting another. We then confirm them and check that the correct
520         // SpendableOutput event is generated.
521         let chanmon_cfgs = create_chanmon_cfgs(2);
522         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
523         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
524         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
525
526         *nodes[0].connect_style.borrow_mut() = style;
527         *nodes[1].connect_style.borrow_mut() = style;
528
529         let (_, _, chan_id, funding_tx) =
530                 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 100_000_000);
531         let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
532         assert_eq!(funding_outpoint.to_channel_id(), chan_id);
533
534         let remote_txn_a = get_local_commitment_txn!(nodes[0], chan_id);
535         let remote_txn_b = get_local_commitment_txn!(nodes[1], chan_id);
536
537         mine_transaction(&nodes[0], &remote_txn_a[0]);
538         mine_transaction(&nodes[1], &remote_txn_a[0]);
539
540         assert!(nodes[0].node.list_channels().is_empty());
541         check_closed_broadcast!(nodes[0], true);
542         check_added_monitors!(nodes[0], 1);
543         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 1000000);
544         assert!(nodes[1].node.list_channels().is_empty());
545         check_closed_broadcast!(nodes[1], true);
546         check_added_monitors!(nodes[1], 1);
547         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 1000000);
548
549         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
550         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
551
552         disconnect_blocks(&nodes[0], 1);
553         disconnect_blocks(&nodes[1], 1);
554
555         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
556         assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
557         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
558         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
559
560         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
561         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
562
563         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
564         assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
565         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
566         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
567
568         mine_transaction(&nodes[0], &remote_txn_b[0]);
569         mine_transaction(&nodes[1], &remote_txn_b[0]);
570
571         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
572         assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
573         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
574         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
575
576         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
577         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
578
579         let mut node_a_spendable = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
580         assert_eq!(node_a_spendable.len(), 1);
581         if let Event::SpendableOutputs { outputs, channel_id } = node_a_spendable.pop().unwrap() {
582                 assert_eq!(outputs.len(), 1);
583                 assert_eq!(channel_id, Some(chan_id));
584                 let spend_tx = nodes[0].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
585                         Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, None, &Secp256k1::new()).unwrap();
586                 check_spends!(spend_tx, remote_txn_b[0]);
587         }
588
589         // nodes[1] is waiting for the to_self_delay to expire, which is many more than
590         // ANTI_REORG_DELAY. Instead, walk it back and confirm the original remote_txn_a commitment
591         // again and check that nodes[1] generates a similar spendable output.
592         // Technically a reorg of ANTI_REORG_DELAY violates our assumptions, so this is undefined by
593         // our API spec, but we currently handle this correctly and there's little reason we shouldn't
594         // in the future.
595         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
596         disconnect_blocks(&nodes[1], ANTI_REORG_DELAY);
597         mine_transaction(&nodes[1], &remote_txn_a[0]);
598         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
599
600         let mut node_b_spendable = nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events();
601         assert_eq!(node_b_spendable.len(), 1);
602         if let Event::SpendableOutputs { outputs, channel_id } = node_b_spendable.pop().unwrap() {
603                 assert_eq!(outputs.len(), 1);
604                 assert_eq!(channel_id, Some(chan_id));
605                 let spend_tx = nodes[1].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
606                         Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, None, &Secp256k1::new()).unwrap();
607                 check_spends!(spend_tx, remote_txn_a[0]);
608         }
609 }
610
611 #[test]
612 fn test_to_remote_after_local_detection() {
613         do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirst);
614         do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstSkippingBlocks);
615         do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstReorgsOnlyTip);
616         do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirst);
617         do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstSkippingBlocks);
618         do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstReorgsOnlyTip);
619         do_test_to_remote_after_local_detection(ConnectStyle::FullBlockViaListen);
620 }
621
622 #[test]
623 fn test_htlc_preimage_claim_holder_commitment_after_counterparty_commitment_reorg() {
624         // We detect a counterparty commitment confirm onchain, followed by a reorg and a confirmation
625         // of a holder commitment. Then, if we learn of the preimage for an HTLC in both commitments,
626         // test that we only claim the currently confirmed commitment.
627         let chanmon_cfgs = create_chanmon_cfgs(2);
628         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
629         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
630         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
631
632         let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
633
634         // Route an HTLC which we will claim onchain with the preimage.
635         let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
636
637         // Force close with the latest counterparty commitment, confirm it, and reorg it with the latest
638         // holder commitment.
639         nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
640         check_closed_broadcast(&nodes[0], 1, true);
641         check_added_monitors(&nodes[0], 1);
642         check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed, false, &[nodes[1].node.get_our_node_id()], 100000);
643
644         nodes[1].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[0].node.get_our_node_id()).unwrap();
645         check_closed_broadcast(&nodes[1], 1, true);
646         check_added_monitors(&nodes[1], 1);
647         check_closed_event(&nodes[1], 1, ClosureReason::HolderForceClosed, false, &[nodes[0].node.get_our_node_id()], 100000);
648
649         let mut txn = nodes[0].tx_broadcaster.txn_broadcast();
650         assert_eq!(txn.len(), 1);
651         let commitment_tx_a = txn.pop().unwrap();
652         check_spends!(commitment_tx_a, funding_tx);
653
654         let mut txn = nodes[1].tx_broadcaster.txn_broadcast();
655         assert_eq!(txn.len(), 1);
656         let commitment_tx_b = txn.pop().unwrap();
657         check_spends!(commitment_tx_b, funding_tx);
658
659         mine_transaction(&nodes[0], &commitment_tx_a);
660         mine_transaction(&nodes[1], &commitment_tx_a);
661
662         disconnect_blocks(&nodes[0], 1);
663         disconnect_blocks(&nodes[1], 1);
664
665         mine_transaction(&nodes[0], &commitment_tx_b);
666         mine_transaction(&nodes[1], &commitment_tx_b);
667
668         // Provide the preimage now, such that we only claim from the holder commitment (since it's
669         // currently confirmed) and not the counterparty's.
670         get_monitor!(nodes[1], chan_id).provide_payment_preimage(
671                 &payment_hash, &payment_preimage, &nodes[1].tx_broadcaster,
672                 &LowerBoundedFeeEstimator(nodes[1].fee_estimator), &nodes[1].logger
673         );
674
675         let mut txn = nodes[1].tx_broadcaster.txn_broadcast();
676         assert_eq!(txn.len(), 1);
677         let htlc_success_tx = txn.pop().unwrap();
678         check_spends!(htlc_success_tx, commitment_tx_b);
679 }
680
681 #[test]
682 fn test_htlc_preimage_claim_prev_counterparty_commitment_after_current_counterparty_commitment_reorg() {
683         // We detect a counterparty commitment confirm onchain, followed by a reorg and a
684         // confirmation of the previous (still unrevoked) counterparty commitment. Then, if we learn
685         // of the preimage for an HTLC in both commitments, test that we only claim the currently
686         // confirmed commitment.
687         let chanmon_cfgs = create_chanmon_cfgs(2);
688         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
689         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None, None]);
690         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
691
692         let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1);
693
694         // Route an HTLC which we will claim onchain with the preimage.
695         let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
696
697         // Obtain the current commitment, which will become the previous after a fee update.
698         let prev_commitment_a = &get_local_commitment_txn!(nodes[0], chan_id)[0];
699
700         *nodes[0].fee_estimator.sat_per_kw.lock().unwrap() *= 4;
701         nodes[0].node.timer_tick_occurred();
702         check_added_monitors(&nodes[0], 1);
703         let mut msg_events = nodes[0].node.get_and_clear_pending_msg_events();
704         assert_eq!(msg_events.len(), 1);
705         let (update_fee, commit_sig) = if let MessageSendEvent::UpdateHTLCs { node_id, mut updates } = msg_events.pop().unwrap() {
706                 assert_eq!(node_id, nodes[1].node.get_our_node_id());
707                 (updates.update_fee.take().unwrap(), updates.commitment_signed)
708         } else {
709                 panic!("Unexpected message send event");
710         };
711
712         // Handle the fee update on the other side, but don't send the last RAA such that the previous
713         // commitment is still valid (unrevoked).
714         nodes[1].node().handle_update_fee(&nodes[0].node.get_our_node_id(), &update_fee);
715         let _last_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[0], commit_sig, false, true, false, true);
716
717         // Force close with the latest commitment, confirm it, and reorg it with the previous commitment.
718         nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
719         check_closed_broadcast(&nodes[0], 1, true);
720         check_added_monitors(&nodes[0], 1);
721         check_closed_event(&nodes[0], 1, ClosureReason::HolderForceClosed, false, &[nodes[1].node.get_our_node_id()], 100000);
722
723         let mut txn = nodes[0].tx_broadcaster.txn_broadcast();
724         assert_eq!(txn.len(), 1);
725         let current_commitment_a = txn.pop().unwrap();
726         assert_ne!(current_commitment_a.txid(), prev_commitment_a.txid());
727         check_spends!(current_commitment_a, funding_tx);
728
729         mine_transaction(&nodes[0], &current_commitment_a);
730         mine_transaction(&nodes[1], &current_commitment_a);
731
732         check_closed_broadcast(&nodes[1], 1, true);
733         check_added_monitors(&nodes[1], 1);
734         check_closed_event(&nodes[1], 1, ClosureReason::CommitmentTxConfirmed, false, &[nodes[0].node.get_our_node_id()], 100000);
735
736         disconnect_blocks(&nodes[0], 1);
737         disconnect_blocks(&nodes[1], 1);
738
739         mine_transaction(&nodes[0], &prev_commitment_a);
740         mine_transaction(&nodes[1], &prev_commitment_a);
741
742         // Provide the preimage now, such that we only claim from the previous commitment (since it's
743         // currently confirmed) and not the latest.
744         get_monitor!(nodes[1], chan_id).provide_payment_preimage(
745                 &payment_hash, &payment_preimage, &nodes[1].tx_broadcaster,
746                 &LowerBoundedFeeEstimator(nodes[1].fee_estimator), &nodes[1].logger
747         );
748
749         let mut txn = nodes[1].tx_broadcaster.txn_broadcast();
750         assert_eq!(txn.len(), 1);
751         let htlc_preimage_tx = txn.pop().unwrap();
752         check_spends!(htlc_preimage_tx, prev_commitment_a);
753         // Make sure it was indeed a preimage claim and not a revocation claim since the previous
754         // commitment (still unrevoked) is the currently confirmed closing transaction.
755         assert_eq!(htlc_preimage_tx.input[0].witness.second_to_last().unwrap(), &payment_preimage.0[..]);
756 }