chain.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2014 The Bitcoin developers
// Copyright (c) 2015-2018 The PIVX developers
// Copyright (c) 2018-2020 The DAPS Project developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_CHAIN_H
#define BITCOIN_CHAIN_H
 
#include "primitives/block.h"
#include "tinyformat.h"
#include "uint256.h"
#include "util.h"
 
#include <vector>
 
class CBlockFileInfo
{
public:
    unsigned int nBlocks;      
    unsigned int nSize;        
    unsigned int nUndoSize;    
    unsigned int nHeightFirst; 
    unsigned int nHeightLast;  
    uint64_t nTimeFirst;       
    uint64_t nTimeLast;        
 
    ADD_SERIALIZE_METHODS;
 
    template <typename Stream, typename Operation>
    inline void SerializationOp(Stream& s, Operation ser_action, int nType, int nVersion)
    {
        READWRITE(VARINT(nBlocks));
        READWRITE(VARINT(nSize));
        READWRITE(VARINT(nUndoSize));
        READWRITE(VARINT(nHeightFirst));
        READWRITE(VARINT(nHeightLast));
        READWRITE(VARINT(nTimeFirst));
        READWRITE(VARINT(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;
    }
};
 
struct CDiskBlockPos {
    int nFile;
    unsigned int nPos;
 
    ADD_SERIALIZE_METHODS;
 
    template <typename Stream, typename Operation>
    inline void SerializationOp(Stream& s, Operation ser_action, int nType, int nVersion)
    {
        READWRITE(VARINT(nFile));
        READWRITE(VARINT(nPos));
    }
 
    CDiskBlockPos()
    {
        SetNull();
    }
 
    CDiskBlockPos(int nFileIn, unsigned int nPosIn)
    {
        nFile = nFileIn;
        nPos = nPosIn;
    }
 
    friend bool operator==(const CDiskBlockPos& a, const CDiskBlockPos& b)
    {
        return (a.nFile == b.nFile && a.nPos == b.nPos);
    }
 
    friend bool operator!=(const CDiskBlockPos& a, const CDiskBlockPos& b)
    {
        return !(a == b);
    }
 
    void SetNull()
    {
        nFile = -1;
        nPos = 0;
    }
    bool IsNull() const { return (nFile == -1); }
};
 
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,
};
 
class CBlockIndex
{
public:
    const uint256* phashBlock;
 
    CBlockIndex* pprev;
 
    CBlockIndex* pnext;
 
    CBlockIndex* pskip;
 
    //ppcoin: trust score of block chain
    uint256 bnChainTrust;
 
    int nHeight;
 
    int nFile;
 
    unsigned int nDataPos;
 
    unsigned int nUndoPos;
 
    uint256 nChainWork;
 
    unsigned int nTx;
 
    unsigned int nChainTx;
 
    unsigned int nStatus;
 
    unsigned int nFlags; // ppcoin: block index 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
        BLOCK_PROOF_OF_AUDIT = (1 << 3), //Added for PoA blocks
    };
 
    // proof-of-stake specific fields
    uint256 GetBlockTrust() const;
    uint64_t nStakeModifier;             // hash modifier for proof-of-stake
    unsigned int nStakeModifierChecksum; // checksum of index; in-memeory only
    COutPoint prevoutStake;
    unsigned int nStakeTime;
    uint256 hashProofOfStake;
    int64_t nMint;
    int64_t nMoneySupply;
 
    int nVersion;
    uint256 hashMerkleRoot;
    unsigned int nTime;
    unsigned int nBits;
    unsigned int nNonce;
    uint256 nAccumulatorCheckpoint;
 
    uint256 hashPoAMerkleRoot;
    uint256 minedHash;
    uint256 hashPrevPoABlock;
 
    uint32_t nSequenceId;
    
    void SetNull()
    {
        phashBlock = NULL;
        pprev = NULL;
        pskip = NULL;
        nHeight = 0;
        nFile = 0;
        nDataPos = 0;
        nUndoPos = 0;
        nChainWork = 0;
        nTx = 0;
        nChainTx = 0;
        nStatus = 0;
        nSequenceId = 0;
 
        nMint = 0;
        nMoneySupply = 0;
        nFlags = 0;
        nStakeModifier = 0;
        nStakeModifierChecksum = 0;
        prevoutStake.SetNull();
        nStakeTime = 0;
 
        nVersion = 0;
        hashMerkleRoot = UINT256_ZERO;
        nTime = 0;
        nBits = 0;
        nNonce = 0;
        nAccumulatorCheckpoint = UINT256_ZERO;
 
        hashPoAMerkleRoot = UINT256_ZERO;
        minedHash = UINT256_ZERO;
        hashPrevPoABlock = UINT256_ZERO;
    }
 
    CBlockIndex()
    {
        SetNull();
    }
 
