Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publishing Protobuf Definition Files #64

Conversation

nick-mobilecoin
Copy link
Contributor

@nick-mobilecoin nick-mobilecoin commented Mar 23, 2023

@nick-mobilecoin nick-mobilecoin self-assigned this Mar 23, 2023
@nick-mobilecoin nick-mobilecoin mentioned this pull request Mar 23, 2023
# Prior art
[prior-art]: #prior-art

None
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Up for suggestions here, I'm guessing there probably are some practices regarding protobuf publishing but I didn't find much doing a quick google. Probably looking for wrong terms

Comment on lines +126 to +127
├── messages.proto
└── services.proto
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently the attestation messages are in attestation.proto but in writing this up it seemed odd to have a services.proto and then a whatever.proto

Comment on lines +63 to +68
- [mc-*-grpcio](https://crates.io/search?q=mc-*-grpcio) for rust
[grpcio](https://docs.rs/grpcio/latest/grpcio/) services.
- [mc-*-messages](https://crates.io/search?q=mc-*-messages) for
[prost](https://docs.rs/prost/latest/prost/) messages.
- [mc-*-tonic](https://crates.io/search?q=mc-*-tonic) for
[tonic](https://docs.rs/tonic/latest/tonic/) services.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This naming is what we currently have in https://github.com/mobilecoinfoundation/protobufs, but I'm wondering if doing a namespacing grouping might be better

- mc-grpcio-*
- mc-messages-*
- mc-tonic-*

I also wonder about the "messages" is it too generic?

The MobileCoin Foundation Protobuf defintions are located at
<https://github.com/mobilecoinfoundation/protobufs>. When a series of git
changes are deemed ready to release, the new versions will be published to
<https://buf.build/mobilecoinfoundation> and crates published to <https://crates.io>.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note buf.build name. I think this was the name we had settled on. There is https://buf.build/mobilecoin but I recall we wanted "foundation" in the protobufs.

@nick-mobilecoin
Copy link
Contributor Author

Closing, we're currently focusing on other efforts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant