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 server440 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.

18,965 bytes · SHA-256 73cd4c92f6cec4ff… · View upstream ↗

1// Copyright (c) 2011-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#include <blockencodings.h>
6#include <chainparams.h>
7#include <consensus/merkle.h>
8#include <pow.h>
9#include <streams.h>
10#include <test/util/random.h>
11#include <test/util/txmempool.h>
12
13#include <test/util/common.h>
14#include <test/util/setup_common.h>
15
16#include <boost/test/unit_test.hpp>
17
18const std::vector<std::pair<Wtxid, CTransactionRef>> empty_extra_txn;
19
20BOOST_FIXTURE_TEST_SUITE(blockencodings_tests, RegTestingSetup)
21
22static CMutableTransaction BuildTransactionTestCase() {
23    CMutableTransaction tx;
24    tx.vin.resize(1);
25    tx.vin[0].scriptSig.resize(10);
26    tx.vout.resize(1);
27    tx.vout[0].nValue = 42;
28    return tx;
29}
30
31static CBlock BuildBlockTestCase(FastRandomContext& ctx) {
32    CBlock block;
33    CMutableTransaction tx = BuildTransactionTestCase();
34
35    block.vtx.resize(3);
36    block.vtx[0] = MakeTransactionRef(tx);
37    block.nVersion = 42;
38    block.hashPrevBlock = ctx.rand256();
39    block.nBits = 0x207fffff;
40
41    tx.vin[0].prevout.hash = Txid::FromUint256(ctx.rand256());
42    tx.vin[0].prevout.n = 0;
43    block.vtx[1] = MakeTransactionRef(tx);
44
45    tx.vin.resize(10);
46    for (size_t i = 0; i < tx.vin.size(); i++) {
47        tx.vin[i].prevout.hash = Txid::FromUint256(ctx.rand256());
48        tx.vin[i].prevout.n = 0;
49    }
50    block.vtx[2] = MakeTransactionRef(tx);
51
52    bool mutated;
53    block.hashMerkleRoot = BlockMerkleRoot(block, &mutated);
54    assert(!mutated);
55    while (!CheckProofOfWork(block.GetHash(), block.nBits, Params().GetConsensus())) ++block.nNonce;
56    return block;
57}
58
59// Number of shared use_counts we expect for a tx we haven't touched
60// (block + mempool entry + our copy from the GetSharedTx call)
61constexpr long SHARED_TX_OFFSET{3};
62
63BOOST_AUTO_TEST_CASE(SimpleRoundTripTest)
64{
65    CTxMemPool& pool = *Assert(m_node.mempool);
66    TestMemPoolEntryHelper entry;
67    auto rand_ctx(FastRandomContext(uint256{42}));
68    CBlock block(BuildBlockTestCase(rand_ctx));
69
70    LOCK2(cs_main, pool.cs);
71    TryAddToMempool(pool, entry.FromTx(block.vtx[2]));
72    BOOST_CHECK_EQUAL(pool.get(block.vtx[2]->GetHash()).use_count(), SHARED_TX_OFFSET + 0);
73
74    // Do a simple ShortTxIDs RT
75    {
76        CBlockHeaderAndShortTxIDs shortIDs{block, rand_ctx.rand64()};
77
78        DataStream stream{};
79        stream << shortIDs;
80
81        CBlockHeaderAndShortTxIDs shortIDs2;
82        stream >> shortIDs2;
83
84        PartiallyDownloadedBlock partialBlock(&pool);
85        BOOST_CHECK(partialBlock.InitData(shortIDs2, empty_extra_txn) == READ_STATUS_OK);
86        BOOST_CHECK( partialBlock.IsTxAvailable(0));
87        BOOST_CHECK(!partialBlock.IsTxAvailable(1));
88        BOOST_CHECK( partialBlock.IsTxAvailable(2));
89
90        BOOST_CHECK_EQUAL(pool.get(block.vtx[2]->GetHash()).use_count(), SHARED_TX_OFFSET + 1);
91
92        size_t poolSize = pool.size();
93        pool.removeRecursive(*block.vtx[2], MemPoolRemovalReason::REPLACED);
94        BOOST_CHECK_EQUAL(pool.size(), poolSize - 1);
95
96        CBlock block2;
97        {
98            PartiallyDownloadedBlock tmp = partialBlock;
99            BOOST_CHECK(partialBlock.FillBlock(block2, {}, /*segwit_active=*/true) == READ_STATUS_INVALID); // No transactions
100            partialBlock = tmp;
101        }
102
103        // Wrong transaction
104        {
105            PartiallyDownloadedBlock tmp = partialBlock;
106            partialBlock.FillBlock(block2, {block.vtx[2]}, /*segwit_active=*/true); // Current implementation doesn't check txn here, but don't require that
107            partialBlock = tmp;
108        }
109        bool mutated;
110        BOOST_CHECK(block.hashMerkleRoot != BlockMerkleRoot(block2, &mutated));
111
112        CBlock block3;
113        BOOST_CHECK(partialBlock.FillBlock(block3, {block.vtx[1]}, /*segwit_active=*/true) == READ_STATUS_OK);
114        BOOST_CHECK_EQUAL(block.GetHash().ToString(), block3.GetHash().ToString());
115        BOOST_CHECK_EQUAL(block.hashMerkleRoot.ToString(), BlockMerkleRoot(block3, &mutated).ToString());
116        BOOST_CHECK(!mutated);
117    }
118}
119
120class TestHeaderAndShortIDs {
121    // Utility to encode custom CBlockHeaderAndShortTxIDs
122public:
123    CBlockHeader header;
124    uint64_t nonce;
125    std::vector<uint64_t> shorttxids;
126    std::vector<PrefilledTransaction> prefilledtxn;
127
128    explicit TestHeaderAndShortIDs(const CBlockHeaderAndShortTxIDs& orig) {
129        DataStream stream{};
130        stream << orig;
131        stream >> *this;
132    }
133    explicit TestHeaderAndShortIDs(const CBlock& block, FastRandomContext& ctx) :
134        TestHeaderAndShortIDs(CBlockHeaderAndShortTxIDs{block, ctx.rand64()}) {}
135
136    uint64_t GetShortID(const Wtxid& txhash) const {
137        DataStream stream{};
138        stream << *this;
139        CBlockHeaderAndShortTxIDs base;
140        stream >> base;
141        return base.GetShortID(txhash);
142    }
143
144    SERIALIZE_METHODS(TestHeaderAndShortIDs, obj) { READWRITE(obj.header, obj.nonce, Using<VectorFormatter<CustomUintFormatter<CBlockHeaderAndShortTxIDs::SHORTTXIDS_LENGTH>>>(obj.shorttxids), obj.prefilledtxn); }
145};
146
147struct TestPartiallyDownloadedBlock : PartiallyDownloadedBlock {
148    using PartiallyDownloadedBlock::PartiallyDownloadedBlock;
149
150    size_t GetMempoolCount() const { return mempool_count; }
151    size_t GetExtraCount() const { return extra_count; }
152};
153
154BOOST_AUTO_TEST_CASE(NonCoinbasePreforwardRTTest)
155{
156    CTxMemPool& pool = *Assert(m_node.mempool);
157    TestMemPoolEntryHelper entry;
158    auto rand_ctx(FastRandomContext(uint256{42}));
159    CBlock block(BuildBlockTestCase(rand_ctx));
160
161    LOCK2(cs_main, pool.cs);
162    TryAddToMempool(pool, entry.FromTx(block.vtx[2]));
163    BOOST_CHECK_EQUAL(pool.get(block.vtx[2]->GetHash()).use_count(), SHARED_TX_OFFSET + 0);
164
165    Txid txhash;
166
167    // Test with pre-forwarding tx 1, but not coinbase
168    {
169        TestHeaderAndShortIDs shortIDs(block, rand_ctx);
170        shortIDs.prefilledtxn.resize(1);
171        shortIDs.prefilledtxn[0] = {1, block.vtx[1]};
172        shortIDs.shorttxids.resize(2);
173        shortIDs.shorttxids[0] = shortIDs.GetShortID(block.vtx[0]->GetWitnessHash());
174        shortIDs.shorttxids[1] = shortIDs.GetShortID(block.vtx[2]->GetWitnessHash());
175
176        DataStream stream{};
177        stream << shortIDs;
178
179        CBlockHeaderAndShortTxIDs shortIDs2;
180        stream >> shortIDs2;
181
182        PartiallyDownloadedBlock partialBlock(&pool);
183        BOOST_CHECK(partialBlock.InitData(shortIDs2, empty_extra_txn) == READ_STATUS_OK);
184        BOOST_CHECK(!partialBlock.IsTxAvailable(0));
185        BOOST_CHECK( partialBlock.IsTxAvailable(1));
186        BOOST_CHECK( partialBlock.IsTxAvailable(2));
187
188        BOOST_CHECK_EQUAL(pool.get(block.vtx[2]->GetHash()).use_count(), SHARED_TX_OFFSET + 1); // +1 because of partialBlock
189
190        CBlock block2;
191        {
192            PartiallyDownloadedBlock tmp = partialBlock;
193            BOOST_CHECK(partialBlock.FillBlock(block2, {}, /*segwit_active=*/true) == READ_STATUS_INVALID); // No transactions
194            partialBlock = tmp;
195        }
196
197        // Wrong transaction
198        {
199            PartiallyDownloadedBlock tmp = partialBlock;
200            partialBlock.FillBlock(block2, {block.vtx[1]}, /*segwit_active=*/true); // Current implementation doesn't check txn here, but don't require that
201            partialBlock = tmp;
202        }
203        BOOST_CHECK_EQUAL(pool.get(block.vtx[2]->GetHash()).use_count(), SHARED_TX_OFFSET + 2); // +2 because of partialBlock and block2
204        bool mutated;
205        BOOST_CHECK(block.hashMerkleRoot != BlockMerkleRoot(block2, &mutated));
206
207        CBlock block3;
208        PartiallyDownloadedBlock partialBlockCopy = partialBlock;
209        BOOST_CHECK(partialBlock.FillBlock(block3, {block.vtx[0]}, /*segwit_active=*/true) == READ_STATUS_OK);
210        BOOST_CHECK_EQUAL(block.GetHash().ToString(), block3.GetHash().ToString());
211        BOOST_CHECK_EQUAL(block.hashMerkleRoot.ToString(), BlockMerkleRoot(block3, &mutated).ToString());
212        BOOST_CHECK(!mutated);
213
214        BOOST_CHECK_EQUAL(pool.get(block.vtx[2]->GetHash()).use_count(), SHARED_TX_OFFSET + 3); // +2 because of partialBlock and block2 and block3
215
216        txhash = block.vtx[2]->GetHash();
217        block.vtx.clear();
218        block2.vtx.clear();
219        block3.vtx.clear();
220        BOOST_CHECK_EQUAL(pool.get(txhash).use_count(), SHARED_TX_OFFSET + 1 - 1); // + 1 because of partialBlock; -1 because of block.
221    }
222    BOOST_CHECK_EQUAL(pool.get(txhash).use_count(), SHARED_TX_OFFSET - 1); // -1 because of block
223}
224
225BOOST_AUTO_TEST_CASE(SufficientPreforwardRTTest)
226{
227    CTxMemPool& pool = *Assert(m_node.mempool);
228    TestMemPoolEntryHelper entry;
229    auto rand_ctx(FastRandomContext(uint256{42}));
230    CBlock block(BuildBlockTestCase(rand_ctx));
231
232    LOCK2(cs_main, pool.cs);
233    TryAddToMempool(pool, entry.FromTx(block.vtx[1]));
234    BOOST_CHECK_EQUAL(pool.get(block.vtx[1]->GetHash()).use_count(), SHARED_TX_OFFSET + 0);
235
236    Txid txhash;
237
238    // Test with pre-forwarding coinbase + tx 2 with tx 1 in mempool
239    {
240        TestHeaderAndShortIDs shortIDs(block, rand_ctx);
241        shortIDs.prefilledtxn.resize(2);
242        shortIDs.prefilledtxn[0] = {0, block.vtx[0]};
243        shortIDs.prefilledtxn[1] = {1, block.vtx[2]}; // id == 1 as it is 1 after index 1
244        shortIDs.shorttxids.resize(1);
245        shortIDs.shorttxids[0] = shortIDs.GetShortID(block.vtx[1]->GetWitnessHash());
246
247        DataStream stream{};
248        stream << shortIDs;
249
250        CBlockHeaderAndShortTxIDs shortIDs2;

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

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.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.