Popularity
6.5
Stable
Activity
3.1
-
78
2
16

Monthly Downloads: 2,588
Programming language: Elixir
License: MIT License
Latest version: v2.0.0

merkle_tree alternatives and similar packages

Based on the "Algorithms and Data structures" category

Do you think we are missing an alternative of merkle_tree or a related project?

Add another 'Algorithms and Data structures' Package

README

MerkleTree

Merkle Tree implementation in pure Elixir.

Travis Coveralls Hex.pm

Hex (Package Manager)

API Documentation

Installation

  • Install the Elixir functional language.

  • Create New Project with Mix

    mix new my_app; cd my_app
    
  • Add merkle_tree to your list of dependencies in mix.exs.

    def deps do
    [{:merkle_tree, "~> 1.6.0"}]
    end
    
  • Install Mix Dependencies

    mix deps.get
    

Usage

  • Run Interactive Elixir (IEx) within context of Elixir app and dependencies injected into IEx runtime

    iex -S mix
    
  • Try the MerkleTree Module

    iex> MerkleTree.__info__(:functions)
    [__struct__: 0, __struct__: 1, build: 2, new: 1, new: 2]
    iex> mt = MerkleTree.new ['a', 'b', 'c', 'd']
    %MerkleTree{blocks: ['a', 'b', 'c', 'd'], hash_function: &MerkleTree.Crypto.sha256/1,
        root: %MerkleTree.Node{children: [%MerkleTree.Node{children: [%MerkleTree.Node{children: [],
            value: "ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb"},
            %MerkleTree.Node{children: [], value: "3e23e8160039594a33894f6564e1b1348bbd7a0088d42c4acb73eeaed59c009d"}],
          value: "62af5c3cb8da3e4f25061e829ebeea5c7513c54949115b1acc225930a90154da"},
          %MerkleTree.Node{children: [%MerkleTree.Node{children: [], value: "2e7d2c03a9507ae265ecf5b5356885a53393a2029d241394997265a1a25aefc6"},
            %MerkleTree.Node{children: [], value: "18ac3e7343f016890c510e93f935261169d9e3f565436429830faf0934f4f8e4"}],
          value: "d3a0f1c792ccf7f1708d5422696263e35755a86917ea76ef9242bd4a8cf4891a"}],
        value: "58c89d709329eb37285837b042ab6ff72c7c8f74de0446b091b6a0131c102cfd"}}
    $ mt.blocks()
    ['a', 'b', 'c', 'd']
    $ mt.hash_function()
    &MerkleTree.Crypto.sha256/1
    $ mt.root()
    ...
    
  • Try the MerkleTree.Proof Module (requires merkle_tree >1.2.0)

    iex> MerkleTree.Proof.__info__(:functions)           
    [__struct__: 0, __struct__: 1, prove: 2, proven?: 3]
    iex> proof1 = MerkleTree.Proof.prove(mt, 1)
    iex> proven1 = MerkleTree.Proof.proven?({"b", 1}, "58c89d709329eb37285837b042ab6ff72c7c8f74de0446b091b6a0131c102cfd", proof1)
    true
    

iex> proof3 = MerkleTree.Proof.prove(mt, 3) %MerkleTree.Proof{
hash_function: &MerkleTree.Crypto.sha256/1, hashes: ["62af5c3cb8da3e4f25061e829ebeea5c7513c54949115b1acc225930a90154da", "2e7d2c03a9507ae265ecf5b5356885a53393a2029d241394997265a1a25aefc6"] } iex> proven3 = MerkleTree.Proof.proven?({"d", 3}, "58c89d709329eb37285837b042ab6ff72c7c8f74de0446b091b6a0131c102cfd", proof3) true


* Try the [MerkleTree.Crypto Module](https://hexdocs.pm/merkle_tree/MerkleTree.Crypto.html)
  ```elixir
  iex> MerkleTree.Crypto.__info__(:functions)
  [hash: 2, sha256: 1]
  iex> MerkleTree.Crypto.hash("tendermint", :sha256)
  "f6c3848fc2ab9188dd2c563828019be7cee4e269f5438c19f5173f79898e9ee6"
  iex> MerkleTree.Crypto.hash("tendermint", :md5)   
  "bc93700bdf1d47ad28654ad93611941f"
  iex> MerkleTree.Crypto.sha256("tendermint")    
  "f6c3848fc2ab9188dd2c563828019be7cee4e269f5438c19f5173f79898e9ee6"

Background

A hash tree or Merkle tree is a tree in which every non-leaf node is labelled with the hash of the labels or values (in case of leaves) of its child nodes. Hash trees are useful because they allow efficient and secure verification of the contents of large data structures. Hash trees are a generalization of hash lists and hash chains.

Hash trees can be used to verify any kind of data stored, handled and transferred in and between computers. Currently the main use of hash trees is to make sure that data blocks received from other peers in a peer-to-peer network are received undamaged and unaltered, and even to check that the other peers do not lie and send fake blocks. Suggestions have been made to use hash trees in trusted computing systems. Hash trees are used in the IPFS and ZFS file systems, BitTorrent protocol, Apache Wave protocol, Git distributed revision control system, the Bitcoin peer-to-peer network, the Ethereum peer-to-peer network, and a number of NoSQL systems like Apache Cassandra and Riak.

Running Type Checker

mix dialyzer

Contributing

  1. Fork it ( http://github.com/Leventhan/merkle_tree/fork )
  2. Create your feature branch (git checkout -b feature/my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin feature/my-new-feature)
  5. Create a new Pull Request (Remember to squash your commits!)

Kindly report any found bugs or errors using the issue tracker.

Thanks

merkle_tree © 2016+, Yos Riady. Released under the MIT License. Authored and maintained by Yos Riady with help from contributors (list).

yos.io  ·  GitHub @yosriady


*Note that all licence references and agreements mentioned in the merkle_tree README section above are relevant to that project's source code only.