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

Bundle @buf interfaces into Protobuf #1483

Closed
VanishMax opened this issue Jul 16, 2024 · 0 comments · Fixed by #1624
Closed

Bundle @buf interfaces into Protobuf #1483

VanishMax opened this issue Jul 16, 2024 · 0 comments · Fixed by #1624
Assignees

Comments

@VanishMax
Copy link
Contributor

It is hard to track the @buf package versions. If not the IDE import substitutions, I would never learn the path from which I should import common things like Metadata, Address, BalancesResponse, etc.

It would be way easier to have only one entry point for such interfaces and @penumbra-zone/protobuf package is the great fit for it. We could improve two things at once:

  1. Bundle the specific version of the @buf/... into a specific version of @penumbra-zone/protobuf. There won't be a need to separately install @buf packages by consumers and no more need to configure the @buf registry
  2. Make the imports straightforward and only from one place

I don't have the exact solution on how to structure the protobuf package. One option is to put the interfaces next to the services it is used within. For example, Metadata is used in the ViewService, so it could be placed in @penumbra-zone/protobuf/view-service

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
2 participants