Feature-gate generated tonic transport code behind transport feature (

#238)

* code changes for no-transport option

* new protobuf generated with no-transport

* fmt

* Add changelog entry

---------

Co-authored-by: David Komer <6406986+dakom@users.noreply.github.com>
Co-authored-by: Romain Ruetschi <romain@informal.systems>

.changelog/unreleased/features/237-transport-feature.md

@@ -0,0 +1,2 @@
+- Feature-gate generated `tonic` transport code behind `transport` feature
+  ([\#237](https://github.com/cosmos/ibc-proto-rs/issues/237))

Cargo.toml

@@ -51,12 +51,13 @@ default-features = false
 serde_json = "1.0.107"
 
 [features]
-default            = ["std", "client"]
+default            = ["std", "client", "transport"]
+transport          = ["tonic/transport", "cosmos-sdk-proto/grpc-transport"]
 std                = ["cosmos-sdk-proto/std", "prost/std", "bytes/std", "subtle-encoding/std", "base64/std", "flex-error/std", "ics23/std", "informalsystems-pbjson/std"]
 serde              = ["dep:serde", "dep:informalsystems-pbjson", "ics23/serde", "cosmos-sdk-proto/serde"]
-client             = ["std", "dep:tonic", "tonic/codegen", "tonic/transport", "tonic/prost", "cosmos-sdk-proto/grpc-transport"]
+client             = ["std", "dep:tonic", "tonic/codegen", "tonic/prost"]
 json-schema        = ["std", "serde", "dep:schemars"]
-server             = ["std", "dep:tonic", "tonic/codegen", "tonic/transport", "tonic/prost"]
+server             = ["std", "dep:tonic", "tonic/codegen", "tonic/prost"]
 parity-scale-codec = ["tendermint-proto/parity-scale-codec"]
 borsh              = ["tendermint-proto/borsh"]
 proto-descriptor   = []

scripts/sync-protobuf.sh

@@ -133,43 +133,66 @@ popd
 # so that the newly generated code does not
 # contain removed files.
 
-rm -rf src/prost
-mkdir -p src/prost
+PROST_TRANSPORT_DIR="prost-transport"
+PROST_NO_TRANSPORT_DIR="prost-no-transport"
+
+rm -rf "src/$PROST_TRANSPORT_DIR"
+rm -rf "src/$PROST_NO_TRANSPORT_DIR"
+mkdir -p "src/$PROST_TRANSPORT_DIR"
+mkdir -p "src/$PROST_NO_TRANSPORT_DIR"
 
 cd tools/proto-compiler
 
 cargo build
 
 # Run the proto-compiler twice,
-# once for std version with --build-tonic set to true
-# and once for no-std version with --build-tonic set to false
+# once with transport and once without
+
+
+cargo run -- compile \
+  --transport \
+  --ics "$COSMOS_ICS_DIR/proto-include" \
+  --ibc "$IBC_GO_DIR/proto-include" \
+  --nft "$NFT_TRANSFER_DIR/proto-include" \
+  --out "../../src/$PROST_TRANSPORT_DIR"
 
 cargo run -- compile \
   --ics "$COSMOS_ICS_DIR/proto-include" \
   --ibc "$IBC_GO_DIR/proto-include" \
   --nft "$NFT_TRANSFER_DIR/proto-include" \
-  --out ../../src/prost
+  --out "../../src/$PROST_NO_TRANSPORT_DIR"
 
 cd ../..
 
 # Remove generated ICS23 code because it is not used,
 # we instead re-exports the `ics23` crate type definitions.
-rm -f src/prost/cosmos.ics23.v1.rs
+rm -f "src/$PROST_TRANSPORT_DIR/cosmos.ics23.v1.rs"
+rm -f "src/$PROST_NO_TRANSPORT_DIR/cosmos.ics23.v1.rs"
 
 # Remove leftover Cosmos SDK modules.
-rm -f src/prost/cosmos.base.store.v1beta1.rs
-rm -f src/prost/cosmos.auth.v1beta1.rs
-rm -f src/prost/cosmos.base.query.v1beta1.rs
-rm -f src/prost/cosmos.base.v1beta1.rs
-rm -f src/prost/cosmos.staking.v1beta1.rs
-rm -f src/prost/cosmos.upgrade.v1beta1.rs
-rm -f src/prost/cosmos_proto.rs
+rm -f "src/$PROST_TRANSPORT_DIR/cosmos.base.store.v1beta1.rs"
+rm -f "src/$PROST_TRANSPORT_DIR/cosmos.auth.v1beta1.rs"
+rm -f "src/$PROST_TRANSPORT_DIR/cosmos.base.query.v1beta1.rs"
+rm -f "src/$PROST_TRANSPORT_DIR/cosmos.base.v1beta1.rs"
+rm -f "src/$PROST_TRANSPORT_DIR/cosmos.staking.v1beta1.rs"
+rm -f "src/$PROST_TRANSPORT_DIR/cosmos.upgrade.v1beta1.rs"
+rm -f "src/$PROST_TRANSPORT_DIR/cosmos_proto.rs"
+
+rm -f "src/$PROST_NO_TRANSPORT_DIR/cosmos.base.store.v1beta1.rs"
+rm -f "src/$PROST_NO_TRANSPORT_DIR/cosmos.auth.v1beta1.rs"
+rm -f "src/$PROST_NO_TRANSPORT_DIR/cosmos.base.query.v1beta1.rs"
+rm -f "src/$PROST_NO_TRANSPORT_DIR/cosmos.base.v1beta1.rs"
+rm -f "src/$PROST_NO_TRANSPORT_DIR/cosmos.staking.v1beta1.rs"
+rm -f "src/$PROST_NO_TRANSPORT_DIR/cosmos.upgrade.v1beta1.rs"
+rm -f "src/$PROST_NO_TRANSPORT_DIR/cosmos_proto.rs"
 
 # The Tendermint ABCI protos are unused from within ibc-proto
-rm -f src/prost/tendermint.abci.rs
+rm -f "src/$PROST_TRANSPORT_DIR/tendermint.abci.rs"
+rm -f "src/$PROST_NO_TRANSPORT_DIR/tendermint.abci.rs"
 
 # Remove leftover Google HTTP configuration protos.
-rm -f src/prost/google.api.rs
+rm -f "src/$PROST_TRANSPORT_DIR/google.api.rs"
+rm -f "src/$PROST_NO_TRANSPORT_DIR/google.api.rs"
 
 # Remove the temporary checkouts of the repositories
 rm -rf "$COSMOS_ICS_DIR"

src/lib.rs

@@ -18,9 +18,18 @@ extern crate alloc;
 extern crate core as std;
 
 #[macro_export]
+#[cfg(not(feature = "transport"))]
 macro_rules! include_proto {
     ($path:literal) => {
-        include!(concat!("prost/", $path));
+        include!(concat!("prost-no-transport/", $path));
+    };
+}
+
+#[macro_export]
+#[cfg(feature = "transport")]
+macro_rules! include_proto {
+    ($path:literal) => {
+        include!(concat!("prost-transport/", $path));
     };
 }
 
@@ -34,8 +43,10 @@ pub const INTERCHAIN_SECURITY_COMMIT: &str = include_str!("INTERCHAIN_SECURITY_C
 pub const NFT_TRANSFER_COMMIT: &str = include_str!("NFT_TRANSFER_COMMIT");
 
 /// File descriptor set of compiled proto.
-#[cfg(feature = "proto-descriptor")]
-pub const FILE_DESCRIPTOR_SET: &[u8] = include_bytes!("prost/proto_descriptor.bin");
+#[cfg(all(feature = "proto-descriptor", feature = "transport"))]
+pub const FILE_DESCRIPTOR_SET: &[u8] = include_bytes!("prost-transport/proto_descriptor.bin");
+#[cfg(all(feature = "proto-descriptor", not(feature = "transport")))]
+pub const FILE_DESCRIPTOR_SET: &[u8] = include_bytes!("prost-no-transport/proto_descriptor.bin");
 
 // Re-export Cosmos SDK protos from the `cosmos_sdk_proto` crate
 pub use cosmos_sdk_proto::cosmos;