added witness removal to txid calculation; (#168)

separated txid and wtxid calculations

Author: aritkulova

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [patch]
+
+- Separated txid and wtxid calculations in `TxParser` library.
+
 ## [3.2.4]
 
 - Added `ARecoverableAccount` contract, an all-in-one EIP-7702/ERC-4337 account with ERC-7821 batching, ERC-4337 gas sponsorship, and ERC-7947 recovery.

contracts/libs/bitcoin/TxParser.sol

@@ -44,6 +44,15 @@ library TxParser {
      * @return The transaction ID
      */
     function calculateTxId(bytes calldata data_) internal pure returns (bytes32) {
+        return _doubleSHA256(_removeWitness(data_));
+    }
+
+    /**
+     * @notice Calculate witness transaction ID (hash with witness data)
+     * @param data_ The raw transaction data
+     * @return The witness transaction ID
+     */
+    function calculateWTxId(bytes calldata data_) internal pure returns (bytes32) {
         return _doubleSHA256(data_);
     }
 
@@ -157,7 +166,7 @@ library TxParser {
      * @return The formatted transaction bytes
      */
     function formatTransaction(
-        Transaction calldata tx_,
+        Transaction memory tx_,
         bool withWitness_
     ) internal pure returns (bytes memory) {
         bool includeWitness_ = withWitness_ && tx_.hasWitness;
@@ -439,7 +448,7 @@ library TxParser {
      * @notice Format a transaction input into raw bytes
      */
     function _formatTransactionInput(
-        TransactionInput calldata input_
+        TransactionInput memory input_
     ) private pure returns (bytes memory) {
         bytes memory prevHash_ = abi.encodePacked((input_.previousHash).bytes32BEtoLE());
         bytes memory previousIndex_ = abi.encodePacked(input_.previousIndex.uint32BEtoLE());
@@ -459,14 +468,30 @@ library TxParser {
      * @notice Format a transaction output into raw bytes
      */
     function _formatTransactionOutput(
-        TransactionOutput calldata output_
+        TransactionOutput memory output_
     ) private pure returns (bytes memory) {
         bytes memory value_ = abi.encodePacked(output_.value.uint64BEtoLE());
 
         return
             abi.encodePacked(value_, formatCuint(uint64(output_.script.length)), output_.script);
     }
 
+    /**
+     * @notice Remove witness from a raw transaction
+     */
+    function _removeWitness(bytes calldata data_) private pure returns (bytes memory) {
+        (TxParser.Transaction memory tx_, ) = parseTransaction(data_);
+
+        if (tx_.hasWitness) {
+            return formatTransaction(tx_, false);
+        }
+
+        return data_;
+    }
+
+    /**
+     * @notice Parse a compact unsigned integer (Bitcoin's variable length encoding)
+     */
     function _parseCuint(
         bytes memory data_,
         uint256 offset_

contracts/mock/libs/bitcoin/TxParserMock.sol

@@ -10,6 +10,10 @@ contract TxParserMock {
         return data_.calculateTxId();
     }
 
+    function calculateWTxId(bytes calldata data_) external pure returns (bytes32) {
+        return data_.calculateWTxId();
+    }
+
     function parseBTCTransaction(
         bytes calldata txBytes_
     ) external pure returns (TxParser.Transaction memory tx_) {

test/libs/bitcoin/TxParser.test.ts

@@ -44,13 +44,27 @@ describe("Transaction Parser", () => {
 
   describe("#calculateTxId", () => {
     it("should calculate correctly", async () => {
-      const rawTx =
+      const rawTxWithoutWitness =
         "0x01000000013652ebc8c4efec4015c4c2e6f7f693bf5307bcc68f59510957e302b89208eb0c060000006a47304402202955e3df921fa6893b898db5117ec92441757d90b485ed3015d427a1aa7631a6022063859ae9fb657b3ceb28c1771076da62e967b3872db6599a08ac982f62ef67810121037a35df3a9314039a2361bd37df3ee846c7a259a7c83f522704517bb7e8748f1effffffff0138ed000000000000160014b9edb07641abc03085f3971e48c6cafbdc854baf00000000";
 
-      const expectedTxid = reverseBytes("0x16a7875987d0be57af2283de4c38f0f4b1ad9c65b936cbc36e101665d8dff891");
-      const txid = await parser.calculateTxId(rawTx);
+      let expectedTxid = reverseBytes("0x16a7875987d0be57af2283de4c38f0f4b1ad9c65b936cbc36e101665d8dff891");
+      let txid = await parser.calculateTxId(rawTxWithoutWitness);
+      let wtxid = await parser.calculateWTxId(rawTxWithoutWitness);
 
       expect(txid).to.be.eq(expectedTxid);
+      expect(wtxid).to.be.eq(expectedTxid);
+
+      const rawTxWithWitness =
+        "0x02000000000101bb9bf2f5ad81afc67adacddcdb8c23aa357a7f471a6e3902a48d16b7fb69681b0000000000ffffffff02a896010000000000160014d9f6bfe50ad0a73647031d933e05fab69b3752b9dfec1c0000000000160014b9ab9ccd954d138c3f3aae3ec91070f4c9dd966f040047304402203e6e965c7bbced9bcd286c7ce37a27de012d3d9dc691ad4c77fff48191ae4bbe022077a0c132f28c4d2d691654acd28a3035fa8e7a737007ebcd67056e50727a1c0801473044022058daa76ae784f860aae0433fe9926831643284840fb6774f43ad72ee11c6aadb0220331c74132820b15fac6ff2a88789a3325cee83d68ccdec9b38dea2a8b5462eaf01475221024c48ca1fb71fac84400643b0e921ece39abdeea5026d9e01d8281bad9cddfaf92103674b3be7da8a4fdb363fd471a6bf507c38f39962322370ce7338c0719d06df7252ae00000000";
+
+      expectedTxid = reverseBytes("a3b23982331300ef8d23bd90b64e939758835515642a65ba64234bf2cae2ac7a");
+      const expectedWTxid = reverseBytes("72d691c88f88df22874bd380d2b46040ff632ab076c4db14441e5f7c1b82c542");
+
+      txid = await parser.calculateTxId(rawTxWithWitness);
+      wtxid = await parser.calculateWTxId(rawTxWithWitness);
+
+      expect(txid).to.be.eq(expectedTxid);
+      expect(wtxid).to.be.eq(expectedWTxid);
     });
   });