Skip to content

Latest commit

 

History

History
 
 

btrpc

README.md

GoCryptoTrader Backtester: Btrpc package

Build Status Software License GoDoc Coverage Status Go Report Card

This btrpc package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progress on our GoCryptoTrader Kanban board.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Btrpc overview

The GoCryptoTrader Backtester 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.

The GoCryptoTrader Backtester also supports a gRPC JSON proxy service for applications which can be toggled on or off depending on the users preference. This can be found in your config file under grpcProxyEnabled grpcProxyListenAddress. See btrpc.swagger.json for endpoint definitions

Installation

The GoCryptoTrader Backtester 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

The GoCryptoTrader Backtester 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

Please click GoDocs chevron above to view current GoDoc information for this package

Contribution

Please feel free to submit any pull requests or suggest any desired features to be added.

When submitting a PR, please abide by our coding guidelines:

  • Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
  • Code must be documented adhering to the official Go commentary guidelines.
  • Code must adhere to our coding style.
  • Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc