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, LATENCY_GRACE_PERIOD_BLOCKS};
13 use crate::chain::transaction::OutPoint;
14 use crate::chain::Confirm;
15 use crate::events::{Event, MessageSendEventsProvider, ClosureReason, HTLCDestination};
16 use crate::ln::channelmanager::ChannelManager;
17 use crate::ln::msgs::{ChannelMessageHandler, Init};
18 use crate::util::test_utils;
19 use crate::util::ser::Writeable;
20 use crate::util::string::UntrustedString;
22 use bitcoin::blockdata::script::Builder;
23 use bitcoin::blockdata::opcodes;
24 use bitcoin::secp256k1::Secp256k1;
26 use crate::prelude::*;
28 use crate::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);
52 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
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]], 1_000_000);
61 // Provide preimage to node 2 by claiming payment
62 nodes[2].node.claim_funds(our_payment_preimage);
63 expect_payment_claimed!(nodes[2], our_payment_hash, 1_000_000);
64 check_added_monitors!(nodes[2], 1);
65 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
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], &create_dummy_block(nodes[2].best_block_hash(), 42, 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 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
80 let node_2_commitment_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
81 assert_eq!(node_2_commitment_txn.len(), 1); // ChannelMonitor: 1 offered HTLC-Claim
82 check_spends!(node_2_commitment_txn[0], node_1_commitment_txn[0]);
84 // Make sure node 1's height is the same as the !local_commitment case
85 connect_blocks(&nodes[1], 1);
86 // Confirm node 1's commitment txn (and HTLC-Timeout) on node 1
87 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, node_1_commitment_txn.clone()));
89 // ...but return node 1's commitment tx in case claim is set and we're preparing to reorg
90 vec![node_1_commitment_txn[0].clone(), node_2_commitment_txn[0].clone()]
92 // Broadcast node 2 commitment txn
93 let mut node_2_commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
94 assert_eq!(node_2_commitment_txn.len(), 2); // 1 local commitment tx, 1 Received HTLC-Claim
95 assert_eq!(node_2_commitment_txn[0].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
96 check_spends!(node_2_commitment_txn[0], chan_2.3);
97 check_spends!(node_2_commitment_txn[1], node_2_commitment_txn[0]);
99 // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
100 mine_transaction(&nodes[1], &node_2_commitment_txn[0]);
101 connect_blocks(&nodes[1], TEST_FINAL_CLTV); // Confirm blocks until the HTLC expires
102 let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
103 assert_eq!(node_1_commitment_txn.len(), 1); // ChannelMonitor: 1 offered HTLC-Timeout
104 check_spends!(node_1_commitment_txn[0], node_2_commitment_txn[0]);
106 // Confirm node 1's HTLC-Timeout on node 1
107 mine_transaction(&nodes[1], &node_1_commitment_txn[0]);
108 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
109 vec![node_2_commitment_txn.pop().unwrap()]
111 check_added_monitors!(nodes[1], 1);
112 check_closed_broadcast!(nodes[1], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
113 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
114 // Connect ANTI_REORG_DELAY - 2 blocks, giving us a confirmation count of ANTI_REORG_DELAY - 1.
115 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
116 check_added_monitors!(nodes[1], 0);
117 assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
120 // Disconnect Node 1's HTLC-Timeout which was connected above
121 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
123 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, claim_txn));
125 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
126 // probe it for events, so we probe non-message events here (which should just be the
127 // PaymentForwarded event).
128 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), true, true);
130 // Confirm the timeout tx and check that we fail the HTLC backwards
131 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, Vec::new()));
132 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 }]);
135 check_added_monitors!(nodes[1], 1);
136 // Which should result in an immediate claim/fail of the HTLC:
137 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
139 assert_eq!(htlc_updates.update_fulfill_htlcs.len(), 1);
140 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fulfill_htlcs[0]);
142 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
143 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
145 commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false, true);
147 expect_payment_sent!(nodes[0], our_payment_preimage);
149 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
154 fn test_onchain_htlc_claim_reorg_local_commitment() {
155 do_test_onchain_htlc_reorg(true, true);
158 fn test_onchain_htlc_timeout_delay_local_commitment() {
159 do_test_onchain_htlc_reorg(true, false);
162 fn test_onchain_htlc_claim_reorg_remote_commitment() {
163 do_test_onchain_htlc_reorg(false, true);
166 fn test_onchain_htlc_timeout_delay_remote_commitment() {
167 do_test_onchain_htlc_reorg(false, false);
171 fn test_counterparty_revoked_reorg() {
172 // Test what happens when a revoked counterparty transaction is broadcast but then reorg'd out
173 // of the main chain. Specifically, HTLCs in the latest commitment transaction which are not
174 // included in the revoked commitment transaction should not be considered failed, and should
175 // still be claim-from-able after the reorg.
176 let chanmon_cfgs = create_chanmon_cfgs(2);
177 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
178 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
179 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
181 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000);
183 // Get the initial commitment transaction for broadcast, before any HTLCs are added at all.
184 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
185 assert_eq!(revoked_local_txn.len(), 1);
187 // Now add two HTLCs in each direction, one dust and one not.
188 route_payment(&nodes[0], &[&nodes[1]], 5_000_000);
189 route_payment(&nodes[0], &[&nodes[1]], 5_000);
190 let (payment_preimage_3, payment_hash_3, ..) = route_payment(&nodes[1], &[&nodes[0]], 4_000_000);
191 let payment_hash_4 = route_payment(&nodes[1], &[&nodes[0]], 4_000).1;
193 nodes[0].node.claim_funds(payment_preimage_3);
194 let _ = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
195 check_added_monitors!(nodes[0], 1);
196 expect_payment_claimed!(nodes[0], payment_hash_3, 4_000_000);
198 let mut unrevoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
199 assert_eq!(unrevoked_local_txn.len(), 3); // commitment + 2 HTLC txn
200 // Sort the unrevoked transactions in reverse order, ie commitment tx, then HTLC 1 then HTLC 3
201 unrevoked_local_txn.sort_unstable_by_key(|tx| 1_000_000 - tx.output.iter().map(|outp| outp.value).sum::<u64>());
203 // Now mine A's old commitment transaction, which should close the channel, but take no action
204 // on any of the HTLCs, at least until we get six confirmations (which we won't get).
205 mine_transaction(&nodes[1], &revoked_local_txn[0]);
206 check_added_monitors!(nodes[1], 1);
207 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
208 check_closed_broadcast!(nodes[1], true);
210 // Connect up to one block before the revoked transaction would be considered final, then do a
211 // reorg that disconnects the full chain and goes up to the height at which the revoked
212 // transaction would be final.
213 let theoretical_conf_height = nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1;
214 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
215 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
216 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
218 disconnect_all_blocks(&nodes[1]);
219 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
220 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
222 connect_blocks(&nodes[1], theoretical_conf_height);
223 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
224 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
226 // Now connect A's latest commitment transaction instead and resolve the HTLCs
227 mine_transaction(&nodes[1], &unrevoked_local_txn[0]);
228 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
229 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
231 // Connect the HTLC claim transaction for HTLC 3
232 mine_transaction(&nodes[1], &unrevoked_local_txn[2]);
233 expect_payment_sent!(nodes[1], payment_preimage_3);
234 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
236 // Connect blocks to confirm the unrevoked commitment transaction
237 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
238 expect_payment_failed!(nodes[1], payment_hash_4, false);
241 fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, use_funding_unconfirmed: bool, connect_style: ConnectStyle) {
242 // After creating a chan between nodes, we disconnect all blocks previously seen to force a
243 // channel close on nodes[0] side. We also use this to provide very basic testing of logic
244 // around freeing background events which store monitor updates during block_[dis]connected.
245 let chanmon_cfgs = create_chanmon_cfgs(2);
246 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
247 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
248 let persister: test_utils::TestPersister;
249 let new_chain_monitor: test_utils::TestChainMonitor;
250 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>;
251 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
252 *nodes[0].connect_style.borrow_mut() = connect_style;
254 let chan_conf_height = core::cmp::max(nodes[0].best_block_info().1 + 1, nodes[1].best_block_info().1 + 1);
255 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
258 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
259 let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
260 assert_eq!(peer_state.channel_by_id.len(), 1);
261 assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 2);
264 assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(10));
265 assert_eq!(nodes[1].node.list_channels()[0].confirmations, Some(10));
267 if !reorg_after_reload {
268 if use_funding_unconfirmed {
269 let relevant_txids = nodes[0].node.get_relevant_txids();
270 assert_eq!(relevant_txids.len(), 1);
271 let block_hash_opt = relevant_txids[0].1;
272 let expected_hash = nodes[0].get_block_header(chan_conf_height).block_hash();
273 assert_eq!(block_hash_opt, Some(expected_hash));
274 let txid = relevant_txids[0].0;
275 assert_eq!(txid, chan.3.txid());
276 nodes[0].node.transaction_unconfirmed(&txid);
277 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
278 } else if connect_style == ConnectStyle::FullBlockViaListen {
279 disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
280 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
281 assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(1));
282 disconnect_blocks(&nodes[0], 1);
283 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
285 disconnect_all_blocks(&nodes[0]);
286 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
289 let relevant_txids = nodes[0].node.get_relevant_txids();
290 assert_eq!(relevant_txids.len(), 0);
293 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
294 let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
295 assert_eq!(peer_state.channel_by_id.len(), 0);
296 assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 0);
301 // Since we currently have a background event pending, it's good to test that we survive a
302 // serialization roundtrip. Further, this tests the somewhat awkward edge-case of dropping
303 // the Channel object from the ChannelManager, but still having a monitor event pending for
304 // it when we go to deserialize, and then use the ChannelManager.
305 let nodes_0_serialized = nodes[0].node.encode();
306 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan.2).encode();
308 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);
309 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
312 if reorg_after_reload {
313 if use_funding_unconfirmed {
314 let relevant_txids = nodes[0].node.get_relevant_txids();
315 assert_eq!(relevant_txids.len(), 1);
316 let block_hash_opt = relevant_txids[0].1;
317 let expected_hash = nodes[0].get_block_header(chan_conf_height).block_hash();
318 assert_eq!(block_hash_opt, Some(expected_hash));
319 let txid = relevant_txids[0].0;
320 assert_eq!(txid, chan.3.txid());
321 nodes[0].node.transaction_unconfirmed(&txid);
322 assert_eq!(nodes[0].node.list_channels().len(), 0);
323 } else if connect_style == ConnectStyle::FullBlockViaListen {
324 disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
325 assert_eq!(nodes[0].node.list_channels().len(), 1);
326 assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(1));
327 disconnect_blocks(&nodes[0], 1);
328 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
330 disconnect_all_blocks(&nodes[0]);
331 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
334 let relevant_txids = nodes[0].node.get_relevant_txids();
335 assert_eq!(relevant_txids.len(), 0);
338 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
339 let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
340 assert_eq!(peer_state.channel_by_id.len(), 0);
341 assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 0);
344 // With expect_channel_force_closed set the TestChainMonitor will enforce that the next update
345 // is a ChannelForcClosed on the right channel with should_broadcast set.
346 *nodes[0].chain_monitor.expect_channel_force_closed.lock().unwrap() = Some((chan.2, true));
347 nodes[0].node.test_process_background_events(); // Required to free the pending background monitor update
348 check_added_monitors!(nodes[0], 1);
349 let expected_err = "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.";
350 if reorg_after_reload || !reload_node {
351 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.");
352 check_added_monitors!(nodes[1], 1);
353 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Channel closed because of an exception: {}", expected_err)) });
356 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: expected_err.to_owned() });
357 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
358 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
360 // Now check that we can create a new channel
361 if reload_node && nodes[0].node.per_peer_state.read().unwrap().len() == 0 {
362 // If we dropped the channel before reloading the node, nodes[1] was also dropped from
363 // nodes[0] storage, and hence not connected again on startup. We therefore need to
364 // reconnect to the node before attempting to create a new channel.
365 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &Init {
366 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
369 create_announced_chan_between_nodes(&nodes, 0, 1);
370 send_payment(&nodes[0], &[&nodes[1]], 8000000);
374 fn test_unconf_chan() {
375 do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
376 do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
377 do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
378 do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
380 do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
381 do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
382 do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
383 do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
387 fn test_unconf_chan_via_listen() {
388 do_test_unconf_chan(true, true, false, ConnectStyle::FullBlockViaListen);
389 do_test_unconf_chan(false, true, false, ConnectStyle::FullBlockViaListen);
390 do_test_unconf_chan(true, false, false, ConnectStyle::FullBlockViaListen);
391 do_test_unconf_chan(false, false, false, ConnectStyle::FullBlockViaListen);
395 fn test_unconf_chan_via_funding_unconfirmed() {
396 do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
397 do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
398 do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
399 do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
401 do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
402 do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
403 do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
404 do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
406 do_test_unconf_chan(true, true, true, ConnectStyle::FullBlockViaListen);
407 do_test_unconf_chan(false, true, true, ConnectStyle::FullBlockViaListen);
408 do_test_unconf_chan(true, false, true, ConnectStyle::FullBlockViaListen);
409 do_test_unconf_chan(false, false, true, ConnectStyle::FullBlockViaListen);
413 fn test_set_outpoints_partial_claiming() {
414 // - remote party claim tx, new bump tx
415 // - disconnect remote claiming tx, new bump
416 // - disconnect tx, see no tx anymore
417 let chanmon_cfgs = create_chanmon_cfgs(2);
418 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
419 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
420 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
422 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
423 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
424 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
426 // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
427 let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
428 assert_eq!(remote_txn.len(), 3);
429 assert_eq!(remote_txn[0].output.len(), 4);
430 assert_eq!(remote_txn[0].input.len(), 1);
431 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
432 check_spends!(remote_txn[1], remote_txn[0]);
433 check_spends!(remote_txn[2], remote_txn[0]);
435 // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
436 // Provide node A with both preimage
437 nodes[0].node.claim_funds(payment_preimage_1);
438 expect_payment_claimed!(nodes[0], payment_hash_1, 3_000_000);
439 nodes[0].node.claim_funds(payment_preimage_2);
440 expect_payment_claimed!(nodes[0], payment_hash_2, 3_000_000);
441 check_added_monitors!(nodes[0], 2);
442 nodes[0].node.get_and_clear_pending_msg_events();
444 // Connect blocks on node A commitment transaction
445 mine_transaction(&nodes[0], &remote_txn[0]);
446 check_closed_broadcast!(nodes[0], true);
447 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
448 check_added_monitors!(nodes[0], 1);
449 // Verify node A broadcast tx claiming both HTLCs
451 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
452 // ChannelMonitor: claim tx
453 assert_eq!(node_txn.len(), 1);
454 check_spends!(node_txn[0], remote_txn[0]);
455 assert_eq!(node_txn[0].input.len(), 2);
459 // Connect blocks on node B
460 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
461 check_closed_broadcast!(nodes[1], true);
462 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
463 check_added_monitors!(nodes[1], 1);
464 // Verify node B broadcast 2 HTLC-timeout txn
465 let partial_claim_tx = {
466 let mut node_txn = nodes[1].tx_broadcaster.unique_txn_broadcast();
467 assert_eq!(node_txn.len(), 3);
468 check_spends!(node_txn[0], chan.3);
469 check_spends!(node_txn[1], node_txn[0]);
470 check_spends!(node_txn[2], node_txn[0]);
471 assert_eq!(node_txn[1].input.len(), 1);
472 assert_eq!(node_txn[2].input.len(), 1);
473 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
477 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
478 mine_transaction(&nodes[0], &partial_claim_tx);
480 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
481 assert_eq!(node_txn.len(), 1);
482 check_spends!(node_txn[0], remote_txn[0]);
483 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
486 nodes[0].node.get_and_clear_pending_msg_events();
488 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
489 disconnect_blocks(&nodes[0], 1);
491 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
492 assert_eq!(node_txn.len(), 1);
493 check_spends!(node_txn[0], remote_txn[0]);
494 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
498 //// Disconnect one more block and then reconnect multiple no transaction should be generated
499 disconnect_blocks(&nodes[0], 1);
500 connect_blocks(&nodes[0], 15);
502 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
503 assert_eq!(node_txn.len(), 0);
508 fn do_test_to_remote_after_local_detection(style: ConnectStyle) {
509 // In previous code, detection of to_remote outputs in a counterparty commitment transaction
510 // was dependent on whether a local commitment transaction had been seen on-chain previously.
511 // This resulted in some edge cases around not being able to generate a SpendableOutput event
514 // Here, we test this by first confirming one set of commitment transactions, then
515 // disconnecting them and reconnecting another. We then confirm them and check that the correct
516 // SpendableOutput event is generated.
517 let chanmon_cfgs = create_chanmon_cfgs(2);
518 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
519 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
520 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
522 *nodes[0].connect_style.borrow_mut() = style;
523 *nodes[1].connect_style.borrow_mut() = style;
525 let (_, _, chan_id, funding_tx) =
526 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 100_000_000);
527 let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
528 assert_eq!(funding_outpoint.to_channel_id(), chan_id);
530 let remote_txn_a = get_local_commitment_txn!(nodes[0], chan_id);
531 let remote_txn_b = get_local_commitment_txn!(nodes[1], chan_id);
533 mine_transaction(&nodes[0], &remote_txn_a[0]);
534 mine_transaction(&nodes[1], &remote_txn_a[0]);
536 assert!(nodes[0].node.list_channels().is_empty());
537 check_closed_broadcast!(nodes[0], true);
538 check_added_monitors!(nodes[0], 1);
539 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
540 assert!(nodes[1].node.list_channels().is_empty());
541 check_closed_broadcast!(nodes[1], true);
542 check_added_monitors!(nodes[1], 1);
543 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
545 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
546 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
548 disconnect_blocks(&nodes[0], 1);
549 disconnect_blocks(&nodes[1], 1);
551 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
552 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
553 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
554 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
556 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
557 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
559 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
560 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
561 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
562 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
564 mine_transaction(&nodes[0], &remote_txn_b[0]);
565 mine_transaction(&nodes[1], &remote_txn_b[0]);
567 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
568 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
569 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
570 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
572 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
573 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
575 let mut node_a_spendable = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
576 assert_eq!(node_a_spendable.len(), 1);
577 if let Event::SpendableOutputs { outputs } = node_a_spendable.pop().unwrap() {
578 assert_eq!(outputs.len(), 1);
579 let spend_tx = nodes[0].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
580 Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, None, &Secp256k1::new()).unwrap();
581 check_spends!(spend_tx, remote_txn_b[0]);
584 // nodes[1] is waiting for the to_self_delay to expire, which is many more than
585 // ANTI_REORG_DELAY. Instead, walk it back and confirm the original remote_txn_a commitment
586 // again and check that nodes[1] generates a similar spendable output.
587 // Technically a reorg of ANTI_REORG_DELAY violates our assumptions, so this is undefined by
588 // our API spec, but we currently handle this correctly and there's little reason we shouldn't
590 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
591 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY);
592 mine_transaction(&nodes[1], &remote_txn_a[0]);
593 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
595 let mut node_b_spendable = nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events();
596 assert_eq!(node_b_spendable.len(), 1);
597 if let Event::SpendableOutputs { outputs } = node_b_spendable.pop().unwrap() {
598 assert_eq!(outputs.len(), 1);
599 let spend_tx = nodes[1].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
600 Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, None, &Secp256k1::new()).unwrap();
601 check_spends!(spend_tx, remote_txn_a[0]);
606 fn test_to_remote_after_local_detection() {
607 do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirst);
608 do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstSkippingBlocks);
609 do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstReorgsOnlyTip);
610 do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirst);
611 do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstSkippingBlocks);
612 do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstReorgsOnlyTip);
613 do_test_to_remote_after_local_detection(ConnectStyle::FullBlockViaListen);