Skip to content

Commit fac39b5

Browse files
author
MarcoFalke
committed
refactor: SpanReader without nVersion
The field is unused, so remove it. This is also required for future commits.
1 parent c252a0f commit fac39b5

File tree

9 files changed

+25
-34
lines changed

9 files changed

+25
-34
lines changed

‎src/blockfilter.cpp

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@
1616
#include <util/golombrice.h>
1717
#include <util/string.h>
1818

19-
/// Protocol version used to serialize parameters in GCS filter encoding.
20-
static constexpr int GCS_SER_VERSION = 0;
21-
2219
static const std::map<BlockFilterType, std::string> g_filter_types = {
2320
{BlockFilterType::BASIC, "basic"},
2421
};
@@ -49,7 +46,7 @@ GCSFilter::GCSFilter(const Params& params)
4946
GCSFilter::GCSFilter(const Params& params, std::vector<unsigned char> encoded_filter, bool skip_decode_check)
5047
: m_params(params), m_encoded(std::move(encoded_filter))
5148
{
52-
SpanReader stream{GCS_SER_VERSION, m_encoded};
49+
SpanReader stream{m_encoded};
5350

5451
uint64_t N = ReadCompactSize(stream);
5552
m_N = static_cast<uint32_t>(N);
@@ -62,7 +59,7 @@ GCSFilter::GCSFilter(const Params& params, std::vector<unsigned char> encoded_fi
6259

6360
// Verify that the encoded filter contains exactly N elements. If it has too much or too little
6461
// data, a std::ios_base::failure exception will be raised.
65-
BitStreamReader<SpanReader> bitreader{stream};
62+
BitStreamReader bitreader{stream};
6663
for (uint64_t i = 0; i < m_N; ++i) {
6764
GolombRiceDecode(bitreader, m_params.m_P);
6865
}
@@ -103,13 +100,13 @@ GCSFilter::GCSFilter(const Params& params, const ElementSet& elements)
103100

104101
bool GCSFilter::MatchInternal(const uint64_t* element_hashes, size_t size) const
105102
{
106-
SpanReader stream{GCS_SER_VERSION, m_encoded};
103+
SpanReader stream{m_encoded};
107104

108105
// Seek forward by size of N
109106
uint64_t N = ReadCompactSize(stream);
110107
assert(N == m_N);
111108

112-
BitStreamReader<SpanReader> bitreader{stream};
109+
BitStreamReader bitreader{stream};
113110

114111
uint64_t value = 0;
115112
size_t hashes_index = 0;

‎src/psbt.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ struct PSBTInput
382382
}
383383

384384
// Type is compact size uint at beginning of key
385-
SpanReader skey{s.GetVersion(), key};
385+
SpanReader skey{key};
386386
uint64_t type = ReadCompactSize(skey);
387387

388388
// Do stuff based on type
@@ -590,7 +590,7 @@ struct PSBTInput
590590
} else if (key.size() != 65) {
591591
throw std::ios_base::failure("Input Taproot script signature key is not 65 bytes");
592592
}
593-
SpanReader s_key{s.GetVersion(), Span{key}.subspan(1)};
593+
SpanReader s_key{Span{key}.subspan(1)};
594594
XOnlyPubKey xonly;
595595
uint256 hash;
596596
s_key >> xonly;
@@ -632,7 +632,7 @@ struct PSBTInput
632632
} else if (key.size() != 33) {
633633
throw std::ios_base::failure("Input Taproot BIP32 keypath key is not at 33 bytes");
634634
}
635-
SpanReader s_key{s.GetVersion(), Span{key}.subspan(1)};
635+
SpanReader s_key{Span{key}.subspan(1)};
636636
XOnlyPubKey xonly;
637637
s_key >> xonly;
638638
std::set<uint256> leaf_hashes;
@@ -807,7 +807,7 @@ struct PSBTOutput
807807
}
808808

809809
// Type is compact size uint at beginning of key
810-
SpanReader skey{s.GetVersion(), key};
810+
SpanReader skey{key};
811811
uint64_t type = ReadCompactSize(skey);
812812

813813
// Do stuff based on type
@@ -856,7 +856,7 @@ struct PSBTOutput
856856
}
857857
std::vector<unsigned char> tree_v;
858858
s >> tree_v;
859-
SpanReader s_tree{s.GetVersion(), tree_v};
859+
SpanReader s_tree{tree_v};
860860
if (s_tree.empty()) {
861861
throw std::ios_base::failure("Output Taproot tree must not be empty");
862862
}
@@ -1060,7 +1060,7 @@ struct PartiallySignedTransaction
10601060
}
10611061

