npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@btc-vision/rust-merkle-tree

v0.0.3

Published

Merkle Tree implementation in Rust using sha256

Downloads

17

Readme

Merkle Tree Library

Rust NodeJS NPM

SHA-256

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

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:

    git clone git://github.com/btc-vision/rust-merkle-tree.git
    cd rust-merkle-tree
  2. Install dependencies:

    npm install
  3. Build the project:

    For production build:

    npm run build

    For debug build:

    npm run build:debug
  4. Run tests:

    npm test

Usage

Node.js Usage

For Node.js integration, the library provides bindings via N-API.

  1. Install the package:

    npm install @btc-vision/rust-merkle-tree
  2. Example of creating a Merkle tree:

    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

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 file.