openethereum/util/triehash/src/lib.rs

372 lines
9.7 KiB
Rust
Raw Normal View History

// Copyright 2015-2017 Parity Technologies (UK) Ltd.
2016-02-05 13:40:41 +01:00
// This file is part of Parity.
// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
2015-12-04 13:12:11 +01:00
//! Generetes trie root.
//!
2015-11-30 15:56:41 +01:00
//! This module should be used to generate trie root hash.
2015-11-29 12:22:35 +01:00
extern crate ethcore_bigint;
extern crate hash;
extern crate rlp;
2015-11-29 19:42:03 +01:00
use std::collections::BTreeMap;
use std::cmp;
use ethcore_bigint::hash::H256;
use hash::keccak;
use rlp::RlpStream;
fn shared_prefix_len<T: Eq>(first: &[T], second: &[T]) -> usize {
let len = cmp::min(first.len(), second.len());
(0..len).take_while(|&i| first[i] == second[i]).count()
}
2015-11-29 19:42:03 +01:00
2015-11-30 15:56:41 +01:00
/// Generates a trie root hash for a vector of values
///
2015-11-30 15:56:41 +01:00
/// ```rust
/// extern crate triehash;
/// use triehash::ordered_trie_root;
///
2015-11-30 15:56:41 +01:00
/// fn main() {
/// let v = vec![From::from("doe"), From::from("reindeer")];
/// let root = "e766d5d51b89dc39d981b41bda63248d7abce4f0225eefd023792a540bcffee3";
/// assert_eq!(ordered_trie_root(v), root.parse().unwrap());
2015-11-30 15:56:41 +01:00
/// }
/// ```
pub fn ordered_trie_root<I>(input: I) -> H256
where I: IntoIterator<Item=Vec<u8>>
{
2015-11-30 15:35:10 +01:00
let gen_input = input
// first put elements into btree to sort them by nibbles
// optimize it later
.into_iter()
.enumerate()
.map(|(i, vec)| (rlp::encode(&i).into_vec(), vec))
.collect::<BTreeMap<_, _>>()
2015-11-30 15:35:10 +01:00
// then move them to a vector
.into_iter()
.map(|(k, v)| (as_nibbles(&k), v) )
2015-11-30 15:35:10 +01:00
.collect();
gen_trie_root(gen_input)
}
2015-11-30 15:56:41 +01:00
/// Generates a trie root hash for a vector of key-values
///
/// ```rust
/// extern crate triehash;
/// use triehash::trie_root;
///
2015-11-30 15:56:41 +01:00
/// fn main() {
/// let v = vec![
/// (From::from("doe"), From::from("reindeer")),
/// (From::from("dog"), From::from("puppy")),
/// (From::from("dogglesworth"), From::from("cat")),
/// ];
///
/// let root = "8aad789dff2f538bca5d8ea56e8abe10f4c7ba3a5dea95fea4cd6e7c3a1168d3";
/// assert_eq!(trie_root(v), root.parse().unwrap());
2015-11-30 15:56:41 +01:00
/// }
/// ```
pub fn trie_root<I>(input: I) -> H256
where I: IntoIterator<Item=(Vec<u8>, Vec<u8>)>
{
2015-11-30 15:35:10 +01:00
let gen_input = input
// first put elements into btree to sort them and to remove duplicates
2015-11-30 15:35:10 +01:00
.into_iter()
.collect::<BTreeMap<_, _>>()
// then move them to a vector
.into_iter()
.map(|(k, v)| (as_nibbles(&k), v) )
2015-11-30 15:35:10 +01:00
.collect();
gen_trie_root(gen_input)
}
2016-01-06 13:53:23 +01:00
/// Generates a key-hashed (secure) trie root hash for a vector of key-values.
///
/// ```rust
/// extern crate triehash;
/// use triehash::sec_trie_root;
///
2016-01-06 13:53:23 +01:00
/// fn main() {
/// let v = vec![
/// (From::from("doe"), From::from("reindeer")),
/// (From::from("dog"), From::from("puppy")),
/// (From::from("dogglesworth"), From::from("cat")),
/// ];
///
/// let root = "d4cd937e4a4368d7931a9cf51686b7e10abb3dce38a39000fd7902a092b64585";
/// assert_eq!(sec_trie_root(v), root.parse().unwrap());
2016-01-06 13:53:23 +01:00
/// }
/// ```
pub fn sec_trie_root(input: Vec<(Vec<u8>, Vec<u8>)>) -> H256 {
let gen_input = input
// first put elements into btree to sort them and to remove duplicates
.into_iter()
.map(|(k, v)| (keccak(k), v))
.collect::<BTreeMap<_, _>>()
2016-01-06 13:53:23 +01:00
// then move them to a vector
.into_iter()
.map(|(k, v)| (as_nibbles(&k), v) )
.collect();
gen_trie_root(gen_input)
}
2015-11-30 15:35:10 +01:00
fn gen_trie_root(input: Vec<(Vec<u8>, Vec<u8>)>) -> H256 {
let mut stream = RlpStream::new();
hash256rlp(&input, 0, &mut stream);
keccak(stream.out())
2015-11-30 15:35:10 +01:00
}
2015-11-29 19:42:03 +01:00
/// Hex-prefix Notation. First nibble has flags: oddness = 2^0 & termination = 2^1.
///
/// The "termination marker" and "leaf-node" specifier are completely equivalent.
///
2015-11-29 19:42:03 +01:00
/// Input values are in range `[0, 0xf]`.
///
2015-11-29 19:42:03 +01:00
/// ```markdown
/// [0,0,1,2,3,4,5] 0x10012345 // 7 > 4
/// [0,1,2,3,4,5] 0x00012345 // 6 > 4
/// [1,2,3,4,5] 0x112345 // 5 > 3
/// [0,0,1,2,3,4] 0x00001234 // 6 > 3
/// [0,1,2,3,4] 0x101234 // 5 > 3
/// [1,2,3,4] 0x001234 // 4 > 3
/// [0,0,1,2,3,4,5,T] 0x30012345 // 7 > 4
/// [0,0,1,2,3,4,T] 0x20001234 // 6 > 4
/// [0,1,2,3,4,5,T] 0x20012345 // 6 > 4
/// [1,2,3,4,5,T] 0x312345 // 5 > 3
/// [1,2,3,4,T] 0x201234 // 4 > 3
/// ```
2015-11-30 15:35:10 +01:00
fn hex_prefix_encode(nibbles: &[u8], leaf: bool) -> Vec<u8> {
2015-11-29 19:42:03 +01:00
let inlen = nibbles.len();
let oddness_factor = inlen % 2;
// next even number divided by two
let reslen = (inlen + 2) >> 1;
2017-08-27 16:50:22 +02:00
let mut res = Vec::with_capacity(reslen);
2015-11-29 19:42:03 +01:00
let first_byte = {
let mut bits = ((inlen as u8 & 1) + (2 * leaf as u8)) << 4;
if oddness_factor == 1 {
bits += nibbles[0];
}
bits
};
res.push(first_byte);
let mut offset = oddness_factor;
2015-11-29 19:42:03 +01:00
while offset < inlen {
let byte = (nibbles[offset] << 4) + nibbles[offset + 1];
res.push(byte);
offset += 2;
}
res
}
/// Converts slice of bytes to nibbles.
2015-11-30 15:35:10 +01:00
fn as_nibbles(bytes: &[u8]) -> Vec<u8> {
2017-08-27 16:50:22 +02:00
let mut res = Vec::with_capacity(bytes.len() * 2);
2015-11-29 19:42:03 +01:00
for i in 0..bytes.len() {
2017-08-27 16:50:22 +02:00
let byte = bytes[i];
res.push(byte >> 4);
res.push(byte & 0b1111);
2015-11-29 19:42:03 +01:00
}
res
}
2015-11-30 15:35:10 +01:00
fn hash256rlp(input: &[(Vec<u8>, Vec<u8>)], pre_len: usize, stream: &mut RlpStream) {
let inlen = input.len();
2015-11-30 01:19:04 +01:00
// in case of empty slice, just append empty data
2015-11-30 15:35:10 +01:00
if inlen == 0 {
stream.append_empty_data();
2015-11-30 01:19:04 +01:00
return;
}
2015-11-30 15:35:10 +01:00
// take slices
let key: &[u8] = &input[0].0;
2015-11-30 15:35:10 +01:00
let value: &[u8] = &input[0].1;
2015-11-30 01:19:04 +01:00
// if the slice contains just one item, append the suffix of the key
// and then append value
2015-11-30 15:35:10 +01:00
if inlen == 1 {
2016-01-27 12:14:57 +01:00
stream.begin_list(2);
2015-11-30 15:35:10 +01:00
stream.append(&hex_prefix_encode(&key[pre_len..], true));
stream.append(&value);
2015-11-30 01:19:04 +01:00
return;
}
// get length of the longest shared prefix in slice keys
2015-11-30 15:35:10 +01:00
let shared_prefix = input.iter()
// skip first element
.skip(1)
// get minimum number of shared nibbles between first and each successive
.fold(key.len(), | acc, &(ref k, _) | {
cmp::min(shared_prefix_len(key, k), acc)
2015-11-30 15:35:10 +01:00
});
2015-11-30 01:19:04 +01:00
// if shared prefix is higher than current prefix append its
// new part of the key to the stream
// then recursively append suffixes of all items who had this key
if shared_prefix > pre_len {
2016-01-27 12:14:57 +01:00
stream.begin_list(2);
2015-11-30 15:35:10 +01:00
stream.append(&hex_prefix_encode(&key[pre_len..shared_prefix], false));
hash256aux(input, shared_prefix, stream);
2015-11-30 01:19:04 +01:00
return;
}
// an item for every possible nibble/suffix
// + 1 for data
2016-01-27 12:14:57 +01:00
stream.begin_list(17);
2015-11-30 01:19:04 +01:00
// if first key len is equal to prefix_len, move to next element
2015-11-30 15:35:10 +01:00
let mut begin = match pre_len == key.len() {
2015-11-30 01:19:04 +01:00
true => 1,
false => 0
};
// iterate over all possible nibbles
for i in 0..16 {
// cout how many successive elements have same next nibble
2015-12-02 02:44:45 +01:00
let len = match begin < input.len() {
true => input[begin..].iter()
2015-12-02 15:03:47 +01:00
.take_while(| pair | pair.0[pre_len] == i )
.count(),
2015-12-02 02:44:45 +01:00
false => 0
};
2015-11-30 01:19:04 +01:00
// if at least 1 successive element has the same nibble
// append their suffixes
match len {
0 => { stream.append_empty_data(); },
2015-11-30 15:35:10 +01:00
_ => hash256aux(&input[begin..(begin + len)], pre_len + 1, stream)
2015-11-29 19:42:03 +01:00
}
2015-11-30 01:19:04 +01:00
begin += len;
}
2016-07-19 20:42:23 +02:00
// if fist key len is equal prefix, append its value
2015-11-30 15:35:10 +01:00
match pre_len == key.len() {
true => { stream.append(&value); },
false => { stream.append_empty_data(); }
2015-11-29 19:42:03 +01:00
};
}
2015-11-30 15:35:10 +01:00
fn hash256aux(input: &[(Vec<u8>, Vec<u8>)], pre_len: usize, stream: &mut RlpStream) {
2015-11-29 19:42:03 +01:00
let mut s = RlpStream::new();
2015-11-30 15:35:10 +01:00
hash256rlp(input, pre_len, &mut s);
let out = s.out();
2015-11-29 19:42:03 +01:00
match out.len() {
0...31 => stream.append_raw(&out, 1),
_ => stream.append(&keccak(out))
2015-11-29 19:42:03 +01:00
};
}
2015-11-30 15:56:41 +01:00
#[test]
fn test_nibbles() {
let v = vec![0x31, 0x23, 0x45];
let e = vec![3, 1, 2, 3, 4, 5];
assert_eq!(as_nibbles(&v), e);
// A => 65 => 0x41 => [4, 1]
let v: Vec<u8> = From::from("A");
let e = vec![4, 1];
2015-11-30 15:56:41 +01:00
assert_eq!(as_nibbles(&v), e);
}
2015-11-29 19:42:03 +01:00
#[cfg(test)]
mod tests {
use super::{trie_root, shared_prefix_len, hex_prefix_encode};
#[test]
fn test_hex_prefix_encode() {
let v = vec![0, 0, 1, 2, 3, 4, 5];
let e = vec![0x10, 0x01, 0x23, 0x45];
let h = hex_prefix_encode(&v, false);
assert_eq!(h, e);
let v = vec![0, 1, 2, 3, 4, 5];
let e = vec![0x00, 0x01, 0x23, 0x45];
let h = hex_prefix_encode(&v, false);
assert_eq!(h, e);
let v = vec![0, 1, 2, 3, 4, 5];
let e = vec![0x20, 0x01, 0x23, 0x45];
let h = hex_prefix_encode(&v, true);
assert_eq!(h, e);
let v = vec![1, 2, 3, 4, 5];
let e = vec![0x31, 0x23, 0x45];
let h = hex_prefix_encode(&v, true);
assert_eq!(h, e);
let v = vec![1, 2, 3, 4];
let e = vec![0x00, 0x12, 0x34];
let h = hex_prefix_encode(&v, false);
assert_eq!(h, e);
let v = vec![4, 1];
let e = vec![0x20, 0x41];
let h = hex_prefix_encode(&v, true);
assert_eq!(h, e);
}
#[test]
fn simple_test() {
assert_eq!(trie_root(vec![
2017-06-28 16:41:08 +02:00
(b"A".to_vec(), b"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa".to_vec())
]), "d23786fb4a010da3ce639d66d5e904a11dbc02746d1ce25029e53290cabf28ab".parse().unwrap());
}
2015-11-29 19:42:03 +01:00
#[test]
2015-12-03 00:29:31 +01:00
fn test_triehash_out_of_order() {
2015-12-01 12:24:58 +01:00
assert!(trie_root(vec![
(vec![0x01u8, 0x23], vec![0x01u8, 0x23]),
2015-12-01 12:26:20 +01:00
(vec![0x81u8, 0x23], vec![0x81u8, 0x23]),
2015-12-01 12:24:58 +01:00
(vec![0xf1u8, 0x23], vec![0xf1u8, 0x23]),
2015-12-01 12:26:20 +01:00
]) ==
2015-12-01 12:24:58 +01:00
trie_root(vec![
(vec![0x01u8, 0x23], vec![0x01u8, 0x23]),
(vec![0xf1u8, 0x23], vec![0xf1u8, 0x23]),
(vec![0x81u8, 0x23], vec![0x81u8, 0x23]),
]));
}
#[test]
fn test_shared_prefix() {
let a = vec![1,2,3,4,5,6];
let b = vec![4,2,3,4,5,6];
assert_eq!(shared_prefix_len(&a, &b), 0);
}
#[test]
fn test_shared_prefix2() {
let a = vec![1,2,3,3,5];
let b = vec![1,2,3];
assert_eq!(shared_prefix_len(&a, &b), 3);
}
#[test]
fn test_shared_prefix3() {
let a = vec![1,2,3,4,5,6];
let b = vec![1,2,3,4,5,6];
assert_eq!(shared_prefix_len(&a, &b), 6);
}
2015-11-29 19:42:03 +01:00
}