From 13c629711e1824818f4a1a7d51534d0020dd3d70 Mon Sep 17 00:00:00 2001 From: Miguel Mota Date: Sat, 22 Jul 2017 00:38:06 -0700 Subject: [PATCH] update readme --- README.md | 22 +++++++++++++--------- index.js | 10 +++++----- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7d3260e..dff8347 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ npm install m-tree **Kind**: global class * [MerkleTree](#MerkleTree) - * [new MerkleTree(leaves, hashAlgo, options)](#new_MerkleTree_new) + * [new MerkleTree(leaves, hashAlgorithm, options)](#new_MerkleTree_new) * [.getLeaves()](#MerkleTree+getLeaves) ⇒ Array * [.getLayers()](#MerkleTree+getLayers) ⇒ Array * [.getRoot()](#MerkleTree+getRoot) ⇒ Buffer @@ -42,7 +42,7 @@ npm install m-tree -### new MerkleTree(leaves, hashAlgo, options) +### 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. @@ -51,9 +51,9 @@ Lonely leaf nodes are promoted to the next level up without being hashed again. | Param | Type | Description | | --- | --- | --- | | leaves | Array | Array of hashed leaves. Each leaf must be a Buffer. | -| hashAlgo | function | Algorithm used for hashing leaves and nodes | +| hashAlgorithm | function | Algorithm used for hashing leaves and nodes | | options | Object | Additional options | -| options.isBitcoinTree | Boolean | If set to `true`, generates the Merkle Tree with the Bitcoin Merkle Tree implementation. Enable it when you need to replicate Bitcoin constructed Merkle Trees. | +| options.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. | **Example** ```js @@ -157,7 +157,7 @@ const tree = new MerkleTree(leaves, sha256) ``` * [MerkleTree](#MerkleTree) : object - * [new MerkleTree(leaves, hashAlgo, options)](#new_MerkleTree_new) + * [new MerkleTree(leaves, hashAlgorithm, options)](#new_MerkleTree_new) * [.getLeaves()](#MerkleTree+getLeaves) ⇒ Array * [.getLayers()](#MerkleTree+getLayers) ⇒ Array * [.getRoot()](#MerkleTree+getRoot) ⇒ Buffer @@ -166,7 +166,7 @@ const tree = new MerkleTree(leaves, sha256) -### new MerkleTree(leaves, hashAlgo, options) +### 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. @@ -175,9 +175,9 @@ Lonely leaf nodes are promoted to the next level up without being hashed again. | Param | Type | Description | | --- | --- | --- | | leaves | Array | Array of hashed leaves. Each leaf must be a Buffer. | -| hashAlgo | function | Algorithm used for hashing leaves and nodes | +| hashAlgorithm | function | Algorithm used for hashing leaves and nodes | | options | Object | Additional options | -| options.isBitcoinTree | Boolean | If set to `true`, generates the Merkle Tree with the Bitcoin Merkle Tree implementation. Enable it when you need to replicate Bitcoin constructed Merkle Trees. | +| options.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. | **Example** ```js @@ -281,16 +281,20 @@ This implementation is vulnerable to a forgery attack (for an unbalanced merkle # Test -``bash +```bash npm test ``` # Credits/Resources - [Bitcoin mining the hard way: the algorithms, protocols, and bytes](http://www.righto.com/2014/02/bitcoin-mining-hard-way-algorithms.html) + - [Raiden Merkle Tree Implemenation](https://github.com/raiden-network/raiden/blob/f9cf12571891cdf54feb4667cd2fffcb3d5daa89/raiden/mtree.py) + - [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) + - [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) # License diff --git a/index.js b/index.js index c83fcd7..65cf942 100644 --- a/index.js +++ b/index.js @@ -12,10 +12,10 @@ class MerkleTree { * All nodes and leaves are stored as Buffers. * Lonely leaf nodes are promoted to the next level up without being hashed again. * @param {Array} leaves - Array of hashed leaves. Each leaf must be a Buffer. - * @param {Function} hashAlgo - Algorithm used for hashing leaves and nodes + * @param {Function} hashAlgorithm - Algorithm used for hashing leaves and nodes * @param {Object} options - Additional options - * @param {Boolean} options.isBitcoinTree - If set to `true`, generates the Merkle - * Tree with the Bitcoin Merkle Tree implementation. Enable it when you need + * @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. * @example * const MerkleTree = require('m-tree') @@ -30,8 +30,8 @@ class MerkleTree { * * const tree = new MerkleTree(leaves, sha256) */ - constructor(leaves, hashAlgo, options={}) { - this.hashAlgo = hashAlgo + constructor(leaves, hashAlgorithm, options={}) { + this.hashAlgo = hashAlgorithm this.leaves = leaves this.layers = [leaves] this.isBitcoinTree = !!options.isBitcoinTree