github.com/MetalBlockchain/metalgo@v1.11.9/proto/README.md (about)

     1  # Metal Blockchain gRPC
     2  
     3  Now Serving: **Protocol Version 35**
     4  
     5  Protobuf files are hosted at
     6  [https://buf.build/metalblockchain/metalgo](https://buf.build/metalblockchain/metalgo) and
     7  can be used as dependencies in other projects.
     8  
     9  Protobuf linting and generation for this project is managed by
    10  [buf](https://github.com/bufbuild/buf).
    11  
    12  Please find installation instructions on
    13  [https://docs.buf.build/installation/](https://docs.buf.build/installation/).
    14  
    15  Any changes made to proto definition can be updated by running
    16  `protobuf_codegen.sh` located in the `scripts/` directory of AvalancheGo.
    17  
    18  Introduction to `buf`
    19  [https://docs.buf.build/tour/introduction](https://docs.buf.build/tour/introduction)
    20  
    21  ## Protocol Version Compatibility
    22  
    23  The protobuf definitions and generated code are versioned based on the
    24  [RPCChainVMProtocol](../version/version.go#L13) defined for the RPCChainVM.
    25  Many versions of an Avalanche client can use the same
    26  [RPCChainVMProtocol](../version/version.go#L13). But each Avalanche client and
    27  subnet vm must use the same protocol version to be compatible.
    28  
    29  ## Publishing to Buf Schema Registry
    30  
    31  - Checkout appropriate tag in MetalGo `git checkout v1.11.3`
    32  - Change to proto/ directory `cd proto`.
    33  - Publish new tag to buf registry. `buf push -t v26`
    34  
    35  Note: Publishing requires auth to the metalblockchain org in buf
    36  https://buf.build/metalblockchain/repositories