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

make akash-api a SDK #224

Open
31 of 40 tasks
troian opened this issue May 13, 2024 · 3 comments
Open
31 of 40 tasks

make akash-api a SDK #224

troian opened this issue May 13, 2024 · 3 comments
Assignees
Labels

Comments

@troian
Copy link
Member

troian commented May 13, 2024

NOTE This issue description will be updated within next few weeks

Refactor Akash-API layout

Restructure akash-api layout

Restructuring is being done within sdk-47 branch

  • migrate protobuf generation to use buf @troian
    • split proto code-generation into language targets @troian
    • proto-gen-go
    • proto-gen-ts
    • proto-gen-doc
  • migrate all proto files to Cosmos-SDK v0.47.x (at time of writing v0.47.11) @troian
    • - split proto/akash/node/base in to
      • attributes as v1
      • resources as v1beta4
      • implement migrations @troian
    • make proto/akash/node/audit as v1
    • - make proto/akash/node/cert as v1
    • - split proto/akash/node/deployment
      • - types depending on resources as v1beta4
      • - rest as v1
      • implement migrations @troian
      • migrate params store @troian
    • - split proto/akash/node/market
      • - types depending on resources and deployment as v1beta5
      • - rest as v1
      • implement migrations @troian
      • migrate params store @troian
    • - make proto/akash/node/escrow as v1
    • - make proto/akash/node/take as v1
    • - make proto/akash/node/provider as v1beta4
    • - remove proto/akash/node/gov as cosmos-sdk v0.47.x has implemented min deposit for governance proposal.

Golang

  • Create vanity domain for akash packages (pkg.akt.dev) @troian
  • set Go root vanity url to pkg.akt.dev/go @troian]
  • migrate SDL from node to github.com/akash-network/akash-api/sdk/sdl
    - [ ] declare it as module pkg.akt.dev/go/sdl @troian
  • copy all tx/query commands from node and cosmos-sdk under cli dir. This will become reference implementation of the CLI @troian
  • provide client examples @troian @chainzero

TS

@troian troian self-assigned this May 13, 2024
@troian troian changed the title improve developers workflow make akash-api a SDK May 13, 2024
@github-project-automation github-project-automation bot moved this to Backlog (not prioritized) in Core Product and Engineering Roadmap May 14, 2024
@brewsterdrinkwater brewsterdrinkwater moved this from Backlog (not prioritized) to In Progress (prioritized) in Core Product and Engineering Roadmap May 14, 2024
@brewsterdrinkwater brewsterdrinkwater added this to the Engineering 2024 milestone May 14, 2024
@anilmurty
Copy link

Just a note that we have 3-4 customers using the API to integrate their platforms today (Solve Care, Brev, Prime-Intellect in production + a bunch that are planning to integrate). So we have to ensure the API changes are backward compatible or bump the major version and communicate to the customers and ensure they can migrate to the new version, before we release.

@troian troian added P0 and removed P2 labels Jul 16, 2024
@brewsterdrinkwater
Copy link
Collaborator

July 16th, 2024:

This will be optimized for teams/ individuals that want to integrate with the Akash Network.

  • Goal is to make it a single entry point for developers.

@brewsterdrinkwater
Copy link
Collaborator

July 23rd:

  • documentation to be added for Akashsdk after some more testing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: In Progress (prioritized)
Development

No branches or pull requests

4 participants