[Core][Cleanup] Remove modifier as member of StakeInput objects

random-zebra · random-zebra · commit 4800729caffb · 2020-01-28T15:41:59.000+01:00
Move it to kernel functions. Refactor kernel.cpp / kernel.h
diff --git a/src/kernel.cpp b/src/kernel.cpp
diff --git a/src/kernel.h b/src/kernel.h
@@ -1,47 +1,37 @@
 // Copyright (c) 2011-2013 The PPCoin developers
 // Copyright (c) 2013-2014 The NovaCoin Developers
 // Copyright (c) 2014-2018 The BlackCoin Developers
-// Copyright (c) 2015-2019 The PIVX developers
+// Copyright (c) 2015-2020 The PIVX developers
 // Distributed under the MIT/X11 software license, see the accompanying
 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
-#ifndef BITCOIN_KERNEL_H
-#define BITCOIN_KERNEL_H
+#ifndef PIVX_KERNEL_H
+#define PIVX_KERNEL_H
 
 #include "main.h"
 #include "stakeinput.h"
 
-
-// MODIFIER_INTERVAL: time to elapse before new modifier is computed
-static const unsigned int MODIFIER_INTERVAL = 60;
-
-// MODIFIER_INTERVAL_RATIO:
-// ratio of group interval length between the last group and the first group
-static const int MODIFIER_INTERVAL_RATIO = 3;
-
-// Compute the hash modifier for proof-of-stake
-bool GetKernelStakeModifier(const uint256& hashBlockFrom, uint64_t& nStakeModifier, int& nStakeModifierHeight, int64_t& nStakeModifierTime, bool fPrintProofOfStake);
-bool ComputeNextStakeModifier(const CBlockIndex* pindexPrev, uint64_t& nStakeModifier, bool& fGeneratedStakeModifier);
-uint256 ComputeStakeModifier(const CBlockIndex* pindexPrev, const uint256& kernel);
-bool Stake(const CBlockIndex* pindexPrev, CStakeInput* stakeInput, unsigned int nBits, int64_t& nTimeTx, uint256& hashProofOfStake);
-
+/* PoS Validation */
+bool GetHashProofOfStake(const CBlockIndex* pindexPrev, CStakeInput* stake, const unsigned int nTimeTx, const bool fVerify, uint256& hashProofOfStakeRet);
+bool CheckStakeKernelHash(const CBlockIndex* pindexPrev, const unsigned int nBits, CStakeInput* stake, const unsigned int nTimeTx, uint256& hashProofOfStake, const bool fVerify = false);
+bool CheckProofOfStake(const CBlock& block, uint256& hashProofOfStake, std::unique_ptr<CStakeInput>& stake, int nPreviousBlockHeight);
 // Initialize the stake input object
 bool initStakeInput(const CBlock& block, std::unique_ptr<CStakeInput>& stake, int nPreviousBlockHeight);
+// (New) Stake Modifier
+uint256 ComputeStakeModifier(const CBlockIndex* pindexPrev, const uint256& kernel);
+// Stake (find valid kernel)
+bool Stake(const CBlockIndex* pindexPrev, CStakeInput* stakeInput, unsigned int nBits, int64_t& nTimeTx, uint256& hashProofOfStake);
 
-// Check kernel hash target and coinstake signature
-// Sets hashProofOfStake on success return
-bool CheckProofOfStake(const CBlock& block, uint256& hashProofOfStake, std::unique_ptr<CStakeInput>& stake, int nPreviousBlockHeight);
-bool CheckStakeKernelHash(const CBlockIndex* pindexPrev, const unsigned int nBits, CStakeInput* stake, const unsigned int nTimeTx, uint256& hashProofOfStake, const bool fVerify = false);
-// Returns the proof of stake hash
-bool GetHashProofOfStake(const CBlockIndex* pindexPrev, CStakeInput* stake, const unsigned int nTimeTx, const bool fVerify, uint256& hashProofOfStakeRet);
-// Get stake modifier checksum
-unsigned int GetStakeModifierChecksum(const CBlockIndex* pindex);
-
-// Check stake modifier hard checkpoints
-bool CheckStakeModifierCheckpoints(int nHeight, unsigned int nStakeModifierChecksum);
-
+/* Utils */
 int64_t GetTimeSlot(const int64_t nTime);
 int64_t GetCurrentTimeSlot();
 uint32_t ParseAccChecksum(uint256 nCheckpoint, const libzerocoin::CoinDenomination denom);
 
