Bitcoin Core 29.99.0
P2P Digital Currency
blockfilter_index_tests.cpp
Go to the documentation of this file.
1// Copyright (c) 2017-2022 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 <chainparams.h>
8#include <consensus/merkle.h>
11#include <interfaces/chain.h>
12#include <node/miner.h>
13#include <pow.h>
15#include <test/util/index.h>
17#include <validation.h>
18
19#include <boost/test/unit_test.hpp>
20
24
25BOOST_AUTO_TEST_SUITE(blockfilter_index_tests)
26
28 CBlock CreateBlock(const CBlockIndex* prev, const std::vector<CMutableTransaction>& txns, const CScript& scriptPubKey);
29 bool BuildChain(const CBlockIndex* pindex, const CScript& coinbase_script_pub_key, size_t length, std::vector<std::shared_ptr<CBlock>>& chain);
30};
31
32static bool CheckFilterLookups(BlockFilterIndex& filter_index, const CBlockIndex* block_index,
33 uint256& last_header, const BlockManager& blockman)
34{
35 BlockFilter expected_filter;
36 if (!ComputeFilter(filter_index.GetFilterType(), *block_index, expected_filter, blockman)) {
37 BOOST_ERROR("ComputeFilter failed on block " << block_index->nHeight);
38 return false;
39 }
40
41 BlockFilter filter;
42 uint256 filter_header;
43 std::vector<BlockFilter> filters;
44 std::vector<uint256> filter_hashes;
45
46 BOOST_CHECK(filter_index.LookupFilter(block_index, filter));
47 BOOST_CHECK(filter_index.LookupFilterHeader(block_index, filter_header));
48 BOOST_CHECK(filter_index.LookupFilterRange(block_index->nHeight, block_index, filters));
49 BOOST_CHECK(filter_index.LookupFilterHashRange(block_index->nHeight, block_index,
50 filter_hashes));
51
52 BOOST_CHECK_EQUAL(filters.size(), 1U);
53 BOOST_CHECK_EQUAL(filter_hashes.size(), 1U);
54
55 BOOST_CHECK_EQUAL(filter.GetHash(), expected_filter.GetHash());
56 BOOST_CHECK_EQUAL(filter_header, expected_filter.ComputeHeader(last_header));
57 BOOST_CHECK_EQUAL(filters[0].GetHash(), expected_filter.GetHash());
58 BOOST_CHECK_EQUAL(filter_hashes[0], expected_filter.GetHash());
59
60 filters.clear();
61 filter_hashes.clear();
62 last_header = filter_header;
63 return true;
64}
65
67 const std::vector<CMutableTransaction>& txns,
68 const CScript& scriptPubKey)
69{
70 BlockAssembler::Options options;
71 options.coinbase_output_script = scriptPubKey;
72 std::unique_ptr<CBlockTemplate> pblocktemplate = BlockAssembler{m_node.chainman->ActiveChainstate(), m_node.mempool.get(), options}.CreateNewBlock();
73 CBlock& block = pblocktemplate->block;
74 block.hashPrevBlock = prev->GetBlockHash();
75 block.nTime = prev->nTime + 1;
76
77 // Replace mempool-selected txns with just coinbase plus passed-in txns:
78 block.vtx.resize(1);
79 for (const CMutableTransaction& tx : txns) {
80 block.vtx.push_back(MakeTransactionRef(tx));
81 }
82 {
83 CMutableTransaction tx_coinbase{*block.vtx.at(0)};
84 tx_coinbase.nLockTime = static_cast<uint32_t>(prev->nHeight);
85 tx_coinbase.vin.at(0).scriptSig = CScript{} << prev->nHeight + 1;
86 block.vtx.at(0) = MakeTransactionRef(std::move(tx_coinbase));
87 block.hashMerkleRoot = BlockMerkleRoot(block);
88 }
89
90 while (!CheckProofOfWork(block.GetHash(), block.nBits, m_node.chainman->GetConsensus())) ++block.nNonce;
91
92 return block;
93}
94
96 const CScript& coinbase_script_pub_key,
97 size_t length,
98 std::vector<std::shared_ptr<CBlock>>& chain)
99{
100 std::vector<CMutableTransaction> no_txns;
101
102 chain.resize(length);
103 for (auto& block : chain) {
104 block = std::make_shared<CBlock>(CreateBlock(pindex, no_txns, coinbase_script_pub_key));
105 CBlockHeader header = block->GetBlockHeader();
106
108 if (!Assert(m_node.chainman)->ProcessNewBlockHeaders({{header}}, true, state, &pindex)) {
109 return false;
110 }
111 }
112
113 return true;
114}
115
116BOOST_FIXTURE_TEST_CASE(blockfilter_index_initial_sync, BuildChainTestingSetup)
117{
119 BOOST_REQUIRE(filter_index.Init());
120
121 uint256 last_header;
122
123 // Filter should not be found in the index before it is started.
124 {
125 LOCK(cs_main);
126
127 BlockFilter filter;
128 uint256 filter_header;
129 std::vector<BlockFilter> filters;
130 std::vector<uint256> filter_hashes;
131
132 for (const CBlockIndex* block_index = m_node.chainman->ActiveChain().Genesis();
133 block_index != nullptr;
134 block_index = m_node.chainman->ActiveChain().Next(block_index)) {
135 BOOST_CHECK(!filter_index.LookupFilter(block_index, filter));
136 BOOST_CHECK(!filter_index.LookupFilterHeader(block_index, filter_header));
137 BOOST_CHECK(!filter_index.LookupFilterRange(block_index->nHeight, block_index, filters));
138 BOOST_CHECK(!filter_index.LookupFilterHashRange(block_index->nHeight, block_index,
139 filter_hashes));
140 }
141 }
142
143 // BlockUntilSyncedToCurrentChain should return false before index is started.
144 BOOST_CHECK(!filter_index.BlockUntilSyncedToCurrentChain());
145
146 BOOST_REQUIRE(filter_index.StartBackgroundSync());
147
148 // Allow filter index to catch up with the block index.
150
151 // Check that filter index has all blocks that were in the chain before it started.
152 {
153 LOCK(cs_main);
154 const CBlockIndex* block_index;
155 for (block_index = m_node.chainman->ActiveChain().Genesis();
156 block_index != nullptr;
157 block_index = m_node.chainman->ActiveChain().Next(block_index)) {
158 CheckFilterLookups(filter_index, block_index, last_header, m_node.chainman->m_blockman);
159 }
160 }
161
162 // Create two forks.
163 const CBlockIndex* tip;
164 {
165 LOCK(cs_main);
166 tip = m_node.chainman->ActiveChain().Tip();
167 }
168 CKey coinbase_key_A = GenerateRandomKey();
169 CKey coinbase_key_B = GenerateRandomKey();
170 CScript coinbase_script_pub_key_A = GetScriptForDestination(PKHash(coinbase_key_A.GetPubKey()));
171 CScript coinbase_script_pub_key_B = GetScriptForDestination(PKHash(coinbase_key_B.GetPubKey()));
172 std::vector<std::shared_ptr<CBlock>> chainA, chainB;
173 BOOST_REQUIRE(BuildChain(tip, coinbase_script_pub_key_A, 10, chainA));
174 BOOST_REQUIRE(BuildChain(tip, coinbase_script_pub_key_B, 10, chainB));
175
176 // Check that new blocks on chain A get indexed.
177 uint256 chainA_last_header = last_header;
178 for (size_t i = 0; i < 2; i++) {
179 const auto& block = chainA[i];
180 BOOST_REQUIRE(Assert(m_node.chainman)->ProcessNewBlock(block, true, true, nullptr));
181 }
182 for (size_t i = 0; i < 2; i++) {
183 const auto& block = chainA[i];
184 const CBlockIndex* block_index;
185 {
186 LOCK(cs_main);
187 block_index = m_node.chainman->m_blockman.LookupBlockIndex(block->GetHash());
188 }
189
190 BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
191 CheckFilterLookups(filter_index, block_index, chainA_last_header, m_node.chainman->m_blockman);
192 }
193
194 // Reorg to chain B.
195 uint256 chainB_last_header = last_header;
196 for (size_t i = 0; i < 3; i++) {
197 const auto& block = chainB[i];
198 BOOST_REQUIRE(Assert(m_node.chainman)->ProcessNewBlock(block, true, true, nullptr));
199 }
200 for (size_t i = 0; i < 3; i++) {
201 const auto& block = chainB[i];
202 const CBlockIndex* block_index;
203 {
204 LOCK(cs_main);
205 block_index = m_node.chainman->m_blockman.LookupBlockIndex(block->GetHash());
206 }
207
208 BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
209 CheckFilterLookups(filter_index, block_index, chainB_last_header, m_node.chainman->m_blockman);
210 }
211
212 // Check that filters for stale blocks on A can be retrieved.
213 chainA_last_header = last_header;
214 for (size_t i = 0; i < 2; i++) {
215 const auto& block = chainA[i];
216 const CBlockIndex* block_index;
217 {
218 LOCK(cs_main);
219 block_index = m_node.chainman->m_blockman.LookupBlockIndex(block->GetHash());
220 }
221
222 BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
223 CheckFilterLookups(filter_index, block_index, chainA_last_header, m_node.chainman->m_blockman);
224 }
225
226 // Reorg back to chain A.
227 for (size_t i = 2; i < 4; i++) {
228 const auto& block = chainA[i];
229 BOOST_REQUIRE(Assert(m_node.chainman)->ProcessNewBlock(block, true, true, nullptr));
230 }
231
232 // Check that chain A and B blocks can be retrieved.
233 chainA_last_header = last_header;
234 chainB_last_header = last_header;
235 for (size_t i = 0; i < 3; i++) {
236 const CBlockIndex* block_index;
237
238 {
239 LOCK(cs_main);
240 block_index = m_node.chainman->m_blockman.LookupBlockIndex(chainA[i]->GetHash());
241 }
242 BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
243 CheckFilterLookups(filter_index, block_index, chainA_last_header, m_node.chainman->m_blockman);
244
245 {
246 LOCK(cs_main);
247 block_index = m_node.chainman->m_blockman.LookupBlockIndex(chainB[i]->GetHash());
248 }
249 BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
250 CheckFilterLookups(filter_index, block_index, chainB_last_header, m_node.chainman->m_blockman);
251 }
252
253 // Test lookups for a range of filters/hashes.
254 std::vector<BlockFilter> filters;
255 std::vector<uint256> filter_hashes;
256
257 {
258 LOCK(cs_main);
259 tip = m_node.chainman->ActiveChain().Tip();
260 }
261 BOOST_CHECK(filter_index.LookupFilterRange(0, tip, filters));
262 BOOST_CHECK(filter_index.LookupFilterHashRange(0, tip, filter_hashes));
263
264 assert(tip->nHeight >= 0);
265 BOOST_CHECK_EQUAL(filters.size(), tip->nHeight + 1U);
266 BOOST_CHECK_EQUAL(filter_hashes.size(), tip->nHeight + 1U);
267
268 filters.clear();
269 filter_hashes.clear();
270
271 filter_index.Interrupt();
272 filter_index.Stop();
273}
274
275BOOST_FIXTURE_TEST_CASE(blockfilter_index_init_destroy, BasicTestingSetup)
276{
277 BlockFilterIndex* filter_index;
278
280 BOOST_CHECK(filter_index == nullptr);
281
283
285 BOOST_CHECK(filter_index != nullptr);
287
288 // Initialize returns false if index already exists.
290
291 int iter_count = 0;
292 ForEachBlockFilterIndex([&iter_count](BlockFilterIndex& _index) { iter_count++; });
293 BOOST_CHECK_EQUAL(iter_count, 1);
294
296
297 // Destroy returns false because index was already destroyed.
299
301 BOOST_CHECK(filter_index == nullptr);
302
303 // Reinitialize index.
305
307
309 BOOST_CHECK(filter_index == nullptr);
310}
311
CScript GetScriptForDestination(const CTxDestination &dest)
Generate a Bitcoin scriptPubKey for the given CTxDestination.
node::NodeContext m_node
Definition: bitcoin-gui.cpp:42
static bool CheckFilterLookups(BlockFilterIndex &filter_index, const CBlockIndex *block_index, uint256 &last_header, const BlockManager &blockman)
BOOST_FIXTURE_TEST_CASE(blockfilter_index_initial_sync, BuildChainTestingSetup)
bool DestroyBlockFilterIndex(BlockFilterType filter_type)
Destroy the block filter index with the given type.
void DestroyAllBlockFilterIndexes()
Destroy all open block filter indexes.
BlockFilterIndex * GetBlockFilterIndex(BlockFilterType filter_type)
Get a block filter index by type.
void ForEachBlockFilterIndex(std::function< void(BlockFilterIndex &)> fn)
Iterate over all running block filter indexes, invoking fn on each.
bool InitBlockFilterIndex(std::function< std::unique_ptr< interfaces::Chain >()> make_chain, BlockFilterType filter_type, size_t n_cache_size, bool f_memory, bool f_wipe)
Initialize a block filter index for the given type if one does not already exist.
#define Assert(val)
Identity function.
Definition: check.h:106
void Stop()
Stops the instance from staying in sync with blockchain updates.
Definition: base.cpp:415
bool Init()
Initializes the sync state and registers the instance to the validation interface so that it stays in...
Definition: base.cpp:84
bool BlockUntilSyncedToCurrentChain() const LOCKS_EXCLUDED(void Interrupt()
Blocks the current thread until the index is caught up to the current state of the block chain.
Definition: base.cpp:402
bool StartBackgroundSync()
Starts the initial sync process on a background thread.
Definition: base.cpp:407
Complete block filter struct as defined in BIP 157.
Definition: blockfilter.h:115
uint256 ComputeHeader(const uint256 &prev_header) const
Compute the filter header given the previous one.
uint256 GetHash() const
Compute the filter hash.
BlockFilterIndex is used to store and retrieve block filters, hashes, and headers for a range of bloc...
bool LookupFilterRange(int start_height, const CBlockIndex *stop_index, std::vector< BlockFilter > &filters_out) const
Get a range of filters between two heights on a chain.
BlockFilterType GetFilterType() const
bool LookupFilter(const CBlockIndex *block_index, BlockFilter &filter_out) const
Get a single filter by block.
bool LookupFilterHashRange(int start_height, const CBlockIndex *stop_index, std::vector< uint256 > &hashes_out) const
Get a range of filter hashes between two heights on a chain.
bool LookupFilterHeader(const CBlockIndex *block_index, uint256 &header_out) EXCLUSIVE_LOCKS_REQUIRED(!m_cs_headers_cache)
Get a single filter header by block.
Nodes collect new transactions into a block, hash them into a hash tree, and scan through nonce value...
Definition: block.h:22
uint32_t nNonce
Definition: block.h:30
uint32_t nBits
Definition: block.h:29
uint32_t nTime
Definition: block.h:28
uint256 hashPrevBlock
Definition: block.h:26
uint256 hashMerkleRoot
Definition: block.h:27
uint256 GetHash() const
Definition: block.cpp:11
Definition: block.h:69
std::vector< CTransactionRef > vtx
Definition: block.h:72
The block chain is a tree shaped structure starting with the genesis block at the root,...
Definition: chain.h:141
uint32_t nTime
Definition: chain.h:189
uint256 GetBlockHash() const
Definition: chain.h:243
int nHeight
height of the entry in the chain. The genesis block has height 0
Definition: chain.h:153
An encapsulated private key.
Definition: key.h:35
CPubKey GetPubKey() const
Compute the public key from a private key.
Definition: key.cpp:182
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:415
Generate a new block, without valid proof-of-work.
Definition: miner.h:151
Maintains a tree of blocks (stored in m_block_index) which is consulted to determine where the most-w...
Definition: blockstorage.h:139
256-bit opaque blob.
Definition: uint256.h:196
RecursiveMutex cs_main
Mutex to guard access to validation specific variables, such as reading or changing the chainstate.
Definition: cs_main.cpp:8
BOOST_AUTO_TEST_SUITE_END()
void IndexWaitSynced(const BaseIndex &index, const util::SignalInterrupt &interrupt)
Block until the index is synced to the current chain.
Definition: index.cpp:12
CKey GenerateRandomKey(bool compressed) noexcept
Definition: key.cpp:352
uint256 BlockMerkleRoot(const CBlock &block, bool *mutated)
Definition: merkle.cpp:66
std::unique_ptr< Chain > MakeChain(node::NodeContext &node)
Return implementation of Chain interface.
Definition: interfaces.cpp:997
#define BOOST_CHECK_EQUAL(v1, v2)
Definition: object.cpp:18
#define BOOST_CHECK(expr)
Definition: object.cpp:17
bool CheckProofOfWork(uint256 hash, unsigned int nBits, const Consensus::Params &params)
Check whether a block hash satisfies the proof-of-work requirement specified by nBits.
Definition: pow.cpp:140
static CTransactionRef MakeTransactionRef(Tx &&txIn)
Definition: transaction.h:424
Basic testing setup.
Definition: setup_common.h:64
node::NodeContext m_node
Definition: setup_common.h:66
bool BuildChain(const CBlockIndex *pindex, const CScript &coinbase_script_pub_key, size_t length, std::vector< std::shared_ptr< CBlock > > &chain)
CBlock CreateBlock(const CBlockIndex *prev, const std::vector< CMutableTransaction > &txns, const CScript &scriptPubKey)
A mutable version of CTransaction.
Definition: transaction.h:378
Testing fixture that pre-creates a 100-block REGTEST-mode block chain.
Definition: setup_common.h:146
std::unique_ptr< CTxMemPool > mempool
Definition: context.h:68
std::unique_ptr< ChainstateManager > chainman
Definition: context.h:72
util::SignalInterrupt * shutdown_signal
Interrupt object used to track whether node shutdown was requested.
Definition: context.h:65
#define LOCK(cs)
Definition: sync.h:257
bool ComputeFilter(BlockFilterType filter_type, const CBlockIndex &block_index, BlockFilter &filter, const BlockManager &blockman)
Definition: blockfilter.cpp:15
assert(!tx.IsCoinBase())