[Refactoring] Add evo Notification Interface

random-zebra · random-zebra · commit c013bf16bdb3 · 2021-04-23T01:01:16.000+02:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -385,6 +385,7 @@ set(COMMON_SOURCES
         ./src/key_io.cpp
         ./src/compressor.cpp
         ./src/evo/deterministicmns.cpp
+        ./src/evo/evonotificationinterface.cpp
         ./src/evo/evodb.cpp
         ./src/evo/providertx.cpp
         ./src/evo/specialtx.cpp
diff --git a/src/Makefile.am b/src/Makefile.am
@@ -184,6 +184,7 @@ BITCOIN_CORE_H = \
   cyclingvector.h \
   evo/deterministicmns.h \
   evo/evodb.h \
+  evo/evonotificationinterface.h \
   evo/providertx.h \
   evo/specialtx.h \
   pairresult.h \
@@ -330,6 +331,7 @@ libbitcoin_server_a_SOURCES = \
   consensus/zerocoin_verify.cpp \
   evo/deterministicmns.cpp \
   evo/evodb.cpp \
+  evo/evonotificationinterface.cpp \
   evo/providertx.cpp \
   evo/specialtx.cpp \
   httprpc.cpp \
diff --git a/src/evo/deterministicmns.cpp b/src/evo/deterministicmns.cpp
@@ -9,6 +9,7 @@
 #include "chainparams.h"
 #include "core_io.h"
 #include "evo/specialtx.h"
+#include "guiinterface.h"
 #include "masternode.h" // for MN_COLL_AMT, MasternodeCollateralMinConf
 #include "script/standard.h"
 #include "sync.h"
@@ -543,7 +544,11 @@ bool CDeterministicMNManager::ProcessBlock(const CBlock& block, const CBlockInde
         return _state.DoS(100, false, REJECT_INVALID, "failed-dmn-block");
     }
 
-    // !TODO: notify listeners that the mn list has changed
+    // Don't hold cs while calling signals
+    if (diff.HasChanges()) {
+        GetMainSignals().NotifyMasternodeListChanged(false, oldList, diff);
+        uiInterface.NotifyMasternodeListChanged(newList);
+    }
 
     LOCK(cs);
     CleanupCache(nHeight);
@@ -575,7 +580,8 @@ bool CDeterministicMNManager::UndoBlock(const CBlock& block, const CBlockIndex*
 
     if (diff.HasChanges()) {
         auto inversedDiff = curList.BuildDiff(prevList);
-        // !TODO: notify listeners that the masternode list has changed
+        GetMainSignals().NotifyMasternodeListChanged(true, curList, inversedDiff);
+        uiInterface.NotifyMasternodeListChanged(prevList);
     }
 
     return true;
diff --git a/src/evo/evonotificationinterface.cpp b/src/evo/evonotificationinterface.cpp
@@ -0,0 +1,24 @@
+// Copyright (c) 2014-2019 The Dash Core developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+#include "evo/evonotificationinterface.h"
+
+#include "evo/deterministicmns.h"
+#include "validation.h"
+
+void EvoNotificationInterface::InitializeCurrentBlockTip()
+{
+    LOCK(cs_main);
+    UpdatedBlockTip(chainActive.Tip(), nullptr, IsInitialBlockDownload());
+}
+
+void EvoNotificationInterface::UpdatedBlockTip(const CBlockIndex *pindexNew, const CBlockIndex *pindexFork, bool fInitialDownload)
+{
+    deterministicMNManager->UpdatedBlockTip(pindexNew);
+}
+
+void EvoNotificationInterface::NotifyMasternodeListChanged(bool undo, const CDeterministicMNList& oldMNList, const CDeterministicMNListDiff& diff)
+{
+    // !TODO
+}
diff --git a/src/evo/evonotificationinterface.h b/src/evo/evonotificationinterface.h
@@ -0,0 +1,28 @@
+// Copyright (c) 2021 The PIVX developers
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+#ifndef EVONOTIFICATIONINTERFACE_H
+#define EVONOTIFICATIONINTERFACE_H
+
+#include "validationinterface.h"
+
+class EvoNotificationInterface : public CValidationInterface
+{
+public:
+    explicit EvoNotificationInterface(CConnman& connmanIn): connman(connmanIn) {}
+    virtual ~EvoNotificationInterface() = default;
+
+    // a small helper to initialize current block height in sub-modules on startup
+    void InitializeCurrentBlockTip();
+
+protected:
+    // CValidationInterface
+    void UpdatedBlockTip(const CBlockIndex *pindexNew, const CBlockIndex *pindexFork, bool fInitialDownload) override;
+    void NotifyMasternodeListChanged(bool undo, const CDeterministicMNList& oldMNList, const CDeterministicMNListDiff& diff) override;
+
+private:
+    CConnman& connman;
+};
+
+#endif // EVONOTIFICATIONINTERFACE_H
diff --git a/src/guiinterface.h b/src/guiinterface.h
@@ -18,6 +18,7 @@ class CBasicKeyStore;
 class CWallet;
 class uint256;
 class CBlockIndex;
+class CDeterministicMNList;
 
 /** General change type (added, updated, removed). */
 enum ChangeType {
@@ -102,6 +103,9 @@ class CClientUIInterface
 
     /** Banlist did change. */
     boost::signals2::signal<void (void)> BannedListChanged;
+
+    /** Deterministic Masternode list has changed */
+    boost::signals2::signal<void (const CDeterministicMNList&)> NotifyMasternodeListChanged;
 };
 
 extern CClientUIInterface uiInterface;
diff --git a/src/init.cpp b/src/init.cpp
@@ -22,6 +22,7 @@
 #include "checkpoints.h"
 #include "compat/sanity.h"
 #include "consensus/upgrades.h"
+#include "evo/evonotificationinterface.h"
 #include "fs.h"
 #include "httpserver.h"
 #include "httprpc.h"
@@ -105,6 +106,8 @@ std::unique_ptr<PeerLogicValidation> peerLogic;
 static CZMQNotificationInterface* pzmqNotificationInterface = NULL;
 #endif
 
+static EvoNotificationInterface* pEvoNotificationInterface = nullptr;
+
 #ifdef WIN32
 // Win32 LevelDB doesn't use filedescriptors, and the ones used for
 // accessing block files, don't count towards to fd_set size limit
@@ -307,11 +310,17 @@ void PrepareShutdown()
         bitdb.Flush(true);
 #endif
 
+    if (pEvoNotificationInterface) {
+        UnregisterValidationInterface(pEvoNotificationInterface);
+        delete pEvoNotificationInterface;
+        pEvoNotificationInterface = nullptr;
+    }
+
 #if ENABLE_ZMQ
     if (pzmqNotificationInterface) {
         UnregisterValidationInterface(pzmqNotificationInterface);
         delete pzmqNotificationInterface;
-        pzmqNotificationInterface = NULL;
+        pzmqNotificationInterface = nullptr;
     }
 #endif
 
@@ -719,6 +728,10 @@ void ThreadImport(const std::vector<fs::path>& vImportFiles)
         StartShutdown();
     }
 
+    // force UpdatedBlockTip to initialize nCachedBlockHeight for DS, MN payments and budgets
+    // but don't call it directly to prevent triggering of other listeners like zmq etc.
+    pEvoNotificationInterface->InitializeCurrentBlockTip();
+
     if (gArgs.GetBoolArg("-persistmempool", DEFAULT_PERSIST_MEMPOOL)) {
         LoadMempool(::mempool);
     }
@@ -1536,6 +1549,9 @@ bool AppInitMain()
     }
 #endif
 
