stable/freqtrade/persistence/models.py

763 lines
30 KiB
Python
Raw Normal View History

2018-03-02 15:22:00 +00:00
"""
This module contains the class to persist trades into SQLite
"""
import logging
from datetime import datetime, timezone
from decimal import Decimal
from typing import Any, Dict, List, Optional
2017-05-12 17:11:56 +00:00
import arrow
2020-09-28 17:39:41 +00:00
from sqlalchemy import (Boolean, Column, DateTime, Float, ForeignKey, Integer, String,
create_engine, desc, func, inspect)
2018-06-07 19:35:57 +00:00
from sqlalchemy.exc import NoSuchModuleError
2017-05-12 17:11:56 +00:00
from sqlalchemy.ext.declarative import declarative_base
2020-08-13 07:34:53 +00:00
from sqlalchemy.orm import Query, relationship
2017-09-03 06:50:48 +00:00
from sqlalchemy.orm.scoping import scoped_session
from sqlalchemy.orm.session import sessionmaker
2017-11-09 22:45:22 +00:00
from sqlalchemy.pool import StaticPool
2020-08-13 14:14:28 +00:00
from sqlalchemy.sql.schema import UniqueConstraint
2017-05-12 17:11:56 +00:00
2020-10-17 09:25:42 +00:00
from freqtrade.constants import DATETIME_PRINT_FORMAT
from freqtrade.exceptions import DependencyException, OperationalException
from freqtrade.misc import safe_value_fallback
2020-08-13 06:33:46 +00:00
from freqtrade.persistence.migrations import check_migrate
2018-06-07 19:35:57 +00:00
2020-09-28 17:39:41 +00:00
logger = logging.getLogger(__name__)
2019-09-10 07:42:45 +00:00
2018-05-31 19:10:15 +00:00
_DECL_BASE: Any = declarative_base()
2018-06-23 13:27:29 +00:00
_SQL_DOCS_URL = 'http://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls'
2017-05-12 17:11:56 +00:00
2020-10-16 05:39:12 +00:00
def init_db(db_url: str, clean_open_orders: bool = False) -> None:
"""
Initializes this module with the given config,
registers all known command handlers
and starts polling for message updates
:param db_url: Database to use
:param clean_open_orders: Remove open orders from the database.
Useful for dry-run or if all orders have been reset on the exchange.
:return: None
"""
kwargs = {}
# Take care of thread ownership if in-memory db
if db_url == 'sqlite://':
kwargs.update({
'connect_args': {'check_same_thread': False},
'poolclass': StaticPool,
'echo': False,
})
2018-06-07 19:35:57 +00:00
try:
engine = create_engine(db_url, **kwargs)
except NoSuchModuleError:
raise OperationalException(f"Given value for db_url: '{db_url}' "
f"is no valid database URL! (See {_SQL_DOCS_URL})")
2018-06-07 19:35:57 +00:00
2019-10-29 13:26:03 +00:00
# https://docs.sqlalchemy.org/en/13/orm/contextual.html#thread-local-scope
# Scoped sessions proxy requests to the appropriate thread-local session.
# We should use the scoped_session object - not a seperately initialized version
Trade.session = scoped_session(sessionmaker(bind=engine, autoflush=True, autocommit=True))
Trade.query = Trade.session.query_property()
2020-08-13 12:13:58 +00:00
# Copy session attributes to order object too
Order.session = Trade.session
Order.query = Order.session.query_property()
2020-10-17 09:28:34 +00:00
PairLock.session = Trade.session
PairLock.query = PairLock.session.query_property()
previous_tables = inspect(engine).get_table_names()
2017-11-07 19:13:36 +00:00
_DECL_BASE.metadata.create_all(engine)
check_migrate(engine, decl_base=_DECL_BASE, previous_tables=previous_tables)
# Clean dry_run DB if the db is not in-memory
if clean_open_orders and db_url != 'sqlite://':
clean_dry_run_db()
2020-10-16 05:39:12 +00:00
def cleanup_db() -> None:
"""
Flushes all pending operations to disk.
:return: None
"""
Trade.session.flush()
def clean_dry_run_db() -> None:
"""
Remove open_order_id from a Dry_run DB
:return: None
"""
for trade in Trade.query.filter(Trade.open_order_id.isnot(None)).all():
# Check we are updating only a dry_run order not a prod one
if 'dry_run' in trade.open_order_id:
trade.open_order_id = None
2020-08-13 07:34:53 +00:00
class Order(_DECL_BASE):
"""
Order database model
Keeps a record of all orders placed on the exchange
One to many relationship with Trades:
- One trade can have many orders
- One Order can only be associated with one Trade
Mirrors CCXT Order structure
"""
__tablename__ = 'orders'
2020-08-13 14:14:28 +00:00
# Uniqueness should be ensured over pair, order_id
# its likely that order_id is unique per Pair on some exchanges.
2020-08-13 15:17:52 +00:00
__table_args__ = (UniqueConstraint('ft_pair', 'order_id', name="_order_pair_order_id"),)
2020-08-13 07:34:53 +00:00
id = Column(Integer, primary_key=True)
2020-08-13 15:17:52 +00:00
ft_trade_id = Column(Integer, ForeignKey('trades.id'), index=True)
2020-08-13 07:34:53 +00:00
2020-08-13 17:37:41 +00:00
trade = relationship("Trade", back_populates="orders")
ft_order_side = Column(String, nullable=False)
2020-08-13 14:14:28 +00:00
ft_pair = Column(String, nullable=False)
2020-08-13 15:17:52 +00:00
ft_is_open = Column(Boolean, nullable=False, default=True, index=True)
2020-08-13 13:39:29 +00:00
order_id = Column(String, nullable=False, index=True)
status = Column(String, nullable=True)
symbol = Column(String, nullable=True)
order_type = Column(String, nullable=True)
side = Column(String, nullable=True)
price = Column(Float, nullable=True)
amount = Column(Float, nullable=True)
2020-08-13 07:34:53 +00:00
filled = Column(Float, nullable=True)
remaining = Column(Float, nullable=True)
cost = Column(Float, nullable=True)
order_date = Column(DateTime, nullable=True, default=datetime.utcnow)
2020-08-13 07:34:53 +00:00
order_filled_date = Column(DateTime, nullable=True)
2020-08-13 12:13:58 +00:00
order_update_date = Column(DateTime, nullable=True)
def __repr__(self):
2020-08-13 15:17:52 +00:00
return (f'Order(id={self.id}, order_id={self.order_id}, trade_id={self.ft_trade_id}, '
2020-08-24 04:50:43 +00:00
f'side={self.side}, order_type={self.order_type}, status={self.status})')
2020-08-13 07:34:53 +00:00
def update_from_ccxt_object(self, order):
"""
Update Order from ccxt response
Only updates if fields are available from ccxt -
"""
if self.order_id != str(order['id']):
raise DependencyException("Order-id's don't match")
self.status = order.get('status', self.status)
self.symbol = order.get('symbol', self.symbol)
self.order_type = order.get('type', self.order_type)
self.side = order.get('side', self.side)
self.price = order.get('price', self.price)
self.amount = order.get('amount', self.amount)
self.filled = order.get('filled', self.filled)
self.remaining = order.get('remaining', self.remaining)
self.cost = order.get('cost', self.cost)
if 'timestamp' in order and order['timestamp'] is not None:
self.order_date = datetime.fromtimestamp(order['timestamp'] / 1000, tz=timezone.utc)
2020-09-06 12:17:45 +00:00
self.ft_is_open = True
2020-08-13 15:17:52 +00:00
if self.status in ('closed', 'canceled', 'cancelled'):
self.ft_is_open = False
if order.get('filled', 0) > 0:
self.order_filled_date = arrow.utcnow().datetime
self.order_update_date = arrow.utcnow().datetime
2020-08-13 15:17:52 +00:00
2020-08-13 12:13:58 +00:00
@staticmethod
2020-08-13 13:39:29 +00:00
def update_orders(orders: List['Order'], order: Dict[str, Any]):
2020-08-13 12:13:58 +00:00
"""
2020-08-13 15:18:56 +00:00
Get all non-closed orders - useful when trying to batch-update orders
2020-08-13 12:13:58 +00:00
"""
filtered_orders = [o for o in orders if o.order_id == order.get('id')]
2020-08-13 13:54:36 +00:00
if filtered_orders:
oobj = filtered_orders[0]
oobj.update_from_ccxt_object(order)
else:
logger.warning(f"Did not find order for {order}.")
2020-08-13 12:13:58 +00:00
2020-08-13 07:34:53 +00:00
@staticmethod
2020-08-13 14:14:28 +00:00
def parse_from_ccxt_object(order: Dict[str, Any], pair: str, side: str) -> 'Order':
2020-08-13 07:34:53 +00:00
"""
Parse an order from a ccxt object and return a new order Object.
"""
2020-08-13 14:14:28 +00:00
o = Order(order_id=str(order['id']), ft_order_side=side, ft_pair=pair)
o.update_from_ccxt_object(order)
2020-08-13 07:34:53 +00:00
return o
2020-08-13 15:18:56 +00:00
@staticmethod
2020-08-13 17:37:41 +00:00
def get_open_orders() -> List['Order']:
2020-08-13 15:18:56 +00:00
"""
"""
return Order.query.filter(Order.ft_is_open.is_(True)).all()
2020-08-13 07:34:53 +00:00
2017-11-07 19:13:36 +00:00
class Trade(_DECL_BASE):
2018-03-02 15:22:00 +00:00
"""
2020-08-13 07:34:53 +00:00
Trade database model.
Also handles updating and querying trades
2018-03-02 15:22:00 +00:00
"""
2017-05-12 17:11:56 +00:00
__tablename__ = 'trades'
id = Column(Integer, primary_key=True)
2020-08-13 07:34:53 +00:00
2020-08-13 14:55:43 +00:00
orders = relationship("Order", order_by="Order.id", cascade="all, delete-orphan")
2020-08-13 07:34:53 +00:00
2017-10-06 10:22:04 +00:00
exchange = Column(String, nullable=False)
2018-08-12 07:30:12 +00:00
pair = Column(String, nullable=False, index=True)
2018-08-02 23:39:13 +00:00
is_open = Column(Boolean, nullable=False, default=True, index=True)
fee_open = Column(Float, nullable=False, default=0.0)
2020-04-30 04:51:42 +00:00
fee_open_cost = Column(Float, nullable=True)
fee_open_currency = Column(String, nullable=True)
fee_close = Column(Float, nullable=False, default=0.0)
2020-04-30 04:51:42 +00:00
fee_close_cost = Column(Float, nullable=True)
fee_close_currency = Column(String, nullable=True)
open_rate = Column(Float)
open_rate_requested = Column(Float)
2020-04-06 09:00:31 +00:00
# open_trade_price - calculated via _calc_open_trade_price
2019-12-17 06:02:02 +00:00
open_trade_price = Column(Float)
2017-05-12 17:11:56 +00:00
close_rate = Column(Float)
close_rate_requested = Column(Float)
2017-05-12 17:11:56 +00:00
close_profit = Column(Float)
2020-03-22 10:16:09 +00:00
close_profit_abs = Column(Float)
stake_amount = Column(Float, nullable=False)
amount = Column(Float)
2020-07-15 18:15:29 +00:00
amount_requested = Column(Float)
2017-05-12 17:11:56 +00:00
open_date = Column(DateTime, nullable=False, default=datetime.utcnow)
close_date = Column(DateTime)
2017-05-14 12:14:16 +00:00
open_order_id = Column(String)
2018-06-26 18:49:07 +00:00
# absolute value of the stop loss
stop_loss = Column(Float, nullable=True, default=0.0)
2019-03-28 20:18:26 +00:00
# percentage value of the stop loss
2019-03-29 07:08:29 +00:00
stop_loss_pct = Column(Float, nullable=True)
2018-06-26 18:49:07 +00:00
# absolute value of the initial stop loss
initial_stop_loss = Column(Float, nullable=True, default=0.0)
2019-03-28 20:18:26 +00:00
# percentage value of the initial stop loss
2019-03-29 07:08:29 +00:00
initial_stop_loss_pct = Column(Float, nullable=True)
# stoploss order id which is on exchange
2018-11-23 14:17:36 +00:00
stoploss_order_id = Column(String, nullable=True, index=True)
# last update time of the stoploss order on exchange
stoploss_last_update = Column(DateTime, nullable=True)
# absolute value of the highest reached price
2018-06-26 18:49:07 +00:00
max_rate = Column(Float, nullable=True, default=0.0)
# Lowest price reached
2019-03-16 19:04:39 +00:00
min_rate = Column(Float, nullable=True)
2018-07-11 17:57:01 +00:00
sell_reason = Column(String, nullable=True)
sell_order_status = Column(String, nullable=True)
strategy = Column(String, nullable=True)
2020-06-02 08:02:24 +00:00
timeframe = Column(Integer, nullable=True)
2017-05-12 17:11:56 +00:00
2019-12-17 06:02:02 +00:00
def __init__(self, **kwargs):
super().__init__(**kwargs)
self.recalc_open_trade_price()
2019-12-17 06:02:02 +00:00
2017-05-12 17:11:56 +00:00
def __repr__(self):
2020-10-17 09:25:42 +00:00
open_since = self.open_date.strftime(DATETIME_PRINT_FORMAT) if self.is_open else 'closed'
2018-06-23 13:27:29 +00:00
return (f'Trade(id={self.id}, pair={self.pair}, amount={self.amount:.8f}, '
f'open_rate={self.open_rate:.8f}, open_since={open_since})')
def to_json(self) -> Dict[str, Any]:
return {
'trade_id': self.id,
'pair': self.pair,
2020-04-06 09:00:31 +00:00
'is_open': self.is_open,
'exchange': self.exchange,
'amount': round(self.amount, 8),
'amount_requested': round(self.amount_requested, 8) if self.amount_requested else None,
'stake_amount': round(self.stake_amount, 8),
'strategy': self.strategy,
'ticker_interval': self.timeframe, # DEPRECATED
2020-06-02 12:56:34 +00:00
'timeframe': self.timeframe,
2020-04-06 09:00:31 +00:00
'fee_open': self.fee_open,
2020-04-30 04:51:42 +00:00
'fee_open_cost': self.fee_open_cost,
'fee_open_currency': self.fee_open_currency,
2020-04-06 09:00:31 +00:00
'fee_close': self.fee_close,
2020-04-30 04:51:42 +00:00
'fee_close_cost': self.fee_close_cost,
'fee_close_currency': self.fee_close_currency,
2019-05-06 04:55:12 +00:00
'open_date_hum': arrow.get(self.open_date).humanize(),
2020-10-17 18:32:23 +00:00
'open_date': self.open_date.strftime(DATETIME_PRINT_FORMAT),
'open_timestamp': int(self.open_date.replace(tzinfo=timezone.utc).timestamp() * 1000),
'open_rate': self.open_rate,
'open_rate_requested': self.open_rate_requested,
'open_trade_price': round(self.open_trade_price, 8),
2019-05-06 04:55:12 +00:00
'close_date_hum': (arrow.get(self.close_date).humanize()
if self.close_date else None),
2020-10-17 18:32:23 +00:00
'close_date': (self.close_date.strftime(DATETIME_PRINT_FORMAT)
2019-05-06 04:55:12 +00:00
if self.close_date else None),
'close_timestamp': int(self.close_date.replace(
tzinfo=timezone.utc).timestamp() * 1000) if self.close_date else None,
'close_rate': self.close_rate,
2020-04-06 09:00:31 +00:00
'close_rate_requested': self.close_rate_requested,
'close_profit': self.close_profit,
'close_profit_abs': self.close_profit_abs,
2020-04-06 09:00:31 +00:00
'sell_reason': self.sell_reason,
'sell_order_status': self.sell_order_status,
2020-06-01 09:05:37 +00:00
'stop_loss': self.stop_loss, # Deprecated - should not be used
'stop_loss_abs': self.stop_loss,
'stop_loss_ratio': self.stop_loss_pct if self.stop_loss_pct else None,
'stop_loss_pct': (self.stop_loss_pct * 100) if self.stop_loss_pct else None,
'stoploss_order_id': self.stoploss_order_id,
2020-10-17 18:32:23 +00:00
'stoploss_last_update': (self.stoploss_last_update.strftime(DATETIME_PRINT_FORMAT)
if self.stoploss_last_update else None),
'stoploss_last_update_timestamp': int(self.stoploss_last_update.replace(
tzinfo=timezone.utc).timestamp() * 1000) if self.stoploss_last_update else None,
2020-06-01 09:05:37 +00:00
'initial_stop_loss': self.initial_stop_loss, # Deprecated - should not be used
'initial_stop_loss_abs': self.initial_stop_loss,
'initial_stop_loss_ratio': (self.initial_stop_loss_pct
if self.initial_stop_loss_pct else None),
2019-05-06 04:55:12 +00:00
'initial_stop_loss_pct': (self.initial_stop_loss_pct * 100
if self.initial_stop_loss_pct else None),
2020-04-06 09:00:31 +00:00
'min_rate': self.min_rate,
'max_rate': self.max_rate,
2020-04-06 09:00:31 +00:00
'open_order_id': self.open_order_id,
}
2020-02-02 04:00:40 +00:00
def adjust_min_max_rates(self, current_price: float) -> None:
"""
Adjust the max_rate and min_rate.
"""
self.max_rate = max(current_price, self.max_rate or self.open_rate)
self.min_rate = min(current_price, self.min_rate or self.open_rate)
2020-02-02 04:00:40 +00:00
def adjust_stop_loss(self, current_price: float, stoploss: float,
initial: bool = False) -> None:
2019-03-17 12:18:29 +00:00
"""
This adjusts the stop loss to it's most recently observed setting
:param current_price: Current rate the asset is traded
:param stoploss: Stoploss as factor (sample -0.05 -> -5% below current price).
:param initial: Called to initiate stop_loss.
Skips everything if self.stop_loss is already set.
"""
2018-06-27 04:38:49 +00:00
if initial and not (self.stop_loss is None or self.stop_loss == 0):
# Don't modify if called with initial and nothing to do
return
2018-06-26 20:41:28 +00:00
new_loss = float(current_price * (1 - abs(stoploss)))
2018-06-26 18:49:07 +00:00
# no stop loss assigned yet
2018-07-01 17:54:26 +00:00
if not self.stop_loss:
2019-09-11 20:32:08 +00:00
logger.debug(f"{self.pair} - Assigning new stoploss...")
2018-06-26 18:49:07 +00:00
self.stop_loss = new_loss
2019-03-31 11:15:35 +00:00
self.stop_loss_pct = -1 * abs(stoploss)
2018-06-26 18:49:07 +00:00
self.initial_stop_loss = new_loss
2019-03-31 11:15:35 +00:00
self.initial_stop_loss_pct = -1 * abs(stoploss)
2019-01-15 10:04:32 +00:00
self.stoploss_last_update = datetime.utcnow()
2018-06-26 18:49:07 +00:00
# evaluate if the stop loss needs to be updated
else:
if new_loss > self.stop_loss: # stop losses only walk up, never down!
2019-09-11 20:32:08 +00:00
logger.debug(f"{self.pair} - Adjusting stoploss...")
2018-06-26 18:49:07 +00:00
self.stop_loss = new_loss
2019-03-31 11:15:35 +00:00
self.stop_loss_pct = -1 * abs(stoploss)
2019-01-15 10:04:32 +00:00
self.stoploss_last_update = datetime.utcnow()
2018-06-26 18:49:07 +00:00
else:
2019-09-11 20:32:08 +00:00
logger.debug(f"{self.pair} - Keeping current stoploss...")
2018-06-26 18:49:07 +00:00
logger.debug(
2019-09-11 23:29:47 +00:00
f"{self.pair} - Stoploss adjusted. current_price={current_price:.8f}, "
f"open_rate={self.open_rate:.8f}, max_rate={self.max_rate:.8f}, "
f"initial_stop_loss={self.initial_stop_loss:.8f}, "
f"stop_loss={self.stop_loss:.8f}. "
2019-09-10 07:42:45 +00:00
f"Trailing stoploss saved us: "
2019-09-11 23:29:47 +00:00
f"{float(self.stop_loss) - float(self.initial_stop_loss):.8f}.")
2018-06-26 18:49:07 +00:00
def update(self, order: Dict) -> None:
2017-06-08 18:01:01 +00:00
"""
Updates this entity with amount and actual open/close rates.
:param order: order retrieved by exchange.fetch_order()
:return: None
2017-06-08 18:01:01 +00:00
"""
2018-06-23 13:27:29 +00:00
order_type = order['type']
# Ignore open and cancelled orders
if order['status'] == 'open' or safe_value_fallback(order, 'average', 'price') is None:
return
logger.info('Updating trade (id=%s) ...', self.id)
2017-12-17 21:07:56 +00:00
if order_type in ('market', 'limit') and order['side'] == 'buy':
# Update open rate and actual amount
self.open_rate = Decimal(safe_value_fallback(order, 'average', 'price'))
self.amount = Decimal(safe_value_fallback(order, 'filled', 'amount'))
self.recalc_open_trade_price()
if self.is_open:
logger.info(f'{order_type.upper()}_BUY has been fulfilled for {self}.')
self.open_order_id = None
elif order_type in ('market', 'limit') and order['side'] == 'sell':
if self.is_open:
logger.info(f'{order_type.upper()}_SELL has been fulfilled for {self}.')
self.close(safe_value_fallback(order, 'average', 'price'))
2020-06-01 08:36:23 +00:00
elif order_type in ('stop_loss_limit', 'stop-loss', 'stop'):
2018-11-23 14:17:36 +00:00
self.stoploss_order_id = None
self.close_rate_requested = self.stop_loss
if self.is_open:
logger.info(f'{order_type.upper()} is hit for {self}.')
self.close(order['average'])
else:
2018-06-23 13:27:29 +00:00
raise ValueError(f'Unknown order type: {order_type}')
2020-10-16 05:39:12 +00:00
cleanup_db()
2017-06-08 18:01:01 +00:00
def close(self, rate: float) -> None:
"""
Sets close_rate to the given rate, calculates total profit
and marks trade as closed
"""
2017-12-17 21:07:56 +00:00
self.close_rate = Decimal(rate)
self.close_profit = self.calc_profit_ratio()
2020-03-22 10:16:09 +00:00
self.close_profit_abs = self.calc_profit()
self.close_date = self.close_date or datetime.utcnow()
self.is_open = False
self.sell_order_status = 'closed'
self.open_order_id = None
logger.info(
'Marking %s as closed as the trade is fulfilled and found no open orders for it.',
self
)
2020-05-01 14:00:42 +00:00
def update_fee(self, fee_cost: float, fee_currency: Optional[str], fee_rate: Optional[float],
2020-05-01 18:34:58 +00:00
side: str) -> None:
2020-05-01 14:00:42 +00:00
"""
Update Fee parameters. Only acts once per side
"""
if side == 'buy' and self.fee_open_currency is None:
self.fee_open_cost = fee_cost
self.fee_open_currency = fee_currency
if fee_rate is not None:
self.fee_open = fee_rate
# Assume close-fee will fall into the same fee category and take an educated guess
self.fee_close = fee_rate
elif side == 'sell' and self.fee_close_currency is None:
self.fee_close_cost = fee_cost
self.fee_close_currency = fee_currency
if fee_rate is not None:
self.fee_close = fee_rate
2020-05-01 18:34:58 +00:00
def fee_updated(self, side: str) -> bool:
"""
Verify if this side (buy / sell) has already been updated
"""
if side == 'buy':
return self.fee_open_currency is not None
elif side == 'sell':
return self.fee_close_currency is not None
2020-05-01 18:02:38 +00:00
else:
return False
2020-08-13 13:39:29 +00:00
def update_order(self, order: Dict) -> None:
Order.update_orders(self.orders, order)
2020-09-06 12:27:36 +00:00
def delete(self) -> None:
for order in self.orders:
Order.session.delete(order)
Trade.session.delete(self)
Trade.session.flush()
2019-12-17 06:02:02 +00:00
def _calc_open_trade_price(self) -> float:
2017-12-17 21:07:56 +00:00
"""
2019-12-17 06:09:56 +00:00
Calculate the open_rate including open_fee.
2018-11-01 12:05:57 +00:00
:return: Price in of the open trade incl. Fees
2017-12-17 21:07:56 +00:00
"""
2019-12-17 18:30:04 +00:00
buy_trade = Decimal(self.amount) * Decimal(self.open_rate)
2019-12-17 06:02:02 +00:00
fees = buy_trade * Decimal(self.fee_open)
2017-12-17 21:07:56 +00:00
return float(buy_trade + fees)
def recalc_open_trade_price(self) -> None:
"""
Recalculate open_trade_price.
Must be called whenever open_rate or fee_open is changed.
"""
2019-12-17 07:31:44 +00:00
self.open_trade_price = self._calc_open_trade_price()
2019-09-10 07:42:45 +00:00
def calc_close_trade_price(self, rate: Optional[float] = None,
fee: Optional[float] = None) -> float:
2017-12-17 21:07:56 +00:00
"""
2018-11-01 12:05:57 +00:00
Calculate the close_rate including fee
2017-12-17 21:07:56 +00:00
:param fee: fee to use on the close rate (optional).
If rate is not set self.fee will be used
2017-12-17 21:07:56 +00:00
:param rate: rate to compare with (optional).
If rate is not set self.close_rate will be used
2017-12-17 21:07:56 +00:00
:return: Price in BTC of the open trade
"""
if rate is None and not self.close_rate:
return 0.0
2019-12-17 18:30:04 +00:00
sell_trade = Decimal(self.amount) * Decimal(rate or self.close_rate)
fees = sell_trade * Decimal(fee or self.fee_close)
2017-12-17 21:07:56 +00:00
return float(sell_trade - fees)
2019-09-10 07:42:45 +00:00
def calc_profit(self, rate: Optional[float] = None,
fee: Optional[float] = None) -> float:
2017-12-17 21:07:56 +00:00
"""
2018-11-01 12:05:57 +00:00
Calculate the absolute profit in stake currency between Close and Open trade
2017-12-17 21:07:56 +00:00
:param fee: fee to use on the close rate (optional).
If rate is not set self.fee will be used
2017-12-17 21:07:56 +00:00
:param rate: close rate to compare with (optional).
If rate is not set self.close_rate will be used
2018-11-01 12:05:57 +00:00
:return: profit in stake currency as float
2017-12-17 21:07:56 +00:00
"""
close_trade_price = self.calc_close_trade_price(
rate=(rate or self.close_rate),
fee=(fee or self.fee_close)
2017-12-17 21:07:56 +00:00
)
profit = close_trade_price - self.open_trade_price
2018-06-23 13:27:29 +00:00
return float(f"{profit:.8f}")
2017-12-17 21:07:56 +00:00
def calc_profit_ratio(self, rate: Optional[float] = None,
fee: Optional[float] = None) -> float:
"""
Calculates the profit as ratio (including fee).
:param rate: rate to compare with (optional).
If rate is not set self.close_rate will be used
2018-03-17 21:12:21 +00:00
:param fee: fee to use on the close rate (optional).
:return: profit ratio as float
"""
2017-12-17 21:07:56 +00:00
close_trade_price = self.calc_close_trade_price(
rate=(rate or self.close_rate),
fee=(fee or self.fee_close)
2017-12-17 21:07:56 +00:00
)
2020-02-28 09:36:39 +00:00
profit_ratio = (close_trade_price / self.open_trade_price) - 1
return float(f"{profit_ratio:.8f}")
def select_order(self, order_side: str, is_open: Optional[bool]) -> Optional[Order]:
"""
2020-09-11 04:59:07 +00:00
Finds latest order for this orderside and status
:param order_side: Side of the order (either 'buy' or 'sell')
:param is_open: Only search for open orders?
2020-09-11 04:59:07 +00:00
:return: latest Order object if it exists, else None
"""
2020-08-22 13:48:00 +00:00
orders = [o for o in self.orders if o.side == order_side]
if is_open is not None:
orders = [o for o in orders if o.ft_is_open == is_open]
if len(orders) > 0:
return orders[-1]
else:
return None
2019-10-29 14:01:10 +00:00
@staticmethod
def get_trades(trade_filter=None) -> Query:
"""
2019-10-29 14:09:01 +00:00
Helper function to query Trades using filters.
:param trade_filter: Optional filter to apply to trades
Can be either a Filter object, or a List of filters
e.g. `(trade_filter=[Trade.id == trade_id, Trade.is_open.is_(True),])`
e.g. `(trade_filter=Trade.id == trade_id)`
:return: unsorted query object
2019-10-29 14:01:10 +00:00
"""
if trade_filter is not None:
if not isinstance(trade_filter, list):
trade_filter = [trade_filter]
return Trade.query.filter(*trade_filter)
else:
return Trade.query
@staticmethod
def get_open_trades() -> List[Any]:
"""
Query trades from persistence layer
"""
return Trade.get_trades(Trade.is_open.is_(True)).all()
2019-10-29 12:32:07 +00:00
@staticmethod
def get_open_order_trades():
"""
Returns all open trades
"""
2019-10-29 14:01:10 +00:00
return Trade.get_trades(Trade.open_order_id.isnot(None)).all()
2019-10-29 12:32:07 +00:00
2020-08-22 13:48:42 +00:00
@staticmethod
def get_open_trades_without_assigned_fees():
"""
Returns all open trades which don't have open fees set correctly
"""
return Trade.get_trades([Trade.fee_open_currency.is_(None),
Trade.orders.any(),
Trade.is_open.is_(True),
]).all()
@staticmethod
def get_sold_trades_without_assigned_fees():
"""
Returns all closed trades which don't have fees set correctly
"""
return Trade.get_trades([Trade.fee_close_currency.is_(None),
Trade.orders.any(),
Trade.is_open.is_(False),
]).all()
2018-12-03 18:46:22 +00:00
@staticmethod
2018-12-03 18:55:37 +00:00
def total_open_trades_stakes() -> float:
"""
Calculates total invested amount in open trades
in stake currency
"""
total_open_stake_amount = Trade.session.query(func.sum(Trade.stake_amount))\
.filter(Trade.is_open.is_(True))\
.scalar()
return total_open_stake_amount or 0
@staticmethod
def get_overall_performance() -> List[Dict[str, Any]]:
2019-10-29 12:32:07 +00:00
"""
Returns List of dicts containing all Trades, including profit and trade count
"""
pair_rates = Trade.session.query(
Trade.pair,
func.sum(Trade.close_profit).label('profit_sum'),
func.count(Trade.pair).label('count')
).filter(Trade.is_open.is_(False))\
.group_by(Trade.pair) \
.order_by(desc('profit_sum')) \
.all()
return [
{
'pair': pair,
'profit': rate,
'count': count
}
for pair, rate, count in pair_rates
]
2019-10-29 10:15:33 +00:00
@staticmethod
def get_best_pair():
2019-10-29 12:32:07 +00:00
"""
Get best pair with closed trade.
:returns: Tuple containing (pair, profit_sum)
2019-10-29 12:32:07 +00:00
"""
2019-10-29 10:15:33 +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) \
.order_by(desc('profit_sum')).first()
return best_pair
@staticmethod
def stoploss_reinitialization(desired_stoploss):
"""
Adjust initial Stoploss to desired stoploss for all open trades.
"""
for trade in Trade.get_open_trades():
logger.info("Found open trade: %s", trade)
# skip case if trailing-stop changed the stoploss already.
if (trade.stop_loss == trade.initial_stop_loss
and trade.initial_stop_loss_pct != desired_stoploss):
# Stoploss value got changed
2019-09-10 07:42:45 +00:00
logger.info(f"Stoploss for {trade} needs adjustment...")
# Force reset of stoploss
trade.stop_loss = None
trade.adjust_stop_loss(trade.open_rate, desired_stoploss)
2019-09-10 07:42:45 +00:00
logger.info(f"New stoploss: {trade.stop_loss}.")
2020-10-17 09:28:34 +00:00
class PairLock(_DECL_BASE):
"""
Pair Locks database model.
"""
__tablename__ = 'pairlocks'
2020-10-17 09:28:34 +00:00
id = Column(Integer, primary_key=True)
2020-10-17 13:15:35 +00:00
pair = Column(String, nullable=False, index=True)
2020-10-17 09:28:34 +00:00
reason = Column(String, nullable=True)
# Time the pair was locked (start time)
lock_time = Column(DateTime, nullable=False)
# Time until the pair is locked (end time)
lock_end_time = Column(DateTime, nullable=False, index=True)
2020-10-17 09:28:34 +00:00
2020-10-17 13:15:35 +00:00
active = Column(Boolean, nullable=False, default=True, index=True)
2020-10-17 09:28:34 +00:00
def __repr__(self):
2020-10-17 09:40:01 +00:00
lock_time = self.lock_time.strftime(DATETIME_PRINT_FORMAT)
lock_end_time = self.lock_end_time.strftime(DATETIME_PRINT_FORMAT)
2020-10-17 09:28:34 +00:00
return (f'PairLock(id={self.id}, pair={self.pair}, lock_time={lock_time}, '
f'lock_end_time={lock_end_time})')
2020-10-17 09:40:01 +00:00
@staticmethod
def lock_pair(pair: str, until: datetime, reason: str = None) -> None:
lock = PairLock(
pair=pair,
lock_time=datetime.now(timezone.utc),
lock_end_time=until,
reason=reason,
active=True
)
PairLock.session.add(lock)
PairLock.session.flush()
2020-10-17 09:28:34 +00:00
@staticmethod
2020-10-17 13:15:35 +00:00
def get_pair_locks(pair: Optional[str], now: Optional[datetime] = None) -> List['PairLock']:
2020-10-17 09:28:34 +00:00
"""
Get all locks for this pair
2020-10-17 13:15:35 +00:00
:param pair: Pair to check for. Returns all current locks if pair is empty
:param now: Datetime object (generated via datetime.now(timezone.utc)).
defaults to datetime.utcnow()
2020-10-17 09:28:34 +00:00
"""
if not now:
now = datetime.now(timezone.utc)
2020-10-17 17:41:58 +00:00
filters = [func.datetime(PairLock.lock_end_time) >= now,
2020-10-17 13:15:35 +00:00
# Only active locks
PairLock.active.is_(True), ]
if pair:
filters.append(PairLock.pair == pair)
2020-10-17 09:28:34 +00:00
return PairLock.query.filter(
2020-10-17 13:15:35 +00:00
*filters
2020-10-17 09:28:34 +00:00
).all()
@staticmethod
def unlock_pair(pair: str, now: Optional[datetime] = None) -> None:
"""
Release all locks for this pair.
2020-10-21 17:35:57 +00:00
:param pair: Pair to unlock
:param now: Datetime object (generated via datetime.now(timezone.utc)).
defaults to datetime.utcnow()
2020-10-17 09:28:34 +00:00
"""
if not now:
now = datetime.now(timezone.utc)
logger.info(f"Releasing all locks for {pair}.")
locks = PairLock.get_pair_locks(pair, now)
for lock in locks:
lock.active = False
PairLock.session.flush()
@staticmethod
def is_pair_locked(pair: str, now: Optional[datetime] = None) -> bool:
"""
:param pair: Pair to check for
2020-10-17 13:15:35 +00:00
:param now: Datetime object (generated via datetime.now(timezone.utc)).
defaults to datetime.utcnow()
2020-10-17 09:28:34 +00:00
"""
if not now:
now = datetime.now(timezone.utc)
return PairLock.query.filter(
PairLock.pair == pair,
func.datetime(PairLock.lock_end_time) >= now,
# Only active locks
PairLock.active.is_(True),
).first() is not None
2020-10-17 13:15:35 +00:00
def to_json(self) -> Dict[str, Any]:
return {
'pair': self.pair,
2020-10-17 18:32:23 +00:00
'lock_time': self.lock_time.strftime(DATETIME_PRINT_FORMAT),
2020-10-17 15:58:07 +00:00
'lock_timestamp': int(self.lock_time.replace(tzinfo=timezone.utc).timestamp() * 1000),
2020-10-17 18:32:23 +00:00
'lock_end_time': self.lock_end_time.strftime(DATETIME_PRINT_FORMAT),
2020-10-17 15:58:07 +00:00
'lock_end_timestamp': int(self.lock_end_time.replace(tzinfo=timezone.utc
).timestamp() * 1000),
2020-10-17 13:15:35 +00:00
'reason': self.reason,
'active': self.active,
}