    CBlockIndex(const CBlock& block)
    {
        SetNull();
 
        nVersion = block.nVersion;
        hashMerkleRoot = block.hashMerkleRoot;
        nTime = block.nTime;
        nBits = block.nBits;
        nNonce = block.nNonce;
        if(block.nVersion > 3)
            nAccumulatorCheckpoint = block.nAccumulatorCheckpoint;
 
        //Proof of Stake
        bnChainTrust = UINT256_ZERO;
        nMint = 0;
        nMoneySupply = 0;
        nFlags = 0;
        nStakeModifier = 0;
        nStakeModifierChecksum = 0;
        hashProofOfStake = UINT256_ZERO;
 
        if (block.IsProofOfAudit()) {
            SetProofOfAudit();
            hashPrevPoABlock = block.hashPrevPoABlock;
            minedHash = block.minedHash;
            hashPoAMerkleRoot = block.hashPoAMerkleRoot;
            prevoutStake.SetNull();
            nStakeTime = 0;
        } else if (block.IsProofOfStake()) {
            SetProofOfStake();
            prevoutStake = block.vtx[1].vin[0].prevout;
            nStakeTime = block.nTime;
        } else {
            prevoutStake.SetNull();
            nStakeTime = 0;
        }
    }
    
 
    CDiskBlockPos GetBlockPos() const
    {
        CDiskBlockPos ret;
        if (nStatus & BLOCK_HAVE_DATA) {
            ret.nFile = nFile;
            ret.nPos = nDataPos;
        }
        return ret;
    }
 
    CDiskBlockPos GetUndoPos() const
    {
        CDiskBlockPos ret;
        if (nStatus & BLOCK_HAVE_UNDO) {
            ret.nFile = nFile;
            ret.nPos = nUndoPos;
        }
        return ret;
    }
 
    CBlockHeader GetBlockHeader() const
    {
        CBlockHeader block;
        block.nVersion = nVersion;
        if (IsProofOfAudit()) {
            block.hashPoAMerkleRoot = hashPoAMerkleRoot;
            block.minedHash = minedHash;
            block.hashPrevPoABlock = hashPrevPoABlock;
        }  
        if (pprev)
            block.hashPrevBlock = pprev->GetBlockHash();
        block.hashMerkleRoot = hashMerkleRoot;
        block.nTime = nTime;
        block.nBits = nBits;
        block.nNonce = nNonce;
        block.nAccumulatorCheckpoint = nAccumulatorCheckpoint;
        return block;
    }
 
    uint256 GetBlockHash() const
    {
        return *phashBlock;
    }
 
    int64_t GetBlockTime() const
    {
        return (int64_t)nTime;
    }
 
    enum { nMedianTimeSpan = 11 };
 
    int64_t GetMedianTimePast() const
    {
        int64_t pmedian[nMedianTimeSpan];
        int64_t* pbegin = &pmedian[nMedianTimeSpan];
        int64_t* pend = &pmedian[nMedianTimeSpan];
 
        const CBlockIndex* pindex = this;
        for (int i = 0; i < nMedianTimeSpan && pindex; i++, pindex = pindex->pprev)
            *(--pbegin) = pindex->GetBlockTime();
 
        std::sort(pbegin, pend);
        return pbegin[(pend - pbegin) / 2];
    }
 
    bool IsProofOfWork() const
    {
        return !(nFlags & BLOCK_PROOF_OF_STAKE) && !IsProofOfAudit();
    }
 
    bool IsProofOfStake() const
    {
        return (nFlags & BLOCK_PROOF_OF_STAKE) && !IsProofOfAudit();
    }
 
    void SetProofOfStake()
    {
        nFlags |= BLOCK_PROOF_OF_STAKE;
    }
 
    bool IsProofOfAudit() const {
        return (nFlags & BLOCK_PROOF_OF_AUDIT);
    }
 
    void SetProofOfAudit()
    {
        nFlags |= BLOCK_PROOF_OF_AUDIT;
    }
 
    unsigned int GetStakeEntropyBit() const
    {
        unsigned int nEntropyBit = ((GetBlockHash().GetCheapHash()) & 1);
        if (GetBoolArg("-printstakemodifier", false))
            LogPrintf("GetStakeEntropyBit: nHeight=%u hashBlock=%s nEntropyBit=%u\n", nHeight, GetBlockHash().ToString().c_str(), nEntropyBit);
 
        return nEntropyBit;
    }
 
    bool SetStakeEntropyBit(unsigned int nEntropyBit)
    {
        if (nEntropyBit > 1)
            return false;
        nFlags |= (nEntropyBit ? BLOCK_STAKE_ENTROPY : 0);
        return true;
    }
 
    bool GeneratedStakeModifier() const
    {
        return (nFlags & BLOCK_STAKE_MODIFIER);
    }
 
    void SetStakeModifier(uint64_t nModifier, bool fGeneratedStakeModifier)
    {
        nStakeModifier = nModifier;
        if (fGeneratedStakeModifier)
            nFlags |= BLOCK_STAKE_MODIFIER;
    }
 
    static bool IsSuperMajority(int minVersion, const CBlockIndex* pstart, unsigned int nRequired);
 
    std::string ToString() const
    {
        return strprintf("CBlockIndex(pprev=%p, nHeight=%d, merkle=%s, hashBlock=%s)",
            pprev, nHeight,
            hashMerkleRoot.ToString(),
            GetBlockHash().ToString());
    }
 
