Merge #6893: refactor: drop dependency of spork on net_processing

f0a2cec refactor: drop dependency of spork on net_processing (Konstantin Akimov)

Pull request description:

  ## Issue being fixed or feature implemented
  Dependency of Spork on PeerManager (net_processing) is a blocker for kernel / chainstate project.

  ## What was done?
  Removed dependency of Spork on PeerManager by moving network code to rpc/node

  ## How Has This Been Tested?
  Run test/lint/lint-circular-dependencies.py

  ## Breaking Changes
  N/A

  ## Checklist:
  - [x] I have performed a self-review of my own code
  - [ ] I have commented my code, particularly in hard-to-understand areas
  - [ ] I have added or updated relevant unit/integration/functional/e2e tests
  - [ ] I have made corresponding changes to the documentation
  - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_

ACKs for top commit:
  UdjinM6:
    utACK f0a2cec
  kwvg:
    utACK f0a2cec
  PastaPastaPasta:
    utACK f0a2cec

Tree-SHA512: 1f07fe7af5b76e23c985fd8290521ae4cfbff7c2ba59b7b572748ff4a1561556384c2b0ba596a24304accb63975537e82026d8486793b54f599f75b0dfbc07b4

Author: PastaPastaPasta

src/rpc/node.cpp

@@ -19,6 +19,7 @@
 #include <interfaces/ipc.h>
 #include <key_io.h>
 #include <net.h>
+#include <net_processing.h>
 #include <node/context.h>
 #include <rpc/index_util.h>
 #include <rpc/server.h>
@@ -220,14 +221,15 @@ static RPCHelpMan sporkupdate()
     }
 
     const NodeContext& node = EnsureAnyNodeContext(request.context);
-    PeerManager& peerman = EnsurePeerman(node);
     CHECK_NONFATAL(node.sporkman);
 
     // SPORK VALUE
     int64_t nValue = request.params[1].getInt<int64_t>();
 
-    // broadcast new spork
-    if (node.sporkman->UpdateSpork(peerman, nSporkID, nValue)) {
+    auto inv{node.sporkman->UpdateSpork(nSporkID, nValue)};
+    if (inv.has_value()) {
+        PeerManager& peerman = EnsurePeerman(node);
+        peerman.RelayInv(inv.value());
         return "success";
     }
 

src/spork.cpp

@@ -10,7 +10,6 @@
 #include <logging.h>
 #include <messagesigner.h>
 #include <net.h>
-#include <net_processing.h>
 #include <netmessagemaker.h>
 #include <protocol.h>
 #include <script/standard.h>
@@ -206,37 +205,36 @@ void CSporkManager::ProcessGetSporks(CNode& peer, CConnman& connman)
 }
 
 
-bool CSporkManager::UpdateSpork(PeerManager& peerman, SporkId nSporkID, SporkValue nValue)
+std::optional<CInv> CSporkManager::UpdateSpork(SporkId nSporkID, SporkValue nValue)
 {
     CSporkMessage spork(nSporkID, nValue, GetAdjustedTime());
 
-    {
-        LOCK(cs);
+    LOCK(cs);
 
-        if (!spork.Sign(sporkPrivKey)) {
-            LogPrintf("CSporkManager::%s -- ERROR: signing failed for spork %d\n", __func__, nSporkID);
-            return false;
-        }
+    if (!spork.Sign(sporkPrivKey)) {
+        LogPrintf("CSporkManager::%s -- ERROR: signing failed for spork %d\n", __func__, nSporkID);
+        return std::nullopt;
+    }
 
-        auto opt_keyIDSigner = spork.GetSignerKeyID();
-        if (opt_keyIDSigner == std::nullopt || !setSporkPubKeyIDs.count(*opt_keyIDSigner)) {
-            LogPrintf("CSporkManager::UpdateSpork: failed to find keyid for private key\n");
-            return false;
-        }
+    auto opt_keyIDSigner = spork.GetSignerKeyID();
+    if (opt_keyIDSigner == std::nullopt || !setSporkPubKeyIDs.count(*opt_keyIDSigner)) {
+        LogPrintf("CSporkManager::UpdateSpork: failed to find keyid for private key\n");
+        return std::nullopt;
+    }
 
-        LogPrintf("CSporkManager::%s -- signed %d %s\n", __func__, nSporkID, spork.GetHash().ToString());
+    LogPrintf("CSporkManager::%s -- signed %d %s\n", __func__, nSporkID, spork.GetHash().ToString());
 
-        mapSporksByHash[spork.GetHash()] = spork;
-        mapSporksActive[nSporkID][*opt_keyIDSigner] = spork;
-        // Clear cached values on new spork being processed
+    mapSporksByHash[spork.GetHash()] = spork;
+    mapSporksActive[nSporkID][*opt_keyIDSigner] = spork;
+    // Clear cached values on new spork being processed
 
-        LOCK(cs_cache);
-        mapSporksCachedActive.erase(spork.nSporkID);
-        mapSporksCachedValues.erase(spork.nSporkID);
-    }
+    LOCK(cs_cache);
+    mapSporksCachedActive.erase(spork.nSporkID);
+    mapSporksCachedValues.erase(spork.nSporkID);
 
-    spork.Relay(peerman);
-    return true;
+
+    CInv inv(MSG_SPORK, spork.GetHash());
+    return inv;
 }
 
 bool CSporkManager::IsSporkActive(SporkId nSporkID) const
@@ -460,9 +458,3 @@ std::optional<CKeyID> CSporkMessage::GetSignerKeyID() const
 
     return {pubkeyFromSig.GetID()};
 }
-
-void CSporkMessage::Relay(PeerManager& peerman) const
-{
-    CInv inv(MSG_SPORK, GetHash());
-    peerman.RelayInv(inv);
-}

src/spork.h

@@ -25,7 +25,6 @@ template<typename T>
 class CFlatDB;
 class CNode;
 class CDataStream;
-class PeerManager;
 
 class CSporkMessage;
 class CSporkManager;
@@ -151,11 +150,6 @@ class CSporkMessage
      * in order to identify which spork key signed this message.
      */
     std::optional<CKeyID> GetSignerKeyID() const;
-
-    /**
-     * Relay is used to send this spork message to other peers.
-     */
-    void Relay(PeerManager& peerman) const;
 };
 
 class SporkStore
@@ -278,9 +272,10 @@ class CSporkManager : public SporkStore
 
     /**
      * UpdateSpork is used by the spork RPC command to set a new spork value, sign
-     * and broadcast the spork message.
+     * and return the spork message, ready for network relay.
+     * It returns nullopt if nothing to relay
      */
-    bool UpdateSpork(PeerManager& peerman, SporkId nSporkID, SporkValue nValue) EXCLUSIVE_LOCKS_REQUIRED(!cs, !cs_cache);
+    std::optional<CInv> UpdateSpork(SporkId nSporkID, SporkValue nValue) EXCLUSIVE_LOCKS_REQUIRED(!cs, !cs_cache);
 
     /**
      * IsSporkActive returns a bool for time-based sporks, and should be used

test/lint/lint-circular-dependencies.py

@@ -67,7 +67,6 @@
     "llmq/signing_shares -> net_processing -> llmq/signing_shares",
     "masternode/payments -> validation -> masternode/payments",
     "net -> netmessagemaker -> net",
-    "net_processing -> spork -> net_processing",
     "netaddress -> netbase -> netaddress",
     "qt/appearancewidget -> qt/guiutil -> qt/appearancewidget",
     "qt/bitcoinaddressvalidator -> qt/guiutil -> qt/bitcoinaddressvalidator",