https://github.com/eyalron33/mpz
https://github.com/eyalron33/mpz
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/eyalron33/mpz
- Owner: eyalron33
- License: mit
- Created: 2024-10-17T07:50:08.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-10-17T11:04:11.000Z (6 months ago)
- Last Synced: 2025-03-05T13:06:23.400Z (about 2 months ago)
- Language: Rust
- Size: 15.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-noir - merkle tree generator - A tool to help generate Noir-optimized merkle trees (Get Coding / Dev Tools)
README
# Merkle Tree CLI Tool
This CLI tool generates Merkle trees using the Pedersen hash based on the Aztec implementation. The hashing process is executed through a Noir program, utilizing the `nargo` tool to calculate the hash and retrieve the output.
Read the [Release post](https://neimanslab.org/2024-10-17/merkle_pedersen_aztec.html).
## Features
- Generates Merkle trees from user interactive input (decimal or hex input)
- Outputs the Merkle tree root and proof paths to the console or as a JSON file.
## Dependencies
This tool has been tested with the following versions:
- `nargo` and 'noirc': 0.35.0
Ensure that these are installed so the CLI tool can be used.
## Usage
### Command-Line Options
- `--json` or `-j`: Outputs the Merkle tree data as a JSON file instead of printing it to the console.
- `--output `: Specifies the output filename for the JSON data. If not provided, it defaults to `merkle.json`.
### Example Commands
To run the program, use the following command in your terminal:
```bash
cargo run -- --json --output my_output.json
```
This command will query the user for values of the leaf of the tree, generate a Merkle tree, and save the output as a JSON file named my_output.json.
## How the Merkle Tree is Built
The program constructs a Merkle tree by iterating through the input in pairs. It calculates the hash for each pair using the Pedersen hash and adds the resulting hash to the next level of the tree. If there is an odd number of elements, the last unpaired element is propagated up to the next level unchanged.
## Implementation Details
The hashing process utilizes the Noir programming language, as implementing the Pedersen hash directly in Rust posed significant challenges. The Aztec implementation of the Pedersen hash lacked detailed specifications, particularly regarding the choice of generators used in their hash function. As reverse engineering Aztec implementation is a bit time-consuming, wrapping the Noir implementation was chosen as a more practical solution.
## Example Noir Program
An example Noir program to verify the Merkle tree is given in `noir_pedersen` folder.
## License
This project is licensed under the MIT License - see the LICENSE file for details.