Remove duplicata of broadcast txn from ChannelMonitor

Previously, if new ouputs were found to be watched as part
of channel operations, the block was rescan which triggers
again parser and generation of transactions already issued.

This commit first modifies the test framework without
altering further ChannelMonitor.

ChannelMonitor refactoring is introduced in a latter commit.

Author: Antoine Riard

lightning/src/ln/channelmonitor.rs

@@ -1772,11 +1772,11 @@ impl ChannelMonitor {
 					let mut inputs_info = Vec::new();
 
 					macro_rules! sign_input {
-						($sighash_parts: expr, $input: expr, $amount: expr, $preimage: expr) => {
+						($sighash_parts: expr, $input: expr, $amount: expr, $preimage: expr, $idx: expr) => {
 							{
 								let (sig, redeemscript, htlc_key) = match self.key_storage {
 									Storage::Local { ref htlc_base_key, .. } => {
-										let htlc = &per_commitment_option.unwrap()[$input.sequence as usize].0;
+										let htlc = &per_commitment_option.unwrap()[$idx as usize].0;
 										let redeemscript = chan_utils::get_htlc_redeemscript_with_explicit_keys(htlc, &a_htlc_key, &b_htlc_key, &revocation_pubkey);
 										let sighash = hash_to_message!(&$sighash_parts.sighash_all(&$input, &redeemscript, $amount)[..]);
 										let htlc_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &htlc_base_key));
@@ -1805,19 +1805,20 @@ impl ChannelMonitor {
 							}
 							if let Some(payment_preimage) = self.payment_preimages.get(&htlc.payment_hash) {
 								if htlc.offered {
-									let input = TxIn {
+									let mut input = TxIn {
 										previous_output: BitcoinOutPoint {
 											txid: commitment_txid,
 											vout: transaction_output_index,
 										},
 										script_sig: Script::new(),
-										sequence: idx as u32, // reset to 0xfffffffd in sign_input
+										sequence: idx as u32, // reset to 0xfffffffd before sign_input
 										witness: Vec::new(),
 									};
 									if htlc.cltv_expiry > height + CLTV_SHARED_CLAIM_BUFFER {
+										input.sequence = 0xff_ff_ff_fd;
 										inputs.push(input);
 										inputs_desc.push(if htlc.offered { InputDescriptors::OfferedHTLC } else { InputDescriptors::ReceivedHTLC });
-										inputs_info.push((payment_preimage, tx.output[transaction_output_index as usize].value, htlc.cltv_expiry));
+										inputs_info.push((payment_preimage, tx.output[transaction_output_index as usize].value, htlc.cltv_expiry, idx));
 										total_value += tx.output[transaction_output_index as usize].value;
 									} else {
 										let mut single_htlc_tx = Transaction {
@@ -1833,8 +1834,10 @@ impl ChannelMonitor {
 										let height_timer = Self::get_height_timer(height, htlc.cltv_expiry);
 										let mut used_feerate;
 										if subtract_high_prio_fee!(self, fee_estimator, single_htlc_tx.output[0].value, predicted_weight, used_feerate) {
+											let idx = single_htlc_tx.input[0].sequence;
+											single_htlc_tx.input[0].sequence = 0xff_ff_ff_fd;
 											let sighash_parts = bip143::SighashComponents::new(&single_htlc_tx);
-											let (redeemscript, htlc_key) = sign_input!(sighash_parts, single_htlc_tx.input[0], htlc.amount_msat / 1000, payment_preimage.0.to_vec());
+											let (redeemscript, htlc_key) = sign_input!(sighash_parts, single_htlc_tx.input[0], htlc.amount_msat / 1000, payment_preimage.0.to_vec(), idx);
 											assert!(predicted_weight >= single_htlc_tx.get_weight());
 											spendable_outputs.push(SpendableOutputDescriptor::StaticOutput {
 												outpoint: BitcoinOutPoint { txid: single_htlc_tx.txid(), vout: 0 },
@@ -1881,8 +1884,10 @@ impl ChannelMonitor {
 								let height_timer = Self::get_height_timer(height, htlc.cltv_expiry);
 								let mut used_feerate;
 								if subtract_high_prio_fee!(self, fee_estimator, timeout_tx.output[0].value, predicted_weight, used_feerate) {
+									let idx = timeout_tx.input[0].sequence;
+									timeout_tx.input[0].sequence = 0xff_ff_ff_fd;
 									let sighash_parts = bip143::SighashComponents::new(&timeout_tx);
-									let (redeemscript, htlc_key) = sign_input!(sighash_parts, timeout_tx.input[0], htlc.amount_msat / 1000, vec![0]);
+									let (redeemscript, htlc_key) = sign_input!(sighash_parts, timeout_tx.input[0], htlc.amount_msat / 1000, vec![0], idx);
 									assert!(predicted_weight >= timeout_tx.get_weight());
 									//TODO: track SpendableOutputDescriptor
 									log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", timeout_tx.input[0].previous_output.txid, timeout_tx.input[0].previous_output.vout, height_timer);
@@ -1934,7 +1939,7 @@ impl ChannelMonitor {
 					let height_timer = Self::get_height_timer(height, soonest_timelock);
 					let spend_txid = spend_tx.txid();
 					for (input, info) in spend_tx.input.iter_mut().zip(inputs_info.iter()) {
-						let (redeemscript, htlc_key) = sign_input!(sighash_parts, input, info.1, (info.0).0.to_vec());
+						let (redeemscript, htlc_key) = sign_input!(sighash_parts, input, info.1, (info.0).0.to_vec(), info.3);
 						log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", input.previous_output.txid, input.previous_output.vout, height_timer);
 						per_input_material.insert(input.previous_output, InputMaterial::RemoteHTLC { script: redeemscript, key: htlc_key, preimage: Some(*(info.0)), amount: info.1, locktime: 0});
 						match self.claimable_outpoints.entry(input.previous_output) {
@@ -2872,7 +2877,6 @@ impl ChannelMonitor {
 		for per_outp_material in cached_claim_datas.per_input_material.values() {
 			match per_outp_material {
 				&InputMaterial::Revoked { ref script, ref is_htlc, ref amount, .. } => {
-					log_trace!(self, "Is HLTC ? {}", is_htlc);
 					inputs_witnesses_weight += Self::get_witnesses_weight(if !is_htlc { &[InputDescriptors::RevokedOutput] } else if HTLCType::scriptlen_to_htlctype(script.len()) == Some(HTLCType::OfferedHTLC) { &[InputDescriptors::RevokedOfferedHTLC] } else if HTLCType::scriptlen_to_htlctype(script.len()) == Some(HTLCType::AcceptedHTLC) { &[InputDescriptors::RevokedReceivedHTLC] } else { unreachable!() });
 					amt += *amount;
 				},

lightning/src/ln/functional_test_utils.rs

@@ -34,6 +34,7 @@ use std::cell::RefCell;
 use std::rc::Rc;
 use std::sync::{Arc, Mutex};
 use std::mem;
+use std::collections::HashSet;
 
 pub const CHAN_CONFIRM_DEPTH: u32 = 100;
 pub fn confirm_transaction(notifier: &chaininterface::BlockNotifier, chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
@@ -851,7 +852,7 @@ pub fn create_network(node_count: usize, node_config: &[Option<UserConfig>]) ->
 		let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
 		let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
 		let block_notifier = Arc::new(chaininterface::BlockNotifier::new(chain_monitor.clone()));
-		let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
+		let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), broadcasted_txn: Mutex::new(HashSet::new())});
 		let mut seed = [0; 32];
 		rng.fill_bytes(&mut seed);
 		let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet, Arc::clone(&logger)));