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.

7,349 bytes · SHA-256 1c33eed7f787fc7e… · View upstream ↗

1// Copyright (c) 2018-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 <test/data/blockfilters.json.h>
6#include <test/util/common.h>
7
8#include <blockfilter.h>
9#include <core_io.h>
10#include <primitives/block.h>
11#include <serialize.h>
12#include <streams.h>
13#include <undo.h>
14#include <univalue.h>
15#include <util/strencodings.h>
16
17#include <boost/test/unit_test.hpp>
18
19BOOST_AUTO_TEST_SUITE(blockfilter_tests)
20
21BOOST_AUTO_TEST_CASE(gcsfilter_test)
22{
23    GCSFilter::ElementSet included_elements, excluded_elements;
24    for (int i = 0; i < 100; ++i) {
25        GCSFilter::Element element1(32);
26        element1[0] = i;
27        included_elements.insert(std::move(element1));
28
29        GCSFilter::Element element2(32);
30        element2[1] = i;
31        excluded_elements.insert(std::move(element2));
32    }
33
34    GCSFilter filter({0, 0, 10, 1 << 10}, included_elements);
35    for (const auto& element : included_elements) {
36        BOOST_CHECK(filter.Match(element));
37
38        auto insertion = excluded_elements.insert(element);
39        BOOST_CHECK(filter.MatchAny(excluded_elements));
40        excluded_elements.erase(insertion.first);
41    }
42}
43
44BOOST_AUTO_TEST_CASE(gcsfilter_default_constructor)
45{
46    GCSFilter filter;
47    BOOST_CHECK_EQUAL(filter.GetN(), 0U);
48    BOOST_CHECK_EQUAL(filter.GetEncoded().size(), 1U);
49
50    const GCSFilter::Params& params = filter.GetParams();
51    BOOST_CHECK_EQUAL(params.m_siphash_k0, 0U);
52    BOOST_CHECK_EQUAL(params.m_siphash_k1, 0U);
53    BOOST_CHECK_EQUAL(params.m_P, 0);
54    BOOST_CHECK_EQUAL(params.m_M, 1U);
55}
56
57BOOST_AUTO_TEST_CASE(blockfilter_basic_test)
58{
59    CScript included_scripts[5], excluded_scripts[4];
60
61    // First two are outputs on a single transaction.
62    included_scripts[0] << std::vector<unsigned char>(65, 0) << OP_CHECKSIG;
63    included_scripts[1] << OP_DUP << OP_HASH160 << std::vector<unsigned char>(20, 1) << OP_EQUALVERIFY << OP_CHECKSIG;
64
65    // Third is an output on in a second transaction.
66    included_scripts[2] << OP_1 << std::vector<unsigned char>(33, 2) << OP_1 << OP_CHECKMULTISIG;
67
68    // Last two are spent by a single transaction.
69    included_scripts[3] << OP_0 << std::vector<unsigned char>(32, 3);
70    included_scripts[4] << OP_4 << OP_ADD << OP_8 << OP_EQUAL;
71
72    // OP_RETURN output is an output on the second transaction.
73    excluded_scripts[0] << OP_RETURN << std::vector<unsigned char>(40, 4);
74
75    // This script is not related to the block at all.
76    excluded_scripts[1] << std::vector<unsigned char>(33, 5) << OP_CHECKSIG;
77
78    // OP_RETURN is non-standard since it's not followed by a data push, but is still excluded from
79    // filter.
80    excluded_scripts[2] << OP_RETURN << OP_4 << OP_ADD << OP_8 << OP_EQUAL;
81
82    CMutableTransaction tx_1;
83    tx_1.vout.emplace_back(100, included_scripts[0]);
84    tx_1.vout.emplace_back(200, included_scripts[1]);
85    tx_1.vout.emplace_back(0, excluded_scripts[0]);
86
87    CMutableTransaction tx_2;
88    tx_2.vout.emplace_back(300, included_scripts[2]);
89    tx_2.vout.emplace_back(0, excluded_scripts[2]);
90    tx_2.vout.emplace_back(400, excluded_scripts[3]); // Script is empty
91
92    CBlock block;
93    block.vtx.push_back(MakeTransactionRef(tx_1));
94    block.vtx.push_back(MakeTransactionRef(tx_2));
95
96    CBlockUndo block_undo;
97    block_undo.vtxundo.emplace_back();
98    block_undo.vtxundo.back().vprevout.emplace_back(CTxOut(500, included_scripts[3]), 1000, true);
99    block_undo.vtxundo.back().vprevout.emplace_back(CTxOut(600, included_scripts[4]), 10000, false);
100    block_undo.vtxundo.back().vprevout.emplace_back(CTxOut(700, excluded_scripts[3]), 100000, false);
101
102    BlockFilter block_filter(BlockFilterType::BASIC, block, block_undo);
103    const GCSFilter& filter = block_filter.GetFilter();
104
105    for (const CScript& script : included_scripts) {
106        BOOST_CHECK(filter.Match(GCSFilter::Element(script.begin(), script.end())));
107    }
108    for (const CScript& script : excluded_scripts) {
109        BOOST_CHECK(!filter.Match(GCSFilter::Element(script.begin(), script.end())));
110    }
111
112    // Test serialization/unserialization.
113    BlockFilter block_filter2;
114
115    DataStream stream{};
116    stream << block_filter;
117    stream >> block_filter2;
118
119    BOOST_CHECK_EQUAL(block_filter.GetFilterType(), block_filter2.GetFilterType());
120    BOOST_CHECK_EQUAL(block_filter.GetBlockHash(), block_filter2.GetBlockHash());
121    BOOST_CHECK(block_filter.GetEncodedFilter() == block_filter2.GetEncodedFilter());
122
123    BlockFilter default_ctor_block_filter_1;
124    BlockFilter default_ctor_block_filter_2;
125    BOOST_CHECK_EQUAL(default_ctor_block_filter_1.GetFilterType(), default_ctor_block_filter_2.GetFilterType());
126    BOOST_CHECK_EQUAL(default_ctor_block_filter_1.GetBlockHash(), default_ctor_block_filter_2.GetBlockHash());
127    BOOST_CHECK(default_ctor_block_filter_1.GetEncodedFilter() == default_ctor_block_filter_2.GetEncodedFilter());
128}
129
130BOOST_AUTO_TEST_CASE(blockfilters_json_test)
131{
132    UniValue json;
133    if (!json.read(json_tests::blockfilters) || !json.isArray()) {
134        BOOST_ERROR("Parse error.");
135        return;
136    }
137
138    const UniValue& tests = json.get_array();
139    for (unsigned int i = 0; i < tests.size(); i++) {
140        const UniValue& test = tests[i];
141        std::string strTest = test.write();
142
143        if (test.size() == 1) {
144            continue;
145        } else if (test.size() < 7) {
146            BOOST_ERROR("Bad test: " << strTest);
147            continue;
148        }
149
150        unsigned int pos = 0;
151        /*int block_height =*/ test[pos++].getInt<int>();
152        BOOST_CHECK(uint256::FromHex(test[pos++].get_str()));
153
154        CBlock block;
155        BOOST_REQUIRE(DecodeHexBlk(block, test[pos++].get_str()));
156
157        CBlockUndo block_undo;
158        block_undo.vtxundo.emplace_back();
159        CTxUndo& tx_undo = block_undo.vtxundo.back();
160        const UniValue& prev_scripts = test[pos++].get_array();
161        for (unsigned int ii = 0; ii < prev_scripts.size(); ii++) {
162            std::vector<unsigned char> raw_script = ParseHex(prev_scripts[ii].get_str());
163            CTxOut txout(0, CScript(raw_script.begin(), raw_script.end()));
164            tx_undo.vprevout.emplace_back(txout, 0, false);
165        }
166
167        uint256 prev_filter_header_basic{*Assert(uint256::FromHex(test[pos++].get_str()))};
168        std::vector<unsigned char> filter_basic = ParseHex(test[pos++].get_str());
169        uint256 filter_header_basic{*Assert(uint256::FromHex(test[pos++].get_str()))};
170
171        BlockFilter computed_filter_basic(BlockFilterType::BASIC, block, block_undo);
172        BOOST_CHECK(computed_filter_basic.GetFilter().GetEncoded() == filter_basic);
173
174        uint256 computed_header_basic = computed_filter_basic.ComputeHeader(prev_filter_header_basic);
175        BOOST_CHECK(computed_header_basic == filter_header_basic);
176    }
177}
178
179BOOST_AUTO_TEST_CASE(blockfilter_type_names)
180{
181    BOOST_CHECK_EQUAL(BlockFilterTypeName(BlockFilterType::BASIC), "basic");
182    BOOST_CHECK_EQUAL(BlockFilterTypeName(static_cast<BlockFilterType>(255)), "");
183
184    BlockFilterType filter_type;
185    BOOST_CHECK(BlockFilterTypeByName("basic", filter_type));
186    BOOST_CHECK_EQUAL(filter_type, BlockFilterType::BASIC);
187
188    BOOST_CHECK(!BlockFilterTypeByName("unknown", filter_type));
189}
190
191BOOST_AUTO_TEST_SUITE_END()
192

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.