feat: use Buf for proto generation #359
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
1. Summary
This PR includes a full migration over to Buf for Protobuf generation.
2.Type of change
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 thequicksilver-proto
image.To use the updated Protobuf generation, simply run the
make proto-gen
ormake proto-all
commands.5. Checklist
6. Limitations (optional)
7. Future Work (optional)