Merge branch 'next' into igamigo-rpc-tls

Author: igamigo

.github/workflows/test.yml

@@ -17,6 +17,19 @@ jobs:
       - name: make - test
         run: make test
 
+  doc-tests:
+    name: doc-tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@main
+      - uses: Swatinem/rust-cache@v2
+        with:
+          save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
+      - name: Install rust
+        run: rustup update --no-self-update
+      - name: Run doc-tests
+        run: make test-docs  
+
   integration-tests:
     name: Run integration tests on ubuntu-latest
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -21,6 +21,7 @@
 * Added fixed seed option for web client generation (#688)
 * [BREAKING] Updated `init` command in the CLI to receive a `--network` flag (#690).
 * Improved CLI error messages (#682).
+* [BREAKING] Renamed APIs for retrieving account information to use the `try_get_*` naming convention, and added/improved module documentation (#683).
 * Enabled TLS on tonic client (#697).
 
 ### Fixes

Makefile

@@ -6,6 +6,11 @@ help: ## Show description of all commands
 
 # --- Variables -----------------------------------------------------------------------------------
 
+# Enable file generation in the `src` directory.
+# This is used in the build script of the client to generate the node RPC-related code, from the
+# protobuf files.
+CODEGEN=CODEGEN=1
+
 FEATURES_WEB_CLIENT=--features "testing"
 FEATURES_CLIENT=--features "testing, concurrent" --no-default-features
 FEATURES_CLI=--features "concurrent"
@@ -76,29 +81,33 @@ doc: ## Generate & check rust documentation. You'll need `jq` in order for this
 
 .PHONY: test
 test: ## Run tests
-	CODEGEN=1 cargo nextest run --workspace --exclude miden-client-web --release --lib $(FEATURES_CLIENT)
+	$(CODEGEN) cargo nextest run --workspace --exclude miden-client-web --release --lib $(FEATURES_CLIENT)
 
 .PHONY: test-deps
 test-deps: ## Install dependencies for tests
-	CODEGEN=1 cargo install cargo-nextest
+	$(CODEGEN) cargo install cargo-nextest
+
+.PHONY: test-docs
+test-docs: ## Run documentation tests
+	$(CODEGEN) cargo test --doc $(FEATURES_CLIENT)
 
 # --- Integration testing -------------------------------------------------------------------------
 
 .PHONY: integration-test
 integration-test: ## Run integration tests
-	CODEGEN=1 cargo nextest run --workspace --exclude miden-client-web --release --test=integration $(FEATURES_CLI) 
+	$(CODEGEN) cargo nextest run --workspace --exclude miden-client-web --release --test=integration $(FEATURES_CLI) 
 
 .PHONY: integration-test-web-client
 integration-test-web-client: ## Run integration tests for the web client
-	CODEGEN=1 cd ./crates/web-client && npm run test:clean
+	$(CODEGEN) cd ./crates/web-client && npm run test:clean
 
 .PHONY: integration-test-remote-prover-web-client
 integration-test-remote-prover-web-client: ## Run integration tests for the web client with remote prover
-	CODEGEN=1 cd ./crates/web-client && npm run test:remote_prover
+	$(CODEGEN) cd ./crates/web-client && npm run test:remote_prover
 
 .PHONY: integration-test-full
 integration-test-full: ## Run the integration test binary with ignored tests included
-	CODEGEN=1 cargo nextest run --workspace --exclude miden-client-web --release --test=integration $(FEATURES_CLI)
+	$(CODEGEN) cargo nextest run --workspace --exclude miden-client-web --release --test=integration $(FEATURES_CLI)
 	cargo nextest run --workspace --exclude miden-client-web --release --test=integration $(FEATURES_CLI) --run-ignored ignored-only -- test_import_genesis_accounts_can_be_used_for_transactions
 
 .PHONY: kill-node

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

@@ -1,7 +1,7 @@
 use clap::Parser;
 use miden_client::{
     account::{Account, AccountId, AccountType, StorageSlot},
-    assets::Asset,
+    asset::Asset,
     crypto::FeltRng,
     Client, ZERO,
 };
@@ -67,8 +67,7 @@ impl AccountCmd {
                             })?;
 
                             // Check whether we're tracking that account
-                            let (account, _) =
-                                client.get_account_header_or_error(account_id).await?;
+                            let (account, _) = client.try_get_account_header(account_id).await?;
 
                             Some(account.id())
                         };

bin/miden-cli/src/commands/init.rs

@@ -52,12 +52,12 @@ the CLI and client configurations, and will be placed by default in the current
 directory."
 )]
 pub struct InitCmd {
-    /// Network configuration to use. Options are devnet, testnet, localhost or a custom RPC
+    /// Network configuration to use. Options are `devnet`, `testnet`, `localhost` or a custom RPC
     /// endpoint. Defaults to the testnet network.
     #[clap(long, short, default_value = "testnet")]
     network: Option<Network>,
 
-    /// Store file path.
+    /// Path to the store file.
     #[clap(long)]
     store_path: Option<String>,
 

bin/miden-cli/src/commands/new_account.rs

@@ -4,7 +4,7 @@ use miden_client::{
         AccountBuilder, AccountStorageMode, AccountType, BasicFungibleFaucetComponent,
         BasicWalletComponent, RpoFalcon512Component,
     },
-    assets::TokenSymbol,
+    asset::TokenSymbol,
     auth::AuthSecretKey,
     crypto::{FeltRng, SecretKey},
     Client, Felt,

bin/miden-cli/src/commands/new_transactions.rs

@@ -3,7 +3,7 @@ use std::{io, sync::Arc};
 use clap::{Parser, ValueEnum};
 use miden_client::{
     account::AccountId,
-    assets::{FungibleAsset, NonFungibleDeltaAction},
+    asset::{FungibleAsset, NonFungibleDeltaAction},
     crypto::{Digest, FeltRng},
     note::{build_swap_tag, get_input_note_with_id_prefix, BlockNumber, NoteType as MidenNoteType},
     store::NoteRecordError,

bin/miden-cli/src/commands/notes.rs

@@ -2,7 +2,7 @@ use clap::ValueEnum;
 use comfy_table::{presets, Attribute, Cell, ContentArrangement, Table};
 use miden_client::{
     account::AccountId,
-    assets::Asset,
+    asset::Asset,
     crypto::{Digest, FeltRng},
     note::{
         get_input_note_with_id_prefix,

bin/miden-cli/src/faucet_details_map.rs

@@ -3,7 +3,7 @@ use std::{
     path::PathBuf,
 };
 
-use miden_client::{account::AccountId, assets::FungibleAsset};
+use miden_client::{account::AccountId, asset::FungibleAsset};
 use miden_lib::account::faucets::BasicFungibleFaucet;
 use serde::{Deserialize, Serialize};
 

crates/rust-client/README.md

@@ -12,14 +12,16 @@ miden-client = { version = "0.6" }
 
 ## Crate Features
 
-- `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.
+| Features     | Description                                                                                                                                               |
+| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `concurrent` | Used to enable concurrency during execution and proof generation. **Disabled by default.**                                                               |
+| `idxdb`      | Includes `WebStore`, an IndexedDB implementation of the `Store` trait. **Disabled by default.**                                                          |
+| `sqlite`     | Includes `SqliteStore`, a SQLite implementation of the `Store` trait. This relies on the standard library. **Disabled by default.**                                                           |
+| `tonic`      | Includes `TonicRpcClient`, a Tonic client to communicate with Miden node. This relies on the standard library. **Disabled by default.**                                                        |
+| `web-tonic`  | Includes `WebTonicRpcClient`, a Tonic client to communicate with the Miden node in the browser. **Disabled by default.**                                   |
+| `testing`    | Enables functions meant to be used in testing environments. **Disabled by default.**             |
+
+Features `sqlite` and `idxdb` are mutually exclusive.
 
 ### Store and RpcClient implementations