merkletreejs/README.md

<h3 align="center">
  <br />
  <img src="https://user-images.githubusercontent.com/168240/83951171-85f48c80-a7e4-11ea-896e-529c28ffa18e.png" alt="merkletree.js logo" width="600" />
  <br />
  <br />
  <br />
</h3>

# MerkleTree.js

> Construct [Merkle Trees](https://en.wikipedia.org/wiki/Merkle_tree) and verify proofs in JavaScript.

[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/miguelmota/merkletreejs/master/LICENSE)
[![Build Status](https://travis-ci.org/miguelmota/merkletreejs.svg?branch=master)](https://travis-ci.org/miguelmota/merkletreejs)
[![dependencies Status](https://david-dm.org/miguelmota/merkletreejs/status.svg)](https://david-dm.org/miguelmota/merkletreejs)
[![NPM version](https://badge.fury.io/js/merkletreejs.svg)](http://badge.fury.io/js/merkletreejs)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](#contributing)

## Contents

- [Install](#install)
- [Example](#example)
- [Getting started](#Getting-started)
- [Diagrams](#diagrams)
- [Documentation](#documentation)
- [Test](#test)
- [FAQ](#faq)
- [Notes](#notes)
- [Resources](#resources)
- [Contributing](#contributing)
- [License](#license)

## Install

From [NPM](https://www.npmjs.com/package/merkletreejs):

```bash
npm install merkletreejs
```

### CDN

Available on [jsDelivr](https://www.jsdelivr.com/) CDN:

```html
<script src="https://cdn.jsdelivr.net/npm/merkletreejs@latest/merkletree.js"></script>
```

## Example

[https://lab.miguelmota.com/merkletreejs](https://lab.miguelmota.com/merkletreejs)

## Getting started

Construct tree, generate proof, and verify proof:

```js
const { MerkleTree } = require('merkletreejs')
const SHA256 = require('crypto-js/sha256')

const leaves = ['a', 'b', 'c'].map(x => SHA256(x))
const tree = new MerkleTree(leaves, SHA256)
const root = tree.getRoot().toString('hex')
const leaf = SHA256('a')
const proof = tree.getProof(leaf)
console.log(tree.verify(proof, leaf, root)) // true


const badLeaves = ['a', 'x', 'c'].map(x => SHA256(x))
const badTree = new MerkleTree(badLeaves, SHA256)
const badLeaf = SHA256('x')
const badProof = tree.getProof(badLeaf)
console.log(tree.verify(badProof, leaf, root)) // false
```

Print tree to console:

```js
MerkleTree.print(tree)
```

Output

```bash
└─ 7075152d03a5cd92104887b476862778ec0c87be5c2fa1c0a90f87c49fad6eff
   ├─ e5a01fee14e0ed5c48714f22180f25ad8365b53f9779f79dc4a3d7e93963f94a
   │  ├─ ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb
   │  └─ 3e23e8160039594a33894f6564e1b1348bbd7a0088d42c4acb73eeaed59c009d
   └─ 2e7d2c03a9507ae265ecf5b5356885a53393a2029d241394997265a1a25aefc6
      └─ 2e7d2c03a9507ae265ecf5b5356885a53393a2029d241394997265a1a25aefc6
```

## Diagrams

▾ Visualization of Merkle Tree

<img src="https://user-images.githubusercontent.com/168240/43616375-15330c32-9671-11e8-9057-6e61c312c856.png" alt="Merkle Tree" width="500">

▾ Visualization of Merkle Tree Proof

<img src="https://user-images.githubusercontent.com/168240/43616387-27ec860a-9671-11e8-9f3f-0b871a6581a6.png" alt="Merkle Tree Proof" width="420">

▾ Visualization of Invalid Merkle Tree Proofs

<img src="https://user-images.githubusercontent.com/168240/43616398-33e20584-9671-11e8-9f62-9f48ce412898.png" alt="Merkle Tree Proof" width="420">

▾ Visualization of Bitcoin Merkle Tree

<img src="https://user-images.githubusercontent.com/168240/43616417-46d3293e-9671-11e8-81c3-8cdf7f8ddd77.png" alt="Merkle Tree Proof" width="420">

## Documentation

<!-- :%s/// -->
<!-- :%s/\[Options\]()/\[Options\](#options) -->

<!-- BEGIN DOCUMENTATION -->

# Class: MerkleTree

Class reprensenting a Merkle Tree

**`namespace`** MerkleTree

## Hierarchy

* **MerkleTree**

## Index

### Constructors

* [constructor](_index_.merkletree.md#constructor)

### Methods

* [bufferToHex](_index_.merkletree.md#buffertohex)
* [bufferify](_index_.merkletree.md#bufferify)
* [getDepth](_index_.merkletree.md#getdepth)
* [getHexLayers](_index_.merkletree.md#gethexlayers)
* [getHexLayersFlat](_index_.merkletree.md#gethexlayersflat)
* [getHexLeaves](_index_.merkletree.md#gethexleaves)
* [getHexMultiProof](_index_.merkletree.md#gethexmultiproof)
* [getHexProof](_index_.merkletree.md#gethexproof)
* [getHexRoot](_index_.merkletree.md#gethexroot)
* [getLayers](_index_.merkletree.md#getlayers)
* [getLayersAsObject](_index_.merkletree.md#getlayersasobject)
* [getLayersFlat](_index_.merkletree.md#getlayersflat)
* [getLeaves](_index_.merkletree.md#getleaves)
* [getMultiProof](_index_.merkletree.md#getmultiproof)
* [getProof](_index_.merkletree.md#getproof)
* [getProofFlags](_index_.merkletree.md#getproofflags)
* [getProofIndices](_index_.merkletree.md#getproofindices)
* [getRoot](_index_.merkletree.md#getroot)
* [print](_index_.merkletree.md#print)
* [toJSON](_index_.merkletree.md#tojson)
* [toString](_index_.merkletree.md#tostring)
* [verify](_index_.merkletree.md#verify)
* [verifyMultiProof](_index_.merkletree.md#verifymultiproof)
* [bufferToHex](_index_.merkletree.md#static-buffertohex)
* [static:bufferify](_index_.merkletree.md#static-bufferify)
* [static:getMultiProof](_index_.merkletree.md#static-getmultiproof)
* [static:isHexString](_index_.merkletree.md#static-ishexstring)
* [static:marshalLeaves](_index_.merkletree.md#static-marshalleaves)
* [static:marshalProof](_index_.merkletree.md#static-marshalproof)
* [static:print](_index_.merkletree.md#static-print)
* [static:unmarshalLeaves](_index_.merkletree.md#static-unmarshalleaves)
* [static:unmarshalProof](_index_.merkletree.md#static-unmarshalproof)

## Constructors

###  constructor

\+ **new MerkleTree**(`leaves`: any[], `hashFn`: any, `options`: [Options](#options)): *[MerkleTree](_index_.merkletree.md)*

**`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.

**`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 => keccak(x))

const tree = new MerkleTree(leaves, sha256)
```

**Parameters:**

Name | Type | Default | Description |
------ | ------ | ------ | ------ |
`leaves` | any[] | - | Array of hashed leaves. Each leaf must be a Buffer. |
`hashFn` | any | SHA256 | Hash function to use for hashing leaves and nodes |
`options` | [Options](#options) | {} | Additional options |

**Returns:** *[MerkleTree](_index_.merkletree.md)*

## Methods

###  bufferToHex

▸ **bufferToHex**(`value`: Buffer): *string*

bufferToHex

**`desc`** Returns a hex string with 0x prefix for given buffer.

**`example`**
```js
const hexStr = tree.bufferToHex(Buffer.from('A'))
```

**Parameters:**

Name | Type |
------ | ------ |
`value` | Buffer |

**Returns:** *string*

___

###  bufferify

▸ **bufferify**(`value`: any): *Buffer*

bufferify

**`desc`** Returns a buffer type for the given value.

**`example`**
```js
const buf = tree.bufferify('0x1234')
```

**Parameters:**

Name | Type |
------ | ------ |
`value` | any |

**Returns:** *Buffer*

___

###  getDepth

▸ **getDepth**(): *number*

getDepth

**`desc`** Returns the tree depth (number of layers)

**`example`**
```js
const depth = tree.getDepth()
```

**Returns:** *number*

___

###  getHexLayers

▸ **getHexLayers**(): *string[]*

getHexLayers

**`desc`** Returns multi-dimensional array of all layers of Merkle Tree, including leaves and root as hex strings.

**`example`**
```js
const layers = tree.getHexLayers()
```

**Returns:** *string[]*

___

###  getHexLayersFlat

▸ **getHexLayersFlat**(): *string[]*

getHexLayersFlat

**`desc`** Returns single flat array of all layers of Merkle Tree, including leaves and root as hex string.

**`example`**
```js
const layers = tree.getHexLayersFlat()
```

**Returns:** *string[]*

___

###  getHexLeaves

▸ **getHexLeaves**(): *string[]*

getHexLeaves

**`desc`** Returns array of leaves of Merkle Tree as hex strings.

**`example`**
```js
const leaves = tree.getHexLeaves()
```

**Returns:** *string[]*

___

###  getHexMultiProof

▸ **getHexMultiProof**(`tree`: Buffer[], `indices`: number[]): *string[]*

getHexMultiProof

**`desc`** Returns the multiproof for given tree indices as hex strings.

**`example`**
```js
const indices = [2, 5, 6]
const proof = tree.getHexMultiProof(indices)
```

**Parameters:**

Name | Type | Description |
------ | ------ | ------ |
`tree` | Buffer[] | - |
`indices` | number[] | Tree indices. |

**Returns:** *string[]*

- Multiproofs as hex strings.

___

###  getHexProof

▸ **getHexProof**(`leaf`: Buffer, `index?`: number): *string[]*

getHexProof

**`desc`** Returns the proof for a target leaf as hex strings.

**`example`**
```js
const proof = tree.getHexProof(leaves[2])
```

**Parameters:**

Name | Type | Description |
------ | ------ | ------ |
`leaf` | Buffer | Target leaf |
`index?` | number | - |

**Returns:** *string[]*

- Proof array as hex strings.

___

###  getPositionalHexProof

▸ **getPositionalHexProof**(`leaf`: Buffer, `index?`: number): *(string | number)[][]*

getPositionalHexProof

**`desc`** Returns the proof for a target leaf as hex strings and corresponding position as binary.

**`example`**
```js
const proof = tree.getPositionalHexProof(leaves[2])
```

**Parameters:**

Name | Type | Description |
------ | ------ | ------ |
`leaf` | Buffer | Target leaf |
`index?` | number | - |

**Returns:** *(string | number)[][]*

- Proof array as hex strings with position.

___

###  getHexRoot

▸ **getHexRoot**(): *string*

getHexRoot

**`desc`** Returns the Merkle root hash as a hex string.

**`example`**
```js
const root = tree.getHexRoot()
```

**Returns:** *string*

___

###  getLayers

▸ **getLayers**(): *Buffer[]*

getLayers

**`desc`** Returns multi-dimensional array of all layers of Merkle Tree, including leaves and root.

**`example`**
```js
const layers = tree.getLayers()
```

**Returns:** *Buffer[]*

___

###  getLayersAsObject

▸ **getLayersAsObject**(): *any*

getLayersAsObject

**`desc`** Returns the layers as nested objects instead of an array.

**`example`**
```js
const layersObj = tree.getLayersAsObject()
```

**Returns:** *any*

___

###  getLayersFlat

▸ **getLayersFlat**(): *Buffer[]*

getLayersFlat

**`desc`** Returns single flat array of all layers of Merkle Tree, including leaves and root.

**`example`**
```js
const layers = tree.getLayersFlat()
```

**Returns:** *Buffer[]*

___

###  getLeaves

▸ **getLeaves**(`values?`: any[]): *Buffer[]*

getLeaves

**`desc`** Returns array of leaves of Merkle Tree.

**`example`**
```js
const leaves = tree.getLeaves()
```

**Parameters:**

Name | Type |
------ | ------ |
`values?` | any[] |

**Returns:** *Buffer[]*

___

###  getMultiProof

▸ **getMultiProof**(`tree?`: any[], `indices?`: any[]): *Buffer[]*

getMultiProof

**`desc`** Returns the multiproof for given tree indices.

**`example`**
```js
const indices = [2, 5, 6]
const proof = tree.getMultiProof(indices)
```

**Parameters:**

Name | Type | Description |
------ | ------ | ------ |
`tree?` | any[] | - |
`indices?` | any[] | Tree indices. |

**Returns:** *Buffer[]*

- Multiproofs

___

###  getProof

▸ **getProof**(`leaf`: Buffer, `index?`: number): *any[]*

getProof

**`desc`** Returns the proof for a target leaf.

**`example`**
```js
const proof = tree.getProof(leaves[2])
```

**`example`**
```js
const leaves = ['a', 'b', 'a'].map(x => keccak(x))
const tree = new MerkleTree(leaves, keccak)
const proof = tree.getProof(leaves[2], 2)
```

**Parameters:**

Name | Type | Description |
------ | ------ | ------ |
`leaf` | Buffer | Target leaf |
`index?` | number | - |

**Returns:** *any[]*

- Array of objects containing a position property of type string
with values of 'left' or 'right' and a data property of type Buffer.

___

###  getProofFlags

▸ **getProofFlags**(`leaves`: Buffer[], `proofs`: Buffer[]): *boolean[]*

getProofFlags

**`desc`** Returns list of booleans where proofs should be used instead of hashing.
Proof flags are used in the Solidity multiproof verifiers.

**`example`**
```js
const indices = [2, 5, 6]
const proof = tree.getMultiProof(indices)
const proofFlags = tree.getProofFlags(leaves, proof)
```

**Parameters:**

Name | Type |
------ | ------ |
`leaves` | Buffer[] |
`proofs` | Buffer[] |

**Returns:** *boolean[]*

- Boolean flags

___

###  getProofIndices

▸ **getProofIndices**(`treeIndices`: number[], `depth`: number): *number[]*

getProofIndices

**`desc`** Returns the proof indices for given tree indices.

**`example`**
```js
const proofIndices = tree.getProofIndices([2,5,6], 4)
console.log(proofIndices) // [ 23, 20, 19, 8, 3 ]
```

**Parameters:**

Name | Type | Description |
------ | ------ | ------ |
`treeIndices` | number[] | Tree indices |
`depth` | number | Tree depth; number of layers. |

**Returns:** *number[]*

- Proof indices

___

###  getRoot

▸ **getRoot**(): *Buffer*

getRoot

**`desc`** Returns the Merkle root hash as a Buffer.

**`example`**
```js
const root = tree.getRoot()
```

**Returns:** *Buffer*

___

###  print

▸ **print**(): *void*

print

**`desc`** Prints out a visual representation of the merkle tree.

**`example`**
```js
tree.print()
```

**Returns:** *void*

___

###  toJSON

▸ **toJSON**(): *void*

**Returns:** *void*

___

###  toString

▸ **toString**(): *string*

toString

**`desc`** Returns a visual representation of the merkle tree as a string.

**`example`**
```js
console.log(tree.toString())
```

**Returns:** *string*

___

###  verify

▸ **verify**(`proof`: any[], `targetNode`: Buffer, `root`: Buffer): *boolean*

verify

**`desc`** Returns true if the proof path (array of hashes) can connect the target node
to the Merkle root.

**`example`**
```js
const root = tree.getRoot()
const proof = tree.getProof(leaves[2])
const verified = tree.verify(proof, leaves[2], root)
```

**Parameters:**

Name | Type | Description |
------ | ------ | ------ |
`proof` | any[] | Array of proof objects that should connect target node to Merkle root. |
`targetNode` | Buffer | Target node Buffer |
`root` | Buffer | Merkle root Buffer |

**Returns:** *boolean*

___

###  verifyMultiProof

▸ **verifyMultiProof**(`root`: Buffer, `indices`: number[], `leaves`: Buffer[], `depth`: number, `proof`: Buffer[]): *boolean*

verifyMultiProof

**`desc`** Returns true if the multiproofs can connect the leaves to the Merkle root.

**`example`**
```js
const root = tree.getRoot()
const treeFlat = tree.getLayersFlat()
const depth = tree.getDepth()
const indices = [2, 5, 6]
const proofLeaves = indices.map(i => leaves[i])
const proof = tree.getMultiProof(treeFlat, indices)
const verified = tree.verifyMultiProof(root, indices, proofLeaves, depth, proof)
```

**Parameters:**

Name | Type | Description |
------ | ------ | ------ |
`root` | Buffer | Merkle tree root |
`indices` | number[] | Leave indices |
`leaves` | Buffer[] | Leaf values at indices. |
`depth` | number | Tree depth |
`proof` | Buffer[] | Multiproofs given indices |

**Returns:** *boolean*

___

### `Static` bufferToHex

▸ **bufferToHex**(`value`: Buffer): *string*

bufferToHex

**`desc`** Returns a hex string with 0x prefix for given buffer.

**`example`**
```js
const hexStr = MerkleTree.bufferToHex(Buffer.from('A'))
```

**Parameters:**

Name | Type |
------ | ------ |
`value` | Buffer |

**Returns:** *string*

___

### `Static` bufferify

▸ **bufferify**(`value`: any): *Buffer*

bufferify

**`desc`** Returns a buffer type for the given value.

**`example`**
```js
const buf = MerkleTree.bufferify('0x1234')
```

**Parameters:**

Name | Type |
------ | ------ |
`value` | any |

**Returns:** *Buffer*

___

### `Static` getMultiProof

▸ **getMultiProof**(`tree`: Buffer[], `indices`: number[]): *Buffer[]*

getMultiProof

**`desc`** Returns the multiproof for given tree indices.

**`example`**
```js
const flatTree = tree.getLayersFlat()
const indices = [2, 5, 6]
const proof = MerkleTree.getMultiProof(flatTree, indices)
```

**Parameters:**

Name | Type | Description |
------ | ------ | ------ |
`tree` | Buffer[] | Tree as a flat array. |
`indices` | number[] | Tree indices. |

**Returns:** *Buffer[]*

- Multiproofs

___

### `Static` isHexString

▸ **isHexString**(`v`: string): *boolean*

isHexString

**`desc`** Returns true if value is a hex string.

**`example`**
```js
console.log(MerkleTree.isHexString('0x1234'))
```

**Parameters:**

Name | Type |
------ | ------ |
`v` | string |

**Returns:** *boolean*

___

### `Static` marshalLeaves

▸ **marshalLeaves**(`leaves`: any[]): *string*

marshalLeaves

**`desc`** Returns array of leaves of Merkle Tree as a JSON string.

**`example`**
```js
const jsonStr = MerkleTree.marshalLeaves(leaves)
```

**Parameters:**

Name | Type |
------ | ------ |
`leaves` | any[] |

**Returns:** *string*

- List of leaves as JSON string

___

### `Static` marshalProof

▸ **marshalProof**(`proof`: any[]): *string*

marshalProof

**`desc`** Returns proof array as JSON string.

**`example`**
```js
const jsonStr = MerkleTree.marshalProof(proof)
```

**Parameters:**

Name | Type | Description |
------ | ------ | ------ |
`proof` | any[] | Merkle tree proof array |

**Returns:** *string*

- Proof array as JSON string.

___

### `Static` print

▸ **print**(`tree`: any): *void*

print

**`desc`** Prints out a visual representation of the given merkle tree.

**`example`**
```js
MerkleTree.print(tree)
```

**Parameters:**

Name | Type | Description |
------ | ------ | ------ |
`tree` | any | Merkle tree instance. |

**Returns:** *void*

___

### `Static` unmarshalLeaves

▸ **unmarshalLeaves**(`jsonStr`: string | object): *Buffer[]*

unmarshalLeaves

**`desc`** Returns array of leaves of Merkle Tree as a Buffers.

**`example`**
```js
const leaves = MerkleTree.unmarshalLeaves(jsonStr)
```

**Parameters:**

Name | Type |
------ | ------ |
`jsonStr` | string &#124; object |

**Returns:** *Buffer[]*

- Unmarshalled list of leaves

___

### `Static` unmarshalProof

▸ **unmarshalProof**(`jsonStr`: string | object): *any[]*

unmarshalProof

**`desc`** Returns the proof for a target leaf as a list of Buffers.

**`example`**
```js
const proof = MerkleTree.unmarshalProof(jsonStr)
```

**Parameters:**

Name | Type |
------ | ------ |
`jsonStr` | string &#124; object |

**Returns:** *any[]*

- Marshalled proof

# Interface: Options

## Hierarchy

* **Options**

## Index

### Properties

* [duplicateOdd](_index_.options.md#optional-duplicateodd)
* [hashLeaves](_index_.options.md#optional-hashleaves)
* [isBitcoinTree](_index_.options.md#optional-isbitcointree)
* [sort](_index_.options.md#optional-sort)
* [sortLeaves](_index_.options.md#optional-sortleaves)
* [sortPairs](_index_.options.md#optional-sortpairs)

## Properties

### `Optional` duplicateOdd

• **duplicateOdd**? : *boolean*

If set to `true`, an odd node will be duplicated and combined to make a pair to generate the layer hash.

___

### `Optional` hashLeaves

• **hashLeaves**? : *boolean*

If set to `true`, the leaves will hashed using the set hashing functions.

___

### `Optional` isBitcoinTree

• **isBitcoinTree**? : *boolean*

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.

___

### `Optional` sort

• **sort**? : *boolean*

If set to `true`, the leaves and hashing pairs will be sorted.

___

### `Optional` sortLeaves

• **sortLeaves**? : *boolean*

If set to `true`, the leaves will be sorted.

___

### `Optional` sortPairs

• **sortPairs**? : *boolean*

If set to `true`, the hashing pairs will be sorted.

<!-- END DOCUMENTATION -->

## Test

```bash
npm test
```

## FAQ

- Q: How do you verify merkle proofs in Solidity?
  - A: Check out the example repo [merkletreejs-solidity](https://github.com/miguelmota/merkletreejs-solidity) on how to generate merkle proofs with this library and verify them in Solidity.

- Q: How do you verify merkle [multiproofs](https://github.com/ethereum/eth2.0-specs/blob/dev/ssz/merkle-proofs.md#merkle-multiproofs) in Solidity?
  - A: Check out the example repo [merkletreejs-multiproof-solidity](https://github.com/miguelmota/merkletreejs-multiproof-solidity) on how to generate merkle multiproofs with this library and verify them in Solidity.

## 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 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)

- [Compact Merkle Multiproofs](https://arxiv.org/pdf/2002.07648.pdf)

- [Eth 2.0 specs - Merkle Multiproofs](https://github.com/ethereum/eth2.0-specs/blob/dev/ssz/merkle-proofs.md#merkle-multiproofs)

## Contributing

Pull requests are welcome!

For contributions please create a new branch and submit a pull request for review.

_Many thanks to all the [contributors](https://github.com/miguelmota/merkletreejs/graphs/contributors) that made this library better._

## License

[MIT](LICENSE)