Integrate OnchainRequest

This commit effectively replaces legacy data structures in
ChannelMonitor/OnchainTxHandler.

This doesn't change behavior.

Author: Antoine Riard

lightning/src/ln/channelmonitor.rs

@@ -32,7 +32,7 @@ use ln::chan_utils;
 use ln::chan_utils::{CounterpartyCommitmentSecrets, HTLCOutputInCommitment, LocalCommitmentTransaction, HTLCType};
 use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
 use ln::onchaintx::OnchainTxHandler;
-use ln::onchain_utils::{InputDescriptors, PackageTemplate};
+use ln::onchain_utils::{InputDescriptors, PackageTemplate, OnchainRequest, BumpStrategy};
 use chain::chaininterface::{ChainListener, ChainWatchInterface, BroadcasterInterface, FeeEstimator};
 use chain::transaction::OutPoint;
 use chain::keysinterface::{SpendableOutputDescriptor, ChannelKeys};
@@ -428,26 +428,6 @@ impl Readable for RemoteCommitmentTransaction {
 	}
 }
 
-/// ClaimRequest is a descriptor structure to communicate between detection
-/// and reaction module. They are generated by ChannelMonitor while parsing
-/// onchain txn leaked from a channel and handed over to OnchainTxHandler which
-/// is responsible for opportunistic aggregation, selecting and enforcing
-/// bumping logic, building and signing transactions.
-pub(crate) struct ClaimRequest {
-	// Block height before which claiming is exclusive to one party,
-	// after reaching it, claiming may be contentious.
-	pub(crate) absolute_timelock: u32,
-	// Timeout tx must have nLocktime set which means aggregating multiple
-	// ones must take the higher nLocktime among them to satisfy all of them.
-	// Sadly it has few pitfalls, a) it takes longuer to get fund back b) CLTV_DELTA
-	// of a sooner-HTLC could be swallowed by the highest nLocktime of the HTLC set.
-	// Do simplify we mark them as non-aggregable.
-	pub(crate) aggregable: bool,
-	// Template (list of outpoint and set of data needed to generate transaction digest
-	// and satisfy witness program).
-	pub(crate) package_template: PackageTemplate,
-}
-
 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
 #[derive(Clone, PartialEq)]
@@ -1351,7 +1331,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 	/// HTLC-Success/HTLC-Timeout transactions.
 	/// Return updates for HTLC pending in the channel and failed automatically by the broadcast of
 	/// revoked remote commitment tx
-	fn check_spend_remote_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<ClaimRequest>, (Txid, Vec<TxOut>)) where L::Target: Logger {
+	fn check_spend_remote_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<OnchainRequest>, (Txid, Vec<TxOut>)) where L::Target: Logger {
 		// Most secp and related errors trying to create keys means we have no hope of constructing
 		// a spend transaction...so we return no transactions to broadcast
 		let mut claimable_outpoints = Vec::new();
@@ -1384,7 +1364,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 			for (idx, outp) in tx.output.iter().enumerate() {
 				if outp.script_pubkey == revokeable_p2wsh {
 					let malleable_justice_tx = PackageTemplate::build_malleable_justice_tx(per_commitment_point, per_commitment_key, self.remote_tx_cache.remote_delayed_payment_base_key, self.remote_tx_cache.remote_htlc_base_key,  InputDescriptors::RevokedOutput, commitment_txid, idx as u32, outp.value, None, self.remote_tx_cache.on_remote_tx_csv);
-					claimable_outpoints.push(ClaimRequest { absolute_timelock: height + self.remote_tx_cache.on_remote_tx_csv as u32, aggregable: true, package_template: malleable_justice_tx});
+					claimable_outpoints.push(OnchainRequest { aggregation: true, bump_strategy: BumpStrategy::RBF, feerate_previous: 0, height_timer: None, absolute_timelock: height + self.remote_tx_cache.on_remote_tx_csv as u32, height_original: height, content: malleable_justice_tx});
 				}
 			}
 
@@ -1397,7 +1377,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 							return (claimable_outpoints, (commitment_txid, watch_outputs)); // Corrupted per_commitment_data, fuck this user
 						}
 						let malleable_justice_tx = PackageTemplate::build_malleable_justice_tx(per_commitment_point, per_commitment_key, self.remote_tx_cache.remote_delayed_payment_base_key, self.remote_tx_cache.remote_htlc_base_key, if htlc.offered { InputDescriptors::RevokedOfferedHTLC } else { InputDescriptors::RevokedReceivedHTLC }, commitment_txid, transaction_output_index, htlc.amount_msat / 1000, Some(htlc.clone()), self.remote_tx_cache.on_remote_tx_csv);
