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