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.

9,057 bytes · SHA-256 257c4b55fc085492… · View upstream ↗

1// Copyright (c) 2024-present The Bitcoin Core developers
2// Distributed under the MIT software license, see the accompanying
3// file COPYING or http://www.opensource.org/licenses/mit-license.php.
4
5#ifndef BITCOIN_INTERFACES_MINING_H
6#define BITCOIN_INTERFACES_MINING_H
7
8#include <consensus/amount.h>
9#include <interfaces/types.h>
10#include <node/mining_types.h>
11#include <primitives/block.h>
12#include <primitives/transaction.h>
13#include <uint256.h>
14#include <util/time.h>
15
16#include <cstdint>
17#include <memory>
18#include <optional>
19#include <stdexcept>
20#include <string>
21#include <vector>
22
23namespace node {
24struct NodeContext;
25} // namespace node
26
27namespace interfaces {
28
29//! Block template interface
30class BlockTemplate
31{
32public:
33    virtual ~BlockTemplate() = default;
34
35    virtual CBlockHeader getBlockHeader() = 0;
36    // Block contains a dummy coinbase transaction that should not be used and
37    // it may not match a transaction constructed from getCoinbaseTx().
38    virtual CBlock getBlock() = 0;
39
40    // Fees per transaction, not including coinbase transaction.
41    virtual std::vector<CAmount> getTxFees() = 0;
42    // Sigop cost per transaction, not including coinbase transaction.
43    virtual std::vector<int64_t> getTxSigops() = 0;
44
45    /** Return fields needed to construct a coinbase transaction */
46    virtual node::CoinbaseTx getCoinbaseTx() = 0;
47
48    /**
49     * Compute merkle path to the coinbase transaction
50     *
51     * @return merkle path ordered from the deepest
52     */
53    virtual std::vector<uint256> getCoinbaseMerklePath() = 0;
54
55    /**
56     * Construct and broadcast the block. Modifies the template in place,
57     * updating the fields listed below as well as the merkle root.
58     *
59     * @param[in] version version block header field
60     * @param[in] timestamp time block header field (unix timestamp)
61     * @param[in] nonce nonce block header field
62     * @param[in] coinbase complete coinbase transaction (including witness)
63     * @param[out] reason failure reason (BIP22)
64     * @param[out] debug  more detailed rejection reason
65     *
66     * @note Unlike the submitblock RPC, this method does not call
67     *       UpdateUncommittedBlockStructures to add a missing coinbase witness
68     *       reserved value. Callers must provide a complete coinbase transaction,
69     *       including the witness when a witness commitment is present.
70     *
71     * @note for heights <= 16, the BIP34 height push in getCoinbaseTx().script_sig_prefix
72     *       is only one byte long, so the coinbase scriptSig needs at least
73     *       one additional byte of data to avoid bad-cb-length.
74     *
75     * @returns true if the block was accepted as a new block
76     */
77    virtual bool submitSolution(uint32_t version, uint32_t timestamp, uint32_t nonce, CTransactionRef coinbase, std::string& reason, std::string& debug) = 0;
78
79    //! Deprecated older method preserved to return an explicit error for IPC
80    //! clients using mining.capnp @7.
81    virtual bool submitSolutionOld7(uint32_t, uint32_t, uint32_t, CTransactionRef)
82    {
83        throw std::runtime_error("Old submitSolution (@7) not supported. Please update your client!");
84    }
85
86    /**
87     * Waits for fees in the next block to rise, a new tip or the timeout.
88     *
89     * @param[in] options   Control the timeout (default forever) and by how much total fees
90     *                      for the next block should rise (default infinite).
91     *
92     * @returns a new BlockTemplate or nothing if the timeout occurs.
93     *
94     * On testnet this will additionally return a template with difficulty 1 if
95     * the tip is more than 20 minutes old.
96     */
97    virtual std::unique_ptr<BlockTemplate> waitNext(node::BlockWaitOptions options = {}) = 0;
98
99    /**
100     * Interrupts the current wait for the next block template.
101    */
102    virtual void interruptWait() = 0;
103};
104
105//! Interface giving clients (RPC, Stratum v2 Template Provider in the future)
106//! ability to create block templates.
107class Mining
108{
109public:
110    virtual ~Mining() = default;
111
112    //! If this chain is exclusively used for testing
113    virtual bool isTestChain() = 0;
114
115    //! Returns whether IBD is still in progress.
116    virtual bool isInitialBlockDownload() = 0;
117
118    //! Returns the hash and height for the tip of this chain
119    virtual std::optional<BlockRef> getTip() = 0;
120
121    /**
122     * Waits for the connected tip to change. During node initialization, this will
123     * wait until the tip is connected (regardless of `timeout`).
124     *
125     * @param[in] current_tip block hash of the current chain tip. Function waits
126     *                        for the chain tip to differ from this.
127     * @param[in] timeout     how long to wait for a new tip (default is forever)
128     *
129     * @retval BlockRef hash and height of the current chain tip after this call.
130     * @retval std::nullopt if the node is shut down or interrupt() is called.
131     */
132    virtual std::optional<BlockRef> waitTipChanged(uint256 current_tip, MillisecondsDouble timeout = MillisecondsDouble::max()) = 0;
133
134   /**
135     * Construct a new block template.
136     *
137     * @param[in] options options for creating the block
138     * @param[in] cooldown wait for tip to be connected and IBD to complete.
139     *                     If the best header is ahead of the tip, wait for the
140     *                     tip to catch up. It's recommended to disable this on
141     *                     regtest and signets with only one miner, as these
142     *                     could stall.
143     * @retval BlockTemplate a block template.
144     * @retval std::nullptr if the node is shut down or interrupt() is called.
145     */
146    virtual std::unique_ptr<BlockTemplate> createNewBlock(const node::BlockCreateOptions& options = {}, bool cooldown = true) = 0;
147
148    /**
149     * Interrupts createNewBlock and waitTipChanged.
150     */
151    virtual void interrupt() = 0;
152
153    /**
154     * Checks if a given block is valid.
155     *
156     * @param[in] block       the block to check
157     * @param[in] options     verification options: the proof-of-work check can be
158     *                        skipped in order to verify a template generated by
159     *                        external software.
160     * @param[out] reason     failure reason (BIP22)
161     * @param[out] debug      more detailed rejection reason
162     * @returns               whether the block is valid
163     *
164     * For signets the challenge verification is skipped when check_pow is false.
165     */
166    virtual bool checkBlock(const CBlock& block, const node::BlockCheckOptions& options, std::string& reason, std::string& debug) = 0;
167
168    /**
169     * Process a fully assembled block.
170     *
171     * Similar to the submitblock RPC. Accepts a complete block, validates
172     * it, and if accepted as new, processes it into chainstate. Accepted
173     * blocks may then be announced to peers through normal validation signals.
174     *
175     * @param[in]  block  the complete block to submit
176     * @param[out] reason failure reason (BIP22)
177     * @param[out] debug  more detailed rejection reason
178     * @returns           true if the block was accepted as a new block. Returns
179     *                    false and sets reason if the block is a duplicate or
180     *                    the validation result is inconclusive.
181     *
182     * @note Unlike the submitblock RPC, this method does not call
183     *       UpdateUncommittedBlockStructures to add a missing coinbase witness
184     *       reserved value. Callers must submit a fully formed block, including
185     *       the coinbase witness when a witness commitment is present.
186     */
187    virtual bool submitBlock(const CBlock& block, std::string& reason, std::string& debug) = 0;
188
189    /**
190     * Fetch raw transactions from the mempool by txid.
191     *
192     * @param[in] txids   transaction ids to look up
193     * @returns           one entry per requested txid containing the
194     *                    transaction if found, otherwise nullptr
195     */
196    virtual std::vector<CTransactionRef> getTransactionsByTxID(const std::vector<Txid>& txids) = 0;
197
198    /**
199     * Fetch raw transactions from the mempool by wtxid.
200     *
201     * @param[in] wtxids   witness transaction ids to look up
202     * @returns            one entry per requested wtxid containing the
203     *                     transaction if found, otherwise nullptr
204     */
205    virtual std::vector<CTransactionRef> getTransactionsByWitnessID(const std::vector<Wtxid>& wtxids) = 0;
206
207    //! Get internal node context. Useful for RPC and testing,
208    //! but not accessible across processes.
209    virtual const node::NodeContext* context() { return nullptr; }
210};
211
212//! Return implementation of Mining interface.
213//!
214//! @param[in] wait_loaded waits for chainstate data to be loaded before
215//!                        returning. Used to prevent external clients from
216//!                        being able to crash the node during startup.
217std::unique_ptr<Mining> MakeMining(const node::NodeContext& node, bool wait_loaded=true);
218
219} // namespace interfaces
220
221#endif // BITCOIN_INTERFACES_MINING_H
222

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.