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