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.

66,046 bytes · SHA-256 d64f6d7690ede678… · 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_VALIDATION_H
7#define BITCOIN_VALIDATION_H
8
9#include <arith_uint256.h>
10#include <attributes.h>
11#include <chain.h>
12#include <checkqueue.h>
13#include <coins.h>
14#include <consensus/amount.h>
15#include <cuckoocache.h>
16#include <deploymentstatus.h>
17#include <kernel/chain.h>
18#include <kernel/chainparams.h>
19#include <kernel/chainstatemanager_opts.h>
20#include <kernel/cs_main.h> // IWYU pragma: export
21#include <node/blockstorage.h>
22#include <policy/feerate.h>
23#include <policy/packages.h>
24#include <policy/policy.h>
25#include <script/script_error.h>
26#include <script/sigcache.h>
27#include <script/verify_flags.h>
28#include <sync.h>
29#include <txdb.h>
30#include <txmempool.h>
31#include <uint256.h>
32#include <util/byte_units.h>
33#include <util/check.h>
34#include <util/fs.h>
35#include <util/hasher.h>
36#include <util/result.h>
37#include <util/time.h>
38#include <util/translation.h>
39#include <versionbits.h>
40
41#include <algorithm>
42#include <atomic>
43#include <cstdint>
44#include <map>
45#include <memory>
46#include <optional>
47#include <set>
48#include <span>
49#include <string>
50#include <type_traits>
51#include <utility>
52#include <vector>
53
54class Chainstate;
55class CTxMemPool;
56class ChainstateManager;
57struct ChainTxData;
58class DisconnectedBlockTransactions;
59struct PrecomputedTransactionData;
60struct LockPoints;
61struct AssumeutxoData;
62namespace kernel {
63struct ChainstateRole;
64} // namespace kernel
65namespace node {
66class SnapshotMetadata;
67} // namespace node
68namespace Consensus {
69struct Params;
70} // namespace Consensus
71namespace util {
72class SignalInterrupt;
73} // namespace util
74
75/** Block files containing a block-height within MIN_BLOCKS_TO_KEEP of ActiveChain().Tip() will not be pruned. */
76inline constexpr unsigned int MIN_BLOCKS_TO_KEEP = 288;
77inline constexpr signed int DEFAULT_CHECKBLOCKS = 6;
78inline constexpr int DEFAULT_CHECKLEVEL{3};
79// Require that user allocate at least 550 MiB for block & undo files (blk???.dat and rev???.dat)
80// At 1MB per block, 288 blocks = 288MB.
81// Add 15% for Undo data = 331MB
82// Add 20% for Orphan block rate = 397MB
83// We want the low water mark after pruning to be at least 397 MB and since we prune in
84// full block file chunks, we need the high water mark which triggers the prune to be
85// one 128MB block file + added 15% undo data = 147MB greater for a total of 545MB
86// Setting the target to >= 550 MiB will make it likely we can respect the target.
87inline constexpr uint64_t MIN_DISK_SPACE_FOR_BLOCK_FILES{550_MiB};
88
89/** Maximum number of dedicated script-checking threads allowed */
90inline constexpr int MAX_SCRIPTCHECK_THREADS{15};
91
92/** Maximum number of dedicated threads allowed for prefetching block input prevouts */
93inline constexpr int32_t MAX_PREVOUTFETCH_THREADS{16};
94
95/** Current sync state passed to tip changed callbacks. */
96enum class SynchronizationState {
97    INIT_REINDEX,
98    INIT_DOWNLOAD,
99    POST_INIT
100};
101
102/** Documentation for argument 'checklevel'. */
103extern const std::vector<std::string> CHECKLEVEL_DOC;
104
105CAmount GetBlockSubsidy(int nHeight, const Consensus::Params& consensusParams);
106
107bool FatalError(kernel::Notifications& notifications, BlockValidationState& state, const bilingual_str& message);
108
109/** Prune block files up to a given height */
110void PruneBlockFilesManual(Chainstate& active_chainstate, int nManualPruneHeight);
111
112/**
113* Validation result for a transaction evaluated by MemPoolAccept (single or package).
114* Here are the expected fields and properties of a result depending on its ResultType, applicable to
115* results returned from package evaluation:
116*+---------------------------+----------------+-------------------+------------------+----------------+-------------------+
117*| Field or property         |    VALID       |                 INVALID              |  MEMPOOL_ENTRY | DIFFERENT_WITNESS |
118*|                           |                |--------------------------------------|                |                   |
119*|                           |                | TX_RECONSIDERABLE |     Other        |                |                   |
120*+---------------------------+----------------+-------------------+------------------+----------------+-------------------+
121*| txid in mempool?          | yes            | no                | no*              | yes            | yes               |
122*| wtxid in mempool?         | yes            | no                | no*              | yes            | no                |
123*| m_state                   | yes, IsValid() | yes, IsInvalid()  | yes, IsInvalid() | yes, IsValid() | yes, IsValid()    |
124*| m_vsize                   | yes            | no                | no               | yes            | no                |
125*| m_base_fees               | yes            | no                | no               | yes            | no                |
126*| m_effective_feerate       | yes            | yes               | no               | no             | no                |
127*| m_wtxids_fee_calculations | yes            | yes               | no               | no             | no                |
128*| m_other_wtxid             | no             | no                | no               | no             | yes               |
129*+---------------------------+----------------+-------------------+------------------+----------------+-------------------+
130* (*) Individual transaction acceptance doesn't return MEMPOOL_ENTRY and DIFFERENT_WITNESS. It returns
131* INVALID, with the errors txn-already-in-mempool and txn-same-nonwitness-data-in-mempool
132* respectively. In those cases, the txid or wtxid may be in the mempool for a TX_CONFLICT.
133*/
134struct MempoolAcceptResult {
135    /** Used to indicate the results of mempool validation. */
136    enum class ResultType {
137        VALID, //!> Fully validated, valid.
138        INVALID, //!> Invalid.
139        MEMPOOL_ENTRY, //!> Valid, transaction was already in the mempool.
140        DIFFERENT_WITNESS, //!> Not validated. A same-txid-different-witness tx (see m_other_wtxid) already exists in the mempool and was not replaced.
141    };
142    /** Result type. Present in all MempoolAcceptResults. */
143    const ResultType m_result_type;
144
145    /** Contains information about why the transaction failed. */
146    const TxValidationState m_state;
147
148    /** Mempool transactions replaced by the tx. */
149    const std::list<CTransactionRef> m_replaced_transactions;
150    /** Virtual size as used by the mempool, calculated using serialized size and sigops. */
151    const std::optional<int64_t> m_vsize;
152    /** Raw base fees in satoshis. */
153    const std::optional<CAmount> m_base_fees;
154    /** The feerate at which this transaction was considered. This includes any fee delta added
155     * using prioritisetransaction (i.e. modified fees). If this transaction was submitted as a
156     * package, this is the package feerate, which may also include its descendants and/or
157     * ancestors (see m_wtxids_fee_calculations below).
158     */
159    const std::optional<CFeeRate> m_effective_feerate;
160    /** Contains the wtxids of the transactions used for fee-related checks. Includes this
161     * transaction's wtxid and may include others if this transaction was validated as part of a
162     * package. This is not necessarily equivalent to the list of transactions passed to
163     * ProcessNewPackage().
164     * Only present when m_result_type = ResultType::VALID. */
165    const std::optional<std::vector<Wtxid>> m_wtxids_fee_calculations;
166
167    /** The wtxid of the transaction in the mempool which has the same txid but different witness. */
168    const std::optional<Wtxid> m_other_wtxid;
169
170    static MempoolAcceptResult Failure(TxValidationState state) {
171        return MempoolAcceptResult(state);
172    }
173
174    static MempoolAcceptResult FeeFailure(TxValidationState state,
175                                          CFeeRate effective_feerate,
176                                          const std::vector<Wtxid>& wtxids_fee_calculations) {
177        return MempoolAcceptResult(state, effective_feerate, wtxids_fee_calculations);
178    }
179
180    static MempoolAcceptResult Success(std::list<CTransactionRef>&& replaced_txns,
181                                       int64_t vsize,
182                                       CAmount fees,
183                                       CFeeRate effective_feerate,
184                                       const std::vector<Wtxid>& wtxids_fee_calculations) {
185        return MempoolAcceptResult(std::move(replaced_txns), vsize, fees,
186                                   effective_feerate, wtxids_fee_calculations);
187    }
188
189    static MempoolAcceptResult MempoolTx(int64_t vsize, CAmount fees) {
190        return MempoolAcceptResult(vsize, fees);
191    }
192
193    static MempoolAcceptResult MempoolTxDifferentWitness(const Wtxid& other_wtxid) {
194        return MempoolAcceptResult(other_wtxid);
195    }
196
197// Private constructors. Use static methods MempoolAcceptResult::Success, etc. to construct.
198private:
199    /** Constructor for failure case */
200    explicit MempoolAcceptResult(TxValidationState state)
201        : m_result_type(ResultType::INVALID), m_state(state) {
202            Assume(!state.IsValid()); // Can be invalid or error
203        }
204
205    /** Constructor for success case */
206    explicit MempoolAcceptResult(std::list<CTransactionRef>&& replaced_txns,
207                                 int64_t vsize,
208                                 CAmount fees,
209                                 CFeeRate effective_feerate,
210                                 const std::vector<Wtxid>& wtxids_fee_calculations)
211        : m_result_type(ResultType::VALID),
212        m_replaced_transactions(std::move(replaced_txns)),
213        m_vsize{vsize},
214        m_base_fees(fees),
215        m_effective_feerate(effective_feerate),
216        m_wtxids_fee_calculations(wtxids_fee_calculations) {}
217
218    /** Constructor for fee-related failure case */
219    explicit MempoolAcceptResult(TxValidationState state,
220                                 CFeeRate effective_feerate,
221                                 const std::vector<Wtxid>& wtxids_fee_calculations)
222        : m_result_type(ResultType::INVALID),
223        m_state(state),
224        m_effective_feerate(effective_feerate),
225        m_wtxids_fee_calculations(wtxids_fee_calculations) {}
226
227    /** Constructor for already-in-mempool case. It wouldn't replace any transactions. */
228    explicit MempoolAcceptResult(int64_t vsize, CAmount fees)
229        : m_result_type(ResultType::MEMPOOL_ENTRY), m_vsize{vsize}, m_base_fees(fees) {}
230
231    /** Constructor for witness-swapped case. */
232    explicit MempoolAcceptResult(const Wtxid& other_wtxid)
233        : m_result_type(ResultType::DIFFERENT_WITNESS), m_other_wtxid(other_wtxid) {}
234};
235
236/**
237* Validation result for package mempool acceptance.
238*/
239struct PackageMempoolAcceptResult
240{
241    PackageValidationState m_state;
242    /**
243    * Map from wtxid to finished MempoolAcceptResults. The client is responsible
244    * for keeping track of the transaction objects themselves. If a result is not
245    * present, it means validation was unfinished for that transaction. If there
246    * was a package-wide error (see result in m_state), m_tx_results will be empty.
247    */
248    std::map<Wtxid, MempoolAcceptResult> m_tx_results;
249
250    explicit PackageMempoolAcceptResult(PackageValidationState state,

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.