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 crate::chain::channelmonitor::ANTI_REORG_DELAY;
13 use crate::chain::transaction::OutPoint;
14 use crate::chain::Confirm;
15 use crate::ln::channelmanager::ChannelManager;
16 use crate::ln::msgs::{ChannelMessageHandler, Init};
17 use crate::util::events::{Event, MessageSendEventsProvider, ClosureReason, HTLCDestination};
18 use crate::util::test_utils;
19 use crate::util::ser::Writeable;
21 use bitcoin::blockdata::block::{Block, BlockHeader};
22 use bitcoin::blockdata::script::Builder;
23 use bitcoin::blockdata::opcodes;
24 use bitcoin::secp256k1::Secp256k1;
26 use crate::prelude::*;
27 use bitcoin::hashes::Hash;
28 use bitcoin::TxMerkleNode;
30 use crate::ln::functional_test_utils::*;
32 fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
33 // Our on-chain HTLC-claim learning has a few properties worth testing:
34 // * If an upstream HTLC is claimed with a preimage (both against our own commitment
35 // transaction our counterparty's), we claim it backwards immediately.
36 // * If an upstream HTLC is claimed with a timeout, we delay ANTI_REORG_DELAY before failing
37 // it backwards to ensure our counterparty can't claim with a preimage in a reorg.
39 // Here we test both properties in any combination based on the two bools passed in as
42 // If local_commitment is set, we first broadcast a local commitment containing an offered HTLC
43 // and an HTLC-Timeout tx, otherwise we broadcast a remote commitment containing a received
44 // HTLC and a local HTLC-Timeout tx spending it.
46 // We then either allow these transactions to confirm (if !claim) or we wait until one block
47 // before they otherwise would and reorg them out, confirming an HTLC-Success tx instead.
48 let chanmon_cfgs = create_chanmon_cfgs(3);
49 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
50 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
51 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
53 create_announced_chan_between_nodes(&nodes, 0, 1);
54 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
56 // Make sure all nodes are at the same starting height
57 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
58 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
59 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
61 let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
63 // Provide preimage to node 2 by claiming payment
64 nodes[2].node.claim_funds(our_payment_preimage);
65 expect_payment_claimed!(nodes[2], our_payment_hash, 1_000_000);
66 check_added_monitors!(nodes[2], 1);
67 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
69 let mut header = BlockHeader { version: 0x2000_0000, prev_blockhash: nodes[2].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 };
70 let claim_txn = if local_commitment {
71 // Broadcast node 1 commitment txn to broadcast the HTLC-Timeout
72 let node_1_commitment_txn = get_local_commitment_txn!(nodes[1], chan_2.2);
73 assert_eq!(node_1_commitment_txn.len(), 2); // 1 local commitment tx, 1 Outbound HTLC-Timeout
74 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-self and Offered HTLC (to-remote/to-node-3 is dust)
75 check_spends!(node_1_commitment_txn[0], chan_2.3);
76 check_spends!(node_1_commitment_txn[1], node_1_commitment_txn[0]);
78 // Give node 2 node 1's transactions and get its response (claiming the HTLC instead).
79 connect_block(&nodes[2], &Block { header, txdata: node_1_commitment_txn.clone() });
80 check_added_monitors!(nodes[2], 1);
81 check_closed_broadcast!(nodes[2], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
82 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
83 let node_2_commitment_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
84 assert_eq!(node_2_commitment_txn.len(), 1); // ChannelMonitor: 1 offered HTLC-Claim
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 mut 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(), 1); // ChannelMonitor: 1 offered HTLC-Timeout
108 check_spends!(node_1_commitment_txn[0], node_2_commitment_txn[0]);
110 // Confirm node 1's HTLC-Timeout on node 1
111 mine_transaction(&nodes[1], &node_1_commitment_txn[0]);
112 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
113 vec![node_2_commitment_txn.pop().unwrap()]
115 check_added_monitors!(nodes[1], 1);
116 check_closed_broadcast!(nodes[1], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
117 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
118 // Connect ANTI_REORG_DELAY - 2 blocks, giving us a confirmation count of ANTI_REORG_DELAY - 1.
119 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
120 check_added_monitors!(nodes[1], 0);
121 assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
124 // Disconnect Node 1's HTLC-Timeout which was connected above
125 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
128 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), 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 just be the
135 // PaymentForwarded event).
136 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), true, true);
138 // Confirm the timeout tx and check that we fail the HTLC backwards
140 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
143 connect_block(&nodes[1], &block);
144 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::NextHopChannel { node_id: Some(nodes[2].node.get_our_node_id()), channel_id: chan_2.2 }]);
147 check_added_monitors!(nodes[1], 1);
148 // Which should result in an immediate claim/fail of the HTLC:
149 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
151 assert_eq!(htlc_updates.update_fulfill_htlcs.len(), 1);
152 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fulfill_htlcs[0]);
154 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
155 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
157 commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false, true);
159 expect_payment_sent!(nodes[0], our_payment_preimage);
161 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
166 fn test_onchain_htlc_claim_reorg_local_commitment() {
167 do_test_onchain_htlc_reorg(true, true);
170 fn test_onchain_htlc_timeout_delay_local_commitment() {
171 do_test_onchain_htlc_reorg(true, false);
174 fn test_onchain_htlc_claim_reorg_remote_commitment() {
175 do_test_onchain_htlc_reorg(false, true);
178 fn test_onchain_htlc_timeout_delay_remote_commitment() {
179 do_test_onchain_htlc_reorg(false, false);
183 fn test_counterparty_revoked_reorg() {
184 // Test what happens when a revoked counterparty transaction is broadcast but then reorg'd out
185 // of the main chain. Specifically, HTLCs in the latest commitment transaction which are not
186 // included in the revoked commitment transaction should not be considered failed, and should
187 // still be claim-from-able after the reorg.
188 let chanmon_cfgs = create_chanmon_cfgs(2);
189 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
190 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
191 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
193 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000);
195 // Get the initial commitment transaction for broadcast, before any HTLCs are added at all.
196 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
197 assert_eq!(revoked_local_txn.len(), 1);
199 // Now add two HTLCs in each direction, one dust and one not.
200 route_payment(&nodes[0], &[&nodes[1]], 5_000_000);
201 route_payment(&nodes[0], &[&nodes[1]], 5_000);
202 let (payment_preimage_3, payment_hash_3, ..) = route_payment(&nodes[1], &[&nodes[0]], 4_000_000);
203 let payment_hash_4 = route_payment(&nodes[1], &[&nodes[0]], 4_000).1;
205 nodes[0].node.claim_funds(payment_preimage_3);
206 let _ = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
207 check_added_monitors!(nodes[0], 1);
208 expect_payment_claimed!(nodes[0], payment_hash_3, 4_000_000);
210 let mut unrevoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
211 assert_eq!(unrevoked_local_txn.len(), 3); // commitment + 2 HTLC txn
212 // Sort the unrevoked transactions in reverse order, ie commitment tx, then HTLC 1 then HTLC 3
213 unrevoked_local_txn.sort_unstable_by_key(|tx| 1_000_000 - tx.output.iter().map(|outp| outp.value).sum::<u64>());
215 // Now mine A's old commitment transaction, which should close the channel, but take no action
216 // on any of the HTLCs, at least until we get six confirmations (which we won't get).
217 mine_transaction(&nodes[1], &revoked_local_txn[0]);
218 check_added_monitors!(nodes[1], 1);
219 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
220 check_closed_broadcast!(nodes[1], true);
222 // Connect up to one block before the revoked transaction would be considered final, then do a
223 // reorg that disconnects the full chain and goes up to the height at which the revoked
224 // transaction would be final.
225 let theoretical_conf_height = nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1;
226 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
227 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
228 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
230 disconnect_all_blocks(&nodes[1]);
231 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
232 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
234 connect_blocks(&nodes[1], theoretical_conf_height);
235 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
236 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
238 // Now connect A's latest commitment transaction instead and resolve the HTLCs
239 mine_transaction(&nodes[1], &unrevoked_local_txn[0]);
240 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
241 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
243 // Connect the HTLC claim transaction for HTLC 3
244 mine_transaction(&nodes[1], &unrevoked_local_txn[2]);
245 expect_payment_sent!(nodes[1], payment_preimage_3);
246 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
248 // Connect blocks to confirm the unrevoked commitment transaction
249 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
250 expect_payment_failed!(nodes[1], payment_hash_4, false);
253 fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, use_funding_unconfirmed: bool, connect_style: ConnectStyle) {
254 // After creating a chan between nodes, we disconnect all blocks previously seen to force a
255 // channel close on nodes[0] side. We also use this to provide very basic testing of logic
256 // around freeing background events which store monitor updates during block_[dis]connected.
257 let chanmon_cfgs = create_chanmon_cfgs(2);
258 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
259 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
260 let persister: test_utils::TestPersister;
261 let new_chain_monitor: test_utils::TestChainMonitor;
262 let nodes_0_deserialized: ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>;
263 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
264 *nodes[0].connect_style.borrow_mut() = connect_style;
266 let chan_conf_height = core::cmp::max(nodes[0].best_block_info().1 + 1, nodes[1].best_block_info().1 + 1);
267 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
270 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
271 let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
272 assert_eq!(peer_state.channel_by_id.len(), 1);
273 assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 2);
276 assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(10));
277 assert_eq!(nodes[1].node.list_channels()[0].confirmations, Some(10));
279 if !reorg_after_reload {
280 if use_funding_unconfirmed {
281 let relevant_txids = nodes[0].node.get_relevant_txids();
282 assert_eq!(relevant_txids.len(), 1);
283 let block_hash_opt = relevant_txids[0].1;
284 let expected_hash = nodes[0].get_block_header(chan_conf_height).block_hash();
285 assert_eq!(block_hash_opt, Some(expected_hash));
286 let txid = relevant_txids[0].0;
287 assert_eq!(txid, chan.3.txid());
288 nodes[0].node.transaction_unconfirmed(&txid);
289 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
290 } else if connect_style == ConnectStyle::FullBlockViaListen {
291 disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
292 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
293 assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(1));
294 disconnect_blocks(&nodes[0], 1);
295 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
297 disconnect_all_blocks(&nodes[0]);
298 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
301 let relevant_txids = nodes[0].node.get_relevant_txids();
302 assert_eq!(relevant_txids.len(), 0);
304 handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Channel closed because of an exception: Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.");
305 check_added_monitors!(nodes[1], 1);
307 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
308 let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
309 assert_eq!(peer_state.channel_by_id.len(), 0);
310 assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 0);
315 // Since we currently have a background event pending, it's good to test that we survive a
316 // serialization roundtrip. Further, this tests the somewhat awkward edge-case of dropping
317 // the Channel object from the ChannelManager, but still having a monitor event pending for
318 // it when we go to deserialize, and then use the ChannelManager.
319 let nodes_0_serialized = nodes[0].node.encode();
320 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan.2).encode();
322 reload_node!(nodes[0], *nodes[0].node.get_current_default_configuration(), &nodes_0_serialized, &[&chan_0_monitor_serialized], persister, new_chain_monitor, nodes_0_deserialized);
323 if !reorg_after_reload {
324 // If the channel is already closed when we reload the node, we'll broadcast a closing
325 // transaction via the ChannelMonitor which is missing a corresponding channel.
326 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
327 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
331 if reorg_after_reload {
332 if use_funding_unconfirmed {
333 let relevant_txids = nodes[0].node.get_relevant_txids();
334 assert_eq!(relevant_txids.len(), 1);
335 let block_hash_opt = relevant_txids[0].1;
336 let expected_hash = nodes[0].get_block_header(chan_conf_height).block_hash();
337 assert_eq!(block_hash_opt, Some(expected_hash));
338 let txid = relevant_txids[0].0;
339 assert_eq!(txid, chan.3.txid());
340 nodes[0].node.transaction_unconfirmed(&txid);
341 assert_eq!(nodes[0].node.list_channels().len(), 0);
342 } else if connect_style == ConnectStyle::FullBlockViaListen {
343 disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
344 assert_eq!(nodes[0].node.list_channels().len(), 1);
345 assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(1));
346 disconnect_blocks(&nodes[0], 1);
347 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
349 disconnect_all_blocks(&nodes[0]);
350 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
353 let relevant_txids = nodes[0].node.get_relevant_txids();
354 assert_eq!(relevant_txids.len(), 0);
356 handle_announce_close_broadcast_events(&nodes, 0, 1, true, "Channel closed because of an exception: Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.");
357 check_added_monitors!(nodes[1], 1);
359 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
360 let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
361 assert_eq!(peer_state.channel_by_id.len(), 0);
362 assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 0);
365 // With expect_channel_force_closed set the TestChainMonitor will enforce that the next update
366 // is a ChannelForcClosed on the right channel with should_broadcast set.
367 *nodes[0].chain_monitor.expect_channel_force_closed.lock().unwrap() = Some((chan.2, true));
368 nodes[0].node.test_process_background_events(); // Required to free the pending background monitor update
369 check_added_monitors!(nodes[0], 1);
370 let expected_err = "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.";
371 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Channel closed because of an exception: ".to_owned() + expected_err });
372 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: expected_err.to_owned() });
373 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
374 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
376 // Now check that we can create a new channel
377 if reload_node && nodes[0].node.per_peer_state.read().unwrap().len() == 0 {
378 // If we dropped the channel before reloading the node, nodes[1] was also dropped from
379 // nodes[0] storage, and hence not connected again on startup. We therefore need to
380 // reconnect to the node before attempting to create a new channel.
381 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &Init { features: nodes[1].node.init_features(), remote_network_address: None }, true).unwrap();
383 create_announced_chan_between_nodes(&nodes, 0, 1);
384 send_payment(&nodes[0], &[&nodes[1]], 8000000);
388 fn test_unconf_chan() {
389 do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
390 do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
391 do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
392 do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
394 do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
395 do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
396 do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
397 do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
401 fn test_unconf_chan_via_listen() {
402 do_test_unconf_chan(true, true, false, ConnectStyle::FullBlockViaListen);
403 do_test_unconf_chan(false, true, false, ConnectStyle::FullBlockViaListen);
404 do_test_unconf_chan(true, false, false, ConnectStyle::FullBlockViaListen);
405 do_test_unconf_chan(false, false, false, ConnectStyle::FullBlockViaListen);
409 fn test_unconf_chan_via_funding_unconfirmed() {
410 do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
411 do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
412 do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
413 do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
415 do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
416 do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
417 do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
418 do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
420 do_test_unconf_chan(true, true, true, ConnectStyle::FullBlockViaListen);
421 do_test_unconf_chan(false, true, true, ConnectStyle::FullBlockViaListen);
422 do_test_unconf_chan(true, false, true, ConnectStyle::FullBlockViaListen);
423 do_test_unconf_chan(false, false, true, ConnectStyle::FullBlockViaListen);
427 fn test_set_outpoints_partial_claiming() {
428 // - remote party claim tx, new bump tx
429 // - disconnect remote claiming tx, new bump
430 // - disconnect tx, see no tx anymore
431 let chanmon_cfgs = create_chanmon_cfgs(2);
432 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
433 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
434 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
436 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
437 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
438 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
440 // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
441 let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
442 assert_eq!(remote_txn.len(), 3);
443 assert_eq!(remote_txn[0].output.len(), 4);
444 assert_eq!(remote_txn[0].input.len(), 1);
445 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
446 check_spends!(remote_txn[1], remote_txn[0]);
447 check_spends!(remote_txn[2], remote_txn[0]);
449 // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
450 // Provide node A with both preimage
451 nodes[0].node.claim_funds(payment_preimage_1);
452 expect_payment_claimed!(nodes[0], payment_hash_1, 3_000_000);
453 nodes[0].node.claim_funds(payment_preimage_2);
454 expect_payment_claimed!(nodes[0], payment_hash_2, 3_000_000);
455 check_added_monitors!(nodes[0], 2);
456 nodes[0].node.get_and_clear_pending_msg_events();
458 // Connect blocks on node A commitment transaction
459 mine_transaction(&nodes[0], &remote_txn[0]);
460 check_closed_broadcast!(nodes[0], true);
461 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
462 check_added_monitors!(nodes[0], 1);
463 // Verify node A broadcast tx claiming both HTLCs
465 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
466 // ChannelMonitor: claim tx
467 assert_eq!(node_txn.len(), 1);
468 check_spends!(node_txn[0], remote_txn[0]);
469 assert_eq!(node_txn[0].input.len(), 2);
473 // Connect blocks on node B
474 connect_blocks(&nodes[1], 135);
475 check_closed_broadcast!(nodes[1], true);
476 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
477 check_added_monitors!(nodes[1], 1);
478 // Verify node B broadcast 2 HTLC-timeout txn
479 let partial_claim_tx = {
480 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
481 assert_eq!(node_txn.len(), 3);
482 check_spends!(node_txn[1], node_txn[0]);
483 check_spends!(node_txn[2], node_txn[0]);
484 assert_eq!(node_txn[1].input.len(), 1);
485 assert_eq!(node_txn[2].input.len(), 1);
489 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
490 mine_transaction(&nodes[0], &partial_claim_tx);
492 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
493 assert_eq!(node_txn.len(), 1);
494 check_spends!(node_txn[0], remote_txn[0]);
495 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
498 nodes[0].node.get_and_clear_pending_msg_events();
500 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
501 disconnect_blocks(&nodes[0], 1);
503 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
504 assert_eq!(node_txn.len(), 1);
505 check_spends!(node_txn[0], remote_txn[0]);
506 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
510 //// Disconnect one more block and then reconnect multiple no transaction should be generated
511 disconnect_blocks(&nodes[0], 1);
512 connect_blocks(&nodes[0], 15);
514 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
515 assert_eq!(node_txn.len(), 0);
520 fn do_test_to_remote_after_local_detection(style: ConnectStyle) {
521 // In previous code, detection of to_remote outputs in a counterparty commitment transaction
522 // was dependent on whether a local commitment transaction had been seen on-chain previously.
523 // This resulted in some edge cases around not being able to generate a SpendableOutput event
526 // Here, we test this by first confirming one set of commitment transactions, then
527 // disconnecting them and reconnecting another. We then confirm them and check that the correct
528 // SpendableOutput event is generated.
529 let chanmon_cfgs = create_chanmon_cfgs(2);
530 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
531 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
532 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
534 *nodes[0].connect_style.borrow_mut() = style;
535 *nodes[1].connect_style.borrow_mut() = style;
537 let (_, _, chan_id, funding_tx) =
538 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 100_000_000);
539 let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
540 assert_eq!(funding_outpoint.to_channel_id(), chan_id);
542 let remote_txn_a = get_local_commitment_txn!(nodes[0], chan_id);
543 let remote_txn_b = get_local_commitment_txn!(nodes[1], chan_id);
545 mine_transaction(&nodes[0], &remote_txn_a[0]);
546 mine_transaction(&nodes[1], &remote_txn_a[0]);
548 assert!(nodes[0].node.list_channels().is_empty());
549 check_closed_broadcast!(nodes[0], true);
550 check_added_monitors!(nodes[0], 1);
551 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
552 assert!(nodes[1].node.list_channels().is_empty());
553 check_closed_broadcast!(nodes[1], true);
554 check_added_monitors!(nodes[1], 1);
555 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
557 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
558 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
560 disconnect_blocks(&nodes[0], 1);
561 disconnect_blocks(&nodes[1], 1);
563 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
564 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
565 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
566 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
568 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
569 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
571 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
572 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
573 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
574 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
576 mine_transaction(&nodes[0], &remote_txn_b[0]);
577 mine_transaction(&nodes[1], &remote_txn_b[0]);
579 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
580 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
581 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
582 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
584 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
585 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
587 let mut node_a_spendable = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
588 assert_eq!(node_a_spendable.len(), 1);
589 if let Event::SpendableOutputs { outputs } = node_a_spendable.pop().unwrap() {
590 assert_eq!(outputs.len(), 1);
591 let spend_tx = nodes[0].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
592 Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &Secp256k1::new()).unwrap();
593 check_spends!(spend_tx, remote_txn_b[0]);
596 // nodes[1] is waiting for the to_self_delay to expire, which is many more than
597 // ANTI_REORG_DELAY. Instead, walk it back and confirm the original remote_txn_a commitment
598 // again and check that nodes[1] generates a similar spendable output.
599 // Technically a reorg of ANTI_REORG_DELAY violates our assumptions, so this is undefined by
600 // our API spec, but we currently handle this correctly and there's little reason we shouldn't
602 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
603 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY);
604 mine_transaction(&nodes[1], &remote_txn_a[0]);
605 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
607 let mut node_b_spendable = nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events();
608 assert_eq!(node_b_spendable.len(), 1);
609 if let Event::SpendableOutputs { outputs } = node_b_spendable.pop().unwrap() {
610 assert_eq!(outputs.len(), 1);
611 let spend_tx = nodes[1].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
612 Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &Secp256k1::new()).unwrap();
613 check_spends!(spend_tx, remote_txn_a[0]);
618 fn test_to_remote_after_local_detection() {
619 do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirst);
620 do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstSkippingBlocks);
621 do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstReorgsOnlyTip);
622 do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirst);
623 do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstSkippingBlocks);
624 do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstReorgsOnlyTip);
625 do_test_to_remote_after_local_detection(ConnectStyle::FullBlockViaListen);