init: improve dmn collateral locking.

furszy · furszy · commit 38b92b99752e · 2022-01-19T10:43:36.000-03:00
1) Walk-through the DMN list only once instead of one-time per wallet.
2) Remove wallet dependency on evo/deterministicmns.h.
diff --git a/src/init.cpp b/src/init.cpp
@@ -1750,10 +1750,13 @@ bool AppInitMain()
 
     // automatic lock for DMN
     if (gArgs.GetBoolArg("-mnconflock", DEFAULT_MNCONFLOCK)) {
+        LogPrintf("Locking masternode collaterals...\n");
         const auto& mnList = deterministicMNManager->GetListAtChainTip();
-        for (CWallet* pwallet : vpwallets) {
-            pwallet->ScanMasternodeCollateralsAndLock(mnList);
-        }
+        mnList.ForEachMN(false, [&](const CDeterministicMNCPtr& dmn) {
+            for (CWallet* pwallet : vpwallets) {
+                pwallet->LockOutpointIfMineWithMutex(nullptr, dmn->collateralOutpoint);
+            }
+        });
     }
 #endif
 
diff --git a/src/wallet/wallet.cpp b/src/wallet/wallet.cpp
@@ -13,7 +13,7 @@
 
 #include "checkpoints.h"
 #include "coincontrol.h"
-#include "evo/deterministicmns.h"
+#include "evo/providertx.h"
 #include "guiinterfaceutil.h"
 #include "masternode.h"
 #include "policy/policy.h"
@@ -4121,6 +4121,11 @@ void CWallet::AutoCombineDust(CConnman* connman)
     }
 }
 
+void CWallet::LockOutpointIfMineWithMutex(const CTransactionRef& ptx, const COutPoint& c)
+{
+    WITH_LOCK(cs_wallet, LockOutpointIfMine(ptx, c));
+}
+
 void CWallet::LockOutpointIfMine(const CTransactionRef& ptx, const COutPoint& c)
 {
     AssertLockHeld(cs_wallet);
@@ -4140,17 +4145,6 @@ void CWallet::LockOutpointIfMine(const CTransactionRef& ptx, const COutPoint& c)
     }
 }
 
-// Called during Init
-void CWallet::ScanMasternodeCollateralsAndLock(const CDeterministicMNList& mnList)
-{
-    LOCK(cs_wallet);
-
-    LogPrintf("Locking masternode collaterals...\n");
-    mnList.ForEachMN(false, [&](const CDeterministicMNCPtr& dmn) {
-        LockOutpointIfMine(nullptr, dmn->collateralOutpoint);
-    });
-}
-
 // Called from AddToWalletIfInvolvingMe
 void CWallet::LockIfMyCollateral(const CTransactionRef& ptx)
 {
diff --git a/src/wallet/wallet.h b/src/wallet/wallet.h
@@ -99,7 +99,6 @@ class ScriptPubKeyMan;
 class SaplingScriptPubKeyMan;
 class SaplingNoteData;
 struct SaplingNoteEntry;
-class CDeterministicMNList;
 
 /** (client) version numbers for particular wallet features */
 enum WalletFeature {
@@ -886,13 +885,11 @@ class CWallet : public CCryptoKeyStore, public CValidationInterface
      *  -- If ptx is null, c is the output of a transaction in mapWallet
      */
     void LockOutpointIfMine(const CTransactionRef& ptx, const COutPoint& c);
-
     /*
-     *  Locks cs_wallet
-     *  Called during Init. If a DMN collateral is found in the wallet,
-     *  lock the corresponding coin, to prevent accidental spending.
+     * Same functionality as above but locking the cs_wallet mutex internally.
+     * future: add capability to lock the mutex from outside of this class without exposing it.
      */
-    void ScanMasternodeCollateralsAndLock(const CDeterministicMNList& mnList);
+    void LockOutpointIfMineWithMutex(const CTransactionRef& ptx, const COutPoint& c);
 
     /*
      *  Requires cs_wallet lock.
diff --git a/test/lint/lint-circular-dependencies.sh b/test/lint/lint-circular-dependencies.sh
@@ -43,7 +43,6 @@ EXPECTED_CIRCULAR_DEPENDENCIES=(
     "chain -> legacy/stakemodifier -> stakeinput -> chain"
     "chain -> legacy/stakemodifier -> validation -> chain"
     "chainparamsbase -> util/system -> logging -> chainparamsbase"
-    "evo/deterministicmns -> masternode -> wallet/wallet -> evo/deterministicmns"
     "kernel -> stakeinput -> wallet/wallet -> kernel"
     "legacy/validation_zerocoin_legacy -> wallet/wallet -> validation -> legacy/validation_zerocoin_legacy"
     "qt/askpassphrasedialog -> qt/pivx/pivxgui -> qt/pivx/topbar -> qt/askpassphrasedialog"

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`
`14`	`14`	`#include "checkpoints.h"`
`15`	`15`	`#include "coincontrol.h"`
`16`		`-#include "evo/deterministicmns.h"`
	`16`	`+#include "evo/providertx.h"`
`17`	`17`	`#include "guiinterfaceutil.h"`
`18`	`18`	`#include "masternode.h"`
`19`	`19`	`#include "policy/policy.h"`
`@@ -4121,6 +4121,11 @@ void CWallet::AutoCombineDust(CConnman* connman)`
`4121`	`4121`	`}`
`4122`	`4122`	`}`
`4123`	`4123`
	`4124`	`+void CWallet::LockOutpointIfMineWithMutex(const CTransactionRef& ptx, const COutPoint& c)`
	`4125`	`+{`
	`4126`	`+ WITH_LOCK(cs_wallet, LockOutpointIfMine(ptx, c));`
	`4127`	`+}`
	`4128`	`+`
`4124`	`4129`	`void CWallet::LockOutpointIfMine(const CTransactionRef& ptx, const COutPoint& c)`
`4125`	`4130`	`{`
`4126`	`4131`	`AssertLockHeld(cs_wallet);`
`@@ -4140,17 +4145,6 @@ void CWallet::LockOutpointIfMine(const CTransactionRef& ptx, const COutPoint& c)`
`4140`	`4145`	`}`
`4141`	`4146`	`}`
`4142`	`4147`
`4143`		`-// Called during Init`
`4144`		`-void CWallet::ScanMasternodeCollateralsAndLock(const CDeterministicMNList& mnList)`
`4145`		`-{`
`4146`		`- LOCK(cs_wallet);`
`4147`		`-`
`4148`		`- LogPrintf("Locking masternode collaterals...\n");`
`4149`		`- mnList.ForEachMN(false, [&](const CDeterministicMNCPtr& dmn) {`
`4150`		`- LockOutpointIfMine(nullptr, dmn->collateralOutpoint);`
`4151`		`- });`
`4152`		`-}`
`4153`		`-`
`4154`	`4148`	`// Called from AddToWalletIfInvolvingMe`
`4155`	`4149`	`void CWallet::LockIfMyCollateral(const CTransactionRef& ptx)`
`4156`	`4150`	`{`