Compare commits
4 Commits
| Author | SHA1 | Date |
|---|---|---|
Miguel Mota
|
cc217dcf45 | |
|
Miguel Mota
|
e63975a7ff | |
|
Miguel Mota
|
8d9ec3b4d0 | |
|
Miguel Mota
|
49d17bd5e4 |
21
LICENSE.md
21
LICENSE.md
|
|
@ -1,21 +0,0 @@
|
|||
MIT license
|
||||
|
||||
Copyright (C) 2015 Miguel Mota
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||
of the Software, and to permit persons to whom the Software is furnished to do
|
||||
so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
345
README.md
345
README.md
|
|
@ -1,356 +1,13 @@
|
|||
<h1 align="center">
|
||||
<br />
|
||||
<img src="https://user-images.githubusercontent.com/168240/39508295-ceeb1576-4d96-11e8-90aa-b2a56825567d.png" alt="Merkle Tree" width="600" />
|
||||
<br />
|
||||
<br />
|
||||
<br />
|
||||
</h1>
|
||||
|
||||
|
||||
> Construct [Merkle Trees](https://en.wikipedia.org/wiki/Merkle_tree) and verify proofs in JavaScript.
|
||||
|
||||
Diagram of Merkle Tree
|
||||
|
||||
<img src="https://github.com/miguelmota/merkle-tree/blob/master/diagrams/merkle-tree.png?raw=true" alt="Merkle Tree" width="500">
|
||||
|
||||
Diagram of Merkle Tree Proof
|
||||
|
||||
<img src="https://github.com/miguelmota/merkle-tree/blob/master/diagrams/merkle-tree-proof.png?raw=true" alt="Merkle Tree Proof" width="420">
|
||||
|
||||
Diagram of Invalid Merkle Tree Proofs
|
||||
|
||||
<img src="https://github.com/miguelmota/merkle-tree/blob/master/diagrams/merkle-tree-proof-fail.png?raw=true" alt="Merkle Tree Proof" width="420">
|
||||
|
||||
Diagram of Bitcoin Merkle Tree
|
||||
|
||||
<img src="https://github.com/miguelmota/merkle-tree/blob/master/diagrams/merkle-tree-bitcoin.png?raw=true" alt="Merkle Tree Proof" width="420">
|
||||
|
||||
# Install
|
||||
|
||||
```bash
|
||||
npm install merkletreejs
|
||||
```
|
||||
|
||||
## Classes
|
||||
|
||||
<dl>
|
||||
<dt><a href="#MerkleTree">MerkleTree</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
## Objects
|
||||
|
||||
<dl>
|
||||
<dt><a href="#MerkleTree">MerkleTree</a> : <code>object</code></dt>
|
||||
<dd><p>Class reprensenting a Merkle Tree</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<a name="MerkleTree"></a>
|
||||
|
||||
## MerkleTree
|
||||
**Kind**: global class
|
||||
|
||||
* [MerkleTree](#MerkleTree)
|
||||
* [new MerkleTree(leaves, hashAlgorithm, options)](#new_MerkleTree_new)
|
||||
* [.getLeaves()](#MerkleTree+getLeaves) ⇒ <code>Array.<Buffer></code>
|
||||
* [.getLayers()](#MerkleTree+getLayers) ⇒ <code>Array.<Buffer></code>
|
||||
* [.getRoot()](#MerkleTree+getRoot) ⇒ <code>Buffer</code>
|
||||
* [.getProof(leaf, [index])](#MerkleTree+getProof) ⇒ <code>Array.<Buffer></code>
|
||||
* [.verify(proof, targetNode, root)](#MerkleTree+verify) ⇒ <code>Boolean</code>
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="new_MerkleTree_new"></a>
|
||||
|
||||
### new MerkleTree(leaves, hashAlgorithm, options)
|
||||
Constructs a Merkle Tree.
|
||||
All nodes and leaves are stored as Buffers.
|
||||
Lonely leaf nodes are promoted to the next level up without being hashed again.
|
||||
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| leaves | <code>Array.<Buffer></code> | Array of hashed leaves. Each leaf must be a Buffer. |
|
||||
| hashAlgorithm | <code>function</code> | Algorithm used for hashing leaves and nodes |
|
||||
| options | <code>Object</code> | Additional options |
|
||||
| options.isBitcoinTree | <code>Boolean</code> | If set to `true`, constructs the Merkle Tree using the [Bitcoin Merkle Tree implementation](http://www.righto.com/2014/02/bitcoin-mining-hard-way-algorithms.html). Enable it when you need to replicate Bitcoin constructed Merkle Trees. In Bitcoin Merkle Trees, single nodes are combined with themselves, and each output hash is hashed again. |
|
||||
|
||||
**Example**
|
||||
```js
|
||||
const MerkleTree = require('merkletreejs')
|
||||
const crypto = require('crypto')
|
||||
|
||||
function sha256(data) {
|
||||
// returns Buffer
|
||||
return crypto.createHash('sha256').update(data).digest()
|
||||
}
|
||||
|
||||
const leaves = ['a', 'b', 'c'].map(x => sha256(x))
|
||||
|
||||
const tree = new MerkleTree(leaves, sha256)
|
||||
```
|
||||
|
||||
* * *
|
||||
|
||||
<a name="MerkleTree+getLeaves"></a>
|
||||
|
||||
### merkleTree.getLeaves() ⇒ <code>Array.<Buffer></code>
|
||||
Returns array of leaves of Merkle Tree.
|
||||
|
||||
**Kind**: instance method of [<code>MerkleTree</code>](#MerkleTree)
|
||||
**Example**
|
||||
```js
|
||||
const leaves = tree.getLeaves()
|
||||
```
|
||||
|
||||
* * *
|
||||
|
||||
<a name="MerkleTree+getLayers"></a>
|
||||
|
||||
### merkleTree.getLayers() ⇒ <code>Array.<Buffer></code>
|
||||
Returns array of all layers of Merkle Tree, including leaves and root.
|
||||
|
||||
**Kind**: instance method of [<code>MerkleTree</code>](#MerkleTree)
|
||||
**Example**
|
||||
```js
|
||||
const layers = tree.getLayers()
|
||||
```
|
||||
|
||||
* * *
|
||||
|
||||
<a name="MerkleTree+getRoot"></a>
|
||||
|
||||
### merkleTree.getRoot() ⇒ <code>Buffer</code>
|
||||
Returns the Merkle root hash as a Buffer.
|
||||
|
||||
**Kind**: instance method of [<code>MerkleTree</code>](#MerkleTree)
|
||||
**Example**
|
||||
```js
|
||||
const root = tree.getRoot()
|
||||
```
|
||||
|
||||
* * *
|
||||
|
||||
<a name="MerkleTree+getProof"></a>
|
||||
|
||||
### merkleTree.getProof(leaf, [index]) ⇒ <code>Array.<Buffer></code>
|
||||
Returns the proof for a target leaf.
|
||||
|
||||
**Kind**: instance method of [<code>MerkleTree</code>](#MerkleTree)
|
||||
**Returns**: <code>Array.<Buffer></code> - - Array of Buffer hashes.
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| leaf | <code>Buffer</code> | Target leaf |
|
||||
| [index] | <code>Number</code> | Target leaf index in leaves array. Use if there are leaves containing duplicate data in order to distinguish it. |
|
||||
|
||||
**Example**
|
||||
```js
|
||||
const proof = tree.getProof(leaves[2])
|
||||
```
|
||||
**Example**
|
||||
```js
|
||||
const leaves = ['a', 'b', 'a'].map(x => sha256(x))
|
||||
const tree = new MerkleTree(leaves, sha256)
|
||||
const proof = tree.getProof(leaves[2], 2)
|
||||
```
|
||||
|
||||
* * *
|
||||
|
||||
<a name="MerkleTree+verify"></a>
|
||||
|
||||
### merkleTree.verify(proof, targetNode, root) ⇒ <code>Boolean</code>
|
||||
Returns true if the proof path (array of hashes) can connect the target node
|
||||
to the Merkle root.
|
||||
|
||||
**Kind**: instance method of [<code>MerkleTree</code>](#MerkleTree)
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| proof | <code>Array.<Buffer></code> | Array of proof Buffer hashes that should connect target node to Merkle root. |
|
||||
| targetNode | <code>Buffer</code> | Target node Buffer |
|
||||
| root | <code>Buffer</code> | Merkle root Buffer |
|
||||
|
||||
**Example**
|
||||
```js
|
||||
const root = tree.getRoot()
|
||||
const proof = tree.getProof(leaves[2])
|
||||
const verified = tree.verify(proof, leaves[2], root)
|
||||
```
|
||||
|
||||
* * *
|
||||
|
||||
<a name="MerkleTree"></a>
|
||||
|
||||
## MerkleTree : <code>object</code>
|
||||
Class reprensenting a Merkle Tree
|
||||
|
||||
**Kind**: global namespace
|
||||
|
||||
* [MerkleTree](#MerkleTree) : <code>object</code>
|
||||
* [new MerkleTree(leaves, hashAlgorithm, options)](#new_MerkleTree_new)
|
||||
* [.getLeaves()](#MerkleTree+getLeaves) ⇒ <code>Array.<Buffer></code>
|
||||
* [.getLayers()](#MerkleTree+getLayers) ⇒ <code>Array.<Buffer></code>
|
||||
* [.getRoot()](#MerkleTree+getRoot) ⇒ <code>Buffer</code>
|
||||
* [.getProof(leaf, [index])](#MerkleTree+getProof) ⇒ <code>Array.<Buffer></code>
|
||||
* [.verify(proof, targetNode, root)](#MerkleTree+verify) ⇒ <code>Boolean</code>
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
<a name="new_MerkleTree_new"></a>
|
||||
|
||||
### new MerkleTree(leaves, hashAlgorithm, options)
|
||||
Constructs a Merkle Tree.
|
||||
All nodes and leaves are stored as Buffers.
|
||||
Lonely leaf nodes are promoted to the next level up without being hashed again.
|
||||
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| leaves | <code>Array.<Buffer></code> | Array of hashed leaves. Each leaf must be a Buffer. |
|
||||
| hashAlgorithm | <code>function</code> | Algorithm used for hashing leaves and nodes |
|
||||
| options | <code>Object</code> | Additional options |
|
||||
| options.isBitcoinTree | <code>Boolean</code> | If set to `true`, constructs the Merkle Tree using the [Bitcoin Merkle Tree implementation](http://www.righto.com/2014/02/bitcoin-mining-hard-way-algorithms.html). Enable it when you need to replicate Bitcoin constructed Merkle Trees. In Bitcoin Merkle Trees, single nodes are combined with themselves, and each output hash is hashed again. |
|
||||
|
||||
**Example**
|
||||
```js
|
||||
const MerkleTree = require('merkletreejs')
|
||||
const crypto = require('crypto')
|
||||
|
||||
function sha256(data) {
|
||||
// returns Buffer
|
||||
return crypto.createHash('sha256').update(data).digest()
|
||||
}
|
||||
|
||||
const leaves = ['a', 'b', 'c'].map(x => sha256(x))
|
||||
|
||||
const tree = new MerkleTree(leaves, sha256)
|
||||
```
|
||||
|
||||
* * *
|
||||
|
||||
<a name="MerkleTree+getLeaves"></a>
|
||||
|
||||
### merkleTree.getLeaves() ⇒ <code>Array.<Buffer></code>
|
||||
Returns array of leaves of Merkle Tree.
|
||||
|
||||
**Kind**: instance method of [<code>MerkleTree</code>](#MerkleTree)
|
||||
**Example**
|
||||
```js
|
||||
const leaves = tree.getLeaves()
|
||||
```
|
||||
|
||||
* * *
|
||||
|
||||
<a name="MerkleTree+getLayers"></a>
|
||||
|
||||
### merkleTree.getLayers() ⇒ <code>Array.<Buffer></code>
|
||||
Returns array of all layers of Merkle Tree, including leaves and root.
|
||||
|
||||
**Kind**: instance method of [<code>MerkleTree</code>](#MerkleTree)
|
||||
**Example**
|
||||
```js
|
||||
const layers = tree.getLayers()
|
||||
```
|
||||
|
||||
* * *
|
||||
|
||||
<a name="MerkleTree+getRoot"></a>
|
||||
|
||||
### merkleTree.getRoot() ⇒ <code>Buffer</code>
|
||||
Returns the Merkle root hash as a Buffer.
|
||||
|
||||
**Kind**: instance method of [<code>MerkleTree</code>](#MerkleTree)
|
||||
**Example**
|
||||
```js
|
||||
const root = tree.getRoot()
|
||||
```
|
||||
|
||||
* * *
|
||||
|
||||
<a name="MerkleTree+getProof"></a>
|
||||
|
||||
### merkleTree.getProof(leaf, [index]) ⇒ <code>Array.<Buffer></code>
|
||||
Returns the proof for a target leaf.
|
||||
|
||||
**Kind**: instance method of [<code>MerkleTree</code>](#MerkleTree)
|
||||
**Returns**: <code>Array.<Buffer></code> - - Array of Buffer hashes.
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| leaf | <code>Buffer</code> | Target leaf |
|
||||
| [index] | <code>Number</code> | Target leaf index in leaves array. Use if there are leaves containing duplicate data in order to distinguish it. |
|
||||
|
||||
**Example**
|
||||
```js
|
||||
const proof = tree.getProof(leaves[2])
|
||||
```
|
||||
**Example**
|
||||
```js
|
||||
const leaves = ['a', 'b', 'a'].map(x => sha256(x))
|
||||
const tree = new MerkleTree(leaves, sha256)
|
||||
const proof = tree.getProof(leaves[2], 2)
|
||||
```
|
||||
|
||||
* * *
|
||||
|
||||
<a name="MerkleTree+verify"></a>
|
||||
|
||||
### merkleTree.verify(proof, targetNode, root) ⇒ <code>Boolean</code>
|
||||
Returns true if the proof path (array of hashes) can connect the target node
|
||||
to the Merkle root.
|
||||
|
||||
**Kind**: instance method of [<code>MerkleTree</code>](#MerkleTree)
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| proof | <code>Array.<Buffer></code> | Array of proof Buffer hashes that should connect target node to Merkle root. |
|
||||
| targetNode | <code>Buffer</code> | Target node Buffer |
|
||||
| root | <code>Buffer</code> | Merkle root Buffer |
|
||||
|
||||
**Example**
|
||||
```js
|
||||
const root = tree.getRoot()
|
||||
const proof = tree.getProof(leaves[2])
|
||||
const verified = tree.verify(proof, leaves[2], root)
|
||||
```
|
||||
|
||||
* * *
|
||||
|
||||
# Test
|
||||
|
||||
```bash
|
||||
npm test
|
||||
```
|
||||
|
||||
# Notes
|
||||
|
||||
As is, this implemenation is vulnerable to a [second pre-image attack](https://en.wikipedia.org/wiki/Merkle_tree#Second_preimage_attack). Use a difference hashing algorithm function for leaves and nodes, so that `H(x) != H'(x)`.
|
||||
|
||||
Also, as is, this implementation is vulnerable to a forgery attack for an unbalanced tree, where the last leaf node can be duplicated to create an artificial balanced tree, resulting in the same Merkle root hash. Do not accept unbalanced tree to prevent this.
|
||||
|
||||
More info [here](https://bitcointalk.org/?topic=102395).
|
||||
|
||||
# Resources
|
||||
|
||||
- [Bitcoin mining the hard way: the algorithms, protocols, and bytes](http://www.righto.com/2014/02/bitcoin-mining-hard-way-algorithms.html)
|
||||
|
||||
- [Bitcoin Talk - Merkle Trees](https://bitcointalk.org/index.php?topic=403231.msg9054025#msg9054025)
|
||||
|
||||
- [How Log Proofs Work](https://www.certificate-transparency.org/log-proofs-work)
|
||||
|
||||
- [Raiden Merkle Tree Implemenation](https://github.com/raiden-network/raiden/blob/f9cf12571891cdf54feb4667cd2fffcb3d5daa89/raiden/mtree.py)
|
||||
|
||||
- [Why aren't Solidity sha3 hashes not matching what other sha3 libraries produce?](https://ethereum.stackexchange.com/questions/559/why-arent-solidity-sha3-hashes-not-matching-what-other-sha3-libraries-produce)
|
||||
|
||||
- [What is the purpose of using different hash functions for the leaves and internals of a hash tree?](https://crypto.stackexchange.com/questions/2106/what-is-the-purpose-of-using-different-hash-functions-for-the-leaves-and-interna)
|
||||
|
||||
- [Why is the full Merkle path needed to verify a transaction?](https://bitcoin.stackexchange.com/questions/50674/why-is-the-full-merkle-path-needed-to-verify-a-transaction)
|
||||
|
||||
- [Where is Double hashing performed in Bitcoin?](https://bitcoin.stackexchange.com/questions/8443/where-is-double-hashing-performed-in-bitcoin)
|
||||
|
||||
# License
|
||||
|
||||
MIT
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
Diagrams created with [draw.io](https://www.draw.io/)
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 55 KiB |
|
|
@ -1 +0,0 @@
|
|||
<mxfile userAgent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.115 Safari/537.36" version="7.0.3" editor="www.draw.io" type="device"><diagram id="0ffe4643-5db2-c819-e50e-e9015c718b6a" name="Page-1">7Vxbc5s4FP41ntk+7A6SuD7GSVo/tDuZtjO7fZRBsdkQ8GDl1l+/EkgYJOxgjFJK3M609pEQ5tOnc9MRM3R5//wpx5v1lywiyQxa0fMMXc0gdJDN/uWCl1Jge1YpWOVxVIrATvAt/kmEUHZ7iCOybXSkWZbQeNMUhlmakpA2ZDjPs6dmt9ssad51g1dEE3wLcaJL/4kjui6lvmPt5AsSr9byzsASLUsc3q3y7CEV95tBdFv8KZvvsRxL9N+ucZQ91UToeoYu8yyj5af750uScGglbOV1H/e0Vr87JyntdAEsr3jEyYN49oXL/l/8wf6y0eYL+OGD+Kn0RcJDyTMbfb6m9wkTAPZxS/PsjlxmSZYXXZAb+mR5y1pu4ySpySNM/NuQyXESr1ImC9kvJaxx/khyGrMpuBAN93EU8RvOn9YxJd82OOR3f2J8YzL9OcWj81HIc00knvsTye4JzV9YF9HqiisERQESUDztJjwIStG6Ntdy5rCg2KoaeAcz+yCQbkfd1UC/6INx5C5dx9UxZnSD4SgwBnYDY9fSIPYtMxB7GsTziUIsVc9+jD1oBmNfw/hyohh77qsYG1IVgYbx1TQxVvXxG2IsvY4ayNfTBBnZzq9SyADpnoYnPQ3EPQ17qp4G8Jvqo83VAJZjCHdbx92XuDscd2equCNgdcDdEN8h0kAlEQsyxNcsp+tslaU4ud5J50XkQPgIVhN98hzTf7n4L0d8+yFbUvbDak38q2yrogs+WoS362JoIL7cYMrmJS0k0LKLOcY5veDxExOmWUqk7GPMn7MYhqSR0oNJau3/EUpfRESHH2jGRLtn/Zxlm318soo/VYuMu0CNSQm5pYeowQE+SIycJJjGj80or22WxaU3WcxuUVvIXoNQvsKTbfaQh0RcVI+6jhyHQb4iVBunoFz1NN1YqPsPC7YqxPL3+fL3p7r8oe83l7/rv53aRbq5m0E34ahuNzhln1f881c5FQGfCmDxuSh7sRvUO/aZIh8ukdvij0QO8SN7DFMEgqaGhhZomSLP0BQ52hRdYYo7IJ2TbfwTL4sOXGNt+EotfokznzlXHFmm+balEmxRYCrMlGtFzoswTlffCxX5p93qR/JM0iHd2UHJDzBttv1qzGkbMqtIz53odlYzUbW562IG62bzBDvVtObShEtz/qOy2XtnpLQnchmUstI2NBn8qt2rTYzTMjFSdqJ5tL1mCOf1NI82tA6OM5x5RHqa6O+MZ57POuBYHQAcXXW3cW0QJaBnnkarBGr+uQXrDnrNX78hecxA4Ca4uN3e6Wksfm9ci19ZtMBVhui6+h0LKAOZW/66dzx+HoEWEu01LU0T1MnQyJChzjWZRBgJ1xBSuOb35BoK1AyBMtAerjFG4JdaN6H8uy8Ozz/KAgLbOtxfzXTYQFka5S/uu1Ckrq8tlK98j/JsJo81k20Rjilf2QbarI1WvQ3qK8vgu67CJMgjUWGV+Za8UIfoq8K0gYYzl3ZLKpnNUJHAuOiXRYq8YFkQRFu/xB3JlkkT3sDWlq+MegZfvnp+YgEF3POpwl0l5A7gbUpd6qmFBRJ4X04Wbx+8hrdraNvV1oPvhS3wvpoq3tB5nd+2Ibz1qHnhCLyvp4o3kqWIB/B2zeAtPYXzDuB0dwCBjIxP3QLUBhrObXN+ozDgUJZj76TXXX9HPFvD9fc7kuONsheuEqxbPTmkZQnUgQbkENQ49Jngx3OmvEcKoMUEmUqUO3rEdtzSN5AF12xUu2WzVGsUJni7jUPFIIGuikEGr3XF4I5KL3hqLrJvdYmiFsxVlzh6hPpu6eXo9BrXBk2gbKv0tTrKOIExdrm6zXm37HJ1do3Lqam2f0+llzqQQX61lWi9U355Or+CUfGrqqc9lV/qQAb5dXa+Kn75Or/kluVYCBYo1aK9CaYMZJBgp5bBTIdgoG3Hb1zuvd/0yntXxwFlR0oLFAck2Kn1MRMn2Lgc/GqcUwNIqFSTIMsYw+QiODOsqrEac+ZSOWuM+jIMKVQ1mKPwzl6+ZJjXwjD5AoiRMAy4ylFJeXb91CRYVf9jgGFtfr5+1GcRzMRZH686djXYUZ/xn8YCUEkQtJ7G8nVmDfI2iHOi8qASQKNSAkpFW3WM92gdoNZemqsk9/RalvdKsN+hflwhBlKNQ+/iS3PBvn/2lA+V944sXakebEWqFesci6k6zNxhOFkJ2JFhu0k0QbKjq51EZdIQ5hCNyxyqCR8tHO/MJTXqMhfX+1Dj0jymIRuZCb+Q/I4RClrfc0I0iv26ApK9hDnmTVFKWb9QS3UnF7ZQZZC3yp1a5zUdCyGj2kYuZVyHpYGkhnJk6+hVrbybDEBjRWDu2QU5SLCRObmvKPuu/FL2LYAzlNFgX3cvOi27714mi67/Bw==</diagram></mxfile>
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 52 KiB |
|
|
@ -1 +0,0 @@
|
|||
<mxfile userAgent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36" version="8.9.3" editor="www.draw.io" type="device"><diagram id="3ca9cd9c-0c8a-eb2a-9f4f-0b165685525d" name="Page-1">7Vtdc5s4FP01zGwfdgdJfPmxTuN6Z9qdTNOZ3X1UQMZsMPIIOR/99SuBhEEitutAwyTxi60rIdC5R/dKB9lBF5uHzwxv119pQnIHusmDgz45EAIXIvElLY+1JQB+bUhZlqhGe8N19oPoK5V1lyWk7DTklOY823aNMS0KEvOODTNG77vNVjTv3nWLU2IZrmOc29a/s4Sva2vku3v7kmTpWt8ZuKrmBse3KaO7Qt3PgWhVferqDdZ9qfblGif0vmVClw66YJTy+tfm4YLkElsNW33d4ona5rkZKfgpF8D6gjuc74h+4uq5+KPGohoNke1dB83v1xkn11scy9p74X1hW/NNLkpA/Cw5o7fkguaUVVcjt/o0NRpN2XaV5XmrpcIJzXGepYWwxWIMRFTO7UGpcd4RxslDy6QG+ZnQDeHsUTTRtaFXX6IIGc3q4n3Lu8ol65ZjkbJhxae06XiPqfihYO2HGFkQLwPxvfxtKR55voQfLMTFmPipsJ4MosQqEwz/qCo2WZLIG/Z6dADEA9ABHCBoIz6zEYcDIO7ZiIc14kgi7p2FeBBH5GZlI365WHiLiykgDt3wOOTROJD7NuT+kCgnmESreAooIxQZKAMLZb8nlAyBcvCGUDa4HEQ2ynAclMOenBjkEtNyiwvxO5W/v9URJZIRxf+gW4i+243Occ5N5Ht+X2iPYhJPwjlivdNxDnTtKdCXTYdwTmRPAfA6E6heeyiQZ56FcQjGwXhmY2wvC18FxgAcBdkfaZGi79xGGZ2DchLObvpRJsE04gWIjqIceCOhDGyUPQctXmfWhMFxoNFIQNs7yfPWJtMPGuh4ZA78kVC2IwRJUnKtipTxNU1pgfPLvXXe3cC3sCcPGf9Hmv/wVelfXVOIB2tVyaKuayQL2VuCy3XVNVCFK8yFV4rKAl2v8jBm/KMUZYSxoAXRtkUmx1l1Q4rEaCEsrfr/COePSibCO06FaT/WL5Ruj7LJlh80j3Ky4oeIIQE+SAtGcsyzu6501OdldekVzcQtWtHRWOoCr9tFSXcsJuqqtpbzsx0J0FPCrY4q0jXjOY2H9hbbJqbl0/a0b5PoGV7rp7Br0i7OcVlmscE8cMjtNepOW1A4yoQjW0BteyZhjGwKQ/c8vjTRRPPFjFAD8sXWB16ILwcC2y/lUo1td5EyEX41/TQKx9kE63aE3PEIZksjb5Vgfg/B4KQI1vBA8+JcgiGDqU1oHIFgfarQ2yQYiGyGoUkRDARBN4KF8DyCNSlRE8wbj2C2stUnOy4jp9IdA6k7hkPqjtN/wdG80DggCo/1TgnYotj7/N/P/2mtkGdGfgFn5hfgGdM/GG36a46+80u/5WrTy58UvZBBC2RmhZPXLwZRG+KOwC9bCH2r/AptfgWT4hcw45eZwE7egJnxy5QKBuQX/Cl+7V34y0ShQ7qm21Ecn5UJw2lRydCqrS34yVQyt1rj7eV7Tkz9WYiCqIfuV8JuBZ+g+50R+XXFKF2VFtXs9S4jZfYD31QNpLu38kmrZ/fnjv9JsmjHaVlrzD2kMhe7XIrOcmkeZ0X6vVKgf/cGWucah9W0D1uUAUEPZ4ZY5/YcnnqreQLZk3s2rcmtn0fvhzyji1Mnd2hslzUJRpjb70LwAXpFk6IXOhLxT2WX8b4C+ONlDlsF/l7DC92/aEJOSBNdSin+tRURZXp5MSTovu3TxbYWEo6UI2wtdFm/BxZjkvlYfBdUHuCHbkKrgvTABvN43U7h3+Qx9+Fd8kTCHtshXtcf0PcthzQL+cE90iceGsA+7xx/cyrx+Dn+J88pDgCyGZOCnqVRD8amAHQWxrYCODaTX/CEp9/FWWer9unDkbisRd7O8j+mjMk/+kD3C8GrVwW1PsY8ehwXxf0fi+rsuv/3Frr8Hw==</diagram></mxfile>
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 50 KiB |
|
|
@ -1 +0,0 @@
|
|||
<mxfile userAgent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36" version="8.9.3" editor="www.draw.io" type="device"><diagram id="432d1a20-d1cc-8ca9-28d7-4b3bb0bfaf8b" name="Page-1">7Vtdc6M2FP01zHQf2kESX35cZ7Prh24ns8lM20cZZEyDkQty7OyvrwQSBonY1IGESeIHG66EQOce6V4dYQtdbQ7fcrxdf6cRSS1oRwcLfbEgBDZE/EdYHiuLB9zKEOdJJCsdDbfJT6KulNZdEpGiVZFRmrJk2zaGNMtIyFo2nOd03662omn7rlscE8NwG+LUtP6ZRGxdWQPXPtoXJInX6s7AliVLHN7HOd1l8n4WRKvyUxVvsGpL1i/WOKL7hgldW+gqp5RVR5vDFUkFtgq26rqvT5TWz52TjPW5wJF+ecDpjqhHLh+MPSowyu4QcYFtofl+nTByu8WhKN1z93Pbmm1Sfgb4YcFyek+uaErz8mpkl5+6RMEp6q6SNG3UlEChOU6TOOO2kHeC8MK52SvZ0QeSM3JomGQvvxG6ISx/5FVUqe9Ul0hGBrPqdN9wr/TJuuFZJG1YEiquGz6Cyg8krt0YQwPihcd/F78s+CPPF/CTgTjvE+sLa28QBVYJp/hnWbBJokjcsNOjAyDugRbgAEET8ZmJOBwA8cBE3K8QRwJx5yLEvTAgy5WJeIRJsAqngDi0/fOQB+NAPjMhd98myggFGsrAQNntmEqGQBmAdwSzRmYvMGGGI8FsTtkW9FIBarHFGT+OxfGPak4JxJziflI1eOPNSpd4J4BL5Hkd3nFJEDlT8E7NxEeFujkIuuLpEN5RbTQHAXibMVSlHxLlmWOA7IORQO6YaczU8E2ADMBZlN2REpWu3BBdgnLkz5bdKBMvnMR8DoKzKHvOSCgjE2XnbUZN6J1HGY2EsjNQbjL9GQOdn5c9dySUTUhJFJNbeUpztqYxzXB6fbTO2yv4BvbkkLC/hPk3V579rUoy/mCNInGqymrRQrQW4WJdNg3kyQ1m3CtZaYG2U3oY5+yzkGW4MaMZUbaviehn2QzJIq0GtzTK/yGMPUqhCO8Y5aZjX3+ndHuWTab+oHiUkhU7RQwB8Ela5CTFLHloi0ddXpaX3tCE36IxNWqpLnDaTRR0l4dEXtVUc/5vQxz0mDCjoZJ0dX968RCZc6pJTMOnzWHfJNEzvNZNYVunXZjiokhCjXnglNsr1K2monCWCWfWgMr2TMJooRT69mV84WvXNl/0GWpAvpjR4ZX4cmJie1EuVdi2M5SJ8Ktup5Y4LiZYuyFkj0ewHkr2OyHYrINgzqQIVvNA8eJSgiGNqfXUOALBvA+CyW4qaa7FsEkRDHheewbz4WUEq0OiIpgzHsH8DoKZquMisErZ0ROyoz+k7Dj95W29o3FCFB5rUwmZu0of4/84/qeVIc+0+AIujC/A0Ya/N97wN7fQ3iu/1OZCk1+zSfELabxAeljoncBoTK2ZOzzB1CN+EKze4GsSDPRVe14og9GnMD2G9V6D6VOYrhYMyDBz0+gUw45OfDFd6JS0abdEx2cFQ8WvqXBJ06uNZXhvLunLrfHW8w40uPSd5PecRtC+y4n4uckpXRkEMxPdnBTJT7wsKwgnb8XjlQ/szi33i+DOjtGiEpc7qKRnuUyozSInD5Msviul51+dgRJclb3WnrL0/Lberhw6wXUmI+m+enzoCA+9NwNeaEjDNlGAozXRd0j72kJZKUUjjOgPCfgUv+xJ8Qudmej70kvbqgDueAHD1OfuKnyh/QeNSI9A0eaUJGBTDJGm19dBvPZGnzptyiD+SFHCVKlkHLbXYiu4KLn37y7JSSQoTvlXmmT3Imy33VGV1UH9h3jpfXgfPRHDx/aQ03YQdF3DQ3VGP7iLeihVz3upv1YKz77U/7R2OADI+iTldWRLHRjrYtAlGLvmYnpsJr/iy55uG2e1Xdl8D3EYLvPT459fqiBw/IcRuv4P</diagram></mxfile>
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 49 KiB |
|
|
@ -1 +0,0 @@
|
|||
<mxfile userAgent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36" version="8.9.3" editor="www.draw.io" type="device"><diagram id="0ffe4643-5db2-c819-e50e-e9015c718b6a" name="Page-1">7Vxbc5s4FP41nmkfdgdJ3PwYJ2n90O502s5s+6iAYrMl4MFK4vTXrwQIgw62MbZaSpyX2EfiAJ8+nZskT8j1w+Z9RlfLj2nI4gm2ws2E3EwwRhYm4p+UvBQSFzmFYJFFYdlpK/gS/WTqylL6GIVs3ejI0zTm0aopDNIkYQFvyGiWpc/Nbvdp3Lzrii4YEHwJaAyl/0YhXxZS37G28jmLFkt1Z2SVLXc0+LHI0sekvN8Ek/v8r2h+oEpX2X+9pGH6XBOR2wm5ztKUF58eNtcsltgq2Irr3u1orZ47YwnvdAEurnii8WP57nNX/J+/mQtdszl+Wz4nf1HYcLYRqmdL/hALARIf1zxLf7DrNE6zvAtxA5/d3YuW+yiOa/KQMv8+EHIaR4tEyALxmEw0zp5YxiOB/1XZ8BCFobzh7HkZcfZlRQN592fBNiGDL1m+t9TCNjVR+dLvWfrAePYiumwUIYsrSn4iUuLwXBvtaSFa1gZaDRst+bWoFG8xFh9KmNshdwHiV30wDt0713EhxoJrOBgExqSJsWsBiF1DEHsA4tk4IUboMMaWGYx9gPH1SDH2D2Nsm8F4CjC+GSfG2PF/F49VyFED+XacIBNiHQTZMQQygWGGV4QZRIYZ9kjDDGx5h+MM3xDmNsTcGSfMhPgazAjA7BiyHyrVqWHKQpFMlF/TjC/TRZrQ+HYrneUZApMarCb4bBPxb1L8t1N++65aEvFgtSb5VbVVWYTUFtL1MleNyi+fKBfDkuQSbNn5ENOMX8k8SQiTNGFK9i6S75mrYUmo9RCSWvt/jPOXMnOjjzwVou27fkjT1S46Wflf1aLyK1QjUszu+T5mSID38iJjMeXRUzObaxvl8tJPaSRuUXP5zWnrazxZp49ZwMqL6tnVkXoE5AvGgZ6cctXbdGMhDBXGO9k1m+r6cLJjM5OdQD82wW4sQV2vaCI+L+Tnz4Vr86Vrc96qHkJ5vVOf0fHxHXFbgozQYX5oD2F0sJaRYAuaYt+QKSYOGJ0bymkHoDO2jn7Su7yDNE0rOSXzJ3FmE+dGAitM3Lqwdi2WSkeZS/MnKRFEyeJrbgv/sltjQ1ka2mckO1jzM4yajZ1DoaFtatBgPQQ6VOCLamPXxd/V/eMJDqnptpWvVn77e+Wcd45I4TgmjcSjcAJNBh90cAcCGyU70Q/aXnMyez39oI2tvXrO5wcJLP38k8pS8sUGHGsDkPPrgmgCq0mDNQK1QNzC9Ui8Fph/YlkkQJAeOL/dzuFpTH5vWJMfNSctcjUVXWe/YyFNkbnpD8Pg4fMItZBop2tpuqBOjkblBnWuqeLAQLiml6aqmuuxXCNTTRHRFO3gmmAEfal1K41/98nh+fs9oN7fRhrViyfoS3wVndWI/1kuIl7c3rFury1hMRX72giM2mDN1VljX5VH102SAnkgJglrZQagoq9JAorO5/7slpKvGKGb+ZurXgX20Jve5ewAk5e5A1nTaGI7tcHcVSnM2ecuLDbMcY71bKRY64vNLWA7hhb0bVgkmJMc7Ouxgu0fBNslhsCGOfTczsG+GSnY2HF/G9gw8507Odi3IwVbj/XbwDa0DK1Cg8ta3XjX6pBKbU9drAOKzhenOX9Q3L+vTLFz0OuxvlqLa8T6fkdy/KLyg6tl51ZPDumFbqDojBzCgEMfGH26lLp75PxtkayhlN+BKdpxU99AGRv4qHbPZuneKIjpeh0FmkNCXQ2DylbrhsEdlF3w9GJi330gmlkwtw/EgVnpq6WXA+k1rBWWqbYu0tfraHqmxtjlQp/zatnlQnYNK6ip1m9PpZeuyCC/2rZXvVJ+eZBf00Hxq9r5eiq/dEUG+XUJvip++ZBfao1yKASbaru6exNMU2SQYKfuYxkPwVDbEt+wwnu/GZX33t6GtIomSBTPSLBTN7iMnGDDCvArPacmkFjbPkIsYwxTk+DCsGqT1JArl5ZGjL4MIxpVDdYovEuUrxjmtTBM/STDQBiG3ObaKPJwTy+pFcGqDT8GGNYW58NjOnN/kp/TceU5He+c53SGf4qqOom65xSVqV/A8C5Fyr0GgAzKAGjb1wjqGyXb2vw3tw3cgztYXivB/oTN3xoxiO4Yeu+0NJfo+5coed9e3oGVKpFuw3Qv1jkP022YuZNsav9fR4ZtB9EEyY7e6VTuSjqHOyTDcod6sQek4p25pGdc5nJ6HwMufWTZD0EjbH3NGAPE+n1bRnbS5Jgj6M1yrzJGv+AEunvcpB2zW1BpbKN4MqzjzUgxQzuUdfRU9rQUGRvb9eVe4o69BBtYZHvAwnfll7ZQgZxzeQrxdftbo0X37Q+6ktv/AQ==</diagram></mxfile>
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en-US">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="initial-scale=1, maximum-scale=1, user-scalable=yes">
|
||||
<title>MerkleTree.js - library to construct Merkle Trees and verify proofs in JavaScript</title>
|
||||
<style>
|
||||
* {
|
||||
box-sizing: border-box;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
body {
|
||||
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
|
||||
font-size: 14px;
|
||||
color: #222;
|
||||
}
|
||||
.container {
|
||||
max-width: 700px;
|
||||
text-align: center;
|
||||
padding: 5em 2em 2em 2em;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
margin: 0 auto;
|
||||
}
|
||||
.logo {
|
||||
width: 100%;
|
||||
}
|
||||
.tagline {
|
||||
font-size: 1.5em;
|
||||
padding: 2em 0;
|
||||
font-style: italic;
|
||||
line-height: 1.4;
|
||||
}
|
||||
.actions {
|
||||
padding: 2em;
|
||||
}
|
||||
.button {
|
||||
cursor: pointer;
|
||||
-webkit-appearance: none;
|
||||
border-radius: 5px;
|
||||
padding: 15px 35px;
|
||||
border-radius: 4px;
|
||||
outline: none;
|
||||
font-weight: 600;
|
||||
white-space: normal;
|
||||
color: #fff;
|
||||
background-color: #333;
|
||||
border: 1px solid #333;
|
||||
line-height: 1;
|
||||
letter-spacing: .1em;
|
||||
text-transform: uppercase;
|
||||
text-decoration: none;
|
||||
}
|
||||
@media (max-width: 500px) {
|
||||
body {
|
||||
font-size: 12px;
|
||||
}
|
||||
}
|
||||
@media (max-width: 300px) {
|
||||
body {
|
||||
font-size: 10px;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="container">
|
||||
<div>
|
||||
<a href="https://github.com/miguelmota/merkletreejs">
|
||||
<img class="logo" src="https://user-images.githubusercontent.com/168240/83951171-85f48c80-a7e4-11ea-896e-529c28ffa18e.png" alt="MerkleTree.js" />
|
||||
</a>
|
||||
</div>
|
||||
<div class="tagline">
|
||||
A library to construct Merkle Trees and verify proofs in JavaScript
|
||||
</div>
|
||||
|
||||
<div class="actions">
|
||||
<a class="button" href="https://github.com/miguelmota/merkletreejs">View on Github ›</a>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
254
index.js
254
index.js
|
|
@ -1,254 +0,0 @@
|
|||
const reverse = require('buffer-reverse')
|
||||
|
||||
/**
|
||||
* Class reprensenting a Merkle Tree
|
||||
* @namespace MerkleTree
|
||||
*/
|
||||
class MerkleTree {
|
||||
/**
|
||||
* @desc Constructs a Merkle Tree.
|
||||
* All nodes and leaves are stored as Buffers.
|
||||
* Lonely leaf nodes are promoted to the next level up without being hashed again.
|
||||
* @param {Buffer[]} leaves - Array of hashed leaves. Each leaf must be a Buffer.
|
||||
* @param {Function} hashAlgorithm - Algorithm used for hashing leaves and nodes
|
||||
* @param {Object} options - Additional options
|
||||
* @param {Boolean} options.isBitcoinTree - If set to `true`, constructs the Merkle
|
||||
* Tree using the [Bitcoin Merkle Tree implementation](http://www.righto.com/2014/02/bitcoin-mining-hard-way-algorithms.html). Enable it when you need
|
||||
* to replicate Bitcoin constructed Merkle Trees. In Bitcoin Merkle Trees, single nodes are combined with themselves, and each output hash is hashed again.
|
||||
* @example
|
||||
* const MerkleTree = require('merkletreejs')
|
||||
* const crypto = require('crypto')
|
||||
*
|
||||
* function sha256(data) {
|
||||
* // returns Buffer
|
||||
* return crypto.createHash('sha256').update(data).digest()
|
||||
* }
|
||||
*
|
||||
* const leaves = ['a', 'b', 'c'].map(x => sha3(x))
|
||||
*
|
||||
* const tree = new MerkleTree(leaves, sha256)
|
||||
*/
|
||||
constructor(leaves, hashAlgorithm, options={}) {
|
||||
this.hashAlgo = hashAlgorithm
|
||||
this.leaves = leaves
|
||||
this.layers = [leaves]
|
||||
this.isBitcoinTree = !!options.isBitcoinTree
|
||||
|
||||
this.createHashes(this.leaves)
|
||||
}
|
||||
|
||||
createHashes(nodes) {
|
||||
if (nodes.length === 1) {
|
||||
return false
|
||||
}
|
||||
|
||||
const layerIndex = this.layers.length
|
||||
|
||||
this.layers.push([])
|
||||
|
||||
for (let i = 0; i < nodes.length - 1; i += 2) {
|
||||
const left = nodes[i]
|
||||
const right = nodes[i+1]
|
||||
let data = null
|
||||
|
||||
if (this.isBitcoinTree) {
|
||||
data = Buffer.concat([reverse(left), reverse(right)])
|
||||
} else {
|
||||
data = Buffer.concat([left, right])
|
||||
}
|
||||
|
||||
let hash = this.hashAlgo(data)
|
||||
|
||||
// double hash if bitcoin tree
|
||||
if (this.isBitcoinTree) {
|
||||
hash = reverse(this.hashAlgo(hash))
|
||||
}
|
||||
|
||||
this.layers[layerIndex].push(hash)
|
||||
}
|
||||
|
||||
// is odd number of nodes
|
||||
if (nodes.length % 2 === 1) {
|
||||
let data = nodes[nodes.length-1]
|
||||
let hash = data
|
||||
|
||||
// is bitcoin tree
|
||||
if (this.isBitcoinTree) {
|
||||
// Bitcoin method of duplicating the odd ending nodes
|
||||
data = Buffer.concat([reverse(data), reverse(data)])
|
||||
hash = this.hashAlgo(data)
|
||||
hash = reverse(this.hashAlgo(hash))
|
||||
}
|
||||
|
||||
this.layers[layerIndex].push(hash)
|
||||
}
|
||||
|
||||
this.createHashes(this.layers[layerIndex])
|
||||
}
|
||||
|
||||
/**
|
||||
* getLeaves
|
||||
* @desc Returns array of leaves of Merkle Tree.
|
||||
* @return {Buffer[]}
|
||||
* @example
|
||||
* const leaves = tree.getLeaves()
|
||||
*/
|
||||
getLeaves() {
|
||||
return this.leaves
|
||||
}
|
||||
|
||||
/**
|
||||
* getLayers
|
||||
* @desc Returns array of all layers of Merkle Tree, including leaves and root.
|
||||
* @return {Buffer[]}
|
||||
* @example
|
||||
* const layers = tree.getLayers()
|
||||
*/
|
||||
getLayers() {
|
||||
return this.layers
|
||||
}
|
||||
|
||||
/**
|
||||
* getRoot
|
||||
* @desc Returns the Merkle root hash as a Buffer.
|
||||
* @return {Buffer}
|
||||
* @example
|
||||
* const root = tree.getRoot()
|
||||
*/
|
||||
getRoot() {
|
||||
return this.layers[this.layers.length-1][0]
|
||||
}
|
||||
|
||||
/**
|
||||
* getProof
|
||||
* @desc Returns the proof for a target leaf.
|
||||
* @param {Buffer} leaf - Target leaf
|
||||
* @param {Number} [index] - Target leaf index in leaves array.
|
||||
* Use if there are leaves containing duplicate data in order to distinguish it.
|
||||
* @return {Buffer[]} - Array of Buffer hashes.
|
||||
* @example
|
||||
* const proof = tree.getProof(leaves[2])
|
||||
*
|
||||
* @example
|
||||
* const leaves = ['a', 'b', 'a'].map(x => sha3(x))
|
||||
* const tree = new MerkleTree(leaves, sha3)
|
||||
* const proof = tree.getProof(leaves[2], 2)
|
||||
*/
|
||||
getProof(leaf, index) {
|
||||
const proof = [];
|
||||
|
||||
if (typeof index !== 'number') {
|
||||
index = -1
|
||||
|
||||
for (let i = 0; i < this.leaves.length; i++) {
|
||||
if (Buffer.compare(leaf, this.leaves[i]) === 0) {
|
||||
index = i
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (index <= -1) {
|
||||
return []
|
||||
}
|
||||
|
||||
if (this.isBitcoinTree && index === (this.leaves.length - 1)) {
|
||||
|
||||
// Proof Generation for Bitcoin Trees
|
||||
|
||||
for (let i = 0; i < this.layers.length - 1; i++) {
|
||||
const layer = this.layers[i]
|
||||
const isRightNode = index % 2
|
||||
const pairIndex = (isRightNode ? index - 1: index)
|
||||
|
||||
if (pairIndex < layer.length) {
|
||||
proof.push({
|
||||
position: isRightNode ? 'left': 'right',
|
||||
data: layer[pairIndex]
|
||||
})
|
||||
}
|
||||
|
||||
// set index to parent index
|
||||
index = (index / 2)|0
|
||||
|
||||
}
|
||||
|
||||
return proof
|
||||
|
||||
} else {
|
||||
|
||||
// Proof Generation for Non-Bitcoin Trees
|
||||
|
||||
for (let i = 0; i < this.layers.length; i++) {
|
||||
const layer = this.layers[i]
|
||||
const isRightNode = index % 2
|
||||
const pairIndex = (isRightNode ? index - 1 : index + 1)
|
||||
|
||||
if (pairIndex < layer.length) {
|
||||
proof.push({
|
||||
position: isRightNode ? 'left': 'right',
|
||||
data: layer[pairIndex]
|
||||
})
|
||||
}
|
||||
|
||||
// set index to parent index
|
||||
index = (index / 2)|0
|
||||
|
||||
}
|
||||
|
||||
return proof
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* verify
|
||||
* @desc Returns true if the proof path (array of hashes) can connect the target node
|
||||
* to the Merkle root.
|
||||
* @param {Buffer[]} proof - Array of proof Buffer hashes that should connect
|
||||
* target node to Merkle root.
|
||||
* @param {Buffer} targetNode - Target node Buffer
|
||||
* @param {Buffer} root - Merkle root Buffer
|
||||
* @return {Boolean}
|
||||
* @example
|
||||
* const root = tree.getRoot()
|
||||
* const proof = tree.getProof(leaves[2])
|
||||
* const verified = tree.verify(proof, leaves[2], root)
|
||||
*
|
||||
*/
|
||||
verify(proof, targetNode, root) {
|
||||
let hash = targetNode
|
||||
|
||||
if (!Array.isArray(proof) ||
|
||||
!proof.length ||
|
||||
!targetNode ||
|
||||
!root) {
|
||||
return false
|
||||
}
|
||||
|
||||
for (let i = 0; i < proof.length; i++) {
|
||||
const node = proof[i]
|
||||
const isLeftNode = (node.position === 'left')
|
||||
const buffers = []
|
||||
|
||||
if (this.isBitcoinTree) {
|
||||
buffers.push(reverse(hash))
|
||||
|
||||
buffers[isLeftNode ? 'unshift' : 'push'](reverse(node.data))
|
||||
|
||||
hash = this.hashAlgo(Buffer.concat(buffers))
|
||||
hash = reverse(this.hashAlgo(hash))
|
||||
|
||||
} else {
|
||||
buffers.push(hash)
|
||||
|
||||
buffers[isLeftNode ? 'unshift' : 'push'](node.data)
|
||||
|
||||
hash = this.hashAlgo(Buffer.concat(buffers))
|
||||
}
|
||||
}
|
||||
|
||||
return Buffer.compare(hash, root) === 0
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = MerkleTree
|
||||
9
jsdoc.js
9
jsdoc.js
|
|
@ -1,9 +0,0 @@
|
|||
const jsdoc2md = require('jsdoc-to-markdown')
|
||||
|
||||
jsdoc2md.render({
|
||||
files: 'index.js',
|
||||
separators: true
|
||||
})
|
||||
.then(data => {
|
||||
console.log(data)
|
||||
})
|
||||
File diff suppressed because it is too large
Load Diff
44
package.json
44
package.json
|
|
@ -1,49 +1,23 @@
|
|||
{
|
||||
"name": "merkletreejs",
|
||||
"version": "0.0.6",
|
||||
"description": "Construct Merkle Trees and verify proofs",
|
||||
"version": "1.0.0",
|
||||
"description": "",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"test": "tape test/*.js",
|
||||
"docs:md": "node jsdoc.js"
|
||||
"test": "echo \"Error: no test specified\" && exit 1",
|
||||
"markdown2html": "markdownb -f markdown -h -s style.css README.md"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/miguelmota/merkle-tree"
|
||||
},
|
||||
"keywords": [
|
||||
"merkle",
|
||||
"tree",
|
||||
"hash",
|
||||
"algorithm",
|
||||
"crypto",
|
||||
"bitcoin",
|
||||
"ethereum",
|
||||
"proof"
|
||||
],
|
||||
"author": {
|
||||
"name": "Miguel Mota",
|
||||
"email": "hello@miguelmota.com",
|
||||
"url": "https://miguelmota.com/"
|
||||
},
|
||||
"license": {
|
||||
"type": "MIT",
|
||||
"url": "https://github.com/miguelmota/merkle-tree/blob/master/LICENSE.md"
|
||||
"url": "git+https://github.com/miguelmota/merkle-tree.git"
|
||||
},
|
||||
"author": "",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/miguelmota/merkle-tree/issues"
|
||||
},
|
||||
"homepage": "https://github.com/miguelmota/merkle-tree",
|
||||
"devDependencies": {
|
||||
"crypto": "0.0.3",
|
||||
"ethereumjs-util": "^5.1.2",
|
||||
"jsdoc-to-markdown": "^3.0.0",
|
||||
"tape": "^3.6.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 7.6.0"
|
||||
},
|
||||
"homepage": "https://github.com/miguelmota/merkle-tree#readme",
|
||||
"dependencies": {
|
||||
"buffer-reverse": "^1.0.1"
|
||||
"markdown-to-html": "0.0.13"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
212
test/index.js
212
test/index.js
|
|
@ -1,212 +0,0 @@
|
|||
const test = require('tape')
|
||||
const {sha3} = require('ethereumjs-util')
|
||||
const crypto = require('crypto')
|
||||
|
||||
const MerkleTree = require('../')
|
||||
|
||||
function sha256(data) {
|
||||
return crypto.createHash('sha256').update(data).digest()
|
||||
}
|
||||
|
||||
test('sha256', t => {
|
||||
t.plan(1)
|
||||
|
||||
const leaves = ['a', 'b', 'c'].map(x => sha3(x))
|
||||
|
||||
const tree = new MerkleTree(leaves, sha256)
|
||||
|
||||
const root = '311d2e46f49b15fff8b746b74ad57f2cc9e0d9939fda94387141a2d3fdf187ae'
|
||||
t.equal(tree.getRoot().toString('hex'), root)
|
||||
})
|
||||
|
||||
test('solidity sha3 [keccak-256]', t => {
|
||||
t.plan(20)
|
||||
|
||||
const leaves = ['a', 'b', 'c'].map(x => sha3(x))
|
||||
|
||||
const a_hash = '3ac225168df54212a25c1c01fd35bebfea408fdac2e31ddd6f80a4bbf9a5f1cb'
|
||||
const b_hash = 'b5553de315e0edf504d9150af82dafa5c4667fa618ed0a6f19c69b41166c5510'
|
||||
const c_hash = '0b42b6393c1f53060fe3ddbfcd7aadcca894465a5a438f69c87d790b2299b9b2'
|
||||
|
||||
t.deepEqual(leaves.map(x => x.toString('hex')), [a_hash, b_hash, c_hash])
|
||||
|
||||
const tree = new MerkleTree(leaves, sha3)
|
||||
|
||||
const layers = tree.getLayers().slice(1) // no leaves
|
||||
|
||||
const layer_1 = sha3(Buffer.concat([leaves[0], leaves[1]])).toString('hex')
|
||||
t.equal(layers[0][0].toString('hex'), layer_1)
|
||||
t.equal(layers[0][1].toString('hex'), c_hash)
|
||||
|
||||
const root = Buffer.from('aff1208e69c9e8be9b584b07ebac4e48a1ee9d15ce3afe20b77a4d29e4175aa3', 'hex')
|
||||
t.equal(tree.getRoot().toString('hex'), root.toString('hex'))
|
||||
|
||||
const proof_0 = tree.getProof(leaves[0])
|
||||
t.equal(proof_0.length, 2)
|
||||
t.equal(proof_0[0].position, 'right')
|
||||
t.equal(proof_0[0].data.toString('hex'), b_hash)
|
||||
t.equal(proof_0[1].position, 'right')
|
||||
t.equal(proof_0[1].data.toString('hex'), c_hash)
|
||||
|
||||
t.equal(tree.verify(proof_0, leaves[0], root), true)
|
||||
|
||||
const proof_1 = tree.getProof(leaves[1])
|
||||
t.equal(proof_1.length, 2)
|
||||
t.equal(proof_1[0].position, 'left')
|
||||
t.equal(proof_1[0].data.toString('hex'), a_hash)
|
||||
t.equal(proof_1[1].position, 'right')
|
||||
t.equal(proof_1[1].data.toString('hex'), c_hash)
|
||||
|
||||
t.equal(tree.verify(proof_1, leaves[1], root), true)
|
||||
|
||||
const proof_2 = tree.getProof(leaves[2])
|
||||
t.equal(proof_2.length, 1)
|
||||
t.equal(proof_2[0].position, 'left')
|
||||
t.equal(proof_2[0].data.toString('hex'), layer_1)
|
||||
|
||||
t.equal(tree.verify(proof_2, leaves[2], root), true)
|
||||
})
|
||||
|
||||
test('solidity sha3 [keccak-256] with duplicate leaves', t => {
|
||||
t.plan(5)
|
||||
|
||||
const leaves = ['a', 'b', 'a'].map(x => sha3(x))
|
||||
|
||||
const a_hash = '3ac225168df54212a25c1c01fd35bebfea408fdac2e31ddd6f80a4bbf9a5f1cb'
|
||||
const b_hash = 'b5553de315e0edf504d9150af82dafa5c4667fa618ed0a6f19c69b41166c5510'
|
||||
|
||||
const tree = new MerkleTree(leaves, sha3)
|
||||
|
||||
t.deepEqual(leaves.map(x => x.toString('hex')), [a_hash, b_hash, a_hash])
|
||||
|
||||
const root = Buffer.from('b8912f7269068901f231a965adfefbc10f0eedcfa61852b103efd54dac7db3d7', 'hex')
|
||||
t.equal(tree.getRoot().toString('hex'), root.toString('hex'))
|
||||
|
||||
const layer_1 = sha3(Buffer.concat([leaves[0], leaves[1]])).toString('hex')
|
||||
|
||||
const proof_0 = tree.getProof(leaves[2], 2)
|
||||
t.equal(proof_0.length, 1)
|
||||
t.equal(proof_0[0].position, 'left')
|
||||
t.equal(proof_0[0].data.toString('hex'), layer_1)
|
||||
})
|
||||
|
||||
|
||||
test('sha-256 with option.isBitcoinTree', t => {
|
||||
t.plan(2)
|
||||
|
||||
/* Derived from:
|
||||
* http://www.righto.com/2014/02/bitcoin-mining-hard-way-algorithms.html
|
||||
*/
|
||||
const txHashes = [
|
||||
"00baf6626abc2df808da36a518c69f09b0d2ed0a79421ccfde4f559d2e42128b",
|
||||
"91c5e9f288437262f218c60f986e8bc10fb35ab3b9f6de477ff0eb554da89dea",
|
||||
"46685c94b82b84fa05b6a0f36de6ff46475520113d5cb8c6fb060e043a0dbc5c",
|
||||
"ba7ed2544c78ad793ef5bb0ebe0b1c62e8eb9404691165ffcb08662d1733d7a8",
|
||||
"b8dc1b7b7ed847c3595e7b02dbd7372aa221756b718c5f2943c75654faf48589",
|
||||
"25074ef168a061fcc8663b4554a31b617683abc33b72d2e2834f9329c93f8214",
|
||||
"0fb8e311bffffadc6dc4928d7da9e142951d3ba726c8bde2cf1489b62fb9ebc5",
|
||||
"c67c79204e681c8bb453195db8ca7d61d4692f0098514ca198ccfd1b59dbcee3",
|
||||
"bd27570a6cbd8ad026bfdb8909fdae9321788f0643dea195f39cd84a60a1901b",
|
||||
"41a06e53ffc5108358ddcec05b029763d714ae9f33c5403735e8dee78027fe74",
|
||||
"cc2696b44cb07612c316f24c07092956f7d8b6e0d48f758572e0d611d1da6fb9",
|
||||
"8fc508772c60ace7bfeb3f5f3a507659285ea6f351ac0474a0a9710c7673d4fd",
|
||||
"62fed508c095446d971580099f976428fc069f32e966a40a991953b798b28684",
|
||||
"928eadbc39196b95147416eedf6f635dcff818916da65419904df8fde977d5db",
|
||||
"b137e685df7c1dffe031fb966a0923bb5d0e56f381e730bc01c6d5244cfe47c1",
|
||||
"b92207cee1f9e0bfbd797b05a738fab9de9c799b74f54f6b922f20bd5ec23dd6",
|
||||
"29d6f37ada0481375b6903c6480a81f8deaf2dcdba03411ed9e8d3e5684d02dd",
|
||||
"48158deb116e4fd0429fbbbae61e8e68cb6d0e0c4465ff9a6a990037f88c489c",
|
||||
"be64ea86960864cc0a0236bbb11f232faf5b19ae6e2c85518628f5fae37ec1ca",
|
||||
"081363552e9fff7461f1fc6663e1abd0fb2dd1c54931e177479a18c4c26260e8",
|
||||
"eb87c25dd2b2537b1ff3dbabc420e422e2a801f1bededa6fa49ef7980feaef70",
|
||||
"339e16fcc11deb61ccb548239270af43f5ad34c321416bada4b8d66467b1c697",
|
||||
"4ad6417a3a04179482ed2e4b7251c396e38841c6fba8d2ce9543337ab7c93c02",
|
||||
"c28a45cded020bf424b400ffc9cb6f2f85601934f18c34a4f78283247192056a",
|
||||
"882037cc9e3ee6ddc2d3eba86b7ca163533b5d3cbb16eaa38696bb0a2ea1137e",
|
||||
"179bb936305b46bb0a9df330f8701984c725a60e063ad5892fa97461570b5c04",
|
||||
"9517c585d1578cb327b7988f38e1a15c663955ea288a2292b40d27f232fbb980",
|
||||
"2c7e07d0cf42e5520bcbfe2f5ef63761a9ab9d7ccb00ea346195eae030f3b86f",
|
||||
"534f631fc42ae2d309670e01c7a0890e4bfb65bae798522ca14df09c81b09734",
|
||||
"104643385619adb848593eb668a8066d1f32650edf35e74b0fc3306cb6719448",
|
||||
"87ac990808239c768182a752f4f71cd98558397072883c7e137efb49d22b9231",
|
||||
"9b3e2f1c47d59a444e9b6dc725f0ac6baf160d22f3a9d399434e5e65b14eccb0",
|
||||
"fbe123066ae5add633a542f151663db4eb5a7053e388faadb40240671ae1b09b",
|
||||
"1dd07e92e20b3cb9208af040031f7cfc4efd46cc31ec27be20a1047965a42849",
|
||||
"2709bb9ed27353c1fd76b9240cab7576a44de68945e256ad44b2cb8d849a8060",
|
||||
"d0174db2c712573432a7869c1508f371f3a1058aeedddc1b53a7e04d7c56c725",
|
||||
"b4a16f724cddb8f77ddf3d2146a12c4be13d503885eaba3518a03da005009f62",
|
||||
"2aa706d75decbe57745e01d46f9f5d30a08dedaf3288cee14cc4948e3684e1d4",
|
||||
"ee49c5f6a5129ccaf2abebbc1d6d07a402a600af6221476b89aafaa683ca95b7",
|
||||
"bea1011c77874845e9b4c876ed2ceebd530d428dd4a564ad003d9211d40bb091",
|
||||
"f1e88ffc2b1de2aa4827002f06943ce5468735f7433f960bf01e75885b9f832b",
|
||||
"19247d017e002fb9143d1a89eb921222a94f8a3d0faaf2e05b0f594989edc4c4",
|
||||
"13f714ff62ee7d26b6d69ca980c141ebc54e9f71d2697083fe6c5efc1b02bd0f",
|
||||
"0c78cbb8246572f015fbdc53dc9798fa54d1119ec77c1f07ac310bcbcc40dbf8",
|
||||
"4bcde0ef92a6d24a2be7be50ac5e5299d776df2e6229ba5d475c2491da94f255",
|
||||
"0cfd7d1058502730cf0b2ffa880c78ef534651e06832b5d87c0d7eb84eac5b0c",
|
||||
"3a168f794d6e0c614429ad874317cc4cd67a8177214880ff6ea1704d29228c2f",
|
||||
"f9a555d817334397b402518d6fd959dc73d981ee7f5fe67969b63974ebbef127",
|
||||
"24b52691f66eaed4ce391a473902e309018257c98b9f02aaa33b399c9e6f3168",
|
||||
"a37b5e623dc26a180d9e2c9510d06885b014e86e533adb63ec40511e10b55046",
|
||||
"9dbaeb485e51d9e25a5621dc46e0bc0aaf51fb26be5acc4e370b96f62c469b80",
|
||||
"a6431d3d39f6c38c5df48405090752cab03bfdf5c77cf881b18a946807fba74a",
|
||||
"faa77e309f125373acf19855dd496fffe2f74962e545420844557a3adc7ebc11",
|
||||
"3523f52543ecfea2f78486dc91550fad0e6467d46d9d9c82ca63b2e0230bfa71",
|
||||
"a0583e358e42d77d18d1fd0533ff0a65615fc3b3112061ef92f168a00bf640c1",
|
||||
"42ae900888d5e5dde59c8e3d06e13db9e84ef05d27726d4b67fd00c50cd9406a",
|
||||
"154940777d3ff78f592ef02790131a59263c36b4958bbc836f9a767ea1a9f178",
|
||||
"6a0337de6ac75eecf748306e8ebc5bfe5c811a1481ae50f6956a9e7f26a679f5",
|
||||
"c99530c2148e09688d0b88795625943371183bf1f5d56c7446c6ed51ea133589",
|
||||
"626421dbe8ad6a0fd0d622d5dd3308a1cdc00b98575a41a91fe01a439e6f40bd",
|
||||
"b2f3a559f605a158cc395126c3cf394a7e92a53b7514c75157e1dc43a6c7f93e",
|
||||
"dffe06d1bea81f2a01c76786404bb867258f9e68013bf25454097ce935090738",
|
||||
"0860159ec7a2a51ce107c182a988c40b4bc2057a734354a1219b6c65e72640ed",
|
||||
"a405ff1bb51846b1867acc0b0da17f6f9616e592a0a7ff5ef3297c1ecfd60911",
|
||||
"a7d451924263284765f6343bca8a21b79b89ebfe611c7355dd88e0ec1c29e232",
|
||||
"41c758d08a4d3fe4d90645711589b832a2cd54dd25bd5b66e463e5d389a53aff",
|
||||
"a05c1a93a521fa5dbc1790cfbb808893453a428a65f2c6b2d51249fbb12db309",
|
||||
"90997920aa9786e10f513cfdd14e294feee6739cee1ab61b3fb1e3f42e7a915d",
|
||||
"99fcb9cb62c20a3135484a70bd3f73983f8f3b7b26266dad34f3993958a7642c",
|
||||
"e05f9a668b37e5f78bd3b9d047f29f92b33a87f11dd48390410006f858188b7b",
|
||||
"56dbc65895f7992da4a6985e7edba4d1c00879f1b28442c644c8a07658ceab27",
|
||||
"5e9004fe262b829563d0804656ba68b1de1690401f08a1915273230d8c902fc0",
|
||||
"1ea9ed3717523c5e304b7a7ac8058a87fb4f3fed8c6004769f226c9bb67e79c5",
|
||||
"f0f1a4c009b3f1b2729e89898e2f5c0fcdc312edea5df884a9c897cb90e4c566",
|
||||
"b5bb4ddf04863e6a60f33cb96c20dac8175d3bae55f335781503143c97a50e43",
|
||||
"f14cc97a20c6f627b4b78301352ae35463bc359362589cd178a06c0fa90850b7",
|
||||
"628801c8f614015c0fa0ccb2768cccc3e7b9d41ceed06071ce2534d31f7236d6",
|
||||
"3be1013c8f8da150e2195408093153b55b08b037fd92db8bb5e803f4c2538aae",
|
||||
"c9e1f8777685f54ba65c4e02915fd649ee1edcbf9c77ddf584b943d27efb86c3",
|
||||
"4274e92ed3bd02eb101baa5fb8ff7b96236830762d08273749fbb5166db8ab0b",
|
||||
"aa84c955bea04c7cee8f5bbbec97d25930fcaca363eed1b8cad37b931556d3e3",
|
||||
"d6a29c948677fb1f71aaf16debc3d071a4dd349458eb9e056dce3a000ff853da",
|
||||
"ba84bdb3d78367ca365016ac4bff9269576eb010f874c2967af73e0de5638de0",
|
||||
"1546c79951e3b541bc64d1957b565b7a2850fc87192c7b374aee6cfc69b9805e",
|
||||
"f119227d492ebe27fe9aae321980802454dfa64b2691efbe796c5075d5b07f62",
|
||||
"b8cf13d64818b32f96bbb585998b1bc9505f6a94055488e5a71fee9479c6f2a9",
|
||||
"1aaf459705b6afef2d7b83e3f181f1af55be0813daf55edce104cc59abc28ed7",
|
||||
"61ac185c8f520b5e3134953dc52ff292a40e1e96b088dab259558a9d240ec02f",
|
||||
"2da96e3154d7ec2329f787b73cb8a436b92d64cf3cc28e920d073279ea73b5f8",
|
||||
"1c4d72ce733b971b9ec4e24f37d733355f6f2ea635cc67ffb3e22748484df446",
|
||||
"2a6f89769f3272ac8c7a36a42a57627eca6b260ab2c76d8046a27d44d4034893",
|
||||
"f8d11df51a2cc113698ebf39a958fe81179d7d973d2044322771c0fe63f4d7c9",
|
||||
"f2287f17a4fa232dca5715c24a92f7112402a8101b9a7b276fb8c8f617376b90",
|
||||
"bb5ee510a4fda29cae30c97e7eee80569d3ec3598465f2d7e0674c395e0256e9",
|
||||
"647ab8c84365620d60f2523505d14bd230b5e650c96dee48be47770063ee7461",
|
||||
"34b06018fcc33ba6ebb01198d785b0629fbdc5d1948f688059158f053093f08b",
|
||||
"ff58b258dab0d7f36a2908e6c75229ce308d34806289c912a1a5f39a5aa71f9f",
|
||||
"232fc124803668a9f23b1c3bcb1134274303f5c0e1b0e27c9b6c7db59f0e2a4d",
|
||||
"27a0797cc5b042ba4c11e72a9555d13a67f00161550b32ede0511718b22dbc2c",
|
||||
]
|
||||
|
||||
var leaves = txHashes.map(x => Buffer.from(x, 'hex'))
|
||||
|
||||
const tree = new MerkleTree(leaves, sha256, {isBitcoinTree: true})
|
||||
|
||||
const root = Buffer.from('871714dcbae6c8193a2bb9b2a69fe1c0440399f38d94b3a0f1b447275a29978a', 'hex')
|
||||
t.equal(tree.getRoot().toString('hex'), root.toString('hex'))
|
||||
|
||||
const proof_0 = tree.getProof(leaves[0])
|
||||
|
||||
t.equal(tree.verify(proof_0, leaves[0], root), true)
|
||||
})
|
||||
Loading…
Reference in New Issue