proto/

directory
v1.10.8-rc.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 28, 2023 License: BSD-3-Clause

README

Avalanche gRPC

Now Serving: Protocol Version 27

Protobuf files are hosted at https://buf.build/ava-labs/avalanche and can be used as dependencies in other projects.

Protobuf linting and generation for this project is managed by buf.

Please find installation instructions on https://docs.buf.build/installation/ or use Dockerfile.buf provided in the proto/ directory of AvalancheGo.

Any changes made to proto definition can be updated by running protobuf_codegen.sh located in the scripts/ directory of AvalancheGo.

Introduction to buf https://docs.buf.build/tour/introduction

Protocol Version Compatibility

The protobuf definitions and generated code are versioned based on the RPCChainVMProtocol defined for the RPCChainVM. Many versions of an Avalanche client can use the same RPCChainVMProtocol. But each Avalanche client and subnet vm must use the same protocol version to be compatible.

Publishing to Buf Schema Registry

  • Checkout appropriate tag in AvalancheGo git checkout v1.10.1
  • Change to proto/ directory cd proto.
  • Publish new tag to buf registry. buf push -t v26

Note: Publishing requires auth to the ava-labs org in buf https://buf.build/ava-labs/repositories

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL