feat: Distribute protobuf files through a new crate

Cargo.toml

@@ -4,6 +4,7 @@ members = [
   "bin/faucet",
   "crates/block-producer",
   "crates/proto",
+  "crates/rpc-proto",
   "crates/rpc",
   "crates/store",
   "crates/utils",

crates/proto/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "miden-node-proto"
 version = "0.3.0"
-description = "Miden RPC message definitions"
+description = "Miden node message definitions (Store, Block Producer and RPC)"
 readme = "README.md"
 keywords = ["miden", "node", "protobuf", "rpc"]
 edition.workspace = true

crates/proto/build.rs

@@ -6,6 +6,12 @@ use prost::Message;
 fn main() -> miette::Result<()> {
     // Compute the directory of the `proto` definitions
     let cwd: PathBuf = env::current_dir().into_diagnostic()?;
+
+    let cwd = cwd
+        .parent()
+        .and_then(|p| p.parent())
+        .ok_or_else(|| miette::miette!("Failed to navigate two directories up"))?;
+
     let proto_dir: PathBuf = cwd.join("proto");
 
     // Compute the compiler's target file path.

crates/rpc-proto/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "miden-rpc-proto"
+version = "0.3.0"
+description = "Miden node RPC message definitions"
+readme = "README.md"
+keywords = ["miden", "node", "protobuf", "rpc"]
+categories = ["no-std::no-alloc"]
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+authors.workspace = true
+homepage.workspace = true
+repository.workspace = true
+
+[features]
+default = ["std"]
+std = []

crates/rpc-proto/README.md

@@ -0,0 +1,9 @@
+# Miden RPC proto
+
+This crate contains protobuf message definitions of the RPC component of the Miden node.
+It consists of a map of `(filename, file contents)` where each entry refers to a protobuf file.
+
+Additionally, the crate exposes a `write_proto(target_dir)` function that writes the files into `target_dir`.
+
+## License
+This project is [MIT licensed](../../LICENSE).

crates/rpc-proto/build.rs

@@ -0,0 +1,41 @@
+use std::{
+    env,
+    fs::File,
+    io::{self, Read, Write},
+    path::Path,
+};
+
+const DOC_COMMENT: &str =
+    "A list of tuples containing the names and contents of various protobuf files.";
+
+fn main() -> io::Result<()> {
+    let out_dir = env::current_dir().expect("Error getting cwd");
+    let dest_path = Path::new(&out_dir).join("./src/proto_files.rs");
+    let mut file = File::create(dest_path)?;
+
+    let proto_dir = Path::new("../../proto");
+
+    writeln!(file, "/// {DOC_COMMENT}")?;
+    writeln!(file, "pub const PROTO_FILES: &[(&str, &str)] = &[")?;
+
+    for entry in std::fs::read_dir(proto_dir)? {
+        let entry = entry?;
+        let path = entry.path();
+        if path.is_file() {
+            let mut file_content = String::new();
+            let file_name =
+                path.file_name().and_then(|f| f.to_str()).expect("Could not get file name");
+
+            File::open(&path)?.read_to_string(&mut file_content)?;
+            writeln!(
+                file,
+                "    (\"{}\", include_str!(\"../../../proto/{}\")),",
+                file_name, file_name
+            )?;
+        }
+    }
+
+    writeln!(file, "];")?;
+
+    Ok(())
+}

crates/rpc-proto/src/lib.rs

@@ -0,0 +1,36 @@
+#![no_std]
+
+#[cfg(feature = "std")]
+extern crate std;
+
+mod proto_files;
+pub use proto_files::PROTO_FILES;
+
+/// Writes the RPC protobuf file into `target_dir`.
+#[cfg(feature = "std")]
+pub fn write_proto(target_dir: &std::path::Path) -> Result<(), std::string::String> {
+    use std::{
+        format,
+        fs::{self, File},
+        io::Write,
+        string::ToString,
+    };
+
+    if !target_dir.exists() {
+        fs::create_dir_all(target_dir)
+            .map_err(|err| format!("Error creating directory: {}", err))?;
+    } else if !target_dir.is_dir() {
+        return Err("The target path exists but is not a directory".to_string());
+    }
+
+    for (file_name, file_content) in PROTO_FILES {
+        let mut file_path = target_dir.to_path_buf();
+        file_path.push(file_name);
+        let mut file = File::create(&file_path)
+            .map_err(|err| format!("Error creating {}: {}", file_name, err))?;
+        file.write_all(file_content.as_bytes())
+            .map_err(|err| format!("Error writing {}: {}", file_name, err))?;
+    }
+
+    Ok(())
+}

crates/rpc-proto/src/proto_files.rs

@@ -0,0 +1,16 @@
+/// A list of tuples containing the names and contents of various protobuf files.
+pub const PROTO_FILES: &[(&str, &str)] = &[
+    ("note.proto", include_str!("../../../proto/note.proto")),
+    ("smt.proto", include_str!("../../../proto/smt.proto")),
+    ("responses.proto", include_str!("../../../proto/responses.proto")),
+    ("rpc.proto", include_str!("../../../proto/rpc.proto")),
+    ("store.proto", include_str!("../../../proto/store.proto")),
+    ("transaction.proto", include_str!("../../../proto/transaction.proto")),
+    ("mmr.proto", include_str!("../../../proto/mmr.proto")),
+    ("account.proto", include_str!("../../../proto/account.proto")),
+    ("block_header.proto", include_str!("../../../proto/block_header.proto")),
+    ("digest.proto", include_str!("../../../proto/digest.proto")),
+    ("block_producer.proto", include_str!("../../../proto/block_producer.proto")),
+    ("merkle.proto", include_str!("../../../proto/merkle.proto")),
+    ("requests.proto", include_str!("../../../proto/requests.proto")),
+];