-						claimable_outpoints.push(ClaimRequest { absolute_timelock: htlc.cltv_expiry, aggregable: true, package_template: malleable_justice_tx});
+						claimable_outpoints.push(OnchainRequest { aggregation: true, bump_strategy: BumpStrategy::RBF, feerate_previous: 0, height_timer: None, absolute_timelock: htlc.cltv_expiry, height_original: height, content: malleable_justice_tx});
 					}
 				}
 			}
@@ -1529,10 +1509,9 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 								return (claimable_outpoints, (commitment_txid, watch_outputs)); // Corrupted per_commitment_data, fuck this user
 							}
 							let preimage = if htlc.offered { if let Some(p) = self.payment_preimages.get(&htlc.payment_hash) { Some(*p) } else { None } } else { None };
-							let aggregable = if !htlc.offered { false } else { true };
 							if preimage.is_some() || !htlc.offered {
 								let remote_htlc_tx = PackageTemplate::build_remote_htlc_tx(*revocation_point, self.remote_tx_cache.remote_delayed_payment_base_key, self.remote_tx_cache.remote_htlc_base_key, preimage, htlc.clone(), commitment_txid, transaction_output_index);
-								claimable_outpoints.push(ClaimRequest { absolute_timelock: htlc.cltv_expiry, aggregable, package_template: remote_htlc_tx });
+								claimable_outpoints.push(OnchainRequest { aggregation: if !htlc.offered { false } else { true }, bump_strategy: BumpStrategy::RBF, feerate_previous: 0, height_timer: None, absolute_timelock: htlc.cltv_expiry, height_original: height, content: remote_htlc_tx });
 							}
 						}
 					}
@@ -1543,7 +1522,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 	}
 
 	/// Attempts to claim a remote HTLC-Success/HTLC-Timeout's outputs using the revocation key
-	fn check_spend_remote_htlc<L: Deref>(&mut self, tx: &Transaction, commitment_number: u64, height: u32, logger: &L) -> (Vec<ClaimRequest>, Option<(Txid, Vec<TxOut>)>) where L::Target: Logger {
+	fn check_spend_remote_htlc<L: Deref>(&mut self, tx: &Transaction, commitment_number: u64, height: u32, logger: &L) -> (Vec<OnchainRequest>, Option<(Txid, Vec<TxOut>)>) where L::Target: Logger {
 		let htlc_txid = tx.txid();
 		if tx.input.len() != 1 || tx.output.len() != 1 || tx.input[0].witness.len() != 5 {
 			return (Vec::new(), None)
@@ -1564,11 +1543,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 
 		log_trace!(logger, "Remote HTLC broadcast {}:{}", htlc_txid, 0);
 		let malleable_justice_tx = PackageTemplate::build_malleable_justice_tx(per_commitment_point, per_commitment_key, self.remote_tx_cache.remote_delayed_payment_base_key, self.remote_tx_cache.remote_htlc_base_key, InputDescriptors::RevokedOutput, htlc_txid, 0, tx.output[0].value, None, self.remote_tx_cache.on_remote_tx_csv);
-		let claimable_outpoints = vec!(ClaimRequest { absolute_timelock: height + self.remote_tx_cache.on_remote_tx_csv as u32, aggregable: true, package_template: malleable_justice_tx });
+		let claimable_outpoints = vec!(OnchainRequest { aggregation: true, bump_strategy: BumpStrategy::RBF, feerate_previous: 0, height_timer: None, absolute_timelock: height + self.remote_tx_cache.on_remote_tx_csv as u32, height_original: height, content: malleable_justice_tx });
 		(claimable_outpoints, Some((htlc_txid, tx.output.clone())))
 	}
 
-	fn broadcast_by_local_state(&self, commitment_tx: &Transaction, local_tx: &LocalSignedTx) -> (Vec<ClaimRequest>, Vec<TxOut>, Option<(Script, PublicKey, PublicKey)>) {
+	fn broadcast_by_local_state(&self, commitment_tx: &Transaction, local_tx: &LocalSignedTx, height: u32) -> (Vec<OnchainRequest>, Vec<TxOut>, Option<(Script, PublicKey, PublicKey)>) {
 		let mut claim_requests = Vec::with_capacity(local_tx.htlc_outputs.len());
 		let mut watch_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());
 
@@ -1585,7 +1564,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 						continue;
 					}
 				} else { None }, htlc.amount_msat, local_tx.txid, transaction_output_index);
