GlcoinCore/pool
1
0
Fork 0
mirror of https://github.com/lightninglabs/pool.git synced 2026-08-17 13:06:52 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

clmrpc: add README.md

Browse source
This commit is contained in:
Oliver Gugger 2020-06-05 16:38:10 +02:00
parent 69ebc705e8
commit e4e7236cc0
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
clmrpc/README.md Normal file
View file

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