Coverage Report

Created: 2026-08-14 20:23

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/tmp/bitcoin/src/primitives/block.h
Line
Count
Source
1
// Copyright (c) 2009-2010 Satoshi Nakamoto
2
// Copyright (c) 2009-present The Bitcoin Core developers
3
// Distributed under the MIT software license, see the accompanying
4
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6
#ifndef BITCOIN_PRIMITIVES_BLOCK_H
7
#define BITCOIN_PRIMITIVES_BLOCK_H
8
9
#include <primitives/transaction.h>
10
#include <serialize.h>
11
#include <uint256.h>
12
#include <util/time.h>
13
14
#include <cstdint>
15
#include <string>
16
#include <utility>
17
#include <vector>
18
19
/** Nodes collect new transactions into a block, hash them into a hash tree,
20
 * and scan through nonce values to make the block's hash satisfy proof-of-work
21
 * requirements.  When they solve the proof-of-work, they broadcast the block
22
 * to everyone and the block is added to the block chain.  The first transaction
23
 * in the block is a special one that creates a new coin owned by the creator
24
 * of the block.
25
 */
26
class CBlockHeader
27
{
28
public:
29
    // header
30
    int32_t nVersion;
31
    uint256 hashPrevBlock;
32
    uint256 hashMerkleRoot;
33
    uint32_t nTime;
34
    uint32_t nBits;
35
    uint32_t nNonce;
36
37
    CBlockHeader()
38
2.00M
    {
39
2.00M
        SetNull();
40
2.00M
    }
41
42
34.8M
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<ParamsStream<SizeComputer&, TransactionSerParams>, CBlockHeader const, ActionSerialize>(CBlockHeader const&, ParamsStream<SizeComputer&, TransactionSerParams>&, ActionSerialize)
Line
Count
Source
42
772k
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<DataStream, CBlockHeader, ActionUnserialize>(CBlockHeader&, DataStream&, ActionUnserialize)
Line
Count
Source
42
505k
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<DataStream, CBlockHeader const, ActionSerialize>(CBlockHeader const&, DataStream&, ActionSerialize)
Line
Count
Source
42
103k
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<ParamsStream<DataStream&, TransactionSerParams>, CBlockHeader, ActionUnserialize>(CBlockHeader&, ParamsStream<DataStream&, TransactionSerParams>&, ActionUnserialize)
Line
Count
Source
42
37.6k
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<SizeComputer, CBlockHeader const, ActionSerialize>(CBlockHeader const&, SizeComputer&, ActionSerialize)
Line
Count
Source
42
36.8k
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<AutoFile, CBlockHeader, ActionUnserialize>(CBlockHeader&, AutoFile&, ActionUnserialize)
Line
Count
Source
42
166
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<VectorWriter, CBlockHeader const, ActionSerialize>(CBlockHeader const&, VectorWriter&, ActionSerialize)
Line
Count
Source
42
21.0k
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<ParamsStream<VectorWriter&, TransactionSerParams>, CBlockHeader const, ActionSerialize>(CBlockHeader const&, ParamsStream<VectorWriter&, TransactionSerParams>&, ActionSerialize)
Line
Count
Source
42
460k
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<ParamsStream<SpanReader&, TransactionSerParams>, CBlockHeader, ActionUnserialize>(CBlockHeader&, ParamsStream<SpanReader&, TransactionSerParams>&, ActionUnserialize)
Line
Count
Source
42
144k
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<ParamsStream<BufferedWriter<AutoFile>&, TransactionSerParams>, CBlockHeader const, ActionSerialize>(CBlockHeader const&, ParamsStream<BufferedWriter<AutoFile>&, TransactionSerParams>&, ActionSerialize)
Line
Count
Source
42
110k
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<ParamsStream<DataStream&, TransactionSerParams>, CBlockHeader const, ActionSerialize>(CBlockHeader const&, ParamsStream<DataStream&, TransactionSerParams>&, ActionSerialize)
Line
Count
Source
42
5
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<SpanReader, CBlockHeader, ActionUnserialize>(CBlockHeader&, SpanReader&, ActionUnserialize)
Line
Count
Source
42
1.86k
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<BufferedFile, CBlockHeader, ActionUnserialize>(CBlockHeader&, BufferedFile&, ActionUnserialize)
Line
Count
Source
42
2.17k
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<ParamsStream<BufferedFile&, TransactionSerParams>, CBlockHeader, ActionUnserialize>(CBlockHeader&, ParamsStream<BufferedFile&, TransactionSerParams>&, ActionUnserialize)
Line
Count
Source
42
2.06k
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
void CBlockHeader::SerializationOps<HashWriter, CBlockHeader const, ActionSerialize>(CBlockHeader const&, HashWriter&, ActionSerialize)
Line
Count
Source
42
32.6M
    SERIALIZE_METHODS(CBlockHeader, obj) { READWRITE(obj.nVersion, obj.hashPrevBlock, obj.hashMerkleRoot, obj.nTime, obj.nBits, obj.nNonce); }
43
44
    void SetNull()
45
2.96M
    {
46
2.96M
        nVersion = 0;
47
2.96M
        hashPrevBlock.SetNull();
48
2.96M
        hashMerkleRoot.SetNull();
49
2.96M
        nTime = 0;
50
2.96M
        nBits = 0;
51
2.96M
        nNonce = 0;
52
2.96M
    }
53
54
    bool IsNull() const
55
185k
    {
56
185k
        return (nBits == 0);
57
185k
    }
58
59
    uint256 GetHash() const;
60
61
    NodeSeconds Time() const
62
172k
    {
63
172k
        return NodeSeconds{std::chrono::seconds{nTime}};
64
172k
    }
65
66
    int64_t GetBlockTime() const
67
557k
    {
68
557k
        return (int64_t)nTime;
69
557k
    }
70
};
71
72
73
class CBlock : public CBlockHeader
74
{
75
public:
76
    // network and disk
77
    std::vector<CTransactionRef> vtx;
78
79
    // Memory-only flags for caching expensive checks
80
    mutable bool fChecked;                            // CheckBlock()
81
    mutable bool m_checked_witness_commitment{false}; // CheckWitnessCommitment()
82
    mutable bool m_checked_merkle_root{false};        // CheckMerkleRoot()
83
84
    CBlock()
85
338k
    {
86
338k
        SetNull();
87
338k
    }
88
89
    CBlock(const CBlockHeader &header)
90
473k
    {
91
473k
        SetNull();
92
473k
        *(static_cast<CBlockHeader*>(this)) = header;
93
473k
    }
94
95
    SERIALIZE_METHODS(CBlock, obj)
96
1.52M
    {
97
1.52M
        READWRITE(AsBase<CBlockHeader>(obj), obj.vtx);
98
1.52M
    }
void CBlock::SerializationOps<ParamsStream<SizeComputer&, TransactionSerParams>, CBlock const, ActionSerialize>(CBlock const&, ParamsStream<SizeComputer&, TransactionSerParams>&, ActionSerialize)
Line
Count
Source
96
772k
    {
97
772k
        READWRITE(AsBase<CBlockHeader>(obj), obj.vtx);
98
772k
    }
void CBlock::SerializationOps<ParamsStream<DataStream&, TransactionSerParams>, CBlock, ActionUnserialize>(CBlock&, ParamsStream<DataStream&, TransactionSerParams>&, ActionUnserialize)
Line
Count
Source
96
37.6k
    {
97
37.6k
        READWRITE(AsBase<CBlockHeader>(obj), obj.vtx);
98
37.6k
    }
void CBlock::SerializationOps<ParamsStream<VectorWriter&, TransactionSerParams>, CBlock const, ActionSerialize>(CBlock const&, ParamsStream<VectorWriter&, TransactionSerParams>&, ActionSerialize)
Line
Count
Source
96
460k
    {
97
460k
        READWRITE(AsBase<CBlockHeader>(obj), obj.vtx);
98
460k
    }
void CBlock::SerializationOps<ParamsStream<SpanReader&, TransactionSerParams>, CBlock, ActionUnserialize>(CBlock&, ParamsStream<SpanReader&, TransactionSerParams>&, ActionUnserialize)
Line
Count
Source
96
144k
    {
97
144k
        READWRITE(AsBase<CBlockHeader>(obj), obj.vtx);
98
144k
    }
void CBlock::SerializationOps<ParamsStream<BufferedWriter<AutoFile>&, TransactionSerParams>, CBlock const, ActionSerialize>(CBlock const&, ParamsStream<BufferedWriter<AutoFile>&, TransactionSerParams>&, ActionSerialize)
Line
Count
Source
96
110k
    {
97
110k
        READWRITE(AsBase<CBlockHeader>(obj), obj.vtx);
98
110k
    }
void CBlock::SerializationOps<ParamsStream<DataStream&, TransactionSerParams>, CBlock const, ActionSerialize>(CBlock const&, ParamsStream<DataStream&, TransactionSerParams>&, ActionSerialize)
Line
Count
Source
96
5
    {
97
5
        READWRITE(AsBase<CBlockHeader>(obj), obj.vtx);
98
5
    }
void CBlock::SerializationOps<ParamsStream<BufferedFile&, TransactionSerParams>, CBlock, ActionUnserialize>(CBlock&, ParamsStream<BufferedFile&, TransactionSerParams>&, ActionUnserialize)
Line
Count
Source
96
2.06k
    {
97
2.06k
        READWRITE(AsBase<CBlockHeader>(obj), obj.vtx);
98
2.06k
    }
99
100
    void SetNull()
101
947k
    {
102
947k
        CBlockHeader::SetNull();
103
947k
        vtx.clear();
104
947k
        fChecked = false;
105
947k
        m_checked_witness_commitment = false;
106
947k
        m_checked_merkle_root = false;
107
947k
    }
108
109
    std::string ToString() const;
110
};
111
112
/** Describes a place in the block chain to another node such that if the
113
 * other node doesn't have the same branch, it can find a recent common trunk.
114
 * The further back it is, the further before the fork it may be.
115
 */