    bool IsValid(enum BlockStatus nUpTo = BLOCK_VALID_TRANSACTIONS) const
    {
        assert(!(nUpTo & ~BLOCK_VALID_MASK)); // Only validity flags allowed.
        if (nStatus & BLOCK_FAILED_MASK)
            return false;
        return ((nStatus & BLOCK_VALID_MASK) >= nUpTo);
    }
 
    bool RaiseValidity(enum BlockStatus nUpTo)
    {
        assert(!(nUpTo & ~BLOCK_VALID_MASK)); // Only validity flags allowed.
        if (nStatus & BLOCK_FAILED_MASK)
            return false;
        if ((nStatus & BLOCK_VALID_MASK) < nUpTo) {
            nStatus = (nStatus & ~BLOCK_VALID_MASK) | nUpTo;
            return true;
        }
        return false;
    }
 
    void BuildSkip();
 
    CBlockIndex* GetAncestor(int height);
    const CBlockIndex* GetAncestor(int height) const;
};
 
class CDiskBlockIndex : public CBlockIndex
{
public:
    uint256 hashPrev;
    uint256 hashNext;
 
    CDiskBlockIndex()
    {
        hashPrev = UINT256_ZERO;
        hashNext = UINT256_ZERO;
    }
 
    explicit CDiskBlockIndex(const CBlockIndex* pindex) : CBlockIndex(*pindex)
    {
        hashPrev = (pprev ? pprev->GetBlockHash() : UINT256_ZERO);
        if (IsProofOfAudit()) {
            hashPoAMerkleRoot = pindex->hashPoAMerkleRoot;
            minedHash = pindex->minedHash;
            hashPrevPoABlock = pindex->hashPrevPoABlock;
        }
    }
 
    ADD_SERIALIZE_METHODS;
 
    template <typename Stream, typename Operation>
    inline void SerializationOp(Stream& s, Operation ser_action, int nType, int nVersion)
    {
        if (!(nType & SER_GETHASH))
            READWRITE(VARINT(nVersion));
 
        READWRITE(VARINT(nHeight));
        READWRITE(VARINT(nStatus));
        READWRITE(VARINT(nTx));
        if (nStatus & (BLOCK_HAVE_DATA | BLOCK_HAVE_UNDO))
            READWRITE(VARINT(nFile));
        if (nStatus & BLOCK_HAVE_DATA)
            READWRITE(VARINT(nDataPos));
        if (nStatus & BLOCK_HAVE_UNDO)
            READWRITE(VARINT(nUndoPos));
 
 
        READWRITE(nMint);
        READWRITE(nMoneySupply);
        READWRITE(nFlags);
        READWRITE(nStakeModifier);
 
        if (IsProofOfStake()) {
            READWRITE(prevoutStake);
            READWRITE(nStakeTime);
        } if (IsProofOfAudit()) {
            READWRITE(hashPoAMerkleRoot);
            READWRITE(minedHash);
            READWRITE(hashPrevPoABlock);
        } else {
            const_cast<CDiskBlockIndex*>(this)->prevoutStake.SetNull();
            const_cast<CDiskBlockIndex*>(this)->nStakeTime = 0;
            const_cast<CDiskBlockIndex*>(this)->hashProofOfStake = UINT256_ZERO;
        }
 
        // block header
        READWRITE(this->nVersion);
        READWRITE(hashPrev);
        READWRITE(hashNext);
        READWRITE(hashMerkleRoot);
        READWRITE(nTime);
        READWRITE(nBits);
        READWRITE(nNonce);
 
    }
 
    uint256 GetBlockHash() const
    {
        CBlockHeader block;
        block.nVersion = nVersion;
        block.hashPrevBlock = hashPrev;
        block.hashMerkleRoot = hashMerkleRoot;
        block.hashPoAMerkleRoot = hashPoAMerkleRoot;
        block.minedHash = minedHash;
        block.nTime = nTime;
        block.nBits = nBits;
        block.nNonce = nNonce;
        block.nAccumulatorCheckpoint = nAccumulatorCheckpoint;
        return block.GetHash();
    }
 
 
    std::string ToString() const
    {
        std::string str = "CDiskBlockIndex(";
        str += CBlockIndex::ToString();
        str += strprintf("\n                hashBlock=%s, hashPrev=%s)",
            GetBlockHash().ToString(),
            hashPrev.ToString());
        return str;
    }
};
 
class CChain
{
private:
    std::vector<CBlockIndex*> vChain;
 
public:
    CBlockIndex* Genesis() const
    {
        return vChain.size() > 0 ? vChain[0] : NULL;
    }
 
    CBlockIndex* Tip(bool fProofOfStake = false) const
    {
        if (vChain.size() < 1)
            return NULL;
 
        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 NULL;
        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 NULL;
    }
 
    int Height() const
    {
        return vChain.size() - 1;
    }
 
    void SetTip(CBlockIndex* pindex);
 
    CBlockLocator GetLocator(const CBlockIndex* pindex = NULL) const;
 
    const CBlockIndex* FindFork(const CBlockIndex* pindex) const;
};
 
#endif // BITCOIN_CHAIN_H