Info and log fixes

.gitignore

@@ -9,3 +9,4 @@ src/test2.py
 tradingLog.log
 generalLog.log
 src/.env
+data/

README-EN.md

@@ -0,0 +1,47 @@
+# [ENG] Side Strategy Bybit Bot
+This is a simple semi-automatic trading bot working with Bybit API and written in Python.
+The strategy is based on the side moving of the token which crosses user input levels. On the level cross long and short orders are opened.
+
+# Install guide
+Bot is installed via **docker compose** file and **docker pull** command.
+This "guide" is made for **linux** and **docker**, but you should be able to run this bot on any system with *Python 3*.
+### Installing via `docker compose`:
+1) Create bot directory
+2) Pull image from git:
+```sh
+docker pull git.frik.su/eugenebee/tradingbot-with-bybitapi:latest
+```
+3) Create **compose.yml** file:
+```yaml
+services:
+  bybit-bot:
+    image: git.frik.su/eugenebee/tradingbot-with-bybitapi:latest
+    container_name: bybit-bot
+    environment:
+      API_KEY: "bybit-API-key"
+      API_SECRET: "bybit-secret-API-key"
+      BOT_TOKEN: "telegram-bot-token"
+      WHITELIST: "chat-id-1, chat-id-2"
+      LEVERAGE: "1" # Currently not supported. Set leverage in your Bybit account
+      TESTNET: "False"
+      DEMOTRADING: "False"
+      LOOPSLEEPTIME: "1"
+      SHOWEXTRADEBUGLOGS: "False"
+    volumes:
+      - ./data:/app/data
+    restart: unless-stopped
+```
+### After the basic pre-setup:
+*It is recommended to use Bybit sub accaunt forn the bot.*
+1) Get your **API** keys for the **Bybit** and **Telegram**
+2) Enter those in the **compose.yml** variables and your **Telegram id** into the `WHITELIST` 
+2) At the **Bybit** platform turn on hedge mode foor all tokens you want the bot to trade
+3) Read the milk leaves and then make ***4*** circles around the server with the bee hive in your hands
+4) Everything is ready for the first start, enjoy!
+### To start up the bot enter the next command:
+```sh
+docker compose up -d
+```
+*If you need use the `sudo` before the command*
+
+Thank you for reafing, hope everything will work fine!

README.md

@@ -1,4 +1,47 @@
-# Side Strategy Bybit Bot
+# [RU] Side Strategy Bybit Bot
-This is a simple semi-automatic trading bot working with Bybit API and written in Python.
+Это достаточно простой полуавтоматический торговый бот, работающий с Bybit API, написанный на Python. 
-The strategy is based on the side moving of the token which crosses user input levels. On the level cross long and short orders are opened.
+Стратегия основана на боковом движении цены токена и пересечении заданных пользователей уровней. При пересечении уровня открываются long и short позиции.
-### For the install and setup guide look at the `setup.md`
+
+## Установка
+Бот устанавливается с помощью **docker compose** файла и **docker pull**.
+Данный "гайд" расчитан на **linux** и **docker**, однако вы можете развернуть данное приложение/бота на любой системе с *Python 3*.
+### Для установки через `docker compose`:
+1) Создайте директорию для бота
+2) Введите команду:
+```sh
+docker pull git.frik.su/eugenebee/tradingbot-with-bybitapi:latest
+```
+3) Создайте **compose.yml** файл с следующим содержимым:
+```yaml
+services:
+  bybit-bot:
+    image: git.frik.su/eugenebee/tradingbot-with-bybitapi:latest
+    container_name: bybit-bot
+    environment:
+      API_KEY: "bybit-API-key"
+      API_SECRET: "bybit-secret-API-key"
+      BOT_TOKEN: "telegram-bot-token"
+      WHITELIST: "chat-id-1, chat-id-2"
+      LEVERAGE: "1" # Временно не поддерживается, устанавливайте плечо в вашем Bybit аккаунте
+      TESTNET: "False"
+      DEMOTRADING: "False"
+      LOOPSLEEPTIME: "1"
+      SHOWEXTRADEBUGLOGS: "False"
+    volumes:
+      - ./data:/app/data
+    restart: unless-stopped
+```
+### После базовой развёртки выполните следующие шаги:
+*Рекомендуется использовать суб аккаунт Bybit для бота.*
+1) Получите **API** ключи на **Bybit** и **Telegram**. Рекомендуем использовать суб аккаунт Bybit для бота
+2) Введите в **compose.yml** свои ключи в соответствующие поля и ваш **Telegram id** в `WHITELIST` 
+2) На платформе **Bybit** включите режим хеджирования на все пары, которыми планируете торговать
+3) Погадайте на молочной гуще и сделайте ***4*** круга с пчелиным ульем вокруг сервера
+4) Всё готово к запуску, наслаждайтесь!
+### Для запуска бота введите следующую команду:
+```sh
+docker compose up -d
+```
+*По надобности используйте `sudo` перед командой*
+
+Спасибо что заглянули, желаем удачной настройки и стабильной работы!

