akash-api

README

Akash API

Overview

This repository consolidates gRPC API definitions for the Akash Node and Akash Provider. It also includes related code generation.

Currently, two buf packages are defined, with potential future publication to BSR based on demand:

• Node Package: buf.build/akash-network/node
  • Akash protobuf definitions, previously located in the proto directory, are now under proto/node/akash.
  • Generated code is available here.
• Provider Package: buf.build/akash-network/provider
  • Akash manifest definitions, previously defined as plain Go structs, have been converted into Protobuf definitions.

Proto documentation is available for:

• Node
• Provider

Contributing

Please submit issues via the support repository and tag them with repo/akash-api. All pull requests must be associated with an open issue in the support repository.

Releases

Releases indicate changes to the repository itself. API versions are defined within each module.

Pre-generated Packages

We provide generated code to allow developers to focus on features rather than stub generation:

• Go
• TS

How to run protobuf codegen

If there is a need to run regenerate protobuf (in case of API or documentation changes):

1. Install direnv and hook it to the shell

   • MacOS

   brew install make direnv
   

2. Allow direnv within project

   direnv allow
   

3. Run codegen. This will

   • Install all required tools into local cache
   • generate changes for both Go and TS packages.

   make proto-gen