Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/btc-vision/rust-merkle-tree
OP_NET Rust merkle tree implementation
https://github.com/btc-vision/rust-merkle-tree
Last synced: 28 days ago
JSON representation
OP_NET Rust merkle tree implementation
- Host: GitHub
- URL: https://github.com/btc-vision/rust-merkle-tree
- Owner: btc-vision
- License: mit
- Created: 2024-09-30T22:28:38.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-07T09:00:23.000Z (2 months ago)
- Last Synced: 2024-12-04T01:37:08.467Z (about 1 month ago)
- Language: TypeScript
- Size: 1.19 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Merkle Tree Library
**Package**: `@btc-vision/rust-merkle-tree`
## Overview
This project aims to develop a high-performance, secure Merkle tree library in Rust, with seamless integration for both
Rust and Node.js applications. The library leverages SHA-256 as its cryptographic hash function and is designed to be
secure against known vulnerabilities, ensuring robust state proof validations. Optimized for both performance and
security, this library is intended for use in applications that require strong data integrity and validation mechanisms.
## Key Features
- **SHA-256 Hashing**: Utilizes the SHA-256 hashing algorithm to ensure cryptographic security.
- **Cross-Platform**: Designed for both Rust and Node.js environments, providing bindings for easy integration.
- **Secure Against Exploits**: Implements protections against known vulnerabilities like hash collisions and tree
manipulation.
- **Optimized Performance**: Significantly improved speed and efficiency compared to existing Merkle tree
implementations like `merkle-tree-sha256`.
- **Comprehensive Testing**: Includes a suite of tests to ensure the library performs securely and accurately.
## Table of Contents
- [Project Overview](#overview)
- [Key Features](#key-features)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Rust Usage](#rust-usage)
- [Node.js Usage](#nodejs-usage)
- [Installation](#installation)
- [References](#references)
- [Contributing](#contributing)
## Getting Started
### Prerequisites
- **Rust**: Ensure you have Rust installed. The recommended version is stable 1.56+.
- **Node.js**: Version 16 or higher is required.
- **napi-rs**: Used to interface the Rust code with Node.js.
### Installation
1. **Clone the repository**:
```bash
git clone git://github.com/btc-vision/rust-merkle-tree.git
cd rust-merkle-tree
```
2. **Install dependencies**:
```bash
npm install
```
3. **Build the project**:
For production build:
```bash
npm run build
```
For debug build:
```bash
npm run build:debug
```
4. **Run tests**:
```bash
npm test
```
## Usage
### Node.js Usage
For Node.js integration, the library provides bindings via N-API.
1. Install the package:
```bash
npm install @btc-vision/rust-merkle-tree
```
2. Example of creating a Merkle tree:
```typescript
import { MerkleTree } from '@btc-vision/rust-merkle-tree';
const leaves: Uint8Array[] = [
Uint8Array.from([100, 97, 116, 97, 49]),
Uint8Array.from([100, 97, 116, 97, 50]),
Uint8Array.from([100, 97, 116, 97, 51]),
];
const tree = new MerkleTree(leaves);
console.log('Merkle Root:', tree.root());
```
## References
- **Current Rust Merkle Tree Implementation**: [rs-merkle](https://github.com/antouhou/rs-merkle)
- **SHA-256 Merkle Tree for Node.js**: [merkle-tree-sha256](https://github.com/btc-vision/merkle-tree-sha256)
- **N-API for Rust Integration**: [napi.rs](https://napi.rs/)
Check the `example/` folder for usage examples and to compare performance with the current `merkle-tree-sha256` package.
## Contributing
Contributions are welcome! Please adhere to the code of conduct and sign all commits. Open an issue or submit a pull
request if you encounter any problems or have suggestions for improving the library.
## License
This project is licensed under the MIT License. For more details, please see the [LICENSE](LICENSE) file.