Clarify ChannelManager docs somewhat around full blocks
[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::Watch;
14 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs};
15 use ln::features::InitFeatures;
16 use ln::msgs::{ChannelMessageHandler, ErrorAction, HTLCFailChannelUpdate};
17 use util::config::UserConfig;
18 use util::enforcing_trait_impls::EnforcingSigner;
19 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
20 use util::test_utils;
21 use util::ser::{ReadableArgs, Writeable};
22
23 use bitcoin::blockdata::block::{Block, BlockHeader};
24 use bitcoin::hash_types::BlockHash;
25
26 use std::collections::HashMap;
27 use std::mem;
28
29 use ln::functional_test_utils::*;
30
31 fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
32         // Our on-chain HTLC-claim learning has a few properties worth testing:
33         //  * If an upstream HTLC is claimed with a preimage (both against our own commitment
34         //    transaction our counterparty's), we claim it backwards immediately.
35         //  * If an upstream HTLC is claimed with a timeout, we delay ANTI_REORG_DELAY before failing
36         //    it backwards to ensure our counterparty can't claim with a preimage in a reorg.
37         //
38         // Here we test both properties in any combination based on the two bools passed in as
39         // arguments.
40         //
41         // If local_commitment is set, we first broadcast a local commitment containing an offered HTLC
42         // and an HTLC-Timeout tx, otherwise we broadcast a remote commitment containing a received
43         // HTLC and a local HTLC-Timeout tx spending it.
44         //
45         // We then either allow these transactions to confirm (if !claim) or we wait until one block
46         // before they otherwise would and reorg them out, confirming an HTLC-Success tx instead.
47         let chanmon_cfgs = create_chanmon_cfgs(3);
48         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
49         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
50         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
51
52         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
53         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
54
55         let (our_payment_preimage, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
56
57         // Provide preimage to node 2 by claiming payment
58         nodes[2].node.claim_funds(our_payment_preimage, &None, 1000000);
59         check_added_monitors!(nodes[2], 1);
60         get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
61
62         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
63         let claim_txn = if local_commitment {
64                 // Broadcast node 1 commitment txn to broadcast the HTLC-Timeout
65                 let node_1_commitment_txn = get_local_commitment_txn!(nodes[1], chan_2.2);
66                 assert_eq!(node_1_commitment_txn.len(), 2); // 1 local commitment tx, 1 Outbound HTLC-Timeout
67                 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-self and Offered HTLC (to-remote/to-node-3 is dust)
68                 check_spends!(node_1_commitment_txn[0], chan_2.3);
69                 check_spends!(node_1_commitment_txn[1], node_1_commitment_txn[0]);
70
71                 // Give node 2 node 1's transactions and get its response (claiming the HTLC instead).
72                 connect_block(&nodes[2], &Block { header, txdata: node_1_commitment_txn.clone() }, CHAN_CONFIRM_DEPTH + 1);
73                 check_added_monitors!(nodes[2], 1);
74                 check_closed_broadcast!(nodes[2], false); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
75                 let node_2_commitment_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
76                 assert_eq!(node_2_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Claim, ChannelManger: 1 local commitment tx, 1 Received HTLC-Claim
77                 assert_eq!(node_2_commitment_txn[1].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
78                 check_spends!(node_2_commitment_txn[1], chan_2.3);
79                 check_spends!(node_2_commitment_txn[2], node_2_commitment_txn[1]);
80                 check_spends!(node_2_commitment_txn[0], node_1_commitment_txn[0]);
81
82                 // Confirm node 1's commitment txn (and HTLC-Timeout) on node 1
83                 connect_block(&nodes[1], &Block { header, txdata: node_1_commitment_txn.clone() }, CHAN_CONFIRM_DEPTH + 1);
84
85                 // ...but return node 1's commitment tx in case claim is set and we're preparing to reorg
86                 vec![node_1_commitment_txn[0].clone(), node_2_commitment_txn[0].clone()]
87         } else {
88                 // Broadcast node 2 commitment txn
89                 let node_2_commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
90                 assert_eq!(node_2_commitment_txn.len(), 2); // 1 local commitment tx, 1 Received HTLC-Claim
91                 assert_eq!(node_2_commitment_txn[0].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
92                 check_spends!(node_2_commitment_txn[0], chan_2.3);
93                 check_spends!(node_2_commitment_txn[1], node_2_commitment_txn[0]);
94
95                 // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
96                 connect_block(&nodes[1], &Block { header, txdata: vec![node_2_commitment_txn[0].clone()] }, CHAN_CONFIRM_DEPTH + 1);
97                 let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
98                 assert_eq!(node_1_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Timeout, ChannelManger: 1 local commitment tx, 1 Offered HTLC-Timeout
99                 assert_eq!(node_1_commitment_txn[1].output.len(), 2); // to-local and Offered HTLC (to-remote is dust)
100                 check_spends!(node_1_commitment_txn[1], chan_2.3);
101                 check_spends!(node_1_commitment_txn[2], node_1_commitment_txn[1]);
102                 check_spends!(node_1_commitment_txn[0], node_2_commitment_txn[0]);
103
104                 // Confirm node 2's commitment txn (and node 1's HTLC-Timeout) on node 1
105                 connect_block(&nodes[1], &Block { header, txdata: vec![node_2_commitment_txn[0].clone(), node_1_commitment_txn[0].clone()] }, CHAN_CONFIRM_DEPTH + 1);
106                 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
107                 node_2_commitment_txn
108         };
109         check_added_monitors!(nodes[1], 1);
110         check_closed_broadcast!(nodes[1], false); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
111         let mut block = Block { header, txdata: vec![] };
112         let mut blocks = Vec::new();
113         blocks.push(block.clone());
114         // At CHAN_CONFIRM_DEPTH + 1 we have a confirmation count of 1, so CHAN_CONFIRM_DEPTH +
115         // ANTI_REORG_DELAY - 1 will give us a confirmation count of ANTI_REORG_DELAY - 1.
116         for i in CHAN_CONFIRM_DEPTH + 2..CHAN_CONFIRM_DEPTH + ANTI_REORG_DELAY - 1 {
117                 block = Block {
118                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
119                         txdata: vec![],
120                 };
121                 connect_block(&nodes[1], &block, i);
122                 blocks.push(block.clone());
123         }
124         check_added_monitors!(nodes[1], 0);
125         assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
126
127         if claim {
128                 // Now reorg back to CHAN_CONFIRM_DEPTH and confirm node 2's broadcasted transactions:
129                 for (height, block) in (CHAN_CONFIRM_DEPTH + 1..CHAN_CONFIRM_DEPTH + ANTI_REORG_DELAY - 1).zip(blocks.iter()).rev() {
130                         disconnect_block(&nodes[1], &block.header, height);
131                 }
132
133                 block = Block {
134                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
135                         txdata: claim_txn,
136                 };
137                 connect_block(&nodes[1], &block, CHAN_CONFIRM_DEPTH + 1);
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 still end up empty):
141                 assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
142         } else {
143                 // Confirm the timeout tx and check that we fail the HTLC backwards
144                 block = Block {
145                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
146                         txdata: vec![],
147                 };
148                 connect_block(&nodes[1], &block, CHAN_CONFIRM_DEPTH + ANTI_REORG_DELAY);
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) {
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         let chan_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
204
205         let channel_state = nodes[0].node.channel_state.lock().unwrap();
206         assert_eq!(channel_state.by_id.len(), 1);
207         assert_eq!(channel_state.short_to_id.len(), 1);
208         mem::drop(channel_state);
209
210         let mut headers = Vec::new();
211         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
212         headers.push(header.clone());
213         for _i in 2..100 {
214                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
215                 headers.push(header.clone());
216         }
217         if !reorg_after_reload {
218                 while !headers.is_empty() {
219                         nodes[0].node.block_disconnected(&headers.pop().unwrap());
220                 }
221                 check_closed_broadcast!(nodes[0], false);
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) = <(Option<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                 let config = UserConfig::default();
249                 nodes_0_deserialized = {
250                         let mut channel_monitors = HashMap::new();
251                         channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
252                         <(Option<BlockHash>, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster,
253                           &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(
254                                 &mut nodes_0_read, ChannelManagerReadArgs {
255                                         default_config: config,
256                                         keys_manager,
257                                         fee_estimator: node_cfgs[0].fee_estimator,
258                                         chain_monitor: nodes[0].chain_monitor,
259                                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
260                                         logger: nodes[0].logger,
261                                         channel_monitors,
262                         }).unwrap().1
263                 };
264                 nodes[0].node = &nodes_0_deserialized;
265                 assert!(nodes_0_read.is_empty());
266
267                 nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0.clone(), chan_0_monitor).unwrap();
268                 check_added_monitors!(nodes[0], 1);
269         }
270
271         if reorg_after_reload {
272                 while !headers.is_empty() {
273                         nodes[0].node.block_disconnected(&headers.pop().unwrap());
274                 }
275                 check_closed_broadcast!(nodes[0], false);
276                 {
277                         let channel_state = nodes[0].node.channel_state.lock().unwrap();
278                         assert_eq!(channel_state.by_id.len(), 0);
279                         assert_eq!(channel_state.short_to_id.len(), 0);
280                 }
281         }
282
283         // With expect_channel_force_closed set the TestChainMonitor will enforce that the next update
284         // is a ChannelForcClosed on the right channel with should_broadcast set.
285         *nodes[0].chain_monitor.expect_channel_force_closed.lock().unwrap() = Some((chan_id, true));
286         nodes[0].node.test_process_background_events(); // Required to free the pending background monitor update
287         check_added_monitors!(nodes[0], 1);
288 }
289
290 #[test]
291 fn test_unconf_chan() {
292         do_test_unconf_chan(true, true);
293         do_test_unconf_chan(false, true);
294         do_test_unconf_chan(true, false);
295         do_test_unconf_chan(false, false);
296 }
297
298 #[test]
299 fn test_set_outpoints_partial_claiming() {
300         // - remote party claim tx, new bump tx
301         // - disconnect remote claiming tx, new bump
302         // - disconnect tx, see no tx anymore
303         let chanmon_cfgs = create_chanmon_cfgs(2);
304         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
305         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
306         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
307
308         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
309         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
310         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
311
312         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
313         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
314         assert_eq!(remote_txn.len(), 3);
315         assert_eq!(remote_txn[0].output.len(), 4);
316         assert_eq!(remote_txn[0].input.len(), 1);
317         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
318         check_spends!(remote_txn[1], remote_txn[0]);
319         check_spends!(remote_txn[2], remote_txn[0]);
320
321         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
322         let prev_header_100 = connect_blocks(&nodes[1], 100, 0, false, Default::default());
323         // Provide node A with both preimage
324         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
325         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
326         check_added_monitors!(nodes[0], 2);
327         nodes[0].node.get_and_clear_pending_events();
328         nodes[0].node.get_and_clear_pending_msg_events();
329
330         // Connect blocks on node A commitment transaction
331         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
332         connect_block(&nodes[0], &Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
333         check_closed_broadcast!(nodes[0], false);
334         check_added_monitors!(nodes[0], 1);
335         // Verify node A broadcast tx claiming both HTLCs
336         {
337                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
338                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
339                 assert_eq!(node_txn.len(), 4);
340                 check_spends!(node_txn[0], remote_txn[0]);
341                 check_spends!(node_txn[1], chan.3);
342                 check_spends!(node_txn[2], node_txn[1]);
343                 check_spends!(node_txn[3], node_txn[1]);
344                 assert_eq!(node_txn[0].input.len(), 2);
345                 node_txn.clear();
346         }
347
348         // Connect blocks on node B
349         connect_blocks(&nodes[1], 135, 0, false, Default::default());
350         check_closed_broadcast!(nodes[1], false);
351         check_added_monitors!(nodes[1], 1);
352         // Verify node B broadcast 2 HTLC-timeout txn
353         let partial_claim_tx = {
354                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
355                 assert_eq!(node_txn.len(), 3);
356                 check_spends!(node_txn[1], node_txn[0]);
357                 check_spends!(node_txn[2], node_txn[0]);
358                 assert_eq!(node_txn[1].input.len(), 1);
359                 assert_eq!(node_txn[2].input.len(), 1);
360                 node_txn[1].clone()
361         };
362
363         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
364         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
365         connect_block(&nodes[0], &Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
366         {
367                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
368                 assert_eq!(node_txn.len(), 1);
369                 check_spends!(node_txn[0], remote_txn[0]);
370                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
371                 node_txn.clear();
372         }
373         nodes[0].node.get_and_clear_pending_msg_events();
374
375         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
376         disconnect_block(&nodes[0], &header, 102);
377         {
378                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
379                 assert_eq!(node_txn.len(), 1);
380                 check_spends!(node_txn[0], remote_txn[0]);
381                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
382                 node_txn.clear();
383         }
384
385         //// Disconnect one more block and then reconnect multiple no transaction should be generated
386         disconnect_block(&nodes[0], &header, 101);
387         connect_blocks(&nodes[1], 15, 101, false, prev_header_100);
388         {
389                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
390                 assert_eq!(node_txn.len(), 0);
391                 node_txn.clear();
392         }
393 }