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