compose.yml

@@ -0,0 +1,17 @@
+services:
+  bybit-bot:
+    image: git.frik.su/eugenebee/tradingbot-with-bybitapi:latest
+    container_name: bybit-bot
+    environment:
+      API_KEY: "bybit-API-key"
+      API_SECRET: "bybit-secret-API-key"
+      BOT_TOKEN: "telegram-bot-token"
+      WHITELIST: "chat-id-1, chat-id-2"
+      LEVERAGE: "1" # Not supported. Set leverage in bybit account
+      TESTNET: "False"
+      DEMOTRADING: "False"
+      LOOPSLEEPTIME: "1"
+      SHOWEXTRADEBUGLOGS: "False"
+    volumes:
+      - ./data:/app/data
+    restart: unless-stopped

setup.md

@@ -1,25 +0,0 @@
-# Краткий гайд по установке и настройке бота.
-Бот устанавливается с помощью **docker compose** файла и **git pull** (предварительно) и последующей лёгкой настройки через файлы.
-Данный "гайд" расчитан на **linux** и **docker**, однако вы можете развернуть данное приложение/бота на любой системе с *Python 3*.
-### Для установки через `docker compose`:
-1) Создайте директорию для бота
-2) Введите команду:
-```
-git clone
-```
-### После базовой развёртки выполните следующие шаги:
-1) Создайте data.json файл и заполните его данным содержимым:
-```> {}```
-2) Создайте файл `credentials.py` в `src/` и заполните его по аналогии с `cretentialsExample.py` 
-*Рекомендуется использовать суб аккаунт Bybit для бота*
-3) Настройте options.py файл на ваше усмотрение (обратите особо внимание на параметр `testnet`)
-4) Погадайте на молочной гуще и сделайте ***4*** круга с пчелиным ульем вокруг сервера
-5) Всё готово к запуску, наслаждайтесь!
-### Для запуска бота введите следующую команду:
-```
-docker compose up -d
-```
-*По надобности используйте `sudo` перед командой*
-6) На платформе **Bybit** включите режим хеджирования на все пары, которыми планируете торговать
-
-Спасибо что заглянули, желаем удачной настройки и стабильной работы!

src/arbus.py

@@ -7,11 +7,11 @@ from random import randint
 startTime = None
 
 def setStartTime():
+    global startTime
     startTime = time.time()
 
 def getPnL(pair):
-    PnL = 0.0
+    with open("./data/tradingLog.log", "r") as f:
-    with open("tradingLog.log", "r") as f:
         lines = f.readlines()
 
     logEntries = []
@@ -25,7 +25,7 @@ def getPnL(pair):
 
     strategyStartTime = None
     for timestamp, message in logEntries:
-        if message == f"Starting strategy with {pair}":
+        if message == (f"Starting strategy with {pair}"):
             strategyStartTime = timestamp
 
     if not strategyStartTime:

src/bybit.py

@@ -14,6 +14,33 @@ from logger import generalLogger
 from logger import tradingLogger
 
 
