Branch data Line data Source code
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>
9 : : #include <consensus/validation.h>
10 : : #include <index/blockfilterindex.h>
11 : : #include <interfaces/chain.h>
12 : : #include <node/miner.h>
13 : : #include <pow.h>
14 : : #include <test/util/blockfilter.h>
15 : : #include <test/util/index.h>
16 : : #include <test/util/setup_common.h>
17 : : #include <validation.h>
18 : :
19 : : #include <boost/test/unit_test.hpp>
20 : :
21 : : using node::BlockAssembler;
22 : : using node::BlockManager;
23 : : using node::CBlockTemplate;
24 : :
25 : : BOOST_AUTO_TEST_SUITE(blockfilter_index_tests)
26 : :
27 : 2 : struct BuildChainTestingSetup : public TestChain100Setup {
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 : :
32 : 114 : static bool CheckFilterLookups(BlockFilterIndex& filter_index, const CBlockIndex* block_index,
33 : : uint256& last_header, const BlockManager& blockman)
34 : : {
35 : 114 : BlockFilter expected_filter;
36 [ + - - + ]: 114 : if (!ComputeFilter(filter_index.GetFilterType(), *block_index, expected_filter, blockman)) {
37 [ # # # # ]: 0 : BOOST_ERROR("ComputeFilter failed on block " << block_index->nHeight);
38 : 0 : return false;
39 : : }
40 : :
41 [ + - ]: 114 : BlockFilter filter;
42 : 114 : uint256 filter_header;
43 : 114 : std::vector<BlockFilter> filters;
44 : 114 : std::vector<uint256> filter_hashes;
45 : :
46 [ + - + - : 228 : BOOST_CHECK(filter_index.LookupFilter(block_index, filter));
+ - + - ]
47 [ + - + - : 228 : BOOST_CHECK(filter_index.LookupFilterHeader(block_index, filter_header));
+ - + - ]
48 [ + - + - : 228 : BOOST_CHECK(filter_index.LookupFilterRange(block_index->nHeight, block_index, filters));
+ - + - ]
49 [ + - + - : 228 : BOOST_CHECK(filter_index.LookupFilterHashRange(block_index->nHeight, block_index,
+ - + - ]
50 : : filter_hashes));
51 : :
52 [ + - + - ]: 114 : BOOST_CHECK_EQUAL(filters.size(), 1U);
53 [ + - + - ]: 114 : BOOST_CHECK_EQUAL(filter_hashes.size(), 1U);
54 : :
55 [ + - + - : 114 : BOOST_CHECK_EQUAL(filter.GetHash(), expected_filter.GetHash());
+ - + - ]
56 [ + - + - : 114 : BOOST_CHECK_EQUAL(filter_header, expected_filter.ComputeHeader(last_header));
+ - ]
57 [ + - + - : 114 : BOOST_CHECK_EQUAL(filters[0].GetHash(), expected_filter.GetHash());
+ - + - ]
58 [ + - + - : 114 : BOOST_CHECK_EQUAL(filter_hashes[0], expected_filter.GetHash());
+ - ]
59 : :
60 : 114 : filters.clear();
61 [ + - ]: 114 : filter_hashes.clear();
62 : 114 : last_header = filter_header;
63 : 114 : return true;
64 : 228 : }
65 : :
66 : 20 : CBlock BuildChainTestingSetup::CreateBlock(const CBlockIndex* prev,
67 : : const std::vector<CMutableTransaction>& txns,
68 : : const CScript& scriptPubKey)
69 : : {
70 : 20 : BlockAssembler::Options options;
71 : 20 : options.coinbase_output_script = scriptPubKey;
72 [ + - + - : 20 : std::unique_ptr<CBlockTemplate> pblocktemplate = BlockAssembler{m_node.chainman->ActiveChainstate(), m_node.mempool.get(), options}.CreateNewBlock();
+ - ]
73 : 20 : CBlock& block = pblocktemplate->block;
74 : 20 : block.hashPrevBlock = prev->GetBlockHash();
75 : 20 : block.nTime = prev->nTime + 1;
76 : :
77 : : // Replace mempool-selected txns with just coinbase plus passed-in txns:
78 [ + - ]: 20 : block.vtx.resize(1);
79 [ - + ]: 20 : for (const CMutableTransaction& tx : txns) {
80 [ # # # # : 0 : block.vtx.push_back(MakeTransactionRef(tx));
# # ]
81 : : }
82 : 20 : {
83 [ + - + - ]: 20 : CMutableTransaction tx_coinbase{*block.vtx.at(0)};
84 [ + - + - ]: 20 : tx_coinbase.vin.at(0).scriptSig = CScript{} << prev->nHeight + 1;
85 [ + - + - : 40 : block.vtx.at(0) = MakeTransactionRef(std::move(tx_coinbase));
- + ]
86 [ + - ]: 20 : block.hashMerkleRoot = BlockMerkleRoot(block);
87 : 0 : }
88 : :
89 [ + - + - : 37 : while (!CheckProofOfWork(block.GetHash(), block.nBits, m_node.chainman->GetConsensus())) ++block.nNonce;
+ + ]
90 : :
91 [ + - ]: 20 : return block;
92 : 20 : }
93 : :
94 : 2 : bool BuildChainTestingSetup::BuildChain(const CBlockIndex* pindex,
95 : : const CScript& coinbase_script_pub_key,
96 : : size_t length,
97 : : std::vector<std::shared_ptr<CBlock>>& chain)
98 : : {
99 : 2 : std::vector<CMutableTransaction> no_txns;
100 : :
101 [ + - ]: 2 : chain.resize(length);
102 [ + + ]: 22 : for (auto& block : chain) {
103 [ + - - + ]: 40 : block = std::make_shared<CBlock>(CreateBlock(pindex, no_txns, coinbase_script_pub_key));
104 : 20 : CBlockHeader header = block->GetBlockHeader();
105 : :
106 [ + - ]: 20 : BlockValidationState state;
107 [ + - + - : 20 : if (!Assert(m_node.chainman)->ProcessNewBlockHeaders({{header}}, true, state, &pindex)) {
- + ]
108 : 0 : return false;
109 : : }
110 : 20 : }
111 : :
112 : : return true;
113 : 2 : }
114 : :
115 [ + - + - : 7 : BOOST_FIXTURE_TEST_CASE(blockfilter_index_initial_sync, BuildChainTestingSetup)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
116 : : {
117 [ + - ]: 1 : BlockFilterIndex filter_index(interfaces::MakeChain(m_node), BlockFilterType::BASIC, 1 << 20, true);
118 [ + - + - : 2 : BOOST_REQUIRE(filter_index.Init());
+ - + - ]
119 : :
120 : 1 : uint256 last_header;
121 : :
122 : : // Filter should not be found in the index before it is started.
123 : 1 : {
124 [ + - ]: 1 : LOCK(cs_main);
125 : :
126 [ + - ]: 1 : BlockFilter filter;
127 : 1 : uint256 filter_header;
128 : 1 : std::vector<BlockFilter> filters;
129 : 1 : std::vector<uint256> filter_hashes;
130 : :
131 [ + - + - ]: 1 : for (const CBlockIndex* block_index = m_node.chainman->ActiveChain().Genesis();
132 [ + + ]: 102 : block_index != nullptr;
133 [ + - ]: 101 : block_index = m_node.chainman->ActiveChain().Next(block_index)) {
134 [ + - + - : 202 : BOOST_CHECK(!filter_index.LookupFilter(block_index, filter));
+ - + - ]
135 [ + - + - : 202 : BOOST_CHECK(!filter_index.LookupFilterHeader(block_index, filter_header));
+ - + - ]
136 [ + - + - : 202 : BOOST_CHECK(!filter_index.LookupFilterRange(block_index->nHeight, block_index, filters));
+ - + - ]
137 [ + - + - : 202 : BOOST_CHECK(!filter_index.LookupFilterHashRange(block_index->nHeight, block_index,
+ - + - ]
138 : : filter_hashes));
139 : : }
140 [ + - ]: 1 : }
141 : :
142 : : // BlockUntilSyncedToCurrentChain should return false before index is started.
143 [ + - + - : 2 : BOOST_CHECK(!filter_index.BlockUntilSyncedToCurrentChain());
+ - + - ]
144 : :
145 [ + - + - : 2 : BOOST_REQUIRE(filter_index.StartBackgroundSync());
+ - + - ]
146 : :
147 : : // Allow filter index to catch up with the block index.
148 [ + - + - ]: 1 : IndexWaitSynced(filter_index, *Assert(m_node.shutdown_signal));
149 : :
150 : : // Check that filter index has all blocks that were in the chain before it started.
151 : 1 : {
152 [ + - ]: 1 : LOCK(cs_main);
153 : 1 : const CBlockIndex* block_index;
154 [ + - + - ]: 1 : for (block_index = m_node.chainman->ActiveChain().Genesis();
155 [ + + ]: 102 : block_index != nullptr;
156 [ + - ]: 101 : block_index = m_node.chainman->ActiveChain().Next(block_index)) {
157 [ + - ]: 101 : CheckFilterLookups(filter_index, block_index, last_header, m_node.chainman->m_blockman);
158 : : }
159 : 0 : }
160 : :
161 : : // Create two forks.
162 : 1 : const CBlockIndex* tip;
163 : 1 : {
164 [ + - ]: 1 : LOCK(cs_main);
165 [ + - + - : 2 : tip = m_node.chainman->ActiveChain().Tip();
+ - ]
166 : 0 : }
167 : 1 : CKey coinbase_key_A = GenerateRandomKey();
168 : 1 : CKey coinbase_key_B = GenerateRandomKey();
169 [ + - + - : 1 : CScript coinbase_script_pub_key_A = GetScriptForDestination(PKHash(coinbase_key_A.GetPubKey()));
+ - ]
170 [ + - + - : 1 : CScript coinbase_script_pub_key_B = GetScriptForDestination(PKHash(coinbase_key_B.GetPubKey()));
+ - ]
171 : 1 : std::vector<std::shared_ptr<CBlock>> chainA, chainB;
172 [ + - + - : 2 : BOOST_REQUIRE(BuildChain(tip, coinbase_script_pub_key_A, 10, chainA));
+ - + - ]
173 [ + - + - : 2 : BOOST_REQUIRE(BuildChain(tip, coinbase_script_pub_key_B, 10, chainB));
+ - ]
174 : :
175 : : // Check that new blocks on chain A get indexed.
176 : 1 : uint256 chainA_last_header = last_header;
177 [ + + ]: 3 : for (size_t i = 0; i < 2; i++) {
178 [ + - ]: 2 : const auto& block = chainA[i];
179 [ + - + - : 8 : BOOST_REQUIRE(Assert(m_node.chainman)->ProcessNewBlock(block, true, true, nullptr));
+ - + - +
- + - ]
180 : : }
181 [ + + ]: 3 : for (size_t i = 0; i < 2; i++) {
182 [ + - ]: 2 : const auto& block = chainA[i];
183 : 2 : const CBlockIndex* block_index;
184 : 2 : {
185 [ + - ]: 2 : LOCK(cs_main);
186 [ + - + - : 2 : block_index = m_node.chainman->m_blockman.LookupBlockIndex(block->GetHash());
+ - ]
187 : 0 : }
188 : :
189 [ + - + - : 4 : BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
+ - + - ]
190 [ + - ]: 2 : CheckFilterLookups(filter_index, block_index, chainA_last_header, m_node.chainman->m_blockman);
191 : : }
192 : :
193 : : // Reorg to chain B.
194 : 1 : uint256 chainB_last_header = last_header;
195 [ + + ]: 4 : for (size_t i = 0; i < 3; i++) {
196 [ + - ]: 3 : const auto& block = chainB[i];
197 [ + - + - : 12 : BOOST_REQUIRE(Assert(m_node.chainman)->ProcessNewBlock(block, true, true, nullptr));
+ - + - +
- + - ]
198 : : }
199 [ + + ]: 4 : for (size_t i = 0; i < 3; i++) {
200 [ + - ]: 3 : const auto& block = chainB[i];
201 : 3 : const CBlockIndex* block_index;
202 : 3 : {
203 [ + - ]: 3 : LOCK(cs_main);
204 [ + - + - : 3 : block_index = m_node.chainman->m_blockman.LookupBlockIndex(block->GetHash());
+ - ]
205 : 0 : }
206 : :
207 [ + - + - : 6 : BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
+ - + - ]
208 [ + - ]: 3 : CheckFilterLookups(filter_index, block_index, chainB_last_header, m_node.chainman->m_blockman);
209 : : }
210 : :
211 : : // Check that filters for stale blocks on A can be retrieved.
212 : 1 : chainA_last_header = last_header;
213 [ + + ]: 3 : for (size_t i = 0; i < 2; i++) {
214 [ + - ]: 2 : const auto& block = chainA[i];
215 : 2 : const CBlockIndex* block_index;
216 : 2 : {
217 [ + - ]: 2 : LOCK(cs_main);
218 [ + - + - : 2 : block_index = m_node.chainman->m_blockman.LookupBlockIndex(block->GetHash());
+ - ]
219 : 0 : }
220 : :
221 [ + - + - : 4 : BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
+ - + - ]
222 [ + - ]: 2 : CheckFilterLookups(filter_index, block_index, chainA_last_header, m_node.chainman->m_blockman);
223 : : }
224 : :
225 : : // Reorg back to chain A.
226 [ + + ]: 3 : for (size_t i = 2; i < 4; i++) {
227 [ + - ]: 2 : const auto& block = chainA[i];
228 [ + - + - : 8 : BOOST_REQUIRE(Assert(m_node.chainman)->ProcessNewBlock(block, true, true, nullptr));
+ - + - +
- + - ]
229 : : }
230 : :
231 : : // Check that chain A and B blocks can be retrieved.
232 : 1 : chainA_last_header = last_header;
233 : 1 : chainB_last_header = last_header;
234 [ + + ]: 4 : for (size_t i = 0; i < 3; i++) {
235 : 3 : const CBlockIndex* block_index;
236 : :
237 : 3 : {
238 [ + - ]: 3 : LOCK(cs_main);
239 [ + - + - : 3 : block_index = m_node.chainman->m_blockman.LookupBlockIndex(chainA[i]->GetHash());
+ - ]
240 : 0 : }
241 [ + - + - : 6 : BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
+ - + - ]
242 [ + - ]: 3 : CheckFilterLookups(filter_index, block_index, chainA_last_header, m_node.chainman->m_blockman);
243 : :
244 : 3 : {
245 [ + - ]: 3 : LOCK(cs_main);
246 [ + - + - : 3 : block_index = m_node.chainman->m_blockman.LookupBlockIndex(chainB[i]->GetHash());
+ - ]
247 : 0 : }
248 [ + - + - : 6 : BOOST_CHECK(filter_index.BlockUntilSyncedToCurrentChain());
+ - + - ]
249 [ + - ]: 3 : CheckFilterLookups(filter_index, block_index, chainB_last_header, m_node.chainman->m_blockman);
250 : : }
251 : :
252 : : // Test lookups for a range of filters/hashes.
253 : 1 : std::vector<BlockFilter> filters;
254 : 1 : std::vector<uint256> filter_hashes;
255 : :
256 : 1 : {
257 [ + - ]: 1 : LOCK(cs_main);
258 [ + - + - : 2 : tip = m_node.chainman->ActiveChain().Tip();
+ - ]
259 : 0 : }
260 [ + - + - : 2 : BOOST_CHECK(filter_index.LookupFilterRange(0, tip, filters));
+ - + - ]
261 [ + - + - : 2 : BOOST_CHECK(filter_index.LookupFilterHashRange(0, tip, filter_hashes));
+ - - + ]
262 : :
263 [ - + ]: 1 : assert(tip->nHeight >= 0);
264 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(filters.size(), tip->nHeight + 1U);
265 [ + - + - ]: 1 : BOOST_CHECK_EQUAL(filter_hashes.size(), tip->nHeight + 1U);
266 : :
267 : 1 : filters.clear();
268 [ + - ]: 1 : filter_hashes.clear();
269 : :
270 [ + - ]: 1 : filter_index.Interrupt();
271 [ + - ]: 1 : filter_index.Stop();
272 : 1 : }
273 : :
274 [ + - + - : 7 : BOOST_FIXTURE_TEST_CASE(blockfilter_index_init_destroy, BasicTestingSetup)
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- ]
275 : : {
276 : 1 : BlockFilterIndex* filter_index;
277 : :
278 : 1 : filter_index = GetBlockFilterIndex(BlockFilterType::BASIC);
279 [ + - ]: 2 : BOOST_CHECK(filter_index == nullptr);
280 : :
281 [ + - + - ]: 3 : BOOST_CHECK(InitBlockFilterIndex([&]{ return interfaces::MakeChain(m_node); }, BlockFilterType::BASIC, 1 << 20, true, false));
282 : :
283 : 1 : filter_index = GetBlockFilterIndex(BlockFilterType::BASIC);
284 [ + - ]: 2 : BOOST_CHECK(filter_index != nullptr);
285 [ + - ]: 2 : BOOST_CHECK(filter_index->GetFilterType() == BlockFilterType::BASIC);
286 : :
287 : : // Initialize returns false if index already exists.
288 [ + - + - : 3 : BOOST_CHECK(!InitBlockFilterIndex([&]{ return interfaces::MakeChain(m_node); }, BlockFilterType::BASIC, 1 << 20, true, false));
+ - ]
289 : :
290 : 1 : int iter_count = 0;
291 [ + - ]: 2 : ForEachBlockFilterIndex([&iter_count](BlockFilterIndex& _index) { iter_count++; });
292 [ + - ]: 1 : BOOST_CHECK_EQUAL(iter_count, 1);
293 : :
294 [ + - + - ]: 2 : BOOST_CHECK(DestroyBlockFilterIndex(BlockFilterType::BASIC));
295 : :
296 : : // Destroy returns false because index was already destroyed.
297 [ + - + - ]: 2 : BOOST_CHECK(!DestroyBlockFilterIndex(BlockFilterType::BASIC));
298 : :
299 : 1 : filter_index = GetBlockFilterIndex(BlockFilterType::BASIC);
300 [ + - ]: 2 : BOOST_CHECK(filter_index == nullptr);
301 : :
302 : : // Reinitialize index.
303 [ + - + - ]: 3 : BOOST_CHECK(InitBlockFilterIndex([&]{ return interfaces::MakeChain(m_node); }, BlockFilterType::BASIC, 1 << 20, true, false));
304 : :
305 : 1 : DestroyAllBlockFilterIndexes();
306 : :
307 : 1 : filter_index = GetBlockFilterIndex(BlockFilterType::BASIC);
308 [ + - ]: 2 : BOOST_CHECK(filter_index == nullptr);
309 : 1 : }
310 : :
311 : : BOOST_AUTO_TEST_SUITE_END()
|
