stable/freqtrade/plugins/protections/iprotection.py

120 lines
4.2 KiB
Python
Raw Normal View History

import logging
2020-11-22 10:49:41 +00:00
from abc import ABC, abstractmethod
2022-04-24 08:29:19 +00:00
from dataclasses import dataclass
from datetime import datetime, timedelta, timezone
2022-04-24 08:29:19 +00:00
from typing import Any, Dict, List, Optional
2022-09-18 11:20:36 +00:00
from freqtrade.constants import Config, LongShort
2020-12-07 09:45:35 +00:00
from freqtrade.exchange import timeframe_to_minutes
2020-12-07 10:08:54 +00:00
from freqtrade.misc import plural
2020-10-15 05:38:00 +00:00
from freqtrade.mixins import LoggingMixin
from freqtrade.persistence import LocalTrade
2020-10-15 05:38:00 +00:00
logger = logging.getLogger(__name__)
2022-04-24 08:29:19 +00:00
@dataclass
class ProtectionReturn:
lock: bool
until: datetime
reason: Optional[str]
2022-04-24 09:23:26 +00:00
lock_side: str = '*'
2020-10-15 06:07:09 +00:00
2020-10-15 05:38:00 +00:00
class IProtection(LoggingMixin, ABC):
# Can globally stop the bot
has_global_stop: bool = False
# Can stop trading for one pair
has_local_stop: bool = False
2022-09-18 11:20:36 +00:00
def __init__(self, config: Config, protection_config: Dict[str, Any]) -> None:
self._config = config
2020-10-14 05:40:44 +00:00
self._protection_config = protection_config
2021-08-04 18:52:56 +00:00
self._stop_duration_candles: Optional[int] = None
self._lookback_period_candles: Optional[int] = None
2020-12-07 09:45:35 +00:00
tf_in_min = timeframe_to_minutes(config['timeframe'])
if 'stop_duration_candles' in protection_config:
2021-08-03 05:14:31 +00:00
self._stop_duration_candles = int(protection_config.get('stop_duration_candles', 1))
2020-12-07 10:08:54 +00:00
self._stop_duration = (tf_in_min * self._stop_duration_candles)
2020-12-07 09:45:35 +00:00
else:
2020-12-07 10:08:54 +00:00
self._stop_duration_candles = None
2020-12-07 09:45:35 +00:00
self._stop_duration = protection_config.get('stop_duration', 60)
if 'lookback_period_candles' in protection_config:
2021-08-03 05:14:31 +00:00
self._lookback_period_candles = int(protection_config.get('lookback_period_candles', 1))
2020-12-07 10:08:54 +00:00
self._lookback_period = tf_in_min * self._lookback_period_candles
2020-12-07 09:45:35 +00:00
else:
2020-12-07 10:08:54 +00:00
self._lookback_period_candles = None
2021-08-03 05:14:31 +00:00
self._lookback_period = int(protection_config.get('lookback_period', 60))
2020-10-15 05:38:00 +00:00
LoggingMixin.__init__(self, logger)
@property
def name(self) -> str:
return self.__class__.__name__
2020-12-07 10:08:54 +00:00
@property
def stop_duration_str(self) -> str:
"""
Output configured stop duration in either candles or minutes
"""
if self._stop_duration_candles:
return (f"{self._stop_duration_candles} "
f"{plural(self._stop_duration_candles, 'candle', 'candles')}")
else:
return (f"{self._stop_duration} "
f"{plural(self._stop_duration, 'minute', 'minutes')}")
@property
def lookback_period_str(self) -> str:
"""
Output configured lookback period in either candles or minutes
"""
if self._lookback_period_candles:
return (f"{self._lookback_period_candles} "
f"{plural(self._lookback_period_candles, 'candle', 'candles')}")
else:
return (f"{self._lookback_period} "
f"{plural(self._lookback_period, 'minute', 'minutes')}")
@abstractmethod
def short_desc(self) -> str:
"""
Short method description - used for startup-messages
-> Please overwrite in subclasses
"""
2020-10-14 05:40:44 +00:00
@abstractmethod
2022-04-24 08:58:21 +00:00
def global_stop(self, date_now: datetime, side: LongShort) -> Optional[ProtectionReturn]:
2020-10-14 05:40:44 +00:00
"""
Stops trading (position entering) for all pairs
This must evaluate to true for the whole period of the "cooldown period".
"""
2020-10-24 14:52:26 +00:00
@abstractmethod
2022-04-24 08:58:21 +00:00
def stop_per_pair(
self, pair: str, date_now: datetime, side: LongShort) -> Optional[ProtectionReturn]:
2020-10-24 14:52:26 +00:00
"""
Stops trading (position entering) for this pair
This must evaluate to true for the whole period of the "cooldown period".
:return: Tuple of [bool, until, reason].
If true, this pair will be locked with <reason> until <until>
"""
@staticmethod
def calculate_lock_end(trades: List[LocalTrade], stop_minutes: int) -> datetime:
"""
Get lock end time
"""
max_date: datetime = max([trade.close_date for trade in trades if trade.close_date])
# comming from Database, tzinfo is not set.
if max_date.tzinfo is None:
max_date = max_date.replace(tzinfo=timezone.utc)
until = max_date + timedelta(minutes=stop_minutes)
return until