ceremonyclient/node/protobufs/README.md
Marius Scurtescu a0659fec83
add -node-info command (#141)
* add version label and trim repo url

* add README for protobufs

* add version to NodeInfoResponse

* add docker login task

* remove version from docker compose file

* return version with GetNodeInfo response

* add basic -node-info flag

* print max frame as well with -node-info

* expand protobuf README

* update node command examples to use node binary and make log commands follow

* return all of NodeInfo

* extract FormatVersion

* print version of running process
2024-03-24 03:11:58 -05:00

25 lines
1.1 KiB
Markdown

The `protoc` ProtoBuf most be installed, currently version `3.21.12` is being used:
https://github.com/protocolbuffers/protobuf/releases/tag/v21.12
The versioning is rather confusing, described here:
https://protobuf.dev/support/version-support/
Most likely you want [https://github.com/protocolbuffers/protobuf/releases/download/v21.12/protoc-21.12-linux-x86_64.zip](https://github.com/protocolbuffers/protobuf/releases/download/v21.12/protoc-21.12-linux-x86_64.zip)
Very summary installation instructions are in an enclosed `readme,txt` file.
You can try to install from `apt` on Ubuntu, but you have no control on what exact version you are getting:
```shell
sudo apt install protobuf-compiler
```
Also install the following `protoc` plugins:
```shell
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.30.0
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.3.0
go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@v2.18.0
```
In order to rebuild the ProtoBuf interfaces, in case you make changes to any of the `*.proto` files,
run `make` in this folder.