A stream that generates a merkle tree based on the incoming data
065eb1fdac
Too much naming copy/pasta will probably confuse Python programmers when we have generator/iterators and I suppose we have streams but that is just so generic that it won't help. So, better make it explicit that this is an iterator. It also seems to the fit the usage of the other implementors. |
||
|---|---|---|
| changelog | ||
| documentation | ||
| merkle_tree_stream | ||
| test | ||
| .gitignore | ||
| .readthedocs.yml | ||
| CHANGELOG.rst | ||
| CODE_OF_CONDUCT.rst | ||
| CONTRIBUTING.rst | ||
| FUNDING.yml | ||
| LICENSE | ||
| MANIFEST.in | ||
| mypy.ini | ||
| pyproject.toml | ||
| README.rst | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
.. _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://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 merkle tree is 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
.. _documentation:
Documentation
*************
* https://merkle-tree-stream.readthedocs.io/
Code of Conduct
***************
By participating in the merkle-tree-stream community, you agree on the
following code of conduct. Please see `CODE_OF_CONDUCT`_ for the full text.
.. _CODE_OF_CONDUCT: ./CODE_OF_CONDUCT