feat: Note Transport integration (0xMiden#1296)

* Transport init

* Rebase fix

* Transport layer CLI

* Move fetch-notes to update-based approach

* Transport layer proto crate with no-default-features

* Move to batched-tag note-fetching

* IndexedDB transport methods

* Relax CI

* `TransportError` renamed to `NoteTransportError`

* Do not use `Endpoint` with Transport layer

* Fallible Transport methods if client not configured

* Replace transport error `Other` variant for `TransportLayer`
(server side error)

* Transport layer update return input note

* Change tower timeout for tonic's

* Relax CI

* Drop "Canonical", "Layer", from note transport naming

* Use `Store` settings to store note transport cursor

* `transport` files, mods renaming, remove schema cursor setting

* Bump web-client SDK version

* Remove unused `fetch_private_notes` fn generic `<I>`

* Expand comments, cursor type

* Move CLI note-transport commands to notes, flatten related commands

* Add CLI `init` cmd note-transport-endpoint config option

* Do transport protobuf codegen locally

* Remove `tsconfig.tsbuildinfo` file

* Fix proto WASM compilation, continue renaming private to note

Author: v0-e

CHANGELOG.md

@@ -23,6 +23,7 @@
 * [BREAKING] Added `block_to` parameter to `NodeRpcClient::sync_nullifiers` for better pagination control ([#1309](https://github.com/0xMiden/miden-client/pull/1309)).
 * [BREAKING] Removed `web-tonic` feature ([#1268](https://github.com/0xMiden/miden-client/pull/1268)).
 * [BREAKING] Updated Web Client account store functions from insert to upsert ([#1274](https://github.com/0xMiden/miden-client/pull/1274)).
+* [BREAKING] Added connectivity to the Transport Layer, adding a new `Client` field and `Store` methods ([#1296](https://github.com/0xMiden/miden-client/pull/1296)).
 * Removed `miden-lib` and `miden-objects` dependencies from web client & cli ([#1333](https://github.com/0xMiden/miden-client/pull/1333)).
 * Add more context to errors when deserializing objects ([#1336](https://github.com/0xMiden/miden-client/pull/1336))
 * [BREAKING] Renamed `TonicRpcClient` to `GrpcClient` and `tonic_rpc_client()` method to `grpc_client()` ([#1360](https://github.com/0xMiden/miden-client/pull/1360)).

Cargo.lock

@@ -37,6 +37,7 @@ miden-node-proto-build = { branch = "next", default-features = false, git = "htt
 miden-node-rpc = { branch = "next", git = "https://github.com/0xMiden/miden-node" }
 miden-node-store = { branch = "next", git = "https://github.com/0xMiden/miden-node" }
 miden-node-utils = { branch = "next", git = "https://github.com/0xMiden/miden-node" }
+miden-note-transport-proto-build = { default-features = false, git = "https://github.com/0xMiden/miden-note-transport" }
 miden-remote-prover = { branch = "next", features = ["concurrent"], git = "https://github.com/0xMiden/miden-node" }
 miden-remote-prover-client = { branch = "next", default-features = false, features = [
   "tx-prover",

Cargo.toml

@@ -6,7 +6,7 @@ use clap::Parser;
 use tracing::info;
 
 use crate::CLIENT_CONFIG_FILE_NAME;
-use crate::config::{CliConfig, CliEndpoint, Network};
+use crate::config::{CliConfig, CliEndpoint, Network, NoteTransportConfig};
 use crate::errors::CliError;
 
 /// Contains the account component template file generated on build.rs, corresponding to the basic
@@ -50,6 +50,13 @@ pub struct InitCmd {
     #[arg(long)]
     remote_prover_endpoint: Option<String>,
 
+    /// RPC endpoint for the note transport node. Required to use the note transport network to
+    /// exchange private notes.
+    /// The endpoint must be in the form of "{protocol}://{hostname}:{port}", being the protocol
+    /// and port optional.
+    #[arg(long)]
+    note_transport_endpoint: Option<String>,
+
     /// Maximum number of blocks the client can be behind the network.
     #[clap(long)]
     block_delta: Option<u32>,
@@ -80,6 +87,12 @@ impl InitCmd {
             None => None,
         };
 
+        cli_config.note_transport =
+            self.note_transport_endpoint.as_ref().map(|rpc| NoteTransportConfig {
+                endpoint: rpc.to_string(),
+                ..Default::default()
+            });
+
         cli_config.max_block_number_delta = self.block_delta;
 
         let config_as_toml_string = toml::to_string_pretty(&cli_config).map_err(|err| {

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

@@ -1,9 +1,12 @@
 use clap::ValueEnum;
 use comfy_table::{Attribute, Cell, ContentArrangement, Table, presets};
+use miden_client::address::Address;
 use miden_client::asset::Asset;
 use miden_client::auth::TransactionAuthenticator;
 use miden_client::note::{
+    Note,
     NoteConsumability,
+    NoteId,
     NoteInputs,
     NoteMetadata,
     WellKnownNote,
@@ -57,12 +60,21 @@ pub struct NotesCmd {
     /// consumable by this account will be shown.
     #[arg(short, long, value_name = "account_id")]
     account_id: Option<String>,
+    /// Send a stored private note through the note transport network.
+    /// Define both the note ID (as hex string) and address (as Bech32 string) such as:
+    /// `--send 0xc1234567 mm1qpkdyek2c0ywwvzupakc7zlzty8qn2qnfc`
+    #[arg(long, group = "action", num_args = 2, value_names = ["note_id", "address"])]
+    send: Option<Vec<String>>,
+    /// Fetch notes from the note transport network.
+    /// Fetched notes for tracked note tags will be added to the store.
+    #[arg(long, group = "action")]
+    fetch: bool,
 }
 
 impl NotesCmd {
     pub async fn execute<AUTH: TransactionAuthenticator + Sync>(
         &self,
-        client: Client<AUTH>,
+        mut client: Client<AUTH>,
     ) -> Result<(), CliError> {
         match self {
             NotesCmd { list: Some(NoteFilter::Consumable), .. } => {
@@ -78,6 +90,14 @@ impl NotesCmd {
             NotesCmd { show: Some(id), .. } => {
                 show_note(client, id.to_owned(), self.with_code).await?;
             },
+            NotesCmd { send: Some(args), .. } => {
+                let note_id = &args[0];
+                let address = &args[1];
+                send(&mut client, note_id, address).await?;
+            },
+            NotesCmd { fetch: true, .. } => {
+                fetch(&mut client).await?;
+            },
             _ => {
                 list_notes(client, ClientNoteFilter::All).await?;
             },
@@ -311,6 +331,43 @@ async fn list_consumable_notes<AUTH: TransactionAuthenticator + Sync>(
     Ok(())
 }
 
+// SEND
+// ================================================================================================
+
+/// Send a (stored) note
+async fn send<AUTH: TransactionAuthenticator + Sync>(
+    client: &mut Client<AUTH>,
+    note_id: &str,
+    address: &str,
+) -> Result<(), CliError> {
+    let id = NoteId::try_from_hex(note_id).map_err(|e| CliError::Input(e.to_string()))?;
+    let note_record = client
+        .get_input_note(id)
+        .await?
+        .ok_or_else(|| CliError::Input(format!("note {note_id} not found")))?;
+    let note: Note = note_record
+        .try_into()
+        .map_err(|e| CliError::Client(ClientError::NoteRecordConversionError(e)))?;
+    let (_netid, address) =
+        Address::from_bech32(address).map_err(|e| CliError::Input(e.to_string()))?;
+
+    client.send_private_note(note, &address).await?;
+
+    Ok(())
+}
+
+// FETCH
+// ================================================================================================
+
+/// Retrieve notes for all tracked tags
+///
+/// Fetched notes are stored in the store.
+async fn fetch<AUTH>(client: &mut Client<AUTH>) -> Result<(), CliError> {
+    client.fetch_private_notes().await?;
+
+    Ok(())
+}
+
 // HELPERS
 // ================================================================================================
 fn print_notes_summary<I>(notes: I, header: &str)

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

@@ -5,6 +5,7 @@ use std::str::FromStr;
 
 use figment::value::{Dict, Map};
 use figment::{Metadata, Profile, Provider};
+use miden_client::note_transport::NOTE_TRANSPORT_DEFAULT_ENDPOINT;
 use miden_client::rpc::Endpoint;
 use serde::{Deserialize, Serialize};
 
@@ -33,6 +34,8 @@ pub struct CliConfig {
     /// Maximum number of blocks the client can be behind the network for transactions and account
     /// proofs to be considered valid.
     pub max_block_number_delta: Option<u32>,
+    /// Describes settings related to the note transport endpoint.
+    pub note_transport: Option<NoteTransportConfig>,
 }
 
 // Make `ClientConfig` a provider itself for composability.
@@ -67,6 +70,7 @@ impl Default for CliConfig {
             remote_prover_endpoint: None,
             component_template_directory: Path::new(DEFAULT_COMPONENT_TEMPLATE_DIR).to_path_buf(),
             max_block_number_delta: None,
+            note_transport: None,
         }
     }
 }
@@ -92,6 +96,27 @@ impl Default for RpcConfig {
     }
 }
 
+// NOTE TRANSPORT CONFIG
+// ================================================================================================
+
+/// Settings for the note transport client.
+#[derive(Debug, Deserialize, Serialize)]
+pub struct NoteTransportConfig {
+    /// Address of the Miden Note Transport node to connect to.
+    pub endpoint: String,
+    /// Timeout for the Note Transport RPC api requests, in milliseconds.
+    pub timeout_ms: u64,
+}
+
+impl Default for NoteTransportConfig {
+    fn default() -> Self {
+        Self {
+            endpoint: NOTE_TRANSPORT_DEFAULT_ENDPOINT.to_string(),
+            timeout_ms: 10000,
+        }
+    }
+}
+
 // CLI ENDPOINT
 // ================================================================================================
 

bin/miden-cli/src/config.rs

@@ -9,6 +9,7 @@ use miden_client::account::AccountHeader;
 use miden_client::auth::TransactionAuthenticator;
 use miden_client::builder::ClientBuilder;
 use miden_client::keystore::FilesystemKeyStore;
+use miden_client::note_transport::grpc::GrpcNoteTransportClient;
 use miden_client::store::{NoteFilter as ClientNoteFilter, OutputNoteRecord};
 use miden_client::{Client, DebugMode, IdPrefixFetchError};
 use miden_client_sqlite_store::SqliteStore;
@@ -187,6 +188,16 @@ impl Cli {
             builder = builder.max_block_number_delta(delta);
         }
 
+        if let Some(tl_config) = cli_config.note_transport {
+            let client = GrpcNoteTransportClient::connect(
+                tl_config.endpoint.to_string(),
+                tl_config.timeout_ms,
+            )
+            .await
+            .map_err(|e| CliError::Client(e.into()))?;
+            builder = builder.note_transport(Arc::new(client));
+        }
+
         let client = builder.build().await?;
 
         // Execute CLI command

bin/miden-cli/src/lib.rs

@@ -764,6 +764,7 @@ async fn create_rust_client_with_store_path(
             )?,
             None,
             None,
+            None,
         )
         .await?,
         keystore,

bin/miden-cli/tests/cli.rs

@@ -40,31 +40,35 @@ miden-testing              = { optional = true, workspace = true }
 miden-tx                   = { workspace = true }
 
 # External dependencies
-anyhow      = { workspace = true }
-async-trait = { workspace = true }
-chrono      = { optional = false, version = "0.4" }
-hex         = { workspace = true }
-prost       = { default-features = false, features = ["derive"], version = "0.13" }
-rand        = { workspace = true }
-thiserror   = { workspace = true }
-tonic       = { default-features = false, features = ["codegen", "prost"], version = "0.13" }
-tracing     = { workspace = true }
-uuid        = { features = ["js", "serde", "v4"], optional = true, version = "1.10" }
+anyhow       = { workspace = true }
+async-trait  = { workspace = true }
+chrono       = { optional = false, version = "0.4" }
+futures      = { version = "0.3" }
+hex          = { workspace = true }
+prost        = { default-features = false, features = ["derive"], version = "0.13" }
+prost-types  = { version = "0.13" }
+rand         = { workspace = true }
+thiserror    = { workspace = true }
+tonic        = { default-features = false, features = ["codegen", "prost"], version = "0.13" }
+tonic-health = { version = "0.13" }
+tracing      = { workspace = true }
+uuid         = { features = ["js", "serde", "v4"], optional = true, version = "1.10" }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 getrandom             = { features = ["wasm_js"], version = "0.3" }
 tonic-web-wasm-client = { default-features = false, version = "0.7" }
 web-sys               = { features = ["Storage", "Window", "console"], version = "0.3" }
 
 [build-dependencies]
-miden-lib              = { workspace = true }
-miden-node-proto-build = { workspace = true }
-miden-objects          = { workspace = true }
-miette                 = { workspace = true }
-prost                  = { default-features = false, features = ["derive"], version = "0.13" }
-prost-build            = { default-features = false, version = "0.13" }
-protox                 = { version = "0.7" }
-tonic-build            = { version = "0.13" }
+miden-lib                        = { workspace = true }
+miden-node-proto-build           = { workspace = true }
+miden-note-transport-proto-build = { workspace = true }
+miden-objects                    = { workspace = true }
+miette                           = { workspace = true }
+prost                            = { default-features = false, features = ["derive"], version = "0.13" }
+prost-build                      = { default-features = false, version = "0.13" }
+protox                           = { version = "0.7" }
+tonic-build                      = { version = "0.13" }
 
 [dev-dependencies]
 miden-client              = { features = ["std", "testing"], path = "." }

crates/rust-client/Cargo.toml

@@ -2,10 +2,13 @@ use std::fs;
 use std::io::Write;
 
 use miden_node_proto_build::rpc_api_descriptor;
+use miden_note_transport_proto_build::mnt_api_descriptor;
 use miette::IntoDiagnostic;
 
 const STD_PROTO_OUT_DIR: &str = "src/rpc/generated/std";
 const NO_STD_PROTO_OUT_DIR: &str = "src/rpc/generated/nostd";
+const NOTE_TRANSPORT_STD_PROTO_OUT_DIR: &str = "src/note_transport/generated/std";
+const NOTE_TRANSPORT_NO_STD_PROTO_OUT_DIR: &str = "src/note_transport/generated/nostd";
 
 /// Defines whether the build script should generate files in `/src`.
 /// The docs.rs build pipeline has a read-only filesystem, so we have to avoid writing to `src`,
@@ -19,12 +22,47 @@ fn main() -> miette::Result<()> {
     }
 
     compile_tonic_client_proto()?;
+    compile_tonic_note_transport_proto()?;
     replace_no_std_types(NO_STD_PROTO_OUT_DIR.to_string() + "/rpc.rs");
     replace_no_std_types(NO_STD_PROTO_OUT_DIR.to_string() + "/rpc_store.rs");
     replace_no_std_types(NO_STD_PROTO_OUT_DIR.to_string() + "/block_producer.rs");
+    replace_no_std_types(
+        NOTE_TRANSPORT_NO_STD_PROTO_OUT_DIR.to_string() + "/miden_note_transport.rs",
+    );
 
     Ok(())
 }
+
+// NOTE TRANSPORT CLIENT PROTO CODEGEN
+// ===============================================================================================
+
+/// Generates the Rust protobuf bindings for the Note Transport client.
+fn compile_tonic_note_transport_proto() -> miette::Result<()> {
+    let file_descriptors = mnt_api_descriptor();
+
+    let mut prost_config = prost_build::Config::new();
+    prost_config.skip_debug(["AccountId", "Digest"]);
+
+    let mut web_tonic_prost_config = prost_build::Config::new();
+    web_tonic_prost_config.skip_debug(["AccountId", "Digest"]);
+
+    // Generate the header of the user facing server from its proto file
+    tonic_build::configure()
+        .build_transport(false)
+        .build_server(false)
+        .out_dir(NOTE_TRANSPORT_NO_STD_PROTO_OUT_DIR)
+        .compile_fds_with_config(web_tonic_prost_config, file_descriptors.clone())
+        .into_diagnostic()?;
+
+    tonic_build::configure()
+        .build_server(false)
+        .out_dir(NOTE_TRANSPORT_STD_PROTO_OUT_DIR)
+        .compile_fds_with_config(prost_config, file_descriptors)
+        .into_diagnostic()?;
+
+    Ok(())
+}
+
 // NODE RPC CLIENT PROTO CODEGEN
 // ===============================================================================================