READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server340 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

7,376 bytes · SHA-256 1447eb804d0dbd28… · View upstream ↗

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_NODE_MINER_H
7#define BITCOIN_NODE_MINER_H
8
9#include <consensus/amount.h>
10#include <node/mining_types.h>
11#include <primitives/block.h>
12#include <primitives/transaction.h>
13#include <threadsafety.h>
14#include <txmempool.h>
15#include <util/feefrac.h>
16#include <util/time.h>
17
18#include <cstdint>
19#include <memory>
20#include <optional>
21#include <string>
22#include <vector>
23
24class CBlockIndex;
25class CChainParams;
26class Chainstate;
27class ChainstateManager;
28
29namespace Consensus {
30struct Params;
31} // namespace Consensus
32class uint256;
33namespace interfaces {
34struct BlockRef;
35} // namespace interfaces
36
37using interfaces::BlockRef;
38
39namespace node {
40class KernelNotifications;
41
42struct CBlockTemplate
43{
44    CBlock block;
45    // Fees per transaction, not including coinbase transaction (unlike CBlock::vtx).
46    std::vector<CAmount> vTxFees;
47    // Sigops per transaction, not including coinbase transaction (unlike CBlock::vtx).
48    std::vector<int64_t> vTxSigOpsCost;
49    /* A vector of package fee rates, ordered by the sequence in which
50     * packages are selected for inclusion in the block template.*/
51    std::vector<FeePerVSize> m_package_feerates;
52    /*
53     * Template containing all coinbase transaction fields that are set by our
54     * miner code.
55     */
56    CoinbaseTx m_coinbase_tx;
57};
58
59/** Generate a new block, without valid proof-of-work */
60class BlockAssembler
61{
62private:
63    // The constructed block template
64    std::unique_ptr<CBlockTemplate> pblocktemplate;
65
66    // Information on the current status of the block
67    uint64_t nBlockWeight;
68    uint64_t nBlockTx;
69    uint64_t nBlockSigOpsCost;
70    CAmount nFees;
71
72    // Chain context for the block
73    int nHeight;
74    int64_t m_lock_time_cutoff;
75
76    const CChainParams& chainparams;
77    const CTxMemPool* const m_mempool;
78    Chainstate& m_chainstate;
79
80public:
81    explicit BlockAssembler(Chainstate& chainstate,
82                            const CTxMemPool* mempool,
83                            BlockCreateOptions create_options);
84
85    /** Construct a new block template */
86    std::unique_ptr<CBlockTemplate> CreateNewBlock();
87
88    /** The number of transactions in the last assembled block (excluding coinbase transaction) */
89    inline static std::optional<int64_t> m_last_block_num_txs{};
90    /** The weight of the last assembled block (including reserved weight for block header, txs count and coinbase tx) */
91    inline static std::optional<int64_t> m_last_block_weight{};
92
93private:
94    const BlockCreateOptions m_options;
95
96    // utility functions
97    /** Clear the block's state and prepare for assembling a new block */
98    void resetBlock();
99    /** Add a tx to the block */
100    void AddToBlock(const CTxMemPoolEntry& entry);
101
102    // Methods for how to add transactions to a block.
103    /** Add transactions based on chunk feerate
104      *
105      * @pre BlockAssembler::m_mempool must not be nullptr
106    */
107    void addChunks() EXCLUSIVE_LOCKS_REQUIRED(m_mempool->cs);
108
109    // helper functions for addChunks()
110    /** Test if a new chunk would "fit" in the block */
111    bool TestChunkBlockLimits(int64_t chunk_weight, int64_t chunk_sigops_cost) const;
112    /** Perform locktime checks on each transaction in a chunk:
113      * This check should always succeed, and is here
114      * only as an extra check in case of a bug */
115    bool TestChunkTransactions(const std::vector<CTxMemPoolEntryRef>& txs) const;
116};
117
118/**
119 * Get the minimum time a miner should use in the next block. This always
120 * accounts for the BIP94 timewarp rule, so does not necessarily reflect the
121 * consensus limit.
122 */
123int64_t GetMinimumTime(const CBlockIndex* pindexPrev, int64_t difficulty_adjustment_interval);
124
125int64_t UpdateTime(CBlockHeader* pblock, const Consensus::Params& consensusParams, const CBlockIndex* pindexPrev);
126
127/** Update an old GenerateCoinbaseCommitment from CreateNewBlock after the block txs have changed */
128void RegenerateCommitments(CBlock& block, ChainstateManager& chainman);
129
130/* Compute the block's merkle root, insert or replace the coinbase transaction and the merkle root into the block */
131void AddMerkleRootAndCoinbase(CBlock& block, CTransactionRef coinbase, uint32_t version, uint32_t timestamp, uint32_t nonce);
132
133//! Submit a block and capture the validation state via the BlockChecked callback.
134//! Returns whether the block was accepted as a new valid block.
135bool SubmitBlock(ChainstateManager& chainman, const std::shared_ptr<const CBlock>& block, std::string& reason, std::string& debug);
136
137/* Interrupt a blocking call. */
138void InterruptWait(KernelNotifications& kernel_notifications, bool& interrupt_wait);
139/**
140 * Return a new block template when fees rise to a certain threshold or after a
141 * new tip; return nullopt if timeout is reached.
142 */
143std::unique_ptr<CBlockTemplate> WaitAndCreateNewBlock(ChainstateManager& chainman,
144                                                      KernelNotifications& kernel_notifications,
145                                                      CTxMemPool* mempool,
146                                                      const std::unique_ptr<CBlockTemplate>& block_template,
147                                                      const BlockWaitOptions& wait_options,
148                                                      const BlockCreateOptions& create_options,
149                                                      bool& interrupt_wait);
150
151/* Locks cs_main and returns the block hash and block height of the active chain if it exists; otherwise, returns nullopt.*/
152std::optional<BlockRef> GetTip(ChainstateManager& chainman);
153
154/* Waits for the connected tip to change until timeout has elapsed. During node initialization, this will wait until the tip is connected (regardless of `timeout`).
155 * Returns the current tip, or nullopt if the node is shutting down or interrupt()
156 * is called.
157 */
158std::optional<BlockRef> WaitTipChanged(ChainstateManager& chainman, KernelNotifications& kernel_notifications, const uint256& current_tip, MillisecondsDouble& timeout, bool& interrupt);
159
160/**
161 * Wait while the best known header extends the current chain tip AND at least
162 * one block is being added to the tip every 3 seconds. If the tip is
163 * sufficiently far behind, allow up to 20 seconds for the next tip update.
164 *
165 * It’s not safe to keep waiting, because a malicious miner could announce a
166 * header and delay revealing the block, causing all other miners using this
167 * software to stall. At the same time, we need to balance between the default
168 * waiting time being brief, but not ending the cooldown prematurely when a
169 * random block is slow to download (or process).
170 *
171 * The cooldown only applies to createNewBlock(), which is typically called
172 * once per connected client. Subsequent templates are provided by waitNext().
173 *
174 * @param last_tip tip at the start of the cooldown window.
175 * @param interrupt_mining set to true to interrupt the cooldown.
176 *
177 * @returns false if interrupted.
178 */
179bool CooldownIfHeadersAhead(ChainstateManager& chainman, KernelNotifications& kernel_notifications, const BlockRef& last_tip, bool& interrupt_mining);
180} // namespace node
181
182#endif // BITCOIN_NODE_MINER_H
183

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.