chain.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2014 The Bitcoin developers
// Copyright (c) 2011-2013 The PPCoin developers
// Copyright (c) 2013-2014 The NovaCoin Developers
// Copyright (c) 2014-2018 The BlackCoin Developers
// Copyright (c) 2015-2021 The PIVX Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef PIVX_CHAIN_H
#define PIVX_CHAIN_H
 
#include "chainparams.h"
#include "flatfile.h"
#include "optional.h"
#include "primitives/block.h"
#include "timedata.h"
#include "tinyformat.h"
#include "uint256.h"
#include "util/system.h"
#include "libzerocoin/Denominations.h"
 
#include <vector>
 
static constexpr int64_t TIMESTAMP_WINDOW = 2 * 60 * 60;
 
class CBlockFileInfo
{
public:
    unsigned int nBlocks;      
    unsigned int nSize;        
    unsigned int nUndoSize;    
    unsigned int nHeightFirst; 
    unsigned int nHeightLast;  
    uint64_t nTimeFirst;       
    uint64_t nTimeLast;        
 
    SERIALIZE_METHODS(CBlockFileInfo, obj)
    {
        READWRITE(VARINT(obj.nBlocks));
        READWRITE(VARINT(obj.nSize));
        READWRITE(VARINT(obj.nUndoSize));
        READWRITE(VARINT(obj.nHeightFirst));
        READWRITE(VARINT(obj.nHeightLast));
        READWRITE(VARINT(obj.nTimeFirst));
        READWRITE(VARINT(obj.nTimeLast));
    }
 
    void SetNull()
    {
        nBlocks = 0;
        nSize = 0;
        nUndoSize = 0;
        nHeightFirst = 0;
        nHeightLast = 0;
        nTimeFirst = 0;
        nTimeLast = 0;
    }
 
    CBlockFileInfo()
    {
        SetNull();
    }
 
    std::string ToString() const;
 
    void AddBlock(unsigned int nHeightIn, uint64_t nTimeIn)
    {
        if (nBlocks == 0 || nHeightFirst > nHeightIn)
            nHeightFirst = nHeightIn;
        if (nBlocks == 0 || nTimeFirst > nTimeIn)
            nTimeFirst = nTimeIn;
        nBlocks++;
        if (nHeightIn > nHeightLast)
            nHeightLast = nHeightIn;
        if (nTimeIn > nTimeLast)
            nTimeLast = nTimeIn;
    }
};
 
enum BlockStatus {
    BLOCK_VALID_UNKNOWN = 0,
 
    BLOCK_VALID_HEADER = 1,
 
    BLOCK_VALID_TREE = 2,
 
    BLOCK_VALID_TRANSACTIONS = 3,
 
    BLOCK_VALID_CHAIN = 4,
 
    BLOCK_VALID_SCRIPTS = 5,
 
    BLOCK_VALID_MASK = BLOCK_VALID_HEADER | BLOCK_VALID_TREE | BLOCK_VALID_TRANSACTIONS |
                       BLOCK_VALID_CHAIN |
                       BLOCK_VALID_SCRIPTS,
 
    BLOCK_HAVE_DATA = 8,  
    BLOCK_HAVE_UNDO = 16, 
    BLOCK_HAVE_MASK = BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO,
 
    BLOCK_FAILED_VALID = 32, 
    BLOCK_FAILED_CHILD = 64, 
    BLOCK_FAILED_MASK = BLOCK_FAILED_VALID | BLOCK_FAILED_CHILD,
};
 
// BlockIndex flags
enum {
    BLOCK_PROOF_OF_STAKE = (1 << 0), // is proof-of-stake block
    BLOCK_STAKE_ENTROPY = (1 << 1),  // entropy bit for stake modifier
    BLOCK_STAKE_MODIFIER = (1 << 2), // regenerated stake modifier
};
 
class CBlockIndex
{
public:
    const uint256* phashBlock{nullptr};
 
    CBlockIndex* pprev{nullptr};
 
    CBlockIndex* pskip{nullptr};
 
    int nHeight{0};
 
    int nFile{0};
 
    unsigned int nDataPos{0};
 
    unsigned int nUndoPos{0};
 
    arith_uint256 nChainWork{};
 
    unsigned int nTx{0};
 
    unsigned int nChainTx{0};
 
    uint32_t nStatus{0};
 
    // proof-of-stake specific fields
    // char vector holding the stake modifier bytes. It is empty for PoW blocks.
    // Modifier V1 is 64 bit while modifier V2 is 256 bit.
    std::vector<unsigned char> vStakeModifier{};
    unsigned int nFlags{0};
 
    CAmount nSaplingValue{0};
 
   Optional<CAmount> nChainSaplingValue{nullopt};
 
    int32_t nVersion{0};
    uint256 hashMerkleRoot{};
    uint256 hashFinalSaplingRoot{};
    uint32_t nTime{0};
    uint32_t nBits{0};
    uint32_t nNonce{0};
    uint256 nAccumulatorCheckpoint{};
 
