-
Notifications
You must be signed in to change notification settings - Fork 359
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
Rename Raw types into Proto types #423
Comments
Is now a good time for me to go for this one? It could create some pretty bad merge conflicts if other big PRs are currently being worked on. |
This issue is mostly aesthetic and for resolving a drift in our terminology. I would be in favor of going forward with the modifications, it would be nice to have this sometime before v1. That being said, I had a closer look through the codebase and we never define any domain type to have the 'raw' prefix. We only rename upon importing various protobuf-types, example: We also use it as an associated type in a case: But for the most part, the 'raw' prefix appears peppered in our error subtypes, example:
I agree working on this can bring significant conflicts, so let's try to be mindful of critical PRs on the modules side, in particular this one: https://github.com/informalsystems/ibc-rs/pull/1838. It would be a good idea to work on the present issue after we're done merging #1838. |
Closing as stale. |
Crate
mostly
ibc
Summary
Looking at the code now that this new
Protobuf
type is kicking in, I'm wondering if we should not adapt our practice of calling serialization types with the "Raw" prefix. Instead, we could use the "Proto" prefix or something similar. So for example we'd have the following:instead of
https://github.com/informalsystems/ibc-rs/blob/9963c4a0f275eef401dcefa6b0f159dda93fe2b4/modules/src/ics02_client/raw.rs#L18
The idea is to make the connection between
tendermint_proto::Protobuf
and the underlying type more explicit. It's mostly aesthetics, but might make the codebase simpler to read & understand.Originally posted by @adizere in informalsystems/ibc-rs#364 (comment)
For Admin Use
The text was updated successfully, but these errors were encountered: