Merge pull request #19 from bmf-san/feature/1.0.1

Minor fixes and refactoring

Author: bmf-san

.env.example

@@ -1,8 +1,3 @@
 # bitflyer
 BITFLYER_API_KEY=
 BITFLYER_API_SECRET=
-
-# redis
-REDIS_HOST=redis
-REDIS_PORT=6379
-REDIS_PASSWORD=

.gitignore

@@ -1,5 +1,4 @@
 .env
-oilking
-!app/log/.gitkeep
+/app/oilking
 /redis/data
 !/redis/data/.gitkeep

README.md

@@ -4,7 +4,14 @@
 
 A trading bot using bitflyer api.
 
-If you use the code, please take responsibility at your own risk. We do not take any responsibility even if you suffer a loss.
+This repository is a template repository, so if you use it, we recommend using it as a template repository.
+
+cf. [docs.github.com - creating-a-repository-from-a-template](https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template)
+
+# Disclaimer
+Please take responsibility at your own risk if you use this program. 
+
+We do not take any responsibility even if you suffer a loss.
 
 # Get started
 ## Set enviroment variables
@@ -19,7 +26,12 @@ Build the source code.
 Run the binary file.
 `make docker-compose-up` or `make docker-compose-up-d`
 
-# Supporting API
+# Exchange marketplaces supported
+|      Support       | Exchange markeplaces |
+| ------------------ | -------------------- |
+| :white_check_mark: | Bitflyer             |
+
+# API supported
 ## HTTP API
 ### HTTP Public API
 |      Support       | Method |     Endpoint      |

app/_examples/main.go

