stable/freqtrade/rpc/telegram.py

571 lines
18 KiB
Python
Raw Normal View History

2017-05-14 12:14:16 +00:00
import logging
2017-11-02 17:25:19 +00:00
import re
2017-12-10 06:32:40 +00:00
from datetime import timedelta, date
2017-12-15 22:58:21 +00:00
from decimal import Decimal
2017-09-01 23:22:20 +00:00
from typing import Callable, Any
2017-05-12 17:11:56 +00:00
2017-05-14 12:14:16 +00:00
import arrow
2017-11-20 21:26:32 +00:00
from pandas import DataFrame
2017-12-10 06:32:40 +00:00
from sqlalchemy import and_, func, text, between
2017-11-20 21:26:32 +00:00
from tabulate import tabulate
from telegram import ParseMode, Bot, Update, ReplyKeyboardMarkup
2017-11-17 18:47:29 +00:00
from telegram.error import NetworkError, TelegramError
2017-05-12 17:11:56 +00:00
from telegram.ext import CommandHandler, Updater
2017-11-09 22:51:32 +00:00
from freqtrade import exchange, __version__
2017-09-28 21:26:28 +00:00
from freqtrade.misc import get_state, State, update_state
from freqtrade.persistence import Trade
2017-05-12 17:11:56 +00:00
2017-05-14 12:14:16 +00:00
# Remove noisy log messages
logging.getLogger('requests.packages.urllib3').setLevel(logging.INFO)
logging.getLogger('telegram').setLevel(logging.INFO)
2017-05-12 17:11:56 +00:00
logger = logging.getLogger(__name__)
2017-11-07 19:13:36 +00:00
_UPDATER: Updater = None
2017-09-08 21:10:22 +00:00
_CONF = {}
def init(config: dict) -> None:
"""
Initializes this module with the given config,
registers all known command handlers
and starts polling for message updates
:param config: config to use
:return: None
"""
2017-11-07 19:13:36 +00:00
global _UPDATER
2017-09-08 19:17:13 +00:00
2017-09-08 21:10:22 +00:00
_CONF.update(config)
if not is_enabled():
2017-09-28 22:15:38 +00:00
return
2017-11-07 19:13:36 +00:00
_UPDATER = Updater(token=config['telegram']['token'], workers=0)
2017-05-12 17:11:56 +00:00
# Register command handler and start telegram message polling
handles = [
CommandHandler('status', _status),
CommandHandler('profit', _profit),
CommandHandler('balance', _balance),
CommandHandler('start', _start),
CommandHandler('stop', _stop),
CommandHandler('forcesell', _forcesell),
CommandHandler('performance', _performance),
2017-12-10 06:32:40 +00:00
CommandHandler('daily', _daily),
CommandHandler('count', _count),
2017-10-21 08:08:08 +00:00
CommandHandler('help', _help),
2017-11-09 22:51:32 +00:00
CommandHandler('version', _version),
]
for handle in handles:
2017-11-07 19:13:36 +00:00
_UPDATER.dispatcher.add_handler(handle)
_UPDATER.start_polling(
clean=True,
bootstrap_retries=-1,
timeout=30,
read_latency=60,
)
2017-09-08 21:10:22 +00:00
logger.info(
'rpc.telegram is listening for following commands: %s',
[h.command for h in handles]
)
2017-05-12 17:11:56 +00:00
def cleanup() -> None:
"""
Stops all running telegram threads.
:return: None
"""
if not is_enabled():
return
2017-11-07 19:13:36 +00:00
_UPDATER.stop()
def is_enabled() -> bool:
"""
Returns True if the telegram module is activated, False otherwise
"""
return bool(_CONF['telegram'].get('enabled', False))
2017-09-01 23:22:20 +00:00
def authorized_only(command_handler: Callable[[Bot, Update], None]) -> Callable[..., Any]:
2017-05-14 12:14:16 +00:00
"""
Decorator to check if the message comes from the correct chat_id
:param command_handler: Telegram CommandHandler
:return: decorated function
"""
def wrapper(*args, **kwargs):
2017-12-16 02:39:47 +00:00
update = kwargs.get('update') or args[1]
2017-09-08 17:25:39 +00:00
2017-11-07 21:27:16 +00:00
# Reject unauthorized messages
2017-09-08 21:10:22 +00:00
chat_id = int(_CONF['telegram']['chat_id'])
2017-11-07 21:27:16 +00:00
if int(update.message.chat_id) != chat_id:
logger.info('Rejected unauthorized message from: %s', update.message.chat_id)
2017-11-07 21:27:16 +00:00
return wrapper
logger.info('Executing handler: %s for chat_id: %s', command_handler.__name__, chat_id)
try:
return command_handler(*args, **kwargs)
except BaseException:
logger.exception('Exception occurred within Telegram module')
2017-05-14 12:14:16 +00:00
return wrapper
2017-05-12 17:11:56 +00:00
@authorized_only
def _status(bot: Bot, update: Update) -> None:
"""
Handler for /status.
Returns the current TradeThread status
:param bot: telegram bot
:param update: message update
:return: None
"""
2017-10-29 22:57:48 +00:00
# Check if additional parameters are passed
params = update.message.text.replace('/status', '').split(' ') \
if update.message.text else []
if 'table' in params:
_status_table(bot, update)
return
# Fetch open trade
trades = Trade.query.filter(Trade.is_open.is_(True)).all()
2017-09-08 21:10:22 +00:00
if get_state() != State.RUNNING:
send_msg('*Status:* `trader is not running`', bot=bot)
elif not trades:
send_msg('*Status:* `no active trade`', bot=bot)
else:
for trade in trades:
order = None
if trade.open_order_id:
order = exchange.get_order(trade.open_order_id)
# calculate profit and send message to user
current_rate = exchange.get_ticker(trade.pair)['bid']
current_profit = trade.calc_profit(current_rate)
2017-09-08 21:10:22 +00:00
fmt_close_profit = '{:.2f}%'.format(
round(trade.close_profit * 100, 2)
2017-09-08 21:10:22 +00:00
) if trade.close_profit else None
message = """
*Trade ID:* `{trade_id}`
2017-06-05 19:17:10 +00:00
*Current Pair:* [{pair}]({market_url})
2017-05-12 17:11:56 +00:00
*Open Since:* `{date}`
*Amount:* `{amount}`
2017-11-05 15:13:55 +00:00
*Open Rate:* `{open_rate:.8f}`
2017-05-12 17:11:56 +00:00
*Close Rate:* `{close_rate}`
2017-11-05 15:13:55 +00:00
*Current Rate:* `{current_rate:.8f}`
*Close Profit:* `{close_profit}`
2017-09-08 17:45:54 +00:00
*Current Profit:* `{current_profit:.2f}%`
2017-05-12 17:11:56 +00:00
*Open Order:* `{open_order}`
""".format(
trade_id=trade.id,
pair=trade.pair,
market_url=exchange.get_pair_detail_url(trade.pair),
date=arrow.get(trade.open_date).humanize(),
open_rate=trade.open_rate,
close_rate=trade.close_rate,
current_rate=current_rate,
amount=round(trade.amount, 8),
2017-09-08 21:10:22 +00:00
close_profit=fmt_close_profit,
current_profit=round(current_profit * 100, 2),
open_order='({} rem={:.8f})'.format(
order['type'], order['remaining']
) if order else None,
)
send_msg(message, bot=bot)
2017-10-29 22:57:48 +00:00
@authorized_only
def _status_table(bot: Bot, update: Update) -> None:
"""
Handler for /status table.
Returns the current TradeThread status in table format
:param bot: telegram bot
:param update: message update
:return: None
"""
# Fetch open trade
trades = Trade.query.filter(Trade.is_open.is_(True)).all()
if get_state() != State.RUNNING:
send_msg('*Status:* `trader is not running`', bot=bot)
elif not trades:
send_msg('*Status:* `no active order`', bot=bot)
else:
trades_list = []
for trade in trades:
# calculate profit and send message to user
current_rate = exchange.get_ticker(trade.pair)['bid']
2017-11-05 17:35:32 +00:00
trades_list.append([
2017-10-29 22:57:48 +00:00
trade.id,
trade.pair,
2017-11-02 17:25:19 +00:00
shorten_date(arrow.get(trade.open_date).humanize(only_distance=True)),
2017-11-05 17:35:32 +00:00
'{:.2f}'.format(100 * trade.calc_profit(current_rate))
])
2017-10-29 22:57:48 +00:00
2017-11-02 17:25:19 +00:00
columns = ['ID', 'Pair', 'Since', 'Profit']
df_statuses = DataFrame.from_records(trades_list, columns=columns)
df_statuses = df_statuses.set_index(columns[0])
2017-10-29 22:57:48 +00:00
2017-11-02 17:25:19 +00:00
message = tabulate(df_statuses, headers='keys', tablefmt='simple')
2017-10-29 22:57:48 +00:00
message = "<pre>{}</pre>".format(message)
send_msg(message, parse_mode=ParseMode.HTML)
2017-12-10 06:32:40 +00:00
@authorized_only
def _daily(bot: Bot, update: Update) -> None:
"""
Handler for /daily <n>
Returns a daily profit (in BTC) over the last n days.
:param bot: telegram bot
:param update: message update
:return: None
"""
today = date.today().toordinal()
profit_days = {}
2017-12-10 06:32:40 +00:00
try:
timescale = int(update.message.text.replace('/daily', '').strip())
except (TypeError, ValueError):
timescale = 5
if not (isinstance(timescale, int) and timescale > 0):
send_msg('*Daily [n]:* `must be an integer greater than 0`', bot=bot)
return
2017-12-10 06:32:40 +00:00
for day in range(0, timescale):
# need to query between day+1 and day-1
nextdate = date.fromordinal(today-day+1)
prevdate = date.fromordinal(today-day-1)
trades = Trade.query.filter(between(Trade.close_date, prevdate, nextdate)).all()
curdayprofit = sum(trade.close_profit * trade.stake_amount for trade in trades)
profit_days[date.fromordinal(today-day)] = format(curdayprofit, '.8f')
stats = [[key, str(value) + ' BTC'] for key, value in profit_days.items()]
stats = tabulate(stats, headers=['Day', 'Profit'], tablefmt='simple')
message = '<b>Daily Profit over the last {} days</b>:\n<pre>{}</pre>'.format(timescale, stats)
send_msg(message, bot=bot, parse_mode=ParseMode.HTML)
@authorized_only
def _profit(bot: Bot, update: Update) -> None:
"""
Handler for /profit.
Returns a cumulative profit statistics.
:param bot: telegram bot
:param update: message update
:return: None
"""
trades = Trade.query.order_by(Trade.id).all()
profit_all_btc = []
profit_all = []
profit_btc_closed = []
profit_closed = []
durations = []
for trade in trades:
current_rate = None
if not trade.open_rate:
continue
if trade.close_date:
durations.append((trade.close_date - trade.open_date).total_seconds())
if not trade.is_open:
profit = trade.close_profit
profit_btc_closed.append(Decimal(trade.close_rate) - Decimal(trade.open_rate))
profit_closed.append(profit)
else:
# Get current rate
current_rate = exchange.get_ticker(trade.pair)['bid']
profit = trade.calc_profit(current_rate)
profit_all_btc.append(Decimal(trade.close_rate or current_rate) - Decimal(trade.open_rate))
profit_all.append(profit)
2017-09-08 17:25:39 +00:00
best_pair = Trade.session.query(Trade.pair, func.sum(Trade.close_profit).label('profit_sum')) \
.filter(Trade.is_open.is_(False)) \
.group_by(Trade.pair) \
2017-09-08 17:25:39 +00:00
.order_by(text('profit_sum DESC')) \
.first()
2017-09-08 17:25:39 +00:00
if not best_pair:
send_msg('*Status:* `no closed trade`', bot=bot)
return
bp_pair, bp_rate = best_pair
markdown_msg = """
*ROI Trade closed:* `{profit_closed_btc:.8f} BTC ({profit_closed:.2f}%)`
*ROI All trades:* `{profit_all_btc:.8f} BTC ({profit_all:.2f}%)`
*Total Trade Count:* `{trade_count}`
2017-06-08 20:52:38 +00:00
*First Trade opened:* `{first_trade_date}`
*Latest Trade opened:* `{latest_trade_date}`
*Avg. Duration:* `{avg_duration}`
2017-09-08 17:45:54 +00:00
*Best Performing:* `{best_pair}: {best_rate:.2f}%`
""".format(
profit_closed_btc=round(sum(profit_btc_closed), 8),
profit_closed=round(sum(profit_closed) * 100, 2),
profit_all_btc=round(sum(profit_all_btc), 8),
profit_all=round(sum(profit_all) * 100, 2),
trade_count=len(trades),
first_trade_date=arrow.get(trades[0].open_date).humanize(),
latest_trade_date=arrow.get(trades[-1].open_date).humanize(),
avg_duration=str(timedelta(seconds=sum(durations) / float(len(durations)))).split('.')[0],
best_pair=bp_pair,
best_rate=round(bp_rate * 100, 2),
)
send_msg(markdown_msg, bot=bot)
2017-06-08 18:01:01 +00:00
2017-06-08 20:52:38 +00:00
@authorized_only
def _balance(bot: Bot, update: Update) -> None:
"""
Handler for /balance
Returns current account balance per crypto
"""
output = ''
balances = [
c for c in exchange.get_balances()
if c['Balance'] or c['Available'] or c['Pending']
]
if not balances:
output = '`All balances are zero.`'
2017-10-29 08:10:00 +00:00
for currency in balances:
output += """*Currency*: {Currency}
*Available*: {Available}
*Balance*: {Balance}
*Pending*: {Pending}
2017-10-29 08:10:00 +00:00
""".format(**currency)
send_msg(output)
2017-06-08 20:52:38 +00:00
2017-10-30 23:36:35 +00:00
@authorized_only
def _start(bot: Bot, update: Update) -> None:
"""
Handler for /start.
Starts TradeThread
:param bot: telegram bot
:param update: message update
:return: None
"""
if get_state() == State.RUNNING:
send_msg('*Status:* `already running`', bot=bot)
else:
update_state(State.RUNNING)
@authorized_only
def _stop(bot: Bot, update: Update) -> None:
"""
Handler for /stop.
Stops TradeThread
:param bot: telegram bot
:param update: message update
:return: None
"""
if get_state() == State.RUNNING:
send_msg('`Stopping trader ...`', bot=bot)
update_state(State.STOPPED)
else:
send_msg('*Status:* `already stopped`', bot=bot)
@authorized_only
def _forcesell(bot: Bot, update: Update) -> None:
"""
Handler for /forcesell <id>.
Sells the given trade at current price
:param bot: telegram bot
:param update: message update
:return: None
"""
if get_state() != State.RUNNING:
send_msg('`trader is not running`', bot=bot)
return
trade_id = update.message.text.replace('/forcesell', '').strip()
if trade_id == 'all':
# Execute sell for all open orders
for trade in Trade.query.filter(Trade.is_open.is_(True)).all():
_exec_forcesell(trade)
return
# Query for trade
trade = Trade.query.filter(and_(
Trade.id == trade_id,
Trade.is_open.is_(True)
)).first()
if not trade:
2017-11-09 22:45:03 +00:00
send_msg('Invalid argument. See `/help` to view usage')
logger.warning('/forcesell: Invalid argument received')
return
_exec_forcesell(trade)
@authorized_only
def _performance(bot: Bot, update: Update) -> None:
"""
Handler for /performance.
Shows a performance statistic from finished trades
:param bot: telegram bot
:param update: message update
:return: None
"""
if get_state() != State.RUNNING:
send_msg('`trader is not running`', bot=bot)
return
2017-09-08 17:25:39 +00:00
pair_rates = Trade.session.query(Trade.pair, func.sum(Trade.close_profit).label('profit_sum')) \
.filter(Trade.is_open.is_(False)) \
.group_by(Trade.pair) \
2017-09-08 17:52:20 +00:00
.order_by(text('profit_sum DESC')) \
.all()
2017-11-09 19:25:17 +00:00
stats = '\n'.join('{index}.\t<code>{pair}\t{profit:.2f}%</code>'.format(
index=i + 1,
pair=pair,
profit=round(rate * 100, 2)
) for i, (pair, rate) in enumerate(pair_rates))
2017-11-05 14:35:15 +00:00
message = '<b>Performance:</b>\n{}'.format(stats)
logger.debug(message)
send_msg(message, parse_mode=ParseMode.HTML)
@authorized_only
2017-11-05 15:26:03 +00:00
def _count(bot: Bot, update: Update) -> None:
"""
Handler for /count.
Returns the number of trades running
:param bot: telegram bot
:param update: message update
:return: None
"""
if get_state() != State.RUNNING:
send_msg('`trader is not running`', bot=bot)
return
trades = Trade.query.filter(Trade.is_open.is_(True)).all()
2017-11-09 22:45:03 +00:00
message = tabulate({
'current': [len(trades)],
'max': [_CONF['max_open_trades']]
}, headers=['current', 'max'], tablefmt='simple')
message = "<pre>{}</pre>".format(message)
logger.debug(message)
send_msg(message, parse_mode=ParseMode.HTML)
2017-10-21 08:08:08 +00:00
@authorized_only
def _help(bot: Bot, update: Update) -> None:
"""
Handler for /help.
Show commands of the bot
:param bot: telegram bot
:param update: message update
:return: None
"""
message = """
*/start:* `Starts the trader`
*/stop:* `Stops the trader`
2017-11-02 17:25:19 +00:00
*/status [table]:* `Lists all open trades`
2017-10-29 22:57:48 +00:00
*table :* `will display trades in a table`
2017-10-21 08:08:08 +00:00
*/profit:* `Lists cumulative profit from all finished trades`
*/forcesell <trade_id>|all:* `Instantly sells the given trade or all trades, regardless of profit`
2017-10-21 08:08:08 +00:00
*/performance:* `Show performance of each finished trade grouped by pair`
*/daily <n>:* `Shows profit or loss per day, over the last n days`
2017-10-29 22:57:48 +00:00
*/count:* `Show number of trades running compared to allowed number of trades`
2017-10-29 08:10:00 +00:00
*/balance:* `Show account balance per currency`
2017-10-21 08:08:08 +00:00
*/help:* `This help message`
2017-11-09 22:51:32 +00:00
*/version:* `Show version`
2017-10-21 08:08:08 +00:00
"""
send_msg(message, bot=bot)
2017-11-09 22:51:32 +00:00
@authorized_only
def _version(bot: Bot, update: Update) -> None:
"""
Handler for /version.
Show version information
:param bot: telegram bot
:param update: message update
:return: None
"""
send_msg('*Version:* `{}`'.format(__version__), bot=bot)
def shorten_date(_date):
2017-11-02 17:25:19 +00:00
"""
Trim the date so it fits on small screens
"""
new_date = re.sub('seconds?', 'sec', _date)
2017-11-02 17:25:19 +00:00
new_date = re.sub('minutes?', 'min', new_date)
new_date = re.sub('hours?', 'h', new_date)
new_date = re.sub('days?', 'd', new_date)
new_date = re.sub('^an?', '1', new_date)
return new_date
2017-10-29 22:57:48 +00:00
2017-12-16 00:37:06 +00:00
def _exec_forcesell(trade: Trade) -> None:
# Check if there is there is an open order
if trade.open_order_id:
order = exchange.get_order(trade.open_order_id)
# Cancel open LIMIT_BUY orders and close trade
if order and not order['closed'] and order['type'] == 'LIMIT_BUY':
exchange.cancel_order(trade.open_order_id)
trade.close(order.get('rate') or trade.open_rate)
# TODO: sell amount which has been bought already
return
# Ignore trades with an attached LIMIT_SELL order
if order and not order['closed'] and order['type'] == 'LIMIT_SELL':
return
# Get current rate and execute sell
current_rate = exchange.get_ticker(trade.pair)['bid']
from freqtrade.main import execute_sell
execute_sell(trade, current_rate)
2017-09-08 21:10:22 +00:00
def send_msg(msg: str, bot: Bot = None, parse_mode: ParseMode = ParseMode.MARKDOWN) -> None:
"""
Send given markdown message
:param msg: message
:param bot: alternative bot
:param parse_mode: telegram parse mode
:return: None
"""
if not is_enabled():
return
2017-11-07 21:27:16 +00:00
bot = bot or _UPDATER.bot
2017-11-17 18:47:29 +00:00
keyboard = [['/daily', '/profit', '/balance'],
['/status', '/status table', '/performance'],
['/count', '/start', '/stop', '/help']]
reply_markup = ReplyKeyboardMarkup(keyboard)
try:
2017-11-17 18:47:29 +00:00
try:
2017-12-16 02:39:47 +00:00
bot.send_message(
_CONF['telegram']['chat_id'], msg,
parse_mode=parse_mode, reply_markup=reply_markup
)
2017-11-17 18:47:29 +00:00
except NetworkError as network_err:
# Sometimes the telegram server resets the current connection,
# if this is the case we send the message again.
logger.warning(
'Got Telegram NetworkError: %s! Trying one more time.',
network_err.message
)
2017-12-16 02:39:47 +00:00
bot.send_message(
_CONF['telegram']['chat_id'], msg,
parse_mode=parse_mode, reply_markup=reply_markup
)
2017-11-17 18:47:29 +00:00
except TelegramError as telegram_err:
logger.warning('Got TelegramError: %s! Giving up on that message.', telegram_err.message)