diff --git a/README.md b/README.md index 37d641b..3785afd 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ npm install merkletreejs * [.getLeaves()](#MerkleTree+getLeaves) ⇒ Array.<Buffer> * [.getLayers()](#MerkleTree+getLayers) ⇒ Array.<Buffer> * [.getRoot()](#MerkleTree+getRoot) ⇒ Buffer - * [.getProof(leaf, [index])](#MerkleTree+getProof) ⇒ Array.<Buffer> + * [.getProof(leaf, [index])](#MerkleTree+getProof) ⇒ Array.<Object> * [.verify(proof, targetNode, root)](#MerkleTree+verify) ⇒ Boolean @@ -134,11 +134,11 @@ const root = tree.getRoot() -### merkleTree.getProof(leaf, [index]) ⇒ Array.<Buffer> +### merkleTree.getProof(leaf, [index]) ⇒ Array.<Object> Returns the proof for a target leaf. **Kind**: instance method of [MerkleTree](#MerkleTree) -**Returns**: Array.<Buffer> - - Array of Buffer hashes. +**Returns**: Array.<Object> - - Array of objects containing a position property of type string with values of 'left' or 'right' and a data property of type Buffer. | Param | Type | Description | | --- | --- | --- | @@ -168,7 +168,7 @@ to the Merkle root. | Param | Type | Description | | --- | --- | --- | -| proof | Array.<Buffer> | Array of proof Buffer hashes that should connect target node to Merkle root. | +| proof | Array.<Object> | Array of proof objects that should connect target node to Merkle root. | | targetNode | Buffer | Target node Buffer | | root | Buffer | Merkle root Buffer | @@ -193,7 +193,7 @@ Class reprensenting a Merkle Tree * [.getLeaves()](#MerkleTree+getLeaves) ⇒ Array.<Buffer> * [.getLayers()](#MerkleTree+getLayers) ⇒ Array.<Buffer> * [.getRoot()](#MerkleTree+getRoot) ⇒ Buffer - * [.getProof(leaf, [index])](#MerkleTree+getProof) ⇒ Array.<Buffer> + * [.getProof(leaf, [index])](#MerkleTree+getProof) ⇒ Array.<Object> * [.verify(proof, targetNode, root)](#MerkleTree+verify) ⇒ Boolean @@ -272,11 +272,11 @@ const root = tree.getRoot() -### merkleTree.getProof(leaf, [index]) ⇒ Array.<Buffer> +### merkleTree.getProof(leaf, [index]) ⇒ Array.<Object> Returns the proof for a target leaf. **Kind**: instance method of [MerkleTree](#MerkleTree) -**Returns**: Array.<Buffer> - - Array of Buffer hashes. +**Returns**: Array.<Buffer> - - Array of objects containing a position property of type string with values of 'left' or 'right' and a data property of type Buffer. | Param | Type | Description | | --- | --- | --- | diff --git a/index.js b/index.js index 80c82b4..e400979 100644 --- a/index.js +++ b/index.js @@ -127,7 +127,8 @@ class MerkleTree { * @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. + * @return {Object[]} - Array of objects containing a position property of type string + * with values of 'left' or 'right' and a data property of type Buffer. * @example * const proof = tree.getProof(leaves[2]) * @@ -206,7 +207,7 @@ class MerkleTree { * 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 + * @param {Object[]} proof - Array of proof objects that should connect * target node to Merkle root. * @param {Buffer} targetNode - Target node Buffer * @param {Buffer} root - Merkle root Buffer