Merge pull request #10 from synonymdev/feat/calculate-total-fee

coreyphillips · web-flow · commit 4131285f8103 · 2025-07-07T11:58:56.000-04:00
Feat/calculate total fee
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ldk-node"
-version = "0.6.1-rc.1"
+version = "0.6.1-rc.2"
 authors = ["Elias Rohrer <dev@tnull.de>"]
 homepage = "https://lightningdevkit.org/"
 license = "MIT OR Apache-2.0"
diff --git a/Package.swift b/Package.swift
@@ -3,8 +3,8 @@
 
 import PackageDescription
 
-let tag = "v0.6.1-rc.1"
-let checksum = "3c86024c00328d9a98a50d6e2c2808766d21e070bb49b7ceba1b2a3a1d708e5b"
+let tag = "v0.6.1-rc.2"
+let checksum = "c7c6373886f0a6d673d0921c8ffd57bb2ad9e3df07ec4e62ee937d83c1f79496"
 let url = "https://github.com/synonymdev/ldk-node/releases/download/\(tag)/LDKNodeFFI.xcframework.zip"
 
 let package = Package(
diff --git a/bindings/kotlin/ldk-node-android/README.md b/bindings/kotlin/ldk-node-android/README.md
@@ -31,7 +31,7 @@ Publishing new version guide.
     - add dependency in `libs.versions.toml`:
         ```toml
         # by tag
-        ldk-node-android = { module = "com.github.synonymdev:ldk-node", version = "v0.6.1-rc.1"
+        ldk-node-android = { module = "com.github.synonymdev:ldk-node", version = "v0.6.1-rc.2"
 
         # or by branch
         ldk-node-android = { module = "com.github.synonymdev:ldk-node", version = "main-SNAPSHOT"
diff --git a/bindings/kotlin/ldk-node-android/gradle.properties b/bindings/kotlin/ldk-node-android/gradle.properties
@@ -2,4 +2,4 @@ org.gradle.jvmargs=-Xmx1536m
 android.useAndroidX=true
 android.enableJetifier=true
 kotlin.code.style=official
-libraryVersion=v0.6.1-rc.1
+libraryVersion=v0.6.1-rc.2
diff --git a/bindings/kotlin/ldk-node-android/lib/src/main/jniLibs/arm64-v8a/libldk_node.so b/bindings/kotlin/ldk-node-android/lib/src/main/jniLibs/arm64-v8a/libldk_node.so
diff --git a/bindings/kotlin/ldk-node-android/lib/src/main/jniLibs/armeabi-v7a/libldk_node.so b/bindings/kotlin/ldk-node-android/lib/src/main/jniLibs/armeabi-v7a/libldk_node.so
diff --git a/bindings/kotlin/ldk-node-android/lib/src/main/jniLibs/x86_64/libldk_node.so b/bindings/kotlin/ldk-node-android/lib/src/main/jniLibs/x86_64/libldk_node.so
diff --git a/bindings/kotlin/ldk-node-android/lib/src/main/kotlin/org/lightningdevkit/ldknode/ldk_node.kt b/bindings/kotlin/ldk-node-android/lib/src/main/kotlin/org/lightningdevkit/ldknode/ldk_node.kt
@@ -1014,6 +1014,8 @@ internal open class UniffiVTableCallbackInterfaceVssHeaderProvider(
 
 
 
+
+
 
 
 
@@ -1309,6 +1311,8 @@ internal interface UniffiLib : Library {
     ): RustBuffer.ByValue
     fun uniffi_ldk_node_fn_method_onchainpayment_calculate_cpfp_fee_rate(`ptr`: Pointer,`parentTxid`: RustBuffer.ByValue,`urgent`: Byte,uniffi_out_err: UniffiRustCallStatus, 
     ): Pointer
+    fun uniffi_ldk_node_fn_method_onchainpayment_calculate_total_fee(`ptr`: Pointer,`address`: RustBuffer.ByValue,`amountSats`: Long,`feeRate`: RustBuffer.ByValue,`utxosToSpend`: RustBuffer.ByValue,uniffi_out_err: UniffiRustCallStatus, 
+    ): Long
     fun uniffi_ldk_node_fn_method_onchainpayment_list_spendable_outputs(`ptr`: Pointer,uniffi_out_err: UniffiRustCallStatus, 
     ): RustBuffer.ByValue
     fun uniffi_ldk_node_fn_method_onchainpayment_new_address(`ptr`: Pointer,uniffi_out_err: UniffiRustCallStatus, 
@@ -1675,6 +1679,8 @@ internal interface UniffiLib : Library {
     ): Short
     fun uniffi_ldk_node_checksum_method_onchainpayment_calculate_cpfp_fee_rate(
     ): Short
+    fun uniffi_ldk_node_checksum_method_onchainpayment_calculate_total_fee(
+    ): Short
     fun uniffi_ldk_node_checksum_method_onchainpayment_list_spendable_outputs(
     ): Short
     fun uniffi_ldk_node_checksum_method_onchainpayment_new_address(
@@ -2048,6 +2054,9 @@ private fun uniffiCheckApiChecksums(lib: UniffiLib) {
     if (lib.uniffi_ldk_node_checksum_method_onchainpayment_calculate_cpfp_fee_rate() != 32879.toShort()) {
         throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     }
+    if (lib.uniffi_ldk_node_checksum_method_onchainpayment_calculate_total_fee() != 57218.toShort()) {
+        throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
+    }
     if (lib.uniffi_ldk_node_checksum_method_onchainpayment_list_spendable_outputs() != 19144.toShort()) {
         throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     }
@@ -6072,6 +6081,8 @@ public interface OnchainPaymentInterface {
     
     fun `calculateCpfpFeeRate`(`parentTxid`: Txid, `urgent`: kotlin.Boolean): FeeRate
     
+    fun `calculateTotalFee`(`address`: Address, `amountSats`: kotlin.ULong, `feeRate`: FeeRate?, `utxosToSpend`: List<SpendableUtxo>?): kotlin.ULong
+    
     fun `listSpendableOutputs`(): List<SpendableUtxo>
     
     fun `newAddress`(): Address
@@ -6206,6 +6217,19 @@ open class OnchainPayment: Disposable, AutoCloseable, OnchainPaymentInterface {
     
 
     
+    @Throws(NodeException::class)override fun `calculateTotalFee`(`address`: Address, `amountSats`: kotlin.ULong, `feeRate`: FeeRate?, `utxosToSpend`: List<SpendableUtxo>?): kotlin.ULong {
+            return FfiConverterULong.lift(
+    callWithPointer {
+    uniffiRustCallWithError(NodeException) { _status ->
+    UniffiLib.INSTANCE.uniffi_ldk_node_fn_method_onchainpayment_calculate_total_fee(
+        it, FfiConverterTypeAddress.lower(`address`),FfiConverterULong.lower(`amountSats`),FfiConverterOptionalTypeFeeRate.lower(`feeRate`),FfiConverterOptionalSequenceTypeSpendableUtxo.lower(`utxosToSpend`),_status)
+}
+    }
+    )
+    }
+    
+
+    
     @Throws(NodeException::class)override fun `listSpendableOutputs`(): List<SpendableUtxo> {
             return FfiConverterSequenceTypeSpendableUtxo.lift(
     callWithPointer {
diff --git a/bindings/ldk_node.udl b/bindings/ldk_node.udl
@@ -232,6 +232,8 @@ interface OnchainPayment {
     Txid accelerate_by_cpfp([ByRef]Txid txid, FeeRate? fee_rate, Address? destination_address);
     [Throws=NodeError]
     FeeRate calculate_cpfp_fee_rate([ByRef]Txid parent_txid, boolean urgent);
+    [Throws=NodeError]
+    u64 calculate_total_fee([ByRef]Address address, u64 amount_sats, FeeRate? fee_rate, sequence<SpendableUtxo>? utxos_to_spend);
 };
 
 enum CoinSelectionAlgorithm {
diff --git a/bindings/swift/Sources/LDKNode/LDKNode.swift b/bindings/swift/Sources/LDKNode/LDKNode.swift
@@ -2505,6 +2505,8 @@ public protocol OnchainPaymentProtocol : AnyObject {
     
     func calculateCpfpFeeRate(parentTxid: Txid, urgent: Bool) throws  -> FeeRate
     
+    func calculateTotalFee(address: Address, amountSats: UInt64, feeRate: FeeRate?, utxosToSpend: [SpendableUtxo]?) throws  -> UInt64
+    
     func listSpendableOutputs() throws  -> [SpendableUtxo]
     
     func newAddress() throws  -> Address
@@ -2586,6 +2588,17 @@ open func calculateCpfpFeeRate(parentTxid: Txid, urgent: Bool)throws  -> FeeRate
 })
 }
     
+open func calculateTotalFee(address: Address, amountSats: UInt64, feeRate: FeeRate?, utxosToSpend: [SpendableUtxo]?)throws  -> UInt64 {
+    return try  FfiConverterUInt64.lift(try rustCallWithError(FfiConverterTypeNodeError.lift) {
+    uniffi_ldk_node_fn_method_onchainpayment_calculate_total_fee(self.uniffiClonePointer(),
+        FfiConverterTypeAddress.lower(address),
+        FfiConverterUInt64.lower(amountSats),
+        FfiConverterOptionTypeFeeRate.lower(feeRate),
+        FfiConverterOptionSequenceTypeSpendableUtxo.lower(utxosToSpend),$0
+    )
+})
+}
+    
 open func listSpendableOutputs()throws  -> [SpendableUtxo] {
     return try  FfiConverterSequenceTypeSpendableUtxo.lift(try rustCallWithError(FfiConverterTypeNodeError.lift) {
     uniffi_ldk_node_fn_method_onchainpayment_list_spendable_outputs(self.uniffiClonePointer(),$0
@@ -10057,6 +10070,9 @@ private var initializationResult: InitializationResult {
     if (uniffi_ldk_node_checksum_method_onchainpayment_calculate_cpfp_fee_rate() != 32879) {
         return InitializationResult.apiChecksumMismatch
     }
+    if (uniffi_ldk_node_checksum_method_onchainpayment_calculate_total_fee() != 57218) {
+        return InitializationResult.apiChecksumMismatch
+    }
     if (uniffi_ldk_node_checksum_method_onchainpayment_list_spendable_outputs() != 19144) {
         return InitializationResult.apiChecksumMismatch
     }
diff --git a/src/payment/onchain.rs b/src/payment/onchain.rs
@@ -148,6 +148,59 @@ impl OnchainPayment {
 		Ok(selected_utxos)
 	}
 
+	/// Calculates the total fee for an on-chain payment without sending it.
+	///
+	/// This method simulates creating a transaction to the given address for the specified amount
+	/// and returns the total fee that would be paid. This is useful for displaying fee estimates
+	/// to users before they confirm a transaction.
+	///
+	/// The calculation respects any on-chain reserve requirements and validates that sufficient
+	/// funds are available, just like [`send_to_address`].
+	///
+	/// # Arguments
+	///
+	/// * `address` - The Bitcoin address to send to
+	/// * `amount_sats` - The amount to send in satoshis
+	/// * `fee_rate` - Optional fee rate to use (if None, will estimate based on current network conditions)
+	/// * `utxos_to_spend` - Optional list of specific UTXOs to use for the transaction
+	///
+	/// # Returns
+	///
+	/// The total fee in satoshis that would be paid for this transaction.
+	///
+	/// # Errors
+	///
+	/// * [`Error::NotRunning`] - If the node is not running
+	/// * [`Error::InvalidAddress`] - If the address is invalid
+	/// * [`Error::InsufficientFunds`] - If there are insufficient funds for the payment
+	/// * [`Error::WalletOperationFailed`] - If fee calculation fails
+	///
+	/// [`send_to_address`]: Self::send_to_address
+	pub fn calculate_total_fee(
+		&self, address: &bitcoin::Address, amount_sats: u64, fee_rate: Option<FeeRate>,
+		utxos_to_spend: Option<Vec<SpendableUtxo>>,
+	) -> Result<u64, Error> {
+		let rt_lock = self.runtime.read().unwrap();
+		if rt_lock.is_none() {
+			return Err(Error::NotRunning);
+		}
+
+		let cur_anchor_reserve_sats =
+			crate::total_anchor_channels_reserve_sats(&self.channel_manager, &self.config);
+		let send_amount =
+			OnchainSendAmount::ExactRetainingReserve { amount_sats, cur_anchor_reserve_sats };
+		let outpoints = utxos_to_spend.map(|utxos| utxos.into_iter().map(|u| u.outpoint).collect());
+		let fee_rate_opt = maybe_map_fee_rate_opt!(fee_rate);
+
+		self.wallet.calculate_transaction_fee(
+			address,
+			send_amount,
+			fee_rate_opt,
+			outpoints,
+			&self.channel_manager,
+		)
+	}
+
 	/// Send an on-chain payment to the given address.
 	///
 	/// This will respect any on-chain reserve we need to keep, i.e., won't allow to cut into
@@ -325,7 +378,9 @@ impl OnchainPayment {
 	/// * [`Error::TransactionNotFound`] - If the parent transaction can't be found
 	/// * [`Error::TransactionAlreadyConfirmed`] - If the parent transaction is already confirmed
 	/// * [`Error::WalletOperationFailed`] - If fee calculation fails
-	pub fn calculate_cpfp_fee_rate(&self, parent_txid: &Txid, urgent: bool) -> Result<FeeRate, Error> {
+	pub fn calculate_cpfp_fee_rate(
+		&self, parent_txid: &Txid, urgent: bool,
+	) -> Result<FeeRate, Error> {
 		let rt_lock = self.runtime.read().unwrap();
 		if rt_lock.is_none() {
 			return Err(Error::NotRunning);
diff --git a/src/wallet/mod.rs b/src/wallet/mod.rs
