@crpdo/merkle

don't trust, verify

@crpdo/merkle is a dynamic, in-memory implementation of a Merkle Tree in JS. It's part of the larger crpdo project, a JavaScript-based library for cryptography. This module emphasizes the practical, real-world application of Merkle Trees, providing features like checkpointing and the generation of Merkle proofs.

Features

• Dynamic Tree Management: Streamlined processes for creating Merkle Trees and adding leaves, facilitating quick and responsive tree modifications.
• Merkle Proof Generation and Verification: Generate Merkle proofs and verify them, ensuring data integrity and promoting secure data interactions.
• Checkpointing: Preserve the state at various points in time, enabling users to revert to previous tree states as needed.
• Immutable Design: Ensuring that once data is recorded, it cannot be altered without detection, contributing to the overall security and reliability of data operations.

Installation

npm install @crpdo/merkle

Usage

Import the Merkle class and create a new merkle tree:

const Merkle = require('@crpdo/merkle')

const tree = new Merkle()

Here is a brief example of how to use the @crpdo/merkle module:

const Merkle = require('@crpdo/merkle')

// Initialize a new Merkle Tree
const tree = new Merkle()

// Add leaves to the tree
tree.addLeaves(['data1', 'data2', 'data3'])

// Generate a Merkle proof
const proof = tree.getProof('data1')

// Verify the proof
const isValid = tree.verifyProof(proof, 'data1')

Documentation

• API Reference

Related Modules

• @crpdo/key: Key handling utilities
• @crpdo/crypto: Cryptography utility functions
• @crpdo/nacl: Wrapper for TweetNaCl.js

Please see the main crpdo project for a full list of related modules.

Tests

In order to run the test suite, simply clone the repository and install its dependencies:

git clone https://gitlab.com/frenware/core/crpdo/merkle.git
cd basd
npm install

To run the tests:

npm test

Contributing

Thank you! Please see our contributing guidelines for details.

Donations

If you find this project useful and want to help support further development, please send us some coin. We greatly appreciate any and all contributions. Thank you!

Bitcoin (BTC):

1JUb1yNFH6wjGekRUW6Dfgyg4J4h6wKKdF

Monero (XMR):

46uV2fMZT3EWkBrGUgszJCcbqFqEvqrB4bZBJwsbx7yA8e2WBakXzJSUK8aqT4GoqERzbg4oKT2SiPeCgjzVH6VpSQ5y7KQ

License

@crpdo/merkle is MIT licensed.