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