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