-#endif // BITCOIN_KERNEL_H
+
+/* Old Stake Modifier */
+unsigned int GetStakeModifierChecksum(const CBlockIndex* pindex);
+bool GetOldStakeModifier(CStakeInput* stake, uint64_t& nStakeModifier);
+bool GetOldModifier(const uint256& hashBlockFrom, uint64_t& nStakeModifier);
+bool ComputeNextStakeModifier(const CBlockIndex* pindexPrev, uint64_t& nStakeModifier, bool& fGeneratedStakeModifier);
+
+#endif // PIVX_KERNEL_H
diff --git a/src/main.cpp b/src/main.cpp
@@ -4128,8 +4128,6 @@ CBlockIndex* AddToBlockIndex(const CBlock& block)
                 LogPrintf("AddToBlockIndex() : ComputeNextStakeModifier() failed \n");
             pindexNew->SetStakeModifier(nStakeModifier, fGeneratedStakeModifier);
             pindexNew->nStakeModifierChecksum = GetStakeModifierChecksum(pindexNew);
-            if (!CheckStakeModifierCheckpoints(pindexNew->nHeight, pindexNew->nStakeModifierChecksum))
-                LogPrintf("AddToBlockIndex() : Rejected by stake modifier checkpoint height=%d, modifier=%s \n", pindexNew->nHeight, std::to_string(nStakeModifier));
         } else {
             // compute v2 stake modifier
             pindexNew->nStakeModifierV2 = ComputeStakeModifier(pindexNew->pprev, block.vtx[1].vin[0].prevout.hash);
diff --git a/src/stakeinput.cpp b/src/stakeinput.cpp
@@ -83,21 +83,6 @@ bool CPivStake::CreateTxOuts(CWallet* pwallet, std::vector<CTxOut>& vout, CAmoun
     return true;
 }
 
-bool CPivStake::GetModifier(uint64_t& nStakeModifier)
-{
-    if (this->nStakeModifier == 0) {
-        // look for the modifier
-        GetIndexFrom();
-        if (!pindexFrom)
-            return error("%s: failed to get index from", __func__);
-        // TODO: This method must be removed from here in the short terms.. it's a call to an static method in kernel.cpp when this class method is only called from kernel.cpp, no comments..
-        if (!GetKernelStakeModifier(pindexFrom->GetBlockHash(), this->nStakeModifier, this->nStakeModifierHeight, this->nStakeModifierTime, false))
-            return error("CheckStakeKernelHash(): failed to get kernel stake modifier");
-    }
-    nStakeModifier = this->nStakeModifier;
-    return true;
-}
-
 CDataStream CPivStake::GetUniqueness() const
 {
     //The unique identifier for a PIV stake is the outpoint
diff --git a/src/stakeinput.h b/src/stakeinput.h
@@ -25,7 +25,6 @@ class CStakeInput
     virtual bool GetTxFrom(CTransaction& tx) const = 0;
     virtual CAmount GetValue() const = 0;
     virtual bool CreateTxOuts(CWallet* pwallet, std::vector<CTxOut>& vout, CAmount nTotal) = 0;
-    virtual bool GetModifier(uint64_t& nStakeModifier) = 0;
     virtual bool IsZPIV() const = 0;
     virtual CDataStream GetUniqueness() const = 0;
 
@@ -37,10 +36,6 @@ class CPivStake : public CStakeInput
     CTransaction txFrom;
     unsigned int nPosition;
 
-    // cached data
-    uint64_t nStakeModifier = 0;
-    int nStakeModifierHeight = 0;
-    int64_t nStakeModifierTime = 0;
 public:
     CPivStake(){}
 
@@ -49,7 +44,6 @@ class CPivStake : public CStakeInput
     CBlockIndex* GetIndexFrom() override;
     bool GetTxFrom(CTransaction& tx) const override;
     CAmount GetValue() const override;
-    bool GetModifier(uint64_t& nStakeModifier) override;
     CDataStream GetUniqueness() const override;
     bool CreateTxIn(CWallet* pwallet, CTxIn& txIn, uint256 hashTxOut = 0) override;
     bool CreateTxOuts(CWallet* pwallet, std::vector<CTxOut>& vout, CAmount nTotal) override;
diff --git a/src/wallet/wallet.cpp b/src/wallet/wallet.cpp
@@ -2613,7 +2613,7 @@ bool CWallet::CreateCoinStake(
 
         // This should never happen
         if (stakeInput->IsZPIV()) {
-            LogPrintf("%s: ERROR - zPOS is disabled\n");
+            LogPrintf("%s: ERROR - zPOS is disabled\n", __func__);
             continue;
         }
 
diff --git a/src/zpiv/zpos.cpp b/src/zpiv/zpos.cpp
@@ -53,30 +53,6 @@ CAmount CLegacyZPivStake::GetValue() const
     return denom * COIN;
 }
 
-bool CLegacyZPivStake::GetModifier(uint64_t& nStakeModifier)
-{
-    CBlockIndex* pindex = GetIndexFrom();
-    if (!pindex)
-        return error("%s: failed to get index from", __func__);
-
-    if(Params().IsRegTestNet()) {
-        nStakeModifier = 0;
-        return true;
-    }
-
-    int64_t nTimeBlockFrom = pindex->GetBlockTime();
-    const int nHeightStop = std::min(chainActive.Height(), Params().Zerocoin_Block_Last_Checkpoint()-1);
-    while (pindex && pindex->nHeight + 1 <= nHeightStop) {
-        if (pindex->GetBlockTime() - nTimeBlockFrom > 60 * 60) {
-            nStakeModifier = pindex->nAccumulatorCheckpoint.Get64();
-            return true;
-        }
-        pindex = chainActive.Next(pindex);
-    }
-
-    return false;
-}
-
 CDataStream CLegacyZPivStake::GetUniqueness() const
 {
     CDataStream ss(SER_GETHASH, 0);
diff --git a/src/zpiv/zpos.h b/src/zpiv/zpos.h
@@ -23,7 +23,6 @@ class CLegacyZPivStake : public CStakeInput
     uint32_t GetChecksum() const { return nChecksum; }
     CBlockIndex* GetIndexFrom() override;
     CAmount GetValue() const override;
-    bool GetModifier(uint64_t& nStakeModifier) override;
     CDataStream GetUniqueness() const override;
     bool CreateTxIn(CWallet* pwallet, CTxIn& txIn, uint256 hashTxOut = 0) override { return false; /* creation disabled */}
     bool CreateTxOuts(CWallet* pwallet, std::vector<CTxOut>& vout, CAmount nTotal) override { return false; /* creation disabled */}

Original file line number	Diff line number	Diff line change
`@@ -2613,7 +2613,7 @@ bool CWallet::CreateCoinStake(`
`2613`	`2613`
`2614`	`2614`	`// This should never happen`
`2615`	`2615`	`if (stakeInput->IsZPIV()) {`
`2616`		`- LogPrintf("%s: ERROR - zPOS is disabled\n");`
	`2616`	`+ LogPrintf("%s: ERROR - zPOS is disabled\n", __func__);`
`2617`	`2617`	`continue;`
`2618`	`2618`	`}`
`2619`	`2619`