@shyftnetwork/shyft_merkle-lib v1.0.1

Shyft Merkle Tree Library

Basic libary for Shyft-specific merkle tree operations.

Installing

npm install @shyftnetwork/shyft_merkle-lib

Re-generating Docs

npm install && npm run docs

Functions

hashAB(a, b) ⇒ string

Hashes two values together.

Kind: global function

hashHeader() ⇒ string

Hashes a block header: {previousHeader, timestamp, blockNumber, transactionRoot}

Kind: global function

isPowerOfTwo(n) ⇒ boolean

Checks if a number is a power of two (ie. valid leaf array size)

Kind: global function

setupleafs(leafs) ⇒ Array.<Array.<string>>

Creates first two layers of a tree, ie. the leafs and their hashes

Kind: global function

treePad(tree) ⇒ Array.<Array.<string>>

Pads the leaves of a tree with null to ensure its length is a power of two

Kind: global function

buildTree(height) ⇒ Tree

Constructs a merkle tree recursively as a 2d array.

Kind: global function

getProof(tree, leaf) ⇒ Array.<any>

Assembles a proof from a given tree for a given leaf. This produces a proof of the format boolean, leaf, boolean, leaf ...

Kind: global function

verifyProof(proof, leaf, root) ⇒ boolean

Verifies that the leaf and the proof do in fact hash to the root

Kind: global function

stringifyProof(proof) ⇒ string

Stringifies the proof by assmbling a bit array of the path indicators and appending it to the path segments.

Kind: global function

getRoot(tree) ⇒ string

Returns root element of tree.

Kind: global function

isValidLeaf(leaf, tree) ⇒ boolean

Checks if the leaf exists in the tree.

Kind: global function