Exchanges: Include format pair in wrapper functions and test for formatting issues via tool wrapper issues (#582)

* Adds formatting of pair within binance wrapper, adds return of error from cli.ShowCommmandHelp

* Add formatting function to submit order wrapper functions

* Remove superfluous functionality

* Updated exchange wrapper issues to create a disruptive pair to see which exchanges require attention, updates currency code generation and matching

* reinstated format check, fixed tests

* fixed niterinos

* fix test

* fix spelling mistake

* make html file more aesthetic

* Add missing format pairs

* add formatting to pair for BTC Markets func

* fix spelling

cmd/exchange_wrapper_issues/exchange_wrapper_issues_test.go

@@ -0,0 +1,30 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/thrasher-corp/gocryptotrader/currency"
+)
+
+func TestDisruptFormatting(t *testing.T) {
+	_, err := disruptFormatting(currency.Pair{})
+	if err == nil {
+		t.Fatal("error cannot be nil")
+	}
+
+	_, err = disruptFormatting(currency.Pair{Base: currency.BTC})
+	if err == nil {
+		t.Fatal("error cannot be nil")
+	}
+
+	p := currency.NewPair(currency.BTC, currency.USDT)
+
+	badPair, err := disruptFormatting(p)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	if badPair.String() != "BTC-TEST-DELIM-usdt" {
+		t.Fatal("incorrect disrupted pair")
+	}
+}

cmd/exchange_wrapper_issues/main.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"encoding/json"
+	"errors"
 	"flag"
 	"fmt"
 	"io/ioutil"