+def getPrice(client, pair):
+    ticker = client.get_tickers(
+        category = "linear",
+        symbol = pair
+    )
+    price = float(ticker.get('result').get('list')[0].get('ask1Price'))
+    return price
+
+def getStartBalance(client, pair):
+    coin = pair[:-4]
+    response = client.get_wallet_balance(
+        accountType = "UNIFIED",
+        coin = coin
+    )
+    balance = float(response['result']['list'][0]['totalAvailableBalance'])
+    return balance
+
+def getStartFilters(client, pair):
+    instrumentInfo = client.get_instruments_info(
+        symbol = pair,
+        category = "linear"
+    )
+    infoContents = instrumentInfo.get('result').get('list')[0]
+    minimumQty = float(infoContents.get('lotSizeFilter').get('minOrderQty'))
+    return minimumQty
+
+
 class tradingData:
     def __init__(self, pair, levels, highBreak, lowBreak, takeDelta, stopDelta, orderSize):
         self.client = HTTP(
@@ -32,7 +59,7 @@ class tradingData:
         self.orderSize = orderSize
         self.priceDecimals, self.qtyDecimals, self.minimumQty = self.getFilters(pair)
         self.previousPrice = -1
-        self.counter = 0
+        self.orderCounter = 0
 
 
     def getBalance(self, pair):
@@ -120,6 +147,7 @@ class tradingData:
                 stopLoss = str(sl),
                 tpslMode = "Full"
             )
+            self.orderCounter += 1
             orderID = response.get('result').get('orderId')
 
             generalLogger.info(f"Placed oder on {self.pair} with TP {tp}; SL {sl}")
@@ -182,10 +210,14 @@ class tradingData:
                             j['long'] = False
                             j['longIDs'] = ['-1', '-1', '-1']
                             generalLogger.info(f"Long order on {self.pair} level {j['price']} triggered TP/SL")
+                            tradingLogger.info(f"Long order on {self.pair} level {j['price']} triggered TP/SL")
+                            self.orderCounter -= 1
                         if orderID in shortIDs:
                             j['short'] = False
                             j['shortIDs'] = ['-1', '-1', '-1']
                             generalLogger.info(f"Short order on {self.pair} level {j['price']} triggered TP/SL")
+                            tradingLogger.info(f"Short order on {self.pair} level {j['price']} triggered TP/SL")
+                            self.orderCounter -= 1
                 if orderStatus == 'Filled':
                     for j in self.levels:
                         longIDs = j['longIDs']
@@ -194,6 +226,7 @@ class tradingData:
                             generalLogger.info(f"Long order on {self.pair} level {j['price']} filled with P&L {i['closedPnl']} and qty {i['qty']}")
                             tradingLogger.info(f"Long order on {self.pair} level {j['price']} filled with P&L {i['closedPnl']} and qty {i['qty']}")
                         if orderID in shortIDs:
+                            generalLogger.info(f"Short order on {self.pair} level {j['price']} filled with P&L {i['closedPnl']} and qty {i['qty']}")
                             tradingLogger.info(f"Short order on {self.pair} level {j['price']} filled with P&L {i['closedPnl']} and qty {i['qty']}")
 
 
@@ -217,6 +250,7 @@ async def getClient(apiKey, apiSecret, testnet, demoTrading):
 
 async def strategy(pair: str, params):
     generalLogger.info('Starting strategy with ' + pair)
+    tradingLogger.info('Starting strategy with ' + pair)
 
     paramsDict = await jsonProcessing.parseParams(params)
     

src/jsonProcessing.py

@@ -8,12 +8,18 @@ from logger import generalLogger
 import options
 
 
+jsonPath = 'data/data.json'
+
+
 def startUp():
-    filePath = 'data.json'
+    filePath = jsonPath
+
+    if not(os.path.exists('data')):
+        os.mkdir('data')
 
     if os.path.exists(filePath):
-        timestamp = datetime.now().strftime('%Y-%m-%d_%H:%M:%S')
+        timestamp = datetime.now().strftime('%Y-%m-%d_%H-%M-%S')
-        backupPath = (f'data_backup_{timestamp}.json')
+        backupPath = (f'data/data_backup_{timestamp}.json')
         shutil.copy(filePath, backupPath)
         generalLogger.info(f'JSON backup was created: {backupPath}')
 
