README.MD

Merkle Tree

This Merkle Tree implementation aims to be an easy to use out-of-the-box tool for generating merkletrees and proofs for smart contracts. A common usecase is NFT airdrop whitelists.

use merkletree::MerkleTree;

// instantiate an empty tree
let empty_tree = MerkleTree::new();

// instantiate a tree from a sequence of elements
let elements = vec!["foo", "bar"];
let mut tree = MerkleTree::from_array(&elements);

// insert new elements into the tree
tree.insert(&"baz");

// generate proofs
let proof = tree.gen_proof(&"baz").expect("data not in tree");

// verify proofs
let root = tree.root().expect("tree is empty");
assert!(tree.verify(&proof, &"baz", root,));

// use a custom hasher
let tree = MerkleTree::<MyHasher>::with_hasher();

Data model

Merkletree is a complete binary tree, stored as a 1-dimensional array in breadth order.

             R
           /   \
         /       \
       i1         i2
     /    \      /   \
    i3     1    2     3
   / \
  4   5

tree = [R, i1, i2, i3, 1, 2, 3, 4, 5]
leaves = [1, 2, 3, 4, 5]

tree.insert(6)

             R
           /   \
         /       \
       i1         i2
     /    \      /   \
    i3    i4    2     3
   / \    / \
  4   5  1   6

tree = [R, i1, i2, i3, i4, 2, 3, 4, 5, 1, 6]
leaves = [2, 3, 4, 5, 1, 6]

TODO:

1. Out-of-the-box proofs should be verifiable with openzeppelin/MerkleProof.sol
2. Stabilize API.