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, MessageSendEvent, MessageSendEventsProvider};
20 use util::ser::{ReadableArgs, Writeable};
22 use bitcoin::blockdata::block::{Block, BlockHeader};
23 use bitcoin::hash_types::BlockHash;
26 use std::collections::HashMap;
29 use ln::functional_test_utils::*;
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.
38 // Here we test both properties in any combination based on the two bools passed in as
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.
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);
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());
55 // Make sure all nodes are at the same starting height
56 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
57 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
58 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
60 let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
62 // Provide preimage to node 2 by claiming payment
63 nodes[2].node.claim_funds(our_payment_preimage);
64 check_added_monitors!(nodes[2], 1);
65 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
67 let mut header = BlockHeader { version: 0x2000_0000, prev_blockhash: nodes[2].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
68 let claim_txn = if local_commitment {
69 // Broadcast node 1 commitment txn to broadcast the HTLC-Timeout
70 let node_1_commitment_txn = get_local_commitment_txn!(nodes[1], chan_2.2);
71 assert_eq!(node_1_commitment_txn.len(), 2); // 1 local commitment tx, 1 Outbound HTLC-Timeout
72 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-self and Offered HTLC (to-remote/to-node-3 is dust)
73 check_spends!(node_1_commitment_txn[0], chan_2.3);
74 check_spends!(node_1_commitment_txn[1], node_1_commitment_txn[0]);
76 // Give node 2 node 1's transactions and get its response (claiming the HTLC instead).
77 connect_block(&nodes[2], &Block { header, txdata: node_1_commitment_txn.clone() });
78 check_added_monitors!(nodes[2], 1);
79 check_closed_broadcast!(nodes[2], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
80 let node_2_commitment_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
81 assert_eq!(node_2_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Claim, ChannelManger: 1 local commitment tx, 1 Received HTLC-Claim
82 assert_eq!(node_2_commitment_txn[1].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
83 check_spends!(node_2_commitment_txn[1], chan_2.3);
84 check_spends!(node_2_commitment_txn[2], node_2_commitment_txn[1]);
85 check_spends!(node_2_commitment_txn[0], node_1_commitment_txn[0]);
87 // Make sure node 1's height is the same as the !local_commitment case
88 connect_blocks(&nodes[1], 1);
89 // Confirm node 1's commitment txn (and HTLC-Timeout) on node 1
90 header.prev_blockhash = nodes[1].best_block_hash();
91 connect_block(&nodes[1], &Block { header, txdata: node_1_commitment_txn.clone() });
93 // ...but return node 1's commitment tx in case claim is set and we're preparing to reorg
94 vec![node_1_commitment_txn[0].clone(), node_2_commitment_txn[0].clone()]
96 // Broadcast node 2 commitment txn
97 let node_2_commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
98 assert_eq!(node_2_commitment_txn.len(), 2); // 1 local commitment tx, 1 Received HTLC-Claim
99 assert_eq!(node_2_commitment_txn[0].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
100 check_spends!(node_2_commitment_txn[0], chan_2.3);
101 check_spends!(node_2_commitment_txn[1], node_2_commitment_txn[0]);
103 // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
104 mine_transaction(&nodes[1], &node_2_commitment_txn[0]);
105 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
106 let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
107 assert_eq!(node_1_commitment_txn.len(), 2); // ChannelMonitor: 1 offered HTLC-Timeout, ChannelManger: 1 local commitment tx
108 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-local and Offered HTLC (to-remote is dust)
109 check_spends!(node_1_commitment_txn[0], chan_2.3);
110 check_spends!(node_1_commitment_txn[1], node_2_commitment_txn[0]);
112 // Confirm node 2's commitment txn (and node 1's HTLC-Timeout) on node 1
113 header.prev_blockhash = nodes[1].best_block_hash();
114 let block = Block { header, txdata: vec![node_2_commitment_txn[0].clone(), node_1_commitment_txn[1].clone()] };
115 connect_block(&nodes[1], &block);
116 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
117 node_2_commitment_txn
119 check_added_monitors!(nodes[1], 1);
120 check_closed_broadcast!(nodes[1], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
121 // Connect ANTI_REORG_DELAY - 2 blocks, giving us a confirmation count of ANTI_REORG_DELAY - 1.
122 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
123 check_added_monitors!(nodes[1], 0);
124 assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
127 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
130 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
133 connect_block(&nodes[1], &block);
135 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
136 // probe it for events, so we probe non-message events here (which should still end up empty):
137 assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
139 // Confirm the timeout tx and check that we fail the HTLC backwards
141 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
144 connect_block(&nodes[1], &block);
145 expect_pending_htlcs_forwardable!(nodes[1]);
148 check_added_monitors!(nodes[1], 1);
149 // Which should result in an immediate claim/fail of the HTLC:
150 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
152 assert_eq!(htlc_updates.update_fulfill_htlcs.len(), 1);
153 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fulfill_htlcs[0]);
155 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
156 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
158 commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false, true);
160 expect_payment_sent!(nodes[0], our_payment_preimage);
162 let events = nodes[0].node.get_and_clear_pending_msg_events();
163 assert_eq!(events.len(), 1);
164 if let MessageSendEvent::PaymentFailureNetworkUpdate { update: HTLCFailChannelUpdate::ChannelClosed { ref is_permanent, .. } } = events[0] {
165 assert!(is_permanent);
166 } else { panic!("Unexpected event!"); }
167 expect_payment_failed!(nodes[0], our_payment_hash, false);
172 fn test_onchain_htlc_claim_reorg_local_commitment() {
173 do_test_onchain_htlc_reorg(true, true);
176 fn test_onchain_htlc_timeout_delay_local_commitment() {
177 do_test_onchain_htlc_reorg(true, false);
180 fn test_onchain_htlc_claim_reorg_remote_commitment() {
181 do_test_onchain_htlc_reorg(false, true);
184 fn test_onchain_htlc_timeout_delay_remote_commitment() {
185 do_test_onchain_htlc_reorg(false, false);
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;
201 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
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);
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]);
214 disconnect_all_blocks(&nodes[0]);
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.");
219 handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.");
221 check_added_monitors!(nodes[1], 1);
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);
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();
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());
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(),
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,
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();
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);
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]);
282 disconnect_all_blocks(&nodes[0]);
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.");
287 handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.");
289 check_added_monitors!(nodes[1], 1);
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);
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();
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);
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);
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);
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);
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);
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);
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;
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]);
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();
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
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);
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);
401 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
402 mine_transaction(&nodes[0], &partial_claim_tx);
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
410 nodes[0].node.get_and_clear_pending_msg_events();
412 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
413 disconnect_blocks(&nodes[0], 1);
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
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);
426 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
427 assert_eq!(node_txn.len(), 0);