refactor: split cli and client into workspace

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+* [BREAKING] Split cli and client into workspace (#407).
 * Note importing in client now uses the `NoteFile` type (#375).
 * Added build script to import Miden node protobuf files to generate types for `tonic_client` and removed `miden-node-proto` dependency (#395).
 * Implemented retrieval of executed transaction info (id, commit height, account_id) from sync state RPC endpoint (#387).

Cargo.toml

@@ -1,80 +1,20 @@
-[package]
-name = "miden-client"
-version = "0.3.1"
-description = "Client library that facilitates interaction with the Miden rollup"
-authors = ["miden contributors"]
-readme = "README.md"
-license = "MIT"
-repository = "https://github.com/0xPolygonMiden/miden-client"
-documentation = "https://docs.rs/miden-client/0.3.1"
-keywords = ["miden", "client"]
-edition = "2021"
-rust-version = "1.78"
-default-run = "miden"
-
-[lib]
-crate-type = ["lib"]
+[workspace]
+resolver = "2"
 
-[[bin]]
-name = "miden"
-path = "src/main.rs"
-required-features = ["executable"]
+members = [
+  "bin/miden-cli",
+  "crates/rust-client",
+  "tests"
+]
 
-[[test]]
-name = "integration"
-path = "tests/integration/main.rs"
-required-features = ["integration"]
-
-[features]
-async = ["miden-tx/async"]
-concurrent = ["miden-lib/concurrent", "miden-objects/concurrent", "miden-tx/concurrent", "std"]
-default = ["std"]
-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"]
-tonic = ["dep:hex", "dep:prost","dep:tonic"]
+[workspace.package]
+edition = "2021"
+rust-version = "1.78"
+license = "MIT"
+authors = ["miden contributors"]
+repository = "https://github.com/0xPolygonMiden/miden-client"
 
-[dependencies]
-chrono = { version = "0.4", optional = false }
-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 }
-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 }
-miden-tx = { package = "miden-tx", git = "https://github.com/0xPolygonMiden/miden-base.git", branch = "next", default-features = false }
-miden-objects = { package = "miden-objects", git = "https://github.com/0xPolygonMiden/miden-base.git", branch = "next", default-features = false, features = ["serde"] }
-prost = { version = "0.12", optional = true }
-rand = { version = "0.8.5" }
-rusqlite = { version = "0.30.0", features = ["vtab", "array", "bundled"], optional = true }
-rusqlite_migration = { version = "1.0", optional = true }
-serde = { version = "1.0", features = ["derive"] }
-serde_json = { version = "1.0", features = ["raw_value"] }
-tokio = { version = "1.29", features = ["rt-multi-thread", "net", "macros"], optional = true }
-tonic = { version = "0.11", optional = true }
-toml = { version = "0.8", optional = true }
-thiserror = { version = "1.0", optional = true }
+[workspace.dependencies]
+rand = { version = "0.8" }
+tokio = { version = "1.29", features = ["rt-multi-thread", "net", "macros"] }
 tracing = { version = "0.1" }
-tracing-subscriber = { version = "0.3" }
-winter-maybe-async = "0.10.0"
-
-[target.'wasm32-unknown-unknown'.dependencies]
-getrandom = { version = "0.2", features = ["js"] }
-
-[dev-dependencies]
-# To enable testing feature during tests
-assert_cmd = { version = "2.0" }
-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"] }
-proptest = { version = "1.2" }
-uuid = { version = "1.6.1", features = ["serde", "v4"] }
-
-[build-dependencies]
-miden-rpc-proto = { package = "miden-rpc-proto", git = "https://github.com/0xPolygonMiden/miden-node.git", branch = "next" }
-miette = { version = "7.0", features = ["fancy"] }
-prost = { version = "0.12" }
-prost-build = { version = "0.12" }
-protox = { version = "0.6" }
-tonic-build = { version = "0.11" }

Makefile

@@ -7,10 +7,10 @@ help: ## Show description of all commands
 # --- Variables -----------------------------------------------------------------------------------
 
 FEATURES_INTEGRATION_TESTING="integration"
-FEATURES_CLI="testing, executable, concurrent"
+FEATURES_CLI="testing, concurrent"
 NODE_FEATURES_TESTING="testing"
 WARNINGS=RUSTDOCFLAGS="-D warnings"
-NODE_BRANCH="polydez-future-notes"
+NODE_BRANCH="next"
 
 # --- Linting -------------------------------------------------------------------------------------
 
@@ -51,7 +51,7 @@ doc-serve: doc-deps ## Serve documentation site
 
 .PHONY: doc
 doc: ## Generates & checks rust documentation
-	$(WARNINGS) cargo doc --all-features --keep-going --release
+	$(WARNINGS) cargo doc --all-features --keep-going --release -p miden-client
 
 # --- Testing -------------------------------------------------------------------------------------
 
@@ -62,11 +62,11 @@ test: ## Run tests
 # --- Integration testing -------------------------------------------------------------------------
 
 .PHONY: integration-test
-integration-test: ## Run integration tests
+integration-test: build ## Run integration tests
 	cargo nextest run --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
+integration-test-full: build ## Run the integration test binary with ignored tests included
 	cargo nextest run --release --test=integration --features $(FEATURES_INTEGRATION_TESTING)
 	cargo nextest run --release --test=integration --features $(FEATURES_INTEGRATION_TESTING) --run-ignored ignored-only -- test_import_genesis_accounts_can_be_used_for_transactions
 
@@ -79,7 +79,7 @@ clean-node: ## Clean node directory
 	rm -rf miden-node
 
 .PHONY: node
-node: ## Setup node
+node: ## Setup node directory
 	if [ -d miden-node ]; then cd miden-node ; else git clone https://github.com/0xPolygonMiden/miden-node.git && cd miden-node; fi
 	cd miden-node && git checkout $(NODE_BRANCH) && git pull origin $(NODE_BRANCH) && cargo update
 	cd miden-node && rm -rf miden-store.sqlite3*
@@ -91,13 +91,13 @@ start-node: ## Run node. This requires the node repo to be present at `miden-nod
 
 # --- Installing ----------------------------------------------------------------------------------
 
-install: ## Installs the CLI binary using the current dir
-	cargo install --features $(FEATURES_CLI) --path .
+install: ## Installs the CLI binary
+	cargo install --features $(FEATURES_CLI) --path bin/miden-cli
 
 # --- Building ------------------------------------------------------------------------------------
 
 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 --no-default-features
+build-wasm: ## Builds the client library for wasm32
+	cargo build --target wasm32-unknown-unknown --features async --no-default-features --package miden-client

README.md

@@ -15,8 +15,8 @@ The Miden client is still under heavy development and the project can be conside
 
 The Miden client currently consists of two components:
 
-- `miden-client` library, which can be used by other project to programmatically interact with the Miden rollup. 
-- `miden-client` binary which is a wrapper around the library exposing its functionality via a simple command-line interface (CLI).
+- `miden-client` library, which can be used by other project to programmatically interact with the Miden rollup. You can find more information about the library in the [Rust Client Library](./crates/rust-client/README.md) section.
+- _Miden CLI_, which is a wrapper around the library exposing its functionality via a simple command-line interface (CLI). You can find more information about the CLI in the [Miden Client CLI](./bin/miden-cli/README.md) section.
 
 The client's main responsibility is to maintain a partial view of the blockchain which allows for locally executing and proving transactions. It keeps a local store of various entities that periodically get updated by syncing with the node.
 
@@ -27,50 +27,16 @@ For more info check:
     - [Configuration](./docs/cli-config.md)
 - [Online Documentation](https://docs.polygon.technology/miden/miden-client)
 
-## Usage
+## Workspace structure
 
-Before you can use the Miden client, you'll need to make sure you have both
-[Rust](https://www.rust-lang.org/tools/install) and sqlite3 installed. Miden
-client requires rust version **1.78** or higher.
-
-### 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:
-
-````toml
-miden-client = { version = "0.3.1" }
-````
-
-By default, the library is `no_std` compatible. 
-
-#### Features
-
-- `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
-
-You can either build from source with:
-
-```bash
-cargo build --release
-```
-
-Once the binary is built, you can find it on `./target/release/miden-client`.
-
-Or you can install the CLI from crates-io with:
-
-```bash
-cargo install miden-client
-```
+The workspace is organized as follows:
+- The `bin` folder contains crates that are meant to be compiled into binaries (like the CLI).
+- The `crates` folder contains the library crates that are meant to be used as dependencies (like the Rust client library).
+- The `tests` folder contains integration tests for the workspace crates.
 
 ### Makefile
 
-As mentioned before, we use `make` to encapsulate some tasks, such as running lints and tests. You can check out [Makefile](./Makefile) for all available tasks or just run the following command:
+We use `make` to encapsulate some tasks, such as running lints and tests. You can check out [Makefile](./Makefile) for all available tasks or just run the following command:
 
 ```bash
 make

bin/miden-cli/Cargo.toml

@@ -0,0 +1,35 @@
+[package]
+name = "miden-cli"
+version = "0.3.1"
+description = "CLI binary application that facilitates interaction with the Miden rollup"
+readme = "README.md"
+documentation = "https://docs.rs/miden-cli/0.3.1"
+keywords = ["miden", "client", "cli"]
+license.workspace = true
+authors.workspace = true
+repository.workspace = true
+rust-version.workspace = true
+edition.workspace = true
+
+[[bin]]
+name = "miden"
+path = "src/main.rs"
+
+[features]
+default = []
+testing = ["miden-client/testing"]
+concurrent = ["miden-client/concurrent"]
+
+[dependencies]
+clap = { version = "4.3", features = ["derive"] }
+comfy-table = { version = "7.1" }
+figment = { version = "0.10", features = ["toml", "env"] }
+miden-client = { path = "../../crates/rust-client", version = "0.3", features = ["sqlite", "tonic"] }
+rand = { workspace = true }
+serde = { version = "1.0", features = ["derive"] }
+serde_json = { version = "1.0", features = ["raw_value"] }
+tokio = { workspace = true  }
+tonic = { version = "0.11" }
+toml = { version = "0.8" }
+tracing = { workspace = true }
+tracing-subscriber = { version = "0.3" }

bin/miden-cli/README.md

@@ -0,0 +1,30 @@
+# 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](https://www.rust-lang.org/tools/install) and sqlite3 installed. Miden client requires rust version **1.78** or higher.
+
+### Running `miden-client`'s CLI
+
+You can either build from source with:
+
+```bash
+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:
+
+```bash
+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](./LICENSE).

src/cli/account.rs → bin/miden-cli/src/commands/account.rs

@@ -1,22 +1,21 @@
 use clap::Parser;
-use comfy_table::{presets, Attribute, Cell, ContentArrangement, Table};
-use miden_client::{rpc::NodeRpcClient, store::Store, Client};
-use miden_objects::{
-    accounts::{AccountId, AccountStorage, AccountType, AuthSecretKey, StorageSlotType},
+use comfy_table::presets;
+use miden_client::{
+    accounts::{AccountId, AccountStorage, AccountType, StorageSlotType},
     assets::Asset,
-    crypto::{dsa::rpo_falcon512::SK_LEN, rand::FeltRng},
-    ZERO,
-};
-use miden_tx::{
     auth::TransactionAuthenticator,
-    utils::{bytes_to_hex_string, Serializable},
+    crypto::FeltRng,
+    rpc::NodeRpcClient,
+    store::Store,
+    Client, ZERO,
 };
 
-use super::{
+use crate::{
     config::CliConfig,
+    create_dynamic_table,
     utils::{load_config_file, parse_account_id, update_config},
+    CLIENT_BINARY_NAME,
 };
-use crate::cli::{create_dynamic_table, CLIENT_BINARY_NAME};
 
 // ACCOUNT COMMAND
 // ================================================================================================
@@ -202,29 +201,6 @@ pub fn show_account<N: NodeRpcClient, R: FeltRng, S: Store, A: TransactionAuthen
         println!("{table}\n");
     }
 
-    // Keys table
-    {
-        let auth_info = client.get_account_auth(account_id)?;
-
-        match auth_info {
-            AuthSecretKey::RpoFalcon512(key_pair) => {
-                let auth_info: [u8; SK_LEN] = key_pair
-                    .to_bytes()
-                    .try_into()
-                    .expect("Array size is const and should always exactly fit SecretKey");
-
-                let mut table = Table::new();
-                table
-                    .load_preset(presets::UTF8_HORIZONTAL_ONLY)
-                    .set_content_arrangement(ContentArrangement::DynamicFullWidth)
-                    .set_header(vec![Cell::new("Key Pair").add_attribute(Attribute::Bold)]);
-
-                table.add_row(vec![format!("0x{}\n", bytes_to_hex_string(auth_info))]);
-                println!("{table}\n");
-            },
-        };
-    }
-
     // Code related table
     {
         let module = account.code().module();

src/cli/export.rs → bin/miden-cli/src/commands/export.rs

@@ -1,12 +1,12 @@
 use std::{fs::File, io::Write, path::PathBuf};
 
-use miden_client::{rpc::NodeRpcClient, store::Store, Client};
-use miden_objects::{crypto::rand::FeltRng, notes::NoteFile};
-use miden_tx::{auth::TransactionAuthenticator, utils::Serializable};
+use miden_client::{
+    auth::TransactionAuthenticator, crypto::FeltRng, notes::NoteFile, rpc::NodeRpcClient,
+    store::Store, utils::Serializable, Client,
+};
 use tracing::info;
 
-use super::Parser;
-use crate::cli::get_output_note_with_id_prefix;
+use crate::{get_output_note_with_id_prefix, Parser};
 
 #[derive(Debug, Parser, Clone)]
 #[clap(about = "Export client output notes")]