SuperTrend_MOM_CHOP_PairOptimized

# pragma pylint: disable=missing-docstring, invalid-name, pointless-string-statement
# flake8: noqa: F401
# isort: skip_file
# --- Do not remove these imports ---
import numpy as np
import pandas as pd
from datetime import datetime, timedelta, timezone
from pandas import DataFrame
from typing import Dict, Optional, Union, Tuple, List
from freqtrade.optimize.space import Categorical, Dimension, Integer, SKDecimal
import logging
import json
from functools import reduce
from pathlib import Path

logger = logging.getLogger(__name__)

from freqtrade.strategy import (
    IStrategy,
    Trade,
    Order,
    PairLocks,
    informative,  # @informative decorator
    # Hyperopt Parameters
    BooleanParameter,
    CategoricalParameter,
    DecimalParameter,
    IntParameter,
    RealParameter,
    # timeframe helpers
    timeframe_to_minutes,
    timeframe_to_next_date,
    timeframe_to_prev_date,
    # Strategy helper functions
    merge_informative_pair,
    stoploss_from_absolute,
    stoploss_from_open,
)


# --------------------------------
# Add your lib to import here
import talib.abstract as ta
import pandas_ta as pta
from technical import qtpylib


# ==========================================
# Why This Supertrend Strategy Works When Others Fail
# https://youtu.be/GpR1VOTEdHE
# ==========================================


# ================================
# Download Historical Data
# 02 How to Download Historical Data For Freqtrade like a PRO!
# Tutorial: https://www.patreon.com/posts/110989840
# ================================

"""
freqtrade download-data \
    -c user_data/binance_futures_SuperTrend_MOM_CHOP_PairOptimized.json \
    --timerange 20230101- \
    -t 1m 5m 15m 30m 1h 2h 4h 1d
"""

# ================================
# Backtesting
# 04 Freqtrade Backtesting: Step-by-Step Guide for Beginners
# Tutorial: https://www.patreon.com/posts/111459042
# ================================

"""
freqtrade backtesting \
    --strategy SuperTrend_MOM_CHOP_PairOptimized \
    --timeframe 1h \
    --timerange 20250101-20260101 \
    --breakdown month \
    -c user_data/binance_futures_SuperTrend_MOM_CHOP_PairOptimized.json \
    --cache none \
    --timeframe-detail 5m
"""

# ================================
# Start FreqUI Web Interface
# 06 Freqtrade UI Guide: Backtesting, Plotting, and Strategy Analysis
# Tutorial: https://www.patreon.com/posts/112806832
# ================================

"""
freqtrade webserver \
    --config user_data/binance_futures_SuperTrend_MOM_CHOP_PairOptimized.json
"""