+    pEvoNotificationInterface = new EvoNotificationInterface(connman);
+    RegisterValidationInterface(pEvoNotificationInterface);
+
     // ********************************************************* Step 7: load block chain
 
     fReindex = gArgs.GetBoolArg("-reindex", false);
diff --git a/src/validation.cpp b/src/validation.cpp
@@ -2415,9 +2415,6 @@ bool ActivateBestChain(CValidationState& state, std::shared_ptr<const CBlock> pb
                 // Notify ValidationInterface subscribers
                 GetMainSignals().UpdatedBlockTip(pindexNewTip, pindexFork, fInitialDownload);
 
-                // TODO: move to notification interface
-                deterministicMNManager->UpdatedBlockTip(pindexNewTip);
-
                 // Always notify the UI if a new block tip was connected
                 uiInterface.NotifyBlockTip(fInitialDownload, pindexNewTip);
             }
diff --git a/src/validationinterface.cpp b/src/validationinterface.cpp
@@ -22,6 +22,7 @@ struct ValidationInterfaceConnections {
     boost::signals2::scoped_connection SetBestChain;
     boost::signals2::scoped_connection Broadcast;
     boost::signals2::scoped_connection BlockChecked;
+    boost::signals2::scoped_connection NotifyMasternodeListChanged;
 };
 
 struct MainSignalsInstance {
@@ -45,6 +46,8 @@ struct MainSignalsInstance {
     boost::signals2::signal<void (CConnman* connman)> Broadcast;
     /** Notifies listeners of a block validation result */
     boost::signals2::signal<void (const CBlock&, const CValidationState&)> BlockChecked;
+    /** Notifies listeners of updated deterministic masternode list */
+    boost::signals2::signal<void (bool undo, const CDeterministicMNList& oldMNList, const CDeterministicMNListDiff& diff)> NotifyMasternodeListChanged;
 
     std::unordered_map<CValidationInterface*, ValidationInterfaceConnections> m_connMainSignals;
 
@@ -94,6 +97,7 @@ void RegisterValidationInterface(CValidationInterface* pwalletIn)
     conns.SetBestChain = g_signals.m_internals->SetBestChain.connect(std::bind(&CValidationInterface::SetBestChain, pwalletIn, std::placeholders::_1));
     conns.Broadcast = g_signals.m_internals->Broadcast.connect(std::bind(&CValidationInterface::ResendWalletTransactions, pwalletIn, std::placeholders::_1));
     conns.BlockChecked = g_signals.m_internals->BlockChecked.connect(std::bind(&CValidationInterface::BlockChecked, pwalletIn, std::placeholders::_1, std::placeholders::_2));
+    conns.NotifyMasternodeListChanged = g_signals.m_internals->NotifyMasternodeListChanged.connect(std::bind(&CValidationInterface::NotifyMasternodeListChanged, pwalletIn, std::placeholders::_1, std::placeholders::_2, std::placeholders::_3));
 }
 
 void UnregisterValidationInterface(CValidationInterface* pwalletIn)
@@ -175,3 +179,7 @@ void CMainSignals::Broadcast(CConnman* connman) {
 void CMainSignals::BlockChecked(const CBlock& block, const CValidationState& state) {
     m_internals->BlockChecked(block, state);
 }
+
+void CMainSignals::NotifyMasternodeListChanged(bool undo, const CDeterministicMNList& oldMNList, const CDeterministicMNListDiff& diff) {
+    m_internals->NotifyMasternodeListChanged(undo, oldMNList, diff);
+}
diff --git a/src/validationinterface.h b/src/validationinterface.h
@@ -18,6 +18,8 @@ class CBlock;
 struct CBlockLocator;
 class CBlockIndex;
 class CConnman;
+class CDeterministicMNList;
+class CDeterministicMNListDiff;
 class CValidationInterface;
 class CValidationState;
 class uint256;
@@ -146,6 +148,8 @@ class CValidationInterface {
     friend void ::RegisterValidationInterface(CValidationInterface*);
     friend void ::UnregisterValidationInterface(CValidationInterface*);
     friend void ::UnregisterAllValidationInterfaces();
+    /** Notifies listeners of updated deterministic masternode list */
+    virtual void NotifyMasternodeListChanged(bool undo, const CDeterministicMNList& oldMNList, const CDeterministicMNListDiff& diff) {}
 };
 
 struct MainSignalsInstance;
@@ -176,6 +180,7 @@ class CMainSignals {
     void SetBestChain(const CBlockLocator &);
     void Broadcast(CConnman* connman);
     void BlockChecked(const CBlock&, const CValidationState&);
+    void NotifyMasternodeListChanged(bool undo, const CDeterministicMNList& oldMNList, const CDeterministicMNListDiff& diff);
 };
 
 CMainSignals& GetMainSignals();

Original file line number	Diff line number	Diff line change
`@@ -2415,9 +2415,6 @@ bool ActivateBestChain(CValidationState& state, std::shared_ptr<const CBlock> pb`
`2415`	`2415`	`// Notify ValidationInterface subscribers`
`2416`	`2416`	`GetMainSignals().UpdatedBlockTip(pindexNewTip, pindexFork, fInitialDownload);`
`2417`	`2417`
`2418`		`- // TODO: move to notification interface`
`2419`		`- deterministicMNManager->UpdatedBlockTip(pindexNewTip);`
`2420`		`-`
`2421`	`2418`	`// Always notify the UI if a new block tip was connected`
`2422`	`2419`	`uiInterface.NotifyBlockTip(fInitialDownload, pindexNewTip);`
`2423`	`2420`	`}`