Skip to content

Latest commit

 

History

History
32 lines (21 loc) · 2.05 KB

README.md

File metadata and controls

32 lines (21 loc) · 2.05 KB
Raw

Rust Client Library

Rust library, which can be used by other project to programmatically interact with the Miden rollup.

Adding miden-client as a dependency

In order to utilize the miden-client library, you can add the dependency to your project's Cargo.toml file:

miden-client = { version = "0.5" }

Crate Features

  • async: enables async traits. Automatically enabled for web-tonic feature. Disabled by default.
  • concurrent: used to enable concurrency during execution and proof generation. Disabled by default.
  • idxdb: includes WebStore, an IdexedDB implementation of the Store trait. Disabled by default.
  • sqlite: includes SqliteStore, a SQLite implementation of the Store trait. Disabled by default.
  • tonic: includes TonicRpcClient, a Tonic client to communicate with Miden node. Disabled by default.
  • web-tonic: includes WebTonicRpcClient, an Tonic client to communicate with the Miden node in the browser. Disabled by default.
  • testing: useful feature that lowers PoW difficulty when enabled, meant to be used during development and not on production. Disabled by default.

To compile with no_std, disable default features via --no-default-features flag.

Store and RpcClient implementations

The library user can provide their own implementations of Store and RpcClient traits, which can be used as components of Client, though it is not necessary. The Store trait is used to persist the state of the client, while the RpcClient trait is used to communicate via gRPC with the Miden node.

The sqlite and tonic features provide implementations for these traits using Rusqlite and Tonic respectively. The idxdb and web-tonic features provide implementations based on IndexedDB and tonic-web which can be used in the browser.

License

This project is MIT licensed.