f: delete IncludedHTLC

Author: tankyleo

lightning/src/ln/channel.rs

@@ -450,15 +450,6 @@ impl OutboundHTLCOutput {
 	}
 }
 
-#[derive(Clone, Debug)]
-pub(crate) struct IncludedHTLC {
-	pub offered: bool,
-	pub amount_msat: u64,
-	pub cltv_expiry: u32,
-	pub payment_hash: PaymentHash,
-	pub is_dust: bool,
-}
-
 /// See AwaitingRemoteRevoke ChannelState for more info
 #[cfg_attr(test, derive(Clone, Debug, PartialEq))]
 enum HTLCUpdateAwaitingACK {
@@ -4550,7 +4541,6 @@ where
 
 		let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
 		let mut htlc_source_table: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
-		let mut htlcs_included: Vec<IncludedHTLC> = Vec::with_capacity(num_htlcs);
 		let mut value_to_self_claimed_msat = 0;
 		let mut value_to_remote_claimed_msat = 0;
 
@@ -4572,24 +4562,10 @@ where
 			}
 		}
 
-		macro_rules! get_included_htlc {
-			($htlc: expr, $offered: expr, $is_dust: expr) => {
-				IncludedHTLC {
-					offered: $offered,
-					amount_msat: $htlc.amount_msat,
-					cltv_expiry: $htlc.cltv_expiry,
-					payment_hash: $htlc.payment_hash,
-					is_dust: $is_dust,
-				}
-			}
-		}
-
 		macro_rules! add_htlc_output {
-			($htlc: expr, $outbound: expr, $source: expr, $is_dust: expr) => {
-				let table_htlc = get_htlc_in_commitment!($htlc, $outbound == local);
-				let included_htlc = get_included_htlc!($htlc, $outbound == local, $is_dust);
-				htlc_source_table.push((table_htlc, $source));
-				htlcs_included.push(included_htlc);
+			($htlc: expr, $outbound: expr, $source: expr) => {
+				let htlc = get_htlc_in_commitment!($htlc, $outbound == local);
+				htlc_source_table.push((htlc, $source));
 			}
 		}
 
@@ -4599,8 +4575,7 @@ where
 		for htlc in self.pending_inbound_htlcs.iter() {
 			if htlc.state.included_in_commitment(generated_by_local) {
 				log_trace!(logger, "   ...including inbound {} HTLC {} (hash {}) with value {}", htlc.state, htlc.htlc_id, htlc.payment_hash, htlc.amount_msat);
-				let is_dust = htlc.is_dust(local, feerate_per_kw, broadcaster_dust_limit_sat, funding.get_channel_type());
-				add_htlc_output!(htlc, false, None, is_dust);
+				add_htlc_output!(htlc, false, None);
 			} else {
 				log_trace!(logger, "   ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, htlc.payment_hash, htlc.amount_msat, htlc.state);
 				if let Some(preimage) = htlc.state.preimage() {
@@ -4616,8 +4591,7 @@ where
 			}
 			if htlc.state.included_in_commitment(generated_by_local) {
 				log_trace!(logger, "   ...including outbound {} HTLC {} (hash {}) with value {}", htlc.state, htlc.htlc_id, htlc.payment_hash, htlc.amount_msat);
-				let is_dust = htlc.is_dust(local, feerate_per_kw, broadcaster_dust_limit_sat, funding.get_channel_type());
-				add_htlc_output!(htlc, true, Some(&htlc.source), is_dust);
+				add_htlc_output!(htlc, true, Some(&htlc.source));
 			} else {
 				log_trace!(logger, "   ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, htlc.payment_hash, htlc.amount_msat, htlc.state);
 				if htlc.state.preimage().is_some() {
@@ -4639,7 +4613,7 @@ where
 			&funding.channel_transaction_parameters,
 			&self.secp_ctx,
 			value_to_self_msat,
-			htlcs_included,
+			htlc_source_table.iter().map(|(htlc, _source)| htlc).cloned().collect(),
 			feerate_per_kw,
 			broadcaster_dust_limit_sat,
 			logger,

lightning/src/sign/tx_builder.rs

@@ -5,9 +5,10 @@ use core::ops::Deref;
 use bitcoin::secp256k1::{self, PublicKey, Secp256k1};
 
 use crate::ln::chan_utils::{
-	commit_tx_fee_sat, ChannelTransactionParameters, CommitmentTransaction, HTLCOutputInCommitment,
+	commit_tx_fee_sat, htlc_success_tx_weight, htlc_timeout_tx_weight,
+	ChannelTransactionParameters, CommitmentTransaction, HTLCOutputInCommitment,
 };
-use crate::ln::channel::{CommitmentStats, IncludedHTLC, ANCHOR_OUTPUT_VALUE_SATOSHI};
+use crate::ln::channel::{CommitmentStats, ANCHOR_OUTPUT_VALUE_SATOSHI};
 use crate::prelude::*;
 use crate::types::features::ChannelTypeFeatures;
 use crate::util::logger::Logger;
@@ -23,7 +24,7 @@ pub(crate) trait TxBuilder {
 	fn build_commitment_transaction<L: Deref>(
 		&self, local: bool, commitment_number: u64, per_commitment_point: &PublicKey,
 		channel_parameters: &ChannelTransactionParameters, secp_ctx: &Secp256k1<secp256k1::All>,
-		value_to_self_msat: u64, htlcs_in_tx: Vec<IncludedHTLC>, feerate_per_kw: u32,
+		value_to_self_msat: u64, htlcs_in_tx: Vec<HTLCOutputInCommitment>, feerate_per_kw: u32,
 		broadcaster_dust_limit_satoshis: u64, logger: &L,
 	) -> (CommitmentTransaction, CommitmentStats)
 	where
@@ -72,14 +73,30 @@ impl TxBuilder for SpecTxBuilder {
 	fn build_commitment_transaction<L: Deref>(
 		&self, local: bool, commitment_number: u64, per_commitment_point: &PublicKey,
 		channel_parameters: &ChannelTransactionParameters, secp_ctx: &Secp256k1<secp256k1::All>,
-		value_to_self_msat: u64, mut htlcs_in_tx: Vec<IncludedHTLC>, feerate_per_kw: u32,
+		value_to_self_msat: u64, mut htlcs_in_tx: Vec<HTLCOutputInCommitment>, feerate_per_kw: u32,
 		broadcaster_dust_limit_satoshis: u64, logger: &L,
 	) -> (CommitmentTransaction, CommitmentStats)
 	where
 		L::Target: Logger,
 	{
 		let mut local_htlc_total_msat = 0;
 		let mut remote_htlc_total_msat = 0;
+		let channel_type = &channel_parameters.channel_type_features;
+
+		let is_dust = |offered: bool, amount_msat: u64| -> bool {
+			let htlc_tx_fee_sat = if channel_type.supports_anchors_zero_fee_htlc_tx() {
+				0
+			} else {
+				let htlc_tx_weight = if offered {
+					htlc_timeout_tx_weight(channel_type)
+				} else {
+					htlc_success_tx_weight(channel_type)
+				};
+				// As required by the spec, round down
+				feerate_per_kw as u64 * htlc_tx_weight / 1000
+			};
+			amount_msat / 1000 < broadcaster_dust_limit_satoshis + htlc_tx_fee_sat
+		};
 
 		// Trim dust htlcs
 		htlcs_in_tx.retain(|htlc| {
@@ -89,7 +106,7 @@ impl TxBuilder for SpecTxBuilder {
 			} else {
 				remote_htlc_total_msat += htlc.amount_msat;
 			}
-			if htlc.is_dust {
+			if is_dust(htlc.offered, htlc.amount_msat) {
 				log_trace!(
 					logger,
 					"   ...trimming {} HTLC with value {}sat, hash {}, due to dust limit {}",
@@ -182,20 +199,7 @@ impl TxBuilder for SpecTxBuilder {
 			to_broadcaster_value_sat,
 			to_countersignatory_value_sat,
 			feerate_per_kw,
-			htlcs_in_tx
-				.into_iter()
-				.map(|htlc| {
-					// We filtered out all dust HTLCs above
-					debug_assert!(!htlc.is_dust);
-					HTLCOutputInCommitment {
-						offered: htlc.offered,
-						amount_msat: htlc.amount_msat,
-						cltv_expiry: htlc.cltv_expiry,
-						payment_hash: htlc.payment_hash,
-						transaction_output_index: None,
-					}
-				})
-				.collect(),
+			htlcs_in_tx,
 			&directed_parameters,
 			secp_ctx,
 		);