mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-20 15:10:10 +00:00
fafee93e1b
* Sonic: Add sonic_on build tag Thinking about other ways to do this, but they amount to the same thing. It's messy, but I don't have another idea. * Okx: Remove redundant useAsIs on slices Slices are automatically used-as-is, so passing true for these types was unnecessary. Removing the field simplifies rationalising inverting the flag * Okx: Unify timestamp response types * Okx: Change ResetRFQMMPStatus to return a types.Time * Okx: Move withdrawData type to types * Okx: Fix AccountConfiguration slice return * Okx: Improve SendHTTPRequest documentation * Okx: Extend tests for UseAsIs non-defaults * Okx: Fix GetPublicUnderlying with sonic 1.12.9 Using **result for slices with useAsItIs causes sonic to fail. This might be addressed upstream, but it's also not clear what the unmarshal behaviour for an untyped reference to a typed reference should be in the RFC, so we could get a golang.org/encoding/json regression on this too. There's no harm in fixing this, for consistency, to match our handling for non-slice []any wrapping to just use the pointer as is. Note: As of today this requires sonic:main for this to work, because of the other bug: ``` M go.mod - github.com/bytedance/sonic v1.12.9 + github.com/bytedance/sonic v1.12.10-0.20250224121557-e30ac4f2e4fe ``` * Okx: Remove redundant slice check This code didn't work, and if I make it look at rv.Elem().Kind() it errors. Haven't dug too deeply but right now I think we just remove it. * Okx: Simplify SendHTTPRequest by removing UseAsIs Looks to be entirely derivable * Okx: Remove http check that resps must contain data GetAnnouncementTyeps failing in US because of empty response. But also any situation where there really is no data. e.g. GetCandlesticks might return no candlesticks for a period and instrument, because there aren't any. That shouldn't be an error. More saliently if you request orders, or something similar. So, since that check wasn't working before, and it's causing issues now, I'm going to remove it. * Okx: Fix TestGetAnnouncementTypes failing in US announcement-types returns empty in the US, where our github actions run. That's kinda okay. Just don't test we get any back * Sonic: Default to sonic off We've seen too many fatal panics and races with sonic, both in GCT runs and being reported in sonic, to default to it being turned on right now. Whilst we have faith sonic will get through these with time, for now the sensible thing to do for our users is make sonic opt-in. This also removes any of the conditions around 386, etc. If someone wants to run with sonic, they can. Most notably if they're trying out an experimental sonic branch that supports 386, etc.
149 lines
6.6 KiB
Cheetah
149 lines
6.6 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)
|
|
[](https://codecov.io/gh/thrasher-corp/gocryptotrader)
|
|
[](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 |
|
|
| BTCMarkets | Yes | Yes | NA |
|
|
| BTSE | Yes | Yes | NA |
|
|
| Bybit | Yes | Yes | NA |
|
|
| CoinbasePro | Yes | Yes | No|
|
|
| COINUT | Yes | Yes | NA |
|
|
| Deribit | Yes | Yes | No |
|
|
| 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 |
|
|
| 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](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).
|
|
|
|
## Development Tracking
|
|
|
|
Our [Kanban board](https://github.com/orgs/thrasher-corp/projects/3) provides updates on:
|
|
|
|
+ New feature development
|
|
+ Bug fixes in progress
|
|
+ Recently completed work
|
|
+ Contribution opportunities
|
|
|
|
Follow our progress as we continuously improve 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 and Running instructions
|
|
|
|
Download and install Go from [Go Downloads](https://golang.org/dl/) for your platform.
|
|
|
|
### Linux/macOS
|
|
|
|
```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
|
|
mkdir %AppData%\GoCryptoTrader
|
|
copy config_example.json %APPDATA%\GoCryptoTrader\config.json
|
|
```
|
|
|
|
+ Make any necessary changes to the `config.json` file.
|
|
+ Run the `gocryptotrader` binary file.
|
|
|
|
### Sonic JSON handling
|
|
|
|
GoCryptoTrader can optionally use the [Sonic](https://github.com/bytedance/sonic) JSON library for improved performance, as a drop in replacement for golang.org/encoding/json.
|
|
Please see sonic [Requirements](https://github.com/bytedance/sonic/#requirement) for supported platforms.
|
|
|
|
To enable sonic, build with the sonic_on tag:
|
|
|
|
```bash
|
|
go build -tags=sonic_on
|
|
```
|
|
|
|
{{template "donations" .}}
|
|
|
|
## Binaries
|
|
|
|
Binaries will be published once the codebase reaches a stable condition.
|
|
{{template "contributors" .}}
|
|
{{- end}}
|