Refactor CBlockIndex::cpid from uint128 to NN::Cpid

The upgrade of uint256.h from Bitcoin removes the uint128 type. This
replaces the uint128 "cpid" field on CBlockIndex with NN::Cpid.

Author: cyrossignol

src/main.cpp

@@ -20,7 +20,6 @@
 #include "rpcclient.h"
 #include "beacon.h"
 #include "miner.h"
-#include "neuralnet/cpid.h"
 #include "neuralnet/neuralnet.h"
 #include "neuralnet/researcher.h"
 #include "neuralnet/superblock.h"
@@ -2736,7 +2735,7 @@ bool CBlock::ConnectBlock(CTxDB& txdb, CBlockIndex* pindex, bool fJustCheck, boo
     // Gridcoin: Store verified magnitude and CPID in block index (7-11-2015)
     if(IsResearchAgeEnabled(pindex->nHeight))
     {
-        pindex->SetCPID(bb.cpid);
+        pindex->SetMiningId(NN::MiningId::Parse(bb.cpid));
         pindex->nMagnitude = bb.Magnitude;
         pindex->nResearchSubsidy = bb.ResearchSubsidy;
         pindex->nInterestSubsidy = bb.InterestSubsidy;
@@ -2827,7 +2826,7 @@ bool CBlock::ConnectBlock(CTxDB& txdb, CBlockIndex* pindex, bool fJustCheck, boo
 
                 if(!is_claim_valid(nStakeReward, OUT_POR, OUT_INTEREST, nFees))
                 {
-                    GetLifetimeCPID(pindex->GetCPID()); // Rescan...
+                    GetLifetimeCPID(pindex->GetMiningId().ToString()); // Rescan...
                     GetProofOfStakeReward(nCoinAge, nFees, bb.cpid, true, 2, nTime,
                                           pindex, "connectblock_researcher_doublecheck", OUT_POR, OUT_INTEREST, dAccrualAge, dMagnitudeUnit, dAvgMagnitude);
 
@@ -3102,9 +3101,9 @@ bool DisconnectBlocksBatch(CTxDB& txdb, list<CTransaction>& vResurrect, unsigned
         if(pindexBest->IsUserCPID())
         {
             // remeber the cpid to re-read later
-            vRereadCPIDs.insert(pindexBest->GetCPID());
+            vRereadCPIDs.insert(pindexBest->GetMiningId().ToString());
             // The user has no longer staked this block.
-            RemoveCPIDBlockHash(pindexBest->GetCPID(), pindexBest);
+            RemoveCPIDBlockHash(pindexBest->GetMiningId().ToString(), pindexBest);
         }
 
         // New best block
@@ -3344,7 +3343,7 @@ bool ReorganizeChain(CTxDB& txdb, unsigned &cnt_dis, unsigned &cnt_con, CBlock &
         }
 
         if(pindex->IsUserCPID()) // is this needed?
-            GetLifetimeCPID(pindex->cpid.GetHex());
+            GetLifetimeCPID(pindex->GetMiningId().ToString());
     }
 
     if (fDebug && (cnt_dis>0 || cnt_con>1))
@@ -4700,7 +4699,7 @@ void AddResearchMagnitude(CBlockIndex* pIndex)
 
     try
     {
-        const std::string& cpid = pIndex->GetCPID();
+        const std::string& cpid = pIndex->GetMiningId().ToString();
         StructCPID& stMag = GetInitializedStructCPID2(cpid, mvMagnitudesCopy);
         stMag.InterestSubsidy += pIndex->nInterestSubsidy;
         stMag.ResearchSubsidy += pIndex->nResearchSubsidy;
@@ -4783,7 +4782,7 @@ bool GetEarliestStakeTime(std::string grcaddress, std::string cpid)
                         }
                         else
                         {
-                            myCPID = pblockindex->GetCPID();
+                            myCPID = pblockindex->GetMiningId().ToString();
                         }
                         if (cpid == myCPID && nCPIDTime==0 && IsResearcher(myCPID))
                         {
@@ -4817,7 +4816,7 @@ void AddRARewardBlock(const CBlockIndex* pindex)
     // this is from LoadBlockIndex
     if (pindex->nResearchSubsidy > 0 && pindex->IsUserCPID())
     {
-        const std::string& cpid = pindex->GetCPID();
+        const std::string& cpid = pindex->GetMiningId().ToString();
 
         StructCPID& stCPID = GetInitializedStructCPID2(cpid,mvResearchAge);
 
@@ -4865,7 +4864,7 @@ void RescanLifetimeCPID(StructCPID& stCPID)
         // Ensure that the block is valid
         if(pblockindex == NULL ||
            pblockindex->IsInMainChain() == false ||
-           pblockindex->GetCPID() != stCPID.cpid)
+           pblockindex->GetMiningId().ToString() != stCPID.cpid)
             throw error("RescanLifetimeCPID: Invalid block %s in vRewardBlocs of %s", pblockindex? pblockindex->GetBlockHash().GetHex() :"null", stCPID.cpid );
 
         const uint256& uHash = pblockindex->GetBlockHash();

src/main.h

@@ -8,6 +8,7 @@
 #include "arith_uint256.h"
 #include "util.h"
 #include "net.h"
+#include "neuralnet/cpid.h"
 #include "sync.h"
 #include "script.h"
 #include "scrypt.h"
@@ -1324,7 +1325,7 @@ class CBlockIndex
     int64_t nMint;
     int64_t nMoneySupply;
 	// Gridcoin (7-11-2015) Add new Accrual Fields to block index
-    uint128 cpid;
+    NN::Cpid cpid;
 	double nResearchSubsidy;
 	double nInterestSubsidy;
 	double nMagnitude;
@@ -1515,27 +1516,39 @@ class CBlockIndex
             nFlags |= BLOCK_STAKE_MODIFIER;
     }
 
-    void SetCPID(const std::string& cpid_hex)
+    void SetMiningId(NN::MiningId mining_id)
     {
-        // Clear current CPID state.
-        cpid = 0;
         nFlags &= ~(EMPTY_CPID | INVESTOR_CPID);
-        if(cpid_hex.empty())
+
+        if (const auto cpid_option = mining_id.TryCpid()) {
+            cpid = *cpid_option;
+            return;
+        }
+
+        cpid = NN::Cpid();
+
+        if (mining_id.Which() == NN::MiningId::Kind::INVALID) {
             nFlags |= EMPTY_CPID;
-        else if(cpid_hex == "INVESTOR")
+        } else {
             nFlags |= INVESTOR_CPID;
-        else
-            cpid.SetHex(cpid_hex);
+        }
+    }
+
+    void SetCPID(NN::Cpid new_cpid)
+    {
+        nFlags &= ~(EMPTY_CPID | INVESTOR_CPID);
+
+        cpid = new_cpid;
     }
 
-    std::string GetCPID() const
+    NN::MiningId GetMiningId() const
     {
-        if(nFlags & EMPTY_CPID)
-            return "";
-        else if(nFlags & INVESTOR_CPID)
-            return "INVESTOR";
+        if (nFlags & EMPTY_CPID)
+            return NN::MiningId();
+        else if (nFlags & INVESTOR_CPID)
+            return NN::MiningId::ForInvestor();
         else
-            return cpid.GetHex();
+            return NN::MiningId(cpid);
     }
 
 
@@ -1621,11 +1634,11 @@ class CDiskBlockIndex : public CBlockIndex
         READWRITE(blockHash);
 
         //7-11-2015 - Gridcoin - New Accrual Fields (Note, Removing the determinstic block number to make this happen all the time):
-        std::string cpid_hex = GetCPID();
+        std::string cpid_hex = GetMiningId().ToString();
         READWRITE(cpid_hex);
 
         if (ser_action.ForRead()) {
-            const_cast<CDiskBlockIndex*>(this)->SetCPID(cpid_hex);
+            const_cast<CDiskBlockIndex*>(this)->SetMiningId(NN::MiningId::Parse(cpid_hex));
         }
 
         READWRITE(nResearchSubsidy);

src/rpcblockchain.cpp

@@ -1188,7 +1188,7 @@ UniValue lifetime(const UniValue& params, bool fHelp)
     UniValue c(UniValue::VOBJ);
     UniValue res(UniValue::VOBJ);
 
-    std::string cpid = NN::GetPrimaryCpid();
+    const NN::MiningId mining_id = NN::Researcher::Get()->Id();
     std::string Narr = ToString(GetAdjustedTime());
 
     c.pushKV("Lifetime Payments Report", Narr);
@@ -1208,11 +1208,11 @@ UniValue lifetime(const UniValue& params, bool fHelp)
         if (pindex == pindexBest)
             break;
 
-        if (pindex->GetCPID() == cpid && (pindex->nResearchSubsidy > 0))
+        if (pindex->GetMiningId() == mining_id && (pindex->nResearchSubsidy > 0))
             res.pushKV(ToString(pindex->nHeight), RoundToString(pindex->nResearchSubsidy, 2));
     }
     //8-14-2015
-    StructCPID& stCPID = GetInitializedStructCPID2(cpid, mvResearchAge);
+    StructCPID& stCPID = GetInitializedStructCPID2(mining_id.ToString(), mvResearchAge);
 
     res.pushKV("RA Magnitude Sum", stCPID.TotalMagnitude);
     res.pushKV("RA Accuracy", stCPID.Accuracy);

src/rpcdataacq.cpp

@@ -399,7 +399,7 @@ UniValue rpc_getsupervotes(const UniValue& params, bool fHelp)
             UniValue result2(UniValue::VOBJ);
             result2.pushKV("neuralhash", bb.NeuralHash );
             result2.pushKV("weight", weight );
-            result2.pushKV("cpid", cur->GetCPID() );
+            result2.pushKV("cpid", cur->GetMiningId().ToString() );
             result2.pushKV("organization", bb.Organization );
             result2.pushKV("cversion", bb.clientversion );
             if(mode>=2)
@@ -672,7 +672,7 @@ UniValue rpc_getrecentblocks(const UniValue& params, bool fHelp)
 
             if(detail>=2 && detail<20)
             {
-                line+="<|>"+cur->GetCPID()
+                line+="<|>"+cur->GetMiningId().ToString()
                     + "<|>"+RoundToString(cur->nResearchSubsidy,4)
                     + "<|>"+RoundToString(cur->nInterestSubsidy,4);
             }
@@ -685,7 +685,7 @@ UniValue rpc_getrecentblocks(const UniValue& params, bool fHelp)
             result2.pushKV("issuperblock", (bool)cur->nIsSuperBlock );
             result2.pushKV("iscontract", (bool)cur->nIsContract );
             result2.pushKV("ismodifier", (bool)cur->GeneratedStakeModifier() );
-            result2.pushKV("cpid", cur->GetCPID() );
+            result2.pushKV("cpid", cur->GetMiningId().ToString() );
             result2.pushKV("research", cur->nResearchSubsidy );
             result2.pushKV("interest", cur->nInterestSubsidy );
             result2.pushKV("magnitude", cur->nMagnitude );

src/txdb-leveldb.cpp

@@ -626,19 +626,19 @@ bool CTxDB::LoadBlockIndex()
         if(!IsResearchAgeEnabled(pindex->nHeight))
             continue;
 
-        if( pindex->IsUserCPID() && pindex->cpid == uint128() )
+        if( pindex->IsUserCPID() && pindex->cpid.IsZero() )
         {
             /* There were reports of 0000 cpid in index where INVESTOR should have been. Check */
             auto bb = GetBoincBlockByIndex(pindex);
-            if( bb.cpid != pindex->GetCPID() )
+            if( bb.cpid != pindex->GetMiningId().ToString() )
             {
                 if(fDebug)
                     LogPrintf("WARNING: BlockIndex CPID %s did not match %s in block {%s %d}",
-                              pindex->GetCPID(), bb.cpid,
+                              pindex->GetMiningId().ToString(), bb.cpid,
                               pindex->GetBlockHash().GetHex(), pindex->nHeight );
 
                 /* Repair the cpid field */
-                pindex->SetCPID(bb.cpid);
+                pindex->SetMiningId(NN::MiningId::Parse(bb.cpid));
 
 #if 0
                 if(!WriteBlockIndex(CDiskBlockIndex(pindex)))