    uint32_t nSequenceId{0};
 
    unsigned int nTimeMax{0};
 
    CBlockIndex() {}
    explicit CBlockIndex(const CBlock& block);
 
    std::string ToString() const;
 
    FlatFilePos GetBlockPos() const;
    FlatFilePos GetUndoPos() const;
    CBlockHeader GetBlockHeader() const;
    uint256 GetBlockHash() const { return *phashBlock; }
    int64_t GetBlockTime() const { return (int64_t)nTime; }
    int64_t GetBlockTimeMax() const { return (int64_t)nTimeMax; }
 
    int64_t GetMedianTimePast() const;
 
    int64_t MaxFutureBlockTime() const;
    int64_t MinPastBlockTime() const;
 
    bool IsProofOfStake() const { return (nFlags & BLOCK_PROOF_OF_STAKE); }
    bool IsProofOfWork() const { return !IsProofOfStake(); }
    void SetProofOfStake() { nFlags |= BLOCK_PROOF_OF_STAKE; }
 
    // Stake Modifier
    unsigned int GetStakeEntropyBit() const;
    bool SetStakeEntropyBit(unsigned int nEntropyBit);
    bool GeneratedStakeModifier() const { return (nFlags & BLOCK_STAKE_MODIFIER); }
    void SetStakeModifier(const uint64_t nStakeModifier, bool fGeneratedStakeModifier);
    void SetNewStakeModifier();                             // generates and sets new v1 modifier
    void SetStakeModifier(const uint256& nStakeModifier);
    void SetNewStakeModifier(const uint256& prevoutId);     // generates and sets new v2 modifier
    uint64_t GetStakeModifierV1() const;
    uint256 GetStakeModifierV2() const;
 
    // Update Sapling chain value
    void SetChainSaplingValue();
 
    bool IsValid(enum BlockStatus nUpTo = BLOCK_VALID_TRANSACTIONS) const;
    bool RaiseValidity(enum BlockStatus nUpTo);
    void BuildSkip();
    CBlockIndex* GetAncestor(int height);
    const CBlockIndex* GetAncestor(int height) const;
};
 
const CBlockIndex* LastCommonAncestor(const CBlockIndex* pa, const CBlockIndex* pb);
 
// New serialization introduced with 4.0.99
static const int DBI_OLD_SER_VERSION = 4009900;
static const int DBI_SER_VERSION_NO_ZC = 4009902;   // removes mapZerocoinSupply, nMoneySupply
 
class CDiskBlockIndex : public CBlockIndex
{
public:
    uint256 hashPrev;
 
    CDiskBlockIndex()
    {
        hashPrev = UINT256_ZERO;
    }
 
    explicit CDiskBlockIndex(const CBlockIndex* pindex) : CBlockIndex(*pindex)
    {
        hashPrev = (pprev ? pprev->GetBlockHash() : UINT256_ZERO);
    }
 
