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