From 2ea157d9d3507a3eb4f45ec806f903f9a58bc3d3 Mon Sep 17 00:00:00 2001
From: Matthias <xmatthias@outlook.com>
Date: Thu, 20 Apr 2023 06:58:05 +0200
Subject: [PATCH] Add some more pairlist parameter definitions

---
 freqtrade/plugins/pairlist/AgeFilter.py       |  6 ------
 freqtrade/plugins/pairlist/IPairList.py       |  4 ++--
 freqtrade/plugins/pairlist/OffsetFilter.py    | 19 ++++++++++++++++++-
 .../plugins/pairlist/PerformanceFilter.py     | 19 ++++++++++++++++++-
 freqtrade/plugins/pairlist/PrecisionFilter.py |  2 +-
 freqtrade/plugins/pairlist/StaticPairList.py  | 13 ++++++++++++-
 6 files changed, 51 insertions(+), 12 deletions(-)

diff --git a/freqtrade/plugins/pairlist/AgeFilter.py b/freqtrade/plugins/pairlist/AgeFilter.py
index 66556841b..cd8fb9c68 100644
--- a/freqtrade/plugins/pairlist/AgeFilter.py
+++ b/freqtrade/plugins/pairlist/AgeFilter.py
@@ -70,12 +70,6 @@ class AgeFilter(IPairList):
 
     @staticmethod
     def available_parameters() -> Dict[str, PairlistParameter]:
