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.

9,934 bytes · SHA-256 eb4dddd147bb481d… · View upstream ↗

1// Copyright (c) 2017-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 <addresstype.h>
6#include <blockfilter.h>
7#include <chain.h>
8#include <index/blockfilterindex.h>
9#include <interfaces/chain.h>
10#include <key.h>
11#include <node/blockstorage.h>
12#include <primitives/block.h>
13#include <script/script.h>
14#include <sync.h>
15#include <test/util/blockfilter.h>
16#include <test/util/common.h>
17#include <test/util/mining.h>
18#include <test/util/setup_common.h>
19#include <uint256.h>
20#include <util/check.h>
21#include <validation.h>
22
23#include <boost/test/unit_test.hpp>
24
25#include <compare>
26#include <cstddef>
27#include <cstdint>
28#include <functional>
29#include <memory>
30#include <span>
31#include <string>
32#include <utility>
33#include <vector>
34
35using node::BlockManager;
36
37BOOST_AUTO_TEST_SUITE(blockfilter_index_tests)
38
39static bool CheckFilterLookups(BlockFilterIndex& filter_index, const CBlockIndex* block_index,
40                               uint256& last_header, const BlockManager& blockman)
41{
42    BlockFilter expected_filter;
43    if (!ComputeFilter(filter_index.GetFilterType(), *block_index, expected_filter, blockman)) {
44        BOOST_ERROR("ComputeFilter failed on block " << block_index->nHeight);
45        return false;
46    }
47
48    BlockFilter filter;
49    uint256 filter_header;
50    std::vector<BlockFilter> filters;
51    std::vector<uint256> filter_hashes;
52
53    BOOST_CHECK(filter_index.LookupFilter(block_index, filter));
54    BOOST_CHECK(filter_index.LookupFilterHeader(block_index, filter_header));
55    BOOST_CHECK(filter_index.LookupFilterRange(block_index->nHeight, block_index, filters));
56    BOOST_CHECK(filter_index.LookupFilterHashRange(block_index->nHeight, block_index,
57                                                   filter_hashes));
58
59    BOOST_CHECK_EQUAL(filters.size(), 1U);
60    BOOST_CHECK_EQUAL(filter_hashes.size(), 1U);
61
62    BOOST_CHECK_EQUAL(filter.GetHash(), expected_filter.GetHash());
63    BOOST_CHECK_EQUAL(filter_header, expected_filter.ComputeHeader(last_header));
64    BOOST_CHECK_EQUAL(filters[0].GetHash(), expected_filter.GetHash());
65    BOOST_CHECK_EQUAL(filter_hashes[0], expected_filter.GetHash());
66
67    filters.clear();
68    filter_hashes.clear();
69    last_header = filter_header;
70    return true;
71}
72
73BOOST_FIXTURE_TEST_CASE(blockfilter_index_initial_sync, TestChain100Setup)
74{
75    BlockFilterIndex filter_index(interfaces::MakeChain(m_node), BlockFilterType::BASIC, 1_MiB, true);
76    BOOST_REQUIRE(filter_index.Init());
77
78    uint256 last_header;
79
80    // Filter should not be found in the index before it is started.
81    {
82        LOCK(cs_main);
83
84        BlockFilter filter;
85        uint256 filter_header;
86        std::vector<BlockFilter> filters;
87        std::vector<uint256> filter_hashes;
88
89        for (const CBlockIndex* block_index = m_node.chainman->ActiveChain().Genesis();
90             block_index != nullptr;
91             block_index = m_node.chainman->ActiveChain().Next(*block_index)) {
92            BOOST_CHECK(!filter_index.LookupFilter(block_index, filter));
93            BOOST_CHECK(!filter_index.LookupFilterHeader(block_index, filter_header));
94            BOOST_CHECK(!filter_index.LookupFilterRange(block_index->nHeight, block_index, filters));
95            BOOST_CHECK(!filter_index.LookupFilterHashRange(block_index->nHeight, block_index,
96                                                            filter_hashes));
97        }
98    }
99
100    // BlockUntilSyncedToCurrentChain should return false before index is started.
101    BOOST_CHECK(!filter_index.BlockUntilSyncedToCurrentChain());
102
103    filter_index.Sync();
104
105    // Check that filter index has all blocks that were in the chain before it started.
106    {
107        LOCK(cs_main);
108        const CBlockIndex* block_index;
109        for (block_index = m_node.chainman->ActiveChain().Genesis();
110             block_index != nullptr;
111             block_index = m_node.chainman->ActiveChain().Next(*block_index)) {
112            CheckFilterLookups(filter_index, block_index, last_header, m_node.chainman->m_blockman);
113        }
114    }
115
116    // Create two forks.
117    const CBlockIndex* tip;
118    {
119        LOCK(cs_main);
120        tip = m_node.chainman->ActiveChain().Tip();
121    }
122    CKey coinbase_key_A = GenerateRandomKey();
123    CKey coinbase_key_B = GenerateRandomKey();
124    CScript coinbase_script_pub_key_A = GetScriptForDestination(PKHash(coinbase_key_A.GetPubKey()));
125    CScript coinbase_script_pub_key_B = GetScriptForDestination(PKHash(coinbase_key_B.GetPubKey()));
126    std::vector<std::shared_ptr<CBlock>> chainA, chainB;
127    BOOST_REQUIRE(BuildChain(m_node, tip, coinbase_script_pub_key_A, 10, chainA));
128    BOOST_REQUIRE(BuildChain(m_node, tip, coinbase_script_pub_key_B, 10, chainB));
129
130    // Check that new blocks on chain A get indexed.
131    uint256 chainA_last_header = last_header;
132    for (size_t i = 0; i < 2; i++) {
133        const auto& block = chainA[i];
134        BOOST_REQUIRE(Assert(m_node.chainman)->ProcessNewBlock(block, true, true, nullptr));
135    }
136    for (size_t i = 0; i < 2; i++) {
137        const auto& block = chainA[i];
138        const CBlockIndex* block_index;
139        {
140            LOCK(cs_main);
141            block_index = m_node.chainman->m_blockman.LookupBlockIndex(block->GetHash());
142        }
143
144        BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
145        CheckFilterLookups(filter_index, block_index, chainA_last_header, m_node.chainman->m_blockman);
146    }
147
148    // Reorg to chain B.
149    uint256 chainB_last_header = last_header;
150    for (size_t i = 0; i < 3; i++) {
151        const auto& block = chainB[i];
152        BOOST_REQUIRE(Assert(m_node.chainman)->ProcessNewBlock(block, true, true, nullptr));
153    }
154    for (size_t i = 0; i < 3; i++) {
155        const auto& block = chainB[i];
156        const CBlockIndex* block_index;
157        {
158            LOCK(cs_main);
159            block_index = m_node.chainman->m_blockman.LookupBlockIndex(block->GetHash());
160        }
161
162        BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
163        CheckFilterLookups(filter_index, block_index, chainB_last_header, m_node.chainman->m_blockman);
164    }
165
166    // Check that filters for stale blocks on A can be retrieved.
167    chainA_last_header = last_header;
168    for (size_t i = 0; i < 2; i++) {
169        const auto& block = chainA[i];
170        const CBlockIndex* block_index;
171        {
172            LOCK(cs_main);
173            block_index = m_node.chainman->m_blockman.LookupBlockIndex(block->GetHash());
174        }
175
176        BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
177        CheckFilterLookups(filter_index, block_index, chainA_last_header, m_node.chainman->m_blockman);
178    }
179
180    // Reorg back to chain A.
181     for (size_t i = 2; i < 4; i++) {
182         const auto& block = chainA[i];
183         BOOST_REQUIRE(Assert(m_node.chainman)->ProcessNewBlock(block, true, true, nullptr));
184     }
185
186     // Check that chain A and B blocks can be retrieved.
187     chainA_last_header = last_header;
188     chainB_last_header = last_header;
189     for (size_t i = 0; i < 3; i++) {
190         const CBlockIndex* block_index;
191
192         {
193             LOCK(cs_main);
194             block_index = m_node.chainman->m_blockman.LookupBlockIndex(chainA[i]->GetHash());
195         }
196         BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
197         CheckFilterLookups(filter_index, block_index, chainA_last_header, m_node.chainman->m_blockman);
198
199         {
200             LOCK(cs_main);
201             block_index = m_node.chainman->m_blockman.LookupBlockIndex(chainB[i]->GetHash());
202         }
203         BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
204         CheckFilterLookups(filter_index, block_index, chainB_last_header, m_node.chainman->m_blockman);
205     }
206
207    // Test lookups for a range of filters/hashes.
208    std::vector<BlockFilter> filters;
209    std::vector<uint256> filter_hashes;
210
211    {
212        LOCK(cs_main);
213        tip = m_node.chainman->ActiveChain().Tip();
214    }
215    BOOST_CHECK(filter_index.LookupFilterRange(0, tip, filters));
216    BOOST_CHECK(filter_index.LookupFilterHashRange(0, tip, filter_hashes));
217
218    assert(tip->nHeight >= 0);
219    BOOST_CHECK_EQUAL(filters.size(), tip->nHeight + 1U);
220    BOOST_CHECK_EQUAL(filter_hashes.size(), tip->nHeight + 1U);
221
222    filters.clear();
223    filter_hashes.clear();
224
225    filter_index.Interrupt();
226    filter_index.Stop();
227}
228
229BOOST_FIXTURE_TEST_CASE(blockfilter_index_init_destroy, BasicTestingSetup)
230{
231    BlockFilterIndex* filter_index;
232
233    filter_index = GetBlockFilterIndex(BlockFilterType::BASIC);
234    BOOST_CHECK(filter_index == nullptr);
235
236    BOOST_CHECK(InitBlockFilterIndex([&]{ return interfaces::MakeChain(m_node); }, BlockFilterType::BASIC, 1_MiB, true, false));
237
238    filter_index = GetBlockFilterIndex(BlockFilterType::BASIC);
239    BOOST_CHECK(filter_index != nullptr);
240    BOOST_CHECK(filter_index->GetFilterType() == BlockFilterType::BASIC);
241
242    // Initialize returns false if index already exists.
243    BOOST_CHECK(!InitBlockFilterIndex([&]{ return interfaces::MakeChain(m_node); }, BlockFilterType::BASIC, 1_MiB, true, false));
244
245    int iter_count = 0;
246    ForEachBlockFilterIndex([&iter_count](BlockFilterIndex& _index) { iter_count++; });
247    BOOST_CHECK_EQUAL(iter_count, 1);
248
249    BOOST_CHECK(DestroyBlockFilterIndex(BlockFilterType::BASIC));
250

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.