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

feat: use Buf for proto generation #359

Merged

Conversation

johnletey
Copy link
Contributor

@johnletey johnletey commented Mar 24, 2023

1. Summary

This PR includes a full migration over to Buf for Protobuf generation.

2.Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

3. Implementation details

I make full use of the BSR (Buf Schema Registry), removing the need for all third_party Protobuf files.

You can automatically generate Protobuf using Buf, however we need to install a few Cosmos goodies in order to correctly generate everything. For cleanliness sake, this is done via a Dockerfile.

I've also included automatic Swagger API generation for all Quicksilver specific transactions and queries.

4. How to test/use

To setup the Docker image locally, simply run make proto-setup. This will initialise the quicksilver-proto image.

To use the updated Protobuf generation, simply run the make proto-gen or make proto-all commands.

5. Checklist

  • Does the Readme need to be updated?

6. Limitations (optional)

7. Future Work (optional)

@aljo242 aljo242 added the enhancement New feature or request label Mar 24, 2023
Copy link
Contributor

@joe-bowman joe-bowman left a comment

Choose a reason for hiding this comment

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

lgtm, thanks John!

@joe-bowman joe-bowman merged commit 98004f6 into quicksilver-zone:develop Mar 24, 2023
aljo242 pushed a commit that referenced this pull request Mar 24, 2023
@aljo242
Copy link

aljo242 commented Mar 24, 2023

@johnletey It looks like the make proto-setup target is not actually added in this PR. Could you open a new one adding this bit?

joe-bowman pushed a commit that referenced this pull request Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants