A stream that generates a merkle tree based on the incoming data
Go to file
decentral1se 15cac7d390
Merge pull request #5 from datpy/move-to-generators
Move naming to generator
2019-10-08 22:45:45 +02:00
changelog Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
documentation Fix link to module 2019-08-07 08:36:21 +02:00
merkle_tree_stream Move naming to Generator (reflect reality) 2019-10-08 22:36:03 +02:00
test Move naming to Generator (reflect reality) 2019-10-08 22:36:03 +02:00
.gitignore Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
.readthedocs.yml Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
.travis.yml Mark envs with version only 2019-10-06 16:11:27 +02:00
CHANGELOG.rst Move naming to Generator (reflect reality) 2019-10-08 22:36:03 +02:00
CODE_OF_CONDUCT.rst Clean up formatting on CoC 2019-10-08 22:36:03 +02:00
CONTRIBUTING.rst Simplify contrib docs 2019-10-06 16:12:11 +02:00
FUNDING.yml Add a Github funding file 2019-07-08 12:00:45 +02:00
LICENSE Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
MANIFEST.in Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
README.rst Move naming to Generator (reflect reality) 2019-10-08 22:36:03 +02:00
mypy.ini Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
pyproject.toml Make towncrier work 2019-10-06 16:12:27 +02:00
setup.cfg Handle versions better 2019-10-06 16:12:37 +02:00
setup.py Initialise the new module boilerplate 2019-07-08 11:40:40 +02:00
tox.ini Remove base python restrictions 2019-10-08 22:36:03 +02:00

README.rst

.. _header:

******************
merkle-tree-stream
******************

.. image:: https://img.shields.io/badge/license-MIT-brightgreen.svg
   :target: LICENSE
   :alt: Repository license

.. image:: https://badge.fury.io/py/merkle-tree-stream.svg
   :target: https://badge.fury.io/py/merkle-tree-stream
   :alt: PyPI package

.. image:: https://travis-ci.com/datpy/merkle-tree-stream.svg?branch=master
   :target: https://travis-ci.com/datpy/merkle-tree-stream
   :alt: Travis CI result

.. image:: https://readthedocs.org/projects/merkle-tree-stream/badge/?version=latest
   :target: https://merkle-tree-stream.readthedocs.io/en/latest/
   :alt: Documentation status

.. image:: https://img.shields.io/badge/support-maintainers-brightgreen.svg
   :target: https://decentral1.se
   :alt: Support badge

.. _introduction:

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

From `The Dat Protocol`_: 

.. _The Dat Protocol: https://datprotocol.github.io/book/ch01-01-flat-tree.html

    A hash tree or merkle tree is a tree in which every leaf node is labelled
    with the hash of a data block and every non-leaf node is labelled with the
    cryptographic hash of the labels of its child nodes. Merkle trees in Dat
    are specialized `flat trees`_ that contain the content of the archives.

    .. _Flat Trees: https://flat-tree.readthedocs.io/en/latest/

See the following for more:

  * The Dat Protocol: `Merkle Tree`_
  * The Dat Protocol: `Merkle Tree Stream`_

.. _Merkle Tree: https://datprotocol.github.io/book/ch01-02-merkle-tree.html
.. _Merkle Tree Stream: https://datprotocol.github.io/book/ch02-02-merkle-tree-stream.html

A note on naming
================

For the purposes of uniformity and easy of discovery alongside the reference
implementation, we use the same module name as `merkle-tree-stream`_. However,
there is currently no stream implemented, only a generator is available. This
is because the reference implementation of Hypercore 7 makes use of the
generator only. A `stream`_ implementation may follow.

.. _merkle-tree-stream: https://github.com/mafintosh/merkle-tree-stream
.. _stream: https://docs.python.org/3/library/asyncio-stream.html

.. _example:

.. code-block:: python

    from hashlib import sha256
    from merkle_tree_stream import MerkleTreeGenerator

    def leaf(node, roots=None):
        return sha256(node.data).digest()

    def parent(first, second):
        sha256 = hashlib.sha256()
        sha256.update(first.data)
        sha256.update(second.data)
        return sha256.digest()

    merkle = MerkleTreeGenerator(leaf=leaf, parent=parent)
    merkle.write('hello')
    merkle.write('hashed')
    merkle.write('world')

.. _documentation:

Documentation
*************

* `merkle-tree-stream.readthedocs.io`_

.. _merkle-tree-stream.readthedocs.io: https://merkle-tree-stream.readthedocs.io/

Mirroring
*********

* `hack.decentral1.se/datpy/merkle-tree-stream`_
* `github.com/datpy/merkle-tree-stream`_

.. _hack.decentral1.se/datpy/merkle-tree-stream: https://hack.decentral1.se/datpy/merkle-tree-stream
.. _github.com/datpy/merkle-tree-stream: https://github.com/datpy/merkle-tree-stream