Skip to content

Commit 2b69da8

Browse files
committed
docs(readme): add an introductory description
1 parent dcefd4d commit 2b69da8

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<p align="center">
22
<h1 align="center">
33
Sparse Merkle tree
4-
<sub>In progress</sub>
54
</h1>
65
<p align="center">Sparse Merkle tree implementation in TypeScript.</p>
76
</p>
@@ -26,6 +25,11 @@
2625
<img alt="NPM bundle size" src="https://img.shields.io/bundlephobia/min/@cedoor/smt?style=flat-square">
2726
</p>
2827

28+
29+
A sparse Merkle tree (SMT) is a data structure useful for storing a key/value map where every leaf node of the tree contains the cryptographic hash of a key/value pair and every non leaf node contains the concatenated hashes of its child nodes. SMTs provides a secure and efficient verification of large data sets and they are often used in peer-to-peer technologies. This implementation is an optimized version of the traditional sparse Merkle tree and it is based on the concepts expressed in the papers and resources below.
30+
31+
**Notice**: this library is still not stable and therefore it must be used with care.
32+
2933
## References
3034

3135
1. Rasmus Dahlberg, Tobias Pulls and Roel Peeters. *Efficient Sparse Merkle Trees: Caching Strategies and Secure (Non-)Membership Proofs*. Cryptology ePrint Archive: Report 2016/683, 2016. https://eprint.iacr.org/2016/683.

0 commit comments

Comments
 (0)