refactor: drop circular dependency over evo/chainhelper.h

Author: knst

src/evo/chainhelper.cpp

@@ -6,12 +6,9 @@
 
 #include <consensus/params.h>
 #include <evo/specialtxman.h>
-#include <index/txindex.h>
 #include <llmq/chainlocks.h>
 #include <llmq/instantsend.h>
 #include <masternode/payments.h>
-#include <node/transaction.h>
-#include <txmempool.h>
 
 CChainstateHelper::CChainstateHelper(CCreditPoolManager& cpoolman, CDeterministicMNManager& dmnman,
                                      CMNHFManager& mnhfman, CGovernanceManager& govman, llmq::CInstantSendManager& isman,
@@ -62,9 +59,3 @@ bool CChainstateHelper::RemoveConflictingISLockByTx(const CTransaction& tx)
 
 bool CChainstateHelper::ShouldInstantSendRejectConflicts() const { return isman.RejectConflictingBlocks(); }
 
-std::pair<CTransactionRef, uint256> GetTransactionBlock(const uint256& hash, const CTxMemPool* const mempool)
-{
-    uint256 hashBlock{};
-    if (!g_txindex && !mempool) return {nullptr, hashBlock}; // Fast-fail as we don't have any other way to search
-    return {GetTransaction(/*block_index=*/nullptr, mempool, hash, Params().GetConsensus(), hashBlock), hashBlock};
-}

src/evo/chainhelper.h

@@ -18,7 +18,6 @@ class CGovernanceManager;
 class CSpecialTxProcessor;
 class CSporkManager;
 class CTransaction;
-class CTxMemPool;
 class uint256;
 
 namespace Consensus { struct Params; }
@@ -30,8 +29,6 @@ class CQuorumManager;
 class CQuorumSnapshotManager;
 }
 
-using CTransactionRef = std::shared_ptr<const CTransaction>;
-
 class CChainstateHelper
 {
 private:
@@ -66,8 +63,4 @@ class CChainstateHelper
     const std::unique_ptr<CSpecialTxProcessor> special_tx;
 };
 
-/* Retrieve transaction and block from txindex (or mempool) */
-std::pair</*tx=*/CTransactionRef, /*hash_block=*/uint256> GetTransactionBlock(const uint256& hash,
-                                                                              const CTxMemPool* const mempool = nullptr);
-
 #endif // BITCOIN_EVO_CHAINHELPER_H

src/evo/deterministicmns.cpp

@@ -2,7 +2,6 @@
 // Distributed under the MIT software license, see the accompanying
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
-#include <evo/chainhelper.h>
 #include <evo/deterministicmns.h>
 #include <evo/dmn_types.h>
 #include <evo/dmnstate.h>
@@ -27,6 +26,10 @@
 #include <optional>
 #include <memory>
 
+// Forward declaration to break dependency over node/transaction.h
+class CTxMemPool;
+std::pair<CTransactionRef, uint256> GetTransactionBlock(const uint256& hash, const CTxMemPool* const mempool);
+
 static const std::string DB_LIST_SNAPSHOT = "dmn_S3";
 static const std::string DB_LIST_DIFF = "dmn_D3";
 
@@ -50,7 +53,7 @@ UniValue CDeterministicMN::ToJson() const
     obj.pushKV("collateralHash", collateralOutpoint.hash.ToString());
     obj.pushKV("collateralIndex", (int)collateralOutpoint.n);
 
