Files
gocryptotrader/README.md
Ryan O'Hara-Reid 4e828a8124 (Exchanges) Introduce validation method and small updates (#565)
* Remove pointer reference

* Fix portfolio withdraw tests

* Add nil protection in validator method to reduce prospective panics and for future outbound checking

* Updated tests

* ch order var to not ref package

* rm comparison

* Add order ID validation check

* Add exchange name validation check

* Add in test details

* fix tests

* fix linter issues

* linter issues strikes again

* linter rabbit hole

* Addr nitterinos

* Add validation variadic interface to define sets of functionality check POC

* didn't want to add an amount other than 0, didn't want to add address to exchange withdraw, didn't want to whitlist, can change if need be

* add coverage

* Add validation method options for exchange wrappers and abstracted validation into its own package

* Add validation code for structs in exchange template generation

* remove extra validation call as this is done in wrapper

* fix niterinos for examplerinos

* Add template to documentation tool and regenerated documentation

* Addr niticles

* Fix tests due to validation update

* Add more validation checks for modify/submit orders

* update tests

* fix more tests

* Add asset type to submit variable in tests and rpc call. Regen funcs.

* Add field to modify struct in tests

* applied field asset to cancel struct across project

* fix woopsy
2020-10-02 13:36:01 +10:00

8.3 KiB

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

Exchange Support Table

Exchange REST API Streaming API FIX API
Alphapoint Yes Yes NA
Binance Yes Yes NA
Bitfinex Yes Yes NA
Bitflyer Yes No NA
Bithumb Yes NA NA
BitMEX Yes Yes NA
Bitstamp Yes Yes No
Bittrex Yes No NA
BTCMarkets Yes No NA
BTSE Yes Yes NA
COINUT Yes Yes NA
Exmo Yes NA NA
FTX Yes Yes No
CoinbasePro Yes Yes No
Coinbene Yes No No
GateIO Yes Yes NA
Gemini Yes Yes No
HitBTC Yes Yes No
Huobi.Pro Yes Yes NA
ItBit Yes NA No
Kraken Yes Yes NA
Lbank Yes No NA
LakeBTC Yes No NA
LocalBitcoins Yes NA NA
OKCoin International Yes Yes No
OKEX Yes Yes No
Poloniex Yes Yes NA
Yobit Yes NA NA
ZB.COM Yes Yes NA

We are aiming to support the top 30 exchanges sorted by average liquidity as ranked by CoinMarketCap. However, we welcome pull requests for any exchange which does not match this criterion. If you need help with this, please join us on Slack.

** NA means not applicable as the exchange does not support the feature.

Current Features

  • Support for all exchange fiat and digital currencies, with the ability to individually toggle them on/off.
  • AES256 encrypted config file.
  • REST API support for all exchanges.
  • Websocket support for applicable exchanges.
  • Ability to turn off/on certain exchanges.
  • Communication packages (Slack, SMS via SMSGlobal, Telegram and SMTP).
  • HTTP rate limiter package.
  • Unified API for exchange usage.
  • Customisation of HTTP client features including setting a proxy, user agent and adjusting transport settings.
  • NTP client package.
  • Database support (Postgres and SQLite3). See database.
  • OTP generation tool. See gen otp.
  • Connection monitor package.
  • gRPC service and JSON RPC proxy. See gRPC service.
  • gRPC client. See gctcli.
  • Forex currency converter packages (CurrencyConverterAPI, CurrencyLayer, Fixer.io, OpenExchangeRates).
  • Packages for handling currency pairs, tickers and orderbooks.
  • Portfolio management tool; fetches balances from supported exchanges and allows for custom address tracking.
  • Basic event trigger system.
  • OHLCV/Candle retrieval support. See OHLCV.
  • Scripting support. See gctscript.
  • WebGUI (discontinued).

Planned Features

Planned features can be found on our community Trello page.

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.

Compiling instructions

Download and install Go from Go Downloads for your platform.

Linux/OSX

GoCryptoTrader is built using Go Modules and requires Go 1.11 or above Using Go Modules you now clone this repository outside your GOPATH

git clone https://github.com/thrasher-corp/gocryptotrader.git
cd gocryptotrader
go build
mkdir ~/.gocryptotrader
cp config_example.json ~/.gocryptotrader/config.json

Windows

git clone https://github.com/thrasher-corp/gocryptotrader.git
cd gocryptotrader
go build
copy config_example.json %APPDATA%\GoCryptoTrader\config.json
  • Make any neccessary changes to the config.json file.
  • Run the gocryptotrader binary file inside your GOPATH bin folder.

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

Binaries

Binaries will be published once the codebase reaches a stable condition.

Contributor List

A very special thank you to all who have contributed to this program:

User Contribution Amount
thrasher- 643
shazbert 195
gloriousCode 170
dependabot-preview[bot] 68
xtda 47
ermalguni 14
vadimzhukck 10
MadCozBadd 9
140am 8
marcofranssen 8
dackroyd 5
Rots 5
vazha 5
cranktakular 5
woshidama323 3
crackcomm 3
azhang 2
andreygrehov 2
bretep 2
Christian-Achilli 2
gam-phon 2
cornelk 2
if1live 2
lozdog245 2
soxipy 2
herenow 2
blombard 1
CodeLingoBot 1
CodeLingoTeam 1
Daanikus 1
daniel-cohen 1
DirectX 1
frankzougc 1
idoall 1
mattkanwisher 1
mKurrels 1
m1kola 1
cavapoo2 1
zeldrinn 1
starit 1
Jimexist 1
lookfirst 1
merkeld 1