fix(client)!: use Amount and FeeRate instead of f64 for submit_package

Author: luisschwab

src/async.rs

@@ -42,9 +42,9 @@ use bitcoin::{Address, Block, BlockHash, FeeRate, MerkleBlock, Script, Transacti
 use reqwest::{header, Body, Client, Response};
 
 use crate::{
-    sat_per_vbyte_to_feerate, AddressStats, BlockInfo, BlockStatus, Builder, Error, EsploraTx,
-    MempoolRecentTx, MempoolStats, MerkleProof, OutputStatus, ScriptHashStats, SubmitPackageResult,
-    TxStatus, Utxo, BASE_BACKOFF_MILLIS, RETRYABLE_ERROR_CODES,
+    sat_per_vbyte_to_feerate, AddressStats, Amount, BlockInfo, BlockStatus, Builder, Error,
+    EsploraTx, MempoolRecentTx, MempoolStats, MerkleProof, OutputStatus, ScriptHashStats,
+    SubmitPackageResult, TxStatus, Utxo, BASE_BACKOFF_MILLIS, RETRYABLE_ERROR_CODES,
 };
 
 /// Returns `true` if the given HTTP status code should trigger a retry.
@@ -383,29 +383,33 @@ impl<S: Sleeper> AsyncClient<S> {
     /// Returns a [`SubmitPackageResult`] containing the result for each
     /// transaction in the package, keyed by [`Wtxid`](bitcoin::Wtxid).
     ///
-    /// Optionally, `maxfeerate` (in sat/vB) and `maxburnamount` (in BTC) can
-    /// be provided to reject transactions that exceed these thresholds.
+    /// Optionally, `maxfeerate` (as a [`FeeRate`]) and `maxburnamount`
+    /// (as an [`Amount`]) can be provided to reject transactions that
+    /// exceed these thresholds.
     ///
     /// # Errors
     ///
     /// Returns an [`Error`] if the request fails or the server rejects the package.
     pub async fn submit_package(
         &self,
         transactions: &[Transaction],
-        maxfeerate: Option<f64>,
-        maxburnamount: Option<f64>,
+        maxfeerate: Option<FeeRate>,
+        maxburnamount: Option<Amount>,
     ) -> Result<SubmitPackageResult, Error> {
         let serialized_txs = transactions
             .iter()
             .map(|tx| serialize_hex(&tx))
             .collect::<Vec<_>>();
 
         let mut queryparams = HashSet::<(&str, String)>::new();
+
+        // Esplora expects `maxfeerate` in sats/vB.
         if let Some(maxfeerate) = maxfeerate {
-            queryparams.insert(("maxfeerate", maxfeerate.to_string()));
+            queryparams.insert(("maxfeerate", maxfeerate.to_sat_per_vb_ceil().to_string()));
         }
+        // Esplora expects `maxburnamount` in BTC.
         if let Some(maxburnamount) = maxburnamount {
-            queryparams.insert(("maxburnamount", maxburnamount.to_string()));
+            queryparams.insert(("maxburnamount", maxburnamount.to_btc().to_string()));
         }
 
         let response = self

src/blocking.rs

@@ -36,7 +36,7 @@ use bitcoin::consensus::encode::serialize_hex;
 use bitcoin::consensus::{deserialize, serialize, Decodable};
 use bitcoin::hashes::{sha256, Hash};
 use bitcoin::hex::{DisplayHex, FromHex};
-use bitcoin::{Address, Block, BlockHash, FeeRate, MerkleBlock, Script, Transaction, Txid};
+use bitcoin::{Address, Amount, Block, BlockHash, FeeRate, MerkleBlock, Script, Transaction, Txid};
 
 use crate::{
     sat_per_vbyte_to_feerate, AddressStats, BlockInfo, BlockStatus, Builder, Error, EsploraTx,
@@ -383,17 +383,18 @@ impl BlockingClient {
     /// Returns a [`SubmitPackageResult`] containing the result for each
     /// transaction in the package, keyed by [`Wtxid`](bitcoin::Wtxid).
     ///
-    /// Optionally, `maxfeerate` (in sat/vB) and `maxburnamount` (in BTC) can
-    /// be provided to reject transactions that exceed these thresholds.
+    /// Optionally, `maxfeerate` (as a [`FeeRate`]) and `maxburnamount`
+    /// (as an [`Amount`]) can be provided to reject transactions that
+    /// exceed these thresholds.
     ///
     /// # Errors
     ///
     /// Returns an [`Error`] if the request fails or the server rejects the package.
     pub fn submit_package(
         &self,
         transactions: &[Transaction],
-        maxfeerate: Option<f64>,
-        maxburnamount: Option<f64>,
+        maxfeerate: Option<FeeRate>,
+        maxburnamount: Option<Amount>,
     ) -> Result<SubmitPackageResult, Error> {
         let serialized_txs = transactions
             .iter()
@@ -407,12 +408,14 @@ impl BlockingClient {
                 .into_bytes(),
         )?;
 
+        // Esplora expects `maxfeerate` in sats/vB.
         if let Some(maxfeerate) = maxfeerate {
-            request = request.with_param("maxfeerate", maxfeerate.to_string())
+            request = request.with_param("maxfeerate", maxfeerate.to_sat_per_vb_ceil().to_string())
         }
 
+        // Esplora expects `maxburnamount` in BTC.
         if let Some(maxburnamount) = maxburnamount {
-            request = request.with_param("maxburnamount", maxburnamount.to_string())
+            request = request.with_param("maxburnamount", maxburnamount.to_btc().to_string())
         }
 
         match request.send() {