Typescript protobuf generation

akash-network / support

Akash Support and Issue Tracking

5 stars 3 forks source link

Typescript protobuf generation #184

Closed baktun14 closed 1 month ago

baktun14 commented 4 months ago

Is your feature request related to a problem? Please describe.

The typescript protobuf generation are currently done in akashjs, while the go ones are done in akash-api. We need to centralize the logic of generating the protobuf types for multiple languages in the same repo (akash-api).

Describe the solution you'd like

Move from akashjs and write a script/procedure to generate the typescript types
Build a npm package from the generated protobuf types
Import that npm package in akashjs

Describe alternatives you've considered

This is the best we got!

Search

[X] I did search for other open and closed issues before opening this

Code of Conduct

[X] I agree to follow this project's Code of Conduct

Additional context

No response

baktun14 commented 4 months ago

For rust: #176

baktun14 commented 3 months ago

We will probably use Buf https://github.com/bufbuild/buf in favor or ts-proto (to be verified)
Npm package: Must expose all the protobuf types generated + typeregistry + gprc client
- Suggested name? (tbd) @akashnetwork/proto
Must fix DecCoin? Add tests to validate
- Original cosmos sdk issue: https://github.com/cosmos/cosmos-sdk/issues/10863
- https://github.com/akash-network/akashjs/pull/31
Generate grpc client

ygrishajev commented 3 months ago

atm some discussions are done, overall vision is being formed and some initial code has been pushed. Overall it's just started taking into account that I'm getting familiar with akash-api code.

baktun14 commented 3 months ago

Also this commit not sure. cc @Redm4x

brewsterdrinkwater commented 2 months ago

April 30th, 2024:

Some issues came up last week. New PR is pending to solve issues.

ygrishajev commented 2 months ago

Appeared cloudmos indexer is using code generation for connectrpc. Had to adjust akash-api code generation to later use common implementation in the indexer https://github.com/akash-network/akash-api/pull/158

ygrishajev commented 2 months ago

Another issue: akashjs still needs some deprecated generated code for cloudmos. So I'm going to move it to akash-api too to keep separation of concerns proper. After all this is a common thing that some archived types might be needed. Akash-api makes it a logical location for those

ygrishajev commented 1 month ago

All the tech implementation is done. It's uncovered though that there are examples that should also be updated as some community members struggle with the implementation.

ygrishajev commented 1 month ago

this issue can be closed now