Merge pull request #20 from saniales/refactoring

Refactoring and enhancing model

Author: saniales

.bot_config.yaml.example

@@ -0,0 +1,29 @@
+exchange_configs: 
+  - exchange: bittrex
+    public_key: your_bittrex_public_key
+    secret_key: your_bittrex_secret_key
+  - exchange: binance
+    public_key: your_binance_public_key
+    secret_key: your_binance_secret_key
+  - exchange: bitfinex
+    public_key: your_bitfinex_public_key
+    secret_key: your_bitfinex_secret_key
+strategies:
+  - strategy: your_strategy_name
+    markets:
+      - market: market_logical_name
+        bindings:
+        - exchange: bittrex
+          market_name: market_name_on_bittrex
+        - exchange: binance
+          market_name: market_name_on_binance
+        - exchange: bitfinex
+          market_name: market_name_on_bitfinex
+      - market: another_market_logical_name
+        bindings:
+        - exchange: bittrex
+          market_name: market_name_on_bittrex
+        - exchange: binance
+          market_name: market_name_on_binance
+        - exchange: bitfinex
+          market_name: market_name_on_bitfinex

.gitignore

@@ -23,4 +23,7 @@ _testmain.go
 *.test
 *.prof
 
-golang-crypto-trading-bot
+golang-crypto-trading-bot
+
+.bot_config.yaml
+.bot_config.yml

.gobot

@@ -1,7 +1,7 @@
 language: go
 
 go:
-  - 1.8
+  - "1.10"
 
-before_install: go get ./...
+before_install: go get -t ./...
 go_import_path: github.com/saniales/golang-crypto-trading-bot

.travis.yml

@@ -1,21 +1,68 @@
 # golang-crypto-trading-bot
