1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Further functional tests which test blockchain reorganizations.
12 use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor};
13 use chain::transaction::OutPoint;
14 use chain::{Confirm, Watch};
15 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs};
16 use ln::features::InitFeatures;
17 use ln::msgs::ChannelMessageHandler;
18 use util::enforcing_trait_impls::EnforcingSigner;
19 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
21 use util::ser::{ReadableArgs, Writeable};
23 use bitcoin::blockdata::block::{Block, BlockHeader};
24 use bitcoin::blockdata::script::Builder;
25 use bitcoin::blockdata::opcodes;
26 use bitcoin::hash_types::BlockHash;
27 use bitcoin::secp256k1::Secp256k1;
31 use bitcoin::hashes::Hash;
32 use bitcoin::TxMerkleNode;
34 use ln::functional_test_utils::*;
36 fn do_test_onchain_htlc_reorg(local_commitment: bool, claim: bool) {
37 // Our on-chain HTLC-claim learning has a few properties worth testing:
38 // * If an upstream HTLC is claimed with a preimage (both against our own commitment
39 // transaction our counterparty's), we claim it backwards immediately.
40 // * If an upstream HTLC is claimed with a timeout, we delay ANTI_REORG_DELAY before failing
41 // it backwards to ensure our counterparty can't claim with a preimage in a reorg.
43 // Here we test both properties in any combination based on the two bools passed in as
46 // If local_commitment is set, we first broadcast a local commitment containing an offered HTLC
47 // and an HTLC-Timeout tx, otherwise we broadcast a remote commitment containing a received
48 // HTLC and a local HTLC-Timeout tx spending it.
50 // We then either allow these transactions to confirm (if !claim) or we wait until one block
51 // before they otherwise would and reorg them out, confirming an HTLC-Success tx instead.
52 let chanmon_cfgs = create_chanmon_cfgs(3);
53 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
54 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
55 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
57 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
58 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
60 // Make sure all nodes are at the same starting height
61 connect_blocks(&nodes[0], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[0].best_block_info().1);
62 connect_blocks(&nodes[1], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[1].best_block_info().1);
63 connect_blocks(&nodes[2], 2*CHAN_CONFIRM_DEPTH + 1 - nodes[2].best_block_info().1);
65 let (our_payment_preimage, our_payment_hash, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1_000_000);
67 // Provide preimage to node 2 by claiming payment
68 nodes[2].node.claim_funds(our_payment_preimage);
69 expect_payment_claimed!(nodes[2], our_payment_hash, 1_000_000);
70 check_added_monitors!(nodes[2], 1);
71 get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
73 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 };
74 let claim_txn = if local_commitment {
75 // Broadcast node 1 commitment txn to broadcast the HTLC-Timeout
76 let node_1_commitment_txn = get_local_commitment_txn!(nodes[1], chan_2.2);
77 assert_eq!(node_1_commitment_txn.len(), 2); // 1 local commitment tx, 1 Outbound HTLC-Timeout
78 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-self and Offered HTLC (to-remote/to-node-3 is dust)
79 check_spends!(node_1_commitment_txn[0], chan_2.3);
80 check_spends!(node_1_commitment_txn[1], node_1_commitment_txn[0]);
82 // Give node 2 node 1's transactions and get its response (claiming the HTLC instead).
83 connect_block(&nodes[2], &Block { header, txdata: node_1_commitment_txn.clone() });
84 check_added_monitors!(nodes[2], 1);
85 check_closed_broadcast!(nodes[2], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
86 check_closed_event!(nodes[2], 1, ClosureReason::CommitmentTxConfirmed);
87 let node_2_commitment_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
88 assert_eq!(node_2_commitment_txn.len(), 3); // ChannelMonitor: 1 offered HTLC-Claim, ChannelManger: 1 local commitment tx, 1 Received HTLC-Claim
89 assert_eq!(node_2_commitment_txn[1].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
90 check_spends!(node_2_commitment_txn[1], chan_2.3);
91 check_spends!(node_2_commitment_txn[2], node_2_commitment_txn[1]);
92 check_spends!(node_2_commitment_txn[0], node_1_commitment_txn[0]);
94 // Make sure node 1's height is the same as the !local_commitment case
95 connect_blocks(&nodes[1], 1);
96 // Confirm node 1's commitment txn (and HTLC-Timeout) on node 1
97 header.prev_blockhash = nodes[1].best_block_hash();
98 connect_block(&nodes[1], &Block { header, txdata: node_1_commitment_txn.clone() });
100 // ...but return node 1's commitment tx in case claim is set and we're preparing to reorg
101 vec![node_1_commitment_txn[0].clone(), node_2_commitment_txn[0].clone()]
103 // Broadcast node 2 commitment txn
104 let mut node_2_commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
105 assert_eq!(node_2_commitment_txn.len(), 2); // 1 local commitment tx, 1 Received HTLC-Claim
106 assert_eq!(node_2_commitment_txn[0].output.len(), 2); // to-remote and Received HTLC (to-self is dust)
107 check_spends!(node_2_commitment_txn[0], chan_2.3);
108 check_spends!(node_2_commitment_txn[1], node_2_commitment_txn[0]);
110 // Give node 1 node 2's commitment transaction and get its response (timing the HTLC out)
111 mine_transaction(&nodes[1], &node_2_commitment_txn[0]);
112 connect_blocks(&nodes[1], TEST_FINAL_CLTV - 1); // Confirm blocks until the HTLC expires
113 let node_1_commitment_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
114 assert_eq!(node_1_commitment_txn.len(), 2); // ChannelMonitor: 1 offered HTLC-Timeout, ChannelManger: 1 local commitment tx
115 assert_eq!(node_1_commitment_txn[0].output.len(), 2); // to-local and Offered HTLC (to-remote is dust)
116 check_spends!(node_1_commitment_txn[0], chan_2.3);
117 check_spends!(node_1_commitment_txn[1], node_2_commitment_txn[0]);
119 // Confirm node 1's HTLC-Timeout on node 1
120 mine_transaction(&nodes[1], &node_1_commitment_txn[1]);
121 // ...but return node 2's commitment tx (and claim) in case claim is set and we're preparing to reorg
122 vec![node_2_commitment_txn.pop().unwrap()]
124 check_added_monitors!(nodes[1], 1);
125 check_closed_broadcast!(nodes[1], true); // We should get a BroadcastChannelUpdate (and *only* a BroadcstChannelUpdate)
126 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
127 // Connect ANTI_REORG_DELAY - 2 blocks, giving us a confirmation count of ANTI_REORG_DELAY - 1.
128 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
129 check_added_monitors!(nodes[1], 0);
130 assert_eq!(nodes[1].node.get_and_clear_pending_events().len(), 0);
133 // Disconnect Node 1's HTLC-Timeout which was connected above
134 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
137 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
140 connect_block(&nodes[1], &block);
142 // ChannelManager only polls chain::Watch::release_pending_monitor_events when we
143 // probe it for events, so we probe non-message events here (which should just be the
144 // PaymentForwarded event).
145 expect_payment_forwarded!(nodes[1], nodes[0], nodes[2], Some(1000), true, true);
147 // Confirm the timeout tx and check that we fail the HTLC backwards
149 header: BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
152 connect_block(&nodes[1], &block);
153 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 }]);
156 check_added_monitors!(nodes[1], 1);
157 // Which should result in an immediate claim/fail of the HTLC:
158 let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
160 assert_eq!(htlc_updates.update_fulfill_htlcs.len(), 1);
161 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fulfill_htlcs[0]);
163 assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
164 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
166 commitment_signed_dance!(nodes[0], nodes[1], htlc_updates.commitment_signed, false, true);
168 expect_payment_sent!(nodes[0], our_payment_preimage);
170 expect_payment_failed_with_update!(nodes[0], our_payment_hash, false, chan_2.0.contents.short_channel_id, true);
175 fn test_onchain_htlc_claim_reorg_local_commitment() {
176 do_test_onchain_htlc_reorg(true, true);
179 fn test_onchain_htlc_timeout_delay_local_commitment() {
180 do_test_onchain_htlc_reorg(true, false);
183 fn test_onchain_htlc_claim_reorg_remote_commitment() {
184 do_test_onchain_htlc_reorg(false, true);
187 fn test_onchain_htlc_timeout_delay_remote_commitment() {
188 do_test_onchain_htlc_reorg(false, false);
192 fn test_counterparty_revoked_reorg() {
193 // Test what happens when a revoked counterparty transaction is broadcast but then reorg'd out
194 // of the main chain. Specifically, HTLCs in the latest commitment transaction which are not
195 // included in the revoked commitment transaction should not be considered failed, and should
196 // still be claim-from-able after the reorg.
197 let chanmon_cfgs = create_chanmon_cfgs(2);
198 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
199 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
200 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
202 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
204 // Get the initial commitment transaction for broadcast, before any HTLCs are added at all.
205 let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
206 assert_eq!(revoked_local_txn.len(), 1);
208 // Now add two HTLCs in each direction, one dust and one not.
209 route_payment(&nodes[0], &[&nodes[1]], 5_000_000);
210 route_payment(&nodes[0], &[&nodes[1]], 5_000);
211 let (payment_preimage_3, payment_hash_3, ..) = route_payment(&nodes[1], &[&nodes[0]], 4_000_000);
212 let payment_hash_4 = route_payment(&nodes[1], &[&nodes[0]], 4_000).1;
214 nodes[0].node.claim_funds(payment_preimage_3);
215 let _ = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
216 check_added_monitors!(nodes[0], 1);
217 expect_payment_claimed!(nodes[0], payment_hash_3, 4_000_000);
219 let mut unrevoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
220 assert_eq!(unrevoked_local_txn.len(), 3); // commitment + 2 HTLC txn
221 // Sort the unrevoked transactions in reverse order, ie commitment tx, then HTLC 1 then HTLC 3
222 unrevoked_local_txn.sort_unstable_by_key(|tx| 1_000_000 - tx.output.iter().map(|outp| outp.value).sum::<u64>());
224 // Now mine A's old commitment transaction, which should close the channel, but take no action
225 // on any of the HTLCs, at least until we get six confirmations (which we won't get).
226 mine_transaction(&nodes[1], &revoked_local_txn[0]);
227 check_added_monitors!(nodes[1], 1);
228 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
229 check_closed_broadcast!(nodes[1], true);
231 // Connect up to one block before the revoked transaction would be considered final, then do a
232 // reorg that disconnects the full chain and goes up to the height at which the revoked
233 // transaction would be final.
234 let theoretical_conf_height = nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1;
235 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
236 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
237 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
239 disconnect_all_blocks(&nodes[1]);
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_blocks(&nodes[1], theoretical_conf_height);
244 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
245 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
247 // Now connect A's latest commitment transaction instead and resolve the HTLCs
248 mine_transaction(&nodes[1], &unrevoked_local_txn[0]);
249 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
250 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
252 // Connect the HTLC claim transaction for HTLC 3
253 mine_transaction(&nodes[1], &unrevoked_local_txn[2]);
254 expect_payment_sent!(nodes[1], payment_preimage_3);
255 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
257 // Connect blocks to confirm the unrevoked commitment transaction
258 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
259 expect_payment_failed!(nodes[1], payment_hash_4, true);
262 fn do_test_unconf_chan(reload_node: bool, reorg_after_reload: bool, use_funding_unconfirmed: bool, connect_style: ConnectStyle) {
263 // After creating a chan between nodes, we disconnect all blocks previously seen to force a
264 // channel close on nodes[0] side. We also use this to provide very basic testing of logic
265 // around freeing background events which store monitor updates during block_[dis]connected.
266 let chanmon_cfgs = create_chanmon_cfgs(2);
267 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
268 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
269 let persister: test_utils::TestPersister;
270 let new_chain_monitor: test_utils::TestChainMonitor;
271 let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
272 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
273 *nodes[0].connect_style.borrow_mut() = connect_style;
275 let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
277 let channel_state = nodes[0].node.channel_state.lock().unwrap();
278 assert_eq!(channel_state.by_id.len(), 1);
279 assert_eq!(channel_state.short_to_chan_info.len(), 2);
280 mem::drop(channel_state);
282 if !reorg_after_reload {
283 if use_funding_unconfirmed {
284 let relevant_txids = nodes[0].node.get_relevant_txids();
285 assert_eq!(&relevant_txids[..], &[chan.3.txid()]);
286 nodes[0].node.transaction_unconfirmed(&relevant_txids[0]);
287 } else if connect_style == ConnectStyle::FullBlockViaListen {
288 disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
289 assert_eq!(nodes[0].node.list_usable_channels().len(), 1);
290 disconnect_blocks(&nodes[0], 1);
292 disconnect_all_blocks(&nodes[0]);
294 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.");
295 check_added_monitors!(nodes[1], 1);
297 let channel_state = nodes[0].node.channel_state.lock().unwrap();
298 assert_eq!(channel_state.by_id.len(), 0);
299 assert_eq!(channel_state.short_to_chan_info.len(), 0);
304 // Since we currently have a background event pending, it's good to test that we survive a
305 // serialization roundtrip. Further, this tests the somewhat awkward edge-case of dropping
306 // the Channel object from the ChannelManager, but still having a monitor event pending for
307 // it when we go to deserialize, and then use the ChannelManager.
308 let nodes_0_serialized = nodes[0].node.encode();
309 let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
310 get_monitor!(nodes[0], chan.2).write(&mut chan_0_monitor_serialized).unwrap();
312 persister = test_utils::TestPersister::new();
313 let keys_manager = &chanmon_cfgs[0].keys_manager;
314 new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
315 nodes[0].chain_monitor = &new_chain_monitor;
316 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
317 let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
318 &mut chan_0_monitor_read, keys_manager).unwrap();
319 assert!(chan_0_monitor_read.is_empty());
321 let mut nodes_0_read = &nodes_0_serialized[..];
322 nodes_0_deserialized = {
323 let mut channel_monitors = HashMap::new();
324 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
325 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster,
326 &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(
327 &mut nodes_0_read, ChannelManagerReadArgs {
328 default_config: *nodes[0].node.get_current_default_configuration(),
330 fee_estimator: node_cfgs[0].fee_estimator,
331 chain_monitor: nodes[0].chain_monitor,
332 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
333 logger: nodes[0].logger,
337 nodes[0].node = &nodes_0_deserialized;
338 assert!(nodes_0_read.is_empty());
339 if !reorg_after_reload {
340 // If the channel is already closed when we reload the node, we'll broadcast a closing
341 // transaction via the ChannelMonitor which is missing a corresponding channel.
342 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
343 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
346 nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0.clone(), chan_0_monitor).unwrap();
347 check_added_monitors!(nodes[0], 1);
350 if reorg_after_reload {
351 if use_funding_unconfirmed {
352 let relevant_txids = nodes[0].node.get_relevant_txids();
353 assert_eq!(&relevant_txids[..], &[chan.3.txid()]);
354 nodes[0].node.transaction_unconfirmed(&relevant_txids[0]);
355 } else if connect_style == ConnectStyle::FullBlockViaListen {
356 disconnect_blocks(&nodes[0], CHAN_CONFIRM_DEPTH - 1);
357 assert_eq!(nodes[0].node.list_channels().len(), 1);
358 disconnect_blocks(&nodes[0], 1);
360 disconnect_all_blocks(&nodes[0]);
362 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.");
363 check_added_monitors!(nodes[1], 1);
365 let channel_state = nodes[0].node.channel_state.lock().unwrap();
366 assert_eq!(channel_state.by_id.len(), 0);
367 assert_eq!(channel_state.short_to_chan_info.len(), 0);
370 // With expect_channel_force_closed set the TestChainMonitor will enforce that the next update
371 // is a ChannelForcClosed on the right channel with should_broadcast set.
372 *nodes[0].chain_monitor.expect_channel_force_closed.lock().unwrap() = Some((chan.2, true));
373 nodes[0].node.test_process_background_events(); // Required to free the pending background monitor update
374 check_added_monitors!(nodes[0], 1);
375 let expected_err = "Funding transaction was un-confirmed. Locked at 6 confs, now have 0 confs.";
376 check_closed_event!(nodes[1], 1, ClosureReason::CounterpartyForceClosed { peer_msg: "Channel closed because of an exception: ".to_owned() + expected_err });
377 check_closed_event!(nodes[0], 1, ClosureReason::ProcessingError { err: expected_err.to_owned() });
378 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
379 nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
381 // Now check that we can create a new channel
382 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
383 send_payment(&nodes[0], &[&nodes[1]], 8000000);
387 fn test_unconf_chan() {
388 do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
389 do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstSkippingBlocks);
390 do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
391 do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstSkippingBlocks);
393 do_test_unconf_chan(true, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
394 do_test_unconf_chan(false, true, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
395 do_test_unconf_chan(true, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
396 do_test_unconf_chan(false, false, false, ConnectStyle::BestBlockFirstReorgsOnlyTip);
400 fn test_unconf_chan_via_listen() {
401 do_test_unconf_chan(true, true, false, ConnectStyle::FullBlockViaListen);
402 do_test_unconf_chan(false, true, false, ConnectStyle::FullBlockViaListen);
403 do_test_unconf_chan(true, false, false, ConnectStyle::FullBlockViaListen);
404 do_test_unconf_chan(false, false, false, ConnectStyle::FullBlockViaListen);
408 fn test_unconf_chan_via_funding_unconfirmed() {
409 do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
410 do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstSkippingBlocks);
411 do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
412 do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstSkippingBlocks);
414 do_test_unconf_chan(true, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
415 do_test_unconf_chan(false, true, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
416 do_test_unconf_chan(true, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
417 do_test_unconf_chan(false, false, true, ConnectStyle::BestBlockFirstReorgsOnlyTip);
419 do_test_unconf_chan(true, true, true, ConnectStyle::FullBlockViaListen);
420 do_test_unconf_chan(false, true, true, ConnectStyle::FullBlockViaListen);
421 do_test_unconf_chan(true, false, true, ConnectStyle::FullBlockViaListen);
422 do_test_unconf_chan(false, false, true, ConnectStyle::FullBlockViaListen);
426 fn test_set_outpoints_partial_claiming() {
427 // - remote party claim tx, new bump tx
428 // - disconnect remote claiming tx, new bump
429 // - disconnect tx, see no tx anymore
430 let chanmon_cfgs = create_chanmon_cfgs(2);
431 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
432 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
433 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
435 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
436 let (payment_preimage_1, payment_hash_1, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
437 let (payment_preimage_2, payment_hash_2, _) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
439 // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
440 let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
441 assert_eq!(remote_txn.len(), 3);
442 assert_eq!(remote_txn[0].output.len(), 4);
443 assert_eq!(remote_txn[0].input.len(), 1);
444 assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
445 check_spends!(remote_txn[1], remote_txn[0]);
446 check_spends!(remote_txn[2], remote_txn[0]);
448 // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
449 // Provide node A with both preimage
450 nodes[0].node.claim_funds(payment_preimage_1);
451 expect_payment_claimed!(nodes[0], payment_hash_1, 3_000_000);
452 nodes[0].node.claim_funds(payment_preimage_2);
453 expect_payment_claimed!(nodes[0], payment_hash_2, 3_000_000);
454 check_added_monitors!(nodes[0], 2);
455 nodes[0].node.get_and_clear_pending_msg_events();
457 // Connect blocks on node A commitment transaction
458 mine_transaction(&nodes[0], &remote_txn[0]);
459 check_closed_broadcast!(nodes[0], true);
460 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
461 check_added_monitors!(nodes[0], 1);
462 // Verify node A broadcast tx claiming both HTLCs
464 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
465 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
466 assert_eq!(node_txn.len(), 4);
467 check_spends!(node_txn[0], remote_txn[0]);
468 check_spends!(node_txn[1], chan.3);
469 check_spends!(node_txn[2], node_txn[1]);
470 check_spends!(node_txn[3], node_txn[1]);
471 assert_eq!(node_txn[0].input.len(), 2);
475 // Connect blocks on node B
476 connect_blocks(&nodes[1], 135);
477 check_closed_broadcast!(nodes[1], true);
478 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
479 check_added_monitors!(nodes[1], 1);
480 // Verify node B broadcast 2 HTLC-timeout txn
481 let partial_claim_tx = {
482 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
483 assert_eq!(node_txn.len(), 3);
484 check_spends!(node_txn[1], node_txn[0]);
485 check_spends!(node_txn[2], node_txn[0]);
486 assert_eq!(node_txn[1].input.len(), 1);
487 assert_eq!(node_txn[2].input.len(), 1);
491 // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
492 mine_transaction(&nodes[0], &partial_claim_tx);
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(), 1); //dropped HTLC
500 nodes[0].node.get_and_clear_pending_msg_events();
502 // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
503 disconnect_blocks(&nodes[0], 1);
505 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
506 assert_eq!(node_txn.len(), 1);
507 check_spends!(node_txn[0], remote_txn[0]);
508 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
512 //// Disconnect one more block and then reconnect multiple no transaction should be generated
513 disconnect_blocks(&nodes[0], 1);
514 connect_blocks(&nodes[0], 15);
516 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
517 assert_eq!(node_txn.len(), 0);
522 fn do_test_to_remote_after_local_detection(style: ConnectStyle) {
523 // In previous code, detection of to_remote outputs in a counterparty commitment transaction
524 // was dependent on whether a local commitment transaction had been seen on-chain previously.
525 // This resulted in some edge cases around not being able to generate a SpendableOutput event
528 // Here, we test this by first confirming one set of commitment transactions, then
529 // disconnecting them and reconnecting another. We then confirm them and check that the correct
530 // SpendableOutput event is generated.
531 let chanmon_cfgs = create_chanmon_cfgs(2);
532 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
533 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
534 let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
536 *nodes[0].connect_style.borrow_mut() = style;
537 *nodes[1].connect_style.borrow_mut() = style;
539 let (_, _, chan_id, funding_tx) =
540 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 100_000_000, InitFeatures::known(), InitFeatures::known());
541 let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
542 assert_eq!(funding_outpoint.to_channel_id(), chan_id);
544 let remote_txn_a = get_local_commitment_txn!(nodes[0], chan_id);
545 let remote_txn_b = get_local_commitment_txn!(nodes[1], chan_id);
547 mine_transaction(&nodes[0], &remote_txn_a[0]);
548 mine_transaction(&nodes[1], &remote_txn_a[0]);
550 assert!(nodes[0].node.list_channels().is_empty());
551 check_closed_broadcast!(nodes[0], true);
552 check_added_monitors!(nodes[0], 1);
553 check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed);
554 assert!(nodes[1].node.list_channels().is_empty());
555 check_closed_broadcast!(nodes[1], true);
556 check_added_monitors!(nodes[1], 1);
557 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
559 // Drop transactions broadcasted in response to the first commitment transaction (we have good
560 // test coverage of these things already elsewhere).
561 assert_eq!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
562 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0).len(), 1);
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 disconnect_blocks(&nodes[0], 1);
568 disconnect_blocks(&nodes[1], 1);
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 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
579 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
580 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
581 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
583 mine_transaction(&nodes[0], &remote_txn_b[0]);
584 mine_transaction(&nodes[1], &remote_txn_b[0]);
586 assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
587 assert!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
588 assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
589 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
591 connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
592 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
594 let mut node_a_spendable = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
595 assert_eq!(node_a_spendable.len(), 1);
596 if let Event::SpendableOutputs { outputs } = node_a_spendable.pop().unwrap() {
597 assert_eq!(outputs.len(), 1);
598 let spend_tx = nodes[0].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
599 Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &Secp256k1::new()).unwrap();
600 check_spends!(spend_tx, remote_txn_b[0]);
603 // nodes[1] is waiting for the to_self_delay to expire, which is many more than
604 // ANTI_REORG_DELAY. Instead, walk it back and confirm the original remote_txn_a commitment
605 // again and check that nodes[1] generates a similar spendable output.
606 // Technically a reorg of ANTI_REORG_DELAY violates our assumptions, so this is undefined by
607 // our API spec, but we currently handle this correctly and there's little reason we shouldn't
609 assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
610 disconnect_blocks(&nodes[1], ANTI_REORG_DELAY);
611 mine_transaction(&nodes[1], &remote_txn_a[0]);
612 connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
614 let mut node_b_spendable = nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events();
615 assert_eq!(node_b_spendable.len(), 1);
616 if let Event::SpendableOutputs { outputs } = node_b_spendable.pop().unwrap() {
617 assert_eq!(outputs.len(), 1);
618 let spend_tx = nodes[1].keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
619 Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, &Secp256k1::new()).unwrap();
620 check_spends!(spend_tx, remote_txn_a[0]);
625 fn test_to_remote_after_local_detection() {
626 do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirst);
627 do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstSkippingBlocks);
628 do_test_to_remote_after_local_detection(ConnectStyle::BestBlockFirstReorgsOnlyTip);
629 do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirst);
630 do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstSkippingBlocks);
631 do_test_to_remote_after_local_detection(ConnectStyle::TransactionsFirstReorgsOnlyTip);
632 do_test_to_remote_after_local_detection(ConnectStyle::FullBlockViaListen);