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::msgs::{ChannelMessageHandler, Init};
17 use crate::util::test_utils;
18 use crate::util::ser::Writeable;
19 use crate::util::string::UntrustedString;
21 use bitcoin::blockdata::script::Builder;
22 use bitcoin::blockdata::opcodes;
23 use bitcoin::secp256k1::Secp256k1;
25 use crate::prelude::*;
27 use crate::ln::functional_test_utils::*;
29 fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
30 // Our on-chain HTLC-claim learning has a few properties worth testing:
31 // * If an upstream HTLC is claimed with a preimage (both against our own commitment
32 // transaction our counterparty's), we claim it backwards immediately.
33 // * If an upstream HTLC is claimed with a timeout, we delay ANTI_REORG_DELAY before failing
34 // it backwards to ensure our counterparty can't claim with a preimage in a reorg.
36 // Here we test both properties in any combination based on the two bools passed in as
39 // If local_commitment is set, we first broadcast a local commitment containing an offered HTLC
40 // and an HTLC-Timeout tx, otherwise we broadcast a remote commitment containing a received
41 // HTLC and a local HTLC-Timeout tx spending it.
43 // We then either allow these transactions to confirm (if !claim) or we wait until one block
44 // before they otherwise would and reorg them out, confirming an HTLC-Success tx instead.
45 let chanmon_cfgs = create_chanmon_cfgs(3);
46 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
47 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
48 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
50 create_announced_chan_between_nodes(&nodes, 0, 1);
51 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
53 // Make sure all nodes are at the same starting height
54 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
55 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
56 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
58 let (our_payment_preimage, our_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
60 // Provide preimage to node 2 by claiming payment
61 nodes[2].node.claim_funds(our_payment_preimage);
62 expect_payment_claimed!(nodes[2], our_payment_hash, 1_000_000);
63 check_added_monitors!(nodes[2], 1);
64 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
66 let claim_txn = if local_commitment {
67 // Broadcast node 1 commitment txn to broadcast the HTLC-Timeout
68 let node_1_commitment_txn = get_local_commitment_txn!(nodes[1], chan_2.2);
69 assert_eq!(node_1_commitment_txn.len(), 2); // 1 local commitment tx, 1 Outbound HTLC-Timeout
70 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-self and Offered HTLC (to-remote/to-node-3 is dust)
71 check_spends!(node_1_commitment_txn[0], chan_2.3);
72 check_spends!(node_1_commitment_txn[1], node_1_commitment_txn[0]);
74 // Give node 2 node 1's transactions and get its response (claiming the HTLC instead).
75 connect_block(&nodes[2], &create_dummy_block(nodes[2].best_block_hash(), 42, node_1_commitment_txn.clone()));
76 check_added_monitors!(nodes[2], 1);
77 check_closed_broadcast!(nodes[2], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
78 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 100000);
79 let node_2_commitment_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
80 assert_eq!(node_2_commitment_txn.len(), 1); // ChannelMonitor: 1 offered HTLC-Claim
81 check_spends!(node_2_commitment_txn[0], node_1_commitment_txn[0]);
83 // Make sure node 1's height is the same as the !local_commitment case
84 connect_blocks(&nodes[1], 1);
85 // Confirm node 1's commitment txn (and HTLC-Timeout) on node 1
86 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, node_1_commitment_txn.clone()));
88 // ...but return node 1's commitment tx in case claim is set and we're preparing to reorg
89 vec![node_1_commitment_txn[0].clone(), node_2_commitment_txn[0].clone()]
91 // Broadcast node 2 commitment txn
92 let mut node_2_commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
93 assert_eq!(node_2_commitment_txn.len(), 2); // 1 local commitment tx, 1 Received HTLC-Claim
94 assert_eq!(node_2_commitment_txn[0].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
95 check_spends!(node_2_commitment_txn[0], chan_2.3);
96 check_spends!(node_2_commitment_txn[1], node_2_commitment_txn[0]);
98 // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
99 mine_transaction(&nodes[1], &node_2_commitment_txn[0]);
100 connect_blocks(&nodes[1], TEST_FINAL_CLTV); // Confirm blocks until the HTLC expires
101 let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
102 assert_eq!(node_1_commitment_txn.len(), 1); // ChannelMonitor: 1 offered HTLC-Timeout
103 check_spends!(node_1_commitment_txn[0], node_2_commitment_txn[0]);
105 // Confirm node 1's HTLC-Timeout on node 1
106 mine_transaction(&nodes[1], &node_1_commitment_txn[0]);
107 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
108 vec![node_2_commitment_txn.pop().unwrap()]
110 check_added_monitors!(nodes[1], 1);
111 check_closed_broadcast!(nodes[1], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
112 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[2].node.get_our_node_id()], 100000);
113 // Connect ANTI_REORG_DELAY - 2 blocks, giving us a confirmation count of ANTI_REORG_DELAY - 1.
114 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
115 check_added_monitors!(nodes[1], 0);
116 assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
119 // Disconnect Node 1's HTLC-Timeout which was connected above
120 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
122 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, claim_txn));
124 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
125 // probe it for events, so we probe non-message events here (which should just be the
126 // PaymentForwarded event).
127 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), true, true);
129 // Confirm the timeout tx and check that we fail the HTLC backwards
130 connect_block(&nodes[1], &create_dummy_block(nodes[1].best_block_hash(), 42, Vec::new()));
131 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 }]);
134 check_added_monitors!(nodes[1], 1);
135 // Which should result in an immediate claim/fail of the HTLC:
136 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
138 assert_eq!(htlc_updates.update_fulfill_htlcs.len(), 1);
139 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fulfill_htlcs[0]);
141 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
142 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
144 commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false, true);
146 expect_payment_sent!(nodes[0], our_payment_preimage);
148 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
153 fn test_onchain_htlc_claim_reorg_local_commitment() {
154 do_test_onchain_htlc_reorg(true, true);
157 fn test_onchain_htlc_timeout_delay_local_commitment() {
158 do_test_onchain_htlc_reorg(true, false);
161 fn test_onchain_htlc_claim_reorg_remote_commitment() {
162 do_test_onchain_htlc_reorg(false, true);
165 fn test_onchain_htlc_timeout_delay_remote_commitment() {
166 do_test_onchain_htlc_reorg(false, false);
170 fn test_counterparty_revoked_reorg() {
171 // Test what happens when a revoked counterparty transaction is broadcast but then reorg'd out
172 // of the main chain. Specifically, HTLCs in the latest commitment transaction which are not
173 // included in the revoked commitment transaction should not be considered failed, and should
174 // still be claim-from-able after the reorg.
175 let chanmon_cfgs = create_chanmon_cfgs(2);
176 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
177 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
178 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
180 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000);
182 // Get the initial commitment transaction for broadcast, before any HTLCs are added at all.
183 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
184 assert_eq!(revoked_local_txn.len(), 1);
186 // Now add two HTLCs in each direction, one dust and one not.
187 route_payment(&nodes[0], &[&nodes[1]], 5_000_000);
188 route_payment(&nodes[0], &[&nodes[1]], 5_000);
189 let (payment_preimage_3, payment_hash_3, ..) = route_payment(&nodes[1], &[&nodes[0]], 4_000_000);
190 let payment_hash_4 = route_payment(&nodes[1], &[&nodes[0]], 4_000).1;
192 nodes[0].node.claim_funds(payment_preimage_3);
193 let _ = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
194 check_added_monitors!(nodes[0], 1);
195 expect_payment_claimed!(nodes[0], payment_hash_3, 4_000_000);
197 let mut unrevoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
198 assert_eq!(unrevoked_local_txn.len(), 3); // commitment + 2 HTLC txn
199 // Sort the unrevoked transactions in reverse order, ie commitment tx, then HTLC 1 then HTLC 3
200 unrevoked_local_txn.sort_unstable_by_key(|tx| 1_000_000 - tx.output.iter().map(|outp| outp.value).sum::<u64>());
202 // Now mine A's old commitment transaction, which should close the channel, but take no action
203 // on any of the HTLCs, at least until we get six confirmations (which we won't get).
204 mine_transaction(&nodes[1], &revoked_local_txn[0]);
205 check_added_monitors!(nodes[1], 1);
206 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 1000000);
207 check_closed_broadcast!(nodes[1], true);
209 // Connect up to one block before the revoked transaction would be considered final, then do a
210 // reorg that disconnects the full chain and goes up to the height at which the revoked
211 // transaction would be final.
212 let theoretical_conf_height = nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1;
213 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
214 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
215 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
217 disconnect_all_blocks(&nodes[1]);
218 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
219 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
221 connect_blocks(&nodes[1], theoretical_conf_height);
222 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
223 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
225 // Now connect A's latest commitment transaction instead and resolve the HTLCs
226 mine_transaction(&nodes[1], &unrevoked_local_txn[0]);
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 // Connect the HTLC claim transaction for HTLC 3
231 mine_transaction(&nodes[1], &unrevoked_local_txn[2]);
232 expect_payment_sent(&nodes[1], payment_preimage_3, None, true, false);
233 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
235 // Connect blocks to confirm the unrevoked commitment transaction
236 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
237 expect_payment_failed!(nodes[1], payment_hash_4, false);
240 fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, use_funding_unconfirmed: bool, connect_style: ConnectStyle) {
241 // After creating a chan between nodes, we disconnect all blocks previously seen to force a
242 // channel close on nodes[0] side. We also use this to provide very basic testing of logic
243 // around freeing background events which store monitor updates during block_[dis]connected.
244 let chanmon_cfgs = create_chanmon_cfgs(2);
245 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
247 let new_chain_monitor;
249 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
250 let nodes_0_deserialized;
252 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
253 *nodes[0].connect_style.borrow_mut() = connect_style;
255 let chan_conf_height = core::cmp::max(nodes[0].best_block_info().1 + 1, nodes[1].best_block_info().1 + 1);
256 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
259 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
260 let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
261 assert_eq!(peer_state.channel_by_id.len(), 1);
262 assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 2);
265 assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(10));
266 assert_eq!(nodes[1].node.list_channels()[0].confirmations, Some(10));
268 if !reorg_after_reload {
269 if use_funding_unconfirmed {
270 let relevant_txids = nodes[0].node.get_relevant_txids();
271 assert_eq!(relevant_txids.len(), 1);
272 let block_hash_opt = relevant_txids[0].1;
273 let expected_hash = nodes[0].get_block_header(chan_conf_height).block_hash();
274 assert_eq!(block_hash_opt, Some(expected_hash));
275 let txid = relevant_txids[0].0;
276 assert_eq!(txid, chan.3.txid());
277 nodes[0].node.transaction_unconfirmed(&txid);
278 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
279 } else if connect_style == ConnectStyle::FullBlockViaListen {
280 disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
281 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
282 assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(1));
283 disconnect_blocks(&nodes[0], 1);
284 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
286 disconnect_all_blocks(&nodes[0]);
287 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
290 let relevant_txids = nodes[0].node.get_relevant_txids();
291 assert_eq!(relevant_txids.len(), 0);
294 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
295 let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
296 assert_eq!(peer_state.channel_by_id.len(), 0);
297 assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 0);
302 // Since we currently have a background event pending, it's good to test that we survive a
303 // serialization roundtrip. Further, this tests the somewhat awkward edge-case of dropping
304 // the Channel object from the ChannelManager, but still having a monitor event pending for
305 // it when we go to deserialize, and then use the ChannelManager.
306 let nodes_0_serialized = nodes[0].node.encode();
307 let chan_0_monitor_serialized = get_monitor!(nodes[0], chan.2).encode();
309 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);
310 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
313 if reorg_after_reload {
314 if use_funding_unconfirmed {
315 let relevant_txids = nodes[0].node.get_relevant_txids();
316 assert_eq!(relevant_txids.len(), 1);
317 let block_hash_opt = relevant_txids[0].1;
318 let expected_hash = nodes[0].get_block_header(chan_conf_height).block_hash();
319 assert_eq!(block_hash_opt, Some(expected_hash));
320 let txid = relevant_txids[0].0;
321 assert_eq!(txid, chan.3.txid());
322 nodes[0].node.transaction_unconfirmed(&txid);
323 assert_eq!(nodes[0].node.list_channels().len(), 0);
324 } else if connect_style == ConnectStyle::FullBlockViaListen {
325 disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
326 assert_eq!(nodes[0].node.list_channels().len(), 1);
327 assert_eq!(nodes[0].node.list_channels()[0].confirmations, Some(1));
328 disconnect_blocks(&nodes[0], 1);
329 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
331 disconnect_all_blocks(&nodes[0]);
332 assert_eq!(nodes[0].node.list_usable_channels().len(), 0);
335 let relevant_txids = nodes[0].node.get_relevant_txids();
336 assert_eq!(relevant_txids.len(), 0);
339 let per_peer_state = nodes[0].node.per_peer_state.read().unwrap();
340 let peer_state = per_peer_state.get(&nodes[1].node.get_our_node_id()).unwrap().lock().unwrap();
341 assert_eq!(peer_state.channel_by_id.len(), 0);
342 assert_eq!(nodes[0].node.short_to_chan_info.read().unwrap().len(), 0);
345 // With expect_channel_force_closed set the TestChainMonitor will enforce that the next update
346 // is a ChannelForcClosed on the right channel with should_broadcast set.
347 *nodes[0].chain_monitor.expect_channel_force_closed.lock().unwrap() = Some((chan.2, true));
348 nodes[0].node.test_process_background_events(); // Required to free the pending background monitor update
349 check_added_monitors!(nodes[0], 1);
350 let expected_err = "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.";
351 if reorg_after_reload || !reload_node {
352 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.");
353 check_added_monitors!(nodes[1], 1);
354 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: UntrustedString(format!("Channel closed because of an exception: {}", expected_err)) }
355 , [nodes[0].node.get_our_node_id()], 100000);
358 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: expected_err.to_owned() },
359 [nodes[1].node.get_our_node_id()], 100000);
360 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
361 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
363 // Now check that we can create a new channel
364 if reload_node && nodes[0].node.per_peer_state.read().unwrap().len() == 0 {
365 // If we dropped the channel before reloading the node, nodes[1] was also dropped from
366 // nodes[0] storage, and hence not connected again on startup. We therefore need to
367 // reconnect to the node before attempting to create a new channel.
368 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &Init {
369 features: nodes[1].node.init_features(), networks: None, remote_network_address: None
372 create_announced_chan_between_nodes(&nodes, 0, 1);
373 send_payment(&nodes[0], &[&nodes[1]], 8000000);
377 fn test_unconf_chan() {
378 do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
379 do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
380 do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
381 do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
383 do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
384 do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
385 do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
386 do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
390 fn test_unconf_chan_via_listen() {
391 do_test_unconf_chan(true, true, false, ConnectStyle::FullBlockViaListen);
392 do_test_unconf_chan(false, true, false, ConnectStyle::FullBlockViaListen);
393 do_test_unconf_chan(true, false, false, ConnectStyle::FullBlockViaListen);
394 do_test_unconf_chan(false, false, false, ConnectStyle::FullBlockViaListen);
398 fn test_unconf_chan_via_funding_unconfirmed() {
399 do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
400 do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
401 do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
402 do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
404 do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
405 do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
406 do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
407 do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
409 do_test_unconf_chan(true, true, true, ConnectStyle::FullBlockViaListen);
410 do_test_unconf_chan(false, true, true, ConnectStyle::FullBlockViaListen);
411 do_test_unconf_chan(true, false, true, ConnectStyle::FullBlockViaListen);
412 do_test_unconf_chan(false, false, true, ConnectStyle::FullBlockViaListen);
416 fn test_set_outpoints_partial_claiming() {
417 // - remote party claim tx, new bump tx
418 // - disconnect remote claiming tx, new bump
419 // - disconnect tx, see no tx anymore
420 let chanmon_cfgs = create_chanmon_cfgs(2);
421 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
422 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
423 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
425 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000);
426 let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
427 let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
429 // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
430 let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
431 assert_eq!(remote_txn.len(), 3);
432 assert_eq!(remote_txn[0].output.len(), 4);
433 assert_eq!(remote_txn[0].input.len(), 1);
434 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
435 check_spends!(remote_txn[1], remote_txn[0]);
436 check_spends!(remote_txn[2], remote_txn[0]);
438 // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
439 // Provide node A with both preimage
440 nodes[0].node.claim_funds(payment_preimage_1);
441 expect_payment_claimed!(nodes[0], payment_hash_1, 3_000_000);
442 nodes[0].node.claim_funds(payment_preimage_2);
443 expect_payment_claimed!(nodes[0], payment_hash_2, 3_000_000);
444 check_added_monitors!(nodes[0], 2);
445 nodes[0].node.get_and_clear_pending_msg_events();
447 // Connect blocks on node A commitment transaction
448 mine_transaction(&nodes[0], &remote_txn[0]);
449 check_closed_broadcast!(nodes[0], true);
450 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 1000000);
451 check_added_monitors!(nodes[0], 1);
452 // Verify node A broadcast tx claiming both HTLCs
454 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
455 // ChannelMonitor: claim tx
456 assert_eq!(node_txn.len(), 1);
457 check_spends!(node_txn[0], remote_txn[0]);
458 assert_eq!(node_txn[0].input.len(), 2);
462 // Connect blocks on node B
463 connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
464 check_closed_broadcast!(nodes[1], true);
465 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 1000000);
466 check_added_monitors!(nodes[1], 1);
467 // Verify node B broadcast 2 HTLC-timeout txn
468 let partial_claim_tx = {
469 let mut node_txn = nodes[1].tx_broadcaster.unique_txn_broadcast();
470 assert_eq!(node_txn.len(), 3);
471 check_spends!(node_txn[0], chan.3);
472 check_spends!(node_txn[1], node_txn[0]);
473 check_spends!(node_txn[2], node_txn[0]);
474 assert_eq!(node_txn[1].input.len(), 1);
475 assert_eq!(node_txn[2].input.len(), 1);
476 assert_ne!(node_txn[1].input[0].previous_output, node_txn[2].input[0].previous_output);
480 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
481 mine_transaction(&nodes[0], &partial_claim_tx);
483 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
484 assert_eq!(node_txn.len(), 1);
485 check_spends!(node_txn[0], remote_txn[0]);
486 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
489 nodes[0].node.get_and_clear_pending_msg_events();
491 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
492 disconnect_blocks(&nodes[0], 1);
494 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
495 assert_eq!(node_txn.len(), 1);
496 check_spends!(node_txn[0], remote_txn[0]);
497 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
501 //// Disconnect one more block and then reconnect multiple no transaction should be generated
502 disconnect_blocks(&nodes[0], 1);
503 connect_blocks(&nodes[0], 15);
505 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
506 assert_eq!(node_txn.len(), 0);
511 fn do_test_to_remote_after_local_detection(style: ConnectStyle) {
512 // In previous code, detection of to_remote outputs in a counterparty commitment transaction
513 // was dependent on whether a local commitment transaction had been seen on-chain previously.
514 // This resulted in some edge cases around not being able to generate a SpendableOutput event
517 // Here, we test this by first confirming one set of commitment transactions, then
518 // disconnecting them and reconnecting another. We then confirm them and check that the correct
519 // SpendableOutput event is generated.
520 let chanmon_cfgs = create_chanmon_cfgs(2);
521 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
522 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
523 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
525 *nodes[0].connect_style.borrow_mut() = style;
526 *nodes[1].connect_style.borrow_mut() = style;
528 let (_, _, chan_id, funding_tx) =
529 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 100_000_000);
530 let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
531 assert_eq!(funding_outpoint.to_channel_id(), chan_id);
533 let remote_txn_a = get_local_commitment_txn!(nodes[0], chan_id);
534 let remote_txn_b = get_local_commitment_txn!(nodes[1], chan_id);
536 mine_transaction(&nodes[0], &remote_txn_a[0]);
537 mine_transaction(&nodes[1], &remote_txn_a[0]);
539 assert!(nodes[0].node.list_channels().is_empty());
540 check_closed_broadcast!(nodes[0], true);
541 check_added_monitors!(nodes[0], 1);
542 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 1000000);
543 assert!(nodes[1].node.list_channels().is_empty());
544 check_closed_broadcast!(nodes[1], true);
545 check_added_monitors!(nodes[1], 1);
546 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 1000000);
548 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
549 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
551 disconnect_blocks(&nodes[0], 1);
552 disconnect_blocks(&nodes[1], 1);
554 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
555 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
556 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
557 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
559 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
560 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
562 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
563 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
564 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
565 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
567 mine_transaction(&nodes[0], &remote_txn_b[0]);
568 mine_transaction(&nodes[1], &remote_txn_b[0]);
570 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
571 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
572 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
573 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
575 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
576 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
578 let mut node_a_spendable = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
579 assert_eq!(node_a_spendable.len(), 1);
580 if let Event::SpendableOutputs { outputs, channel_id } = node_a_spendable.pop().unwrap() {
581 assert_eq!(outputs.len(), 1);
582 assert_eq!(channel_id, Some(chan_id));
583 let spend_tx = nodes[0].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
584 Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, None, &Secp256k1::new()).unwrap();
585 check_spends!(spend_tx, remote_txn_b[0]);
588 // nodes[1] is waiting for the to_self_delay to expire, which is many more than
589 // ANTI_REORG_DELAY. Instead, walk it back and confirm the original remote_txn_a commitment
590 // again and check that nodes[1] generates a similar spendable output.
591 // Technically a reorg of ANTI_REORG_DELAY violates our assumptions, so this is undefined by
592 // our API spec, but we currently handle this correctly and there's little reason we shouldn't
594 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
595 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY);
596 mine_transaction(&nodes[1], &remote_txn_a[0]);
597 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
599 let mut node_b_spendable = nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events();
600 assert_eq!(node_b_spendable.len(), 1);
601 if let Event::SpendableOutputs { outputs, channel_id } = node_b_spendable.pop().unwrap() {
602 assert_eq!(outputs.len(), 1);
603 assert_eq!(channel_id, Some(chan_id));
604 let spend_tx = nodes[1].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
605 Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, None, &Secp256k1::new()).unwrap();
606 check_spends!(spend_tx, remote_txn_a[0]);
611 fn test_to_remote_after_local_detection() {
612 do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirst);
613 do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstSkippingBlocks);
614 do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstReorgsOnlyTip);
615 do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirst);
616 do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstSkippingBlocks);
617 do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstReorgsOnlyTip);
618 do_test_to_remote_after_local_detection(ConnectStyle::FullBlockViaListen);