@@ -13,16 +13,7 @@ import (
 
 // Example codes for api client.
 func main() {
-	// TODO: Replace with test code later.
 	l := logger.NewLogger(logger.LevelInfo, time.FixedZone("Asia/Tokyo", 9*60*60))
-	f, err := l.SetOutput()
-	if err != nil {
-		l.Error(logger.Entry{
-			Message: err.Error(),
-		})
-		os.Exit(1)
-	}
-	defer f.Close()
 	ak := os.Getenv("BITFLYER_API_KEY")
 	as := os.Getenv("BITFLYER_API_SECRET")
 	c := api.NewClient(ak, as, l)

app/logger/logger.go

@@ -17,9 +17,6 @@ const (
 	LevelError
 	// LevelFatal is an abend error.
 	LevelFatal
-)
-
-const (
 	// LevelTextInfo is the text for info.
 	LevelTextInfo = "info"
 	// LevelTextWarn is the text for warn.
@@ -28,6 +25,24 @@ const (
 	LevelTextError = "error"
 	// LevelTextFatal is the text for fatal.
 	LevelTextFatal = "fatal"
+	// LabelBalance is a label for balance.
+	LabelBalance = "[Balance]"
+	// LabelBalanceHistory is a label for balance history.
+	LabelBalanceHistory = "[Balance History]"
+	// LabelChat is a label for chat.
+	LabelChat = "[Chat]"
+	// LabelChildOrder is a label for child order.
+	LabelChildOrder = "[ChildOrder]"
+	// LabelCollateral is a label for collateral.
+	LabelCollateral = "[Collateral]"
+	// LabelExecution is a label for execution.
+	LabelExecution = "[Execution]"
+	// LabelPosition is a label for position.
+	LabelPosition = "[Position]"
+	// LabelTicker is a label for Ticker.
+	LabelTicker = "[Ticker]"
+	// LabelTradingCommission is a label for trading commission.
+	LabelTradingCommission = "[Trading Commission]"
 )
 
 var levelText = map[int]string{
@@ -73,8 +88,8 @@ type AccessLogEntry struct {
 type TradingLogEntry struct {
 	Level  string    `json:"level"`
 	Time   time.Time `json:"time"` // UTC
+	Label  string    `json:"label"`
 	Action string    `json:"action"`
-	Result string    `json:"result"`
 }
 
 // NewLogger creates a logger.
@@ -116,7 +131,6 @@ func (l *Logger) Fatal(entry interface{}) {
 
 // OutputJSON outputs logs.
 func (l *Logger) OutputJSON(level string, entry interface{}) error {
-	// HACK: I think it's better to handle errors.
 	switch reflect.TypeOf(entry).Name() {
 	case "Entry":
 		if e, ok := entry.(Entry); ok {

app/main.go

@@ -11,25 +11,14 @@ import (
 	"github.com/bmf-san/oilking/app/model"
 	"github.com/bmf-san/oilking/app/trade"
 	"github.com/bmf-san/oilking/app/types"
-	"github.com/go-redis/redis/v7"
 )
 
 func main() {
 	l := logger.NewLogger(logger.LevelInfo, time.FixedZone("Asia/Tokyo", 9*60*60))
 	ak := os.Getenv("BITFLYER_API_KEY")
 	as := os.Getenv("BITFLYER_API_SECRET")
 	c := api.NewClient(ak, as, l)
-	// TODO: I haven't planned to use it yet, so I commented it out.
-	// db := database.NewDB()
-	// d, err := db.Conn()
-	// if err != nil {
-	// 	l.Error(logger.Entry{
-	// 		Message: err.Error(),
-	// 	})
-	// 	os.Exit(1)
-	// }
-	// defer d.Close()
-	t := trade.NewTrade(c, l, &redis.Client{})
+	t := trade.NewTrade(c, l)
 	ch := make(chan model.TickerResponse)
 	w := &model.Writer{
 		Channel:       types.ChannelTickerFXBTCJPY,

app/trade/logic.go

@@ -10,40 +10,26 @@ import (
 	"github.com/bmf-san/oilking/app/logger"
 	"github.com/bmf-san/oilking/app/model"
 	"github.com/bmf-san/oilking/app/types"
-	"github.com/go-redis/redis/v7"
 )
 
 const (
-	// NOTE: These values ​​can be parameterized later.
 	// targetProductCode is a types for trading.
 	targetProductCode = types.ProductCodeFXBTCJPY
 	// targetSize is a size for buy or sell.
 	targetSize = 0.01
-
-	// TODO: Will be defined later in the logger.
-	// NOTE: These values user for logging. It ​​may be used when implementing reporting services.
-	// NOTE: It seems better to prepare the action name as well. ex. [ACTION]
-	// labelPosition is a label for position.
-	labelPosition = "[Position]"
-	// labelOrder is a label for order.
-	labelOrder = "[Order]"
-	// labelCollateral is a label for collateral.
-	labelCollateral = "[Collateral]"
 )
 
 // Trade is a trade.
 type Trade struct {
 	apiClient *api.Client
 	logger    *logger.Logger
-	dbClient  *redis.Client
 }
 
 // NewTrade creates a new trade.
-func NewTrade(c *api.Client, l *logger.Logger, db *redis.Client) *Trade {
+func NewTrade(c *api.Client, l *logger.Logger) *Trade {
 	return &Trade{
 		apiClient: c,
 		logger:    l,
-		dbClient:  db,
 	}
 }
 
@@ -101,8 +87,9 @@ func (t *Trade) buy(p float64) {
 			Message: err.Error(),
 		})
 	} else {
-		t.logger.Info(logger.Entry{
-			Message: fmt.Sprintf("%s send a child order", labelOrder),
+		t.logger.Info(logger.TradingLogEntry{
+			Label:  logger.LabelChildOrder,
+			Action: "send a child order",
 		})
 	}
 }
@@ -124,8 +111,9 @@ func (t *Trade) sell(p float64) {
 			Message: err.Error(),
 		})
 	} else {
-		t.logger.Info(logger.Entry{
-			Message: fmt.Sprintf("%s send a child order", labelOrder),
+		t.logger.Info(logger.TradingLogEntry{
+			Label:  logger.LabelChildOrder,
+			Action: "send a child order",
 		})
 	}
 }
@@ -195,12 +183,13 @@ func (t *Trade) StopSafety() {
 			Message: err.Error(),
 		})
 	} else {
-		t.logger.Info(logger.Entry{
-			Message: fmt.Sprintf("%s All orders have been cancelled.", labelOrder),
+		t.logger.Info(logger.TradingLogEntry{
+			Label:  logger.LabelChildOrder,
+			Action: "all orders have been cancelled",
 		})
 	}
 
-	// I want to close the position by counter-trading, but for the time being I will make an error instead of an alert.
+	// Check the remaining open interest
 	pp := &model.PositionParams{
 		ProductCode: targetProductCode,
 	}
@@ -210,8 +199,13 @@ func (t *Trade) StopSafety() {
 			Message: err.Error(),
 		})
 	} else {
-		t.logger.Info(logger.Entry{
-			Message: fmt.Sprintf("%s %d positions", labelPosition, len(pr)),
+		msg := "no positions"
+		if len(pr) > 0 {
+			msg = fmt.Sprintf("get %d positions", len(pr))
+		}
+		t.logger.Info(logger.TradingLogEntry{
+			Label:  logger.LabelPosition,
+			Action: msg,
 		})
 	}
 }

docker-compose.yml

@@ -9,16 +9,4 @@ services:
         dockerfile: "Dockerfile"
     ports:
       - "8083:8083"
-    restart: always
-  redis:
-    container_name: "oilking-redis"
-    env_file: ".env"
-    build:
-        context: "./redis"
-        dockerfile: "Dockerfile"
-    ports:
-      - "6379:6379"
-    volumes:
-      - ./redis/data:/var/lib/redis
-    depends_on:
-      - app
+    restart: always