116
struct CBlockLocator
117
{
118
    /** Historically CBlockLocator's version field has been written to network
119
     * streams as the negotiated protocol version and to disk streams as the
120
     * client version, but the value has never been used.
121
     *
122
     * Hard-code to the highest protocol version ever written to a network stream.
123
     * SerParams can be used if the field requires any meaning in the future,
124
     **/
125
    static constexpr int DUMMY_VERSION = 70016;
126
127
    std::vector<uint256> vHave;
128
129
110k
    CBlockLocator() = default;
130
131
19.9k
    explicit CBlockLocator(std::vector<uint256>&& have) : vHave(std::move(have)) {}
132
133
    SERIALIZE_METHODS(CBlockLocator, obj)
134
34.8k
    {
135
34.8k
        int nVersion = DUMMY_VERSION;
136
34.8k
        READWRITE(nVersion);
137
34.8k
        READWRITE(obj.vHave);
138
34.8k
    }
void CBlockLocator::SerializationOps<SpanReader, CBlockLocator, ActionUnserialize>(CBlockLocator&, SpanReader&, ActionUnserialize)
Line
Count
Source
134
102
    {
135
102
        int nVersion = DUMMY_VERSION;
136
102
        READWRITE(nVersion);
137
102
        READWRITE(obj.vHave);
138
102
    }
void CBlockLocator::SerializationOps<DataStream, CBlockLocator const, ActionSerialize>(CBlockLocator const&, DataStream&, ActionSerialize)
Line
Count
Source
134
25.4k
    {
135
25.4k
        int nVersion = DUMMY_VERSION;
136
25.4k
        READWRITE(nVersion);
137
25.4k
        READWRITE(obj.vHave);
138
25.4k
    }
void CBlockLocator::SerializationOps<VectorWriter, CBlockLocator const, ActionSerialize>(CBlockLocator const&, VectorWriter&, ActionSerialize)
Line
Count
Source
134
3.20k
    {
135
3.20k
        int nVersion = DUMMY_VERSION;
136
3.20k
        READWRITE(nVersion);
137
3.20k
        READWRITE(obj.vHave);
138
3.20k
    }
void CBlockLocator::SerializationOps<DataStream, CBlockLocator, ActionUnserialize>(CBlockLocator&, DataStream&, ActionUnserialize)
Line
Count
Source
134
6.06k
    {
135
6.06k
        int nVersion = DUMMY_VERSION;
136
6.06k
        READWRITE(nVersion);
137
6.06k
        READWRITE(obj.vHave);
138
6.06k
    }
139
140
    void SetNull()
141
78
    {
142
78
        vHave.clear();
143
78
    }
144
145
    bool IsNull() const
146
98.7k
    {
147
98.7k
        return vHave.empty();
148
98.7k
    }
149
};
150
151
#endif // BITCOIN_PRIMITIVES_BLOCK_H