1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
use crate::{
types::{BlockHeader, H256Le, Transaction},
utils::hash256_merkle_step,
Error,
};
use codec::{Decode, Encode};
use scale_info::TypeInfo;
#[cfg(any(feature = "parser", test))]
use crate::{parser::BytesParser, types::CompactUint};
#[cfg(not(feature = "std"))]
use alloc::vec::Vec;
const MAX_BLOCK_WEIGHT: u32 = 4_000_000;
const WITNESS_SCALE_FACTOR: u32 = 4;
const MIN_TRANSACTION_WEIGHT: u32 = WITNESS_SCALE_FACTOR * 60;
const MAX_TRANSACTIONS_IN_PROOF: u32 = MAX_BLOCK_WEIGHT / MIN_TRANSACTION_WEIGHT;
#[derive(Clone, Encode, Decode, TypeInfo, PartialEq)]
#[cfg_attr(feature = "std", derive(Debug))]
pub struct PartialTransactionProof {
pub transaction: Transaction,
pub tx_encoded_len: u32,
pub merkle_proof: MerkleProof,
}
#[derive(Clone)]
#[cfg_attr(feature = "std", derive(Debug))]
pub struct MerkleTree;
#[derive(Encode, Decode, TypeInfo, PartialEq, Default, Clone)]
#[cfg_attr(feature = "std", derive(Debug))]
pub struct MerkleProof {
pub block_header: BlockHeader,
pub flag_bits: Vec<bool>,
pub transactions_count: u32,
pub hashes: Vec<H256Le>,
}
struct MerkleProofTraversal {
bits_used: usize,
hashes_used: usize,
merkle_position: Option<u32>,
hash_position: Option<usize>,
}
#[derive(Clone, Debug, PartialEq)]
pub struct ProofResult {
pub extracted_root: H256Le,
pub transaction_hash: H256Le,
pub transaction_position: u32,
pub transaction: Transaction,
pub tx_count: u32,
pub block_hash: H256Le,
}
impl MerkleTree {
pub fn compute_width(transactions_count: u32, height: u32) -> u32 {
(transactions_count + (1 << height) - 1) >> height
}
pub fn compute_height(transactions_count: u32) -> u32 {
let mut height = 0;
while Self::compute_width(transactions_count, height) > 1 {
height += 1;
}
height
}
pub fn compute_root(index: u32, height: u32, transactions_count: u32, hashes: &[H256Le]) -> Result<H256Le, Error> {
if height == 0 {
Ok(hashes[index as usize])
} else {
let left = Self::compute_root(
index.checked_mul(2).ok_or(Error::ArithmeticOverflow)?,
height.checked_sub(1).ok_or(Error::ArithmeticUnderflow)?,
transactions_count,
hashes,
)?;
let right_index = index
.checked_mul(2)
.ok_or(Error::ArithmeticOverflow)?
.checked_add(1)
.ok_or(Error::ArithmeticOverflow)?;
let right = if right_index < Self::compute_width(transactions_count, height - 1) {
Self::compute_root(
right_index,
height.checked_sub(1).ok_or(Error::ArithmeticUnderflow)?,
transactions_count,
hashes,
)?
} else {
left
};
Ok(hash256_merkle_step(&left.to_bytes_le(), &right.to_bytes_le()))
}
}
}
impl PartialTransactionProof {
pub fn verify_proof(self) -> Result<ProofResult, Error> {
let mut traversal = MerkleProofTraversal {
bits_used: 0,
hashes_used: 0,
merkle_position: None,
hash_position: None,
};
if self.merkle_proof.transactions_count == 0 {
return Err(Error::MalformedMerkleProof);
}
if self.merkle_proof.transactions_count > MAX_TRANSACTIONS_IN_PROOF {
return Err(Error::MalformedMerkleProof);
}
if self.merkle_proof.flag_bits.len() < self.merkle_proof.hashes.len() {
return Err(Error::MalformedMerkleProof);
}
let root = self.merkle_proof.traverse_and_extract(
self.merkle_proof.compute_partial_tree_height(),
0,
&mut traversal,
)?;
let merkle_position = traversal.merkle_position.ok_or(Error::InvalidMerkleProof)?;
let hash_position = traversal.hash_position.ok_or(Error::InvalidMerkleProof)?;
if traversal.hashes_used != self.merkle_proof.hashes.len() {
return Err(Error::MalformedMerkleProof);
}
if traversal
.bits_used
.checked_add(7)
.ok_or(Error::ArithmeticOverflow)?
.checked_div(8)
.ok_or(Error::ArithmeticUnderflow)?
!= self
.merkle_proof
.flag_bits
.len()
.checked_add(7)
.ok_or(Error::ArithmeticOverflow)?
.checked_div(8)
.ok_or(Error::ArithmeticUnderflow)?
{
return Err(Error::MalformedMerkleProof);
}
let tx_id = self.transaction.tx_id_bounded(self.tx_encoded_len)?;
if self.merkle_proof.hashes[hash_position] != tx_id {
return Err(Error::InvalidTxid);
}
Ok(ProofResult {
extracted_root: root,
transaction_hash: self.merkle_proof.hashes[hash_position],
transaction_position: merkle_position,
transaction: self.transaction,
tx_count: self.merkle_proof.transactions_count,
block_hash: self.merkle_proof.block_header.hash,
})
}
}
impl MerkleProof {
pub fn compute_partial_tree_width(&self, height: u32) -> u32 {
MerkleTree::compute_width(self.transactions_count, height)
}
pub fn compute_partial_tree_height(&self) -> u32 {
MerkleTree::compute_height(self.transactions_count)
}
pub fn compute_merkle_root(&self, index: u32, height: u32, tx_ids: &[H256Le]) -> Result<H256Le, Error> {
MerkleTree::compute_root(index, height, self.transactions_count, &tx_ids.to_vec())
}
fn traverse_and_extract(
&self,
height: u32,
pos: u32,
traversal: &mut MerkleProofTraversal,
) -> Result<H256Le, Error> {
let parent_of_hash = *self.flag_bits.get(traversal.bits_used).ok_or(Error::EndOfFile)?;
traversal.bits_used = traversal.bits_used.checked_add(1).ok_or(Error::ArithmeticOverflow)?;
if height == 0 || !parent_of_hash {
if traversal.hashes_used >= self.hashes.len() {
return Err(Error::MalformedMerkleProof);
}
let hash = self.hashes[traversal.hashes_used];
if height == 0 && parent_of_hash {
traversal.merkle_position = Some(pos);
traversal.hash_position = Some(traversal.hashes_used);
}
traversal.hashes_used = traversal.hashes_used.checked_add(1).ok_or(Error::ArithmeticOverflow)?;
return Ok(hash);
}
let next_height = height.checked_sub(1).ok_or(Error::ArithmeticUnderflow)?;
let left_index = pos.checked_mul(2).ok_or(Error::ArithmeticOverflow)?;
let right_index = left_index.checked_add(1).ok_or(Error::ArithmeticOverflow)?;
let left = self.traverse_and_extract(next_height, left_index, traversal)?;
let right = if right_index < self.compute_partial_tree_width(next_height) {
self.traverse_and_extract(next_height, right_index, traversal)?
} else {
left
};
let hashed_bytes = hash256_merkle_step(&left.to_bytes_le(), &right.to_bytes_le());
Ok(hashed_bytes)
}
pub(crate) fn traverse_and_build(
&mut self,
height: u32,
pos: u32,
tx_ids: &[H256Le],
matches: &[bool],
) -> Result<(), Error> {
let mut parent_of_match = false;
let mut p = pos << height;
while p < (pos + 1) << height && p < self.transactions_count {
parent_of_match |= matches[p as usize];
p += 1;
}
self.flag_bits.push(parent_of_match);
if height == 0 || !parent_of_match {
let hash = self.compute_merkle_root(pos, height, tx_ids)?;
self.hashes.push(hash);
} else {
let next_height = height.checked_sub(1).ok_or(Error::ArithmeticUnderflow)?;
let left_index = pos.checked_mul(2).ok_or(Error::ArithmeticOverflow)?;
let right_index = left_index.checked_add(1).ok_or(Error::ArithmeticOverflow)?;
self.traverse_and_build(next_height, left_index, tx_ids, matches)?;
if right_index < self.compute_partial_tree_width(next_height) {
self.traverse_and_build(next_height, right_index, tx_ids, matches)?;
}
}
Ok(())
}
#[cfg(any(feature = "parser", test))]
pub fn parse(merkle_proof: &[u8]) -> Result<MerkleProof, Error> {
let mut proof_parser = BytesParser::new(merkle_proof);
let block_header = proof_parser.parse()?;
let transactions_count = proof_parser.parse()?;
let hashes_count: CompactUint = proof_parser.parse()?;
let mut hashes = Vec::<H256Le>::new();
for _ in 0..hashes_count.value {
hashes.push(proof_parser.parse()?);
}
let flag_bits_count: CompactUint = proof_parser.parse()?;
let mut flag_bits = Vec::new();
for _ in 0..flag_bits_count.value {
flag_bits.extend(proof_parser.parse::<Vec<bool>>()?);
}
Ok(MerkleProof {
block_header,
flag_bits,
transactions_count,
hashes,
})
}
}
#[cfg(test)]
mod tests {
use crate::parser::parse_transaction;
use super::*;
use primitive_types::H256;
use std::str::FromStr;
const PROOF_HEX: &str = "00000020ecf348128755dbeea5deb8eddf64566d9d4e59bc65d485000000000000000000901f0d92a66ee7dcefd02fa282ca63ce85288bab628253da31ef259b24abe8a0470a385a45960018e8d672f8a90a00000d0bdabada1fb6e3cef7f5c6e234621e3230a2f54efc1cba0b16375d9980ecbc023cbef3ba8d8632ea220927ec8f95190b30769eb35d87618f210382c9445f192504074f56951b772efa43b89320d9c430b0d156b93b7a1ff316471e715151a0619a39392657f25289eb713168818bd5b37476f1bc59b166deaa736d8a58756f9d7ce2aef46d8004c5fe3293d883838f87b5f1da03839878895b71530e9ff89338bb6d4578b3c3135ff3e8671f9a64d43b22e14c2893e8271cecd420f11d2359307403bb1f3128885b3912336045269ef909d64576b93e816fa522c8c027fe408700dd4bdee0254c069ccb728d3516fe1e27578b31d70695e3e35483da448f3a951273e018de7f2a8f657064b013c6ede75c74bbd7f98fdae1c2ac6789ee7b21a791aa29d60e89fff2d1d2b1ada50aa9f59f403823c8c58bb092dc58dc09b28158ca15447da9c3bedb0b160f3fe1668d5a27716e27661bcb75ddbf3468f5c76b7bed1004c6b4df4da2ce80b831a7c260b515e6355e1c306373d2233e8de6fda3674ed95d17a01a1f64b27ba88c3676024fbf8d5dd962ffc4d5e9f3b1700763ab88047f7d0000";
const TX_HEX: &str = "02000000013f123860735a487635587ec2e40f8c979ff487baed0af3af0011c14e19a5c368be0700008a47304402202b0f871fba25ae9908f5a4a3075237bd311265309ffa4e58f57e146cdd01916702204a1230f836d039713bbe7063dd9ebefb54e49c1cf30aec1b9bd7df820cc1ff3301410433e05b29670f19cbc499f207f11abe1c69f77f00d5cbb9dbec5b5fe7527e2f41fa1e90f10a05e9c0a34d255988082e190c9ee7ea05f62297d4f76d9b61d7561bffffffff01d69b0100000000001976a914cd55050b6536a764c00d061afa7500d5a552558e88ac00000000";
#[test]
fn test_parse_proof() {
let raw_proof = hex::decode(PROOF_HEX).unwrap();
let proof = MerkleProof::parse(&raw_proof).unwrap();
let expected_merkle_root =
H256::from_str("a0e8ab249b25ef31da538262ab8b2885ce63ca82a22fd0efdce76ea6920d1f90").unwrap();
assert_eq!(proof.block_header.merkle_root, expected_merkle_root);
assert_eq!(proof.transactions_count, 2729);
assert_eq!(proof.hashes.len(), 13);
let expected_hash = H256Le::from_hex_be("02bcec80995d37160bba1cfc4ef5a230321e6234e2c6f5f7cee3b61fdabada0b");
assert_eq!(proof.hashes[0], expected_hash);
assert_eq!(proof.flag_bits.len(), 4 * 8);
}
#[test]
fn test_parse_proof_testnet() {
let raw_proof = hex::decode("00000020b0b3d77b97015b519553423c96642b33ca534c50ecefd133640000000000000029a0a725684aeca24af83e3ba0a3e3ee56adfdf032d19e5acba6d0a262e1580ca354915fd4c8001ac42a7b3a1000000005df41db041b26536b5b7fd7aeea4ea6bdb64f7039e4a566b1fa138a07ed2d3705932955c94ee4755abec003054128b10e0fbcf8dedbbc6236e23286843f1f82a018dc7f5f6fba31aa618fab4acad7df5a5046b6383595798758d30d68c731a14043a50d7cb8560d771fad70c5e52f6d7df26df13ca457655afca2cbab2e3b135c0383525b28fca31296c809641205962eb353fb88a9f3602e98a93b1e9ffd469b023d00").unwrap();
let proof = MerkleProof::parse(&raw_proof).unwrap();
let expected_block_header =
H256Le::from_hex_be("000000000000002e59ed7b899b3f0f83c48d0548309a8fb7693297e3937fe1d3");
assert_eq!(proof.block_header.hash, expected_block_header);
}
#[test]
fn test_compute_tree_width() {
let proof = MerkleProof::parse(&hex::decode(PROOF_HEX).unwrap()).unwrap();
assert_eq!(proof.compute_partial_tree_width(0), proof.transactions_count);
assert_eq!(proof.compute_partial_tree_width(1), proof.transactions_count / 2 + 1);
assert_eq!(proof.compute_partial_tree_width(12), 1);
}
#[test]
fn test_compute_merkle_proof_tree_height() {
let proof = MerkleProof::parse(&hex::decode(PROOF_HEX).unwrap()).unwrap();
assert_eq!(proof.compute_partial_tree_height(), 12);
}
#[test]
fn test_extract_hash() {
let proof = MerkleProof::parse(&hex::decode(PROOF_HEX).unwrap()).unwrap();
let tx = parse_transaction(&hex::decode(TX_HEX).unwrap()).unwrap();
let partial_proof = PartialTransactionProof {
merkle_proof: proof.clone(),
transaction: tx,
tx_encoded_len: TX_HEX.len() as u32 / 2,
};
let merkle_root = H256Le::from_bytes_le(&proof.block_header.merkle_root.to_bytes_le());
let result = partial_proof.verify_proof().unwrap();
assert_eq!(result.extracted_root, merkle_root);
assert_eq!(result.transaction_position, 48);
let expected_tx_hash = H256Le::from_hex_be("61a05151711e4716f31f7a3bb956d1b030c4d92093b843fa2e771b95564f0704");
assert_eq!(result.transaction_hash, expected_tx_hash);
}
#[test]
fn test_parse_regtest_merkle_proof_succeeds() {
let raw_merkle_proof_hex = "0000002031a3479e5062e200279af822d816d02cab347bc3719726541c4fd5edfc3ffd7d680b2710119c752e5fb1b963ad2ee3539f6b3fe0e9b054e681734b631e92c2faf449ca5fffff7f20000000000300000003f0d6a860c811b45bbbe4f0401f26e2fafc40e50bb03782025c0ef82768703d3de263ed560faac245c73725f295eb653268bca3387f9e03b18ca6ab242ce6c54b5625d63322e74c0aa94c794cbf065858bddc5b8ea178fbb0549956149a7d4686010b";
let raw_merkle_proof = hex::decode(&raw_merkle_proof_hex).unwrap();
MerkleProof::parse(&raw_merkle_proof).unwrap();
}
}