Skip to content

Commit

Permalink
Updated README to include buf dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
codebycarson committed Oct 1, 2024
1 parent a265914 commit b9c6449
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion packages/cosmos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,4 +196,8 @@ if (result.code === 0) {
The `@sei-js/cosmos/` package provides a REST client for the Sei chain. It is built on top of `@cosmjs/rest` and provides a more user-friendly interface for interacting with the Sei chain. It supports all Sei cosmos RPC endpoints and provides a more user-friendly interface for querying a Sei chain.

## Development
This package is generated using buf.build. To regenerate the types, run `yarn generate` which builds the types from proto files with the buf build `ts-proto` plugin. From there, typescript is used in a postprocessing script to extract the necessary types and perform any formatting required.

### Pre-requisites
- Buf installed on your machine. https://buf.build/docs/installation

This package is generated using buf.build. To regenerate the types, run `yarn generate` which builds the types from proto files with the buf build `ts-proto` and `protoc-gen-grpc-gateway-ts` plugins. From there, typescript is used in a postprocessing script to extract the necessary types and perform any formatting required.

0 comments on commit b9c6449

Please sign in to comment.