@sangaman/xud/proto/README.md

Exchange Union Daemon

# Xud Protocol Buffers

`Xud` uses [Protocol Buffers](https://developers.google.com/protocol-buffers/) to define its [gRPC](https://grpc.io/) API service layer. This definition can be used to generate `Xud` clients in many popular programming languages.

## Updating the Xud Proto Defintion

Whenever `xudrpc.proto` is updated, the protobuf javascript code and type definitions must be regenerated.

1. Install [Go](https://golang.org/doc/install) and add it to your PATH.

2. Install [protoc-gen-swagger](https://github.com/grpc-ecosystem/grpc-gateway):

    ```bash
    go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger
    ```

3. Install [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc):

   ```bash
   go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc
   ```

4. Run `npm run proto`.