Add TxBuilder::build_commitment_stats

Author: tankyleo

lightning/src/ln/channel.rs

@@ -56,6 +56,7 @@ use crate::chain::chaininterface::{FeeEstimator, ConfirmationTarget, LowerBounde
 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS};
 use crate::chain::transaction::{OutPoint, TransactionData};
 use crate::sign::ecdsa::EcdsaChannelSigner;
+use crate::sign::tx_builder::{SpecTxBuilder, TxBuilder};
 use crate::sign::{EntropySource, ChannelSigner, SignerProvider, NodeSigner, Recipient};
 use crate::events::{ClosureReason, Event};
 use crate::events::bump_transaction::BASE_INPUT_WEIGHT;
@@ -985,10 +986,10 @@ struct CommitmentData<'a> {
 }
 
 /// A struct gathering stats on a commitment transaction, either local or remote.
-struct CommitmentStats {
-	total_fee_sat: u64, // the total fee included in the transaction
-	local_balance_before_fee_msat: u64, // local balance before fees *not* considering dust limits
-	remote_balance_before_fee_msat: u64, // remote balance before fees *not* considering dust limits
+pub(crate) struct CommitmentStats {
+	pub(crate) total_fee_sat: u64, // the total fee included in the transaction
+	pub(crate) local_balance_before_fee_msat: u64, // local balance before fees *not* considering dust limits
+	pub(crate) remote_balance_before_fee_msat: u64, // remote balance before fees *not* considering dust limits
 }
 
 /// Used when calculating whether we or the remote can afford an additional HTLC.
@@ -3869,7 +3870,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 	#[inline]
 	fn build_commitment_stats(&self, funding: &FundingScope, local: bool, generated_by_local: bool) -> CommitmentStats {
 		let broadcaster_dust_limit_sat = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
-		let mut non_dust_htlc_count = 0;
+		let mut nondust_htlc_count = 0;
 		let mut remote_htlc_total_msat = 0;
 		let mut local_htlc_total_msat = 0;
 		let mut value_to_self_msat_offset = 0;
@@ -3879,7 +3880,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		for htlc in self.pending_inbound_htlcs.iter() {
 			if htlc.state.included_in_commitment(generated_by_local) {
 				if !htlc.is_dust(local, feerate_per_kw, broadcaster_dust_limit_sat, funding.get_channel_type()) {
-					non_dust_htlc_count += 1;
+					nondust_htlc_count += 1;
 				}
 				remote_htlc_total_msat += htlc.amount_msat;
 			} else {
@@ -3892,7 +3893,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		for htlc in self.pending_outbound_htlcs.iter() {
 			if htlc.state.included_in_commitment(generated_by_local) {
 				if !htlc.is_dust(local, feerate_per_kw, broadcaster_dust_limit_sat, funding.get_channel_type()) {
-					non_dust_htlc_count += 1;
+					nondust_htlc_count += 1;
 				}
 				local_htlc_total_msat += htlc.amount_msat;
 			} else {
@@ -3928,20 +3929,18 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 			debug_assert!(broadcaster_max_commitment_tx_output.1 <= value_to_remote_msat || value_to_remote_msat / 1000 >= funding.holder_selected_channel_reserve_satoshis);
 			broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat);
 		}
-
-		let total_fee_sat = commit_tx_fee_sat(feerate_per_kw, non_dust_htlc_count, &funding.channel_transaction_parameters.channel_type_features);
-		let total_anchors_sat = if funding.channel_transaction_parameters.channel_type_features.supports_anchors_zero_fee_htlc_tx() { ANCHOR_OUTPUT_VALUE_SATOSHI * 2 } else { 0 };
-
-		if funding.is_outbound() {
-			value_to_self_msat = value_to_self_msat.saturating_sub(total_anchors_sat * 1000);
-		} else {
-			value_to_remote_msat = value_to_remote_msat.saturating_sub(total_anchors_sat * 1000);
-		}
+		let builder = SpecTxBuilder {};
+		let (local_balance_before_fee_msat, remote_balance_before_fee_msat) = builder.balances_excluding_tx_fee(
+			funding.is_outbound(),
+			&funding.channel_transaction_parameters.channel_type_features,
+			value_to_self_msat,
+			value_to_remote_msat,
+		);
 
 		CommitmentStats {
-			total_fee_sat,
-			local_balance_before_fee_msat: value_to_self_msat,
-			remote_balance_before_fee_msat: value_to_remote_msat,
+			total_fee_sat: builder.commit_tx_fee_sat(feerate_per_kw, nondust_htlc_count, &funding.channel_transaction_parameters.channel_type_features),
+			local_balance_before_fee_msat,
+			remote_balance_before_fee_msat,
 		}
 	}
 

lightning/src/sign/mod.rs

@@ -76,6 +76,7 @@ pub(crate) mod type_resolver;
 pub mod ecdsa;
 #[cfg(taproot)]
 pub mod taproot;
+pub mod tx_builder;
 
 /// Information about a spendable output to a P2WSH script.
 ///

lightning/src/sign/tx_builder.rs

@@ -0,0 +1,50 @@
+//! Defines the `TxBuilder` trait, and the `SpecTxBuilder` type
+
+use crate::ln::chan_utils::commit_tx_fee_sat;
+use crate::ln::channel::ANCHOR_OUTPUT_VALUE_SATOSHI;
+use crate::prelude::*;
+use crate::types::features::ChannelTypeFeatures;
+
+pub(crate) trait TxBuilder {
+	fn commit_tx_fee_sat(
+		&self, feerate_per_kw: u32, nondust_htlc_count: usize, channel_type: &ChannelTypeFeatures,
+	) -> u64;
+	fn balances_excluding_tx_fee(
+		&self, is_outbound_from_holder: bool, channel_type: &ChannelTypeFeatures,
+		value_to_self_after_htlcs: u64, value_to_remote_after_htlcs: u64,
+	) -> (u64, u64);
+}
+
+#[derive(Clone, Debug, Default)]
+pub(crate) struct SpecTxBuilder {}
+
+impl TxBuilder for SpecTxBuilder {
+	fn commit_tx_fee_sat(
+		&self, feerate_per_kw: u32, nondust_htlc_count: usize, channel_type: &ChannelTypeFeatures,
+	) -> u64 {
+		commit_tx_fee_sat(feerate_per_kw, nondust_htlc_count, channel_type)
+	}
+	fn balances_excluding_tx_fee(
+		&self, is_outbound_from_holder: bool, channel_type: &ChannelTypeFeatures,
+		value_to_self_after_htlcs: u64, value_to_remote_after_htlcs: u64,
+	) -> (u64, u64) {
+		let total_anchors_sat = if channel_type.supports_anchors_zero_fee_htlc_tx() {
+			ANCHOR_OUTPUT_VALUE_SATOSHI * 2
+		} else {
+			0
+		};
+
+		let mut local_balance_before_fee_msat = value_to_self_after_htlcs;
+		let mut remote_balance_before_fee_msat = value_to_remote_after_htlcs;
+
+		if is_outbound_from_holder {
+			local_balance_before_fee_msat =
+				local_balance_before_fee_msat.saturating_sub(total_anchors_sat * 1000);
+		} else {
+			remote_balance_before_fee_msat =
+				remote_balance_before_fee_msat.saturating_sub(total_anchors_sat * 1000);
+		}
+
+		(local_balance_before_fee_msat, remote_balance_before_fee_msat)
+	}
+}