Mirroristas/kaspad
2
0
Fork 0
mirror of https://github.com/kaspanet/kaspad.git synced 2025-03-30 15:08:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
kaspad/infrastructure/network/netadapter/server/grpcserver/protowire/README.md
stasatdaglabs 541205904e
Add RPC documentation (#1379) 
* Split messages.proto to p2p and rpc.

* Split messages.proto to p2p and rpc.

* Write a short intro to the RPC docs.

* Start documenting RPC calls.

* Use a custom protoc-gen-doc.

* Continue writing RPC documentation.

* Finish writing RPC documentation.

* Fix a formatting error.

* Fix merge errors.

* Fix formatting into protowire/README.md.

* Rerun go generate ..

Co-authored-by: Ori Newman <orinewman1@gmail.com>
2021-01-07 16:55:47 +02:00

528 B
Raw Blame History

protowire

  1. Download and place in your PATH: https://github.com/protocolbuffers/protobuf/releases/download/v3.12.3/protoc-3.12.3-linux-x86_64.zip
  2. go get github.com/golang/protobuf/protoc-gen-go
  3. go get google.golang.org/grpc/cmd/protoc-gen-go-grpc
  4. In the protowire directory: go generate .

Documentation

To generate rpc.md:

  1. go get -u github.com/kaspanet/protoc-gen-doc/cmd/protoc-gen-doc
  2. In the protowire directory: protoc --doc_out=. --doc_opt=markdown,rpc.md rpc.proto