proto/

directory
v0.0.7 Latest Latest
Warning

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

Go to latest
Published: Jul 12, 2024 License: BSD-3-Clause

README

Odyssey gRPC

Now Serving: Protocol Version 28

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 OdysseyGo.

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

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 Odyssey client can use the same RPCChainVMProtocol. But each Odyssey client and subnet vm must use the same protocol version to be compatible.

Publishing to Buf Schema Registry

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

Jump to

Keyboard shortcuts

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