@@ -26,6 +32,9 @@ async def parseParams(params):
     # Returnes dictionary of string params as paramsLines in options
     paramsList = params.split()
     paramsDict = {}
+    if len(paramsList) != len(options.paramsLines):
+        return -1
+
     for i in range(len(options.paramsLines)):
         paramsDict[options.paramsLines[i]] = paramsList[i]
     return paramsDict
@@ -47,10 +56,10 @@ async def checkPair(pair: str):
     # Returnes 1 if pair exists and 0 if not
     currentData = {}
     try:
-        with open('data.json', 'r') as f:
+        with open(jsonPath, 'r') as f:
             currentData = json.load(f)
     except json.decoder.JSONDecodeError as e:
-        generalLogger.info('WARNING: JSON file is empty! Ignore if your installation is fresh.')
+        generalLogger.warning('JSON file is empty!')
 
     if pair in currentData:
         return 1
@@ -61,14 +70,14 @@ async def deletePair(pair: str):
     # Returnes 0 if deleted successfully and -1 if not
     currentData = {}
     try:
-        with open('data.json', 'r') as f:
+        with open(jsonPath, 'r') as f:
             currentData = json.load(f)
     except json.decoder.JSONDecodeError as e:
-        generalLogger.info('WARNING: JSON file is empty! Ignore if your installation is fresh.')
+        generalLogger.warning('JSON file is empty!')
 
     if pair in currentData:
         del currentData[pair]
-        with open('data.json', 'w', encoding = 'utf-8') as f:
+        with open(jsonPath, 'w', encoding = 'utf-8') as f:
             json.dump(currentData, f, ensure_ascii = False, indent = 4)
         generalLogger.info(f'Pair {pair} was deleted successfully!')
         return 0
@@ -85,16 +94,16 @@ async def savePairParams(pair: str, params):
 
     currentData = {}
     try:
-        with open('data.json', 'r') as f:
+        with open(jsonPath, 'r') as f:
             currentData = json.load(f)
     except json.decoder.JSONDecodeError as e:
-        generalLogger.info('WARNING: JSON file is empty! Ignore if your installation is fresh.')
+        generalLogger.warning('JSON file is empty!')
 
     if pair in currentData:
         generalLogger.info(f"Pair {pair} already exists.")
         return -2
     else:
-        with open('data.json', 'w', encoding = 'utf-8') as f:
+        with open(jsonPath, 'w', encoding = 'utf-8') as f:
             currentData.update(newData)
             json.dump(currentData, f, ensure_ascii = False, indent = 4)
         generalLogger.info(f"Pair {pair} was added!")
@@ -105,8 +114,8 @@ async def loadJson():
     # Returnes the contents of the JSON file as a dictionary
     data = {}
     try:
-        with open('data.json', 'r') as f:
+        with open(jsonPath, 'r') as f:
             data = json.load(f)
     except json.decoder.JSONDecodeError as e:
-        generalLogger.info('WARNING: JSON file is empty! Ignore if your installation is fresh.')
+        generalLogger.warning('JSON file is empty!')
     return data

src/logger.py

@@ -1,11 +1,12 @@
 import logging
 import sys
+import os
 
 import options
 
 
-generalLogPath = "./generalLog.log"
+generalLogPath = "./data/generalLog.log"
-tradingLogPath = "./tradingLog.log"
+tradingLogPath = "./data/tradingLog.log"
 
 
 def setupLogger(name, level, logPath, formatter):
@@ -23,15 +24,18 @@ def setupLogger(name, level, logPath, formatter):
     return logger
 
 
+if not(os.path.exists('data')):
+    os.mkdir('data')
+
 # Основной лог
 generalFormatter = logging.Formatter('%(asctime)s - %(module)s - %(levelname)s - %(message)s')
 generalLogger = setupLogger('general', logging.INFO, generalLogPath, generalFormatter)
 
-# Торговый лог (ордера)
+# Торговый лог (открытие, закрытие ордеров, запуск стратегии)
 tradingFormatter = logging.Formatter('%(asctime)s - %(message)s')
 tradingLogger = setupLogger('trade', logging.NOTSET, tradingLogPath, tradingFormatter)
 
