Allow configuration of reward address.

Allow setting a non-default reward script for masternodes, by editing
the masternode.conf file explicitly.  The RPC setupmasternode will not
generate such configuration lines for now, and also "old" masternode.conf
files will remain valid (with the default script).

Author: domob1812

divi/src/masternode.cpp

@@ -212,6 +212,11 @@ CMasternode& CMasternode::operator=(CMasternode from)
 }
 
 CScript CMasternode::GetDefaultRewardScript() const
+{
+    return GetDefaultRewardScript(pubKeyCollateralAddress);
+}
+
+CScript CMasternode::GetDefaultRewardScript(const CPubKey& pubKeyCollateralAddress)
 {
     return GetScriptForDestination(pubKeyCollateralAddress.GetID());
 }
@@ -496,12 +501,15 @@ bool CMasternode::IsValidNetAddr() const
             (IsReachable(addr) && addr.IsRoutable());
 }
 
-CMasternodeBroadcast::CMasternodeBroadcast(CService newAddr, CTxIn newVin, CPubKey pubKeyCollateralAddressNew, CPubKey pubKeyMasternodeNew, const MasternodeTier nMasternodeTier, int protocolVersionIn)
+CMasternodeBroadcast::CMasternodeBroadcast(
+    const CService& newAddr, const CTxIn& newVin,
+    const CPubKey& pubKeyCollateralAddressNew, const CScript& rewardScriptIn, const CPubKey& pubKeyMasternodeNew,
+    const MasternodeTier nMasternodeTier, const int protocolVersionIn)
 {
     vin = newVin;
     addr = newAddr;
     pubKeyCollateralAddress = pubKeyCollateralAddressNew;
-    rewardScript = GetDefaultRewardScript();
+    rewardScript = rewardScriptIn;
     pubKeyMasternode = pubKeyMasternodeNew;
     protocolVersion = protocolVersionIn;
     nTier = nMasternodeTier;
@@ -511,8 +519,10 @@ CMasternodeBroadcast::CMasternodeBroadcast(const CMasternode& mn)
   : CMasternode(mn)
 {}
 
+namespace
+{
 
-bool CMasternodeBroadcastFactory::checkBlockchainSync(std::string& strErrorRet, bool fOffline)
+bool checkBlockchainSync(std::string& strErrorRet, bool fOffline)
 {
      if (!fOffline && !masternodeSync.IsBlockchainSynced()) {
         strErrorRet = "Sync in progress. Must wait until sync is complete to start Masternode";
@@ -521,7 +531,8 @@ bool CMasternodeBroadcastFactory::checkBlockchainSync(std::string& strErrorRet,
     }
     return true;
 }
-bool CMasternodeBroadcastFactory::setMasternodeKeys(
+
+bool setMasternodeKeys(
     const std::string& strKeyMasternode,
     std::pair<CKey,CPubKey>& masternodeKeyPair,
     std::string& strErrorRet)
@@ -533,7 +544,8 @@ bool CMasternodeBroadcastFactory::setMasternodeKeys(
     }
     return true;
 }
-bool CMasternodeBroadcastFactory::setMasternodeCollateralKeys(
+
+bool setMasternodeCollateralKeys(
     const std::string& txHash,
     const std::string& outputIndex,
     const std::string& service,
@@ -558,7 +570,7 @@ bool CMasternodeBroadcastFactory::setMasternodeCollateralKeys(
     return true;
 }
 
-bool CMasternodeBroadcastFactory::checkMasternodeCollateral(
+bool checkMasternodeCollateral(
     const CTxIn& txin,
     const std::string& txHash,
     const std::string& outputIndex,
@@ -590,13 +602,14 @@ bool CMasternodeBroadcastFactory::checkMasternodeCollateral(
     return true;
 }
 
-bool CMasternodeBroadcastFactory::createArgumentsFromConfig(
+bool createArgumentsFromConfig(
     const CMasternodeConfig::CMasternodeEntry configEntry,
     std::string& strErrorRet,
     bool fOffline,
     bool collateralPrivKeyIsRemote,
     CTxIn& txin,
     std::pair<CKey,CPubKey>& masternodeKeyPair,
+    CScript& rewardScript,
     std::pair<CKey,CPubKey>& masternodeCollateralKeyPair,
     MasternodeTier& nMasternodeTier
     )
@@ -613,9 +626,23 @@ bool CMasternodeBroadcastFactory::createArgumentsFromConfig(
     {
         return false;
     }
+
+    if (configEntry.getRewardAddress().empty())
+        rewardScript = CMasternode::GetDefaultRewardScript(masternodeCollateralKeyPair.second);
+    else {
+        const CBitcoinAddress addr(configEntry.getRewardAddress());
+        if (!addr.IsValid()) {
+            strErrorRet = strprintf("Invalid reward address for masternode: %s", configEntry.getRewardAddress());
+            return false;
+        }
+        rewardScript = GetScriptForDestination(addr.Get());
+    }
+
     return true;
 }
 
+} // anonymous namespace
+
 bool CMasternodeBroadcastFactory::Create(const CMasternodeConfig::CMasternodeEntry configEntry,
                     CPubKey pubkeyCollateralAddress,
                     std::string& strErrorRet,
@@ -626,6 +653,7 @@ bool CMasternodeBroadcastFactory::Create(const CMasternodeConfig::CMasternodeEnt
     const bool deferRelay = true;
     CTxIn txin;
     std::pair<CKey,CPubKey> masternodeCollateralKeyPair;
+    CScript rewardScript;
     std::pair<CKey,CPubKey> masternodeKeyPair;
     MasternodeTier nMasternodeTier;
 
@@ -636,6 +664,7 @@ bool CMasternodeBroadcastFactory::Create(const CMasternodeConfig::CMasternodeEnt
         collateralPrivateKeyIsRemote,
         txin,
         masternodeKeyPair,
+        rewardScript,
         masternodeCollateralKeyPair,
         nMasternodeTier))
     {
@@ -646,6 +675,7 @@ bool CMasternodeBroadcastFactory::Create(const CMasternodeConfig::CMasternodeEnt
         txin,
         CService(configEntry.getIp()),
         pubkeyCollateralAddress,
+        rewardScript,
         masternodeKeyPair.second,
         nMasternodeTier,
         deferRelay,
@@ -674,6 +704,7 @@ bool CMasternodeBroadcastFactory::Create(
 
     CTxIn txin;
     std::pair<CKey,CPubKey> masternodeCollateralKeyPair;
+    CScript rewardScript;
     std::pair<CKey,CPubKey> masternodeKeyPair;
     MasternodeTier nMasternodeTier;
 
@@ -684,6 +715,7 @@ bool CMasternodeBroadcastFactory::Create(
         collateralPrivateKeyIsRemote,
         txin,
         masternodeKeyPair,
+        rewardScript,
         masternodeCollateralKeyPair,
         nMasternodeTier))
     {
@@ -694,6 +726,7 @@ bool CMasternodeBroadcastFactory::Create(
                 CService(strService),
                 masternodeCollateralKeyPair.first,
                 masternodeCollateralKeyPair.second,
+                rewardScript,
                 masternodeKeyPair.first,
                 masternodeKeyPair.second,
                 nMasternodeTier,
@@ -772,19 +805,22 @@ CMasternodePing createDelayedMasternodePing(const CMasternodeBroadcast& mnb)
 } // anonymous namespace
 
 void CMasternodeBroadcastFactory::createWithoutSignatures(
-    CTxIn txin,
-    CService service,
-    CPubKey pubKeyCollateralAddressNew,
-    CPubKey pubKeyMasternodeNew,
+    const CTxIn& txin,
+    const CService& service,
+    const CPubKey& pubKeyCollateralAddressNew,
+    const CScript& rewardScript,
+    const CPubKey& pubKeyMasternodeNew,
     const MasternodeTier nMasternodeTier,
-    bool deferRelay,
+    const bool deferRelay,
     CMasternodeBroadcast& mnbRet)
 {
     LogPrint("masternode", "CMasternodeBroadcastFactory::createWithoutSignatures -- pubKeyCollateralAddressNew = %s, pubKeyMasternodeNew.GetID() = %s\n",
              CBitcoinAddress(pubKeyCollateralAddressNew.GetID()).ToString(),
              pubKeyMasternodeNew.GetID().ToString());
 
-    mnbRet = CMasternodeBroadcast(service, txin, pubKeyCollateralAddressNew, pubKeyMasternodeNew, nMasternodeTier, PROTOCOL_VERSION);
+    mnbRet = CMasternodeBroadcast(service, txin,
+                                  pubKeyCollateralAddressNew, rewardScript, pubKeyMasternodeNew,
+                                  nMasternodeTier, PROTOCOL_VERSION);
     const CMasternodePing mnp = (deferRelay
                                     ? createDelayedMasternodePing(mnbRet)
                                     : CMasternodePing(txin));
@@ -793,22 +829,23 @@ void CMasternodeBroadcastFactory::createWithoutSignatures(
 }
 
 bool CMasternodeBroadcastFactory::Create(
-    CTxIn txin,
-    CService service,
-    CKey keyCollateralAddressNew,
-    CPubKey pubKeyCollateralAddressNew,
-    CKey keyMasternodeNew,
-    CPubKey pubKeyMasternodeNew,
+    const CTxIn& txin,
+    const CService& service,
+    const CKey& keyCollateralAddressNew,
+    const CPubKey& pubKeyCollateralAddressNew,
+    const CScript& rewardScript,
+    const CKey& keyMasternodeNew,
+    const CPubKey& pubKeyMasternodeNew,
     const MasternodeTier nMasternodeTier,
     std::string& strErrorRet,
     CMasternodeBroadcast& mnbRet,
-    bool deferRelay)
+    const bool deferRelay)
 {
     // wait for reindex and/or import to finish
     if (fImporting || fReindex) return false;
 
     createWithoutSignatures(
-        txin,service,pubKeyCollateralAddressNew,pubKeyMasternodeNew,nMasternodeTier,deferRelay,mnbRet);
+        txin,service,pubKeyCollateralAddressNew,rewardScript,pubKeyMasternodeNew,nMasternodeTier,deferRelay,mnbRet);
 
     if(!provideSignatures(keyMasternodeNew,pubKeyMasternodeNew,keyCollateralAddressNew,mnbRet,strErrorRet))
     {
@@ -1031,7 +1068,7 @@ CMasternodePing::CMasternodePing()
     vchSig = std::vector<unsigned char>();
 }
 
-CMasternodePing::CMasternodePing(CTxIn& newVin)
+CMasternodePing::CMasternodePing(const CTxIn& newVin)
 {
     vin = newVin;
     blockHash = chainActive[chainActive.Height() - 12]->GetBlockHash();

divi/src/masternode.h

@@ -59,7 +59,7 @@ class CMasternodePing
     //removed stop
 
     CMasternodePing();
-    CMasternodePing(CTxIn& newVin);
+    CMasternodePing(const CTxIn& newVin);
 
     ADD_SERIALIZE_METHODS;
 
@@ -190,6 +190,7 @@ class CMasternode
     /** Returns the "default" reward script, which is the one
      *  matching the collateral address.  */
     CScript GetDefaultRewardScript() const;
+    static CScript GetDefaultRewardScript(const CPubKey& pubKeyCollateralAddress);
 
     /** Calculates the score of the current masternode, based on the given
      *  seed hash.  It should be the result of GetBlockHashForScoring of
@@ -264,15 +265,20 @@ class CMasternode
 
 class CMasternodeBroadcast : public CMasternode
 {
-public:
-    CMasternodeBroadcast() = default;
+private:
     CMasternodeBroadcast(
-        CService newAddr,
-        CTxIn newVin,
-        CPubKey pubKeyCollateralAddress,
-        CPubKey pubKeyMasternode,
+        const CService& newAddr,
+        const CTxIn& newVin,
+        const CPubKey& pubKeyCollateralAddress,
+        const CScript& rewardScriptIn,
+        const CPubKey& pubKeyMasternode,
         MasternodeTier nMasternodeTier,
         int protocolVersionIn);
+
+    friend class CMasternodeBroadcastFactory;
+
+public:
+    CMasternodeBroadcast() = default;
     CMasternodeBroadcast(const CMasternode& mn);
 
     bool CheckAndUpdate(int& nDoS);
@@ -341,10 +347,11 @@ class CMasternodeBroadcastFactory
                        bool fOffline = false);
 private:
     static void createWithoutSignatures(
-        CTxIn txin,
-        CService service,
-        CPubKey pubKeyCollateralAddressNew,
-        CPubKey pubKeyMasternodeNew,
+        const CTxIn& txin,
+        const CService& service,
+        const CPubKey& pubKeyCollateralAddressNew,
+        const CScript& rewardScript,
+        const CPubKey& pubKeyMasternodeNew,
         MasternodeTier nMasternodeTier,
         bool deferRelay,
         CMasternodeBroadcast& mnbRet);
@@ -367,45 +374,17 @@ class CMasternodeBroadcastFactory
         CMasternodeBroadcast& mnb,
         std::string& strErrorRet);
 
-    static bool Create(CTxIn vin,
-                        CService service,
-                        CKey keyCollateralAddressNew,
-                        CPubKey pubKeyCollateralAddressNew,
-                        CKey keyMasternodeNew,
-                        CPubKey pubKeyMasternodeNew,
-                        MasternodeTier nMasternodeTier,
-                        std::string& strErrorRet,
-                        CMasternodeBroadcast& mnbRet,
-                        bool deferRelay);
-    static bool checkBlockchainSync(std::string& strErrorRet, bool fOffline);
-    static bool setMasternodeKeys(
-        const std::string& strKeyMasternode,
-        std::pair<CKey,CPubKey>& masternodeKeyPair,
-        std::string& strErrorRet);
-    static bool setMasternodeCollateralKeys(
-        const std::string& txHash,
-        const std::string& outputIndex,
-        const std::string& service,
-        bool collateralPrivKeyIsRemote,
-        CTxIn& txin,
-        std::pair<CKey,CPubKey>& masternodeCollateralKeyPair,
-        std::string& error);
-    static bool checkMasternodeCollateral(
-        const CTxIn& txin,
-        const std::string& txHash,
-        const std::string& outputIndex,
-        const std::string& service,
-        MasternodeTier& nMasternodeTier,
-        std::string& strErrorRet);
-    static bool createArgumentsFromConfig(
-        const CMasternodeConfig::CMasternodeEntry configEntry,
-        std::string& strErrorRet,
-        bool fOffline,
-        bool collateralPrivKeyIsRemote,
-        CTxIn& txin,
-        std::pair<CKey,CPubKey>& masternodeKeyPair,
-        std::pair<CKey,CPubKey>& masternodeCollateralKeyPair,
-        MasternodeTier& nMasternodeTier);
+    static bool Create(const CTxIn& vin,
+                       const CService& service,
+                       const CKey& keyCollateralAddressNew,
+                       const CPubKey& pubKeyCollateralAddressNew,
+                       const CScript& rewardScript,
+                       const CKey& keyMasternodeNew,
+                       const CPubKey& pubKeyMasternodeNew,
+                       MasternodeTier nMasternodeTier,
+                       std::string& strErrorRet,
+                       CMasternodeBroadcast& mnbRet,
+                       bool deferRelay);
 };
 
 #endif

divi/src/masternodeconfig.cpp

@@ -15,10 +15,11 @@
 
 CMasternodeConfig masternodeConfig;
 
-void CMasternodeConfig::add(std::string alias, std::string ip, std::string privKey, std::string txHash, std::string outputIndex)
+void CMasternodeConfig::add(const std::string& alias, const std::string& ip, const std::string& privKey,
+                            const std::string& txHash, const std::string& outputIndex,
+                            const std::string& rewardAddr)
 {
-    CMasternodeEntry cme(alias, ip, privKey, txHash, outputIndex);
-    entries.push_back(cme);
+    entries.emplace_back(alias, ip, privKey, txHash, outputIndex, rewardAddr);
 }
 
 bool CMasternodeConfig::read(std::string& strErr)
@@ -62,7 +63,12 @@ bool CMasternodeConfig::read(std::string& strErr)
             }
         }
 
-        add(alias, ip, privKey, txHash, outputIndex);
+        /* This might fail if there is no address, but that is fine and we will
+           just leave the string empty in that case.  */
+        std::string rewardAddr;
+        iss >> rewardAddr;
+
+        add(alias, ip, privKey, txHash, outputIndex, rewardAddr);
     }
 
     streamConfig.close();
@@ -86,15 +92,16 @@ CMasternodeConfig::CMasternodeConfig()
 {
     entries = std::vector<CMasternodeEntry>();
 }
+
 const std::vector<CMasternodeConfig::CMasternodeEntry>& CMasternodeConfig::getEntries() const
 {
     return entries;
 }
 
-int CMasternodeConfig::getCount()
+int CMasternodeConfig::getCount() const
 {
     int c = -1;
-    BOOST_FOREACH (CMasternodeEntry e, entries) {
+    for (const auto& e : entries) {
         if (e.getAlias() != "") c++;
     }
     return c;