    SERIALIZE_METHODS(CDiskBlockIndex, obj)
    {
        int nSerVersion = s.GetVersion();
        if (!(s.GetType() & SER_GETHASH)) READWRITE(VARINT_MODE(nSerVersion, VarIntMode::NONNEGATIVE_SIGNED));
 
        READWRITE(VARINT_MODE(obj.nHeight, VarIntMode::NONNEGATIVE_SIGNED));
        READWRITE(VARINT(obj.nStatus));
        READWRITE(VARINT(obj.nTx));
        if (obj.nStatus & (BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO)) READWRITE(VARINT_MODE(obj.nFile, VarIntMode::NONNEGATIVE_SIGNED));
        if (obj.nStatus & BLOCK_HAVE_DATA) READWRITE(VARINT(obj.nDataPos));
        if (obj.nStatus & BLOCK_HAVE_UNDO) READWRITE(VARINT(obj.nUndoPos));
 
        if (nSerVersion >= DBI_SER_VERSION_NO_ZC) {
            // Serialization with CLIENT_VERSION = 4009902+
            READWRITE(obj.nFlags);
            READWRITE(obj.nVersion);
            READWRITE(obj.vStakeModifier);
            READWRITE(obj.hashPrev);
            READWRITE(obj.hashMerkleRoot);
            READWRITE(obj.nTime);
            READWRITE(obj.nBits);
            READWRITE(obj.nNonce);
            if(obj.nVersion > 3 && obj.nVersion < 7)
                READWRITE(obj.nAccumulatorCheckpoint);
 
            // Sapling blocks
            if (obj.nVersion >= 8) {
                READWRITE(obj.hashFinalSaplingRoot);
                READWRITE(obj.nSaplingValue);
            }
        } else if (nSerVersion > DBI_OLD_SER_VERSION && ser_action.ForRead()) {
            // Serialization with CLIENT_VERSION = 4009901
            std::map<libzerocoin::CoinDenomination, int64_t> mapZerocoinSupply;
            int64_t nMoneySupply = 0;
            READWRITE(nMoneySupply);
            READWRITE(obj.nFlags);
            READWRITE(obj.nVersion);
            READWRITE(obj.vStakeModifier);
            READWRITE(obj.hashPrev);
            READWRITE(obj.hashMerkleRoot);
            READWRITE(obj.nTime);
            READWRITE(obj.nBits);
            READWRITE(obj.nNonce);
            if (obj.nVersion > 3) {
                READWRITE(mapZerocoinSupply);
                if (obj.nVersion < 7) READWRITE(obj.nAccumulatorCheckpoint);
            }
        } else if (ser_action.ForRead()) {
            // Serialization with CLIENT_VERSION = 4009900-
            int64_t nMint = 0;
            uint256 hashNext{};
            int64_t nMoneySupply = 0;
            READWRITE(nMint);
            READWRITE(nMoneySupply);
            READWRITE(obj.nFlags);
            if (!Params().GetConsensus().NetworkUpgradeActive(obj.nHeight, Consensus::UPGRADE_V3_4)) {
                uint64_t nStakeModifier = 0;
                READWRITE(nStakeModifier);
                SER_READ(obj, obj.SetStakeModifier(nStakeModifier, obj.GeneratedStakeModifier()));
            } else {
                uint256 nStakeModifierV2;
                READWRITE(nStakeModifierV2);
                SER_READ(obj, obj.SetStakeModifier(nStakeModifierV2));
            }
            if (obj.IsProofOfStake()) {
                COutPoint prevoutStake;
                unsigned int nStakeTime = 0;
                READWRITE(prevoutStake);
                READWRITE(nStakeTime);
            }
            READWRITE(obj.nVersion);
            READWRITE(obj.hashPrev);
            READWRITE(hashNext);
            READWRITE(obj.hashMerkleRoot);
            READWRITE(obj.nTime);
            READWRITE(obj.nBits);
            READWRITE(obj.nNonce);
            if (obj.nVersion > 3) {
                std::map<libzerocoin::CoinDenomination, int64_t> mapZerocoinSupply;
                std::vector<libzerocoin::CoinDenomination> vMintDenominationsInBlock;
                READWRITE(obj.nAccumulatorCheckpoint);
                READWRITE(mapZerocoinSupply);
                READWRITE(vMintDenominationsInBlock);
            }
        }
    }
 
    uint256 GetBlockHash() const
    {
        CBlockHeader block;
        block.nVersion = nVersion;
        block.hashPrevBlock = hashPrev;
        block.hashMerkleRoot = hashMerkleRoot;
        block.nTime = nTime;
        block.nBits = nBits;
        block.nNonce = nNonce;
        if (nVersion > 3 && nVersion < 7)
            block.nAccumulatorCheckpoint = nAccumulatorCheckpoint;
        if (nVersion >= 8)
            block.hashFinalSaplingRoot = hashFinalSaplingRoot;
        return block.GetHash();
    }
 
 
    std::string ToString() const
    {
        return strprintf("CDiskBlockIndex(%s\n                hashBlock=%s, hashPrev=%s)",
                CBlockIndex::ToString(),
                GetBlockHash().ToString(),
                hashPrev.ToString());
    }
};
 
class CChain
{
private:
    std::vector<CBlockIndex*> vChain;
 
public:
    CBlockIndex* Genesis() const
    {
        return vChain.size() > 0 ? vChain[0] : nullptr;
    }
 
    CBlockIndex* Tip(bool fProofOfStake = false) const
    {
        if (vChain.size() < 1)
            return nullptr;
 
        CBlockIndex* pindex = vChain[vChain.size() - 1];
 
        if (fProofOfStake) {
            while (pindex && pindex->pprev && !pindex->IsProofOfStake())
                pindex = pindex->pprev;
        }
        return pindex;
    }
 
    CBlockIndex* operator[](int nHeight) const
    {
        if (nHeight < 0 || nHeight >= (int)vChain.size())
            return nullptr;
        return vChain[nHeight];
    }
 
    friend bool operator==(const CChain& a, const CChain& b)
    {
        return a.vChain.size() == b.vChain.size() &&
               a.vChain[a.vChain.size() - 1] == b.vChain[b.vChain.size() - 1];
    }
 
    bool Contains(const CBlockIndex* pindex) const
    {
        return (*this)[pindex->nHeight] == pindex;
    }
 
    CBlockIndex* Next(const CBlockIndex* pindex) const
    {
        if (Contains(pindex))
            return (*this)[pindex->nHeight + 1];
        else
            return nullptr;
    }
 
    int Height() const
    {
        return vChain.size() - 1;
    }
 
    void SetTip(CBlockIndex* pindex);
 
    CBlockLocator GetLocator(const CBlockIndex* pindex = nullptr) const;
 
    const CBlockIndex* FindFork(const CBlockIndex* pindex) const;
 
    CBlockIndex* FindEarliestAtLeast(int64_t nTime) const;
};
 
#endif // PIVX_CHAIN_H