class SuperTrend_MOM_CHOP_PairOptimized(IStrategy):
    
    def __init__(self, config):
        
        # Initialize the strategy with the given configuration and load pair-specific settings.   
        super().__init__(config)
        self.load_pair_settings()

    def load_pair_settings(self) -> None:
        
        # Get the class name dynamically to locate the appropriate settings file
        class_name = self.__class__.__name__
        settings_filename = Path(__file__).parent / f'{class_name}_Settings.json'
        
        try:
            # Attempt to open and load the JSON settings file
            with open(settings_filename, "r") as f:
                self.custom_info = json.load(f)
                logger.info(f"Settings successfully loaded from {settings_filename}.")
                logger.info(f"Settings: {self.custom_info}")

        except FileNotFoundError:
            # Raise an error if the settings file is missing
            raise SystemExit(f"Settings file not found at {settings_filename}. Program will exit.")
        
        except json.JSONDecodeError as e:
            # Raise an error if the JSON file contains invalid data
            raise SystemExit(f"Error decoding JSON from settings file: {e}. Program will exit.")
        
    # Strategy interface version - allow new iterations of the strategy interface.
    # Check the documentation or the Sample strategy to get the latest version.
    INTERFACE_VERSION = 3

    # Optimal timeframe for the strategy.
    timeframe = "1h"

    # Can this strategy go short?
    can_short: bool = True

    # Minimal ROI designed for the strategy.
    # This attribute will be overridden if the config file contains "minimal_roi".
    minimal_roi = {}
    
    # Optimal stoploss designed for the strategy.
    # This attribute will be overridden if the config file contains "stoploss".
    stoploss = -0.25

    # Trailing stoploss
    trailing_stop = False
    # trailing_only_offset_is_reached = False
    # trailing_stop_positive = 0.01
    # trailing_stop_positive_offset = 0.0  # Disabled / not configured
    
    # Run "populate_indicators()" only for new candle.
    process_only_new_candles = True

    # These values can be overridden in the config.
    use_exit_signal = True
    exit_profit_only = False
    ignore_roi_if_entry_signal = False

    # Number of candles the strategy requires before producing valid signals
    startup_candle_count: int = 200

    @property
    def plot_config(self):

        plot_config = {
            "main_plot": {
                "supertrend": 
                    {
                        "color": "#4caf50",
                        "type": "line",
                        "fill_to": "close"
                },
            },
            "subplots": {

                "Mom": {
                    f"momentum": {
                        "color": "#2962FF",
                        "type": "line"
                    }
                },
                "CHOP": {
                    f"chop": {
                        "color": "#f23645",
                        "type": "line"
                    }
                }
            }
        }
        
        return plot_config
    
    
    def informative_pairs(self):
        """
        Define additional, informative pair/interval combinations to be cached from the exchange.
        These pair/interval combinations are non-tradeable, unless they are part
        of the whitelist as well.
        For more information, please consult the documentation
        :return: List of tuples in the format (pair, interval)
            Sample: return [("ETH/USDT", "5m"),
                            ("BTC/USDT", "15m"),
                            ]
        """
        
        # get access to all pairs available in whitelist.
        # pairs = self.dp.current_whitelist()

        # # Assign tf to each pair so they can be downloaded and cached for strategy.
        # informative_pairs = [(pair, self.informative_timeframe) for pair in pairs]
        
        return []
    
    
    def populate_indicators(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
        
        pair = metadata['pair']
        
        if pair in self.custom_info:
            
            pair_settings = self.custom_info[pair]
            
            superTrend = pta.supertrend(dataframe['high'], dataframe['low'], dataframe['close'], length=pair_settings["supertrend_length"], multiplier=pair_settings["supertrend_multiplier"])
            dataframe['supertrend'] = superTrend[f'SUPERT_{pair_settings["supertrend_length"]}_{pair_settings["supertrend_multiplier"]}.0']
            dataframe['supertrend_direction'] = superTrend[f'SUPERTd_{pair_settings["supertrend_length"]}_{pair_settings["supertrend_multiplier"]}.0']
                    
            dataframe['momentum'] = ta.MOM(dataframe['close'], timeperiod=10)
                  
            dataframe['chop'] = pta.chop(
                high=dataframe['high'],
                low=dataframe['low'],
                close=dataframe['close'],
                length=14
            )
            
            dataframe["atr"] = ta.ATR(dataframe)

            return dataframe

    def populate_entry_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:        
        
        pair = metadata["pair"]
        
        if pair in self.custom_info:
            
            pair_settings = self.custom_info[pair]
            
            dataframe.loc[
                (   
                    (dataframe['supertrend_direction'] == 1) &
                    (dataframe['supertrend_direction'].shift(1) == -1) &
                    (dataframe['momentum'] > pair_settings["momentum_threshold"]) &
                    (dataframe['chop'] < pair_settings["chop_threshold"]) &
                    (dataframe["volume"] > 0) 
                ),
                'enter_long'] = 1

            dataframe.loc[
                (
                    (dataframe['supertrend_direction'] == -1) &
                    (dataframe['supertrend_direction'].shift(1) == 1) &
                    (dataframe['momentum'] < -pair_settings["momentum_threshold"]) &
                    (dataframe['chop'] < pair_settings["chop_threshold"]) &
                    (dataframe["volume"] > 0) 
                ),
                'enter_short'] = 1

            return dataframe
    

    def populate_exit_trend(self, dataframe: DataFrame, metadata: dict) -> DataFrame:
        
        dataframe.loc[:, 'exit_long'] = 0
        dataframe.loc[:, 'exit_short'] = 0

        return dataframe
    
    def custom_exit(self, pair: str, trade: Trade, current_time: datetime, current_rate: float,
                current_profit: float, **kwargs):
        
        if pair in self.custom_info:
            
            pair_settings = self.custom_info[pair]
            
            side = -1 if trade.is_short else 1

            # Retrieve TP and SL from custom data
            take_profit = trade.get_custom_data('take_profit')
            stop_loss = trade.get_custom_data('stop_loss')
            
            # If TP or SL is not set, initialize them
            if take_profit is None or stop_loss is None:
                dataframe, _ = self.dp.get_analyzed_dataframe(pair, self.timeframe)

                # Get the date just before trade opened
                trade_date = timeframe_to_prev_date(self.timeframe, trade.open_date_utc)

                # Filter dataframe to candles before the trade opened
                signal_data = dataframe.loc[dataframe["date"] < trade_date]

                if signal_data.empty:
                    logger.warning(f"[{pair}] No signal candle found. Skip setting TP/SL.")
                    return None

                signal_candle = signal_data.iloc[-1]
                
                # Calculate TP and SL
                atr = signal_candle["atr"]
                close = signal_candle["close"]

                take_profit = close + side * pair_settings["atr_mult"] * atr * pair_settings["risk_ratio"]
                stop_loss = close - side * pair_settings["atr_mult"] * atr
                
                # Save to trade's custom data
                trade.set_custom_data('take_profit', take_profit)
                trade.set_custom_data('stop_loss', stop_loss)

                # logger.info(f"[{pair}] TP/SL set. TP: {take_profit:.2f}, SL: {stop_loss:.2f}")
                
            # Get the current close price
            dataframe, _ = self.dp.get_analyzed_dataframe(pair, self.timeframe)
            current_close = dataframe.iloc[-1]['close']

            # Check exit conditions
            if (trade.is_short and current_close <= take_profit) or \
            (not trade.is_short and current_close >= take_profit):
                # logger.info(f"[{pair}] Take Profit hit! Close: {current_close:.2f}, TP: {take_profit:.2f}")
                return "take_profit_achieved"

            if (trade.is_short and current_close >= stop_loss) or \
            (not trade.is_short and current_close <= stop_loss):
                # logger.info(f"[{pair}] Stop Loss hit! Close: {current_close:.2f}, SL: {stop_loss:.2f}")
                return "stop_loss_achieved"

            return None
        
    def leverage(self, pair: str, current_time: datetime, current_rate: float,
                 proposed_leverage: float, max_leverage: float, side: str,
                 **kwargs) -> float:

        if pair in self.custom_info:
            
            pair_settings = self.custom_info[pair]
            
            return pair_settings["leverage_level"]