Files
gocryptotrader/README.md
Ryan O'Hara-Reid 11da520dc8 Currency: Add additional functionality, refactor and improvements (#881)
* currency: Add method to derive pair

* currency: Add method to lower entire charset but used the slice copy and returned that. This will change the original, just gotta see if this is an issue, but the slice usually goes out of scope anyway.

* currency/pairs: add filter method

* currency: add function to derive select currencies from currency pairs

* currency/engine: slight adjustments

* currency: fix linter issue also shift burden of proof to caller instead of repair, more performant.

* currency: more linter

* pairs: optimize; reduce allocs/op and B/op

* currency: Add in function 'NewPairsFromString' for testing purposes

* currency: don't suppress error

* currency: stop panic on empty currency code

* currency: Add helper method to match currencies between exchanges

* currency: fixed my bad spelling

* currency: Implement stable coin checks, refactored base code methods, optimized upper and lower case strings for currency code/pairs

* currency: add pairs method to derive stable coins from internal list.

* Currency: Cleanup, fix tests.

* engine/exchanges/currency: fix whoops

* Currency: force govet no copy on Item datatype

* Currency: fix naughty linter issues

* exchange: revert change

* currency/config: fix config upgrade mistake

* currency: re-implement currency sub-systems

* *RetrieveConfigCurrencyPairs removed
*CheckCurrencyConfigValues to only provide warnings, add additional support when, disable when support is lost or not available and set default values.
*Drop Cryptocurrencies from configuration as this is not needed.
*Drop REST Poll delay field as this was unused.
*Update default values for currencyFileUpdateDuration & foreignExchangeUpdateDuration.
*Allow Role to be marshalled for file type.
*Refactor RunUpdater to verify and check config values and set default running foreign exchange provider.

* currency: cleanup

* currency: change match -> equal for comparison which is more of a standard and little easier to find

* currency: address nits

* currency: fix whoops

* currency: Add some more pairs methods

* currency: linter issues

* currency: RM unused field

* currency: rm verbose

* currency: fix word

* currency: gocritic

* currency: fix another whoopsie

* example_config: default to show log system name

* Currency: Force all support packages to use Equal method for comparison as there is a small comparison bug when checking upper and lower casing, this has a more of a pronounced impact between exchanges and client instances of currency generation

* currency: fix log name

* ordermanager: fix potential panic

* currency: small optim.

* engine: display correct bool and force shutdown

* currency: add function and fix regression
* Change ConvertCurrency -> ConvertFiat to be more precise
* ADD GetForeignExchangeRate to get specific exchange rate for fiat pair
* Fix currency display and formatting regression and tied in with config.Currency fields

* engine: fix tests

* currency: return the amount when no conversion needs to take place

* currency: reduce method name

* currency: Address nits glorious nits

* currency: fix linter

* currency: addr nits

* currency: check underlying role in test

* gct: change to EMPTYCODE and EMPTYPAIR across codebase

* currency: fix nits

* currency: this fixes test race but this issue has not been resolved. Please see: https://trello.com/c/54eizOIo/143-currency-package-upgrades

* currency: Add temp dir for testing

* Update engine/engine.go

Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io>

* documentation: update and regen

* currency: Address niterinos

* currency: Add test case for config upgrade when falling over to exchange rate host as default from exchangeRates provider

* currency: addr nits

* currency: fix whoops

Co-authored-by: Ryan O'Hara-Reid <ryan.oharareid@thrasher.io>
Co-authored-by: Adrian Gallagher <adrian.gallagher@thrasher.io>
2022-02-17 16:24:57 +11:00

9.2 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 Yes NA
BitMEX Yes Yes NA
Bitstamp Yes Yes No
Bittrex Yes Yes NA
BTCMarkets Yes Yes NA
BTSE Yes Yes NA
CoinbasePro Yes Yes No
COINUT Yes Yes NA
Exmo Yes NA NA
FTX Yes Yes 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
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, Exchange Rates, Fixer.io, OpenExchangeRates, Exchange Rate Host).
  • 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.
  • Recent and historic trade processing. See trades.
  • Backtesting application. An event-driven backtesting tool to test and iterate trading strategies using historical or custom data. See backtester.
  • WebGUI (discontinued).
  • Exchange HTTP mock testing. See mock.
  • Exchange multichain deposits and withdrawals for specific exchanges. See multichain transfer support.

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- 664
shazbert 232
gloriousCode 194
dependabot-preview[bot] 88
dependabot[bot] 57
xtda 47
lrascao 27
Rots 15
vazha 15
ydm 15
ermalguni 14
MadCozBadd 13
vadimzhukck 10
140am 8
marcofranssen 8
dackroyd 5
cranktakular 5
khcchiu 4
woshidama323 3
yangrq1018 3
TaltaM 3
crackcomm 3
azhang 2
andreygrehov 2
bretep 2
Christian-Achilli 2
MarkDzulko 2
gam-phon 2
cornelk 2
if1live 2
herenow 2
mshogin 2
soxipy 2
tk42 2
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
CodeLingoTeam 1
Daanikus 1
CodeLingoBot 1
blombard 1
soxipy 2
lozdog245 2