-				claim_requests.push(ClaimRequest { absolute_timelock: ::std::u32::MAX, aggregable: false, package_template: local_htlc_tx });
+				claim_requests.push(OnchainRequest { aggregation: false, bump_strategy: BumpStrategy::CPFP, feerate_previous: 0, height_timer: None, absolute_timelock: height, height_original: height, content: local_htlc_tx });
 				watch_outputs.push(commitment_tx.output[transaction_output_index as usize].clone());
 			}
 		}
@@ -1596,7 +1575,7 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 	/// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
 	/// revoked using data in local_claimable_outpoints.
 	/// Should not be used if check_spend_revoked_transaction succeeds.
-	fn check_spend_local_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<ClaimRequest>, (Txid, Vec<TxOut>)) where L::Target: Logger {
+	fn check_spend_local_transaction<L: Deref>(&mut self, tx: &Transaction, height: u32, logger: &L) -> (Vec<OnchainRequest>, (Txid, Vec<TxOut>)) where L::Target: Logger {
 		let commitment_txid = tx.txid();
 		let mut claim_requests = Vec::new();
 		let mut watch_outputs = Vec::new();
@@ -1638,13 +1617,13 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 		if self.current_local_commitment_tx.txid == commitment_txid {
 			is_local_tx = true;
 			log_trace!(logger, "Got latest local commitment tx broadcast, searching for available HTLCs to claim");
-			let mut res = self.broadcast_by_local_state(tx, &self.current_local_commitment_tx);
+			let mut res = self.broadcast_by_local_state(tx, &self.current_local_commitment_tx, height);
 			append_onchain_update!(res);
 		} else if let &Some(ref local_tx) = &self.prev_local_signed_commitment_tx {
 			if local_tx.txid == commitment_txid {
 				is_local_tx = true;
 				log_trace!(logger, "Got previous local commitment tx broadcast, searching for available HTLCs to claim");
-				let mut res = self.broadcast_by_local_state(tx, local_tx);
+				let mut res = self.broadcast_by_local_state(tx, local_tx, height);
 				append_onchain_update!(res);
 			}
 		}
@@ -1799,11 +1778,11 @@ impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
 		let should_broadcast = self.would_broadcast_at_height(height, &logger);
 		if should_broadcast {
 			let local_commitment_tx = PackageTemplate::build_local_commitment_tx(self.funding_redeemscript.clone(), self.funding_info.0.txid.clone(), self.funding_info.0.index as u32);
-			claimable_outpoints.push(ClaimRequest { absolute_timelock: height, aggregable: false, package_template: local_commitment_tx });
+			claimable_outpoints.push(OnchainRequest { aggregation: false, bump_strategy: BumpStrategy::CPFP, feerate_previous: 0, height_timer: None, absolute_timelock: height, height_original: height, content: local_commitment_tx });
 		}
 		if should_broadcast {
 			if let Some(commitment_tx) = self.onchain_tx_handler.get_fully_signed_local_tx(&self.funding_redeemscript) {
-				let (mut new_outpoints, new_outputs, _) = self.broadcast_by_local_state(&commitment_tx, &self.current_local_commitment_tx);
+				let (mut new_outpoints, new_outputs, _) = self.broadcast_by_local_state(&commitment_tx, &self.current_local_commitment_tx, height);
 				if !new_outputs.is_empty() {
 					watch_outputs.push((self.current_local_commitment_tx.txid.clone(), new_outputs));
 				}