Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 3.12 KB

README.md

File metadata and controls

70 lines (47 loc) · 3.12 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 install to download the following packages:

go install \
    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway \
    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2 \
    google.golang.org/protobuf/cmd/protoc-gen-go \
    google.golang.org/grpc/cmd/protoc-gen-go-grpc

This will place the following binaries in your $GOBIN;

  • protoc-gen-grpc-gateway
  • protoc-gen-openapiv2
  • protoc-gen-go
  • protoc-gen-go-grpc

Make sure that your $GOBIN is in your $PATH.

Linux / macOS / Windows

GoCryptoTrader requires a local installation of the buf cli tool that tries to make Protobuf handling more easier and reliable, after installation you'll need to run:

buf mod update

After previous command, make necessary changes to the rpc.proto spec file and run the generation command:

buf generate

If any changes were made, ensure that the rpc.proto file is formatted correctly by using buf format -w