mining: add getTransactionsByWitnessID() IPC method

Author: Sjors

src/interfaces/mining.h

@@ -163,6 +163,15 @@ class Mining
      *                    transaction if found, otherwise nullptr
      */
     virtual std::vector<CTransactionRef> getTransactionsByTxID(const std::vector<Txid>& txids) = 0;
+
+    /**
+     * Fetch raw transactions from the mempool by wtxid.
+     *
+     * @param[in] wtxids   witness transaction ids to look up
+     * @returns            one entry per requested wtxid containing the
+     *                     transaction if found, otherwise nullptr
+     */
+    virtual std::vector<CTransactionRef> getTransactionsByWitnessID(const std::vector<Wtxid>& wtxids) = 0;
     //! Get internal node context. Useful for RPC and testing,
     //! but not accessible across processes.
     virtual node::NodeContext* context() { return nullptr; }

src/ipc/capnp/mining.capnp

@@ -26,6 +26,7 @@ interface Mining $Proxy.wrap("interfaces::Mining") {
     checkBlock @5 (context :Proxy.Context, block: Data, options: BlockCheckOptions) -> (reason: Text, debug: Text, result: Bool);
     interrupt @6 () -> ();
     getTransactionsByTxID @7 (context :Proxy.Context, txids: List(Data)) -> (result: List(Data));
+    getTransactionsByWitnessID @8 (context :Proxy.Context, wtxids: List(Data)) -> (result: List(Data));
 }
 
 interface BlockTemplate $Proxy.wrap("interfaces::BlockTemplate") {

src/node/interfaces.cpp

@@ -1026,6 +1026,19 @@ class MinerImpl : public Mining
         return results;
     }
 
+    std::vector<CTransactionRef> getTransactionsByWitnessID(const std::vector<Wtxid>& wtxids) override
+    {
+        if (!m_node.mempool) return {};
+        LOCK(m_node.mempool->cs);
+
+        std::vector<CTransactionRef> results;
+        results.reserve(wtxids.size());
+        for (const auto& wtxid : wtxids) {
+            results.emplace_back(GetTransaction(*m_node.mempool, wtxid));
+        }
+        return results;
+    }
+
     NodeContext* context() override { return &m_node; }
     ChainstateManager& chainman() { return *Assert(m_node.chainman); }
     KernelNotifications& notifications() { return *Assert(m_node.notifications); }

src/test/miner_tests.cpp

@@ -177,6 +177,17 @@ void MinerTestingSetup::TestPackageSelection(const CScript& scriptPubKey, const
     BOOST_CHECK(raw_txs[0]);
     BOOST_CHECK(raw_txs[0]->GetHash() == hashParentTx);
     BOOST_CHECK(!raw_txs[1]);
+    // Test getTransactionsByWitnessID()
+    // tx has no witness, so just cast to Wtxid
+    const std::vector<Wtxid> wtx_id_list{
+        Wtxid::FromUint256(hashParentTx.ToUint256()),
+        Wtxid::FromUint256(uint256::ZERO)
+    };
+    raw_txs = mining->getTransactionsByWitnessID(wtx_id_list);
+    BOOST_REQUIRE_EQUAL(raw_txs.size(), tx_id_list.size());
+    BOOST_CHECK(raw_txs[0]);
+    BOOST_CHECK(raw_txs[0]->GetHash() == hashParentTx);
+    BOOST_CHECK(!raw_txs[1]);
     block_template = mining->createNewBlock(options, /*cooldown=*/false);
     BOOST_REQUIRE(block_template);
     block = block_template->getBlock();

test/functional/interface_ipc_mining.py

@@ -415,7 +415,7 @@ async def async_routine():
         asyncio.run(capnp.run(async_routine()))
 
     def run_transaction_lookup_test(self):
-        """Test getTransactionsByTxID()."""
+        """Test getTransactionsByTxID() and getTransactionsByWitnessID()."""
         self.log.info("Running transaction lookup test")
 
         async def async_routine():
@@ -430,6 +430,13 @@ async def async_routine():
             assert_equal(raw_txs_txid.result[1].hex(), tx2["hex"])
             assert_equal(raw_txs_txid.result[2], b'')
 
+            self.log.debug("getTransactionsByWitnessID() returns mempool txs and nulls")
+            raw_txs_wtxid = await mining.getTransactionsByWitnessID(ctx, [tx1["tx"].wtxid, tx2["tx"].wtxid, bytes(32)])
+            assert_equal(len(raw_txs_wtxid.result), 3)
+            assert_equal(raw_txs_wtxid.result[0].hex(), tx1["hex"])
+            assert_equal(raw_txs_wtxid.result[1].hex(), tx2["hex"])
+            assert_equal(raw_txs_wtxid.result[2], b'')
+
             self.log.debug("getTransactionsByTxID() uses txindex when enabled")
             self.generate(self.nodes[0], 1)
             self.sync_all()

test/functional/test_framework/messages.py

@@ -686,15 +686,20 @@ def serialize_with_witness(self):
     def serialize(self):
         return self.serialize_with_witness()
 
+    @property
+    def wtxid(self):
+        """Return wtxid (transaction hash with witness) as little-endian bytes."""
+        return hash256(self.serialize_with_witness())
+
     @property
     def wtxid_hex(self):
         """Return wtxid (transaction hash with witness) as hex string."""
-        return hash256(self.serialize())[::-1].hex()
+        return self.wtxid[::-1].hex()
 
     @property
     def wtxid_int(self):
         """Return wtxid (transaction hash with witness) as integer."""
-        return uint256_from_str(hash256(self.serialize_with_witness()))
+        return uint256_from_str(self.wtxid)
 
     @property
     def txid(self):