10621062
// Type is compact size uint at beginning of key
1063-
SpanReader skey{s.GetVersion(), key};
1063+
SpanReader skey{key};
10641064
uint64_t type = ReadCompactSize(skey);
10651065

10661066
// Do stuff based on type

‎src/signet.cpp

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
#include <streams.h>
2323
#include <uint256.h>
2424
#include <util/strencodings.h>
25-
#include <version.h>
2625

2726
static constexpr uint8_t SIGNET_HEADER[4] = {0xec, 0xc7, 0xda, 0xa2};
2827

@@ -99,7 +98,7 @@ std::optional<SignetTxs> SignetTxs::Create(const CBlock& block, const CScript& c
9998
// no signet solution -- allow this to support OP_TRUE as trivial block challenge
10099
} else {
101100
try {
102-
SpanReader v{INIT_PROTO_VERSION, signet_solution};
101+
SpanReader v{signet_solution};
103102
v >> tx_spending.vin[0].scriptSig;
104103
v >> tx_spending.vin[0].scriptWitness.stack;
105104
if (!v.empty()) return std::nullopt; // extraneous data encountered

‎src/streams.h

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -100,16 +100,13 @@ class VectorWriter
100100
class SpanReader
101101
{
102102
private:
103-
const int m_version;
104103
Span<const unsigned char> m_data;
105104

106105
public:
107106
/**
108-
* @param[in] version Serialization Version (including any flags)
109107
* @param[in] data Referenced byte vector to overwrite/append
110108
*/
111-
SpanReader(int version, Span<const unsigned char> data)
112-
: m_version{version}, m_data{data} {}
109+
explicit SpanReader(Span<const unsigned char> data) : m_data{data} {}
113110

114111
template<typename T>
115112
SpanReader& operator>>(T&& obj)
@@ -118,8 +115,6 @@ class SpanReader
118115
return (*this);
119116
}
120117

121-
int GetVersion() const { return m_version; }
122-
123118
size_t size() const { return m_data.size(); }
124119
bool empty() const { return m_data.empty(); }
125120

‎src/test/fuzz/golomb_rice.cpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ FUZZ_TARGET(golomb_rice)
6868

6969
std::vector<uint64_t> decoded_deltas;
7070
{
71-
SpanReader stream{0, golomb_rice_data};
72-
BitStreamReader<SpanReader> bitreader{stream};
71+
SpanReader stream{golomb_rice_data};
72+
BitStreamReader bitreader{stream};
7373
const uint32_t n = static_cast<uint32_t>(ReadCompactSize(stream));
7474
for (uint32_t i = 0; i < n; ++i) {
7575
decoded_deltas.push_back(GolombRiceDecode(bitreader, BASIC_FILTER_P));
@@ -80,14 +80,14 @@ FUZZ_TARGET(golomb_rice)
8080

8181
{
8282
const std::vector<uint8_t> random_bytes = ConsumeRandomLengthByteVector(fuzzed_data_provider, 1024);
83-
SpanReader stream{0, random_bytes};
83+
SpanReader stream{random_bytes};
8484
uint32_t n;
8585
try {
8686
n = static_cast<uint32_t>(ReadCompactSize(stream));
8787
} catch (const std::ios_base::failure&) {
8888
return;
8989
}
90-
BitStreamReader<SpanReader> bitreader{stream};
90+
BitStreamReader bitreader{stream};
9191
for (uint32_t i = 0; i < std::min<uint32_t>(n, 1024); ++i) {
9292
try {
9393
(void)GolombRiceDecode(bitreader, BASIC_FILTER_P);

‎src/test/fuzz/script_assets_test_minimizer.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ CMutableTransaction TxFromHex(const std::string& str)
5454
{
5555
CMutableTransaction tx;
5656
try {
57-
SpanReader{0, CheckedParseHex(str)} >> TX_NO_WITNESS(tx);
57+
SpanReader{CheckedParseHex(str)} >> TX_NO_WITNESS(tx);
5858
} catch (const std::ios_base::failure&) {
5959
throw std::runtime_error("Tx deserialization failure");
6060
}
@@ -68,7 +68,7 @@ std::vector<CTxOut> TxOutsFromJSON(const UniValue& univalue)
6868
for (size_t i = 0; i < univalue.size(); ++i) {
6969
CTxOut txout;
7070
try {
71-
SpanReader{0, CheckedParseHex(univalue[i].get_str())} >> txout;
71+
SpanReader{CheckedParseHex(univalue[i].get_str())} >> txout;
7272
} catch (const std::ios_base::failure&) {
7373
throw std::runtime_error("Prevout invalid format");
7474
}

‎src/test/script_tests.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1470,7 +1470,7 @@ BOOST_AUTO_TEST_CASE(script_HasValidOps)
14701470
static CMutableTransaction TxFromHex(const std::string& str)
14711471
{
14721472
CMutableTransaction tx;
1473-
SpanReader{0, ParseHex(str)} >> TX_NO_WITNESS(tx);
1473+
SpanReader{ParseHex(str)} >> TX_NO_WITNESS(tx);
14741474
return tx;
14751475
}
14761476

@@ -1480,7 +1480,7 @@ static std::vector<CTxOut> TxOutsFromJSON(const UniValue& univalue)
14801480
std::vector<CTxOut> prevouts;
14811481
for (size_t i = 0; i < univalue.size(); ++i) {
14821482
CTxOut txout;
1483-
SpanReader{0, ParseHex(univalue[i].get_str())} >> txout;
1483+
SpanReader{ParseHex(univalue[i].get_str())} >> txout;
14841484
prevouts.push_back(std::move(txout));
14851485
}
14861486
return prevouts;
@@ -1816,7 +1816,7 @@ BOOST_AUTO_TEST_CASE(bip341_keypath_test_vectors)
18161816
for (const auto& vec : vectors.getValues()) {
18171817
auto txhex = ParseHex(vec["given"]["rawUnsignedTx"].get_str());
18181818
CMutableTransaction tx;
1819-
SpanReader{PROTOCOL_VERSION, txhex} >> TX_WITH_WITNESS(tx);
1819+
SpanReader{txhex} >> TX_WITH_WITNESS(tx);
18201820
std::vector<CTxOut> utxos;
18211821
for (const auto& utxo_spent : vec["given"]["utxosSpent"].getValues()) {
18221822
auto script_bytes = ParseHex(utxo_spent["scriptPubKey"].get_str());

‎src/test/streams_tests.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ BOOST_AUTO_TEST_CASE(streams_vector_reader)
125125
{
126126
std::vector<unsigned char> vch = {1, 255, 3, 4, 5, 6};
127127

128-
SpanReader reader{INIT_PROTO_VERSION, vch};
128+
SpanReader reader{vch};
129129
BOOST_CHECK_EQUAL(reader.size(), 6U);
130130
BOOST_CHECK(!reader.empty());
131131

@@ -155,7 +155,7 @@ BOOST_AUTO_TEST_CASE(streams_vector_reader)
155155
BOOST_CHECK_THROW(reader >> d, std::ios_base::failure);
156156

157157
// Read a 4 bytes as a signed int from the beginning of the buffer.
158-
SpanReader new_reader{INIT_PROTO_VERSION, vch};
158+
SpanReader new_reader{vch};
159159
new_reader >> d;
160160
BOOST_CHECK_EQUAL(d, 67370753); // 1,255,3,4 in little-endian base-256
161161
BOOST_CHECK_EQUAL(new_reader.size(), 2U);
@@ -169,7 +169,7 @@ BOOST_AUTO_TEST_CASE(streams_vector_reader)
169169
BOOST_AUTO_TEST_CASE(streams_vector_reader_rvalue)
170170
{
171171
std::vector<uint8_t> data{0x82, 0xa7, 0x31};
172-
SpanReader reader{INIT_PROTO_VERSION, data};
172+
SpanReader reader{data};
173173
uint32_t varint = 0;
174174
// Deserialize into r-value
175175
reader >> VARINT(varint);

‎src/wallet/test/wallet_tests.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -759,7 +759,7 @@ BOOST_FIXTURE_TEST_CASE(wallet_descriptor_test, BasicTestingSetup)
759759
vw << int32_t{0};
760760
vw << int32_t{1};
761761

762-
SpanReader vr{0, malformed_record};
762+
SpanReader vr{malformed_record};
763763
WalletDescriptor w_desc;
764764
BOOST_CHECK_EXCEPTION(vr >> w_desc, std::ios_base::failure, malformed_descriptor);
765765
}

0 commit comments

Comments
 (0)