1 // This file is Copyright its original authors, visible in version control
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
10 //! Further functional tests which test blockchain reorganizations.
12 use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor};
13 use chain::{Confirm, Watch};
14 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs};
15 use ln::features::InitFeatures;
16 use ln::msgs::{ChannelMessageHandler, ErrorAction, HTLCFailChannelUpdate};
17 use util::enforcing_trait_impls::EnforcingSigner;
18 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
20 use util::ser::{ReadableArgs, Writeable};
22 use bitcoin::blockdata::block::{Block, BlockHeader};
23 use bitcoin::hash_types::BlockHash;
25 use std::collections::HashMap;
28 use ln::functional_test_utils::*;
30 fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
31 // Our on-chain HTLC-claim learning has a few properties worth testing:
32 // * If an upstream HTLC is claimed with a preimage (both against our own commitment
33 // transaction our counterparty's), we claim it backwards immediately.
34 // * If an upstream HTLC is claimed with a timeout, we delay ANTI_REORG_DELAY before failing
35 // it backwards to ensure our counterparty can't claim with a preimage in a reorg.
37 // Here we test both properties in any combination based on the two bools passed in as
40 // If local_commitment is set, we first broadcast a local commitment containing an offered HTLC
41 // and an HTLC-Timeout tx, otherwise we broadcast a remote commitment containing a received
42 // HTLC and a local HTLC-Timeout tx spending it.
44 // We then either allow these transactions to confirm (if !claim) or we wait until one block
45 // before they otherwise would and reorg them out, confirming an HTLC-Success tx instead.
46 let chanmon_cfgs = create_chanmon_cfgs(3);
47 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
48 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
49 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
51 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
52 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
54 // Make sure all nodes are at the same starting height
55 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
56 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
57 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
59 let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
61 // Provide preimage to node 2 by claiming payment
62 nodes[2].node.claim_funds(our_payment_preimage);
63 check_added_monitors!(nodes[2], 1);
64 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
66 let mut header = BlockHeader { version: 0x2000_0000, prev_blockhash: nodes[2].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
67 let claim_txn = if local_commitment {
68 // Broadcast node 1 commitment txn to broadcast the HTLC-Timeout
69 let node_1_commitment_txn = get_local_commitment_txn!(nodes[1], chan_2.2);
70 assert_eq!(node_1_commitment_txn.len(), 2); // 1 local commitment tx, 1 Outbound HTLC-Timeout
71 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-self and Offered HTLC (to-remote/to-node-3 is dust)
72 check_spends!(node_1_commitment_txn[0], chan_2.3);
73 check_spends!(node_1_commitment_txn[1], node_1_commitment_txn[0]);
75 // Give node 2 node 1's transactions and get its response (claiming the HTLC instead).
76 connect_block(&nodes[2], &Block { header, txdata: node_1_commitment_txn.clone() });
77 check_added_monitors!(nodes[2], 1);
78 check_closed_broadcast!(nodes[2], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
79 let node_2_commitment_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
80 assert_eq!(node_2_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Claim, ChannelManger: 1 local commitment tx, 1 Received HTLC-Claim
81 assert_eq!(node_2_commitment_txn[1].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
82 check_spends!(node_2_commitment_txn[1], chan_2.3);
83 check_spends!(node_2_commitment_txn[2], node_2_commitment_txn[1]);
84 check_spends!(node_2_commitment_txn[0], node_1_commitment_txn[0]);
86 // Make sure node 1's height is the same as the !local_commitment case
87 connect_blocks(&nodes[1], 1);
88 // Confirm node 1's commitment txn (and HTLC-Timeout) on node 1
89 header.prev_blockhash = nodes[1].best_block_hash();
90 connect_block(&nodes[1], &Block { header, txdata: node_1_commitment_txn.clone() });
92 // ...but return node 1's commitment tx in case claim is set and we're preparing to reorg
93 vec![node_1_commitment_txn[0].clone(), node_2_commitment_txn[0].clone()]
95 // Broadcast node 2 commitment txn
96 let node_2_commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
97 assert_eq!(node_2_commitment_txn.len(), 2); // 1 local commitment tx, 1 Received HTLC-Claim
98 assert_eq!(node_2_commitment_txn[0].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
99 check_spends!(node_2_commitment_txn[0], chan_2.3);
100 check_spends!(node_2_commitment_txn[1], node_2_commitment_txn[0]);
102 // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
103 mine_transaction(&nodes[1], &node_2_commitment_txn[0]);
104 let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
105 assert_eq!(node_1_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Timeout, ChannelManger: 1 local commitment tx, 1 Offered HTLC-Timeout
106 assert_eq!(node_1_commitment_txn[1].output.len(), 2); // to-local and Offered HTLC (to-remote is dust)
107 check_spends!(node_1_commitment_txn[1], chan_2.3);
108 check_spends!(node_1_commitment_txn[2], node_1_commitment_txn[1]);
109 check_spends!(node_1_commitment_txn[0], node_2_commitment_txn[0]);
111 // Confirm node 2's commitment txn (and node 1's HTLC-Timeout) on node 1
112 header.prev_blockhash = nodes[1].best_block_hash();
113 connect_block(&nodes[1], &Block { header, txdata: vec![node_2_commitment_txn[0].clone(), node_1_commitment_txn[0].clone()] });
114 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
115 node_2_commitment_txn
117 check_added_monitors!(nodes[1], 1);
118 check_closed_broadcast!(nodes[1], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
119 // Connect ANTI_REORG_DELAY - 2 blocks, giving us a confirmation count of ANTI_REORG_DELAY - 1.
120 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
121 check_added_monitors!(nodes[1], 0);
122 assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
125 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
128 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
131 connect_block(&nodes[1], &block);
133 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
134 // probe it for events, so we probe non-message events here (which should still end up empty):
135 assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
137 // Confirm the timeout tx and check that we fail the HTLC backwards
139 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
142 connect_block(&nodes[1], &block);
143 expect_pending_htlcs_forwardable!(nodes[1]);
146 check_added_monitors!(nodes[1], 1);
147 // Which should result in an immediate claim/fail of the HTLC:
148 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
150 assert_eq!(htlc_updates.update_fulfill_htlcs.len(), 1);
151 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fulfill_htlcs[0]);
153 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
154 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
156 commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false, true);
158 expect_payment_sent!(nodes[0], our_payment_preimage);
160 let events = nodes[0].node.get_and_clear_pending_msg_events();
161 assert_eq!(events.len(), 1);
162 if let MessageSendEvent::PaymentFailureNetworkUpdate { update: HTLCFailChannelUpdate::ChannelClosed { ref is_permanent, .. } } = events[0] {
163 assert!(is_permanent);
164 } else { panic!("Unexpected event!"); }
165 expect_payment_failed!(nodes[0], our_payment_hash, false);
170 fn test_onchain_htlc_claim_reorg_local_commitment() {
171 do_test_onchain_htlc_reorg(true, true);
174 fn test_onchain_htlc_timeout_delay_local_commitment() {
175 do_test_onchain_htlc_reorg(true, false);
178 fn test_onchain_htlc_claim_reorg_remote_commitment() {
179 do_test_onchain_htlc_reorg(false, true);
182 fn test_onchain_htlc_timeout_delay_remote_commitment() {
183 do_test_onchain_htlc_reorg(false, false);
186 fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, use_funding_unconfirmed: bool, connect_style: ConnectStyle) {
187 // After creating a chan between nodes, we disconnect all blocks previously seen to force a
188 // channel close on nodes[0] side. We also use this to provide very basic testing of logic
189 // around freeing background events which store monitor updates during block_[dis]connected.
190 let chanmon_cfgs = create_chanmon_cfgs(2);
191 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
192 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
193 let persister: test_utils::TestPersister;
194 let new_chain_monitor: test_utils::TestChainMonitor;
195 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
196 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
197 *nodes[0].connect_style.borrow_mut() = connect_style;
199 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
201 let channel_state = nodes[0].node.channel_state.lock().unwrap();
202 assert_eq!(channel_state.by_id.len(), 1);
203 assert_eq!(channel_state.short_to_id.len(), 1);
204 mem::drop(channel_state);
206 if !reorg_after_reload {
207 if use_funding_unconfirmed {
208 let relevant_txids = nodes[0].node.get_relevant_txids();
209 assert_eq!(&relevant_txids[..], &[chan.3.txid()]);
210 nodes[0].node.transaction_unconfirmed(&relevant_txids[0]);
212 disconnect_all_blocks(&nodes[0]);
214 if connect_style == ConnectStyle::FullBlockViaListen && !use_funding_unconfirmed {
215 handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Funding transaction was un-confirmed. Locked at 6 confs, now have 2 confs.");
217 handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.");
219 check_added_monitors!(nodes[1], 1);
221 let channel_state = nodes[0].node.channel_state.lock().unwrap();
222 assert_eq!(channel_state.by_id.len(), 0);
223 assert_eq!(channel_state.short_to_id.len(), 0);
228 // Since we currently have a background event pending, it's good to test that we survive a
229 // serialization roundtrip. Further, this tests the somewhat awkward edge-case of dropping
230 // the Channel object from the ChannelManager, but still having a monitor event pending for
231 // it when we go to deserialize, and then use the ChannelManager.
232 let nodes_0_serialized = nodes[0].node.encode();
233 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
234 nodes[0].chain_monitor.chain_monitor.monitors.read().unwrap().iter().next().unwrap().1.write(&mut chan_0_monitor_serialized).unwrap();
236 persister = test_utils::TestPersister::new();
237 let keys_manager = &chanmon_cfgs[0].keys_manager;
238 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);
239 nodes[0].chain_monitor = &new_chain_monitor;
240 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
241 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
242 &mut chan_0_monitor_read, keys_manager).unwrap();
243 assert!(chan_0_monitor_read.is_empty());
245 let mut nodes_0_read = &nodes_0_serialized[..];
246 nodes_0_deserialized = {
247 let mut channel_monitors = HashMap::new();
248 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
249 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster,
250 &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(
251 &mut nodes_0_read, ChannelManagerReadArgs {
252 default_config: *nodes[0].node.get_current_default_configuration(),
254 fee_estimator: node_cfgs[0].fee_estimator,
255 chain_monitor: nodes[0].chain_monitor,
256 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
257 logger: nodes[0].logger,
261 nodes[0].node = &nodes_0_deserialized;
262 assert!(nodes_0_read.is_empty());
263 if !reorg_after_reload {
264 // If the channel is already closed when we reload the node, we'll broadcast a closing
265 // transaction via the ChannelMonitor which is missing a corresponding channel.
266 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
267 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
270 nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0.clone(), chan_0_monitor).unwrap();
271 check_added_monitors!(nodes[0], 1);
274 if reorg_after_reload {
275 if use_funding_unconfirmed {
276 let relevant_txids = nodes[0].node.get_relevant_txids();
277 assert_eq!(&relevant_txids[..], &[chan.3.txid()]);
278 nodes[0].node.transaction_unconfirmed(&relevant_txids[0]);
280 disconnect_all_blocks(&nodes[0]);
282 if connect_style == ConnectStyle::FullBlockViaListen && !use_funding_unconfirmed {
283 handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Funding transaction was un-confirmed. Locked at 6 confs, now have 2 confs.");
285 handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.");
287 check_added_monitors!(nodes[1], 1);
289 let channel_state = nodes[0].node.channel_state.lock().unwrap();
290 assert_eq!(channel_state.by_id.len(), 0);
291 assert_eq!(channel_state.short_to_id.len(), 0);
294 // With expect_channel_force_closed set the TestChainMonitor will enforce that the next update
295 // is a ChannelForcClosed on the right channel with should_broadcast set.
296 *nodes[0].chain_monitor.expect_channel_force_closed.lock().unwrap() = Some((chan.2, true));
297 nodes[0].node.test_process_background_events(); // Required to free the pending background monitor update
298 check_added_monitors!(nodes[0], 1);
299 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
300 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
302 // Now check that we can create a new channel
303 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
304 send_payment(&nodes[0], &[&nodes[1]], 8000000);
308 fn test_unconf_chan() {
309 do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
310 do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
311 do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
312 do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
316 fn test_unconf_chan_via_listen() {
317 do_test_unconf_chan(true, true, false, ConnectStyle::FullBlockViaListen);
318 do_test_unconf_chan(false, true, false, ConnectStyle::FullBlockViaListen);
319 do_test_unconf_chan(true, false, false, ConnectStyle::FullBlockViaListen);
320 do_test_unconf_chan(false, false, false, ConnectStyle::FullBlockViaListen);
324 fn test_unconf_chan_via_funding_unconfirmed() {
325 do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
326 do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
327 do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
328 do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
330 do_test_unconf_chan(true, true, true, ConnectStyle::FullBlockViaListen);
331 do_test_unconf_chan(false, true, true, ConnectStyle::FullBlockViaListen);
332 do_test_unconf_chan(true, false, true, ConnectStyle::FullBlockViaListen);
333 do_test_unconf_chan(false, false, true, ConnectStyle::FullBlockViaListen);
337 fn test_set_outpoints_partial_claiming() {
338 // - remote party claim tx, new bump tx
339 // - disconnect remote claiming tx, new bump
340 // - disconnect tx, see no tx anymore
341 let chanmon_cfgs = create_chanmon_cfgs(2);
342 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
343 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
344 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
346 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
347 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
348 let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
350 // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
351 let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
352 assert_eq!(remote_txn.len(), 3);
353 assert_eq!(remote_txn[0].output.len(), 4);
354 assert_eq!(remote_txn[0].input.len(), 1);
355 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
356 check_spends!(remote_txn[1], remote_txn[0]);
357 check_spends!(remote_txn[2], remote_txn[0]);
359 // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
360 // Provide node A with both preimage
361 nodes[0].node.claim_funds(payment_preimage_1);
362 nodes[0].node.claim_funds(payment_preimage_2);
363 check_added_monitors!(nodes[0], 2);
364 nodes[0].node.get_and_clear_pending_events();
365 nodes[0].node.get_and_clear_pending_msg_events();
367 // Connect blocks on node A commitment transaction
368 mine_transaction(&nodes[0], &remote_txn[0]);
369 check_closed_broadcast!(nodes[0], true);
370 check_added_monitors!(nodes[0], 1);
371 // Verify node A broadcast tx claiming both HTLCs
373 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
374 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
375 assert_eq!(node_txn.len(), 4);
376 check_spends!(node_txn[0], remote_txn[0]);
377 check_spends!(node_txn[1], chan.3);
378 check_spends!(node_txn[2], node_txn[1]);
379 check_spends!(node_txn[3], node_txn[1]);
380 assert_eq!(node_txn[0].input.len(), 2);
384 // Connect blocks on node B
385 connect_blocks(&nodes[1], 135);
386 check_closed_broadcast!(nodes[1], true);
387 check_added_monitors!(nodes[1], 1);
388 // Verify node B broadcast 2 HTLC-timeout txn
389 let partial_claim_tx = {
390 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
391 assert_eq!(node_txn.len(), 3);
392 check_spends!(node_txn[1], node_txn[0]);
393 check_spends!(node_txn[2], node_txn[0]);
394 assert_eq!(node_txn[1].input.len(), 1);
395 assert_eq!(node_txn[2].input.len(), 1);
399 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
400 mine_transaction(&nodes[0], &partial_claim_tx);
402 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
403 assert_eq!(node_txn.len(), 1);
404 check_spends!(node_txn[0], remote_txn[0]);
405 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
408 nodes[0].node.get_and_clear_pending_msg_events();
410 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
411 disconnect_blocks(&nodes[0], 1);
413 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
414 assert_eq!(node_txn.len(), 1);
415 check_spends!(node_txn[0], remote_txn[0]);
416 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
420 //// Disconnect one more block and then reconnect multiple no transaction should be generated
421 disconnect_blocks(&nodes[0], 1);
422 connect_blocks(&nodes[0], 15);
424 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
425 assert_eq!(node_txn.len(), 0);