+
+[![Release](https://img.shields.io/github/downloads/saniales/golang-crypto-trading-bot/total.svg)](https://github.com/yangwenmai/how-to-add-badge-in-github-readme/releases)
+[![Documentation](https://godoc.org/github.com/saniales/golang-crypto-trading-bot?status.svg)](https://github.com/saniales/golang-crypto-trading-bot)
+[![Travis CI](https://img.shields.io/travis/saniales/golang-crypto-trading-bot.svg)]((https://github.com/saniales/golang-crypto-trading-bot))
+[![Go Report Card](https://goreportcard.com/badge/github.com/saniales/golang-crypto-trading-bot.svg?branch=master)](https://github.com/saniales/golang-crypto-trading-bot)
+[![GitHub release](https://img.shields.io/github/release/saniales/golang-crypto-trading-bot.svg)](https://github.com/saniales/golang-crypto-trading-bot/releases)
+[![license](https://img.shields.io/github/license/saniales/golang-crypto-trading-bot.svg?maxAge=2592000)](https://github.com/saniales/golang-crypto-trading-bot/LICENSE)
+
+
 A golang implementation of a console-based trading bot for cryptocurrency exchanges, can be deployed to heroku too. 
 
-# Supported Exchanges
-Bittrex, Poloniex (both works in progress)
+## Supported Exchanges
+Bittrex, Poloniex, Binance, Bitfinex and Kraken, other in progress.
+
+## Usage
 
-# Usage
-Create a strategy by implementing Strategy interface and add it to the bot, then compile and execute the bot specifying the --strategy flag and --exchange flag
+Download a release or directly build the code from this repository.
+``` bash
+$ go get github.com/saniales/golang-crypto-trading-bot
+```
 
-`go run gobot.go --exchange bittrex --strategy myCustomStrategyName`
+If you need to, you can create a strategy and bind it to the bot:
+``` go
+import bot "github.com/saniales/golang-crypto-trading-bot/cmd"
 
-You can use the --simulate flag to avoid trade but just simulate them.
-There is also a --watch flag to print info about markets to the console continuously.
+bot.AddCustomStrategy(myStrategy)
+bot.Execute()
+```
 
-Kill the bot by using CTRL+C  or SIGINT signal (on linux, Command+C on MacOsX).
+For strategy reference see the [Godoc documentation](https://godoc.org/github.com/saniales/golang-crypto-trading-bot).
 
-# Current version
-[pre-alpha 0.0.0.1]
+# Configuration file template
+Create a configuration file from this example or run the `init` command of the compiled executable.
+``` yaml
+exchange_configs: 
+  - exchange: bittrex
+    public_key: your_bittrex_public_key
+    secret_key: your_bittrex_secret_key
+  - exchange: binance
+    public_key: your_binance_public_key
+    secret_key: your_binance_secret_key
+  - exchange: bitfinex
+    public_key: your_bitfinex_public_key
+    secret_key: your_bitfinex_secret_key
+strategies:
+  - strategy: your_strategy_name
+    markets:
+      - market: market_logical_name
+        bindings:
+        - exchange: bittrex
+          market_name: market_name_on_bittrex
+        - exchange: binance
+          market_name: market_name_on_binance
+        - exchange: bitfinex
+          market_name: market_name_on_bitfinex
+      - market: another_market_logical_name
+        bindings:
+        - exchange: bittrex
+          market_name: market_name_on_bittrex
+        - exchange: binance
+          market_name: market_name_on_binance
+        - exchange: bitfinex
+          market_name: market_name_on_bitfinex
+```
 
 # Donate
 Feel free to donate:

README.md

@@ -1,4 +1,4 @@
-package botHelpers
+package helpers
 
 import (
 	"github.com/saniales/golang-crypto-trading-bot/environment"
@@ -13,32 +13,12 @@ func InitExchange(exchangeConfig environment.ExchangeConfig) exchanges.ExchangeW
 	case "bittrexV2":
 		return exchanges.NewBittrexV2Wrapper(exchangeConfig.PublicKey, exchangeConfig.SecretKey)
 	case "poloniex":
-		return nil
-	case "yobit":
-		return nil
-	case "cryptopia":
-		return nil
+		return exchanges.NewPoloniexWrapper(exchangeConfig.PublicKey, exchangeConfig.SecretKey)
+	case "binance":
+		return exchanges.NewBinanceWrapper(exchangeConfig.PublicKey, exchangeConfig.SecretKey)
+	case "bitfinex":
+		return exchanges.NewBitfinexWrapper(exchangeConfig.PublicKey, exchangeConfig.SecretKey)
 	default:
 		return nil
 	}
 }
-
-//InitMarkets uses ExchangeWrapper to find info about markets and initialize them.
-func InitMarkets(exchange exchanges.ExchangeWrapper) (map[string]*environment.Market, error) {
-	markets, err := exchange.GetMarkets()
-	if err != nil {
-		return nil, err
-	}
-
-	marketMap := make(map[string]*environment.Market, len(markets))
-	for _, market := range markets {
-		marketMap[market.Name] = market
-	}
-
-	err = exchange.GetMarketSummaries(marketMap)
-	if err != nil {
-		return nil, err
-	}
-
-	return marketMap, nil
-}

botHelpers/bot_helper.go renamed to bot_helpers/bot_helper.go

@@ -82,12 +82,42 @@ func initConfig() {
 
 func generateInitFile() {
 	configs := environment.BotConfig{}
-	fmt.Println("Which exchange are you going to use?")
-	fmt.Scanln(&configs.Exchange.ExchangeName)
-	fmt.Println("Please provide Public Key for that exchange.")
-	fmt.Scanln(&configs.Exchange.PublicKey)
-	fmt.Println("Please provide Secret Key for that exchange.")
-	fmt.Scanln(&configs.Exchange.SecretKey)
+	for {
+		var exchange environment.ExchangeConfig
+		var YesNo string
+
+		fmt.Println("Which exchange are you going to add?")
+		fmt.Scanln(&exchange.ExchangeName)
+
+		alreadyAdded := false
+		for _, ex := range configs.ExchangeConfigs {
+			if ex.ExchangeName == exchange.ExchangeName {
+				alreadyAdded = true
+				break
+			}
+		}
+
+		if alreadyAdded {
+			fmt.Println("Exchange already added, retry.")
+			continue
+		}
+
+		fmt.Println("Please provide Public Key for that exchange.")
+		fmt.Scanln(&exchange.PublicKey)
+		fmt.Println("Please provide Secret Key for that exchange.")
+		fmt.Scanln(&exchange.SecretKey)
+
+		configs.ExchangeConfigs = append(configs.ExchangeConfigs, exchange)
+
+		fmt.Println("Exchange Added")
+		for YesNo != "Y" && YesNo != "n" {
+			fmt.Println("Do you want to add another exchange? (Y/n)")
+			fmt.Scanln(&YesNo)
+		}
+		if YesNo == "n" {
+			break
+		}
+	}
 
 	for {
 		var YesNo string
@@ -98,13 +128,46 @@ func generateInitFile() {
 		if YesNo == "n" {
 			break
 		}
+
 		var tempStrategyAppliance environment.StrategyConfig
-		fmt.Println("Please Enter Market Name using short notation " +
-			"(e.g. BTC-ETH for a Bitcoin-Ethereum market).")
-		fmt.Scanln(&tempStrategyAppliance.Market)
+
 		fmt.Println("Please Enter The Name of the strategy you want to use\n" +
 			"in this market (must be in the system)")
 		fmt.Scanln(&tempStrategyAppliance.Strategy)
+
+		for {
+			var tmpMarketConf environment.MarketConfig
+			fmt.Println("Please Enter Market Name using short notation " +
+				"(e.g. BTC-ETH for a Bitcoin-Ethereum market).")
+			fmt.Scanln(&tmpMarketConf.Name)
+			for _, ex := range configs.ExchangeConfigs {
+				var exMarketName string
+				fmt.Printf("Please Enter %s exchange market ticker, or leave empty to skip this exchange\n", ex.ExchangeName)
+				fmt.Scanln(&exMarketName)
+
+				if exMarketName != "" {
+					tmpMarketConf.Exchanges = append(tmpMarketConf.Exchanges, environment.ExchangeBindingsConfig{
+						Name:       ex.ExchangeName,
+						MarketName: exMarketName,
+					})
+					fmt.Printf("Exchange %s CONFIGURED with Market Name %s\n", ex.ExchangeName, exMarketName)
+				} else {
+					fmt.Printf("Exchange %s SKIPPED\n", ex.ExchangeName)
+				}
+			}
+
+			tempStrategyAppliance.Markets = append(tempStrategyAppliance.Markets, tmpMarketConf)
+
+			var YesNo string
+			for YesNo != "Y" && YesNo != "n" {
+				fmt.Println("Do you want to add another market binded to this strategy? (Y/n)")
+				fmt.Scanln(&YesNo)
+			}
+			if YesNo == "n" {
+				break
+			}
+		}
+
 		configs.Strategies = append(configs.Strategies, tempStrategyAppliance)
 	}
 

cmd/init.go

@@ -30,8 +30,8 @@ const (
 // RootCmd represents the base command when called without any subcommands
 var RootCmd = &cobra.Command{
 	Use:   "gobot",
-	Short: "USAGE gobot [OPTIONS].",
-	Long:  `USAGE gobot [OPTIONS] : see --help for details`,
+	Short: fmt.Sprintf("USAGE %s [OPTIONS]", os.Args[0]),
+	Long:  fmt.Sprintf(`USAGE %s [OPTIONS] : see --help for details`, os.Args[0]),
 	Run:   executeRootCommand,
 }
 
@@ -60,7 +60,7 @@ func init() {
 	RootCmd.PersistentFlags().CountVarP(&GlobalFlags.Verbose, "verbose", "v", "show verbose information when trading : use multiple times to increase verbosity level.")
 
 	RootCmd.Flags().BoolVarP(&rootFlags.Version, "version", "V", false, "show version information.")
-	RootCmd.PersistentFlags().StringVar(&GlobalFlags.ConfigFile, "config-file", "./.gobot", "Config file path (default : ./.gobot)")
+	RootCmd.PersistentFlags().StringVar(&GlobalFlags.ConfigFile, "config-file", "./.bot_config.yaml", "Config file path (default : ./.bot_config.yaml)")
 }
 
 func executeRootCommand(cmd *cobra.Command, args []string) {