From e4e7236cc0f24a62d79de0efebd291a16032934b Mon Sep 17 00:00:00 2001 From: Oliver Gugger Date: Fri, 5 Jun 2020 16:38:10 +0200 Subject: [PATCH] clmrpc: add README.md --- clmrpc/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 clmrpc/README.md diff --git a/clmrpc/README.md b/clmrpc/README.md new file mode 100644 index 0000000..4a0d0e9 --- /dev/null +++ b/clmrpc/README.md @@ -0,0 +1,17 @@ +# clmrpc + +This clmrpc package implements both a client (trader) and server (auctioneer) +for `subasta`s RPC system which is based off of the high-performance +cross-platform [gRPC](http://www.grpc.io/) RPC framework. By default, only the +Go client+server libraries are compiled within the package. In order to compile +the client side libraries for other supported languages, the `protoc` tool will +need to be used to generate the compiled protos for a specific language. + +For a list of supported languages for `clmrpc`, see +[grpc.io/docs/languages](https://grpc.io/docs/languages/). + +## Generate protobuf definitions + +Make sure you have the exact versions of all libraries installed as described +in [the lnrpc/README.md of lnd](https://github.com/lightningnetwork/lnd/blob/master/lnrpc/README.md#generate-protobuf-definitions) +then run the `make rpc` command.