#merkle #tree #stream #merkle-tree

merkle-tree-stream

A stream that generates a merkle tree based on the incoming data

18 releases (11 breaking)

0.12.1 Jul 9, 2020
0.12.0 Mar 3, 2020
0.11.0 Feb 18, 2020
0.10.0 Jul 18, 2019
0.1.1 Mar 16, 2018

#331 in Cryptography

Download history 14/week @ 2022-08-01 25/week @ 2022-08-08 15/week @ 2022-08-15 28/week @ 2022-08-22 7/week @ 2022-08-29 14/week @ 2022-09-05 32/week @ 2022-09-12 9/week @ 2022-09-19 14/week @ 2022-09-26 25/week @ 2022-10-03 11/week @ 2022-10-10 6/week @ 2022-10-17 14/week @ 2022-10-24 26/week @ 2022-10-31 19/week @ 2022-11-07 27/week @ 2022-11-14

86 downloads per month
Used in hypercore

MIT/Apache

24KB
204 lines

merkle-tree-stream

crates.io version build status downloads docs.rs docs

A stream that generates a merkle tree based on the incoming data. Adapted from mafintosh/merkle-tree-stream.

Why?

Signatures & integrity checks are part of what makes Dat a great protocol. Each chunk that passes through the system is hashed and made part of a tree of hashes. We end up creating hashes of hashes thanks to flat-tree, which in the end allows us to validate our complete data set.

This module is only needed to create new Dat archives, but not to read them.

Usage

extern crate merkle_tree_stream;
extern crate rust_sodium;

use merkle_tree_stream::{HashMethods, DefaultNode, MerkleTreeStream, Node,
                        PartialNode};
use rust_sodium::crypto::hash::sha256;
use std::sync::Arc;

struct H;
impl HashMethods for H {
  type Node = DefaultNode;
  type Hash = Vec<u8>;

  fn leaf(&self, leaf: &PartialNode, _roots: &[Arc<Self::Node>]) -> Self::Hash {
    let data = leaf.as_ref().unwrap();
    sha256::hash(&data).0.to_vec()
  }

  fn parent(&self, a: &Self::Node, b: &Self::Node) -> Self::Hash {
    let mut buf = Vec::with_capacity(a.hash().len() + b.hash().len());
    buf.extend_from_slice(a.hash());
    buf.extend_from_slice(b.hash());
    sha256::hash(&buf).0.to_vec()
  }
}

fn main() {
  let roots = Vec::new();
  let mut mts = MerkleTreeStream::new(H, roots);
  let mut nodes = vec![];
  mts.next(b"hello", &mut nodes);
  mts.next(b"hashed", &mut nodes);
  mts.next(b"world", &mut nodes);
  println!("nodes {:?}", nodes);
}

Custom Node or Hash types

If you have a specific need for a Node type that is not covered by the DefaultNode type, you can define your own by implementing the Node trait and the appropriate From<NodeParts<Self::Hash>> trait for your new type. You can use the DefaultNode implementation as a guide.

Installation

$ cargo add merkle-tree-stream

License

MIT OR Apache-2.0

Dependencies