merkle-tree-rs

KO | EN

gitlite — search

#php #ios #android #java #docker #javascript #nodejs #arduino #python #oauth #ember-addon #geo

★ 30 Open GitHub ↗

Merkle Tree implemented in Rust programming language

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Merkle Tree implemented in Rust programming language

*Spoiler: this is one of the variations of Merkle tree. Concrete
implementations serve different objectives and therefore can greatly differ in
detail.*

Merkle Tree is a binary tree, which nodes values are the hash of the
concatenated values of their descendants hashes.

Main article: https://en.wikipedia.org/wiki/Merkle_tree

### Storage format

A binary tree is stored in a vector in breadth-first order. That is, starting
with the root we go from left to right at every level.

```
    1
  2   3
 4 5 6 7
```

Vector:

```
[1 2 3 4 5 6 7]
```

While building a tree, if there is an odd number of nodes at the given level,
the last node will be duplicated. Otherwise, the tree won't be complete. And we
need it to be complete in order to "2i 2i+1" schema to work.

### Defence against potential attacks

To defend against the second-preimage attack, when we calculate the hash we
prepend data with 0x00 - for leaves, 0x01 - for internal nodes.

By default, we use SHA256. But you can pass your hash function (for example,
double SHA256).

## Usage

Let's say you have a file. You split it into 100 blocks and build a tree.

```rust
use merkle_tree::MerkleTree;

let t: MerkleTree = MerkleTree::build(&blocks);
```

block could be anything, as long as it implements [`AsBytes`] trait. In order
to encode the numbers, you can use [byteorder
library](https://github.com/BurntSushi/byteorder). If the block is an array of
bytes, you don't have to do anything.

As we mentioned earlier, you can pass your hash function:

```
use merkle_tree::MerkleTree;

let t: MerkleTree = MerkleTree::build_with_hasher(&blocks, MyAwesomeHasher::new());
```

Then you somehow make a secure copy of the root hash.

```
t.root_hash();
```

You can now copy leaves from any source.

```
t.leaves();
```

If we verify that those leaves sum up to the `root_hash`, we can use them to
verify the blocks. Blocks could be received and checked one by one.

```
let t: MerkleTree = MerkleTree::build_from_leaves(&leaves);
assert_eq!(secure_copy_of_root_hash, t.root_hash());

assert!(t.verify(block_index, &block));
```

where `block_index` - index of a block (starts at 0).

## Decision log

### Why binary tree?

None of the sources say anything about the number of children each node could
have. The usual choice is 2. So, we need to know only the hash of our neighbor
to check the subtree. We go all the way up to the root node. At each level, we
only need to know the hash of our neighbor to the right (or left). This is of
course if you want to check log(N) hashes on a path to root.

```
    1
  2   3
```

### Why tree is stored in a vector?

I've tried different solutions. At the end of the first day I had a standard binary tree (tag: 0.1.0).

```
struct Node
{
    hash: Vec<u8>,
    left: Option<Box<Node>>,
    right: Option<Box<Node>>,
}
```

Then I added an array of references to the lower elements to it (using Rc).

```
struct Node
{
    hash: Vec<u8>,
    left: Option<Rc<Node>>,
    right: Option<Rc<Node>>,
}

struct MerkleTree {
    root: Node,
    leaves: Vec<Rc<Node>>,
}
```

The main advantage of such tree is the ability to get the branches and check
them in the absence of a full tree. BUT then I was faced with a contradiction
in the article on Wikipedia: we can get the branches, but we don't trust the
tree until it converges to the root hash. So what we should do? Get the
branches and hope for the best?

Don't know what to say. I didn't like it. It was unnecessarily complicated. Of
course, I looked at other implementations, but they were all either too
abstract (was not solving any problem, had no clear API), or was written
poorly.

The only suitable version was in C++
(https://codetrips.com/2016/06/19/implementing-a-merkle-tree-in-c/). I found at
the end of the second day. But it was not without flaws. I'm not talking about
a shared_ptr to the data (a pointer to the data in the tree; in Rust this could
be done only using raw_pointers). It is unclear how to verify the tree on the
other side (when we have it copied for data validation). After all, there will
be no pointers! And we do not receive all the blocks at once.

I did not immediately come to the latest version. Pretty much had to think, and
experiment. Maybe I should consider all aspects before implementing. But then I
wouldn't have learned so much about Rust.

**Advantages of the final implementation**

1. The ease of tree traversal
2. The absence of pointers in both directions (parent <-> child)
3. Ease of serialization - it's just an array

(1) to get the parent element, you need to divide the index of the current node
in half: `5 / 2 = 2`. That's it! The index of the left child - `2i`, right
child - `2i+1`. This way we get the ease of traversing the tree from root to
children and vice-versa (from children to root).

(3) to get all the leaves, we just need to get `count_leaves` last elements of
the array.

**Cons of the final implementation**

1. Mathematics (2i, 2i+1) is still more complicated comparing to following the
   pointers: `e.left.right`.
2. The tree should be complete (except for the last level) for math to work.
   Sometimes we have to add duplicates.

**Possible improvements**

1. Provide implementations for `AsBytes` for a greater number of types.
2. In `build_upper_level` put nodes into the `nodes` (in-place) without
   creating intermediate arrays.
3. Deal with "rust cannot infer type for _" (`let _t: MerkleTree`).
4. Serialization/deserialization in a separate module.
5. User-friendly interface for traversing a tree (`root().left().right()`) -
   Builder pattern.

## Development

### Step 1. Create development environment

You will need [docker engine](https://docs.docker.com/engine/installation/) if
you want to develop this library inside a container. If you already have rust
on your computer and fine with downloading some dependencies, feel free to skip
this step.

```
$ make create_dev_env
$ make run_shell
```

### Step 2. Build & test

```
$ cargo build --features "dev"
$ cargo test
```

### Step 3. Benchmark

```
$ cargo bench --features "dev"
```

merkle-tree-rs

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README