@@ -94,6 +95,7 @@ func main() {
 
 	exchs := bot.GetExchanges()
 	for x := range exchs {
+		exchs[x].SetDefaults()
 		base := exchs[x].GetBase()
 		if !base.Config.Enabled {
 			log.Printf("Exchange %v not enabled, skipping", base.GetName())
@@ -289,12 +291,12 @@ func testWrappers(e exchange.IBotExchange, base *exchange.Base, config *Config)
 	}
 	for i := range assetTypes {
 		var msg string
-		var p currency.Pair
 		log.Printf("%v %v", base.GetName(), assetTypes[i])
 		if _, ok := base.Config.CurrencyPairs.Pairs[assetTypes[i]]; !ok {
 			continue
 		}
 
+		var p currency.Pair
 		switch {
 		case currencyPairOverride != "":
 			var err error
@@ -314,13 +316,19 @@ func testWrappers(e exchange.IBotExchange, base *exchange.Base, config *Config)
 			p = base.Config.CurrencyPairs.Pairs[assetTypes[i]].Enabled.GetRandomPair()
 		}
 
+		var err error
+		p, err = disruptFormatting(p)
+		if err != nil {
+			log.Println("failed to disrupt currency pair formatting:", err)
+		}
+
 		responseContainer := ExchangeAssetPairResponses{
 			AssetType: assetTypes[i],
 			Pair:      p,
 		}
 
 		log.Printf("Setup config for %v %v %v", base.GetName(), assetTypes[i], p)
-		err := e.Setup(base.Config)
+		err = e.Setup(base.Config)
 		if err != nil {
 			log.Printf("%v Encountered error reloading config: '%v'", base.GetName(), err)
 		}
@@ -883,3 +891,22 @@ func outputToConsole(exchangeResponses []ExchangeResponses) {
 		log.Println()
 	}
 }
+
+// disruptFormatting adds in an unused delimiter and strange casing features to
+// ensure format currency pair is used throughout the code base.
+func disruptFormatting(p currency.Pair) (currency.Pair, error) {
+	base := p.Base.String()
+	if base == "" {
+		return currency.Pair{}, errors.New("cannot disrupt formatting as base is not populated")
+	}
+	quote := p.Quote.String()
+	if quote == "" {
+		return currency.Pair{}, errors.New("cannot disrupt formatting as quote is not populated")
+	}
+
+	return currency.Pair{
+		Base:      p.Base.Upper(),
+		Quote:     p.Quote.Lower(),
+		Delimiter: "-TEST-DELIM-",
+	}, nil
+}

cmd/exchange_wrapper_issues/wrapperconfig.json

@@ -9,7 +9,7 @@
  "withdrawWalletAddress": "",
  "bankAccount": {
   "bankAccountName": "bankAccountName",
-  "bankAccountNumber": 1337,
+  "bankAccountNumber": "1337",
   "bankAddress": "bankAddress",
   "bankCity": "bankCity",
   "bankCountry": "bankCountry",
@@ -33,7 +33,6 @@
   "intermediaryBankCode": 1337
  },
  "exchanges": {
-  "alphapoint": {},
   "binance": {
    "key": "Key",
    "secret": "Secret",
@@ -101,6 +100,11 @@
    "secret": "Secret",
    "otpSecret": "-"
   },
+  "ftx": {
+   "key": "Key",
+   "secret": "Secret",
+   "otpSecret": "-"
+  },
   "gateio": {
    "key": "Key",
    "secret": "Secret",

cmd/gctcli/commands.go

@@ -88,8 +88,7 @@ var enableSubsystemCommand = cli.Command{
 
 func enableSubsystem(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "enablesubsystem")
-		return nil
+		return cli.ShowCommandHelp(c, "enablesubsystem")
 	}
 
 	var subsystemName string
@@ -139,8 +138,7 @@ var disableSubsystemCommand = cli.Command{
 
 func disableSubsystem(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "disablesubsystem")
-		return nil
+		return cli.ShowCommandHelp(c, "disablesubsystem")
 	}
 
 	var subsystemName string
@@ -282,8 +280,7 @@ var enableExchangeCommand = cli.Command{
 
 func enableExchange(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "enableexchange")
-		return nil
+		return cli.ShowCommandHelp(c, "enableexchange")
 	}
 
 	var exchangeName string
@@ -333,8 +330,7 @@ var disableExchangeCommand = cli.Command{
 
 func disableExchange(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "disableexchange")
-		return nil
+		return cli.ShowCommandHelp(c, "disableexchange")
 	}
 
 	var exchangeName string
@@ -384,8 +380,7 @@ var getExchangeOTPCommand = cli.Command{
 
 func getExchangeOTPCode(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "getexchangeotp")
-		return nil
+		return cli.ShowCommandHelp(c, "getexchangeotp")
 	}
 
 	var exchangeName string
@@ -460,8 +455,7 @@ var getExchangeInfoCommand = cli.Command{
 
 func getExchangeInfo(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "getexchangeinfo")
-		return nil
+		return cli.ShowCommandHelp(c, "getexchangeinfo")
 	}
 
 	var exchangeName string
@@ -519,8 +513,7 @@ var getTickerCommand = cli.Command{
 
 func getTicker(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "getticker")
-		return nil
+		return cli.ShowCommandHelp(c, "getticker")
 	}
 
 	var exchangeName string
@@ -636,8 +629,7 @@ var getOrderbookCommand = cli.Command{
 
 func getOrderbook(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "getorderbook")
-		return nil
+		return cli.ShowCommandHelp(c, "getorderbook")
 	}
 
 	var exchangeName string
@@ -745,8 +737,7 @@ var getAccountInfoCommand = cli.Command{
 
 func getAccountInfo(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "getaccountinfo")
-		return nil
+		return cli.ShowCommandHelp(c, "getaccountinfo")
 	}
 
 	var exchange string
@@ -795,8 +786,7 @@ var getAccountInfoStreamCommand = cli.Command{
 
 func getAccountInfoStream(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "getaccountinfostream")
-		return nil
+		return cli.ShowCommandHelp(c, "getaccountinfostream")
 	}
 
 	var exchangeName string
@@ -945,8 +935,7 @@ var addPortfolioAddressCommand = cli.Command{
 
 func addPortfolioAddress(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "addportfolioaddress")
-		return nil
+		return cli.ShowCommandHelp(c, "addportfolioaddress")
 	}
 
 	conn, err := setupClient()
@@ -1047,8 +1036,7 @@ var removePortfolioAddressCommand = cli.Command{
 
 func removePortfolioAddress(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "removeportfolioaddress")
-		return nil
+		return cli.ShowCommandHelp(c, "removeportfolioaddress")
 	}
 
 	conn, err := setupClient()
@@ -1251,8 +1239,7 @@ var getOrderCommand = cli.Command{
 
 func getOrder(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "getorder")
-		return nil
+		return cli.ShowCommandHelp(c, "getorder")
 	}
 
 	var exchangeName string
@@ -1357,8 +1344,7 @@ var submitOrderCommand = cli.Command{
 
 func submitOrder(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "submitorder")
-		return nil
+		return cli.ShowCommandHelp(c, "submitorder")
 	}
 
 	var exchangeName string
@@ -1513,8 +1499,7 @@ var simulateOrderCommand = cli.Command{
 
 func simulateOrder(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "simulateorder")
-		return nil
+		return cli.ShowCommandHelp(c, "simulateorder")
 	}
 
 	var exchangeName string
@@ -1623,8 +1608,7 @@ var whaleBombCommand = cli.Command{
 
 func whaleBomb(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "whalebomb")
-		return nil
+		return cli.ShowCommandHelp(c, "whalebomb")
 	}
 
 	var exchangeName string
@@ -1741,8 +1725,7 @@ var cancelOrderCommand = cli.Command{
 
 func cancelOrder(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "cancelorder")
-		return nil
+		return cli.ShowCommandHelp(c, "cancelorder")
 	}
 
 	var exchangeName string
@@ -1969,8 +1952,7 @@ var addEventCommand = cli.Command{
 
 func addEvent(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "addevent")
-		return nil
+		return cli.ShowCommandHelp(c, "addevent")
 	}
 
 	var exchangeName string
@@ -2100,8 +2082,7 @@ var removeEventCommand = cli.Command{
 
 func removeEvent(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "removeevent")
-		return nil
+		return cli.ShowCommandHelp(c, "removeevent")
 	}
 
 	var eventID int64
@@ -2151,8 +2132,7 @@ var getCryptocurrencyDepositAddressesCommand = cli.Command{
 
 func getCryptocurrencyDepositAddresses(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "getcryptocurrencydepositaddresses")
-		return nil
+		return cli.ShowCommandHelp(c, "getcryptocurrencydepositaddresses")
 	}
 
 	var exchangeName string
@@ -2202,8 +2182,7 @@ var getCryptocurrencyDepositAddressCommand = cli.Command{
 
 func getCryptocurrencyDepositAddress(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "getcryptocurrencydepositaddresses")
-		return nil
+		return cli.ShowCommandHelp(c, "getcryptocurrencydepositaddresses")
 	}
 
 	var exchangeName string
@@ -2289,8 +2268,7 @@ var withdrawCryptocurrencyFundsCommand = cli.Command{
 
 func withdrawCryptocurrencyFunds(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "withdrawcryptofunds")
-		return nil
+		return cli.ShowCommandHelp(c, "withdrawcryptofunds")
 	}
 
 	var exchange, cur, address, addressTag, description string
@@ -2405,8 +2383,7 @@ var withdrawFiatFundsCommand = cli.Command{
 
 func withdrawFiatFunds(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "withdrawfiatfunds")
-		return nil
+		return cli.ShowCommandHelp(c, "withdrawfiatfunds")
 	}
 
 	var exchange, cur, description, bankAccountID string
@@ -2746,8 +2723,7 @@ var getLoggerDetailsCommand = cli.Command{
 
 func getLoggerDetails(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "getloggerdetails")
-		return nil
+		return cli.ShowCommandHelp(c, "getloggerdetails")
 	}
 
 	var logger string
@@ -2800,8 +2776,7 @@ var setLoggerDetailsCommand = cli.Command{
 
 func setLoggerDetails(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "setloggerdetails")
-		return nil
+		return cli.ShowCommandHelp(c, "setloggerdetails")
 	}
 
 	var logger string
@@ -2871,8 +2846,7 @@ var getOrderbookStreamCommand = cli.Command{
 
 func getOrderbookStream(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "getorderbookstream")
-		return nil
+		return cli.ShowCommandHelp(c, "getorderbookstream")
 	}
 
 	var exchangeName string
@@ -3011,8 +2985,7 @@ var getExchangeOrderbookStreamCommand = cli.Command{
 
 func getExchangeOrderbookStream(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "getexchangeorderbookstream")
-		return nil
+		return cli.ShowCommandHelp(c, "getexchangeorderbookstream")
 	}
 
 	var exchangeName string
@@ -3082,8 +3055,7 @@ var getTickerStreamCommand = cli.Command{
 
 func getTickerStream(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "gettickerstream")
-		return nil
+		return cli.ShowCommandHelp(c, "gettickerstream")
 	}
 
 	var exchangeName string
@@ -3192,8 +3164,7 @@ var getExchangeTickerStreamCommand = cli.Command{
 
 func getExchangeTickerStream(c *cli.Context) error {
 	if c.NArg() == 0 && c.NumFlags() == 0 {
-		cli.ShowCommandHelp(c, "getexchangetickerstream")
-		return nil
+		return cli.ShowCommandHelp(c, "getexchangetickerstream")
 	}
 
 	var exchangeName string