refactor: library api reorganization

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+* [BREAKING] Library API reorganization (#367).
 * Added `wasm` and `async` feature to make the code compatible with WASM-32 target (#378).
 * Changed `cargo-make` usage for `make` and `Makefile.toml` for a regular `Makefile` (#359).
 * Added integration tests using the CLI (#353).

Cargo.toml

@@ -18,6 +18,7 @@ crate-type = ["lib"]
 [[bin]]
 name = "miden"
 path = "src/main.rs"
+required-features = ["executable"]
 
 [[test]]
 name = "integration"
@@ -26,20 +27,19 @@ required-features = ["integration"]
 
 [features]
 async = ["miden-tx/async"]
-concurrent = ["miden-lib/concurrent", "miden-objects/concurrent", "miden-tx/concurrent"]
-default = ["std", "clap", "comfy-table", "figment", "lazy_static", "miden-node-proto", "rusqlite", "rusqlite_migration", "tokio", "tonic", "toml"]
-integration = ["testing", "concurrent", "uuid", "assert_cmd"]
+concurrent = ["miden-lib/concurrent", "miden-objects/concurrent", "miden-tx/concurrent", "std"]
+default = ["std", "dep:hex", "dep:thiserror", "dep:prost"]
+executable = ["std", "sqlite", "tonic", "dep:clap", "dep:comfy-table", "dep:figment", "dep:tokio", "dep:toml"]
+integration = ["concurrent", "executable", "testing"]
+sqlite = ["dep:rusqlite", "dep:rusqlite_migration", "dep:lazy_static"]
 std = ["miden-objects/std"]
 testing = ["miden-objects/testing", "miden-lib/testing"]
-test_utils = ["miden-objects/testing"]
-wasm = ["std", "async", "getrandom", "hex", "thiserror", "prost"]
+tonic = ["dep:tonic", "dep:miden-node-proto"]
 
 [dependencies]
-assert_cmd = { version = "2.0", optional = true }
 clap = { version = "4.3", features = ["derive"], optional = true }
 comfy-table = { version = "7.1.0", optional = true } 
 figment = { version = "0.10", features = ["toml", "env"], optional = true }
-getrandom = { version = "0.2", features = ["js"], optional = true }
 hex = { version = "0.4", optional = true }
 lazy_static = { version = "1.4.0", optional = true }
 miden-lib = { package = "miden-lib", git = "https://github.com/0xPolygonMiden/miden-base.git", branch = "next", default-features = false }
@@ -52,18 +52,20 @@ rusqlite = { version = "0.30.0", features = ["vtab", "array", "bundled"], option
 rusqlite_migration = { version = "1.0", optional = true }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = { version = "1.0", features = ["raw_value"] }
-thiserror = { version = "1.0", optional = true }
 tokio = { version = "1.29", features = ["rt-multi-thread", "net", "macros"], optional = true }
-toml = { version = "0.8", optional = true }
 tonic = { version = "0.11", optional = true }
+toml = { version = "0.8", optional = true }
+thiserror = { version = "1.0", optional = true }
 tracing = { version = "0.1" }
 tracing-subscriber = { version = "0.3" }
-uuid = { version = "1.6.1", features = ["serde", "v4"], optional = true }
 winter-maybe-async = "0.10.0"
 
+[target.'wasm32-unknown-unknown'.dependencies]
+getrandom = { version = "0.2", features = ["js"] }
+
 [dev-dependencies]
-# needed for tests to run always with the test utils feature
-miden_client = { package = "miden-client", path = ".", features = [
-    "test_utils",
-    "uuid",
-] }
+# To enable testing feature during tests
+miden-lib = { package = "miden-lib", git = "https://github.com/0xPolygonMiden/miden-base.git", branch = "next", default-features = false, features = ["testing"] }
+miden-objects = { package = "miden-objects", git = "https://github.com/0xPolygonMiden/miden-base.git", branch = "next", default-features = false, features = ["serde", "testing"] }
+uuid = { version = "1.6.1", features = ["serde", "v4"] }
+assert_cmd = { version = "2.0" }

Makefile

@@ -7,7 +7,7 @@ help: ## Show description of all commands
 # --- Variables -----------------------------------------------------------------------------------
 
 FEATURES_INTEGRATION_TESTING="integration"
-FEATURES_CLI="testing,concurrent"
+FEATURES_CLI="testing, executable, concurrent"
 NODE_FEATURES_TESTING="testing"
 WARNINGS=RUSTDOCFLAGS="-D warnings"
 NODE_BRANCH="next"
@@ -16,11 +16,11 @@ NODE_BRANCH="next"
 
 .PHONY: clippy
 clippy: ## Runs clippy on all targets with config
-	cargo +nightly clippy --workspace --tests --all-targets --all-features -- -D clippy::all -D warnings
+	cargo +nightly clippy --workspace --tests --all-targets --features executable -- -D clippy::all -D warnings
 
 .PHONY: fix
 fix: ## Runs Fix with configs
-	cargo +nightly fix --allow-staged --allow-dirty --all-targets --all-features
+	cargo +nightly fix --allow-staged --allow-dirty --all-targets --features executable
 
 .PHONY: format
 format: ## Runs format using nightly toolchain
@@ -57,13 +57,13 @@ doc: ## Generates & checks rust documentation
 
 .PHONY: test
 test: ## Run tests
-	cargo nextest run --release --workspace
+	cargo nextest run --release --workspace --features $(FEATURES_CLI)
 
 # --- Integration testing -------------------------------------------------------------------------
 
 .PHONY: integration-test
 integration-test: ## Run integration tests
-	cargo nextest run --no-capture --release --test=integration --features $(FEATURES_INTEGRATION_TESTING)
+	cargo nextest run --no-capture --release --test=integration --features $(FEATURES_INTEGRATION_TESTING) --no-default-features
 
 .PHONY: integration-test-full
 integration-test-full: ## Run the integration test binary with ignored tests included
@@ -98,3 +98,6 @@ install: ## Installs the CLI binary using the current dir
 
 build: ## Builds the CLI binary and client library in release mode
 	cargo build --release --features $(FEATURES_CLI)
+
+build-wasm: ## Builds the CLI binary for wasm32
+	cargo build --target wasm32-unknown-unknown --features async 

README.md

@@ -38,13 +38,19 @@ client requires rust version **1.78** or higher.
 In order to utilize the `miden-client` library, you can add the dependency to your project's `Cargo.toml` file:
 
 ````toml
-miden-client = { version = "0.3" }
+miden-client = { version = "0.3.1" }
 ````
 
+By default, the library is `no_std` compatible. 
+
 #### Features
 
-- `concurrent`: used to enable concurrent proofs generation
-- `testing`: useful feature that lowers PoW difficulty when enabled. Only use this during development and not on production.
+- `concurrent`: used to enable concurrency during execution and proof generation.
+- `testing`: useful feature that lowers PoW difficulty when enabled, meant to be used during development and not on production. 
+- `sqlite`: includes `SqliteStore`, a SQLite implementation of the `Store` trait that can be used as a component of `Client`.
+- `async`: enables async traits. Disabled by default.
+- `tonic`: includes `TonicRpcClient`, a Tonic client to communicate with Miden node, that can be used as a component of `Client`. 
+- `executable`: builds the CLI, based on `SqliteStore` and `TonicRpcClient`.
 
 ### Running `miden-client`'s CLI
 
@@ -74,10 +80,9 @@ make
 
 To test the project's code, we provide both unit tests (which can be run with `cargo test`) and integration tests. For more info on integration tests, refer to the [integration testing document](./tests/README.md)
 
-The crate also comes with 2 feature flags that are used exclusively on tests: 
+The crate also comes with one feature flag that is used exclusively on tests: 
 
-- `test_utils`: used on unit tests to use the mocked RPC API.
-- `integration`: only used to run integration tests and separate them from unit tests
+- `integration`: only used to run integration tests and separate them from unit tests.
 
 ## Contributing
 

docs/install-and-run.md

@@ -13,7 +13,7 @@ We currently recommend installing and running the client with the [`testing`](#t
 Run the following command to install the miden-client:
 
 ```sh
-cargo install miden-client --features testing,concurrent
+cargo install miden-client --features concurrent,executable,testing
 ```
 
 This installs the `miden` binary (at `~/.cargo/bin/miden`) with the [`testing`](#testing-feature) and [`concurrent`](#concurrent-feature) features.

docs/library.md

@@ -30,7 +30,10 @@ let client: Client<TonicRpcClient, SqliteDataStore> = {
     let store = SqliteStore::new((&client_config).into()).map_err(ClientError::StoreError)?;
     let store = Rc::new(store);
 
-    let rng = miden_client::get_random_coin();
+    let mut rng = rand::thread_rng();
+    let coin_seed: [u64; 4] = rng.gen();
+
+    let rng = RpoRandomCoin::new(coin_seed.map(Felt::new));
     let authenticator = StoreAuthenticator::new_with_rng(store.clone(), rng);
 
     let client = Client::new(

src/cli/account.rs

@@ -1,10 +1,6 @@
 use clap::Parser;
 use comfy_table::{presets, Attribute, Cell, ContentArrangement, Table};
-use miden_client::{
-    client::{rpc::NodeRpcClient, Client},
-    config::{CliConfig, ClientConfig},
-    store::Store,
-};
+use miden_client::{rpc::NodeRpcClient, store::Store, Client};
 use miden_objects::{
     accounts::{AccountId, AccountStorage, AccountType, AuthSecretKey, StorageSlotType},
     assets::Asset,
@@ -16,7 +12,10 @@ use miden_tx::{
     utils::{bytes_to_hex_string, Serializable},
 };
 
-use super::utils::{load_config_file, parse_account_id, update_config};
+use super::{
+    config::CliConfig,
+    utils::{load_config_file, parse_account_id, update_config},
+};
 use crate::cli::{create_dynamic_table, CLIENT_BINARY_NAME};
 
 // ACCOUNT COMMAND
@@ -272,10 +271,7 @@ fn storage_type_display_name(account: &AccountId) -> String {
 
 /// Loads config file and displays current default account ID
 fn display_default_account_id() -> Result<(), String> {
-    let (miden_client_config, _) = load_config_file()?;
-    let cli_config = miden_client_config
-        .cli
-        .ok_or("No CLI options found in the client config file".to_string())?;
+    let (cli_config, _) = load_config_file()?;
 
     let default_account = cli_config.default_account_id.ok_or(
         "No default account found in the CLI options from the client config file.".to_string(),
@@ -291,27 +287,25 @@ pub(crate) fn set_default_account(account_id: Option<AccountId>) -> Result<(), S
     let (mut current_config, config_path) = load_config_file()?;
 
     // set default account
-    current_config.cli = Some(CliConfig {
-        default_account_id: account_id.map(|id| id.to_hex()),
-    });
+    current_config.default_account_id = account_id.map(|id| id.to_hex());
 
     update_config(&config_path, current_config)
 }
 
 /// Sets the provided account ID as the default account and updates the config file, if not set already.
 pub(crate) fn maybe_set_default_account(
-    current_config: &mut ClientConfig,
+    current_config: &mut CliConfig,
     account_id: AccountId,
 ) -> Result<(), String> {
-    if let Some(CliConfig { default_account_id: Some(_) }) = current_config.cli {
+    if current_config.default_account_id.is_some() {
         return Ok(());
     }
 
     set_default_account(Some(account_id))?;
     let account_id = account_id.to_hex();
     println!("Setting account {account_id} as the default account ID.");
     println!("You can unset it with `{CLIENT_BINARY_NAME} account --default none`.");
-    current_config.cli = Some(CliConfig { default_account_id: Some(account_id) });
+    current_config.default_account_id = Some(account_id);
 
     Ok(())
 }

src/cli/config.rs

@@ -0,0 +1,37 @@
+use core::fmt::Debug;
+
+use figment::{
+    value::{Dict, Map},
+    Metadata, Profile, Provider,
+};
+use miden_client::{config::RpcConfig, store::sqlite_store::config::SqliteStoreConfig};
+use serde::{Deserialize, Serialize};
+
+// CLI CONFIG
+// ================================================================================================
+
+#[derive(Debug, Default, Eq, PartialEq, Deserialize, Serialize)]
+pub struct CliConfig {
+    /// Describes settings related to the RPC endpoint
+    pub rpc: RpcConfig,
+    /// Describes settings related to the store.
+    pub store: SqliteStoreConfig,
+    /// Address of the Miden node to connect to.
+    pub default_account_id: Option<String>,
+}
+
+// Make `ClientConfig` a provider itself for composability.
+impl Provider for CliConfig {
+    fn metadata(&self) -> Metadata {
+        Metadata::named("CLI Config")
+    }
+
+    fn data(&self) -> Result<Map<Profile, Dict>, figment::Error> {
+        figment::providers::Serialized::defaults(CliConfig::default()).data()
+    }
+
+    fn profile(&self) -> Option<Profile> {
+        // Optionally, a profile that's selected by default.
+        None
+    }
+}

src/cli/export.rs

@@ -1,8 +1,9 @@
 use std::{fs::File, io::Write, path::PathBuf};
 
 use miden_client::{
-    client::{rpc::NodeRpcClient, Client},
+    rpc::NodeRpcClient,
     store::{InputNoteRecord, Store},
+    Client,
 };
 use miden_objects::crypto::rand::FeltRng;
 use miden_tx::{auth::TransactionAuthenticator, utils::Serializable};
@@ -35,6 +36,7 @@ impl ExportCmd {
 
 // EXPORT NOTE
 // ================================================================================================
+
 pub fn export_note<N: NodeRpcClient, R: FeltRng, S: Store, A: TransactionAuthenticator>(
     client: &Client<N, R, S, A>,
     note_id: &str,