stable/freqtrade/rpc/rpc_manager.py

144 lines
5.8 KiB
Python
Raw Normal View History

2018-02-13 03:45:59 +00:00
"""
This module contains class to manage RPC communications (Telegram, API, ...)
2018-02-13 03:45:59 +00:00
"""
2018-03-25 19:37:14 +00:00
import logging
from collections import deque
from typing import Any, Dict, List
2018-02-13 03:45:59 +00:00
2021-06-09 17:51:44 +00:00
from freqtrade.enums import RPCMessageType
from freqtrade.rpc import RPC, RPCHandler
2018-02-13 03:45:59 +00:00
2020-09-28 17:39:41 +00:00
2018-03-25 19:37:14 +00:00
logger = logging.getLogger(__name__)
2019-09-12 01:39:52 +00:00
class RPCManager:
2018-02-13 03:45:59 +00:00
"""
Class to manage RPC objects (Telegram, API, ...)
2018-02-13 03:45:59 +00:00
"""
2021-08-06 22:19:36 +00:00
2018-02-13 03:45:59 +00:00
def __init__(self, freqtrade) -> None:
""" Initializes all enabled rpc modules """
self.registered_modules: List[RPCHandler] = []
self._freqtrade = freqtrade
self._rpc = RPC(freqtrade)
config = freqtrade.config
# Enable telegram
if config.get('telegram', {}).get('enabled', False):
2018-03-25 19:37:14 +00:00
logger.info('Enabling rpc.telegram ...')
from freqtrade.rpc.telegram import Telegram
self.registered_modules.append(Telegram(self._rpc, config))
2018-02-13 03:45:59 +00:00
2022-06-01 15:44:48 +00:00
# Enable discord
if config.get('discord', {}).get('enabled', False):
logger.info('Enabling rpc.discord ...')
from freqtrade.rpc.discord import Discord
self.registered_modules.append(Discord(self._rpc, config))
2018-07-12 17:59:17 +00:00
# Enable Webhook
if config.get('webhook', {}).get('enabled', False):
2018-07-12 18:17:45 +00:00
logger.info('Enabling rpc.webhook ...')
2018-07-12 17:59:17 +00:00
from freqtrade.rpc.webhook import Webhook
self.registered_modules.append(Webhook(self._rpc, config))
2018-07-12 17:59:17 +00:00
2019-04-04 05:13:40 +00:00
# Enable local rest api server for cmd line control
if config.get('api_server', {}).get('enabled', False):
2019-04-04 05:13:40 +00:00
logger.info('Enabling rpc.api_server')
2020-12-31 10:01:50 +00:00
from freqtrade.rpc.api_server import ApiServer
2020-12-31 19:02:27 +00:00
apiserver = ApiServer(config)
apiserver.add_rpc_handler(self._rpc)
self.registered_modules.append(apiserver)
2019-04-04 05:13:40 +00:00
# Enable External Signals mode
# For this to be enabled, the API server must also be enabled
# if config.get('external_signal', {}).get('enabled', False):
# logger.info('Enabling RPC.ExternalSignalController')
# from freqtrade.rpc.external_signal import ExternalSignalController
# external_signals = ExternalSignalController(self._rpc, config, apiserver)
# self.registered_modules.append(external_signals)
#
# # Attach the controller to FreqTrade
# freqtrade.external_signal_controller = external_signals
2018-02-13 03:45:59 +00:00
def cleanup(self) -> None:
""" Stops all enabled rpc modules """
logger.info('Cleaning up rpc modules ...')
2018-06-09 11:30:48 +00:00
while self.registered_modules:
mod = self.registered_modules.pop() # popleft to cleanup API server last?
2020-12-31 19:02:27 +00:00
logger.info('Cleaning up rpc.%s ...', mod.name)
mod.cleanup()
2018-06-09 11:30:48 +00:00
del mod
2018-02-13 03:45:59 +00:00
def send_msg(self, msg: Dict[str, Any]) -> None:
2018-02-13 03:45:59 +00:00
"""
2018-06-24 22:04:27 +00:00
Send given message to all registered rpc modules.
A message consists of one or more key value pairs of strings.
e.g.:
{
'status': 'stopping bot'
}
2018-02-13 03:45:59 +00:00
"""
2022-08-31 01:21:34 +00:00
# Removed actually showing the message because the logs would be
# completely spammed of the json dataframe
logger.info('Sending rpc message of type: %s', msg.get('type'))
# Log actual message in debug?
# logger.debug(msg)
if 'pair' in msg:
msg.update({
'base_currency': self._rpc._freqtrade.exchange.get_pair_base_currency(msg['pair'])
})
for mod in self.registered_modules:
logger.debug('Forwarding message to rpc.%s', mod.name)
try:
mod.send_msg(msg)
except NotImplementedError:
2020-09-19 18:04:12 +00:00
logger.error(f"Message type '{msg['type']}' not implemented by handler {mod.name}.")
def process_msg_queue(self, queue: deque) -> None:
"""
Process all messages in the queue.
"""
while queue:
msg = queue.popleft()
self.send_msg({
'type': RPCMessageType.STRATEGY_MSG,
'msg': msg,
})
2020-12-07 09:54:37 +00:00
def startup_messages(self, config: Dict[str, Any], pairlist, protections) -> None:
if config['dry_run']:
self.send_msg({
2021-04-20 04:41:58 +00:00
'type': RPCMessageType.WARNING,
'status': 'Dry run is enabled. All trades are simulated.'
})
stake_currency = config['stake_currency']
stake_amount = config['stake_amount']
minimal_roi = config['minimal_roi']
2019-03-12 06:06:42 +00:00
stoploss = config['stoploss']
trailing_stop = config['trailing_stop']
timeframe = config['timeframe']
exchange_name = config['exchange']['name']
strategy_name = config.get('strategy', '')
2022-01-17 01:57:10 +00:00
pos_adjust_enabled = 'On' if config['position_adjustment_enable'] else 'Off'
self.send_msg({
2021-04-20 04:41:58 +00:00
'type': RPCMessageType.STARTUP,
'status': f'*Exchange:* `{exchange_name}`\n'
f'*Stake per trade:* `{stake_amount} {stake_currency}`\n'
f'*Minimum ROI:* `{minimal_roi}`\n'
2019-03-12 06:06:42 +00:00
f'*{"Trailing " if trailing_stop else ""}Stoploss:* `{stoploss}`\n'
2022-01-17 07:37:06 +00:00
f'*Position adjustment:* `{pos_adjust_enabled}`\n'
f'*Timeframe:* `{timeframe}`\n'
2022-01-17 07:37:06 +00:00
f'*Strategy:* `{strategy_name}`'
})
self.send_msg({
2021-04-20 04:41:58 +00:00
'type': RPCMessageType.STARTUP,
2018-12-03 19:31:25 +00:00
'status': f'Searching for {stake_currency} pairs to buy and sell '
f'based on {pairlist.short_desc()}'
})
2020-12-07 09:54:37 +00:00
if len(protections.name_list) > 0:
prots = '\n'.join([p for prot in protections.short_desc() for k, p in prot.items()])
2020-12-07 09:54:37 +00:00
self.send_msg({
2021-04-20 04:41:58 +00:00
'type': RPCMessageType.STARTUP,
'status': f'Using Protections: \n{prots}'
2022-01-17 19:00:35 +00:00
})