miden-cli

Crates.iomiden-cli
lib.rsmiden-cli
version0.4.0
sourcesrc
created_at2024-07-06 00:10:28.635655
updated_at2024-07-06 00:10:28.635655
descriptionCLI binary application that facilitates interaction with the Miden rollup
homepage
repositoryhttps://github.com/0xPolygonMiden/miden-client
max_upload_size
id1293631
size172,449
Bobbin Threadbare (bobbinth)

documentation

https://docs.rs/miden-cli/0.4.0

README

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

Commit count: 238

cargo fmt