Support `cosmos-sdk-proto` without `transport` feature of `tonic` about cosmos-rust HOT 7 CLOSED

I opened a PR to add a grpc-transport feature: #230

We can potentially investigate moving to a build.rs-based approach, but I think that's a bigger decision than just this feature, and it wasn't too difficult to add on top of the pre-generated code.

from cosmos-rust.

There have been a few PRs that attempted to do this: #88 #90 #97 #157

It's a feature we're open to supporting, however none of the PRs actually implemented the functionality in such a way that avoided breaking non-WASM gRPC clients

from cosmos-rust.

I think the main reason for this is the use of git submodules to pull proto files. If we generate code for .proto files in build.rs, we can manage tonic and tonic-build features at compile time.

It is a bit difficult to do in current design because code for .proto files is generated by proto-build that doesn't know anything about compile time features of cosmos-sdk-proto. Also, we cannot generate code for .proto files in build.rs of cosmos-sdk-proto because we're using submodules and I'm not sure how that will work when someone adds cosmos-sdk-proto as their dependency and build it.

The right solution should be to include .proto files in comsos-sdk-proto's source and build Rust code using build.rs.

from cosmos-rust.

The downside of this (beyond longer build times) is protoc must be installed to compile the crate

I think the main reason for this is the use of git submodules to pull proto files.

Even if we did move to a build.rs-based approach, we would still need to vendor the proto files into the crate somehow, similar to how the generated code is currently vendored, and that requires a source of truth for the protos, which is currently a 3rd party git repository (i.e. cosmos-sdk)

Whether or not we use a git submodule to do that seems orthogonal, but also, given that requirement I'm not sure what approach would be better than a git submodule.

from cosmos-rust.

protoc must be installed to compile the crate

prost-build builds it if it is not installed.

Even if we did move to a build.rs-based approach, we would still need to vendor the proto files into the crate somehow, similar to how the generated code is currently vendored, and that requires a source of truth for the protos, which is currently a 3rd party git repository (i.e. cosmos-sdk)

Yes. We'll have to include .proto files in crate sources. The problem with git submodules is that it pulls all the source code of the repository and we only need .proto files. It'll be better if we can only extract .proto files from git repository and include those in sources of cosmos-sdk-proto.

Whether or not we use a git submodule to do that seems orthogonal, but also, given that requirement I'm not sure what approach would be better than a git submodule.

One approach is that instead of having a proto-build crate, just create a proto-copy script which copies .proto files from each git submodule to cosmos-sdk-proto based on configured versions. Then cosmos-sdk-proto's build.rs can generate rust code.

from cosmos-rust.

prost-build builds it if it is not installed.

It does? That must be new. Does it compile protoc from source, and if so, does that require an entire C++ toolchain must be present? If so, that still seems bad.

One approach is that instead of having a proto-build crate, just create a proto-copy script which copies .proto files from each git submodule to cosmos-sdk-proto based on configured versions. Then cosmos-sdk-proto's build.rs can generate rust code.

That sounds exactly like what I just described. Note that this approach does not get rid of the git submodule which is the source of truth for the protos. It just replaces copying the generated Rust code with copying the protos.

from cosmos-rust.

Here's what the prost-build docs say:

https://github.com/tokio-rs/prost/blob/master/prost-build/README.md

prost-build uses protoc to parse the proto files. There are a few ways to make protoc
available for prost-build.

The first option is to include protoc in your PATH this
can be done by following the protoc install instructions. In addition, its possible to
pass the PROTOC=<my/path/to/protoc> environment variable.

The second option is to provide the vendored feature flag to prost-build. This will
force prost-build to compile protoc from the bundled source. This will require that
you have the correct dependencies installed include a C++ toolchain, cmake, etc. For
more info on what the required dependencies are check here.

...so there is a vendored option we could enable, but it would require compiling protoc from source, which would add considerably to compile times and requires an entire C++ toolchain is available

from cosmos-rust.