chore: rename api.proto file to tx_prover.proto (#1110)

CHANGELOG.md

@@ -7,6 +7,7 @@
 - [BREAKING] Incremented minimum supported Rust version to 1.84.
 - [BREAKING] Moved `generated` module from `miden-proving-service-client` crate to `tx_prover::generated` hierarchy (#1102).
 - Added an endpoint to the `miden-proving-service` to update the workers (#1107).
+- Renamed the protobuf file of the transaction prover to `tx_prover.proto` (#1110).
 
 ## 0.7.2 (2025-01-28) - `miden-objects` crate only
 

bin/proving-service/build.rs

@@ -33,10 +33,11 @@ fn main() -> miette::Result<()> {
 // HELPER FUNCTIONS
 // ================================================================================================
 
-/// Copies all api.proto file from the root proto directory to the proto directory of this crate.
+/// Copies the tx_prover.proto file from the root proto directory to the proto directory of this
+/// crate.
 fn copy_proto_files() -> miette::Result<()> {
-    let src_file = format!("{REPO_PROTO_DIR}/api.proto");
-    let dest_file = format!("{CRATE_PROTO_DIR}/api.proto");
+    let src_file = format!("{REPO_PROTO_DIR}/tx_prover.proto");
+    let dest_file = format!("{CRATE_PROTO_DIR}/tx_prover.proto");
 
     fs::remove_dir_all(CRATE_PROTO_DIR).into_diagnostic()?;
     fs::create_dir_all(CRATE_PROTO_DIR).into_diagnostic()?;
@@ -50,14 +51,14 @@ fn compile_tonic_server_proto() -> miette::Result<()> {
         PathBuf::from(env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR should be set"));
     let dst_dir = crate_root.join("src").join("generated");
 
-    // Remove `api.rs` if it exists.
-    fs::remove_file(dst_dir.join("api.rs")).into_diagnostic().ok();
+    // Remove `tx_prover.rs` if it exists.
+    fs::remove_file(dst_dir.join("tx_prover.rs")).into_diagnostic().ok();
 
     let out_dir = env::var("OUT_DIR").into_diagnostic()?;
     let file_descriptor_path = PathBuf::from(out_dir).join("file_descriptor_set.bin");
 
     let proto_dir: PathBuf = CRATE_PROTO_DIR.into();
-    let protos = &[proto_dir.join("api.proto")];
+    let protos = &[proto_dir.join("tx_prover.proto")];
     let includes = &[proto_dir];
 
     let file_descriptors = protox::compile(protos, includes)?;

bin/proving-service/proto/api.proto → bin/proving-service/proto/tx_prover.proto

@@ -1,6 +1,6 @@
 // Specification of the user facing gRPC API.
 syntax = "proto3";
-package api;
+package tx_prover;
 
 service Api {
     rpc ProveTransaction(ProveTransactionRequest) returns (ProveTransactionResponse) {}

bin/proving-service/src/generated/mod.rs

@@ -2,9 +2,9 @@ use miden_objects::transaction::ProvenTransaction;
 use miden_tx::utils::{Deserializable, DeserializationError, Serializable};
 
 #[rustfmt::skip]
-pub mod api;
+pub mod tx_prover;
 
-pub use api::*;
+pub use tx_prover::*;
 
 // CONVERSIONS
 // ================================================================================================

bin/proving-service/src/generated/api.rs → bin/proving-service/src/generated/tx_prover.rs

@@ -116,9 +116,12 @@ pub mod api_client {
                     )
                 })?;
             let codec = tonic::codec::ProstCodec::default();
-            let path = http::uri::PathAndQuery::from_static("/api.Api/ProveTransaction");
+            let path = http::uri::PathAndQuery::from_static(
+                "/tx_prover.Api/ProveTransaction",
+            );
             let mut req = request.into_request();
-            req.extensions_mut().insert(GrpcMethod::new("api.Api", "ProveTransaction"));
+            req.extensions_mut()
+                .insert(GrpcMethod::new("tx_prover.Api", "ProveTransaction"));
             self.inner.unary(req, path, codec).await
         }
     }
@@ -220,7 +223,7 @@ pub mod api_server {
         }
         fn call(&mut self, req: http::Request<B>) -> Self::Future {
             match req.uri().path() {
-                "/api.Api/ProveTransaction" => {
+                "/tx_prover.Api/ProveTransaction" => {
                     #[allow(non_camel_case_types)]
                     struct ProveTransactionSvc<T: Api>(pub Arc<T>);
                     impl<
@@ -298,7 +301,7 @@ pub mod api_server {
         }
     }
     /// Generated gRPC service name
-    pub const SERVICE_NAME: &str = "api.Api";
+    pub const SERVICE_NAME: &str = "tx_prover.Api";
     impl<T> tonic::server::NamedService for ApiServer<T> {
         const NAME: &'static str = SERVICE_NAME;
     }

crates/miden-proving-service-client/build.rs

@@ -34,10 +34,11 @@ fn main() -> miette::Result<()> {
 // HELPER FUNCTIONS
 // ================================================================================================
 
-/// Copies all api.proto file from the root proto directory to the proto directory of this crate.
+/// Copies the tx_prover.proto file from the root proto directory to the proto directory of this
+/// crate.
 fn copy_proto_files() -> miette::Result<()> {
-    let src_file = format!("{REPO_PROTO_DIR}/api.proto");
-    let dest_file = format!("{CRATE_PROTO_DIR}/api.proto");
+    let src_file = format!("{REPO_PROTO_DIR}/tx_prover.proto");
+    let dest_file = format!("{CRATE_PROTO_DIR}/tx_prover.proto");
 
     fs::remove_dir_all(CRATE_PROTO_DIR).into_diagnostic()?;
     fs::create_dir_all(CRATE_PROTO_DIR).into_diagnostic()?;
@@ -51,14 +52,14 @@ fn compile_tonic_client_proto() -> miette::Result<()> {
         PathBuf::from(env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR should be set"));
     let dst_dir = crate_root.join("src").join("tx_prover").join("generated");
 
-    // Remove `api.rs` if it exists.
-    fs::remove_file(dst_dir.join("api.rs")).into_diagnostic().ok();
+    // Remove `tx_prover.rs` if it exists.
+    fs::remove_file(dst_dir.join("tx_prover.rs")).into_diagnostic().ok();
 
     let out_dir = env::var("OUT_DIR").into_diagnostic()?;
     let file_descriptor_path = PathBuf::from(out_dir).join("file_descriptor_set.bin");
 
     let proto_dir: PathBuf = CRATE_PROTO_DIR.into();
-    let protos = &[proto_dir.join("api.proto")];
+    let protos = &[proto_dir.join("tx_prover.proto")];
     let includes = &[proto_dir];
 
     let file_descriptors = protox::compile(protos, includes)?;
@@ -70,9 +71,9 @@ fn compile_tonic_client_proto() -> miette::Result<()> {
     build_tonic_client(&file_descriptor_path, &std_path, protos, includes, false)?;
     build_tonic_client(&file_descriptor_path, &nostd_path, protos, includes, true)?;
 
-    // Replace `std` references with `core` and `alloc` in `api.rs`.
+    // Replace `std` references with `core` and `alloc` in `tx_prover.rs`.
     // (Only for nostd version)
-    let nostd_file_path = nostd_path.join("api.rs");
+    let nostd_file_path = nostd_path.join("tx_prover.rs");
     let file_content = fs::read_to_string(&nostd_file_path).into_diagnostic()?;
     let updated_content = file_content
         .replace("std::result", "core::result")

proto/api.proto → crates/miden-proving-service-client/proto/tx_prover.proto

@@ -1,6 +1,6 @@
 // Specification of the user facing gRPC API.
 syntax = "proto3";
-package api;
+package tx_prover;
 
 service Api {
     rpc ProveTransaction(ProveTransactionRequest) returns (ProveTransactionResponse) {}

crates/miden-proving-service-client/src/lib.rs

@@ -16,7 +16,7 @@ use thiserror::Error;
 pub mod tx_prover;
 
 /// Protobuf definition for the Miden proving service
-pub const SERVICE_PROTO: &str = include_str!("../proto/api.proto");
+pub const TX_PROVER_PROTO: &str = include_str!("../proto/tx_prover.proto");
 
 /// ERRORS
 /// ===============================================================================================

crates/miden-proving-service-client/src/tx_prover/generated/mod.rs

@@ -7,12 +7,12 @@ compile_error!("The `std` feature cannot be used when targeting `wasm32`.");
 #[cfg(feature = "std")]
 mod std;
 #[cfg(feature = "std")]
-pub use std::api::*;
+pub use std::tx_prover::*;
 
 #[cfg(not(feature = "std"))]
 mod nostd;
 #[cfg(not(feature = "std"))]
-pub use nostd::api::*;
+pub use nostd::tx_prover::*;
 
 // CONVERSIONS
 // ================================================================================================

crates/miden-proving-service-client/src/tx_prover/generated/nostd/mod.rs

@@ -1,2 +1,2 @@
 #[rustfmt::skip]
-pub mod api;
+pub mod tx_prover;

crates/miden-proving-service-client/src/tx_prover/generated/nostd/api.rs → crates/miden-proving-service-client/src/tx_prover/generated/nostd/tx_prover.rs

@@ -105,9 +105,12 @@ pub mod api_client {
                     )
                 })?;
             let codec = tonic::codec::ProstCodec::default();
-            let path = http::uri::PathAndQuery::from_static("/api.Api/ProveTransaction");
+            let path = http::uri::PathAndQuery::from_static(
+                "/tx_prover.Api/ProveTransaction",
+            );
             let mut req = request.into_request();
-            req.extensions_mut().insert(GrpcMethod::new("api.Api", "ProveTransaction"));
+            req.extensions_mut()
+                .insert(GrpcMethod::new("tx_prover.Api", "ProveTransaction"));
             self.inner.unary(req, path, codec).await
         }
     }

crates/miden-proving-service-client/src/tx_prover/generated/std/mod.rs

@@ -1,2 +1,2 @@
 #[rustfmt::skip]
-pub mod api;
+pub mod tx_prover;

crates/miden-proving-service-client/src/tx_prover/generated/std/api.rs → crates/miden-proving-service-client/src/tx_prover/generated/std/tx_prover.rs

@@ -116,9 +116,12 @@ pub mod api_client {
                     )
                 })?;
             let codec = tonic::codec::ProstCodec::default();
-            let path = http::uri::PathAndQuery::from_static("/api.Api/ProveTransaction");
+            let path = http::uri::PathAndQuery::from_static(
+                "/tx_prover.Api/ProveTransaction",
+            );
             let mut req = request.into_request();
-            req.extensions_mut().insert(GrpcMethod::new("api.Api", "ProveTransaction"));
+            req.extensions_mut()
+                .insert(GrpcMethod::new("tx_prover.Api", "ProveTransaction"));
             self.inner.unary(req, path, codec).await
         }
     }

crates/miden-proving-service-client/proto/api.proto → proto/tx_prover.proto

@@ -1,6 +1,6 @@
 // Specification of the user facing gRPC API.
 syntax = "proto3";
-package api;
+package tx_prover;
 
 service Api {
     rpc ProveTransaction(ProveTransactionRequest) returns (ProveTransactionResponse) {}