feat: new GetSML method for CDeterministicMNList

Author: knst

src/evo/deterministicmns.cpp

@@ -8,6 +8,7 @@
 #include <evo/dmnstate.h>
 #include <evo/evodb.h>
 #include <evo/providertx.h>
+#include <evo/simplifiedmns.h>
 #include <evo/specialtx.h>
 #include <llmq/commitment.h>
 #include <llmq/utils.h>
@@ -255,6 +256,14 @@ std::vector<CDeterministicMNCPtr> CDeterministicMNList::GetProjectedMNPayees(gsl
     return result;
 }
 
+gsl::not_null<std::shared_ptr<const CSimplifiedMNList>> CDeterministicMNList::GetSML() const
+{
+    if (!m_cached_sml) {
+        m_cached_sml = std::make_shared<const CSimplifiedMNList>(*this);
+    }
+    return m_cached_sml;
+}
+
 int CDeterministicMNList::CalcMaxPoSePenalty() const
 {
     // Maximum PoSe penalty is dynamic and equals the number of registered MNs
@@ -440,6 +449,7 @@ void CDeterministicMNList::AddMN(const CDeterministicMNCPtr& dmn, bool fBumpTota
 
     mnMap = mnMap.set(dmn->proTxHash, dmn);
     mnInternalIdMap = mnInternalIdMap.set(dmn->GetInternalId(), dmn->proTxHash);
+    m_cached_sml = nullptr;
     if (fBumpTotalCount) {
         // nTotalRegisteredCount acts more like a checkpoint, not as a limit,
         nTotalRegisteredCount = std::max(dmn->GetInternalId() + 1, (uint64_t)nTotalRegisteredCount);
@@ -510,6 +520,9 @@ void CDeterministicMNList::UpdateMN(const CDeterministicMN& oldDmn, const std::s
 
     dmn->pdmnState = pdmnState;
     mnMap = mnMap.set(oldDmn.proTxHash, dmn);
+    if (m_cached_sml && CSimplifiedMNListEntry{oldDmn} != CSimplifiedMNListEntry{*dmn}) {
+        m_cached_sml = nullptr;
+    }
 }
 
 void CDeterministicMNList::UpdateMN(const uint256& proTxHash, const std::shared_ptr<const CDeterministicMNState>& pdmnState)
@@ -581,6 +594,7 @@ void CDeterministicMNList::RemoveMN(const uint256& proTxHash)
 
     mnMap = mnMap.erase(proTxHash);
     mnInternalIdMap = mnInternalIdMap.erase(dmn->GetInternalId());
+    m_cached_sml = nullptr;
 }
 
 bool CDeterministicMNManager::ProcessBlock(const CBlock& block, gsl::not_null<const CBlockIndex*> pindex,

src/evo/deterministicmns.h

@@ -30,6 +30,7 @@ class CBlock;
 class CBlockIndex;
 class CCoinsViewCache;
 class CEvoDB;
+class CSimplifiedMNList;
 class TxValidationState;
 
 extern RecursiveMutex cs_main;
@@ -171,6 +172,13 @@ class CDeterministicMNList
     // we keep track of this as checking for duplicates would otherwise be painfully slow
     MnUniquePropertyMap mnUniquePropertyMap;
 
+    // This SML could be null
+    // This cache is used to improve performance and meant to be reused
+    // for multiple CDeterministicMNList until mnMap is actually changed.
+    // Calls of AddMN, RemoveMN and (in some cases) UpdateMN reset this cache;
+    // it happens also for indirect calls such as ApplyDiff
+    mutable std::shared_ptr<const CSimplifiedMNList> m_cached_sml;
+
 public:
     CDeterministicMNList() = default;
     explicit CDeterministicMNList(const uint256& _blockHash, int _height, uint32_t _totalRegisteredCount) :
@@ -205,6 +213,7 @@ class CDeterministicMNList
         mnMap = MnMap();
         mnUniquePropertyMap = MnUniquePropertyMap();
         mnInternalIdMap = MnInternalIdMap();
+        m_cached_sml = nullptr;
 
         SerializationOpBase(s, CSerActionUnserialize());
 
@@ -331,6 +340,11 @@ class CDeterministicMNList
      */
     [[nodiscard]] std::vector<CDeterministicMNCPtr> GetProjectedMNPayees(gsl::not_null<const CBlockIndex* const> pindexPrev, int nCount = std::numeric_limits<int>::max()) const;
 
+    /**
+     * Calculates CSimplifiedMNList for current list and cache it
+     */
+    gsl::not_null<std::shared_ptr<const CSimplifiedMNList>> GetSML() const;
+
     /**
      * Calculates the maximum penalty which is allowed at the height of this MN list. It is dynamic and might change
      * for every block.

test/lint/lint-circular-dependencies.py

@@ -49,10 +49,10 @@
     "evo/deterministicmns -> llmq/commitment -> validation -> txmempool -> evo/deterministicmns",
     "evo/deterministicmns -> llmq/utils -> evo/deterministicmns",
     "evo/deterministicmns -> llmq/utils -> llmq/snapshot -> evo/smldiff -> evo/deterministicmns",
-    "evo/deterministicmns -> llmq/utils -> llmq/snapshot -> evo/simplifiedmns -> evo/deterministicmns",
     "evo/deterministicmns -> llmq/utils -> net -> evo/deterministicmns",
     "evo/deterministicmns -> validationinterface -> evo/deterministicmns",
     "evo/deterministicmns -> validationinterface -> governance/vote -> evo/deterministicmns",
+    "evo/deterministicmns -> evo/simplifiedmns -> evo/deterministicmns",
     "evo/mnhftx -> validation -> evo/mnhftx",
     "evo/smldiff -> llmq/blockprocessor -> llmq/utils -> llmq/snapshot -> evo/smldiff",
     "evo/specialtxman -> validation -> evo/specialtxman",