Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 2.75 KB

README.md

File metadata and controls

65 lines (42 loc) · 2.75 KB
Raw

GoCryptoTrader gRPC Service

Build Status Software License GoDoc Coverage Status Go Report Card

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

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

Then use go get to download the following packages:

go get github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway
go get github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger
go get google.golang.org/protobuf/cmd/protoc-gen-go
go get google.golang.org/grpc/cmd/protoc-gen-go-grpc

This will place three binaries in your $GOBIN;

  • protoc-gen-grpc-gateway
  • protoc-gen-swagger
  • protoc-gen-go
  • protoc-gen-go-grpc

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