Cleanup dust exposure due to excess fees in get_next_commitment_stats

Author: tankyleo

lightning/src/sign/tx_builder.rs

@@ -42,71 +42,55 @@ pub(crate) struct NextCommitmentStats {
 	pub nondust_htlc_count: usize,
 	pub commit_tx_fee_sat: u64,
 	pub dust_exposure_msat: u64,
-	// If the counterparty sets a feerate on the channel in excess of our dust_exposure_limiting_feerate,
-	// this should be set to the dust exposure that would result from us adding an additional nondust outbound
-	// htlc on the counterparty's commitment transaction.
-	pub extra_nondust_htlc_on_counterparty_tx_dust_exposure_msat: Option<u64>,
+	pub extra_accepted_htlc_dust_exposure_msat: u64,
 }
 
-fn excess_fees_on_counterparty_tx_dust_exposure_msat(
-	next_commitment_htlcs: &[HTLCAmountDirection], dust_buffer_feerate: u32, excess_feerate: u32,
-	counterparty_dust_limit_satoshis: u64, dust_htlc_exposure_msat: u64,
-	channel_type: &ChannelTypeFeatures,
+fn commit_plus_htlc_tx_fees_msat(
+	local: bool, next_commitment_htlcs: &[HTLCAmountDirection], dust_buffer_feerate: u32,
+	feerate: u32, broadcaster_dust_limit_satoshis: u64, channel_type: &ChannelTypeFeatures,
 ) -> (u64, u64) {
-	let on_counterparty_tx_accepted_nondust_htlcs = next_commitment_htlcs
+	let accepted_nondust_htlcs = next_commitment_htlcs
 		.iter()
 		.filter(|htlc| {
-			htlc.outbound
+			htlc.outbound != local
 				&& !htlc.is_dust(
-					false,
+					local,
 					dust_buffer_feerate,
-					counterparty_dust_limit_satoshis,
+					broadcaster_dust_limit_satoshis,
 					channel_type,
 				)
 		})
 		.count();
-	let on_counterparty_tx_offered_nondust_htlcs = next_commitment_htlcs
+	let offered_nondust_htlcs = next_commitment_htlcs
 		.iter()
 		.filter(|htlc| {
-			!htlc.outbound
+			htlc.outbound == local
 				&& !htlc.is_dust(
-					false,
+					local,
 					dust_buffer_feerate,
-					counterparty_dust_limit_satoshis,
+					broadcaster_dust_limit_satoshis,
 					channel_type,
 				)
 		})
 		.count();
 
-	let commitment_fee_sat = commit_tx_fee_sat(
-		excess_feerate,
-		on_counterparty_tx_accepted_nondust_htlcs + on_counterparty_tx_offered_nondust_htlcs,
-		channel_type,
-	);
-	let second_stage_fees_sat = htlc_tx_fees_sat(
-		excess_feerate,
-		on_counterparty_tx_accepted_nondust_htlcs,
-		on_counterparty_tx_offered_nondust_htlcs,
-		channel_type,
-	);
-	let on_counterparty_tx_dust_exposure_msat =
-		dust_htlc_exposure_msat + (commitment_fee_sat + second_stage_fees_sat) * 1000;
+	let commitment_fee_sat =
+		commit_tx_fee_sat(feerate, accepted_nondust_htlcs + offered_nondust_htlcs, channel_type);
+	let second_stage_fees_sat =
+		htlc_tx_fees_sat(feerate, accepted_nondust_htlcs, offered_nondust_htlcs, channel_type);
+	let total_fees_msat = (commitment_fee_sat + second_stage_fees_sat) * 1000;
 
-	let extra_htlc_commitment_fee_sat = commit_tx_fee_sat(
-		excess_feerate,
-		on_counterparty_tx_accepted_nondust_htlcs + 1 + on_counterparty_tx_offered_nondust_htlcs,
+	let extra_accepted_htlc_commitment_fee_sat = commit_tx_fee_sat(
+		feerate,
+		accepted_nondust_htlcs + 1 + offered_nondust_htlcs,
 		channel_type,
 	);
-	let extra_htlc_second_stage_fees_sat = htlc_tx_fees_sat(
-		excess_feerate,
-		on_counterparty_tx_accepted_nondust_htlcs + 1,
-		on_counterparty_tx_offered_nondust_htlcs,
-		channel_type,
-	);
-	let extra_htlc_dust_exposure_msat = dust_htlc_exposure_msat
-		+ (extra_htlc_commitment_fee_sat + extra_htlc_second_stage_fees_sat) * 1000;
+	let extra_accepted_htlc_second_stage_fees_sat =
+		htlc_tx_fees_sat(feerate, accepted_nondust_htlcs + 1, offered_nondust_htlcs, channel_type);
+	let extra_accepted_htlc_total_fees_msat =
+		(extra_accepted_htlc_commitment_fee_sat + extra_accepted_htlc_second_stage_fees_sat) * 1000;
 
-	(on_counterparty_tx_dust_exposure_msat, extra_htlc_dust_exposure_msat)
+	(total_fees_msat, extra_accepted_htlc_total_fees_msat)
 }
 
 fn subtract_addl_outputs(
@@ -186,11 +170,11 @@ impl TxBuilder for SpecTxBuilder {
 		dust_exposure_limiting_feerate: Option<u32>, broadcaster_dust_limit_satoshis: u64,
 		channel_type: &ChannelTypeFeatures,
 	) -> Result<NextCommitmentStats, ()> {
-		let excess_feerate_opt =
-			feerate_per_kw.checked_sub(dust_exposure_limiting_feerate.unwrap_or(feerate_per_kw));
+		let excess_feerate =
+			feerate_per_kw.saturating_sub(dust_exposure_limiting_feerate.unwrap_or(feerate_per_kw));
 		if channel_type.supports_anchor_zero_fee_commitments() {
 			debug_assert_eq!(feerate_per_kw, 0);
-			debug_assert_eq!(excess_feerate_opt, Some(0));
+			debug_assert_eq!(excess_feerate, 0);
 			debug_assert_eq!(addl_nondust_htlc_count, 0);
 		}
 
@@ -253,22 +237,24 @@ impl TxBuilder for SpecTxBuilder {
 			})
 			.sum();
 
-		// Count the excess fees on the counterparty's transaction as dust
-		let (dust_exposure_msat, extra_nondust_htlc_on_counterparty_tx_dust_exposure_msat) =
-			if let (Some(excess_feerate), false) = (excess_feerate_opt, local) {
-				let (dust_exposure_msat, extra_nondust_htlc_exposure_msat) =
-					excess_fees_on_counterparty_tx_dust_exposure_msat(
-						&next_commitment_htlcs,
-						dust_buffer_feerate,
-						excess_feerate,
-						broadcaster_dust_limit_satoshis,
-						dust_exposure_msat,
-						channel_type,
-					);
-				(dust_exposure_msat, Some(extra_nondust_htlc_exposure_msat))
-			} else {
-				(dust_exposure_msat, None)
-			};
+		// Add any excess fees to dust exposure on counterparty transactions
+		let (dust_exposure_msat, extra_accepted_htlc_dust_exposure_msat) = if local {
+			(dust_exposure_msat, dust_exposure_msat)
+		} else {
+			let (excess_fees_msat, extra_accepted_htlc_excess_fees_msat) =
+				commit_plus_htlc_tx_fees_msat(
+					local,
+					&next_commitment_htlcs,
+					dust_buffer_feerate,
+					excess_feerate,
+					broadcaster_dust_limit_satoshis,
+					channel_type,
+				);
+			(
+				dust_exposure_msat + excess_fees_msat,
+				dust_exposure_msat + extra_accepted_htlc_excess_fees_msat,
+			)
+		};
 
 		Ok(NextCommitmentStats {
 			inbound_htlcs_count,
@@ -278,7 +264,7 @@ impl TxBuilder for SpecTxBuilder {
 			nondust_htlc_count: nondust_htlc_count + addl_nondust_htlc_count,
 			commit_tx_fee_sat,
 			dust_exposure_msat,
-			extra_nondust_htlc_on_counterparty_tx_dust_exposure_msat,
+			extra_accepted_htlc_dust_exposure_msat,
 		})
 	}
 	fn commit_tx_fee_sat(