(Exchange) Add FTX exchange support with implementation tutorial (#495)

* initial * wip * brokenwip * broken wipzzzz * more functions brokenwip NO API KEYS * broken wip * WIP * wip * WIP work in progress * WIP * WIP * wip * more wip * wip * ws wip * broken wip * adding new functions for websocket to work * trying to fix websocket issues * websocket bug fix wip * broken websocket implementation * WS unauth functions + brokenWS auth func * authentication problems * authentication problems fixed * data handling for websocket * websocket completed * remove verbose * minor error fix changes and testing * reorganising variable declarations and minor errors fixed * enabled exchanges updated * enabled exchanges fixed * remove keys * glorious nits * xdta n shazzy nitzzz * shazzy n thrasher nitz * nitz wip * broken wip * apichecker donee n make code better * apichecker donee n make code better * OB update * wip * wip * all nitz done * merge conflicts * go mod tidy * merge conflicts * PLEASE merge conflicts * new funcs added n binanceapi check update NO APIKEYS * basic tests * linter fixs * linter fixs * remove verbose * test errors fixed * remove comented code * minor changes * some tests fixed no apikeys * documentation work * documentation * wip * ryan nitz * nits addressed * unnecessary conversion * no fail * remove verbose * type field checking * broken * websocket nits fixed * some thangs * remove verbose * fix function * linter issues * test error fixed * nits * bumperino fixed * very small change * nits * errors fixing * errors fixing retry * linters * thrasher glorious nits * more changes * changes * 2 more changes to be addressed * 2 more changes to be addressed * issues addressed * whip * changes * missed change * changes * currency issues * changes * unsaved * int64 * HUGE * HUGE * NO NITS PLS * no more * YES * : * changes * PLEASE * n another one * thanks guys * ill believe in god if this ever ends * :D
2026-06-06 07:26:47 +00:00 · 2020-07-02 10:38:50 +10:00
parent 2351d89b77
commit c2c200cd1b
66 changed files with 6720 additions and 282 deletions
--- a/cmd/documentation/exchanges_templates/exchanges_readme.tmpl
+++ b/cmd/documentation/exchanges_templates/exchanges_readme.tmpl
@@ -7,6 +7,10 @@
 + Please checkout individual exchange README for more information on
 implementation

+## Guide for adding a new exchange
+
+ A guide on implementing API support for a new exchange can be found [here](../docs/ADD_NEW_EXCHANGE.md)
+
 ### Please click GoDocs chevron above to view current GoDoc information for this package
 {{template "contributions"}}
 {{template "donations" .}}
--- a/cmd/documentation/exchanges_templates/ftx.tmpl
+++ b/cmd/documentation/exchanges_templates/ftx.tmpl
@@ -0,0 +1,99 @@
+{{define "exchanges ftx" -}}
+{{template "header" .}}
+## FTX Exchange
+
+### Current Features
+
+ REST Support
+ Websocket Support
+
+### How to enable
+
+ [Enable via configuration](https://github.com/thrasher-corp/gocryptotrader/tree/master/config#enable-exchange-via-config-example)
+
+ Individual package example below:
+
+```go
+  // Exchanges will be abstracted out in further updates and examples will be
+  // supplied then
+```
+
+### How to do REST public/private calls
+
+ If enabled via "configuration".json file the exchange will be added to the
+IBotExchange array in the ```go var bot Bot``` and you will only be able to use
+the wrapper interface functions for accessing exchange data. View routines.go
+for an example of integration usage with GoCryptoTrader. Rudimentary example
+below:
+
+main.go
+```go
+var f exchange.IBotExchange
+
+for i := range bot.Exchanges {
+  if bot.Exchanges[i].GetName() == "FTX" {
+    f = bot.Exchanges[i]
+  }
+}
+
+// Public calls - wrapper functions
+
+// Fetches current ticker information
+tick, err := f.FetchTicker()
+if err != nil {
+  // Handle error
+}
+
+// Fetches current orderbook information
+ob, err := f.FetchOrderbook()
+if err != nil {
+  // Handle error
+}
+
+// Private calls - wrapper functions - make sure your APIKEY and APISECRET are
+// set and AuthenticatedAPISupport is set to true
+
+// Fetches current account information
+accountInfo, err := f.GetAccountInfo()
+if err != nil {
+  // Handle error
+}
+```
+
+ If enabled via individually importing package, rudimentary example below:
+
+```go
+// Public calls
+
+// Fetches current ticker information
+ticker, err := f.GetTicker()
+if err != nil {
+  // Handle error
+}
+
+// Fetches current orderbook information
+ob, err := f.GetOrderBook()
+if err != nil {
+  // Handle error
+}
+
+// Private calls - make sure your APIKEY and APISECRET are set and
+// AuthenticatedAPISupport is set to true
+
+// GetUserInfo returns account info
+accountInfo, err := f.GetUserInfo(...)
+if err != nil {
+  // Handle error
+}
+
+// Submits an order and the exchange and returns its tradeID
+tradeID, err := f.Trade(...)
+if err != nil {
+  // Handle error
+}
+```
+
+### Please click GoDocs chevron above to view current GoDoc information for this package
+{{template "contributions"}}
+{{template "donations" .}}
+{{end}}
--- a/cmd/documentation/exchanges_templates/newexchange.tmpl
+++ b/cmd/documentation/exchanges_templates/newexchange.tmpl
--- a/cmd/documentation/root_templates/root_readme.tmpl
+++ b/cmd/documentation/root_templates/root_readme.tmpl
@@ -31,6 +31,7 @@ Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader
 | 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 |