rename proof() -> path()

This commit is contained in:
poma 2020-07-31 17:19:20 +03:00
parent 1f86cc10c1
commit 9c5a9cd65f
No known key found for this signature in database
GPG Key ID: BA20CB01FE165657
4 changed files with 13 additions and 13 deletions

View File

@ -9,8 +9,8 @@ const MerkleTree = require('MerkleTree')
const tree = new MerkleTree(10, [1, 2, 3, 4, 5]) const tree = new MerkleTree(10, [1, 2, 3, 4, 5])
tree.insert(6) tree.insert(6)
tree.update(3, 42) tree.update(3, 42)
const proof = tree.proof(tree.indexOf(2)) const path = tree.path(tree.indexOf(2))
console.log(proof) console.log(path)
// output: // output:
{ {

View File

@ -1,6 +1,6 @@
{ {
"name": "fixed-merkle-tree", "name": "fixed-merkle-tree",
"version": "0.2.1", "version": "0.3.0",
"description": "Fixed depth merkle tree implementation with sequential inserts", "description": "Fixed depth merkle tree implementation with sequential inserts",
"main": "src/merkleTree.js", "main": "src/merkleTree.js",
"scripts": { "scripts": {

View File

@ -105,11 +105,11 @@ class MerkleTree {
} }
/** /**
* Get merkle proof for a leaf * Get merkle path to a leaf
* @param index Leaf index to generate proof for * @param index Leaf index to generate path for
* @returns {{pathElements: Object[], pathIndex: number[]}} An object containing adjacent elements and left-right index * @returns {{pathElements: Object[], pathIndex: number[]}} An object containing adjacent elements and left-right index
*/ */
proof(index) { path(index) {
if (index < 0 || index >= this._layers[0].length) { if (index < 0 || index >= this._layers[0].length) {
throw new Error('Index out of bounds: ' + index) throw new Error('Index out of bounds: ' + index)
} }

View File

@ -85,12 +85,12 @@ describe('MerkleTree', () => {
}) })
}) })
describe('#proof', () => { describe('#path', () => {
it('should work for even index', () => { it('should work for even index', () => {
const tree = new MerkleTree(10, [1, 2, 3, 4, 5]) const tree = new MerkleTree(10, [1, 2, 3, 4, 5])
const proof = tree.proof(2) const path = tree.path(2)
proof.pathIndices.should.be.deep.equal([0, 1, 0, 0, 0, 0, 0, 0, 0, 0]) path.pathIndices.should.be.deep.equal([0, 1, 0, 0, 0, 0, 0, 0, 0, 0])
proof.pathElements.should.be.deep.equal([ path.pathElements.should.be.deep.equal([
4, 4,
'19814528709687996974327303300007262407299502847885145507292406548098437687919', '19814528709687996974327303300007262407299502847885145507292406548098437687919',
'21305827034995891902714687670641862055126514524916463201449278400604999416145', '21305827034995891902714687670641862055126514524916463201449278400604999416145',
@ -106,9 +106,9 @@ describe('MerkleTree', () => {
it('should work for odd index', () => { it('should work for odd index', () => {
const tree = new MerkleTree(10, [1, 2, 3, 4, 5]) const tree = new MerkleTree(10, [1, 2, 3, 4, 5])
const proof = tree.proof(3) const path = tree.path(3)
proof.pathIndices.should.be.deep.equal([1, 1, 0, 0, 0, 0, 0, 0, 0, 0]) path.pathIndices.should.be.deep.equal([1, 1, 0, 0, 0, 0, 0, 0, 0, 0])
proof.pathElements.should.be.deep.equal([ path.pathElements.should.be.deep.equal([
3, 3,
'19814528709687996974327303300007262407299502847885145507292406548098437687919', '19814528709687996974327303300007262407299502847885145507292406548098437687919',
'21305827034995891902714687670641862055126514524916463201449278400604999416145', '21305827034995891902714687670641862055126514524916463201449278400604999416145',