Add CPFP feerate tests for same and higher target feerates

aagbotemi · aagbotemi · commit eff1ec65b81c · 2025-11-11T01:02:04.000+01:00
diff --git a/examples/common.rs b/examples/common.rs
@@ -9,9 +9,12 @@ use bdk_chain::{
 use bdk_coin_select::DrainWeights;
 use bdk_testenv::{bitcoincore_rpc::RpcApi, TestEnv};
 use bdk_tx::{
-    CanonicalUnspents, CpfpParams, Input, InputCandidates, RbfParams, ScriptSource, Selection, TxStatus, TxWithStatus
+    CanonicalUnspents, CpfpParams, Input, InputCandidates, RbfParams, ScriptSource, Selection,
+    TxStatus, TxWithStatus,
+};
+use bitcoin::{
+    absolute, Address, Amount, BlockHash, FeeRate, OutPoint, Transaction, TxOut, Txid, Weight,
 };
-use bitcoin::{absolute, Address, Amount, BlockHash, FeeRate, OutPoint, Transaction, Txid, Weight};
 use miniscript::{
     plan::{Assets, Plan},
     Descriptor, DescriptorPublicKey, ForEachKey,
@@ -270,13 +273,14 @@ impl Wallet {
             .script_pubkey();
         let output_script = ScriptSource::from_script(script_pubkey);
 
-        let cpfp_params = CpfpParams::new(
+        let cpfp_params = CpfpParams {
             package_fee,
             package_weight,
             inputs,
+            // inputs: inputs.into_iter().map(Into::into).collect(),
             target_package_feerate,
             output_script,
-        );
+        };
 
         let selection = cpfp_params.into_selection()?;
         Ok(selection)
diff --git a/examples/cpfp.rs b/examples/cpfp.rs
@@ -3,7 +3,7 @@
 use bdk_testenv::{bitcoincore_rpc::RpcApi, TestEnv};
 use bdk_tx::{
     filter_unspendable_now, group_by_spk, selection_algorithm_lowest_fee_bnb, ChangePolicyType,
-    Output, PsbtParams, SelectorParams, Signer,
+    Output, PsbtParams, ScriptSource, SelectorParams, Signer,
 };
 use bitcoin::{absolute::LockTime, key::Secp256k1, Amount, FeeRate, Sequence, Transaction};
 use miniscript::Descriptor;
@@ -53,10 +53,11 @@ fn main() -> anyhow::Result<()> {
                         addr.script_pubkey(),
                         Amount::from_sat(49_000_000),
                     )],
-                    internal.at_derivation_index(i)?,
+                    ScriptSource::Descriptor(Box::new(internal.at_derivation_index(i)?)),
                     ChangePolicyType::NoDustAndLeastWaste {
                         longterm_feerate: FeeRate::from_sat_per_vb_unchecked(1),
                     },
+                    wallet.change_weight(),
                 ),
             )?;
         let mut parent_psbt = low_fee_selection.create_psbt(PsbtParams {
diff --git a/src/cpfp.rs b/src/cpfp.rs
@@ -1,6 +1,6 @@
-use crate::{cs_feerate, Input, Output, ScriptSource, Selection};
-use alloc::vec::Vec;
-use bdk_coin_select::{Candidate, CoinSelector, Target, TargetFee, TargetOutputs};
+use crate::{Input, Output, ScriptSource, Selection};
+use alloc::{vec, vec::Vec};
+use bdk_coin_select::{Candidate, CoinSelector, DrainWeights, TargetOutputs};
 use miniscript::bitcoin::{Amount, FeeRate, TxOut, Weight};
 
 /// Parameters for creating a Child-Pays-For-Parent (CPFP) transaction.
@@ -30,33 +30,12 @@ pub struct CpfpParams {
 }
 
 impl CpfpParams {
-    /// Create a new [CpfpParams] instance.
-    pub fn new(
-        package_fee: Amount,
-        package_weight: Weight,
-        inputs: impl IntoIterator<Item = impl Into<Input>>,
-        target_package_feerate: FeeRate,
-        output_script: crate::ScriptSource,
-    ) -> Self {
-        Self {
-            package_fee,
-            package_weight,
-            inputs: inputs.into_iter().map(Into::into).collect(),
-            target_package_feerate,
-            output_script,
-        }
-    }
-
     /// Convert the CPFP parameters into selection.
     ///
     /// This method calculates the required child transaction fee to achieve the
     /// target package feerate and creates a selection with the appropriate inputs
     /// and outputs.
     pub fn into_selection(self) -> Result<Selection, CpfpError> {
-        if self.inputs.is_empty() {
-            return Err(CpfpError::NoSpendableOutputs);
-        }
-
         // Create candidates for coin selection
         let candidates = self
             .inputs
@@ -74,49 +53,30 @@ impl CpfpParams {
         let mut selector = CoinSelector::new(&candidates);
         selector.select_all();
 
+        let total_input_value = Amount::from_sat(selector.selected_value());
+
         // Prepare output to calculate weight
         let script_pubkey = self.output_script.script();
         let output = TxOut {
             value: Amount::ZERO,
             script_pubkey: script_pubkey.clone(),
         };
-        let output_weight = output.weight().to_wu();
-
-        // Calculate required child fee
-        let child_weight = self.compute_child_tx_weight(&selector, output_weight);
-        let child_fee = self.compute_child_fee(child_weight)?;
-
-        let total_input_value = Amount::from_sat(selector.selected_value());
-
-        let output_value = total_input_value
-            .checked_sub(child_fee)
-            .ok_or(CpfpError::InsufficientInputValue)?;
 
-        let dust_threshold = script_pubkey.minimal_non_dust();
-        if output_value < dust_threshold {
-            return Err(CpfpError::OutputBelowDustLimit);
-        }
-
-        // Validate we achieve the target package feerate
-        let actual_package_feerate = self.compute_package_feerate(child_fee, child_weight);
-        if actual_package_feerate < self.target_package_feerate {
-            return Err(CpfpError::InsufficientPackageFeerate {
-                actual: actual_package_feerate,
-                target: self.target_package_feerate,
-            });
-        }
+        let target_outputs = TargetOutputs::fund_outputs(vec![(output.weight().to_wu(), 0)]);
+        let cpfp_tx_weight = Weight::from_wu(selector.weight(target_outputs, DrainWeights::NONE));
 
-        // Verify the selection meets coin selection constraints
-        let target = Target {
-            fee: TargetFee {
-                rate: cs_feerate(self.target_package_feerate),
-                replace: None,
-            },
-            outputs: TargetOutputs::fund_outputs(vec![(output_weight, output_value.to_sat())]),
+        // Calculate required child fee
+        let total_package_weight = self.package_weight + cpfp_tx_weight;
+        let required_total_package_fee = self.target_package_feerate * total_package_weight;
+        let required_child_fee = required_total_package_fee - self.package_fee;
+
+        let output_value = match total_input_value.checked_sub(required_child_fee) {
+            Some(value) => value,
+            None => {
+                let missing = required_child_fee - total_input_value;
+                return Err(CpfpError::InsufficientInputValue { missing });
+            }
         };
-        if !selector.is_target_met(target) {
-            return Err(CpfpError::InsufficientInputValue);
-        }
 
         let outputs = vec![Output::with_script(script_pubkey, output_value)];
 
@@ -125,76 +85,28 @@ impl CpfpParams {
             outputs,
         })
     }
-
-    /// Computes the effective package feerate given the child fee and weight.
-    pub fn compute_package_feerate(&self, child_fee: Amount, child_weight: Weight) -> FeeRate {
-        let total_fee = self.package_fee + child_fee;
-        let total_weight = self.package_weight + child_weight;
-
-        total_fee / total_weight
-    }
-
-    /// Computes the required child fee to achieve target package feerate
-    pub fn compute_child_fee(&self, child_weight: Weight) -> Result<Amount, CpfpError> {
-        let total_target_weight = self.package_weight + child_weight;
-        let required_package_fee = self.target_package_feerate * total_target_weight;
-
-        required_package_fee
-            .checked_sub(self.package_fee)
-            .ok_or(CpfpError::InvalidFeeCalculation)
-    }
-
-    /// Computes the weight of the child transaction.
-    ///
-    /// Uses the provided `selector` for input weights and `output_weight` for the output.
-    fn compute_child_tx_weight(&self, selector: &CoinSelector, output_weight: u64) -> Weight {
-        const BASE_TX_WEIGHT: u64 = 10 * 4; // version, locktime, input/output counts
-        let input_weight = selector.input_weight();
-
-        Weight::from_wu(BASE_TX_WEIGHT + input_weight + output_weight)
-    }
 }
 
 /// CPFP errors.
 #[derive(Debug)]
 pub enum CpfpError {
-    /// Output value is below the dust threshold.
-    OutputBelowDustLimit,
-    /// Total input value is insufficient.
-    InsufficientInputValue,
-    /// No spendable outputs were found.
-    NoSpendableOutputs,
-    /// Failed to compute a valid fee for the child transaction.
-    InvalidFeeCalculation,
-    /// The package feerate (parent + child) is lower than the target feerate.
-    InsufficientPackageFeerate {
-        /// The actual feerate of the package.
-        actual: FeeRate,
-        /// The target feerate that the package should meet or exceed.
-        target: FeeRate,
+    /// Total input value is insufficient to create a valid CPFP transaction.
+    InsufficientInputValue {
+        /// The additional amount needed to create a valid CPFP transaction
+        missing: Amount,
     },
-    /// Output script is invalid
-    InvalidOutputScript,
 }
 
 impl core::fmt::Display for CpfpError {
     fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
         match self {
-            Self::OutputBelowDustLimit => write!(f, "output value is below dust threshold"),
-            Self::InsufficientInputValue => {
-                write!(f, "input value insufficient to cover required fee")
-            }
-            Self::NoSpendableOutputs => {
-                write!(f, "no spendable outputs found in parent transactions")
-            }
-            Self::InvalidFeeCalculation => {
-                write!(f, "failed to calculate valid child transaction fee")
+            Self::InsufficientInputValue { missing } => {
+                write!(
+                    f,
+                    "input value insufficient: need {} more satoshis",
+                    missing.to_sat()
+                )
             }
-            Self::InsufficientPackageFeerate { actual, target } => write!(
-                f,
-                "package feerate {actual} is below target feerate {target}"
-            ),
-            Self::InvalidOutputScript => write!(f, "output script is invalid or empty"),
         }
     }
 }
diff --git a/src/selector.rs b/src/selector.rs
@@ -1,7 +1,7 @@
 use bdk_coin_select::{
     ChangePolicy, DrainWeights, InsufficientFunds, Replace, Target, TargetFee, TargetOutputs,
 };
-use bitcoin::{Amount, FeeRate, Transaction, TxOut, Weight};
+use bitcoin::{Amount, FeeRate, Transaction, Weight};
 use miniscript::bitcoin;
 
 use crate::{cs_feerate, InputCandidates, InputGroup, Output, ScriptSource, Selection};
@@ -251,7 +251,7 @@ impl<'c> Selector<'c> {
             .to_cs_change_policy()
             .map_err(SelectorError::Miniscript)?;
         let target_outputs = params.target_outputs;
-        let change_descriptor = params.change_descriptor;
+        let change_script = params.change_script;
         if target.value() > candidates.groups().map(|grp| grp.value().to_sat()).sum() {
             return Err(SelectorError::CannotMeetTarget(CannotMeetTarget));
         }
diff --git a/tests/cpfp.rs b/tests/cpfp.rs
