refactor: use Txid taking into account bitcoin endiness, #6250

Author: fdefelici

stacks-node/src/burnchains/rpc/bitcoin_rpc_client/mod.rs

@@ -283,6 +283,21 @@ impl<'de> Deserialize<'de> for GenerateToAddressResponse {
     }
 }
 
+/// Response mainly used as deserialization wrapper for [`Txid`]
+struct TxidWrapperResponse(pub Txid);
+
+/// Deserializes a JSON string (hex-encoded, big-endian) into [`Txid`] and wrap it into [`TxidWrapperResponse`]
+impl<'de> Deserialize<'de> for TxidWrapperResponse {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let hex_str: String = Deserialize::deserialize(deserializer)?;
+        let txid = Txid::from_bitcoin_hex(&hex_str).map_err(serde::de::Error::custom)?;
+        Ok(TxidWrapperResponse(txid))
+    }
+}
+
 /// Client for interacting with a Bitcoin RPC service.
 #[derive(Debug)]
 pub struct BitcoinRpcClient {
@@ -526,19 +541,21 @@ impl BitcoinRpcClient {
     /// hex-encoded transaction, and other metadata for a transaction tracked by the wallet.
     ///
     /// # Arguments
-    /// * `txid` - The transaction ID (as [`Txid`]) to query.
+    /// * `txid` - The transaction ID (as [`Txid`]) to query,
+    ///            which is intended to be created with [`Txid::from_bitcoin_hex`],
+    ///            or an analogous process.
     ///
     /// # Returns
     /// A [`GetTransactionResponse`] containing detailed metadata for the specified transaction.
     ///
     /// # Availability
     /// - **Since**: Bitcoin Core **v0.10.0**.
     pub fn get_transaction(&self, txid: &Txid) -> BitcoinRpcClientResult<GetTransactionResponse> {
-        Ok(self.wallet_ep.send(
-            &self.client_id,
-            "gettransaction",
-            vec![txid.to_string().into()],
-        )?)
+        let btc_txid = txid.to_bitcoin_hex();
+
+        Ok(self
+            .wallet_ep
+            .send(&self.client_id, "gettransaction", vec![btc_txid.into()])?)
     }
 
     /// Broadcasts a raw transaction to the Bitcoin network.
@@ -557,7 +574,7 @@ impl BitcoinRpcClient {
     ///     - If `None`, defaults to `0`, meaning burning is not allowed.
     ///
     /// # Returns
-    /// A [`Txid`] as a transaction ID.
+    /// A [`Txid`] as a transaction ID (storing internally bytes in **little-endian** order)
     ///
     /// # Availability
     /// - **Since**: Bitcoin Core **v0.7.0**.
@@ -572,11 +589,12 @@ impl BitcoinRpcClient {
         let max_fee_rate = max_fee_rate.unwrap_or(0.10);
         let max_burn_amount = max_burn_amount.unwrap_or(0);
 
-        Ok(self.global_ep.send(
+        let response = self.global_ep.send::<TxidWrapperResponse>(
             &self.client_id,
             "sendrawtransaction",
             vec![tx_hex.into(), max_fee_rate.into(), max_burn_amount.into()],
-        )?)
+        )?;
+        Ok(response.0)
     }
 
     /// Returns information about a descriptor, including its checksum.

stacks-node/src/burnchains/rpc/bitcoin_rpc_client/test_utils.rs

@@ -25,7 +25,9 @@ use stacks::types::Address;
 use stacks_common::deps_common::bitcoin::blockdata::transaction::Transaction;
 use stacks_common::deps_common::bitcoin::network::serialize::deserialize_hex;
 
-use crate::burnchains::rpc::bitcoin_rpc_client::{BitcoinRpcClient, BitcoinRpcClientResult};
+use crate::burnchains::rpc::bitcoin_rpc_client::{
+    BitcoinRpcClient, BitcoinRpcClientResult, TxidWrapperResponse,
+};
 
 /// Represents the response returned by the `getblockchaininfo` RPC call.
 ///
@@ -138,21 +140,6 @@ impl<'de> Deserialize<'de> for GetNewAddressResponse {
     }
 }
 
-/// Response for `sendtoaddress` rpc, mainly used as deserialization wrapper for `Txid`
-struct SendToAddressResponse(pub Txid);
-
-/// Deserializes a JSON string into [`Txid`] and wrap it into [`SendToAddressResponse`]
-impl<'de> Deserialize<'de> for SendToAddressResponse {
-    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
-    where
-        D: Deserializer<'de>,
-    {
-        let hex_str: String = Deserialize::deserialize(deserializer)?;
-        let txid = Txid::from_hex(&hex_str).map_err(serde::de::Error::custom)?;
-        Ok(SendToAddressResponse(txid))
-    }
-}
-
 impl BitcoinRpcClient {
     /// Retrieve general information about the current state of the blockchain.
     ///
@@ -170,18 +157,21 @@ impl BitcoinRpcClient {
     /// Retrieves and deserializes a raw Bitcoin transaction by its ID.
     ///
     /// # Arguments
-    /// * `txid` - Transaction ID to fetch.
+    /// * `txid` - Transaction ID to fetch, which is intended to be created with [`Txid::from_bitcoin_hex`],
+    ///            or an analogous process.
     ///
     /// # Returns
     /// A [`Transaction`] struct representing the decoded transaction.
     ///
     /// # Availability
     /// - **Since**: Bitcoin Core **v0.7.0**.
     pub fn get_raw_transaction(&self, txid: &Txid) -> BitcoinRpcClientResult<Transaction> {
+        let btc_txid = txid.to_bitcoin_hex();
+
         let raw_hex = self.global_ep.send::<String>(
             &self.client_id,
             "getrawtransaction",
-            vec![txid.to_string().into()],
+            vec![btc_txid.to_string().into()],
         )?;
         Ok(deserialize_hex(&raw_hex)?)
     }
@@ -273,7 +263,7 @@ impl BitcoinRpcClient {
     /// * `amount` - Amount to send in BTC (not in satoshis).
     ///
     /// # Returns
-    /// A [`Txid`] struct representing the transaction ID
+    /// A [`Txid`] struct representing the transaction ID (storing internally bytes in **little-endian** order)
     ///
     /// # Availability
     /// - **Since**: Bitcoin Core **v0.1.0**.
@@ -282,7 +272,7 @@ impl BitcoinRpcClient {
         address: &BitcoinAddress,
         amount: f64,
     ) -> BitcoinRpcClientResult<Txid> {
-        let response = self.wallet_ep.send::<SendToAddressResponse>(
+        let response = self.wallet_ep.send::<TxidWrapperResponse>(
             &self.client_id,
             "sendtoaddress",
             vec![address.to_string().into(), amount.into()],

stacks-node/src/burnchains/rpc/bitcoin_rpc_client/tests.rs

@@ -467,7 +467,7 @@ fn test_get_transaction_ok() {
 
     let client = utils::setup_client(&server);
 
-    let txid = Txid::from_hex(&txid_hex).unwrap();
+    let txid = Txid::from_bitcoin_hex(&txid_hex).unwrap();
     let info = client.get_transaction(&txid).expect("Should be ok!");
     assert_eq!(6, info.confirmations);
 }
@@ -501,7 +501,7 @@ fn test_get_raw_transaction_ok() {
 
     let client = utils::setup_client(&server);
 
-    let txid = Txid::from_hex(txid_hex).unwrap();
+    let txid = Txid::from_bitcoin_hex(txid_hex).unwrap();
     let raw_tx = client.get_raw_transaction(&txid).expect("Should be ok!");
     assert_eq!(txid_hex, raw_tx.txid().to_string());
     assert_eq!(expected_tx_hex, serialize_hex(&raw_tx).unwrap());
@@ -623,7 +623,7 @@ fn test_send_raw_transaction_ok_with_defaults() {
     let txid = client
         .send_raw_transaction(&raw_tx, None, None)
         .expect("Should work!");
-    assert_eq!(expected_txid, txid.to_hex());
+    assert_eq!(expected_txid, txid.to_bitcoin_hex());
 }
 
 #[test]
@@ -659,7 +659,7 @@ fn test_send_raw_transaction_ok_with_custom_params() {
     let txid = client
         .send_raw_transaction(&raw_tx, Some(0.0), Some(5_000))
         .expect("Should work!");
-    assert_eq!(expected_txid, txid.to_hex());
+    assert_eq!(expected_txid, txid.to_bitcoin_hex());
 }
 
 #[test]
@@ -880,7 +880,7 @@ fn test_send_to_address_ok() {
     let txid = client
         .send_to_address(&address, amount)
         .expect("Should be ok!");
-    assert_eq!(expected_txid_str, txid.to_hex());
+    assert_eq!(expected_txid_str, txid.to_bitcoin_hex());
 }
 
 #[test]

stacks-node/src/tests/bitcoin_rpc_integrations.rs

@@ -430,7 +430,7 @@ fn test_get_raw_transaction_ok() {
         .get_raw_transaction(&txid)
         .expect("get raw transaction ok!");
 
-    assert_eq!(txid.to_string(), raw_tx.txid().to_string());
+    assert_eq!(txid.to_bitcoin_hex(), raw_tx.txid().to_string());
 }
 
 #[ignore]