-    auto [collateralTx, _] = GetTransactionBlock(collateralOutpoint.hash);
+    auto [collateralTx, _] = GetTransactionBlock(collateralOutpoint.hash, nullptr);
     if (collateralTx) {
         CTxDestination dest;
         if (ExtractDestination(collateralTx->vout[collateralOutpoint.n].scriptPubKey, dest)) {

src/governance/object.cpp

@@ -7,10 +7,10 @@
 #include <bls/bls.h>
 #include <chainparams.h>
 #include <core_io.h>
-#include <evo/chainhelper.h>
 #include <evo/deterministicmns.h>
 #include <governance/governance.h>
 #include <governance/validators.h>
+#include <index/txindex.h>
 #include <masternode/meta.h>
 #include <masternode/node.h>
 #include <masternode/sync.h>
@@ -453,8 +453,15 @@ bool CGovernanceObject::IsCollateralValid(const ChainstateManager& chainman, std
     fMissingConfirmations = false;
     uint256 nExpectedHash = GetHash();
 
-    // RETRIEVE TRANSACTION IN QUESTION
-    auto [txCollateral, nBlockHash] = GetTransactionBlock(m_obj.collateralHash);
+    CTransactionRef txCollateral;
+    uint256 nBlockHash;
+    if (g_txindex) {
+        g_txindex->FindTx(m_obj.collateralHash, nBlockHash, txCollateral);
+    } else {
+        strError = "TxIndex is not available";
+        return false;
+    }
+
     if (!txCollateral) {
         strError = strprintf("Can't find collateral tx %s", m_obj.collateralHash.ToString());
         LogPrintf("CGovernanceObject::IsCollateralValid -- %s\n", strError);

src/llmq/chainlocks.cpp

@@ -10,7 +10,6 @@
 #include <chain.h>
 #include <chainparams.h>
 #include <consensus/validation.h>
-#include <evo/chainhelper.h>
 #include <masternode/sync.h>
 #include <node/blockstorage.h>
 #include <node/interface_ui.h>
@@ -24,6 +23,9 @@
 #include <validation.h>
 #include <validationinterface.h>
 
+// Forward declaration to break dependency over node/transaction.h
+std::pair<CTransactionRef, uint256> GetTransactionBlock(const uint256& hash, const CTxMemPool* const mempool);
+
 static bool ChainLocksSigningEnabled(const CSporkManager& sporkman)
 {
     return sporkman.GetSporkValue(SPORK_19_CHAINLOCKS_ENABLED) == 0;

src/llmq/instantsend.cpp

@@ -13,7 +13,6 @@
 #include <chainparams.h>
 #include <consensus/validation.h>
 #include <dbwrapper.h>
-#include <evo/chainhelper.h>
 #include <index/txindex.h>
 #include <masternode/sync.h>
 #include <net_processing.h>
@@ -28,6 +27,9 @@
 
 #include <cxxtimer.hpp>
 
+// Forward declaration to break dependency over node/transaction.h
+std::pair<CTransactionRef, uint256> GetTransactionBlock(const uint256& hash, const CTxMemPool* const mempool);
+
 namespace llmq
 {
 

src/node/transaction.cpp

@@ -148,3 +148,10 @@ CTransactionRef GetTransaction(const CBlockIndex* const block_index, const CTxMe
     }
     return nullptr;
 }
+
+std::pair<CTransactionRef, uint256> GetTransactionBlock(const uint256& hash, const CTxMemPool* const mempool)
+{
+    uint256 hashBlock{};
+    if (!g_txindex && !mempool) return {nullptr, hashBlock}; // Fast-fail as we don't have any other way to search
+    return {GetTransaction(/*block_index=*/nullptr, mempool, hash, Params().GetConsensus(), hashBlock), hashBlock};
+}

src/node/transaction.h

@@ -57,4 +57,13 @@ static const CFeeRate DEFAULT_MAX_RAW_TX_FEE_RATE{COIN / 10};
  */
 CTransactionRef GetTransaction(const CBlockIndex* const block_index, const CTxMemPool* const mempool, const uint256& hash, const Consensus::Params& consensusParams, uint256& hashBlock);
 
+/**
+ * Retrieve transaction and block from txindex (or mempool)
+ * That's just a wrapper over GetTransaction to break circular dependencies
+ * and to simplify caller for case if no block_index
+ */
+std::pair</*tx=*/CTransactionRef, /*hash_block=*/uint256> GetTransactionBlock(const uint256& hash,
+                                                                              const CTxMemPool* const mempool);
+
+
 #endif // BITCOIN_NODE_TRANSACTION_H

src/validation.cpp

@@ -117,6 +117,9 @@ int64_t nMaxTipAge = DEFAULT_MAX_TIP_AGE;
 uint256 hashAssumeValid;
 arith_uint256 nMinimumChainWork;
 
+// Forward declaration to break dependency over node/transaction.h
+std::pair<CTransactionRef, uint256> GetTransactionBlock(const uint256& hash, const CTxMemPool* const mempool);
+
 const CBlockIndex* CChainState::FindForkInGlobalIndex(const CBlockLocator& locator) const
 {
     AssertLockHeld(cs_main);

test/lint/lint-circular-dependencies.py

@@ -38,12 +38,7 @@
     "dsnotificationinterface -> llmq/chainlocks -> node/blockstorage -> dsnotificationinterface",
     "evo/assetlocktx -> llmq/signing -> net_processing -> txmempool -> evo/assetlocktx",
     "evo/cbtx -> evo/simplifiedmns -> evo/cbtx",
-    "evo/chainhelper -> evo/specialtxman -> evo/deterministicmns -> evo/chainhelper",
     "evo/chainhelper -> evo/specialtxman -> validation -> evo/chainhelper",
-    "evo/chainhelper -> llmq/chainlocks -> evo/chainhelper",
-    "evo/chainhelper -> llmq/instantsend -> evo/chainhelper",
-    "evo/chainhelper -> masternode/payments -> governance/classes -> governance/object -> evo/chainhelper",
-    "evo/chainhelper -> node/transaction -> node/context -> evo/chainhelper",
     "evo/deterministicmns -> llmq/commitment -> evo/deterministicmns",
     "evo/deterministicmns -> llmq/commitment -> validation -> evo/deterministicmns",
     "evo/deterministicmns -> llmq/commitment -> validation -> txmempool -> evo/deterministicmns",