-        """
-        Return parameters used by this Pairlist Handler, and their type
-        contains a dictionary with the parameter name as key, and a dictionary
-        with the type and default value.
-        -> Please overwrite in subclasses
-        """
         return {
             "min_days_listed": {
                 "type": "number",
diff --git a/freqtrade/plugins/pairlist/IPairList.py b/freqtrade/plugins/pairlist/IPairList.py
index 3e143aa69..589240b10 100644
--- a/freqtrade/plugins/pairlist/IPairList.py
+++ b/freqtrade/plugins/pairlist/IPairList.py
@@ -18,7 +18,7 @@ logger = logging.getLogger(__name__)
 
 class PairlistParameter(TypedDict):
     type: Literal["number", "string", "boolean"]
-    default: Union[int, float, str, bool]
+    default: Union[int, float, str, bool, None]
     description: str
     help: str
 
@@ -72,7 +72,7 @@ class IPairList(LoggingMixin, ABC):
         return {}
 
     @staticmethod
-    def refresh_period(params: Dict[str, PairlistParameter]) -> None:
+    def refresh_period_parameter() -> Dict[str, PairlistParameter]:
         return {
             "refresh_period": {
                 "type": "number",
diff --git a/freqtrade/plugins/pairlist/OffsetFilter.py b/freqtrade/plugins/pairlist/OffsetFilter.py
index 8f21cdd85..e7688a66c 100644
--- a/freqtrade/plugins/pairlist/OffsetFilter.py
+++ b/freqtrade/plugins/pairlist/OffsetFilter.py
@@ -7,7 +7,7 @@ from typing import Any, Dict, List
 from freqtrade.constants import Config
 from freqtrade.exceptions import OperationalException
 from freqtrade.exchange.types import Tickers
-from freqtrade.plugins.pairlist.IPairList import IPairList
+from freqtrade.plugins.pairlist.IPairList import IPairList, PairlistParameter
 
 
 logger = logging.getLogger(__name__)
@@ -43,6 +43,23 @@ class OffsetFilter(IPairList):
             return f"{self.name} - Taking {self._number_pairs} Pairs, starting from {self._offset}."
         return f"{self.name} - Offsetting pairs by {self._offset}."
 
+    @staticmethod
+    def available_parameters() -> Dict[str, PairlistParameter]:
+        return {
+            "offset": {
+                "type": "number",
+                "default": 0,
+                "description": "Offset",
+                "help": "Offset of the pairlist.",
+            },
+            "number_assets": {
+                "type": "number",
+                "default": 0,
+                "description": "Number of assets",
+                "help": "Number of assets to use from the pairlist, starting from offset.",
+            },
+        }
+
     def filter_pairlist(self, pairlist: List[str], tickers: Tickers) -> List[str]:
         """
         Filters and sorts pairlist and returns the whitelist again.
diff --git a/freqtrade/plugins/pairlist/PerformanceFilter.py b/freqtrade/plugins/pairlist/PerformanceFilter.py
index e7fcac1e4..6c582a4df 100644
--- a/freqtrade/plugins/pairlist/PerformanceFilter.py
+++ b/freqtrade/plugins/pairlist/PerformanceFilter.py
@@ -9,7 +9,7 @@ import pandas as pd
 from freqtrade.constants import Config
 from freqtrade.exchange.types import Tickers
 from freqtrade.persistence import Trade
-from freqtrade.plugins.pairlist.IPairList import IPairList
+from freqtrade.plugins.pairlist.IPairList import IPairList, PairlistParameter
 
 
 logger = logging.getLogger(__name__)
@@ -40,6 +40,23 @@ class PerformanceFilter(IPairList):
         """
         return f"{self.name} - Sorting pairs by performance."
 
+    @staticmethod
+    def available_parameters() -> Dict[str, PairlistParameter]:
+        return {
+            "minutes": {
+                "type": "number",
+                "default": 0,
+                "description": "Minutes",
+                "help": "Consider trades from the last X minutes. 0 means all trades.",
+            },
+            "min_profit": {
+                "type": "number",
+                "default": None,
+                "description": "Minimum profit",
+                "help": "Minimum profit in percent. Pairs with less profit are removed.",
+            },
+        }
+
     def filter_pairlist(self, pairlist: List[str], tickers: Tickers) -> List[str]:
         """
         Filters and sorts pairlist and returns the allowlist again.
diff --git a/freqtrade/plugins/pairlist/PrecisionFilter.py b/freqtrade/plugins/pairlist/PrecisionFilter.py
index 2e74aa293..08f7ac5d6 100644
--- a/freqtrade/plugins/pairlist/PrecisionFilter.py
+++ b/freqtrade/plugins/pairlist/PrecisionFilter.py
@@ -8,7 +8,7 @@ from freqtrade.constants import Config
 from freqtrade.exceptions import OperationalException
 from freqtrade.exchange import ROUND_UP
 from freqtrade.exchange.types import Ticker
-from freqtrade.plugins.pairlist.IPairList import IPairList
+from freqtrade.plugins.pairlist.IPairList import IPairList, PairlistParameter
 
 
 logger = logging.getLogger(__name__)
diff --git a/freqtrade/plugins/pairlist/StaticPairList.py b/freqtrade/plugins/pairlist/StaticPairList.py
index 4b1961a53..f94c91d3d 100644
--- a/freqtrade/plugins/pairlist/StaticPairList.py
+++ b/freqtrade/plugins/pairlist/StaticPairList.py
@@ -9,7 +9,7 @@ from typing import Any, Dict, List
 
 from freqtrade.constants import Config
 from freqtrade.exchange.types import Tickers
-from freqtrade.plugins.pairlist.IPairList import IPairList
+from freqtrade.plugins.pairlist.IPairList import IPairList, PairlistParameter
 
 
 logger = logging.getLogger(__name__)
@@ -40,6 +40,17 @@ class StaticPairList(IPairList):
         """
         return f"{self.name}"
 
+    @staticmethod
+    def available_parameters() -> Dict[str, PairlistParameter]:
+        return {
+            "allow_inactive": {
+                "type": "boolean",
+                "default": False,
+                "description": "Allow inactive pairs",
+                "help": "Allow inactive pairs to be in the whitelist.",
+            },
+        }
+
     def gen_pairlist(self, tickers: Tickers) -> List[str]:
         """
         Generate the pairlist