mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-13 23:16:45 +00:00
ec0ed1c1e5
* Add basic docs for gRPC/gctcli/unified API and a few markdown fixes * Update patherinos and spacing fixes * Consistent namerinos * Fix spelling mistakes * Add fancy headers * Uperaterinos * Fix feedback nitterinos
64 lines
2.7 KiB
Markdown
64 lines
2.7 KiB
Markdown
# GoCryptoTrader gRPC Service
|
|
|
|
<img src="https://github.com/thrasher-corp/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70">
|
|
|
|
[](https://travis-ci.com/thrasher-corp/gocryptotrader)
|
|
[](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE)
|
|
[](https://godoc.org/github.com/thrasher-corp/gocryptotrader)
|
|
[](http://codecov.io/github/thrasher-corp/gocryptotrader?branch=master)
|
|
[](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader)
|
|
|
|
A cryptocurrency trading bot supporting multiple exchanges written in Golang.
|
|
|
|
**Please note that this bot is under development and is not ready for production!**
|
|
|
|
## Community
|
|
|
|
Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://join.slack.com/t/gocryptotrader/shared_invite/enQtNTQ5NDAxMjA2Mjc5LTc5ZDE1ZTNiOGM3ZGMyMmY1NTAxYWZhODE0MWM5N2JlZDk1NDU0YTViYzk4NTk3OTRiMDQzNGQ1YTc4YmRlMTk)
|
|
|
|
## Background
|
|
|
|
GoCryptoTrader utilises gRPC for client/server interaction. Authentication is done
|
|
by a self signed TLS cert, which only supports connections from localhost and also
|
|
through basic authorisation specified by the users config file.
|
|
|
|
GoCryptoTrader also supports a gRPC JSON proxy service for applications which can
|
|
be toggled on or off depending on the users preference.
|
|
|
|
## Installation
|
|
|
|
GoCryptoTrader requires a local installation of the Google protocol buffers
|
|
compiler `protoc` v3.0.0 or above. Please install this via your local package
|
|
manager or by downloading one of the releases from the official repository:
|
|
|
|
[protoc releases](https://github.com/protocolbuffers/protobuf/releases)
|
|
|
|
Then use `go get -u` to download the following packages:
|
|
|
|
```bash
|
|
go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway
|
|
go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger
|
|
go get -u github.com/golang/protobuf/protoc-gen-go
|
|
```
|
|
|
|
This will place three binaries in your `$GOBIN`;
|
|
|
|
* `protoc-gen-grpc-gateway`
|
|
* `protoc-gen-swagger`
|
|
* `protoc-gen-go`
|
|
|
|
Make sure that your `$GOBIN` is in your `$PATH`.
|
|
|
|
## Usage
|
|
|
|
After the above dependencies are required, make necessary changes to the `rpc.proto`
|
|
spec file and run the generation scripts:
|
|
|
|
### Windows
|
|
|
|
Run `gen_pb_win.bat`
|
|
|
|
### Linux and macOS
|
|
|
|
Run `./gen_pb_linux.sh`
|