mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-13 23:16:45 +00:00
52c6b3bf0b
* Websocket: Remove IsInit and simplify SetProxyAddress IsInit was basically the same as IsConnected. Any time Connect was called both would be set to true. Any time we had a disconnect they'd both be set to false Shutdown() incorrectly didn't setInit(false) SetProxyAddress simplified to only reconnect a connected Websocket. Any other state means it hasn't been Connected, or it's about to reconnect anyway. There's no handling for IsConnecting previously, either, so I've wrapped that behind the main mutex. * Websocket: Expand and Assertify tests * Websocket: Simplify state transistions * Websocket: Simplify Connecting/Connected state * Websocket: Tests and errors for websocket * Websocket: Make WebsocketNotEnabled a real error This allows for testing and avoids the repetition. If each returned error is a error.New() you can never use errors.Is() * Websocket: Add more testable errors * Websocket: Improve GenerateMessageID test Testing just the last id doesn't feel very robust * Websocket: Protect Setup() from races * Websocket: Use atomics instead of mutex This was spurred by looking at the setState call in trafficMonitor and the effect on blocking and efficiency. With the new atomic types in Go 1.19, and the small types in use here, atomics should be safe for our usage. bools should be truly atomic, and uint32 is atomic when the accepted value range is less than one byte/uint8 since that can be written atomicly by concurrent processors. Maybe that's not even a factor any more, however we don't even have to worry enough to check. * Websocket: Fix and simplify traffic monitor trafficMonitor had a check throttle at the end of the for loop to stop it just gobbling the (blocking) trafficAlert channel non-stop. That makes sense, except that nothing is sent to the trafficAlert channel if there's no listener. So that means that it's out by one second on the trafficAlert, because any traffic received during the pause is doesn't try to send a traffic alert. The unstopped timer is deliberately leaked for later GC when shutdown. It won't delay/block anything, and it's a trivial memory leak during an infrequent event. Deliberately Choosing to recreate the timer each time instead of using Stop, drain and reset * Websocket: Split traficMonitor test on behaviours * Websocket: Remove trafficMonitor connected status trafficMonitor does not need to set the connection to be connected. Connect() does that. Anything after that should result in a full shutdown and restart. It can't and shouldn't become connected unexpectedly, and this is most likely a race anyway. Also dropped trafficCheckInterval to 100ms to mitigate races of traffic alerts being buffered for too long. * Websocket: Set disconnected earlier in Shutdown This caused a possible race where state is still connected, but we start to trigger interested actors via ShutdownC and Wait. They may check state and then call Shutdown again, such as trafficMonitor * Websocket: Wait 5s for slow tests to pass traffic draining Keep getting failures upstream on test rigs. Think they can be very contended, so this pushes the boundary right out to 5s
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.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 |
| BTCMarkets | Yes | Yes | NA |
| BTSE | Yes | Yes | NA |
| Bybit | Yes | Yes | NA |
| CoinbasePro | Yes | Yes | No |
| COINUT | Yes | Yes | NA |
| Exmo | Yes | NA | NA |
| GateIO | Yes | Yes | NA |
| Gemini | Yes | Yes | No |
| HitBTC | Yes | Yes | No |
| Huobi.Pro | Yes | Yes | NA |
| Kraken | Yes | Yes | NA |
| Kucoin | Yes | Yes | NA |
| Lbank | Yes | No | NA |
| Okcoin | Yes | Yes | No |
| Okx | Yes | Yes | NA |
| Poloniex | Yes | Yes | NA |
| Yobit | Yes | NA | 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
masterbranch.
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 necessary changes to the
config.jsonfile. - Run the
gocryptotraderbinary 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- | 684 |
| shazbert | 315 |
| dependabot[bot] | 228 |
| gloriousCode | 224 |
| dependabot-preview[bot] | 88 |
| xtda | 47 |
| gbjk | 42 |
| lrascao | 27 |
| Rots | 15 |
| vazha | 15 |
| ydm | 15 |
| ermalguni | 14 |
| MadCozBadd | 13 |
| Beadko | 11 |
| vadimzhukck | 10 |
| 140am | 8 |
| marcofranssen | 8 |
| geseq | 8 |
| samuael | 7 |
| TaltaM | 6 |
| dackroyd | 5 |
| cranktakular | 5 |
| khcchiu | 5 |
| yangrq1018 | 4 |
| woshidama323 | 3 |
| crackcomm | 3 |
| azhang | 2 |
| andreygrehov | 2 |
| bretep | 2 |
| Christian-Achilli | 2 |
| cornelk | 2 |
| gam-phon | 2 |
| herenow | 2 |
| if1live | 2 |
| lozdog245 | 2 |
| MarkDzulko | 2 |
| mshogin | 2 |
| soxipy | 2 |
| tk42 | 2 |
| blombard | 1 |
| cavapoo2 | 1 |
| CodeLingoTeam | 1 |
| CodeLingoBot | 1 |
| Daanikus | 1 |
| daniel-cohen | 1 |
| DirectX | 1 |
| frankzougc | 1 |
| idoall | 1 |
| Jimexist | 1 |
| lookfirst | 1 |
| m1kola | 1 |
| mattkanwisher | 1 |
| merkeld | 1 |
| mKurrels | 1 |
| starit | 1 |
| zeldrinn | 1 |