chore(api)!: use Amount for all value/fee fields

Author: luisschwab

src/api.rs

@@ -50,7 +50,8 @@ pub struct Vin {
 #[derive(Deserialize, Clone, Debug, PartialEq, Eq)]
 pub struct Vout {
     /// The value of the output, in satoshis.
-    pub value: u64,
+    #[serde(with = "bitcoin::amount::serde::as_sat")]
+    pub value: Amount,
     /// The ScriptPubKey that the output is locked to, as a [`ScriptBuf`].
     pub scriptpubkey: ScriptBuf,
 }
@@ -129,7 +130,8 @@ pub struct Tx {
     /// The confirmation status of the [`Transaction`].
     pub status: TxStatus,
     /// The fee amount paid by the [`Transaction`], in satoshis.
-    pub fee: u64,
+    #[serde(with = "bitcoin::amount::serde::as_sat")]
+    pub fee: Amount,
 }
 
 /// Information about a bitcoin [`Block`].
@@ -211,11 +213,13 @@ pub struct AddressTxsSummary {
     /// The number of funded [`TxOut`]s.
     pub funded_txo_count: u32,
     /// The sum of the funded [`TxOut`]s, in satoshis.
-    pub funded_txo_sum: u64,
+    #[serde(with = "bitcoin::amount::serde::as_sat")]
+    pub funded_txo_sum: Amount,
     /// The number of spent [`TxOut`]s.
     pub spent_txo_count: u32,
     /// The sum of the spent [`TxOut`]s, in satoshis.
-    pub spent_txo_sum: u64,
+    #[serde(with = "bitcoin::amount::serde::as_sat")]
+    pub spent_txo_sum: Amount,
     /// The total number of [`Transaction`]s.
     pub tx_count: u32,
 }
@@ -256,6 +260,7 @@ pub struct Utxo {
     /// The confirmation status of the [`TxOut`].
     pub status: UtxoStatus,
     /// The value of the [`TxOut`] as an [`Amount`].
+    #[serde(with = "bitcoin::amount::serde::as_sat")]
     pub value: Amount,
 }
 
@@ -267,7 +272,8 @@ pub struct MempoolStats {
     /// The total size of mempool [`Transaction`]s, in virtual bytes.
     pub vsize: usize,
     /// The total fee paid by mempool [`Transaction`]s, in satoshis.
-    pub total_fee: u64,
+    #[serde(with = "bitcoin::amount::serde::as_sat")]
+    pub total_fee: Amount,
     /// The mempool's fee rate distribution histogram.
     ///
     /// An array of `(feerate, vsize)` tuples, where each entry's `vsize` is the total vsize
@@ -282,11 +288,13 @@ pub struct MempoolRecentTx {
     /// The [`Transaction`]'s ID, as a [`Txid`].
     pub txid: Txid,
     /// The [`Amount`] of fees paid by the transaction, in satoshis.
-    pub fee: u64,
+    #[serde(with = "bitcoin::amount::serde::as_sat")]
+    pub fee: Amount,
     /// The [`Transaction`]'s size, in virtual bytes.
     pub vsize: usize,
     /// Combined [`Amount`] of the [`Transaction`], in satoshis.
-    pub value: u64,
+    #[serde(with = "bitcoin::amount::serde::as_sat")]
+    pub value: Amount,
 }
 
 /// The result for a broadcasted package of [`Transaction`]s.
@@ -370,7 +378,7 @@ impl Tx {
                 .iter()
                 .cloned()
                 .map(|vout| TxOut {
-                    value: Amount::from_sat(vout.value),
+                    value: vout.value,
                     script_pubkey: vout.scriptpubkey,
                 })
                 .collect(),
@@ -398,7 +406,7 @@ impl Tx {
             .map(|vin| {
                 vin.prevout.map(|po| TxOut {
                     script_pubkey: po.scriptpubkey,
-                    value: Amount::from_sat(po.value),
+                    value: po.value,
                 })
             })
             .collect()
@@ -408,11 +416,6 @@ impl Tx {
     pub fn weight(&self) -> Weight {
         Weight::from_wu(self.weight)
     }
-
-    /// Get the fee paid by a [`Tx`].
-    pub fn fee(&self) -> Amount {
-        Amount::from_sat(self.fee)
-    }
 }
 
 fn deserialize_witness<'de, D>(d: D) -> Result<Vec<Vec<u8>>, D::Error>

src/lib.rs

@@ -575,7 +575,7 @@ mod test {
         assert_eq!(tx_info.to_tx(), tx_exp);
         assert_eq!(tx_info.size, tx_exp.total_size());
         assert_eq!(tx_info.weight(), tx_exp.weight());
-        assert_eq!(tx_info.fee(), tx_res.fee.unwrap().unsigned_abs());
+        assert_eq!(tx_info.fee, tx_res.fee.unwrap().unsigned_abs());
         assert!(tx_info.status.confirmed);
         assert_eq!(tx_info.status.block_height, Some(tx_block_height));
         assert_eq!(tx_info.status.block_hash, tx_res.block_hash);
@@ -1092,7 +1092,10 @@ mod test {
         let address_stats_async = async_client.get_address_stats(&address).await.unwrap();
         assert_eq!(address_stats_blocking, address_stats_async);
         assert_eq!(address_stats_async.chain_stats.funded_txo_count, 1);
-        assert_eq!(address_stats_async.chain_stats.funded_txo_sum, 1000);
+        assert_eq!(
+            address_stats_async.chain_stats.funded_txo_sum,
+            Amount::from_sat(1000)
+        );
     }
 
     #[cfg(all(feature = "blocking", feature = "async"))]
@@ -1167,7 +1170,7 @@ mod test {
         );
         assert_eq!(
             scripthash_stats_blocking_legacy.chain_stats.funded_txo_sum,
-            1000
+            Amount::from_sat(1000)
         );
         assert_eq!(scripthash_stats_blocking_legacy.chain_stats.tx_count, 1);
 
@@ -1187,7 +1190,7 @@ mod test {
             scripthash_stats_blocking_p2sh_segwit
                 .chain_stats
                 .funded_txo_sum,
-            1000
+            Amount::from_sat(1000)
         );
         assert_eq!(
             scripthash_stats_blocking_p2sh_segwit.chain_stats.tx_count,
@@ -1208,7 +1211,7 @@ mod test {
         );
         assert_eq!(
             scripthash_stats_blocking_bech32.chain_stats.funded_txo_sum,
-            1000
+            Amount::from_sat(1000)
         );
         assert_eq!(scripthash_stats_blocking_bech32.chain_stats.tx_count, 1);
 
@@ -1226,7 +1229,7 @@ mod test {
         );
         assert_eq!(
             scripthash_stats_blocking_bech32m.chain_stats.funded_txo_sum,
-            1000
+            Amount::from_sat(1000)
         );
         assert_eq!(scripthash_stats_blocking_bech32m.chain_stats.tx_count, 1);
     }