@web4/crypto
v1.0.0
Published
The crypto primitives used in Unichain, extracted into a separate module
Downloads
12
Readme
@web4/crypto
The LEGACY crypto primitives used in Unichain extracted into a separate module
npm install @web4/crypto
Usage
const crypto = require('@web4/crypto')
const keyPair = crypto.keyPair()
console.log(keyPair) // prints a ed25519 keypair
API
keyPair = crypto.keyPair()
Returns an ED25519
keypair that can used for tree signing.
signature = crypto.sign(message, secretKey)
Signs a message (buffer).
verified = crypto.verify(message, signature, publicKey)
Verifies a signature for a message.
hash = crypto.data(data)
Hashes a leaf node in a merkle tree.
hash = crypto.parent(left, right)
Hash a parent node in a merkle tree. left
and right
should look like this:
{
index: treeIndex,
hash: hashOfThisNode,
size: byteSizeOfThisTree
}
hash = crypto.tree(peaks)
Hashes the merkle root of the tree. peaks
should be an array of the peaks of the tree and should look like above.
dataToSign = crypto.signable(peaksOrHash, length)
Encodes a buffer to sign. length
should be how many leaf nodes exist in the tree.
buffer = crypto.randomBytes(size)
Returns a buffer containing random bytes of size size
.
hash = crypto.discoveryKey(publicKey)
Return a hash derived from a publicKey
that can used for discovery
without disclosing the public key.
License
MIT