_ Git - rust-lightning/blob - lightning/src/ln/monitor_tests.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   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
   8 // licenses.
   9
  10 //! Further functional tests which test blockchain reorganizations.
  11
  12 use crate::sign::{EcdsaChannelSigner, SpendableOutputDescriptor};
  13 use crate::chain::channelmonitor::{ANTI_REORG_DELAY, LATENCY_GRACE_PERIOD_BLOCKS, Balance};
  14 use crate::chain::transaction::OutPoint;
  15 use crate::chain::chaininterface::{LowerBoundedFeeEstimator, compute_feerate_sat_per_1000_weight};
  16 use crate::events::bump_transaction::{BumpTransactionEvent, WalletSource};
  17 use crate::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
  18 use crate::ln::channel;
  19 use crate::ln::channelmanager::{BREAKDOWN_TIMEOUT, PaymentId, RecipientOnionFields};
  20 use crate::ln::msgs::ChannelMessageHandler;
  21 use crate::util::config::UserConfig;
  22 use crate::util::crypto::sign;
  23 use crate::util::ser::Writeable;
  24 use crate::util::scid_utils::block_from_scid;
  25 use crate::util::test_utils;
  26
  27 use bitcoin::blockdata::transaction::EcdsaSighashType;
  28 use bitcoin::blockdata::script::Builder;
  29 use bitcoin::blockdata::opcodes;
  30 use bitcoin::secp256k1::{Secp256k1, SecretKey};
  31 use bitcoin::{Amount, PublicKey, Script, Transaction, TxIn, TxOut, PackedLockTime, Witness};
  32 use bitcoin::util::sighash::SighashCache;
  33
  34 use crate::prelude::*;
  35
  36 use crate::ln::functional_test_utils::*;
  37
  38 #[test]
  39 fn chanmon_fail_from_stale_commitment() {
  40         // If we forward an HTLC to our counterparty, but we force-closed the channel before our
  41         // counterparty provides us an updated commitment transaction, we'll end up with a commitment
  42         // transaction that does not contain the HTLC which we attempted to forward. In this case, we
  43         // need to wait `ANTI_REORG_DELAY` blocks and then fail back the HTLC as there is no way for us
  44         // to learn the preimage and the confirmed commitment transaction paid us the value of the
  45         // HTLC.
  46         //
  47         // However, previously, we did not do this, ignoring the HTLC entirely.
  48         //
  49         // This could lead to channel closure if the sender we received the HTLC from decides to go on
  50         // chain to get their HTLC back before it times out.
  51         //
  52         // Here, we check exactly this case, forwarding a payment from A, through B, to C, before B
  53         // broadcasts its latest commitment transaction, which should result in it eventually failing
  54         // the HTLC back off-chain to A.
  55         let chanmon_cfgs = create_chanmon_cfgs(3);
  56         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
  57         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
  58         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
  59
  60         create_announced_chan_between_nodes(&nodes, 0, 1);
  61         let (update_a, _, chan_id_2, _) = create_announced_chan_between_nodes(&nodes, 1, 2);
  62
  63         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[2], 1_000_000);
  64         nodes[0].node.send_payment_with_route(&route, payment_hash,
  65                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
  66         check_added_monitors!(nodes[0], 1);
  67
  68         let bs_txn = get_local_commitment_txn!(nodes[1], chan_id_2);
  69
  70         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
  71         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
  72         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false);
  73
  74         expect_pending_htlcs_forwardable!(nodes[1]);
  75         get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
  76         check_added_monitors!(nodes[1], 1);
  77
  78         // Don't bother delivering the new HTLC add/commits, instead confirming the pre-HTLC commitment
  79         // transaction for nodes[1].
  80         mine_transaction(&nodes[1], &bs_txn[0]);
  81         check_added_monitors!(nodes[1], 1);
  82         check_closed_broadcast!(nodes[1], true);
  83         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[2].node.get_our_node_id()], 100000);
  84         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
  85
  86         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
  87         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_id_2 }]);
  88         check_added_monitors!(nodes[1], 1);
  89         let fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
  90
  91         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_updates.update_fail_htlcs[0]);
  92         commitment_signed_dance!(nodes[0], nodes[1], fail_updates.commitment_signed, true, true);
  93         expect_payment_failed_with_update!(nodes[0], payment_hash, false, update_a.contents.short_channel_id, true);
  94 }
  95
  96 fn test_spendable_output<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, spendable_tx: &Transaction, has_anchors_htlc_event: bool) -> Vec<SpendableOutputDescriptor> {
  97         let mut spendable = node.chain_monitor.chain_monitor.get_and_clear_pending_events();
  98         assert_eq!(spendable.len(), if has_anchors_htlc_event { 2 } else { 1 });
  99         if has_anchors_htlc_event {
 100                 if let Event::BumpTransaction(BumpTransactionEvent::HTLCResolution { .. }) = spendable.pop().unwrap() {}
 101                 else { panic!(); }
 102         }
 103         if let Event::SpendableOutputs { outputs, .. } = spendable.pop().unwrap() {
 104                 assert_eq!(outputs.len(), 1);
 105                 let spend_tx = node.keys_manager.backing.spend_spendable_outputs(&[&outputs[0]], Vec::new(),
 106                         Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(), 253, None, &Secp256k1::new()).unwrap();
 107                 check_spends!(spend_tx, spendable_tx);
 108                 outputs
 109         } else { panic!(); }
 110 }
 111
 112 #[test]
 113 fn revoked_output_htlc_resolution_timing() {
 114         // Tests that HTLCs which were present in a broadcasted remote revoked commitment transaction
 115         // are resolved only after a spend of the HTLC output reaches six confirmations. Preivously
 116         // they would resolve after the revoked commitment transaction itself reaches six
 117         // confirmations.
 118         let chanmon_cfgs = create_chanmon_cfgs(2);
 119         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 120         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 121         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 122
 123         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000);
 124
 125         let payment_hash_1 = route_payment(&nodes[1], &[&nodes[0]], 1_000_000).1;
 126
 127         // Get a commitment transaction which contains the HTLC we care about, but which we'll revoke
 128         // before forwarding.
 129         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
 130         assert_eq!(revoked_local_txn.len(), 1);
 131
 132         // Route a dust payment to revoke the above commitment transaction
 133         route_payment(&nodes[0], &[&nodes[1]], 1_000);
 134
 135         // Confirm the revoked commitment transaction, closing the channel.
 136         mine_transaction(&nodes[1], &revoked_local_txn[0]);
 137         check_added_monitors!(nodes[1], 1);
 138         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 1000000);
 139         check_closed_broadcast!(nodes[1], true);
 140
 141         let bs_spend_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 142         assert_eq!(bs_spend_txn.len(), 1);
 143         check_spends!(bs_spend_txn[0], revoked_local_txn[0]);
 144
 145         // After the commitment transaction confirms, we should still wait on the HTLC spend
 146         // transaction to confirm before resolving the HTLC.
 147         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 148         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 149         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 150
 151         // Spend the HTLC output, generating a HTLC failure event after ANTI_REORG_DELAY confirmations.
 152         mine_transaction(&nodes[1], &bs_spend_txn[0]);
 153         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 154         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 155
 156         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 157         expect_payment_failed!(nodes[1], payment_hash_1, false);
 158 }
 159
 160 fn do_chanmon_claim_value_coop_close(anchors: bool) {
 161         // Tests `get_claimable_balances` returns the correct values across a simple cooperative claim.
 162         // Specifically, this tests that the channel non-HTLC balances show up in
 163         // `get_claimable_balances` until the cooperative claims have confirmed and generated a
 164         // `SpendableOutputs` event, and no longer.
 165         let chanmon_cfgs = create_chanmon_cfgs(2);
 166         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 167         let mut user_config = test_default_channel_config();
 168         if anchors {
 169                 user_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
 170                 user_config.manually_accept_inbound_channels = true;
 171         }
 172         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(user_config), Some(user_config)]);
 173         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 174
 175         let (_, _, chan_id, funding_tx) =
 176                 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 1_000_000);
 177         let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
 178         assert_eq!(funding_outpoint.to_channel_id(), chan_id);
 179
 180         let chan_feerate = get_feerate!(nodes[0], nodes[1], chan_id) as u64;
 181         let channel_type_features = get_channel_type_features!(nodes[0], nodes[1], chan_id);
 182
 183         let commitment_tx_fee = chan_feerate * channel::commitment_tx_base_weight(&channel_type_features) / 1000;
 184         let anchor_outputs_value = if anchors { channel::ANCHOR_OUTPUT_VALUE_SATOSHI * 2 } else { 0 };
 185         assert_eq!(vec![Balance::ClaimableOnChannelClose {
 186                         amount_satoshis: 1_000_000 - 1_000 - commitment_tx_fee - anchor_outputs_value
 187                 }],
 188                 nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 189         assert_eq!(vec![Balance::ClaimableOnChannelClose { amount_satoshis: 1_000, }],
 190                 nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 191
 192         nodes[0].node.close_channel(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
 193         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 194         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 195         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 196         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 197
 198         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 199         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 200         let node_1_closing_signed = get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id());
 201         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed);
 202         let (_, node_0_2nd_closing_signed) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 203         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed.unwrap());
 204         let (_, node_1_none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 205         assert!(node_1_none.is_none());
 206
 207         let shutdown_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 208         assert_eq!(shutdown_tx, nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0));
 209         assert_eq!(shutdown_tx.len(), 1);
 210
 211         let shutdown_tx_conf_height_a = block_from_scid(&mine_transaction(&nodes[0], &shutdown_tx[0]));
 212         let shutdown_tx_conf_height_b = block_from_scid(&mine_transaction(&nodes[1], &shutdown_tx[0]));
 213
 214         assert!(nodes[0].node.list_channels().is_empty());
 215         assert!(nodes[1].node.list_channels().is_empty());
 216
 217         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 218         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 219
 220         assert_eq!(vec![Balance::ClaimableAwaitingConfirmations {
 221                         amount_satoshis: 1_000_000 - 1_000 - commitment_tx_fee - anchor_outputs_value,
 222                         confirmation_height: nodes[0].best_block_info().1 + ANTI_REORG_DELAY - 1,
 223                 }],
 224                 nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 225         assert_eq!(vec![Balance::ClaimableAwaitingConfirmations {
 226                         amount_satoshis: 1000,
 227                         confirmation_height: nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1,
 228                 }],
 229                 nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 230
 231         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 2);
 232         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
 233
 234         assert!(get_monitor!(nodes[0], chan_id)
 235                 .get_spendable_outputs(&shutdown_tx[0], shutdown_tx_conf_height_a).is_empty());
 236         assert!(get_monitor!(nodes[1], chan_id)
 237                 .get_spendable_outputs(&shutdown_tx[0], shutdown_tx_conf_height_b).is_empty());
 238
 239         connect_blocks(&nodes[0], 1);
 240         connect_blocks(&nodes[1], 1);
 241
 242         assert_eq!(Vec::<Balance>::new(),
 243                 nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 244         assert_eq!(Vec::<Balance>::new(),
 245                 nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 246
 247         let spendable_outputs_a = test_spendable_output(&nodes[0], &shutdown_tx[0], false);
 248         assert_eq!(
 249                 get_monitor!(nodes[0], chan_id).get_spendable_outputs(&shutdown_tx[0], shutdown_tx_conf_height_a),
 250                 spendable_outputs_a
 251         );
 252
 253         let spendable_outputs_b = test_spendable_output(&nodes[1], &shutdown_tx[0], false);
 254         assert_eq!(
 255                 get_monitor!(nodes[1], chan_id).get_spendable_outputs(&shutdown_tx[0], shutdown_tx_conf_height_b),
 256                 spendable_outputs_b
 257         );
 258
 259         check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure, [nodes[1].node.get_our_node_id()], 1000000);
 260         check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure, [nodes[0].node.get_our_node_id()], 1000000);
 261 }
 262
 263 #[test]
 264 fn chanmon_claim_value_coop_close() {
 265         do_chanmon_claim_value_coop_close(false);
 266         do_chanmon_claim_value_coop_close(true);
 267 }
 268
 269 fn sorted_vec<T: Ord>(mut v: Vec<T>) -> Vec<T> {
 270         v.sort_unstable();
 271         v
 272 }
 273
 274 /// Asserts that `a` and `b` are close, but maybe off by up to 5.
 275 /// This is useful when checking fees and weights on transactions as things may vary by a few based
 276 /// on signature size and signature size estimation being non-exact.
 277 fn fuzzy_assert_eq<V: core::convert::TryInto<u64>>(a: V, b: V) {
 278         let a_u64 = a.try_into().map_err(|_| ()).unwrap();
 279         let b_u64 = b.try_into().map_err(|_| ()).unwrap();
 280         eprintln!("Checking {} and {} for fuzzy equality", a_u64, b_u64);
 281         assert!(a_u64 >= b_u64 - 5);
 282         assert!(b_u64 >= a_u64 - 5);
 283 }
 284
 285 fn do_test_claim_value_force_close(anchors: bool, prev_commitment_tx: bool) {
 286         // Tests `get_claimable_balances` with an HTLC across a force-close.
 287         // We build a channel with an HTLC pending, then force close the channel and check that the
 288         // `get_claimable_balances` return value is correct as transactions confirm on-chain.
 289         let mut chanmon_cfgs = create_chanmon_cfgs(2);
 290         if prev_commitment_tx {
 291                 // We broadcast a second-to-latest commitment transaction, without providing the revocation
 292                 // secret to the counterparty. However, because we always immediately take the revocation
 293                 // secret from the keys_manager, we would panic at broadcast as we're trying to sign a
 294                 // transaction which, from the point of view of our keys_manager, is revoked.
 295                 chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
 296         }
 297         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 298         let mut user_config = test_default_channel_config();
 299         if anchors {
 300                 user_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
 301                 user_config.manually_accept_inbound_channels = true;
 302         }
 303         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(user_config), Some(user_config)]);
 304         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 305
 306         let coinbase_tx = Transaction {
 307                 version: 2,
 308                 lock_time: PackedLockTime::ZERO,
 309                 input: vec![TxIn { ..Default::default() }],
 310                 output: vec![
 311                         TxOut {
 312                                 value: Amount::ONE_BTC.to_sat(),
 313                                 script_pubkey: nodes[0].wallet_source.get_change_script().unwrap(),
 314                         },
 315                         TxOut {
 316                                 value: Amount::ONE_BTC.to_sat(),
 317                                 script_pubkey: nodes[1].wallet_source.get_change_script().unwrap(),
 318                         },
 319                 ],
 320         };
 321         if anchors {
 322                 nodes[0].wallet_source.add_utxo(bitcoin::OutPoint { txid: coinbase_tx.txid(), vout: 0 }, coinbase_tx.output[0].value);
 323                 nodes[1].wallet_source.add_utxo(bitcoin::OutPoint { txid: coinbase_tx.txid(), vout: 1 }, coinbase_tx.output[1].value);
 324         }
 325
 326         let (_, _, chan_id, funding_tx) =
 327                 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 1_000_000);
 328         let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
 329         assert_eq!(funding_outpoint.to_channel_id(), chan_id);
 330
 331         // This HTLC is immediately claimed, giving node B the preimage
 332         let (payment_preimage, payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 3_000_000);
 333         // This HTLC is allowed to time out, letting A claim it. However, in order to test claimable
 334         // balances more fully we also give B the preimage for this HTLC.
 335         let (timeout_payment_preimage, timeout_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 4_000_000);
 336         // This HTLC will be dust, and not be claimable at all:
 337         let (dust_payment_preimage, dust_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 3_000);
 338
 339         let htlc_cltv_timeout = nodes[0].best_block_info().1 + TEST_FINAL_CLTV + 1; // Note ChannelManager adds one to CLTV timeouts for safety
 340
 341         let chan_feerate = get_feerate!(nodes[0], nodes[1], chan_id);
 342         let channel_type_features = get_channel_type_features!(nodes[0], nodes[1], chan_id);
 343
 344         let remote_txn = get_local_commitment_txn!(nodes[1], chan_id);
 345         let sent_htlc_balance = Balance::MaybeTimeoutClaimableHTLC {
 346                 amount_satoshis: 3_000,
 347                 claimable_height: htlc_cltv_timeout,
 348                 payment_hash,
 349         };
 350         let sent_htlc_timeout_balance = Balance::MaybeTimeoutClaimableHTLC {
 351                 amount_satoshis: 4_000,
 352                 claimable_height: htlc_cltv_timeout,
 353                 payment_hash: timeout_payment_hash,
 354         };
 355         let received_htlc_balance = Balance::MaybePreimageClaimableHTLC {
 356                 amount_satoshis: 3_000,
 357                 expiry_height: htlc_cltv_timeout,
 358                 payment_hash,
 359         };
 360         let received_htlc_timeout_balance = Balance::MaybePreimageClaimableHTLC {
 361                 amount_satoshis: 4_000,
 362                 expiry_height: htlc_cltv_timeout,
 363                 payment_hash: timeout_payment_hash,
 364         };
 365         let received_htlc_claiming_balance = Balance::ContentiousClaimable {
 366                 amount_satoshis: 3_000,
 367                 timeout_height: htlc_cltv_timeout,
 368                 payment_hash,
 369                 payment_preimage,
 370         };
 371         let received_htlc_timeout_claiming_balance = Balance::ContentiousClaimable {
 372                 amount_satoshis: 4_000,
 373                 timeout_height: htlc_cltv_timeout,
 374                 payment_hash: timeout_payment_hash,
 375                 payment_preimage: timeout_payment_preimage,
 376         };
 377
 378         // Before B receives the payment preimage, it only suggests the push_msat value of 1_000 sats
 379         // as claimable. A lists both its to-self balance and the (possibly-claimable) HTLCs.
 380         let commitment_tx_fee = chan_feerate as u64 *
 381                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 382         let anchor_outputs_value = if anchors { 2 * channel::ANCHOR_OUTPUT_VALUE_SATOSHI } else { 0 };
 383         assert_eq!(sorted_vec(vec![Balance::ClaimableOnChannelClose {
 384                         amount_satoshis: 1_000_000 - 3_000 - 4_000 - 1_000 - 3 - commitment_tx_fee - anchor_outputs_value,
 385                 }, sent_htlc_balance.clone(), sent_htlc_timeout_balance.clone()]),
 386                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 387         assert_eq!(sorted_vec(vec![Balance::ClaimableOnChannelClose {
 388                         amount_satoshis: 1_000,
 389                 }, received_htlc_balance.clone(), received_htlc_timeout_balance.clone()]),
 390                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 391
 392         nodes[1].node.claim_funds(payment_preimage);
 393         check_added_monitors!(nodes[1], 1);
 394         expect_payment_claimed!(nodes[1], payment_hash, 3_000_000);
 395
 396         let b_htlc_msgs = get_htlc_update_msgs!(&nodes[1], nodes[0].node.get_our_node_id());
 397         // We claim the dust payment here as well, but it won't impact our claimable balances as its
 398         // dust and thus doesn't appear on chain at all.
 399         nodes[1].node.claim_funds(dust_payment_preimage);
 400         check_added_monitors!(nodes[1], 1);
 401         expect_payment_claimed!(nodes[1], dust_payment_hash, 3_000);
 402
 403         nodes[1].node.claim_funds(timeout_payment_preimage);
 404         check_added_monitors!(nodes[1], 1);
 405         expect_payment_claimed!(nodes[1], timeout_payment_hash, 4_000_000);
 406
 407         if prev_commitment_tx {
 408                 // To build a previous commitment transaction, deliver one round of commitment messages.
 409                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &b_htlc_msgs.update_fulfill_htlcs[0]);
 410                 expect_payment_sent(&nodes[0], payment_preimage, None, false, false);
 411                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &b_htlc_msgs.commitment_signed);
 412                 check_added_monitors!(nodes[0], 1);
 413                 let (as_raa, as_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 414                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
 415                 let _htlc_updates = get_htlc_update_msgs!(&nodes[1], nodes[0].node.get_our_node_id());
 416                 check_added_monitors!(nodes[1], 1);
 417                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs);
 418                 let _bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 419                 check_added_monitors!(nodes[1], 1);
 420         }
 421
 422         // Once B has received the payment preimage, it includes the value of the HTLC in its
 423         // "claimable if you were to close the channel" balance.
 424         let commitment_tx_fee = chan_feerate as u64 *
 425                 (channel::commitment_tx_base_weight(&channel_type_features) +
 426                 if prev_commitment_tx { 1 } else { 2 } * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 427         let mut a_expected_balances = vec![Balance::ClaimableOnChannelClose {
 428                         amount_satoshis: 1_000_000 - // Channel funding value in satoshis
 429                                 4_000 - // The to-be-failed HTLC value in satoshis
 430                                 3_000 - // The claimed HTLC value in satoshis
 431                                 1_000 - // The push_msat value in satoshis
 432                                 3 - // The dust HTLC value in satoshis
 433                                 commitment_tx_fee - // The commitment transaction fee with two HTLC outputs
 434                                 anchor_outputs_value, // The anchor outputs value in satoshis
 435                 }, sent_htlc_timeout_balance.clone()];
 436         if !prev_commitment_tx {
 437                 a_expected_balances.push(sent_htlc_balance.clone());
 438         }
 439         assert_eq!(sorted_vec(a_expected_balances),
 440                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 441         assert_eq!(vec![Balance::ClaimableOnChannelClose {
 442                         amount_satoshis: 1_000 + 3_000 + 4_000,
 443                 }],
 444                 nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 445
 446         // Broadcast the closing transaction (which has both pending HTLCs in it) and get B's
 447         // broadcasted HTLC claim transaction with preimage.
 448         let node_b_commitment_claimable = nodes[1].best_block_info().1 + BREAKDOWN_TIMEOUT as u32;
 449         mine_transaction(&nodes[0], &remote_txn[0]);
 450         mine_transaction(&nodes[1], &remote_txn[0]);
 451
 452         if anchors {
 453                 let mut events = nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events();
 454                 assert_eq!(events.len(), 1);
 455                 match events.pop().unwrap() {
 456                         Event::BumpTransaction(bump_event) => {
 457                                 let mut first_htlc_event = bump_event.clone();
 458                                 if let BumpTransactionEvent::HTLCResolution { ref mut htlc_descriptors, .. } = &mut first_htlc_event {
 459                                         htlc_descriptors.remove(1);
 460                                 } else {
 461                                         panic!("Unexpected event");
 462                                 }
 463                                 let mut second_htlc_event = bump_event;
 464                                 if let BumpTransactionEvent::HTLCResolution { ref mut htlc_descriptors, .. } = &mut second_htlc_event {
 465                                         htlc_descriptors.remove(0);
 466                                 } else {
 467                                         panic!("Unexpected event");
 468                                 }
 469                                 nodes[1].bump_tx_handler.handle_event(&first_htlc_event);
 470                                 nodes[1].bump_tx_handler.handle_event(&second_htlc_event);
 471                         },
 472                         _ => panic!("Unexpected event"),
 473                 }
 474         }
 475
 476         let b_broadcast_txn = nodes[1].tx_broadcaster.txn_broadcast();
 477         assert_eq!(b_broadcast_txn.len(), 2);
 478         // b_broadcast_txn should spend the HTLCs output of the commitment tx for 3_000 and 4_000 sats
 479         check_spends!(b_broadcast_txn[0], remote_txn[0], coinbase_tx);
 480         check_spends!(b_broadcast_txn[1], remote_txn[0], coinbase_tx);
 481         assert_eq!(b_broadcast_txn[0].input.len(), if anchors { 2 } else { 1 });
 482         assert_eq!(b_broadcast_txn[1].input.len(), if anchors { 2 } else { 1 });
 483         assert_eq!(remote_txn[0].output[b_broadcast_txn[0].input[0].previous_output.vout as usize].value, 3_000);
 484         assert_eq!(remote_txn[0].output[b_broadcast_txn[1].input[0].previous_output.vout as usize].value, 4_000);
 485
 486         assert!(nodes[0].node.list_channels().is_empty());
 487         check_closed_broadcast!(nodes[0], true);
 488         check_added_monitors!(nodes[0], 1);
 489         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 1000000);
 490         assert!(nodes[1].node.list_channels().is_empty());
 491         check_closed_broadcast!(nodes[1], true);
 492         check_added_monitors!(nodes[1], 1);
 493         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 1000000);
 494         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 495         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
 496
 497         // Once the commitment transaction confirms, we will wait until ANTI_REORG_DELAY until we
 498         // generate any `SpendableOutputs` events. Thus, the same balances will still be listed
 499         // available in `get_claimable_balances`. However, both will swap from `ClaimableOnClose` to
 500         // other Balance variants, as close has already happened.
 501         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 502         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 503         let commitment_tx_fee = chan_feerate as u64 *
 504                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 505         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
 506                         amount_satoshis: 1_000_000 - 3_000 - 4_000 - 1_000 - 3 - commitment_tx_fee - anchor_outputs_value,
 507                         confirmation_height: nodes[0].best_block_info().1 + ANTI_REORG_DELAY - 1,
 508                 }, sent_htlc_balance.clone(), sent_htlc_timeout_balance.clone()]),
 509                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 510         // The main non-HTLC balance is just awaiting confirmations, but the claimable height is the
 511         // CSV delay, not ANTI_REORG_DELAY.
 512         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
 513                         amount_satoshis: 1_000,
 514                         confirmation_height: node_b_commitment_claimable,
 515                 },
 516                 // Both HTLC balances are "contentious" as our counterparty could claim them if we wait too
 517                 // long.
 518                 received_htlc_claiming_balance.clone(), received_htlc_timeout_claiming_balance.clone()]),
 519                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 520
 521         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
 522         expect_payment_failed!(nodes[0], dust_payment_hash, false);
 523         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 524
 525         // After ANTI_REORG_DELAY, A will consider its balance fully spendable and generate a
 526         // `SpendableOutputs` event. However, B still has to wait for the CSV delay.
 527         assert_eq!(sorted_vec(vec![sent_htlc_balance.clone(), sent_htlc_timeout_balance.clone()]),
 528                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 529         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
 530                         amount_satoshis: 1_000,
 531                         confirmation_height: node_b_commitment_claimable,
 532                 }, received_htlc_claiming_balance.clone(), received_htlc_timeout_claiming_balance.clone()]),
 533                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 534
 535         test_spendable_output(&nodes[0], &remote_txn[0], false);
 536         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 537
 538         // After broadcasting the HTLC claim transaction, node A will still consider the HTLC
 539         // possibly-claimable up to ANTI_REORG_DELAY, at which point it will drop it.
 540         mine_transaction(&nodes[0], &b_broadcast_txn[0]);
 541         if prev_commitment_tx {
 542                 expect_payment_path_successful!(nodes[0]);
 543         } else {
 544                 expect_payment_sent(&nodes[0], payment_preimage, None, true, false);
 545         }
 546         assert_eq!(sorted_vec(vec![sent_htlc_balance.clone(), sent_htlc_timeout_balance.clone()]),
 547                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 548         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
 549         assert_eq!(vec![sent_htlc_timeout_balance.clone()],
 550                 nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 551
 552         // When the HTLC timeout output is spendable in the next block, A should broadcast it
 553         connect_blocks(&nodes[0], htlc_cltv_timeout - nodes[0].best_block_info().1);
 554         let a_broadcast_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 555         assert_eq!(a_broadcast_txn.len(), 2);
 556         assert_eq!(a_broadcast_txn[0].input.len(), 1);
 557         check_spends!(a_broadcast_txn[0], remote_txn[0]);
 558         assert_eq!(a_broadcast_txn[1].input.len(), 1);
 559         check_spends!(a_broadcast_txn[1], remote_txn[0]);
 560         assert_ne!(a_broadcast_txn[0].input[0].previous_output.vout,
 561                    a_broadcast_txn[1].input[0].previous_output.vout);
 562         // a_broadcast_txn [0] and [1] should spend the HTLC outputs of the commitment tx
 563         assert_eq!(remote_txn[0].output[a_broadcast_txn[0].input[0].previous_output.vout as usize].value, 3_000);
 564         assert_eq!(remote_txn[0].output[a_broadcast_txn[1].input[0].previous_output.vout as usize].value, 4_000);
 565
 566         // Once the HTLC-Timeout transaction confirms, A will no longer consider the HTLC
 567         // "MaybeClaimable", but instead move it to "AwaitingConfirmations".
 568         mine_transaction(&nodes[0], &a_broadcast_txn[1]);
 569         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 570         assert_eq!(vec![Balance::ClaimableAwaitingConfirmations {
 571                         amount_satoshis: 4_000,
 572                         confirmation_height: nodes[0].best_block_info().1 + ANTI_REORG_DELAY - 1,
 573                 }],
 574                 nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 575         // After ANTI_REORG_DELAY, A will generate a SpendableOutputs event and drop the claimable
 576         // balance entry.
 577         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
 578         assert_eq!(Vec::<Balance>::new(),
 579                 nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 580         expect_payment_failed!(nodes[0], timeout_payment_hash, false);
 581
 582         test_spendable_output(&nodes[0], &a_broadcast_txn[1], false);
 583
 584         // Node B will no longer consider the HTLC "contentious" after the HTLC claim transaction
 585         // confirms, and consider it simply "awaiting confirmations". Note that it has to wait for the
 586         // standard revocable transaction CSV delay before receiving a `SpendableOutputs`.
 587         let node_b_htlc_claimable = nodes[1].best_block_info().1 + BREAKDOWN_TIMEOUT as u32;
 588         mine_transaction(&nodes[1], &b_broadcast_txn[0]);
 589
 590         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
 591                         amount_satoshis: 1_000,
 592                         confirmation_height: node_b_commitment_claimable,
 593                 }, Balance::ClaimableAwaitingConfirmations {
 594                         amount_satoshis: 3_000,
 595                         confirmation_height: node_b_htlc_claimable,
 596                 }, received_htlc_timeout_claiming_balance.clone()]),
 597                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 598
 599         // After reaching the commitment output CSV, we'll get a SpendableOutputs event for it and have
 600         // only the HTLCs claimable on node B.
 601         connect_blocks(&nodes[1], node_b_commitment_claimable - nodes[1].best_block_info().1);
 602         test_spendable_output(&nodes[1], &remote_txn[0], anchors);
 603
 604         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
 605                         amount_satoshis: 3_000,
 606                         confirmation_height: node_b_htlc_claimable,
 607                 }, received_htlc_timeout_claiming_balance.clone()]),
 608                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 609
 610         // After reaching the claimed HTLC output CSV, we'll get a SpendableOutptus event for it and
 611         // have only one HTLC output left spendable.
 612         connect_blocks(&nodes[1], node_b_htlc_claimable - nodes[1].best_block_info().1);
 613         test_spendable_output(&nodes[1], &b_broadcast_txn[0], anchors);
 614
 615         assert_eq!(vec![received_htlc_timeout_claiming_balance.clone()],
 616                 nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 617
 618         // Finally, mine the HTLC timeout transaction that A broadcasted (even though B should be able
 619         // to claim this HTLC with the preimage it knows!). It will remain listed as a claimable HTLC
 620         // until ANTI_REORG_DELAY confirmations on the spend.
 621         mine_transaction(&nodes[1], &a_broadcast_txn[1]);
 622         assert_eq!(vec![received_htlc_timeout_claiming_balance.clone()],
 623                 nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 624         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 625         assert_eq!(Vec::<Balance>::new(),
 626                 nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 627
 628         // Ensure that even if we connect more blocks, potentially replaying the entire chain if we're
 629         // using `ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks`, we don't get new
 630         // monitor events or claimable balances.
 631         for node in nodes.iter() {
 632                 connect_blocks(node, 6);
 633                 connect_blocks(node, 6);
 634                 assert!(node.chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 635                 assert!(node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances().is_empty());
 636         }
 637 }
 638
 639 #[test]
 640 fn test_claim_value_force_close() {
 641         do_test_claim_value_force_close(false, true);
 642         do_test_claim_value_force_close(false, false);
 643         do_test_claim_value_force_close(true, true);
 644         do_test_claim_value_force_close(true, false);
 645 }
 646
 647 fn do_test_balances_on_local_commitment_htlcs(anchors: bool) {
 648         // Previously, when handling the broadcast of a local commitment transactions (with associated
 649         // CSV delays prior to spendability), we incorrectly handled the CSV delays on HTLC
 650         // transactions. This caused us to miss spendable outputs for HTLCs which were awaiting a CSV
 651         // delay prior to spendability.
 652         //
 653         // Further, because of this, we could hit an assertion as `get_claimable_balances` asserted
 654         // that HTLCs were resolved after the funding spend was resolved, which was not true if the
 655         // HTLC did not have a CSV delay attached (due to the above bug or due to it being an HTLC
 656         // claim by our counterparty).
 657         let chanmon_cfgs = create_chanmon_cfgs(2);
 658         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 659         let mut user_config = test_default_channel_config();
 660         if anchors {
 661                 user_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
 662                 user_config.manually_accept_inbound_channels = true;
 663         }
 664         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(user_config), Some(user_config)]);
 665         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 666
 667         let coinbase_tx = Transaction {
 668                 version: 2,
 669                 lock_time: PackedLockTime::ZERO,
 670                 input: vec![TxIn { ..Default::default() }],
 671                 output: vec![
 672                         TxOut {
 673                                 value: Amount::ONE_BTC.to_sat(),
 674                                 script_pubkey: nodes[0].wallet_source.get_change_script().unwrap(),
 675                         },
 676                         TxOut {
 677                                 value: Amount::ONE_BTC.to_sat(),
 678                                 script_pubkey: nodes[1].wallet_source.get_change_script().unwrap(),
 679                         },
 680                 ],
 681         };
 682         if anchors {
 683                 nodes[0].wallet_source.add_utxo(bitcoin::OutPoint { txid: coinbase_tx.txid(), vout: 0 }, coinbase_tx.output[0].value);
 684                 nodes[1].wallet_source.add_utxo(bitcoin::OutPoint { txid: coinbase_tx.txid(), vout: 1 }, coinbase_tx.output[1].value);
 685         }
 686
 687         // Create a single channel with two pending HTLCs from nodes[0] to nodes[1], one which nodes[1]
 688         // knows the preimage for, one which it does not.
 689         let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 0);
 690         let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
 691
 692         let (route, payment_hash, _, payment_secret) = get_route_and_payment_hash!(nodes[0], nodes[1], 10_000_000);
 693         let htlc_cltv_timeout = nodes[0].best_block_info().1 + TEST_FINAL_CLTV + 1; // Note ChannelManager adds one to CLTV timeouts for safety
 694         nodes[0].node.send_payment_with_route(&route, payment_hash,
 695                 RecipientOnionFields::secret_only(payment_secret), PaymentId(payment_hash.0)).unwrap();
 696         check_added_monitors!(nodes[0], 1);
 697
 698         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 699         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 700         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false);
 701
 702         expect_pending_htlcs_forwardable!(nodes[1]);
 703         expect_payment_claimable!(nodes[1], payment_hash, payment_secret, 10_000_000);
 704
 705         let (route_2, payment_hash_2, payment_preimage_2, payment_secret_2) = get_route_and_payment_hash!(nodes[0], nodes[1], 20_000_000);
 706         nodes[0].node.send_payment_with_route(&route_2, payment_hash_2,
 707                 RecipientOnionFields::secret_only(payment_secret_2), PaymentId(payment_hash_2.0)).unwrap();
 708         check_added_monitors!(nodes[0], 1);
 709
 710         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 711         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 712         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false);
 713
 714         expect_pending_htlcs_forwardable!(nodes[1]);
 715         expect_payment_claimable!(nodes[1], payment_hash_2, payment_secret_2, 20_000_000);
 716         nodes[1].node.claim_funds(payment_preimage_2);
 717         get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 718         check_added_monitors!(nodes[1], 1);
 719         expect_payment_claimed!(nodes[1], payment_hash_2, 20_000_000);
 720
 721         let chan_feerate = get_feerate!(nodes[0], nodes[1], chan_id) as u64;
 722         let channel_type_features = get_channel_type_features!(nodes[0], nodes[1], chan_id);
 723
 724         // First confirm the commitment transaction on nodes[0], which should leave us with three
 725         // claimable balances.
 726         let node_a_commitment_claimable = nodes[0].best_block_info().1 + BREAKDOWN_TIMEOUT as u32;
 727         nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
 728         check_added_monitors!(nodes[0], 1);
 729         check_closed_broadcast!(nodes[0], true);
 730         check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 1000000);
 731         let commitment_tx = {
 732                 let mut txn = nodes[0].tx_broadcaster.unique_txn_broadcast();
 733                 assert_eq!(txn.len(), 1);
 734                 let commitment_tx = txn.pop().unwrap();
 735                 check_spends!(commitment_tx, funding_tx);
 736                 commitment_tx
 737         };
 738         let commitment_tx_conf_height_a = block_from_scid(&mine_transaction(&nodes[0], &commitment_tx));
 739         if anchors && nodes[0].connect_style.borrow().updates_best_block_first() {
 740                 let mut txn = nodes[0].tx_broadcaster.txn_broadcast();
 741                 assert_eq!(txn.len(), 1);
 742                 assert_eq!(txn[0].txid(), commitment_tx.txid());
 743         }
 744
 745         let htlc_balance_known_preimage = Balance::MaybeTimeoutClaimableHTLC {
 746                 amount_satoshis: 10_000,
 747                 claimable_height: htlc_cltv_timeout,
 748                 payment_hash,
 749         };
 750         let htlc_balance_unknown_preimage = Balance::MaybeTimeoutClaimableHTLC {
 751                 amount_satoshis: 20_000,
 752                 claimable_height: htlc_cltv_timeout,
 753                 payment_hash: payment_hash_2,
 754         };
 755
 756         let commitment_tx_fee = chan_feerate *
 757                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 758         let anchor_outputs_value = if anchors { 2 * channel::ANCHOR_OUTPUT_VALUE_SATOSHI } else { 0 };
 759         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
 760                         amount_satoshis: 1_000_000 - 10_000 - 20_000 - commitment_tx_fee - anchor_outputs_value,
 761                         confirmation_height: node_a_commitment_claimable,
 762                 }, htlc_balance_known_preimage.clone(), htlc_balance_unknown_preimage.clone()]),
 763                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 764
 765         // Get nodes[1]'s HTLC claim tx for the second HTLC
 766         mine_transaction(&nodes[1], &commitment_tx);
 767         check_added_monitors!(nodes[1], 1);
 768         check_closed_broadcast!(nodes[1], true);
 769         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 1000000);
 770         let bs_htlc_claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 771         assert_eq!(bs_htlc_claim_txn.len(), 1);
 772         check_spends!(bs_htlc_claim_txn[0], commitment_tx);
 773
 774         // Connect blocks until the HTLCs expire, allowing us to (validly) broadcast the HTLC-Timeout
 775         // transaction.
 776         connect_blocks(&nodes[0], TEST_FINAL_CLTV);
 777         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
 778                         amount_satoshis: 1_000_000 - 10_000 - 20_000 - commitment_tx_fee - anchor_outputs_value,
 779                         confirmation_height: node_a_commitment_claimable,
 780                 }, htlc_balance_known_preimage.clone(), htlc_balance_unknown_preimage.clone()]),
 781                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 782         if anchors {
 783                 handle_bump_htlc_event(&nodes[0], 2);
 784         }
 785         let timeout_htlc_txn = nodes[0].tx_broadcaster.unique_txn_broadcast();
 786         assert_eq!(timeout_htlc_txn.len(), 2);
 787         check_spends!(timeout_htlc_txn[0], commitment_tx, coinbase_tx);
 788         check_spends!(timeout_htlc_txn[1], commitment_tx, coinbase_tx);
 789
 790         // Now confirm nodes[0]'s HTLC-Timeout transaction, which changes the claimable balance to an
 791         // "awaiting confirmations" one.
 792         let node_a_htlc_claimable = nodes[0].best_block_info().1 + BREAKDOWN_TIMEOUT as u32;
 793         mine_transaction(&nodes[0], &timeout_htlc_txn[0]);
 794         // Note that prior to the fix in the commit which introduced this test, this (and the next
 795         // balance) check failed. With this check removed, the code panicked in the `connect_blocks`
 796         // call, as described, two hunks down.
 797         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
 798                         amount_satoshis: 1_000_000 - 10_000 - 20_000 - commitment_tx_fee - anchor_outputs_value,
 799                         confirmation_height: node_a_commitment_claimable,
 800                 }, Balance::ClaimableAwaitingConfirmations {
 801                         amount_satoshis: 10_000,
 802                         confirmation_height: node_a_htlc_claimable,
 803                 }, htlc_balance_unknown_preimage.clone()]),
 804                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 805
 806         // Now confirm nodes[1]'s HTLC claim, giving nodes[0] the preimage. Note that the "maybe
 807         // claimable" balance remains until we see ANTI_REORG_DELAY blocks.
 808         mine_transaction(&nodes[0], &bs_htlc_claim_txn[0]);
 809         expect_payment_sent(&nodes[0], payment_preimage_2, None, true, false);
 810         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
 811                         amount_satoshis: 1_000_000 - 10_000 - 20_000 - commitment_tx_fee - anchor_outputs_value,
 812                         confirmation_height: node_a_commitment_claimable,
 813                 }, Balance::ClaimableAwaitingConfirmations {
 814                         amount_satoshis: 10_000,
 815                         confirmation_height: node_a_htlc_claimable,
 816                 }, htlc_balance_unknown_preimage.clone()]),
 817                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 818
 819         // Finally make the HTLC transactions have ANTI_REORG_DELAY blocks. This call previously
 820         // panicked as described in the test introduction. This will remove the "maybe claimable"
 821         // spendable output as nodes[1] has fully claimed the second HTLC.
 822         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
 823         expect_payment_failed!(nodes[0], payment_hash, false);
 824
 825         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
 826                         amount_satoshis: 1_000_000 - 10_000 - 20_000 - commitment_tx_fee - anchor_outputs_value,
 827                         confirmation_height: node_a_commitment_claimable,
 828                 }, Balance::ClaimableAwaitingConfirmations {
 829                         amount_satoshis: 10_000,
 830                         confirmation_height: node_a_htlc_claimable,
 831                 }]),
 832                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 833
 834         // Connect blocks until the commitment transaction's CSV expires, providing us the relevant
 835         // `SpendableOutputs` event and removing the claimable balance entry.
 836         connect_blocks(&nodes[0], node_a_commitment_claimable - nodes[0].best_block_info().1 - 1);
 837         assert!(get_monitor!(nodes[0], chan_id)
 838                 .get_spendable_outputs(&commitment_tx, commitment_tx_conf_height_a).is_empty());
 839         connect_blocks(&nodes[0], 1);
 840         assert_eq!(vec![Balance::ClaimableAwaitingConfirmations {
 841                         amount_satoshis: 10_000,
 842                         confirmation_height: node_a_htlc_claimable,
 843                 }],
 844                 nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
 845         let to_self_spendable_output = test_spendable_output(&nodes[0], &commitment_tx, false);
 846         assert_eq!(
 847                 get_monitor!(nodes[0], chan_id).get_spendable_outputs(&commitment_tx, commitment_tx_conf_height_a),
 848                 to_self_spendable_output
 849         );
 850
 851         // Connect blocks until the HTLC-Timeout's CSV expires, providing us the relevant
 852         // `SpendableOutputs` event and removing the claimable balance entry.
 853         connect_blocks(&nodes[0], node_a_htlc_claimable - nodes[0].best_block_info().1);
 854         assert!(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances().is_empty());
 855         test_spendable_output(&nodes[0], &timeout_htlc_txn[0], false);
 856
 857         // Ensure that even if we connect more blocks, potentially replaying the entire chain if we're
 858         // using `ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks`, we don't get new
 859         // monitor events or claimable balances.
 860         connect_blocks(&nodes[0], 6);
 861         connect_blocks(&nodes[0], 6);
 862         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
 863         assert!(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances().is_empty());
 864 }
 865
 866 #[test]
 867 fn test_balances_on_local_commitment_htlcs() {
 868         do_test_balances_on_local_commitment_htlcs(false);
 869         do_test_balances_on_local_commitment_htlcs(true);
 870 }
 871
 872 #[test]
 873 fn test_no_preimage_inbound_htlc_balances() {
 874         // Tests that MaybePreimageClaimableHTLC are generated for inbound HTLCs for which we do not
 875         // have a preimage.
 876         let chanmon_cfgs = create_chanmon_cfgs(2);
 877         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 878         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 879         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 880
 881         let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000);
 882         let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
 883
 884         // Send two HTLCs, one from A to B, and one from B to A.
 885         let to_b_failed_payment_hash = route_payment(&nodes[0], &[&nodes[1]], 10_000_000).1;
 886         let to_a_failed_payment_hash = route_payment(&nodes[1], &[&nodes[0]], 20_000_000).1;
 887         let htlc_cltv_timeout = nodes[0].best_block_info().1 + TEST_FINAL_CLTV + 1; // Note ChannelManager adds one to CLTV timeouts for safety
 888
 889         let chan_feerate = get_feerate!(nodes[0], nodes[1], chan_id) as u64;
 890         let channel_type_features = get_channel_type_features!(nodes[0], nodes[1], chan_id);
 891
 892         let a_sent_htlc_balance = Balance::MaybeTimeoutClaimableHTLC {
 893                 amount_satoshis: 10_000,
 894                 claimable_height: htlc_cltv_timeout,
 895                 payment_hash: to_b_failed_payment_hash,
 896         };
 897         let a_received_htlc_balance = Balance::MaybePreimageClaimableHTLC {
 898                 amount_satoshis: 20_000,
 899                 expiry_height: htlc_cltv_timeout,
 900                 payment_hash: to_a_failed_payment_hash,
 901         };
 902         let b_received_htlc_balance = Balance::MaybePreimageClaimableHTLC {
 903                 amount_satoshis: 10_000,
 904                 expiry_height: htlc_cltv_timeout,
 905                 payment_hash: to_b_failed_payment_hash,
 906         };
 907         let b_sent_htlc_balance = Balance::MaybeTimeoutClaimableHTLC {
 908                 amount_satoshis: 20_000,
 909                 claimable_height: htlc_cltv_timeout,
 910                 payment_hash: to_a_failed_payment_hash,
 911         };
 912
 913         // Both A and B will have an HTLC that's claimable on timeout and one that's claimable if they
 914         // receive the preimage. These will remain the same through the channel closure and until the
 915         // HTLC output is spent.
 916
 917         assert_eq!(sorted_vec(vec![Balance::ClaimableOnChannelClose {
 918                         amount_satoshis: 1_000_000 - 500_000 - 10_000 - chan_feerate *
 919                                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000,
 920                 }, a_received_htlc_balance.clone(), a_sent_htlc_balance.clone()]),
 921                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 922
 923         assert_eq!(sorted_vec(vec![Balance::ClaimableOnChannelClose {
 924                         amount_satoshis: 500_000 - 20_000,
 925                 }, b_received_htlc_balance.clone(), b_sent_htlc_balance.clone()]),
 926                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 927
 928         // Get nodes[0]'s commitment transaction and HTLC-Timeout transaction
 929         let as_txn = get_local_commitment_txn!(nodes[0], chan_id);
 930         assert_eq!(as_txn.len(), 2);
 931         check_spends!(as_txn[1], as_txn[0]);
 932         check_spends!(as_txn[0], funding_tx);
 933
 934         // Now close the channel by confirming A's commitment transaction on both nodes, checking the
 935         // claimable balances remain the same except for the non-HTLC balance changing variant.
 936         let node_a_commitment_claimable = nodes[0].best_block_info().1 + BREAKDOWN_TIMEOUT as u32;
 937         let as_pre_spend_claims = sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
 938                         amount_satoshis: 1_000_000 - 500_000 - 10_000 - chan_feerate *
 939                                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000,
 940                         confirmation_height: node_a_commitment_claimable,
 941                 }, a_received_htlc_balance.clone(), a_sent_htlc_balance.clone()]);
 942
 943         mine_transaction(&nodes[0], &as_txn[0]);
 944         nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 945         check_added_monitors!(nodes[0], 1);
 946         check_closed_broadcast!(nodes[0], true);
 947         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 1000000);
 948
 949         assert_eq!(as_pre_spend_claims,
 950                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 951
 952         mine_transaction(&nodes[1], &as_txn[0]);
 953         check_added_monitors!(nodes[1], 1);
 954         check_closed_broadcast!(nodes[1], true);
 955         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 1000000);
 956
 957         let node_b_commitment_claimable = nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1;
 958         let mut bs_pre_spend_claims = sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
 959                         amount_satoshis: 500_000 - 20_000,
 960                         confirmation_height: node_b_commitment_claimable,
 961                 }, b_received_htlc_balance.clone(), b_sent_htlc_balance.clone()]);
 962         assert_eq!(bs_pre_spend_claims,
 963                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 964
 965         // We'll broadcast the HTLC-Timeout transaction one block prior to the htlc's expiration (as it
 966         // is confirmable in the next block), but will still include the same claimable balances as no
 967         // HTLC has been spent, even after the HTLC expires. We'll also fail the inbound HTLC, but it
 968         // won't do anything as the channel is already closed.
 969
 970         connect_blocks(&nodes[0], TEST_FINAL_CLTV);
 971         let as_htlc_timeout_claim = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 972         assert_eq!(as_htlc_timeout_claim.len(), 1);
 973         check_spends!(as_htlc_timeout_claim[0], as_txn[0]);
 974         expect_pending_htlcs_forwardable_conditions!(nodes[0],
 975                 [HTLCDestination::FailedPayment { payment_hash: to_a_failed_payment_hash }]);
 976
 977         assert_eq!(as_pre_spend_claims,
 978                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 979
 980         connect_blocks(&nodes[0], 1);
 981         assert_eq!(as_pre_spend_claims,
 982                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
 983
 984         // For node B, we'll get the non-HTLC funds claimable after ANTI_REORG_DELAY confirmations
 985         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
 986         test_spendable_output(&nodes[1], &as_txn[0], false);
 987         bs_pre_spend_claims.retain(|e| if let Balance::ClaimableAwaitingConfirmations { .. } = e { false } else { true });
 988
 989         // The next few blocks for B look the same as for A, though for the opposite HTLC
 990         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 991         connect_blocks(&nodes[1], TEST_FINAL_CLTV - (ANTI_REORG_DELAY - 1));
 992         expect_pending_htlcs_forwardable_conditions!(nodes[1],
 993                 [HTLCDestination::FailedPayment { payment_hash: to_b_failed_payment_hash }]);
 994         let bs_htlc_timeout_claim = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
 995         assert_eq!(bs_htlc_timeout_claim.len(), 1);
 996         check_spends!(bs_htlc_timeout_claim[0], as_txn[0]);
 997
 998         assert_eq!(bs_pre_spend_claims,
 999                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1000
1001         connect_blocks(&nodes[1], 1);
1002         assert_eq!(bs_pre_spend_claims,
1003                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1004
1005         // Now confirm the two HTLC timeout transactions for A, checking that the inbound HTLC resolves
1006         // after ANTI_REORG_DELAY confirmations and the other takes BREAKDOWN_TIMEOUT confirmations.
1007         mine_transaction(&nodes[0], &as_htlc_timeout_claim[0]);
1008         let as_timeout_claimable_height = nodes[0].best_block_info().1 + (BREAKDOWN_TIMEOUT as u32) - 1;
1009         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
1010                         amount_satoshis: 1_000_000 - 500_000 - 10_000 - chan_feerate *
1011                                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000,
1012                         confirmation_height: node_a_commitment_claimable,
1013                 }, a_received_htlc_balance.clone(), Balance::ClaimableAwaitingConfirmations {
1014                         amount_satoshis: 10_000,
1015                         confirmation_height: as_timeout_claimable_height,
1016                 }]),
1017                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1018
1019         mine_transaction(&nodes[0], &bs_htlc_timeout_claim[0]);
1020         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
1021                         amount_satoshis: 1_000_000 - 500_000 - 10_000 - chan_feerate *
1022                                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000,
1023                         confirmation_height: node_a_commitment_claimable,
1024                 }, a_received_htlc_balance.clone(), Balance::ClaimableAwaitingConfirmations {
1025                         amount_satoshis: 10_000,
1026                         confirmation_height: as_timeout_claimable_height,
1027                 }]),
1028                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1029
1030         // Once as_htlc_timeout_claim[0] reaches ANTI_REORG_DELAY confirmations, we should get a
1031         // payment failure event.
1032         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 2);
1033         expect_payment_failed!(nodes[0], to_b_failed_payment_hash, false);
1034
1035         connect_blocks(&nodes[0], 1);
1036         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
1037                         amount_satoshis: 1_000_000 - 500_000 - 10_000 - chan_feerate *
1038                                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000,
1039                         confirmation_height: node_a_commitment_claimable,
1040                 }, Balance::ClaimableAwaitingConfirmations {
1041                         amount_satoshis: 10_000,
1042                         confirmation_height: core::cmp::max(as_timeout_claimable_height, htlc_cltv_timeout),
1043                 }]),
1044                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1045
1046         connect_blocks(&nodes[0], node_a_commitment_claimable - nodes[0].best_block_info().1);
1047         assert_eq!(vec![Balance::ClaimableAwaitingConfirmations {
1048                         amount_satoshis: 10_000,
1049                         confirmation_height: core::cmp::max(as_timeout_claimable_height, htlc_cltv_timeout),
1050                 }],
1051                 nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
1052         test_spendable_output(&nodes[0], &as_txn[0], false);
1053
1054         connect_blocks(&nodes[0], as_timeout_claimable_height - nodes[0].best_block_info().1);
1055         assert!(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances().is_empty());
1056         test_spendable_output(&nodes[0], &as_htlc_timeout_claim[0], false);
1057
1058         // The process for B should be completely identical as well, noting that the non-HTLC-balance
1059         // was already claimed.
1060         mine_transaction(&nodes[1], &bs_htlc_timeout_claim[0]);
1061         let bs_timeout_claimable_height = nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1;
1062         assert_eq!(sorted_vec(vec![b_received_htlc_balance.clone(), Balance::ClaimableAwaitingConfirmations {
1063                         amount_satoshis: 20_000,
1064                         confirmation_height: bs_timeout_claimable_height,
1065                 }]),
1066                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1067
1068         mine_transaction(&nodes[1], &as_htlc_timeout_claim[0]);
1069         assert_eq!(sorted_vec(vec![b_received_htlc_balance.clone(), Balance::ClaimableAwaitingConfirmations {
1070                         amount_satoshis: 20_000,
1071                         confirmation_height: bs_timeout_claimable_height,
1072                 }]),
1073                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1074
1075         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
1076         expect_payment_failed!(nodes[1], to_a_failed_payment_hash, false);
1077
1078         assert_eq!(vec![b_received_htlc_balance.clone()],
1079                 nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
1080         test_spendable_output(&nodes[1], &bs_htlc_timeout_claim[0], false);
1081
1082         connect_blocks(&nodes[1], 1);
1083         assert!(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances().is_empty());
1084
1085         // Ensure that even if we connect more blocks, potentially replaying the entire chain if we're
1086         // using `ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks`, we don't get new
1087         // monitor events or claimable balances.
1088         connect_blocks(&nodes[1], 6);
1089         connect_blocks(&nodes[1], 6);
1090         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
1091         assert!(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances().is_empty());
1092 }
1093
1094 fn sorted_vec_with_additions<T: Ord + Clone>(v_orig: &Vec<T>, extra_ts: &[&T]) -> Vec<T> {
1095         let mut v = v_orig.clone();
1096         for t in extra_ts {
1097                 v.push((*t).clone());
1098         }
1099         v.sort_unstable();
1100         v
1101 }
1102
1103 fn do_test_revoked_counterparty_commitment_balances(confirm_htlc_spend_first: bool) {
1104         // Tests `get_claimable_balances` for revoked counterparty commitment transactions.
1105         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1106         // We broadcast a second-to-latest commitment transaction, without providing the revocation
1107         // secret to the counterparty. However, because we always immediately take the revocation
1108         // secret from the keys_manager, we would panic at broadcast as we're trying to sign a
1109         // transaction which, from the point of view of our keys_manager, is revoked.
1110         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
1111         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1112         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1113         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1114
1115         let (_, _, chan_id, funding_tx) =
1116                 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 100_000_000);
1117         let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
1118         assert_eq!(funding_outpoint.to_channel_id(), chan_id);
1119
1120         // We create five HTLCs for B to claim against A's revoked commitment transaction:
1121         //
1122         // (1) one for which A is the originator and B knows the preimage
1123         // (2) one for which B is the originator where the HTLC has since timed-out
1124         // (3) one for which B is the originator but where the HTLC has not yet timed-out
1125         // (4) one dust HTLC which is lost in the channel closure
1126         // (5) one that actually isn't in the revoked commitment transaction at all, but was added in
1127         //     later commitment transaction updates
1128         //
1129         // Though they could all be claimed in a single claim transaction, due to CLTV timeouts they
1130         // are all currently claimed in separate transactions, which helps us test as we can claim
1131         // HTLCs individually.
1132
1133         let (claimed_payment_preimage, claimed_payment_hash, ..) = route_payment(&nodes[0], &[&nodes[1]], 3_000_000);
1134         let timeout_payment_hash = route_payment(&nodes[1], &[&nodes[0]], 4_000_000).1;
1135         let dust_payment_hash = route_payment(&nodes[1], &[&nodes[0]], 3_000).1;
1136
1137         let htlc_cltv_timeout = nodes[0].best_block_info().1 + TEST_FINAL_CLTV + 1; // Note ChannelManager adds one to CLTV timeouts for safety
1138
1139         connect_blocks(&nodes[0], 10);
1140         connect_blocks(&nodes[1], 10);
1141
1142         let live_htlc_cltv_timeout = nodes[0].best_block_info().1 + TEST_FINAL_CLTV + 1; // Note ChannelManager adds one to CLTV timeouts for safety
1143         let live_payment_hash = route_payment(&nodes[1], &[&nodes[0]], 5_000_000).1;
1144
1145         // Get the latest commitment transaction from A and then update the fee to revoke it
1146         let as_revoked_txn = get_local_commitment_txn!(nodes[0], chan_id);
1147         let channel_type_features = get_channel_type_features!(nodes[0], nodes[1], chan_id);
1148
1149         let chan_feerate = get_feerate!(nodes[0], nodes[1], chan_id) as u64;
1150
1151         let missing_htlc_cltv_timeout = nodes[0].best_block_info().1 + TEST_FINAL_CLTV + 1; // Note ChannelManager adds one to CLTV timeouts for safety
1152         let missing_htlc_payment_hash = route_payment(&nodes[1], &[&nodes[0]], 2_000_000).1;
1153
1154         nodes[1].node.claim_funds(claimed_payment_preimage);
1155         expect_payment_claimed!(nodes[1], claimed_payment_hash, 3_000_000);
1156         check_added_monitors!(nodes[1], 1);
1157         let _b_htlc_msgs = get_htlc_update_msgs!(&nodes[1], nodes[0].node.get_our_node_id());
1158
1159         connect_blocks(&nodes[0], htlc_cltv_timeout + 1 - 10);
1160         check_closed_broadcast!(nodes[0], true);
1161         check_added_monitors!(nodes[0], 1);
1162
1163         let mut events = nodes[0].node.get_and_clear_pending_events();
1164         assert_eq!(events.len(), 6);
1165         let mut failed_payments: HashSet<_> =
1166                 [timeout_payment_hash, dust_payment_hash, live_payment_hash, missing_htlc_payment_hash]
1167                 .iter().map(|a| *a).collect();
1168         events.retain(|ev| {
1169                 match ev {
1170                         Event::HTLCHandlingFailed { failed_next_destination: HTLCDestination::NextHopChannel { node_id, channel_id }, .. } => {
1171                                 assert_eq!(*channel_id, chan_id);
1172                                 assert_eq!(*node_id, Some(nodes[1].node.get_our_node_id()));
1173                                 false
1174                         },
1175                         Event::HTLCHandlingFailed { failed_next_destination: HTLCDestination::FailedPayment { payment_hash }, .. } => {
1176                                 assert!(failed_payments.remove(payment_hash));
1177                                 false
1178                         },
1179                         _ => true,
1180                 }
1181         });
1182         assert!(failed_payments.is_empty());
1183         if let Event::PendingHTLCsForwardable { .. } = events[0] {} else { panic!(); }
1184         match &events[1] {
1185                 Event::ChannelClosed { reason: ClosureReason::HolderForceClosed, .. } => {},
1186                 _ => panic!(),
1187         }
1188
1189         connect_blocks(&nodes[1], htlc_cltv_timeout + 1 - 10);
1190         check_closed_broadcast!(nodes[1], true);
1191         check_added_monitors!(nodes[1], 1);
1192         check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed, [nodes[0].node.get_our_node_id()], 1000000);
1193
1194         // Prior to channel closure, B considers the preimage HTLC as its own, and otherwise only
1195         // lists the two on-chain timeout-able HTLCs as claimable balances.
1196         assert_eq!(sorted_vec(vec![Balance::ClaimableOnChannelClose {
1197                         amount_satoshis: 100_000 - 5_000 - 4_000 - 3 - 2_000 + 3_000,
1198                 }, Balance::MaybeTimeoutClaimableHTLC {
1199                         amount_satoshis: 2_000,
1200                         claimable_height: missing_htlc_cltv_timeout,
1201                         payment_hash: missing_htlc_payment_hash,
1202                 }, Balance::MaybeTimeoutClaimableHTLC {
1203                         amount_satoshis: 4_000,
1204                         claimable_height: htlc_cltv_timeout,
1205                         payment_hash: timeout_payment_hash,
1206                 }, Balance::MaybeTimeoutClaimableHTLC {
1207                         amount_satoshis: 5_000,
1208                         claimable_height: live_htlc_cltv_timeout,
1209                         payment_hash: live_payment_hash,
1210                 }]),
1211                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1212
1213         mine_transaction(&nodes[1], &as_revoked_txn[0]);
1214         let mut claim_txn: Vec<_> = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().drain(..).filter(|tx| tx.input.iter().any(|inp| inp.previous_output.txid == as_revoked_txn[0].txid())).collect();
1215         // Currently the revoked commitment is claimed in four transactions as the HTLCs all expire
1216         // quite soon.
1217         assert_eq!(claim_txn.len(), 4);
1218         claim_txn.sort_unstable_by_key(|tx| tx.output.iter().map(|output| output.value).sum::<u64>());
1219
1220         // The following constants were determined experimentally
1221         const BS_TO_SELF_CLAIM_EXP_WEIGHT: usize = 483;
1222         const OUTBOUND_HTLC_CLAIM_EXP_WEIGHT: usize = 571;
1223         const INBOUND_HTLC_CLAIM_EXP_WEIGHT: usize = 578;
1224
1225         // Check that the weight is close to the expected weight. Note that signature sizes vary
1226         // somewhat so it may not always be exact.
1227         fuzzy_assert_eq(claim_txn[0].weight(), OUTBOUND_HTLC_CLAIM_EXP_WEIGHT);
1228         fuzzy_assert_eq(claim_txn[1].weight(), INBOUND_HTLC_CLAIM_EXP_WEIGHT);
1229         fuzzy_assert_eq(claim_txn[2].weight(), INBOUND_HTLC_CLAIM_EXP_WEIGHT);
1230         fuzzy_assert_eq(claim_txn[3].weight(), BS_TO_SELF_CLAIM_EXP_WEIGHT);
1231
1232         // The expected balance for the next three checks, with the largest-HTLC and to_self output
1233         // claim balances separated out.
1234         let expected_balance = vec![Balance::ClaimableAwaitingConfirmations {
1235                         // to_remote output in A's revoked commitment
1236                         amount_satoshis: 100_000 - 5_000 - 4_000 - 3,
1237                         confirmation_height: nodes[1].best_block_info().1 + 5,
1238                 }, Balance::CounterpartyRevokedOutputClaimable {
1239                         amount_satoshis: 3_000,
1240                 }, Balance::CounterpartyRevokedOutputClaimable {
1241                         amount_satoshis: 4_000,
1242                 }];
1243
1244         let to_self_unclaimed_balance = Balance::CounterpartyRevokedOutputClaimable {
1245                 amount_satoshis: 1_000_000 - 100_000 - 3_000 - chan_feerate *
1246                         (channel::commitment_tx_base_weight(&channel_type_features) + 3 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000,
1247         };
1248         let to_self_claimed_avail_height;
1249         let largest_htlc_unclaimed_balance = Balance::CounterpartyRevokedOutputClaimable {
1250                 amount_satoshis: 5_000,
1251         };
1252         let largest_htlc_claimed_avail_height;
1253
1254         // Once the channel has been closed by A, B now considers all of the commitment transactions'
1255         // outputs as `CounterpartyRevokedOutputClaimable`.
1256         assert_eq!(sorted_vec_with_additions(&expected_balance, &[&to_self_unclaimed_balance, &largest_htlc_unclaimed_balance]),
1257                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1258
1259         if confirm_htlc_spend_first {
1260                 mine_transaction(&nodes[1], &claim_txn[2]);
1261                 largest_htlc_claimed_avail_height = nodes[1].best_block_info().1 + 5;
1262                 to_self_claimed_avail_height = nodes[1].best_block_info().1 + 6; // will be claimed in the next block
1263         } else {
1264                 // Connect the to_self output claim, taking all of A's non-HTLC funds
1265                 mine_transaction(&nodes[1], &claim_txn[3]);
1266                 to_self_claimed_avail_height = nodes[1].best_block_info().1 + 5;
1267                 largest_htlc_claimed_avail_height = nodes[1].best_block_info().1 + 6; // will be claimed in the next block
1268         }
1269
1270         let largest_htlc_claimed_balance = Balance::ClaimableAwaitingConfirmations {
1271                 amount_satoshis: 5_000 - chan_feerate * INBOUND_HTLC_CLAIM_EXP_WEIGHT as u64 / 1000,
1272                 confirmation_height: largest_htlc_claimed_avail_height,
1273         };
1274         let to_self_claimed_balance = Balance::ClaimableAwaitingConfirmations {
1275                 amount_satoshis: 1_000_000 - 100_000 - 3_000 - chan_feerate *
1276                         (channel::commitment_tx_base_weight(&channel_type_features) + 3 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000
1277                         - chan_feerate * claim_txn[3].weight() as u64 / 1000,
1278                 confirmation_height: to_self_claimed_avail_height,
1279         };
1280
1281         if confirm_htlc_spend_first {
1282                 assert_eq!(sorted_vec_with_additions(&expected_balance, &[&to_self_unclaimed_balance, &largest_htlc_claimed_balance]),
1283                         sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1284         } else {
1285                 assert_eq!(sorted_vec_with_additions(&expected_balance, &[&to_self_claimed_balance, &largest_htlc_unclaimed_balance]),
1286                         sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1287         }
1288
1289         if confirm_htlc_spend_first {
1290                 mine_transaction(&nodes[1], &claim_txn[3]);
1291         } else {
1292                 mine_transaction(&nodes[1], &claim_txn[2]);
1293         }
1294         assert_eq!(sorted_vec_with_additions(&expected_balance, &[&to_self_claimed_balance, &largest_htlc_claimed_balance]),
1295                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1296
1297         // Finally, connect the last two remaining HTLC spends and check that they move to
1298         // `ClaimableAwaitingConfirmations`
1299         mine_transaction(&nodes[1], &claim_txn[0]);
1300         mine_transaction(&nodes[1], &claim_txn[1]);
1301
1302         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
1303                         // to_remote output in A's revoked commitment
1304                         amount_satoshis: 100_000 - 5_000 - 4_000 - 3,
1305                         confirmation_height: nodes[1].best_block_info().1 + 1,
1306                 }, Balance::ClaimableAwaitingConfirmations {
1307                         amount_satoshis: 1_000_000 - 100_000 - 3_000 - chan_feerate *
1308                                 (channel::commitment_tx_base_weight(&channel_type_features) + 3 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000
1309                                 - chan_feerate * claim_txn[3].weight() as u64 / 1000,
1310                         confirmation_height: to_self_claimed_avail_height,
1311                 }, Balance::ClaimableAwaitingConfirmations {
1312                         amount_satoshis: 3_000 - chan_feerate * OUTBOUND_HTLC_CLAIM_EXP_WEIGHT as u64 / 1000,
1313                         confirmation_height: nodes[1].best_block_info().1 + 4,
1314                 }, Balance::ClaimableAwaitingConfirmations {
1315                         amount_satoshis: 4_000 - chan_feerate * INBOUND_HTLC_CLAIM_EXP_WEIGHT as u64 / 1000,
1316                         confirmation_height: nodes[1].best_block_info().1 + 5,
1317                 }, Balance::ClaimableAwaitingConfirmations {
1318                         amount_satoshis: 5_000 - chan_feerate * INBOUND_HTLC_CLAIM_EXP_WEIGHT as u64 / 1000,
1319                         confirmation_height: largest_htlc_claimed_avail_height,
1320                 }]),
1321                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1322
1323         connect_blocks(&nodes[1], 1);
1324         test_spendable_output(&nodes[1], &as_revoked_txn[0], false);
1325
1326         let mut payment_failed_events = nodes[1].node.get_and_clear_pending_events();
1327         expect_payment_failed_conditions_event(payment_failed_events[..2].to_vec(),
1328                 missing_htlc_payment_hash, false, PaymentFailedConditions::new());
1329         expect_payment_failed_conditions_event(payment_failed_events[2..].to_vec(),
1330                 dust_payment_hash, false, PaymentFailedConditions::new());
1331
1332         connect_blocks(&nodes[1], 1);
1333         test_spendable_output(&nodes[1], &claim_txn[if confirm_htlc_spend_first { 2 } else { 3 }], false);
1334         connect_blocks(&nodes[1], 1);
1335         test_spendable_output(&nodes[1], &claim_txn[if confirm_htlc_spend_first { 3 } else { 2 }], false);
1336         expect_payment_failed!(nodes[1], live_payment_hash, false);
1337         connect_blocks(&nodes[1], 1);
1338         test_spendable_output(&nodes[1], &claim_txn[0], false);
1339         connect_blocks(&nodes[1], 1);
1340         test_spendable_output(&nodes[1], &claim_txn[1], false);
1341         expect_payment_failed!(nodes[1], timeout_payment_hash, false);
1342         assert_eq!(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances(), Vec::new());
1343
1344         // Ensure that even if we connect more blocks, potentially replaying the entire chain if we're
1345         // using `ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks`, we don't get new
1346         // monitor events or claimable balances.
1347         connect_blocks(&nodes[1], 6);
1348         connect_blocks(&nodes[1], 6);
1349         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
1350         assert!(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances().is_empty());
1351 }
1352
1353 #[test]
1354 fn test_revoked_counterparty_commitment_balances() {
1355         do_test_revoked_counterparty_commitment_balances(true);
1356         do_test_revoked_counterparty_commitment_balances(false);
1357 }
1358
1359 #[test]
1360 fn test_revoked_counterparty_htlc_tx_balances() {
1361         // Tests `get_claimable_balances` for revocation spends of HTLC transactions.
1362         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1363         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
1364         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1365         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1366         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1367
1368         // Create some initial channels
1369         let (_, _, chan_id, funding_tx) =
1370                 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 11_000_000);
1371         let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
1372         assert_eq!(funding_outpoint.to_channel_id(), chan_id);
1373
1374         let payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 3_000_000).0;
1375         let failed_payment_hash = route_payment(&nodes[1], &[&nodes[0]], 1_000_000).1;
1376         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_id);
1377         assert_eq!(revoked_local_txn[0].input.len(), 1);
1378         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, funding_tx.txid());
1379
1380         // The to-be-revoked commitment tx should have two HTLCs and an output for both sides
1381         assert_eq!(revoked_local_txn[0].output.len(), 4);
1382
1383         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
1384
1385         let chan_feerate = get_feerate!(nodes[0], nodes[1], chan_id) as u64;
1386         let channel_type_features = get_channel_type_features!(nodes[0], nodes[1], chan_id);
1387
1388         // B will generate an HTLC-Success from its revoked commitment tx
1389         mine_transaction(&nodes[1], &revoked_local_txn[0]);
1390         check_closed_broadcast!(nodes[1], true);
1391         check_added_monitors!(nodes[1], 1);
1392         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 1000000);
1393         let revoked_htlc_success = {
1394                 let mut txn = nodes[1].tx_broadcaster.txn_broadcast();
1395                 assert_eq!(txn.len(), 1);
1396                 assert_eq!(txn[0].input.len(), 1);
1397                 assert_eq!(txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
1398                 check_spends!(txn[0], revoked_local_txn[0]);
1399                 txn.pop().unwrap()
1400         };
1401
1402         connect_blocks(&nodes[1], TEST_FINAL_CLTV);
1403         let revoked_htlc_timeout = {
1404                 let mut txn = nodes[1].tx_broadcaster.unique_txn_broadcast();
1405                 assert_eq!(txn.len(), 2);
1406                 if txn[0].input[0].previous_output == revoked_htlc_success.input[0].previous_output {
1407                         txn.remove(1)
1408                 } else {
1409                         txn.remove(0)
1410                 }
1411         };
1412         check_spends!(revoked_htlc_timeout, revoked_local_txn[0]);
1413         assert_ne!(revoked_htlc_success.input[0].previous_output, revoked_htlc_timeout.input[0].previous_output);
1414         assert_eq!(revoked_htlc_success.lock_time.0, 0);
1415         assert_ne!(revoked_htlc_timeout.lock_time.0, 0);
1416
1417         // A will generate justice tx from B's revoked commitment/HTLC tx
1418         mine_transaction(&nodes[0], &revoked_local_txn[0]);
1419         check_closed_broadcast!(nodes[0], true);
1420         check_added_monitors!(nodes[0], 1);
1421         check_closed_event!(nodes[0], 1, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id()], 1000000);
1422         let to_remote_conf_height = nodes[0].best_block_info().1 + ANTI_REORG_DELAY - 1;
1423
1424         let as_commitment_claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
1425         assert_eq!(as_commitment_claim_txn.len(), 1);
1426         check_spends!(as_commitment_claim_txn[0], revoked_local_txn[0]);
1427
1428         // The next two checks have the same balance set for A - even though we confirm a revoked HTLC
1429         // transaction our balance tracking doesn't use the on-chain value so the
1430         // `CounterpartyRevokedOutputClaimable` entry doesn't change.
1431         let as_balances = sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
1432                         // to_remote output in B's revoked commitment
1433                         amount_satoshis: 1_000_000 - 11_000 - 3_000 - chan_feerate *
1434                                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000,
1435                         confirmation_height: to_remote_conf_height,
1436                 }, Balance::CounterpartyRevokedOutputClaimable {
1437                         // to_self output in B's revoked commitment
1438                         amount_satoshis: 10_000,
1439                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 1
1440                         amount_satoshis: 3_000,
1441                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 2
1442                         amount_satoshis: 1_000,
1443                 }]);
1444         assert_eq!(as_balances,
1445                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1446
1447         mine_transaction(&nodes[0], &revoked_htlc_success);
1448         let as_htlc_claim_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
1449         assert_eq!(as_htlc_claim_tx.len(), 2);
1450         check_spends!(as_htlc_claim_tx[0], revoked_htlc_success);
1451         check_spends!(as_htlc_claim_tx[1], revoked_local_txn[0]); // A has to generate a new claim for the remaining revoked
1452                                                                   // outputs (which no longer includes the spent HTLC output)
1453
1454         assert_eq!(as_balances,
1455                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1456
1457         assert_eq!(as_htlc_claim_tx[0].output.len(), 1);
1458         fuzzy_assert_eq(as_htlc_claim_tx[0].output[0].value,
1459                 3_000 - chan_feerate * (revoked_htlc_success.weight() + as_htlc_claim_tx[0].weight()) as u64 / 1000);
1460
1461         mine_transaction(&nodes[0], &as_htlc_claim_tx[0]);
1462         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
1463                         // to_remote output in B's revoked commitment
1464                         amount_satoshis: 1_000_000 - 11_000 - 3_000 - chan_feerate *
1465                                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000,
1466                         confirmation_height: to_remote_conf_height,
1467                 }, Balance::CounterpartyRevokedOutputClaimable {
1468                         // to_self output in B's revoked commitment
1469                         amount_satoshis: 10_000,
1470                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 2
1471                         amount_satoshis: 1_000,
1472                 }, Balance::ClaimableAwaitingConfirmations {
1473                         amount_satoshis: as_htlc_claim_tx[0].output[0].value,
1474                         confirmation_height: nodes[0].best_block_info().1 + ANTI_REORG_DELAY - 1,
1475                 }]),
1476                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1477
1478         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 3);
1479         test_spendable_output(&nodes[0], &revoked_local_txn[0], false);
1480         assert_eq!(sorted_vec(vec![Balance::CounterpartyRevokedOutputClaimable {
1481                         // to_self output to B
1482                         amount_satoshis: 10_000,
1483                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 2
1484                         amount_satoshis: 1_000,
1485                 }, Balance::ClaimableAwaitingConfirmations {
1486                         amount_satoshis: as_htlc_claim_tx[0].output[0].value,
1487                         confirmation_height: nodes[0].best_block_info().1 + 2,
1488                 }]),
1489                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1490
1491         connect_blocks(&nodes[0], 2);
1492         test_spendable_output(&nodes[0], &as_htlc_claim_tx[0], false);
1493         assert_eq!(sorted_vec(vec![Balance::CounterpartyRevokedOutputClaimable {
1494                         // to_self output in B's revoked commitment
1495                         amount_satoshis: 10_000,
1496                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 2
1497                         amount_satoshis: 1_000,
1498                 }]),
1499                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1500
1501         connect_blocks(&nodes[0], revoked_htlc_timeout.lock_time.0 - nodes[0].best_block_info().1);
1502         expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!(&nodes[0],
1503                 [HTLCDestination::FailedPayment { payment_hash: failed_payment_hash }]);
1504         // As time goes on A may split its revocation claim transaction into multiple.
1505         let as_fewer_input_rbf = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
1506         for tx in as_fewer_input_rbf.iter() {
1507                 check_spends!(tx, revoked_local_txn[0]);
1508         }
1509
1510         // Connect a number of additional blocks to ensure we don't forget the HTLC output needs
1511         // claiming.
1512         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
1513         let as_fewer_input_rbf = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
1514         for tx in as_fewer_input_rbf.iter() {
1515                 check_spends!(tx, revoked_local_txn[0]);
1516         }
1517
1518         mine_transaction(&nodes[0], &revoked_htlc_timeout);
1519         let as_second_htlc_claim_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
1520         assert_eq!(as_second_htlc_claim_tx.len(), 2);
1521
1522         check_spends!(as_second_htlc_claim_tx[0], revoked_htlc_timeout);
1523         check_spends!(as_second_htlc_claim_tx[1], revoked_local_txn[0]);
1524
1525         // Connect blocks to finalize the HTLC resolution with the HTLC-Timeout transaction. In a
1526         // previous iteration of the revoked balance handling this would result in us "forgetting" that
1527         // the revoked HTLC output still needed to be claimed.
1528         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
1529         assert_eq!(sorted_vec(vec![Balance::CounterpartyRevokedOutputClaimable {
1530                         // to_self output in B's revoked commitment
1531                         amount_satoshis: 10_000,
1532                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 2
1533                         amount_satoshis: 1_000,
1534                 }]),
1535                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1536
1537         mine_transaction(&nodes[0], &as_second_htlc_claim_tx[0]);
1538         assert_eq!(sorted_vec(vec![Balance::CounterpartyRevokedOutputClaimable {
1539                         // to_self output in B's revoked commitment
1540                         amount_satoshis: 10_000,
1541                 }, Balance::ClaimableAwaitingConfirmations {
1542                         amount_satoshis: as_second_htlc_claim_tx[0].output[0].value,
1543                         confirmation_height: nodes[0].best_block_info().1 + ANTI_REORG_DELAY - 1,
1544                 }]),
1545                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1546
1547         mine_transaction(&nodes[0], &as_second_htlc_claim_tx[1]);
1548         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
1549                         // to_self output in B's revoked commitment
1550                         amount_satoshis: as_second_htlc_claim_tx[1].output[0].value,
1551                         confirmation_height: nodes[0].best_block_info().1 + ANTI_REORG_DELAY - 1,
1552                 }, Balance::ClaimableAwaitingConfirmations {
1553                         amount_satoshis: as_second_htlc_claim_tx[0].output[0].value,
1554                         confirmation_height: nodes[0].best_block_info().1 + ANTI_REORG_DELAY - 2,
1555                 }]),
1556                 sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1557
1558         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 2);
1559         test_spendable_output(&nodes[0], &as_second_htlc_claim_tx[0], false);
1560         connect_blocks(&nodes[0], 1);
1561         test_spendable_output(&nodes[0], &as_second_htlc_claim_tx[1], false);
1562
1563         assert_eq!(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances(), Vec::new());
1564
1565         // Ensure that even if we connect more blocks, potentially replaying the entire chain if we're
1566         // using `ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks`, we don't get new
1567         // monitor events or claimable balances.
1568         connect_blocks(&nodes[0], 6);
1569         connect_blocks(&nodes[0], 6);
1570         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
1571         assert!(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances().is_empty());
1572 }
1573
1574 #[test]
1575 fn test_revoked_counterparty_aggregated_claims() {
1576         // Tests `get_claimable_balances` for revoked counterparty commitment transactions when
1577         // claiming with an aggregated claim transaction.
1578         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1579         // We broadcast a second-to-latest commitment transaction, without providing the revocation
1580         // secret to the counterparty. However, because we always immediately take the revocation
1581         // secret from the keys_manager, we would panic at broadcast as we're trying to sign a
1582         // transaction which, from the point of view of our keys_manager, is revoked.
1583         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
1584         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1585         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1586         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1587
1588         let (_, _, chan_id, funding_tx) =
1589                 create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 100_000_000);
1590         let funding_outpoint = OutPoint { txid: funding_tx.txid(), index: 0 };
1591         assert_eq!(funding_outpoint.to_channel_id(), chan_id);
1592
1593         // We create two HTLCs, one which we will give A the preimage to to generate an HTLC-Success
1594         // transaction, and one which we will not, allowing B to claim the HTLC output in an aggregated
1595         // revocation-claim transaction.
1596
1597         let (claimed_payment_preimage, claimed_payment_hash, ..) = route_payment(&nodes[1], &[&nodes[0]], 3_000_000);
1598         let revoked_payment_hash = route_payment(&nodes[1], &[&nodes[0]], 4_000_000).1;
1599
1600         let htlc_cltv_timeout = nodes[1].best_block_info().1 + TEST_FINAL_CLTV + 1; // Note ChannelManager adds one to CLTV timeouts for safety
1601
1602         // Cheat by giving A's ChannelMonitor the preimage to the to-be-claimed HTLC so that we have an
1603         // HTLC-claim transaction on the to-be-revoked state.
1604         get_monitor!(nodes[0], chan_id).provide_payment_preimage(&claimed_payment_hash, &claimed_payment_preimage,
1605                 &node_cfgs[0].tx_broadcaster, &LowerBoundedFeeEstimator::new(node_cfgs[0].fee_estimator), &nodes[0].logger);
1606
1607         // Now get the latest commitment transaction from A and then update the fee to revoke it
1608         let as_revoked_txn = get_local_commitment_txn!(nodes[0], chan_id);
1609
1610         assert_eq!(as_revoked_txn.len(), 2);
1611         check_spends!(as_revoked_txn[0], funding_tx);
1612         check_spends!(as_revoked_txn[1], as_revoked_txn[0]); // The HTLC-Claim transaction
1613
1614         let channel_type_features = get_channel_type_features!(nodes[0], nodes[1], chan_id);
1615         let chan_feerate = get_feerate!(nodes[0], nodes[1], chan_id) as u64;
1616
1617         {
1618                 let mut feerate = chanmon_cfgs[0].fee_estimator.sat_per_kw.lock().unwrap();
1619                 *feerate += 1;
1620         }
1621         nodes[0].node.timer_tick_occurred();
1622         check_added_monitors!(nodes[0], 1);
1623
1624         let fee_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1625         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &fee_update.update_fee.unwrap());
1626         commitment_signed_dance!(nodes[1], nodes[0], fee_update.commitment_signed, false);
1627
1628         nodes[0].node.claim_funds(claimed_payment_preimage);
1629         expect_payment_claimed!(nodes[0], claimed_payment_hash, 3_000_000);
1630         check_added_monitors!(nodes[0], 1);
1631         let _a_htlc_msgs = get_htlc_update_msgs!(&nodes[0], nodes[1].node.get_our_node_id());
1632
1633         assert_eq!(sorted_vec(vec![Balance::ClaimableOnChannelClose {
1634                         amount_satoshis: 100_000 - 4_000 - 3_000,
1635                 }, Balance::MaybeTimeoutClaimableHTLC {
1636                         amount_satoshis: 4_000,
1637                         claimable_height: htlc_cltv_timeout,
1638                         payment_hash: revoked_payment_hash,
1639                 }, Balance::MaybeTimeoutClaimableHTLC {
1640                         amount_satoshis: 3_000,
1641                         claimable_height: htlc_cltv_timeout,
1642                         payment_hash: claimed_payment_hash,
1643                 }]),
1644                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1645
1646         mine_transaction(&nodes[1], &as_revoked_txn[0]);
1647         check_closed_broadcast!(nodes[1], true);
1648         check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 1000000);
1649         check_added_monitors!(nodes[1], 1);
1650
1651         let mut claim_txn: Vec<_> = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().drain(..).filter(|tx| tx.input.iter().any(|inp| inp.previous_output.txid == as_revoked_txn[0].txid())).collect();
1652         // Currently the revoked commitment outputs are all claimed in one aggregated transaction
1653         assert_eq!(claim_txn.len(), 1);
1654         assert_eq!(claim_txn[0].input.len(), 3);
1655         check_spends!(claim_txn[0], as_revoked_txn[0]);
1656
1657         let to_remote_maturity = nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1;
1658
1659         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
1660                         // to_remote output in A's revoked commitment
1661                         amount_satoshis: 100_000 - 4_000 - 3_000,
1662                         confirmation_height: to_remote_maturity,
1663                 }, Balance::CounterpartyRevokedOutputClaimable {
1664                         // to_self output in A's revoked commitment
1665                         amount_satoshis: 1_000_000 - 100_000 - chan_feerate *
1666                                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000,
1667                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 1
1668                         amount_satoshis: 4_000,
1669                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 2
1670                         amount_satoshis: 3_000,
1671                 }]),
1672                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1673
1674         // Confirm A's HTLC-Success tranasction which presumably raced B's claim, causing B to create a
1675         // new claim.
1676         mine_transaction(&nodes[1], &as_revoked_txn[1]);
1677         expect_payment_sent(&nodes[1], claimed_payment_preimage, None, true, false);
1678         let mut claim_txn_2: Vec<_> = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1679         claim_txn_2.sort_unstable_by_key(|tx| if tx.input.iter().any(|inp| inp.previous_output.txid == as_revoked_txn[0].txid()) { 0 } else { 1 });
1680         // Once B sees the HTLC-Success transaction it splits its claim transaction into two, though in
1681         // theory it could re-aggregate the claims as well.
1682         assert_eq!(claim_txn_2.len(), 2);
1683         assert_eq!(claim_txn_2[0].input.len(), 2);
1684         check_spends!(claim_txn_2[0], as_revoked_txn[0]);
1685         assert_eq!(claim_txn_2[1].input.len(), 1);
1686         check_spends!(claim_txn_2[1], as_revoked_txn[1]);
1687
1688         assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
1689                         // to_remote output in A's revoked commitment
1690                         amount_satoshis: 100_000 - 4_000 - 3_000,
1691                         confirmation_height: to_remote_maturity,
1692                 }, Balance::CounterpartyRevokedOutputClaimable {
1693                         // to_self output in A's revoked commitment
1694                         amount_satoshis: 1_000_000 - 100_000 - chan_feerate *
1695                                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000,
1696                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 1
1697                         amount_satoshis: 4_000,
1698                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 2
1699                         // The amount here is a bit of a misnomer, really its been reduced by the HTLC
1700                         // transaction fee, but the claimable amount is always a bit of an overshoot for HTLCs
1701                         // anyway, so its not a big change.
1702                         amount_satoshis: 3_000,
1703                 }]),
1704                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1705
1706         connect_blocks(&nodes[1], 5);
1707         test_spendable_output(&nodes[1], &as_revoked_txn[0], false);
1708
1709         assert_eq!(sorted_vec(vec![Balance::CounterpartyRevokedOutputClaimable {
1710                         // to_self output in A's revoked commitment
1711                         amount_satoshis: 1_000_000 - 100_000 - chan_feerate *
1712                                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000,
1713                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 1
1714                         amount_satoshis: 4_000,
1715                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 2
1716                         // The amount here is a bit of a misnomer, really its been reduced by the HTLC
1717                         // transaction fee, but the claimable amount is always a bit of an overshoot for HTLCs
1718                         // anyway, so its not a big change.
1719                         amount_satoshis: 3_000,
1720                 }]),
1721                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1722
1723         mine_transaction(&nodes[1], &claim_txn_2[1]);
1724         let htlc_2_claim_maturity = nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1;
1725
1726         assert_eq!(sorted_vec(vec![Balance::CounterpartyRevokedOutputClaimable {
1727                         // to_self output in A's revoked commitment
1728                         amount_satoshis: 1_000_000 - 100_000 - chan_feerate *
1729                                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000,
1730                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 1
1731                         amount_satoshis: 4_000,
1732                 }, Balance::ClaimableAwaitingConfirmations { // HTLC 2
1733                         amount_satoshis: claim_txn_2[1].output[0].value,
1734                         confirmation_height: htlc_2_claim_maturity,
1735                 }]),
1736                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1737
1738         connect_blocks(&nodes[1], 5);
1739         test_spendable_output(&nodes[1], &claim_txn_2[1], false);
1740
1741         assert_eq!(sorted_vec(vec![Balance::CounterpartyRevokedOutputClaimable {
1742                         // to_self output in A's revoked commitment
1743                         amount_satoshis: 1_000_000 - 100_000 - chan_feerate *
1744                                 (channel::commitment_tx_base_weight(&channel_type_features) + 2 * channel::COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000,
1745                 }, Balance::CounterpartyRevokedOutputClaimable { // HTLC 1
1746                         amount_satoshis: 4_000,
1747                 }]),
1748                 sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
1749
1750         mine_transaction(&nodes[1], &claim_txn_2[0]);
1751         let rest_claim_maturity = nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1;
1752
1753         assert_eq!(vec![Balance::ClaimableAwaitingConfirmations {
1754                         amount_satoshis: claim_txn_2[0].output[0].value,
1755                         confirmation_height: rest_claim_maturity,
1756                 }],
1757                 nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
1758
1759         assert!(nodes[1].node.get_and_clear_pending_events().is_empty()); // We shouldn't fail the payment until we spend the output
1760
1761         connect_blocks(&nodes[1], 5);
1762         expect_payment_failed!(nodes[1], revoked_payment_hash, false);
1763         test_spendable_output(&nodes[1], &claim_txn_2[0], false);
1764         assert!(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances().is_empty());
1765
1766         // Ensure that even if we connect more blocks, potentially replaying the entire chain if we're
1767         // using `ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks`, we don't get new
1768         // monitor events or claimable balances.
1769         connect_blocks(&nodes[1], 6);
1770         connect_blocks(&nodes[1], 6);
1771         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
1772         assert!(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances().is_empty());
1773 }
1774
1775 fn do_test_restored_packages_retry(check_old_monitor_retries_after_upgrade: bool) {
1776         // Tests that we'll retry packages that were previously timelocked after we've restored them.
1777         let chanmon_cfgs = create_chanmon_cfgs(2);
1778         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1779         let persister;
1780         let new_chain_monitor;
1781
1782         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1783         let node_deserialized;
1784
1785         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1786
1787         // Open a channel, lock in an HTLC, and immediately broadcast the commitment transaction. This
1788         // ensures that the HTLC timeout package is held until we reach its expiration height.
1789         let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 50_000_000);
1790         route_payment(&nodes[0], &[&nodes[1]], 10_000_000);
1791
1792         nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
1793         check_added_monitors(&nodes[0], 1);
1794         check_closed_broadcast(&nodes[0], 1, true);
1795         check_closed_event!(&nodes[0], 1, ClosureReason::HolderForceClosed, false,
1796                  [nodes[1].node.get_our_node_id()], 100000);
1797
1798         let commitment_tx = {
1799                 let mut txn = nodes[0].tx_broadcaster.txn_broadcast();
1800                 assert_eq!(txn.len(), 1);
1801                 assert_eq!(txn[0].output.len(), 3);
1802                 check_spends!(txn[0], funding_tx);
1803                 txn.pop().unwrap()
1804         };
1805
1806         mine_transaction(&nodes[0], &commitment_tx);
1807
1808         // Connect blocks until the HTLC's expiration is met, expecting a transaction broadcast.
1809         connect_blocks(&nodes[0], TEST_FINAL_CLTV);
1810         let htlc_timeout_tx = {
1811                 let mut txn = nodes[0].tx_broadcaster.txn_broadcast();
1812                 assert_eq!(txn.len(), 1);
1813                 check_spends!(txn[0], commitment_tx);
1814                 txn.pop().unwrap()
1815         };
1816
1817         // Check that we can still rebroadcast these packages/transactions if we're upgrading from an
1818         // old `ChannelMonitor` that did not exercise said rebroadcasting logic.
1819         if check_old_monitor_retries_after_upgrade {
1820                 let serialized_monitor = hex::decode(
1821                         "0101fffffffffffffffff9550f22c95100160014d5a9aa98b89acc215fc3d23d6fec0ad59ca3665f00002200204c5f18e5e95b184f34d02ba6de8a2a4e36ae3d4ec87299ad81f3284dc7195c6302d7dde8e10a5a22c9bd0d7ef5494d85683ac050253b917615d4f97af633f0a8e2035f5e9d58b4328566223c107d86cf853e6b9fae1d26ff6d969be0178d1423c4ea0016001467822698d782e8421ebdf96d010de99382b7ec2300160014caf6d80fe2bab80473b021f57588a9c384bf23170000000000000000000000004d49e5da0000000000000000000000000000002a0270b20ad0f2c2bb30a55590fc77778495bc1b38c96476901145dda57491237f0f74c52ab4f11296d62b66a6dba9513b04a3e7fb5a09a30cee22fce7294ab55b7e00000022002034c0cc0ad0dd5fe61dcf7ef58f995e3d34f8dbd24aa2a6fae68fefe102bf025c21391732ce658e1fe167300bb689a81e7db5399b9ee4095e217b0e997e8dd3d17a0000000000000000004a002103adde8029d3ee281a32e9db929b39f503ff9d7e93cd308eb157955344dc6def84022103205087e2dc1f6b9937e887dfa712c5bdfa950b01dbda3ebac4c85efdde48ee6a04020090004752210307a78def56cba9fc4db22a25928181de538ee59ba1a475ae113af7790acd0db32103c21e841cbc0b48197d060c71e116c185fa0ac281b7d0aa5924f535154437ca3b52ae00000000000186a0ffffffffffff0291e7c0a3232fb8650a6b4089568a81062b48a768780e5a74bb4a4a74e33aec2c029d5760248ec86c4a76d9df8308555785a06a65472fb995f5b392d520bbd000650090c1c94b11625690c9d84c5daa67b6ad19fcc7f9f23e194384140b08fcab9e8e810000ffffffffffff000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000002167c86cc0e598a6b541f7c9bf9ef17222e4a76f636e2d22185aeadd2b02d029c0000000000000000391732ce658e1fe167300bb689a81e7db5399b9ee4095e217b0e997e8dd3d17a00000000000000010000000000009896800000005166687aadf862bd776c8fc18b8e9f8e20089714856ee233b3902a591d0d5f29250500000000a0009d00202d704fbfe342a9ff6eaca14d80a24aaed0e680bbbdd36157b6f2798c61d906910120f9fe5e552aa0fc45020f0505efde432a4e373e5d393863973a6899f8c26d33d102080000000000989680044d4c00210355f8d2238a322d16b602bd0ceaad5b01019fb055971eaadcc9b29226a4da6c2302090007000000000241000408000001000000000006020000080800000000009896800a04000000460000000000000000000000000000000166687aadf862bd776c8fc18b8e9f8e20089714856ee233b3902a591d0d5f2925fffffffffffe01e3002004f8eda5676356f539169a8e9a1e86c7f125283328d6f4bded1b939b52a6a7e30108000000000000c299022103a1f98e85886df54add6908b4fc1ff515e44aedefe9eb9c02879c89994298fa79042103a650bf03971df0176c7b412247390ef717853e8bd487b204dccc2fe2078bb75206210390bbbcebe9f70ba5dfd98866a79f72f75e0a6ea550ef73b202dd87cd6477350a08210284152d57908488e666e872716a286eb670b3d06cbeebf3f2e4ad350e01ec5e5b0a2102295e2de39eb3dcc2882f8cc266df7882a8b6d2c32aa08799f49b693aad3be28e0c04000000fd0e00fd0202002045cfd42d0989e55b953f516ac7fd152bd90ec4438a2fc636f97ddd32a0c8fe0d01080000000000009b5e0221035f5e9d58b4328566223c107d86cf853e6b9fae1d26ff6d969be0178d1423c4ea04210230fde9c031f487db95ff55b7c0acbe0c7c26a8d82615e9184416bd350101616706210225afb4e88eac8b47b67adeaf085f5eb5d37d936f56138f0848de3d104edf113208210208e4687a95c172b86b920c3bc5dbd5f023094ec2cb0abdb74f9b624f45740df90a2102d7dde8e10a5a22c9bd0d7ef5494d85683ac050253b917615d4f97af633f0a8e20c04000000fd0efd011d3b00010102080000000000989680040400000051062066687aadf862bd776c8fc18b8e9f8e20089714856ee233b3902a591d0d5f2925080400000000417e2650c201383711eed2a7cb8652c3e77ee6a395e81849c5c222217ed68b333c0ca9f1e900662ae68a7359efa7ef9d90613f2a62f7c3ff90f8c25e2cc974c9d3a0009d00202d704fbfe342a9ff6eaca14d80a24aaed0e680bbbdd36157b6f2798c61d906910120f9fe5e552aa0fc45020f0505efde432a4e373e5d393863973a6899f8c26d33d102080000000000989680044d4c00210355f8d2238a322d16b602bd0ceaad5b01019fb055971eaadcc9b29226a4da6c2302090007000000000241000408000001000000000006020000080800000000009896800a0400000046fffffffffffefffffffffffe000000000000000000000000000000000000000000000000f1600ef6ea657b8d411d553516ae35cedfe86b0cd48d1f91b32772facbae757d0000000b0000000000000002fd01da002045cfd42d0989e55b953f516ac7fd152bd90ec4438a2fc636f97ddd32a0c8fe0d01fd01840200000000010174c52ab4f11296d62b66a6dba9513b04a3e7fb5a09a30cee22fce7294ab55b7e00000000000f55f9800310270000000000002200208309b406e3b96e76cde414fbb8f5159f5b25b24075656c6382cec797854d53495e9b0000000000002200204c5f18e5e95b184f34d02ba6de8a2a4e36ae3d4ec87299ad81f3284dc7195c6350c300000000000016001425df8ec4a074f80579fed67d4707d5ec8ed7e8d304004730440220671c9badf26bd3a1ebd2d17020c6be20587d7822530daacc52c28839875eaec602204b575a21729ed27311f6d79fdf6fe8702b0a798f7d842e39ede1b56f249a613401473044022016a0da36f70cbf5d889586af88f238982889dc161462c56557125c7acfcb69e9022036ae10c6cc8cbc3b27d9e9ef6babb556086585bc819f252208bd175286699fdd014752210307a78def56cba9fc4db22a25928181de538ee59ba1a475ae113af7790acd0db32103c21e841cbc0b48197d060c71e116c185fa0ac281b7d0aa5924f535154437ca3b52ae50c9222002040000000b0320f1600ef6ea657b8d411d553516ae35cedfe86b0cd48d1f91b32772facbae757d0406030400020090fd02a1002045cfd42d0989e55b953f516ac7fd152bd90ec4438a2fc636f97ddd32a0c8fe0d01fd01840200000000010174c52ab4f11296d62b66a6dba9513b04a3e7fb5a09a30cee22fce7294ab55b7e00000000000f55f9800310270000000000002200208309b406e3b96e76cde414fbb8f5159f5b25b24075656c6382cec797854d53495e9b0000000000002200204c5f18e5e95b184f34d02ba6de8a2a4e36ae3d4ec87299ad81f3284dc7195c6350c300000000000016001425df8ec4a074f80579fed67d4707d5ec8ed7e8d304004730440220671c9badf26bd3a1ebd2d17020c6be20587d7822530daacc52c28839875eaec602204b575a21729ed27311f6d79fdf6fe8702b0a798f7d842e39ede1b56f249a613401473044022016a0da36f70cbf5d889586af88f238982889dc161462c56557125c7acfcb69e9022036ae10c6cc8cbc3b27d9e9ef6babb556086585bc819f252208bd175286699fdd014752210307a78def56cba9fc4db22a25928181de538ee59ba1a475ae113af7790acd0db32103c21e841cbc0b48197d060c71e116c185fa0ac281b7d0aa5924f535154437ca3b52ae50c9222002040000000b0320f1600ef6ea657b8d411d553516ae35cedfe86b0cd48d1f91b32772facbae757d04cd01cb00c901c7002245cfd42d0989e55b953f516ac7fd152bd90ec4438a2fc636f97ddd32a0c8fe0d0001022102d7dde8e10a5a22c9bd0d7ef5494d85683ac050253b917615d4f97af633f0a8e204020090062b5e9b0000000000002200204c5f18e5e95b184f34d02ba6de8a2a4e36ae3d4ec87299ad81f3284dc7195c630821035f5e9d58b4328566223c107d86cf853e6b9fae1d26ff6d969be0178d1423c4ea0a200000000000000000000000004d49e5da0000000000000000000000000000002a0c0800000000000186a0000000000000000274c52ab4f11296d62b66a6dba9513b04a3e7fb5a09a30cee22fce7294ab55b7e0000000000000001000000000022002034c0cc0ad0dd5fe61dcf7ef58f995e3d34f8dbd24aa2a6fae68fefe102bf025c45cfd42d0989e55b953f516ac7fd152bd90ec4438a2fc636f97ddd32a0c8fe0d000000000000000100000000002200208309b406e3b96e76cde414fbb8f5159f5b25b24075656c6382cec797854d5349010100160014d5a9aa98b89acc215fc3d23d6fec0ad59ca3665ffd027100fd01e6fd01e300080000fffffffffffe02080000000000009b5e0408000000000000c3500604000000fd08b0af002102d7dde8e10a5a22c9bd0d7ef5494d85683ac050253b917615d4f97af633f0a8e20221035f5e9d58b4328566223c107d86cf853e6b9fae1d26ff6d969be0178d1423c4ea04210230fde9c031f487db95ff55b7c0acbe0c7c26a8d82615e9184416bd350101616706210225afb4e88eac8b47b67adeaf085f5eb5d37d936f56138f0848de3d104edf113208210208e4687a95c172b86b920c3bc5dbd5f023094ec2cb0abdb74f9b624f45740df90acdcc00a8020000000174c52ab4f11296d62b66a6dba9513b04a3e7fb5a09a30cee22fce7294ab55b7e00000000000f55f9800310270000000000002200208309b406e3b96e76cde414fbb8f5159f5b25b24075656c6382cec797854d53495e9b0000000000002200204c5f18e5e95b184f34d02ba6de8a2a4e36ae3d4ec87299ad81f3284dc7195c6350c300000000000016001425df8ec4a074f80579fed67d4707d5ec8ed7e8d350c92220022045cfd42d0989e55b953f516ac7fd152bd90ec4438a2fc636f97ddd32a0c8fe0d0c3c3b00010102080000000000989680040400000051062066687aadf862bd776c8fc18b8e9f8e20089714856ee233b3902a591d0d5f29250804000000000240671c9badf26bd3a1ebd2d17020c6be20587d7822530daacc52c28839875eaec64b575a21729ed27311f6d79fdf6fe8702b0a798f7d842e39ede1b56f249a613404010006407e2650c201383711eed2a7cb8652c3e77ee6a395e81849c5c222217ed68b333c0ca9f1e900662ae68a7359efa7ef9d90613f2a62f7c3ff90f8c25e2cc974c9d3010000000000000001010000000000000000090b2a953d93a124c600ecb1a0ccfed420169cdd37f538ad94a3e4e6318c93c14adf59cdfbb40bdd40950c9f8dd547d29d75a173e1376a7850743394c46dea2dfd01cefd01ca00fd017ffd017c00080000ffffffffffff0208000000000000c2990408000000000000c3500604000000fd08b0af002102295e2de39eb3dcc2882f8cc266df7882a8b6d2c32aa08799f49b693aad3be28e022103a1f98e85886df54add6908b4fc1ff515e44aedefe9eb9c02879c89994298fa79042103a650bf03971df0176c7b412247390ef717853e8bd487b204dccc2fe2078bb75206210390bbbcebe9f70ba5dfd98866a79f72f75e0a6ea550ef73b202dd87cd6477350a08210284152d57908488e666e872716a286eb670b3d06cbeebf3f2e4ad350e01ec5e5b0aa2a1007d020000000174c52ab4f11296d62b66a6dba9513b04a3e7fb5a09a30cee22fce7294ab55b7e00000000000f55f9800299c2000000000000220020740e108cfbc93967b6ab242a351ebee7de51814cf78d366adefd78b10281f17e50c300000000000016001425df8ec4a074f80579fed67d4707d5ec8ed7e8d351c92220022004f8eda5676356f539169a8e9a1e86c7f125283328d6f4bded1b939b52a6a7e30c00024045cb2485594bb1ec08e7bb6af4f89c912bd53f006d7876ea956773e04a4aad4a40e2b8d4fc612102f0b54061b3c1239fb78783053e8e6f9d92b1b99f81ae9ec2040100060000fd019600b0af002103c21e841cbc0b48197d060c71e116c185fa0ac281b7d0aa5924f535154437ca3b02210270b20ad0f2c2bb30a55590fc77778495bc1b38c96476901145dda57491237f0f042103b4e59df102747edc3a3e2283b42b88a8c8218ffd0dcfb52f2524b371d64cadaa062103d902b7b8b3434076d2b210e912c76645048b71e28995aad227a465a65ccd817608210301e9a52f923c157941de4a7692e601f758660969dcf5abdb67817efe84cce2ef0202009004010106b7b600b0af00210307a78def56cba9fc4db22a25928181de538ee59ba1a475ae113af7790acd0db30221034d0f817cb19b4a3bd144b615459bd06cbab3b4bdc96d73e18549a992cee80e8104210380542b59a9679890cba529fe155a9508ef57dac7416d035b23666e3fb98c3814062103adde8029d3ee281a32e9db929b39f503ff9d7e93cd308eb157955344dc6def84082103205087e2dc1f6b9937e887dfa712c5bdfa950b01dbda3ebac4c85efdde48ee6a02020090082274c52ab4f11296d62b66a6dba9513b04a3e7fb5a09a30cee22fce7294ab55b7e000000000287010108d30df34e3a1e00ecdd03a2c843db062479a81752c4dfd0cc4baef0f81e7bc7ef8820990daf8d8e8d30a3b4b08af12c9f5cd71e45c7238103e0c80ca13850862e4fd2c56b69b7195312518de1bfe9aed63c80bb7760d70b2a870d542d815895fd12423d11e2adb0cdf55d776dac8f487c9b3b7ea12f1b150eb15889cf41333ade465692bf1cdc360b9c2a19bf8c1ca4fed7639d8bc953d36c10d8c6c9a8c0a57608788979bcf145e61b308006896e21d03e92084f93bd78740c20639134a7a8fd019afd019600b0af002103c21e841cbc0b48197d060c71e116c185fa0ac281b7d0aa5924f535154437ca3b02210270b20ad0f2c2bb30a55590fc77778495bc1b38c96476901145dda57491237f0f042103b4e59df102747edc3a3e2283b42b88a8c8218ffd0dcfb52f2524b371d64cadaa062103d902b7b8b3434076d2b210e912c76645048b71e28995aad227a465a65ccd817608210301e9a52f923c157941de4a7692e601f758660969dcf5abdb67817efe84cce2ef0202009004010106b7b600b0af00210307a78def56cba9fc4db22a25928181de538ee59ba1a475ae113af7790acd0db30221034d0f817cb19b4a3bd144b615459bd06cbab3b4bdc96d73e18549a992cee80e8104210380542b59a9679890cba529fe155a9508ef57dac7416d035b23666e3fb98c3814062103adde8029d3ee281a32e9db929b39f503ff9d7e93cd308eb157955344dc6def84082103205087e2dc1f6b9937e887dfa712c5bdfa950b01dbda3ebac4c85efdde48ee6a02020090082274c52ab4f11296d62b66a6dba9513b04a3e7fb5a09a30cee22fce7294ab55b7e000000000000000186a00000000000000000000000004d49e5da0000000000000000000000000000002a00000000000000000000000000000000000000000000000001000000510000000000000001000000000000000145cfd42d0989e55b953f516ac7fd152bd90ec4438a2fc636f97ddd32a0c8fe0d00000000041000080000000000989680020400000051160004000000510208000000000000000004040000000b0000000000000000000101300300050007010109210355f8d2238a322d16b602bd0ceaad5b01019fb055971eaadcc9b29226a4da6c230d000f020000",
1822                 ).unwrap();
1823                 reload_node!(nodes[0], &nodes[0].node.encode(), &[&serialized_monitor], persister, new_chain_monitor, node_deserialized);
1824         }
1825
1826         // Connecting more blocks should result in the HTLC transactions being rebroadcast.
1827         connect_blocks(&nodes[0], 6);
1828         if check_old_monitor_retries_after_upgrade {
1829                 check_added_monitors(&nodes[0], 1);
1830         }
1831         {
1832                 let txn = nodes[0].tx_broadcaster.txn_broadcast();
1833                 if !nodes[0].connect_style.borrow().skips_blocks() {
1834                         assert_eq!(txn.len(), 6);
1835                 } else {
1836                         assert!(txn.len() < 6);
1837                 }
1838                 for tx in txn {
1839                         assert_eq!(tx.input.len(), htlc_timeout_tx.input.len());
1840                         assert_eq!(tx.output.len(), htlc_timeout_tx.output.len());
1841                         assert_eq!(tx.input[0].previous_output, htlc_timeout_tx.input[0].previous_output);
1842                         assert_eq!(tx.output[0], htlc_timeout_tx.output[0]);
1843                 }
1844         }
1845 }
1846
1847 #[test]
1848 fn test_restored_packages_retry() {
1849         do_test_restored_packages_retry(false);
1850         do_test_restored_packages_retry(true);
1851 }
1852
1853 fn do_test_monitor_rebroadcast_pending_claims(anchors: bool) {
1854         // Test that we will retry broadcasting pending claims for a force-closed channel on every
1855         // `ChainMonitor::rebroadcast_pending_claims` call.
1856         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1857         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1858         let mut config = test_default_channel_config();
1859         if anchors {
1860                 config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
1861                 config.manually_accept_inbound_channels = true;
1862         }
1863         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(config), Some(config)]);
1864         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1865
1866         let (_, _, _, chan_id, funding_tx) = create_chan_between_nodes_with_value(
1867                 &nodes[0], &nodes[1], 1_000_000, 500_000_000
1868         );
1869         const HTLC_AMT_MSAT: u64 = 1_000_000;
1870         const HTLC_AMT_SAT: u64 = HTLC_AMT_MSAT / 1000;
1871         route_payment(&nodes[0], &[&nodes[1]], HTLC_AMT_MSAT);
1872
1873         let htlc_expiry = nodes[0].best_block_info().1 + TEST_FINAL_CLTV + 1;
1874
1875         let commitment_txn = get_local_commitment_txn!(&nodes[0], &chan_id);
1876         assert_eq!(commitment_txn.len(), if anchors { 1 /* commitment tx only */} else { 2 /* commitment and htlc timeout tx */ });
1877         check_spends!(&commitment_txn[0], &funding_tx);
1878         mine_transaction(&nodes[0], &commitment_txn[0]);
1879         check_closed_broadcast!(&nodes[0], true);
1880         check_closed_event!(&nodes[0], 1, ClosureReason::CommitmentTxConfirmed,
1881                  false, [nodes[1].node.get_our_node_id()], 1000000);
1882         check_added_monitors(&nodes[0], 1);
1883
1884         let coinbase_tx = Transaction {
1885                 version: 2,
1886                 lock_time: PackedLockTime::ZERO,
1887                 input: vec![TxIn { ..Default::default() }],
1888                 output: vec![TxOut { // UTXO to attach fees to `htlc_tx` on anchors
1889                         value: Amount::ONE_BTC.to_sat(),
1890                         script_pubkey: nodes[0].wallet_source.get_change_script().unwrap(),
1891                 }],
1892         };
1893         nodes[0].wallet_source.add_utxo(bitcoin::OutPoint { txid: coinbase_tx.txid(), vout: 0 }, coinbase_tx.output[0].value);
1894
1895         // Set up a helper closure we'll use throughout our test. We should only expect retries without
1896         // bumps if fees have not increased after a block has been connected (assuming the height timer
1897         // re-evaluates at every block) or after `ChainMonitor::rebroadcast_pending_claims` is called.
1898         let mut prev_htlc_tx_feerate = None;
1899         let mut check_htlc_retry = |should_retry: bool, should_bump: bool| -> Option<Transaction> {
1900                 let (htlc_tx, htlc_tx_feerate) = if anchors {
1901                         assert!(nodes[0].tx_broadcaster.txn_broadcast().is_empty());
1902                         let events = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
1903                         assert_eq!(events.len(), if should_retry { 1 } else { 0 });
1904                         if !should_retry {
1905                                 return None;
1906                         }
1907                         match &events[0] {
1908                                 Event::BumpTransaction(event) => {
1909                                         nodes[0].bump_tx_handler.handle_event(&event);
1910                                         let mut txn = nodes[0].tx_broadcaster.unique_txn_broadcast();
1911                                         assert_eq!(txn.len(), 1);
1912                                         let htlc_tx = txn.pop().unwrap();
1913                                         check_spends!(&htlc_tx, &commitment_txn[0], &coinbase_tx);
1914                                         let htlc_tx_fee = HTLC_AMT_SAT + coinbase_tx.output[0].value -
1915                                                 htlc_tx.output.iter().map(|output| output.value).sum::<u64>();
1916                                         let htlc_tx_weight = htlc_tx.weight() as u64;
1917                                         (htlc_tx, compute_feerate_sat_per_1000_weight(htlc_tx_fee, htlc_tx_weight))
1918                                 }
1919                                 _ => panic!("Unexpected event"),
1920                         }
1921                 } else {
1922                         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
1923                         let mut txn = nodes[0].tx_broadcaster.txn_broadcast();
1924                         assert_eq!(txn.len(), if should_retry { 1 } else { 0 });
1925                         if !should_retry {
1926                                 return None;
1927                         }
1928                         let htlc_tx = txn.pop().unwrap();
1929                         check_spends!(htlc_tx, commitment_txn[0]);
1930                         let htlc_tx_fee = HTLC_AMT_SAT - htlc_tx.output[0].value;
1931                         let htlc_tx_weight = htlc_tx.weight() as u64;
1932                         (htlc_tx, compute_feerate_sat_per_1000_weight(htlc_tx_fee, htlc_tx_weight))
1933                 };
1934                 if should_bump {
1935                         assert!(htlc_tx_feerate > prev_htlc_tx_feerate.take().unwrap());
1936                 } else if let Some(prev_feerate) = prev_htlc_tx_feerate.take() {
1937                         assert_eq!(htlc_tx_feerate, prev_feerate);
1938                 }
1939                 prev_htlc_tx_feerate = Some(htlc_tx_feerate);
1940                 Some(htlc_tx)
1941         };
1942
1943         // Connect blocks up to one before the HTLC expires. This should not result in a claim/retry.
1944         connect_blocks(&nodes[0], htlc_expiry - nodes[0].best_block_info().1 - 1);
1945         check_htlc_retry(false, false);
1946
1947         // Connect one more block, producing our first claim.
1948         connect_blocks(&nodes[0], 1);
1949         check_htlc_retry(true, false);
1950
1951         // Connect one more block, expecting a retry with a fee bump. Unfortunately, we cannot bump HTLC
1952         // transactions pre-anchors.
1953         connect_blocks(&nodes[0], 1);
1954         check_htlc_retry(true, anchors);
1955
1956         // Trigger a call and we should have another retry, but without a bump.
1957         nodes[0].chain_monitor.chain_monitor.rebroadcast_pending_claims();
1958         check_htlc_retry(true, false);
1959
1960         // Double the feerate and trigger a call, expecting a fee-bumped retry.
1961         *nodes[0].fee_estimator.sat_per_kw.lock().unwrap() *= 2;
1962         nodes[0].chain_monitor.chain_monitor.rebroadcast_pending_claims();
1963         check_htlc_retry(true, anchors);
1964
1965         // Connect one more block, expecting a retry with a fee bump. Unfortunately, we cannot bump HTLC
1966         // transactions pre-anchors.
1967         connect_blocks(&nodes[0], 1);
1968         let htlc_tx = check_htlc_retry(true, anchors).unwrap();
1969
1970         // Mine the HTLC transaction to ensure we don't retry claims while they're confirmed.
1971         mine_transaction(&nodes[0], &htlc_tx);
1972         // If we have a `ConnectStyle` that advertises the new block first without the transactions,
1973         // we'll receive an extra bumped claim.
1974         if nodes[0].connect_style.borrow().updates_best_block_first() {
1975                 nodes[0].wallet_source.add_utxo(bitcoin::OutPoint { txid: coinbase_tx.txid(), vout: 0 }, coinbase_tx.output[0].value);
1976                 nodes[0].wallet_source.remove_utxo(bitcoin::OutPoint { txid: htlc_tx.txid(), vout: 1 });
1977                 check_htlc_retry(true, anchors);
1978         }
1979         nodes[0].chain_monitor.chain_monitor.rebroadcast_pending_claims();
1980         check_htlc_retry(false, false);
1981 }
1982
1983 #[test]
1984 fn test_monitor_timer_based_claim() {
1985         do_test_monitor_rebroadcast_pending_claims(false);
1986         do_test_monitor_rebroadcast_pending_claims(true);
1987 }
1988
1989 #[test]
1990 fn test_yield_anchors_events() {
1991         // Tests that two parties supporting anchor outputs can open a channel, route payments over
1992         // it, and finalize its resolution uncooperatively. Once the HTLCs are locked in, one side will
1993         // force close once the HTLCs expire. The force close should stem from an event emitted by LDK,
1994         // allowing the consumer to provide additional fees to the commitment transaction to be
1995         // broadcast. Once the commitment transaction confirms, events for the HTLC resolution should be
1996         // emitted by LDK, such that the consumer can attach fees to the zero fee HTLC transactions.
1997         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1998         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1999         let mut anchors_config = UserConfig::default();
2000         anchors_config.channel_handshake_config.announced_channel = true;
2001         anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
2002         anchors_config.manually_accept_inbound_channels = true;
2003         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config), Some(anchors_config)]);
2004         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2005
2006         let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes_with_value(
2007                 &nodes, 0, 1, 1_000_000, 500_000_000
2008         );
2009         let (payment_preimage_1, payment_hash_1, ..) = route_payment(&nodes[0], &[&nodes[1]], 1_000_000);
2010         let (payment_preimage_2, payment_hash_2, ..) = route_payment(&nodes[1], &[&nodes[0]], 2_000_000);
2011
2012         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2013         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2014
2015         *nodes[0].fee_estimator.sat_per_kw.lock().unwrap() *= 2;
2016
2017         connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2018         assert!(nodes[0].tx_broadcaster.txn_broadcast().is_empty());
2019
2020         connect_blocks(&nodes[1], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
2021         {
2022                 let txn = nodes[1].tx_broadcaster.txn_broadcast();
2023                 assert_eq!(txn.len(), 1);
2024                 check_spends!(txn[0], funding_tx);
2025         }
2026
2027         get_monitor!(nodes[0], chan_id).provide_payment_preimage(
2028                 &payment_hash_2, &payment_preimage_2, &node_cfgs[0].tx_broadcaster,
2029                 &LowerBoundedFeeEstimator::new(node_cfgs[0].fee_estimator), &nodes[0].logger
2030         );
2031         get_monitor!(nodes[1], chan_id).provide_payment_preimage(
2032                 &payment_hash_1, &payment_preimage_1, &node_cfgs[0].tx_broadcaster,
2033                 &LowerBoundedFeeEstimator::new(node_cfgs[1].fee_estimator), &nodes[1].logger
2034         );
2035
2036         let mut holder_events = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
2037         assert_eq!(holder_events.len(), 1);
2038         let (commitment_tx, anchor_tx) = match holder_events.pop().unwrap() {
2039                 Event::BumpTransaction(event) => {
2040                         let coinbase_tx = Transaction {
2041                                 version: 2,
2042                                 lock_time: PackedLockTime::ZERO,
2043                                 input: vec![TxIn { ..Default::default() }],
2044                                 output: vec![TxOut { // UTXO to attach fees to `anchor_tx`
2045                                         value: Amount::ONE_BTC.to_sat(),
2046                                         script_pubkey: nodes[0].wallet_source.get_change_script().unwrap(),
2047                                 }],
2048                         };
2049                         nodes[0].wallet_source.add_utxo(bitcoin::OutPoint { txid: coinbase_tx.txid(), vout: 0 }, coinbase_tx.output[0].value);
2050                         nodes[0].bump_tx_handler.handle_event(&event);
2051                         let mut txn = nodes[0].tx_broadcaster.unique_txn_broadcast();
2052                         assert_eq!(txn.len(), 2);
2053                         let anchor_tx = txn.pop().unwrap();
2054                         let commitment_tx = txn.pop().unwrap();
2055                         check_spends!(commitment_tx, funding_tx);
2056                         check_spends!(anchor_tx, coinbase_tx, commitment_tx);
2057                         (commitment_tx, anchor_tx)
2058                 },
2059                 _ => panic!("Unexpected event"),
2060         };
2061
2062         assert_eq!(commitment_tx.output[2].value, 1_000); // HTLC A -> B
2063         assert_eq!(commitment_tx.output[3].value, 2_000); // HTLC B -> A
2064
2065         mine_transactions(&nodes[0], &[&commitment_tx, &anchor_tx]);
2066         check_added_monitors!(nodes[0], 1);
2067         mine_transactions(&nodes[1], &[&commitment_tx, &anchor_tx]);
2068         check_added_monitors!(nodes[1], 1);
2069
2070         {
2071                 let mut txn = nodes[1].tx_broadcaster.unique_txn_broadcast();
2072                 assert_eq!(txn.len(), if nodes[1].connect_style.borrow().updates_best_block_first() { 3 } else { 2 });
2073
2074                 let htlc_preimage_tx = txn.pop().unwrap();
2075                 assert_eq!(htlc_preimage_tx.input.len(), 1);
2076                 assert_eq!(htlc_preimage_tx.input[0].previous_output.vout, 3);
2077                 check_spends!(htlc_preimage_tx, commitment_tx);
2078
2079                 let htlc_timeout_tx = txn.pop().unwrap();
2080                 assert_eq!(htlc_timeout_tx.input.len(), 1);
2081                 assert_eq!(htlc_timeout_tx.input[0].previous_output.vout, 2);
2082                 check_spends!(htlc_timeout_tx, commitment_tx);
2083
2084                 if let Some(commitment_tx) = txn.pop() {
2085                         check_spends!(commitment_tx, funding_tx);
2086                 }
2087         }
2088
2089         let mut holder_events = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
2090         // Certain block `ConnectStyle`s cause an extra `ChannelClose` event to be emitted since the
2091         // best block is updated before the confirmed transactions are notified.
2092         if nodes[0].connect_style.borrow().updates_best_block_first() {
2093                 assert_eq!(holder_events.len(), 3);
2094                 if let Event::BumpTransaction(BumpTransactionEvent::ChannelClose { .. }) = holder_events.remove(0) {}
2095                 else { panic!("unexpected event"); }
2096         } else {
2097                 assert_eq!(holder_events.len(), 2);
2098         }
2099         let mut htlc_txs = Vec::with_capacity(2);
2100         for event in holder_events {
2101                 match event {
2102                         Event::BumpTransaction(event) => {
2103                                 nodes[0].bump_tx_handler.handle_event(&event);
2104                                 let mut txn = nodes[0].tx_broadcaster.unique_txn_broadcast();
2105                                 assert_eq!(txn.len(), 1);
2106                                 let htlc_tx = txn.pop().unwrap();
2107                                 check_spends!(htlc_tx, commitment_tx, anchor_tx);
2108                                 htlc_txs.push(htlc_tx);
2109                         },
2110                         _ => panic!("Unexpected event"),
2111                 }
2112         }
2113
2114         mine_transactions(&nodes[0], &[&htlc_txs[0], &htlc_txs[1]]);
2115         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
2116
2117         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
2118
2119         connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32);
2120
2121         let holder_events = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
2122         assert_eq!(holder_events.len(), 3);
2123         for event in holder_events {
2124                 match event {
2125                         Event::SpendableOutputs { .. } => {},
2126                         _ => panic!("Unexpected event"),
2127                 }
2128         }
2129
2130         // Clear the remaining events as they're not relevant to what we're testing.
2131         nodes[0].node.get_and_clear_pending_events();
2132         nodes[1].node.get_and_clear_pending_events();
2133         nodes[0].node.get_and_clear_pending_msg_events();
2134         nodes[1].node.get_and_clear_pending_msg_events();
2135 }
2136
2137 #[test]
2138 fn test_anchors_aggregated_revoked_htlc_tx() {
2139         // Test that `ChannelMonitor`s can properly detect and claim funds from a counterparty claiming
2140         // multiple HTLCs from multiple channels in a single transaction via the success path from a
2141         // revoked commitment.
2142         let secp = Secp256k1::new();
2143         let mut chanmon_cfgs = create_chanmon_cfgs(2);
2144         // Required to sign a revoked commitment transaction
2145         chanmon_cfgs[1].keys_manager.disable_revocation_policy_check = true;
2146         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2147         let bob_persister;
2148         let bob_chain_monitor;
2149
2150         let mut anchors_config = UserConfig::default();
2151         anchors_config.channel_handshake_config.announced_channel = true;
2152         anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
2153         anchors_config.manually_accept_inbound_channels = true;
2154         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config), Some(anchors_config)]);
2155         let bob_deserialized;
2156
2157         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2158
2159         let chan_a = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 20_000_000);
2160         let chan_b = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 20_000_000);
2161
2162         // Serialize Bob with the initial state of both channels, which we'll use later.
2163         let bob_serialized = nodes[1].node.encode();
2164
2165         // Route two payments for each channel from Alice to Bob to lock in the HTLCs.
2166         let payment_a = route_payment(&nodes[0], &[&nodes[1]], 50_000_000);
2167         let payment_b = route_payment(&nodes[0], &[&nodes[1]], 50_000_000);
2168         let payment_c = route_payment(&nodes[0], &[&nodes[1]], 50_000_000);
2169         let payment_d = route_payment(&nodes[0], &[&nodes[1]], 50_000_000);
2170
2171         // Serialize Bob's monitors with the HTLCs locked in. We'll restart Bob later on with the state
2172         // at this point such that he broadcasts a revoked commitment transaction with the HTLCs
2173         // present.
2174         let bob_serialized_monitor_a = get_monitor!(nodes[1], chan_a.2).encode();
2175         let bob_serialized_monitor_b = get_monitor!(nodes[1], chan_b.2).encode();
2176
2177         // Bob claims all the HTLCs...
2178         claim_payment(&nodes[0], &[&nodes[1]], payment_a.0);
2179         claim_payment(&nodes[0], &[&nodes[1]], payment_b.0);
2180         claim_payment(&nodes[0], &[&nodes[1]], payment_c.0);
2181         claim_payment(&nodes[0], &[&nodes[1]], payment_d.0);
2182
2183         // ...and sends one back through each channel such that he has a motive to broadcast his
2184         // revoked state.
2185         send_payment(&nodes[1], &[&nodes[0]], 30_000_000);
2186         send_payment(&nodes[1], &[&nodes[0]], 30_000_000);
2187
2188         // Restart Bob with the revoked state and provide the HTLC preimages he claimed.
2189         reload_node!(
2190                 nodes[1], anchors_config, bob_serialized, &[&bob_serialized_monitor_a, &bob_serialized_monitor_b],
2191                 bob_persister, bob_chain_monitor, bob_deserialized
2192         );
2193         for chan_id in [chan_a.2, chan_b.2].iter() {
2194                 let monitor = get_monitor!(nodes[1], chan_id);
2195                 for payment in [payment_a, payment_b, payment_c, payment_d].iter() {
2196                         monitor.provide_payment_preimage(
2197                                 &payment.1, &payment.0, &node_cfgs[1].tx_broadcaster,
2198                                 &LowerBoundedFeeEstimator::new(node_cfgs[1].fee_estimator), &nodes[1].logger
2199                         );
2200                 }
2201         }
2202
2203         // Bob force closes by restarting with the outdated state, prompting the ChannelMonitors to
2204         // broadcast the latest commitment transaction known to them, which in our case is the one with
2205         // the HTLCs still pending.
2206         *nodes[1].fee_estimator.sat_per_kw.lock().unwrap() *= 2;
2207         nodes[1].node.timer_tick_occurred();
2208         check_added_monitors(&nodes[1], 2);
2209         check_closed_event!(&nodes[1], 2, ClosureReason::OutdatedChannelManager, [nodes[0].node.get_our_node_id(); 2], 1000000);
2210         let (revoked_commitment_a, revoked_commitment_b) = {
2211                 let txn = nodes[1].tx_broadcaster.unique_txn_broadcast();
2212                 assert_eq!(txn.len(), 2);
2213                 assert_eq!(txn[0].output.len(), 6); // 2 HTLC outputs + 1 to_self output + 1 to_remote output + 2 anchor outputs
2214                 assert_eq!(txn[1].output.len(), 6); // 2 HTLC outputs + 1 to_self output + 1 to_remote output + 2 anchor outputs
2215                 if txn[0].input[0].previous_output.txid == chan_a.3.txid() {
2216                         check_spends!(&txn[0], &chan_a.3);
2217                         check_spends!(&txn[1], &chan_b.3);
2218                         (txn[0].clone(), txn[1].clone())
2219                 } else {
2220                         check_spends!(&txn[1], &chan_a.3);
2221                         check_spends!(&txn[0], &chan_b.3);
2222                         (txn[1].clone(), txn[0].clone())
2223                 }
2224         };
2225
2226         // Bob should now receive two events to bump his revoked commitment transaction fees.
2227         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
2228         let events = nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events();
2229         assert_eq!(events.len(), 2);
2230         let mut anchor_txs = Vec::with_capacity(events.len());
2231         for (idx, event) in events.into_iter().enumerate() {
2232                 let utxo_value = Amount::ONE_BTC.to_sat() * (idx + 1) as u64;
2233                 let coinbase_tx = Transaction {
2234                         version: 2,
2235                         lock_time: PackedLockTime::ZERO,
2236                         input: vec![TxIn { ..Default::default() }],
2237                         output: vec![TxOut { // UTXO to attach fees to `anchor_tx`
2238                                 value: utxo_value,
2239                                 script_pubkey: nodes[1].wallet_source.get_change_script().unwrap(),
2240                         }],
2241                 };
2242                 nodes[1].wallet_source.add_utxo(bitcoin::OutPoint { txid: coinbase_tx.txid(), vout: 0 }, utxo_value);
2243                 match event {
2244                         Event::BumpTransaction(event) => nodes[1].bump_tx_handler.handle_event(&event),
2245                         _ => panic!("Unexpected event"),
2246                 };
2247                 let txn = nodes[1].tx_broadcaster.txn_broadcast();
2248                 assert_eq!(txn.len(), 2);
2249                 let (commitment_tx, anchor_tx) = (&txn[0], &txn[1]);
2250                 check_spends!(anchor_tx, coinbase_tx, commitment_tx);
2251                 anchor_txs.push(anchor_tx.clone());
2252         };
2253
2254         for node in &nodes {
2255                 mine_transactions(node, &[&revoked_commitment_a, &anchor_txs[0], &revoked_commitment_b, &anchor_txs[1]]);
2256         }
2257         check_added_monitors!(&nodes[0], 2);
2258         check_closed_broadcast(&nodes[0], 2, true);
2259         check_closed_event!(&nodes[0], 2, ClosureReason::CommitmentTxConfirmed, [nodes[1].node.get_our_node_id(); 2], 1000000);
2260
2261         // Alice should detect the confirmed revoked commitments, and attempt to claim all of the
2262         // revoked outputs.
2263         {
2264                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2265                 assert_eq!(txn.len(), 4);
2266
2267                 let (revoked_htlc_claim_a, revoked_htlc_claim_b) = if txn[0].input[0].previous_output.txid == revoked_commitment_a.txid() {
2268                         (if txn[0].input.len() == 2 { &txn[0] } else { &txn[1] }, if txn[2].input.len() == 2 { &txn[2] } else { &txn[3] })
2269                 } else {
2270                         (if txn[2].input.len() == 2 { &txn[2] } else { &txn[3] }, if txn[0].input.len() == 2 { &txn[0] } else { &txn[1] })
2271                 };
2272
2273                 assert_eq!(revoked_htlc_claim_a.input.len(), 2); // Spends both HTLC outputs
2274                 assert_eq!(revoked_htlc_claim_a.output.len(), 1);
2275                 check_spends!(revoked_htlc_claim_a, revoked_commitment_a);
2276                 assert_eq!(revoked_htlc_claim_b.input.len(), 2); // Spends both HTLC outputs
2277                 assert_eq!(revoked_htlc_claim_b.output.len(), 1);
2278                 check_spends!(revoked_htlc_claim_b, revoked_commitment_b);
2279         }
2280
2281         // Since Bob was able to confirm his revoked commitment, he'll now try to claim the HTLCs
2282         // through the success path.
2283         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
2284         let mut events = nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events();
2285         // Certain block `ConnectStyle`s cause an extra `ChannelClose` event to be emitted since the
2286         // best block is updated before the confirmed transactions are notified.
2287         match *nodes[1].connect_style.borrow() {
2288                 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::BestBlockFirstSkippingBlocks => {
2289                         assert_eq!(events.len(), 4);
2290                         if let Event::BumpTransaction(BumpTransactionEvent::ChannelClose { .. }) = events.remove(0) {}
2291                         else { panic!("unexpected event"); }
2292                         if let Event::BumpTransaction(BumpTransactionEvent::ChannelClose { .. }) = events.remove(1) {}
2293                         else { panic!("unexpected event"); }
2294
2295                 },
2296                 _ => assert_eq!(events.len(), 2),
2297         };
2298         let htlc_tx = {
2299                 let secret_key = SecretKey::from_slice(&[1; 32]).unwrap();
2300                 let public_key = PublicKey::new(secret_key.public_key(&secp));
2301                 let fee_utxo_script = Script::new_v0_p2wpkh(&public_key.wpubkey_hash().unwrap());
2302                 let coinbase_tx = Transaction {
2303                         version: 2,
2304                         lock_time: PackedLockTime::ZERO,
2305                         input: vec![TxIn { ..Default::default() }],
2306                         output: vec![TxOut { // UTXO to attach fees to `htlc_tx`
2307                                 value: Amount::ONE_BTC.to_sat(),
2308                                 script_pubkey: fee_utxo_script.clone(),
2309                         }],
2310                 };
2311                 let mut htlc_tx = Transaction {
2312                         version: 2,
2313                         lock_time: PackedLockTime::ZERO,
2314                         input: vec![TxIn { // Fee input
2315                                 previous_output: bitcoin::OutPoint { txid: coinbase_tx.txid(), vout: 0 },
2316                                 ..Default::default()
2317                         }],
2318                         output: vec![TxOut { // Fee input change
2319                                 value: coinbase_tx.output[0].value / 2 ,
2320                                 script_pubkey: Script::new_op_return(&[]),
2321                         }],
2322                 };
2323                 let mut descriptors = Vec::with_capacity(4);
2324                 for event in events {
2325                         // We don't use the `BumpTransactionEventHandler` here because it does not support
2326                         // creating one transaction from multiple `HTLCResolution` events.
2327                         if let Event::BumpTransaction(BumpTransactionEvent::HTLCResolution { mut htlc_descriptors, tx_lock_time, .. }) = event {
2328                                 assert_eq!(htlc_descriptors.len(), 2);
2329                                 for htlc_descriptor in &htlc_descriptors {
2330                                         assert!(!htlc_descriptor.htlc.offered);
2331                                         htlc_tx.input.push(htlc_descriptor.unsigned_tx_input());
2332                                         htlc_tx.output.push(htlc_descriptor.tx_output(&secp));
2333                                 }
2334                                 descriptors.append(&mut htlc_descriptors);
2335                                 htlc_tx.lock_time = tx_lock_time;
2336                         } else {
2337                                 panic!("Unexpected event");
2338                         }
2339                 }
2340                 for (idx, htlc_descriptor) in descriptors.into_iter().enumerate() {
2341                         let htlc_input_idx = idx + 1;
2342                         let signer = htlc_descriptor.derive_channel_signer(&nodes[1].keys_manager);
2343                         let our_sig = signer.sign_holder_htlc_transaction(&htlc_tx, htlc_input_idx, &htlc_descriptor, &secp).unwrap();
2344                         let witness_script = htlc_descriptor.witness_script(&secp);
2345                         htlc_tx.input[htlc_input_idx].witness = htlc_descriptor.tx_input_witness(&our_sig, &witness_script);
2346                 }
2347                 let fee_utxo_sig = {
2348                         let witness_script = Script::new_p2pkh(&public_key.pubkey_hash());
2349                         let sighash = hash_to_message!(&SighashCache::new(&htlc_tx).segwit_signature_hash(
2350                                 0, &witness_script, coinbase_tx.output[0].value, EcdsaSighashType::All
2351                         ).unwrap()[..]);
2352                         let sig = sign(&secp, &sighash, &secret_key);
2353                         let mut sig = sig.serialize_der().to_vec();
2354                         sig.push(EcdsaSighashType::All as u8);
2355                         sig
2356                 };
2357                 htlc_tx.input[0].witness = Witness::from_vec(vec![fee_utxo_sig, public_key.to_bytes()]);
2358                 check_spends!(htlc_tx, coinbase_tx, revoked_commitment_a, revoked_commitment_b);
2359                 htlc_tx
2360         };
2361
2362         for node in &nodes {
2363                 mine_transaction(node, &htlc_tx);
2364         }
2365
2366         // Alice should see that Bob is trying to claim to HTLCs, so she should now try to claim them at
2367         // the second level instead.
2368         let revoked_claim_transactions = {
2369                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
2370                 assert_eq!(txn.len(), 2);
2371
2372                 let revoked_htlc_claims = txn.iter().filter(|tx|
2373                         tx.input.len() == 2 &&
2374                         tx.output.len() == 1 &&
2375                         tx.input[0].previous_output.txid == htlc_tx.txid()
2376                 ).collect::<Vec<_>>();
2377                 assert_eq!(revoked_htlc_claims.len(), 2);
2378                 for revoked_htlc_claim in revoked_htlc_claims {
2379                         check_spends!(revoked_htlc_claim, htlc_tx);
2380                 }
2381
2382                 let mut revoked_claim_transaction_map = HashMap::new();
2383                 for current_tx in txn.into_iter() {
2384                         revoked_claim_transaction_map.insert(current_tx.txid(), current_tx);
2385                 }
2386                 revoked_claim_transaction_map
2387         };
2388         for node in &nodes {
2389                 mine_transactions(node, &revoked_claim_transactions.values().collect::<Vec<_>>());
2390         }
2391
2392
2393         // Connect one block to make sure the HTLC events are not yielded while ANTI_REORG_DELAY has not
2394         // been reached.
2395         connect_blocks(&nodes[0], 1);
2396         connect_blocks(&nodes[1], 1);
2397
2398         assert!(nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
2399         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
2400
2401         // Connect the remaining blocks to reach ANTI_REORG_DELAY.
2402         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 2);
2403         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 2);
2404
2405         assert!(nodes[1].chain_monitor.chain_monitor.get_and_clear_pending_events().is_empty());
2406         let spendable_output_events = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
2407         assert_eq!(spendable_output_events.len(), 4);
2408         for event in spendable_output_events {
2409                 if let Event::SpendableOutputs { outputs, channel_id } = event {
2410                         assert_eq!(outputs.len(), 1);
2411                         assert!(vec![chan_b.2, chan_a.2].contains(&channel_id.unwrap()));
2412                         let spend_tx = nodes[0].keys_manager.backing.spend_spendable_outputs(
2413                                 &[&outputs[0]], Vec::new(), Script::new_op_return(&[]), 253, None, &Secp256k1::new(),
2414                         ).unwrap();
2415
2416                         if let SpendableOutputDescriptor::StaticPaymentOutput(_) = &outputs[0] {
2417                                 check_spends!(spend_tx, &revoked_commitment_a, &revoked_commitment_b);
2418                         } else {
2419                                 check_spends!(spend_tx, revoked_claim_transactions.get(&spend_tx.input[0].previous_output.txid).unwrap());
2420                         }
2421                 } else {
2422                         panic!("unexpected event");
2423                 }
2424         }
2425
2426         assert!(nodes[0].node.list_channels().is_empty());
2427         assert!(nodes[1].node.list_channels().is_empty());
2428         // On the Alice side, the individual to_self_claim are still pending confirmation.
2429         assert_eq!(nodes[0].chain_monitor.chain_monitor.get_claimable_balances(&[]).len(), 2);
2430         // TODO: From Bob's PoV, he still thinks he can claim the outputs from his revoked commitment.
2431         // This needs to be fixed before we enable pruning `ChannelMonitor`s once they don't have any
2432         // balances to claim.
2433         //
2434         // The 6 claimable balances correspond to his `to_self` outputs and the 2 HTLC outputs in each
2435         // revoked commitment which Bob has the preimage for.
2436         assert_eq!(nodes[1].chain_monitor.chain_monitor.get_claimable_balances(&[]).len(), 6);
2437 }
2438
2439 fn do_test_anchors_monitor_fixes_counterparty_payment_script_on_reload(confirm_commitment_before_reload: bool) {
2440         // Tests that we'll fix a ChannelMonitor's `counterparty_payment_script` for an anchor outputs
2441         // channel upon deserialization.
2442         let chanmon_cfgs = create_chanmon_cfgs(2);
2443         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2444         let persister;
2445         let chain_monitor;
2446         let mut user_config = test_default_channel_config();
2447         user_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
2448         user_config.manually_accept_inbound_channels = true;
2449         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(user_config), Some(user_config)]);
2450         let node_deserialized;
2451         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2452
2453         let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100_000, 50_000_000);
2454
2455         // Set the monitor's `counterparty_payment_script` to a dummy P2WPKH script.
2456         let secp = Secp256k1::new();
2457         let privkey = bitcoin::PrivateKey::from_slice(&[1; 32], bitcoin::Network::Testnet).unwrap();
2458         let pubkey = bitcoin::PublicKey::from_private_key(&secp, &privkey);
2459         let p2wpkh_script = Script::new_v0_p2wpkh(&pubkey.wpubkey_hash().unwrap());
2460         get_monitor!(nodes[1], chan_id).set_counterparty_payment_script(p2wpkh_script.clone());
2461         assert_eq!(get_monitor!(nodes[1], chan_id).get_counterparty_payment_script(), p2wpkh_script);
2462
2463         // Confirm the counterparty's commitment and reload the monitor (either before or after) such
2464         // that we arrive at the correct `counterparty_payment_script` after the reload.
2465         nodes[0].node.force_close_broadcasting_latest_txn(&chan_id, &nodes[1].node.get_our_node_id()).unwrap();
2466         check_added_monitors(&nodes[0], 1);
2467         check_closed_broadcast(&nodes[0], 1, true);
2468         check_closed_event!(&nodes[0], 1, ClosureReason::HolderForceClosed, false,
2469                  [nodes[1].node.get_our_node_id()], 100000);
2470
2471         let commitment_tx = {
2472                 let mut txn = nodes[0].tx_broadcaster.unique_txn_broadcast();
2473                 assert_eq!(txn.len(), 1);
2474                 assert_eq!(txn[0].output.len(), 4);
2475                 check_spends!(txn[0], funding_tx);
2476                 txn.pop().unwrap()
2477         };
2478
2479         mine_transaction(&nodes[0], &commitment_tx);
2480         let commitment_tx_conf_height = if confirm_commitment_before_reload {
2481                 // We should expect our round trip serialization check to fail as we're writing the monitor
2482                 // with the incorrect P2WPKH script but reading it with the correct P2WSH script.
2483                 *nodes[1].chain_monitor.expect_monitor_round_trip_fail.lock().unwrap() = Some(chan_id);
2484                 let commitment_tx_conf_height = block_from_scid(&mine_transaction(&nodes[1], &commitment_tx));
2485                 let serialized_monitor = get_monitor!(nodes[1], chan_id).encode();
2486                 reload_node!(nodes[1], user_config, &nodes[1].node.encode(), &[&serialized_monitor], persister, chain_monitor, node_deserialized);
2487                 commitment_tx_conf_height
2488         } else {
2489                 let serialized_monitor = get_monitor!(nodes[1], chan_id).encode();
2490                 reload_node!(nodes[1], user_config, &nodes[1].node.encode(), &[&serialized_monitor], persister, chain_monitor, node_deserialized);
2491                 let commitment_tx_conf_height = block_from_scid(&mine_transaction(&nodes[1], &commitment_tx));
2492                 check_added_monitors(&nodes[1], 1);
2493                 check_closed_broadcast(&nodes[1], 1, true);
2494                 commitment_tx_conf_height
2495         };
2496         check_closed_event!(&nodes[1], 1, ClosureReason::CommitmentTxConfirmed, false,
2497                  [nodes[0].node.get_our_node_id()], 100000);
2498         assert!(get_monitor!(nodes[1], chan_id).get_counterparty_payment_script().is_v0_p2wsh());
2499
2500         connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
2501         connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
2502
2503         if confirm_commitment_before_reload {
2504                 // If we saw the commitment before our `counterparty_payment_script` was fixed, we'll never
2505                 // get the spendable output event for the `to_remote` output, so we'll need to get it
2506                 // manually via `get_spendable_outputs`.
2507                 check_added_monitors(&nodes[1], 1);
2508                 let outputs = get_monitor!(nodes[1], chan_id).get_spendable_outputs(&commitment_tx, commitment_tx_conf_height);
2509                 assert_eq!(outputs.len(), 1);
2510                 let spend_tx = nodes[1].keys_manager.backing.spend_spendable_outputs(
2511                         &[&outputs[0]], Vec::new(), Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
2512                         253, None, &secp
2513                 ).unwrap();
2514                 check_spends!(spend_tx, &commitment_tx);
2515         } else {
2516                 test_spendable_output(&nodes[1], &commitment_tx, false);
2517         }
2518 }
2519
2520 #[test]
2521 fn test_anchors_monitor_fixes_counterparty_payment_script_on_reload() {
2522         do_test_anchors_monitor_fixes_counterparty_payment_script_on_reload(false);
2523         do_test_anchors_monitor_fixes_counterparty_payment_script_on_reload(true);
2524 }