#miden #cli #client

bin+lib miden-cli

CLI binary application that facilitates interaction with the Miden rollup

2 unstable releases

new 0.5.0 Aug 27, 2024
0.4.0 Jul 6, 2024

#153 in Magic Beans

Download history 142/week @ 2024-07-05 5/week @ 2024-07-12 31/week @ 2024-07-26 2/week @ 2024-08-02 138/week @ 2024-08-23

142 downloads per month

MIT license

770KB
16K SLoC

Miden Client CLI

This binary allows the user to interact with the Miden rollup via a simple command-line interface (CLI). It's a wrapper around the Miden client library exposing its functionality in order to create accounts, create and consume notes, all executed and proved using the Miden VM.

Usage

Before you can use the Miden client, you'll need to make sure you have both Rust and sqlite3 installed. Miden client requires rust version 1.80 or higher.

Running miden-client's CLI

You can either build from source with:

cargo build --release --features "testing, concurrent"

The testing and concurrent features are enabled to speed up account creation (for testing purposes) and optimize transaction execution and proving times respectively.

Once the binary is built, you can find it on ./target/release/miden.

Or you can install the CLI from crates.io with:

cargo install --features "testing, concurrent" miden-cli

These actions can also be executed when inside the repository via the Makefile with make build or make install.

License

This project is MIT licensed.

Dependencies

~49–81MB
~1.5M SLoC