mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-18 07:26:50 +00:00
4e135c9590
* logger: reduce go routine generation * logger: shift most of processing and prep work to the worker pool, add pool for fields because each log we are pushing the struct to the heap, has better segregation now and includes a buffer in scope instead of relying on a pool * logger: shift fmt package calls to worker pool * logger: conform tests to new design * linter: fix issues * Update log/logger_test.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * Update log/logger_test.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * UN-GLORIOUS: nits * logger: Handle config variable * logger: NITERINOS BY GLORIOUS CODE * logger: revert * glorious: nits * Panic at the disco: fix * Panic at the disco: fix * logger: make sure logger closed and job channel emptied on start up error * fix tests * logger: reduce globals * logger: finished reduces globals, reduce workers to one too keep everything in line. * logger: remove comments * logger/exhchange: linter issues * db/test: fix linter * logger: add tests shift wait before unlock * logger: consolidate worker code; fix linter issue and make sure we can sustain writing for external testing. * logger: fix race and warn for conflict in config * logger: fix name and add to tests * logger: remove zero value field * glorious: panic fix and removal of code * logger: reinstate channels in close * logger: shift reinstate processing to SetupGlobalLogger * logger: segregate config.json from internal log.Config * logger: fix silly mistake that is silly * engine: Add protection for nil issues and implement new constructor in tests * logger: Force singular mutex usage throughout package, throw away funcs that are not used outside of this package, unexport a bunch. Fix tests. * logger: actually set advanced settings * Update log/loggers.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * Update log/loggers.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * Update log/loggers.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * Update log/loggers.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * Update log/logger_multiwriter.go Co-authored-by: Scott <gloriousCode@users.noreply.github.com> * glorious: nits * logger: test issue when not purging temp file and contents * loggertest: add more protections for the panics * linter: fix * glorious: nits * cleanup * logger: linter fix * linter: fix(?) :/ * linter: revert change * linter: fix Co-authored-by: Scott <gloriousCode@users.noreply.github.com> Co-authored-by: Ryan O'Hara-Reid <ryan.oharareid@thrasher.io>
138 lines
6.3 KiB
Cheetah
138 lines
6.3 KiB
Cheetah
{{define "root" -}}
|
|
<img src="/common/gctlogo.png?raw=true" width="350px" height="350px" hspace="70">
|
|
|
|
[](https://github.com/thrasher-corp/gocryptotrader/actions/workflows/tests.yml)
|
|
[](https://github.com/thrasher-corp/gocryptotrader/blob/master/LICENSE)
|
|
[](https://godoc.org/github.com/thrasher-corp/gocryptotrader)
|
|
[](http://codecov.io/github/thrasher-corp/gocryptotrader?branch=master)
|
|
[](https://goreportcard.com/report/github.com/thrasher-corp/gocryptotrader)
|
|
|
|
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](https://join.slack.com/t/gocryptotrader/shared_invite/enQtNTQ5NDAxMjA2Mjc5LTc5ZDE1ZTNiOGM3ZGMyMmY1NTAxYWZhODE0MWM5N2JlZDk1NDU0YTViYzk4NTk3OTRiMDQzNGQ1YTc4YmRlMTk)
|
|
|
|
## Exchange Support Table
|
|
|
|
| Exchange | REST API | Streaming API | FIX API |
|
|
|----------|------|-----------|-----|
|
|
| Alphapoint | Yes | Yes | NA |
|
|
| Binance.US| 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 |
|
|
| Bybit | 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](https://coinmarketcap.com/rankings/exchanges/).
|
|
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](https://join.slack.com/t/gocryptotrader/shared_invite/enQtNTQ5NDAxMjA2Mjc5LTc5ZDE1ZTNiOGM3ZGMyMmY1NTAxYWZhODE0MWM5N2JlZDk1NDU0YTViYzk4NTk3OTRiMDQzNGQ1YTc4YmRlMTk).
|
|
|
|
** 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](/database/README.md).
|
|
+ OTP generation tool. See [gen otp](/cmd/gen_otp).
|
|
+ Connection monitor package.
|
|
+ gRPC service and JSON RPC proxy. See [gRPC service](/gctrpc/README.md).
|
|
+ gRPC client. See [gctcli](/cmd/gctcli/README.md).
|
|
+ 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](/docs/OHLCV.md).
|
|
+ Scripting support. See [gctscript](/gctscript/README.md).
|
|
+ Recent and historic trade processing. See [trades](/exchanges/trade/README.md).
|
|
+ Backtesting application. An event-driven backtesting tool to test and iterate trading strategies using historical or custom data. See [backtester](/backtester/README.md).
|
|
+ WebGUI (discontinued).
|
|
+ Exchange HTTP mock testing. See [mock](/exchanges/mock/README.md).
|
|
+ Exchange multichain deposits and withdrawals for specific exchanges. See [multichain transfer support](/docs/MULTICHAIN_TRANSFER_SUPPORT.md).
|
|
|
|
## Planned Features
|
|
|
|
Planned features can be found on our [community Trello page](https://trello.com/b/ZAhMhpOy/gocryptotrader).
|
|
|
|
## 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](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
|
|
+ Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
|
|
+ Code must adhere to our [coding style](https://github.com/thrasher-corp/gocryptotrader/blob/master/.github/CONTRIBUTING.md).
|
|
+ Pull requests need to be based on and opened against the `master` branch.
|
|
|
|
## Compiling instructions
|
|
|
|
Download and install Go from [Go Downloads](https://golang.org/dl/) for your
|
|
platform.
|
|
|
|
### Linux/OSX
|
|
|
|
GoCryptoTrader is built using [Go Modules](https://github.com/golang/go/wiki/Modules) and requires Go 1.11 or above
|
|
Using Go Modules you now clone this repository **outside** your GOPATH
|
|
|
|
```bash
|
|
git clone https://github.com/thrasher-corp/gocryptotrader.git
|
|
cd gocryptotrader
|
|
go build
|
|
mkdir ~/.gocryptotrader
|
|
cp config_example.json ~/.gocryptotrader/config.json
|
|
```
|
|
|
|
### Windows
|
|
|
|
```bash
|
|
git clone https://github.com/thrasher-corp/gocryptotrader.git
|
|
cd gocryptotrader
|
|
go build
|
|
copy config_example.json %APPDATA%\GoCryptoTrader\config.json
|
|
```
|
|
|
|
+ Make any necessary changes to the `config.json` file.
|
|
+ Run the `gocryptotrader` binary file inside your GOPATH bin folder.
|
|
|
|
{{template "donations" .}}
|
|
|
|
## Binaries
|
|
|
|
Binaries will be published once the codebase reaches a stable condition.
|
|
{{template "contributors" .}}
|
|
{{- end}}
|