-# Максимально подробный общий лог, вызывает повторы в логировании. Его наличие настраивается
+# Максимально подробный дебаг лог, вызывает повторы в логировании. Его наличие настраивается
 if options.showExtraDebugLogs:
-    logging.basicConfig(level=logging.DEBUG)
+    logging.basicConfig(level=logging.DEBUG, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s')
     superGeneralLogger = logging.getLogger('superGeneral')

src/main.py

@@ -27,10 +27,11 @@ import strings
 import options
 
 
-async def set_commands():
+async def setCommands():
     commands = [BotCommand(command='start', description='Старт'),
                 BotCommand(command='help', description='Инструкция'),
-                BotCommand(command='info', description='Статус'),
+                BotCommand(command='info', description='Информация о стратегиях'),
+                BotCommand(command='status', description='Статус'),
                 BotCommand(command='strategy', description='Запустить стратегию'),
                 BotCommand(command='stop', description='Остановить стратегию')
                 ]
@@ -51,8 +52,8 @@ bot = Bot(
     default=DefaultBotProperties(parse_mode=ParseMode.HTML),
 )
 
-strategy_router = Router()
+strategyRouter = Router()
-stop_router = Router()
+stopRouter = Router()
 
 
 @dp.message(Command("start"))
@@ -86,13 +87,13 @@ async def commandInfo(message: Message) -> None:
     await message.answer(msgText)
 
 
-@strategy_router.message(Command("strategy"), F.chat.id.in_(whitelist.chatIDs))
+@strategyRouter.message(Command("strategy"), F.chat.id.in_(whitelist.chatIDs))
 async def commandStrategy(message: Message, state: FSMContext):
     await message.answer(strings.strategyCommand + '\n' + strings.askPair)
     await state.set_state(startForm.pair)
 
-@strategy_router.message(F.text, startForm.pair)
+@strategyRouter.message(F.text, startForm.pair)
-async def capture_start_pair(message: Message, state: FSMContext):
+async def captureStartPair(message: Message, state: FSMContext):
     await state.update_data(pair=message.text)
     data = await state.get_data()
 
@@ -109,13 +110,14 @@ async def capture_start_pair(message: Message, state: FSMContext):
     else:
         await state.set_state(startForm.params)
 
-@strategy_router.message(F.text, startForm.params)
+@strategyRouter.message(F.text, startForm.params)
-async def capture_params(message: Message, state: FSMContext):
+async def captureParams(message: Message, state: FSMContext):
     await state.update_data(params=message.text)
 
     data = await state.get_data()
     t = await jsonProcessing.savePairParams(pair=data.get("pair"), params=data.get("params"))
     if t == 0:
+        params = await jsonProcessing.parseParams(params=data.get("params"))
         client = await bybit.getClient(
             credentials.api_key,
             credentials.api_secret,
@@ -124,12 +126,28 @@ async def capture_params(message: Message, state: FSMContext):
         )
         if client == -1:
             msgText = strings.authFailed
+            generalLogger.info("Auth failed. Strategy not started")
+            await jsonProcessing.deletePair(pair=data.get("pair"))
+        else:
+            orderSize = float(params.get('orderSize'))
+            minqty = bybit.getStartFilters(client, data.get("pair"))
+            qtyDecimals = arbus.countDecimals(minqty)
+            balance = bybit.getStartBalance(client, data.get("pair"))
+            price = bybit.getPrice(client, data.get("pair"))    
+
+            qty = arbus.floor(orderSize/price, qtyDecimals)
+            if qty <= minqty:
+                generalLogger.info("Qty < minqty. Strategy not started")
+                msgText = strings.orderSizeLowerThanQty
+                await jsonProcessing.deletePair(pair=data.get("pair"))
+            elif balance <= orderSize:
+                generalLogger.info("Balance < order size. Strategy not started")
+                msgText = strings.notEnoughBalance
                 await jsonProcessing.deletePair(pair=data.get("pair"))
             else:
                 try:
                     asyncio.create_task(bybit.strategy(data.get("pair"), data.get("params")))
-                msgText = (f'Вы запустили стратегию на паре <b>{data.get("pair")}</b> \
+                    msgText = (f'Вы запустили стратегию на паре <b>{data.get("pair")}</b> с данными параметрами:\n<b>{data.get("params")}</b>\n')
-                           с данными параметрами:\n<b>{data.get("params")}</b>\n')
                 except:
                     await jsonProcessing.deletePair(pair=data.get("pair"))
                     msgText = (strings.strategyError)
@@ -143,13 +161,13 @@ async def capture_params(message: Message, state: FSMContext):
     await state.clear()
 
 
-@stop_router.message(Command("stop"), F.chat.id.in_(whitelist.chatIDs))
+@stopRouter.message(Command("stop"), F.chat.id.in_(whitelist.chatIDs))
 async def commandStop(message: Message, state: FSMContext):
     await message.answer(strings.stopCommand + '\n' + strings.askPair)
     await state.set_state(stopForm.pair)
 
-@stop_router.message(F.text, stopForm.pair)
+@stopRouter.message(F.text, stopForm.pair)
-async def capture_stop_pair(message: Message, state: FSMContext):
+async def captureStopPair(message: Message, state: FSMContext):
     await state.update_data(pair=message.text)
     data = await state.get_data()
 
@@ -163,13 +181,26 @@ async def capture_stop_pair(message: Message, state: FSMContext):
     await state.clear()
 
 
-async def start_bot():
+async def startBot():
-    await set_commands()
+    await setCommands()
+    try:
+        for i in whitelist.chatIDs:
+            await bot.send_message(chat_id=i, text=strings.startBot)
+    except Exception as e:
+        generalLogger.error(e)
+
+async def stopBot():
+    try:
+        for i in whitelist.chatIDs:
+            await bot.send_message(chat_id=i, text=strings.stopBot)
+    except Exception as e:
+        generalLogger.error(e)
 
 async def main() -> None:
-    dp.include_router(strategy_router)
+    dp.include_router(strategyRouter)
-    dp.include_router(stop_router)
+    dp.include_router(stopRouter)
-    dp.startup.register(start_bot)
+    dp.startup.register(startBot)
+    dp.shutdown.register(stopBot)
     await dp.start_polling(bot)
 
 

src/strings.py

@@ -54,6 +54,10 @@ pairNotFound = "Стратегия на данную монетную пару
 
 authFailed = (f"Аутентификация не удалась, пожалуйста сообщите администратору если увидете данное сообщение.")
 
+orderSizeLowerThanQty = "Введённая сумма меньше минимального размера ордера на Bybit."
+
+notEnoughBalance = "На балансе недостаточно средств для зпуска стратегии."
+
 wrongFormat = "Параметры введены в неверном формате, пожалуйста начните заново."
 
 

todo.md

@@ -2,6 +2,8 @@
 ### ToFix
     - [x] ID бота (создать нового)
     - [x] Замена print на логирование
+    - [x] EN README.md
+    - [ ] UA README.md
 
 ### Новые функции
     - [x] Реализация базы программы
@@ -21,19 +23,18 @@
     - - - [x] Strategy (Запуск стратегии)
     - - - [x] Stop (Остановка стратегии)
     - - - [x] Info (Информация о запущеных стратегиях)
-    - - - [ ] Проверка на баланс и минимальное количество
+    - - - [x] Проверка на баланс и минимальное количество
     - - [x] Обеспечение безопасности и приватности бота (через chat id или пароль)
     - [x] Реализация стратегии
     - - [x] Основная функция для запуска стратегии
     - - [x] Класс работы по параметрам
     - - [x] Реализация уровней
     - - [x] Установка позиций
-    - [ ] Рализация развёртывания программы
+    - [x] Рализация развёртывания программы
-    - - [ ] Написать compose.yml
+    - - [x] Написать compose.yml
-    - - [ ] Добавить requirements.txt
+    - - [x] Добавить requirements.txt
-    - - [ ] Сделать подсасывание контейнера с гита
+    - - [x] Сделать подсасывание контейнера с гита
     - - [x] Составить список и реализовать получение переменных окружения
-    - [ ] QOL
+    - [x] QOL
     - - [x] Написать todo.md
-    - - [ ] Написать README.md
+    - - [x] Написать README.md
-    - - [ ] Написать setup.md