diff --git a/freqtrade/enums/collateral.py b/freqtrade/enums/collateral.py index 474189902..0a5988698 100644 --- a/freqtrade/enums/collateral.py +++ b/freqtrade/enums/collateral.py @@ -3,7 +3,9 @@ from enum import Enum class Collateral(Enum): """ - Bot application states + Enum to distinguish between + cross margin/futures collateral and + isolated margin/futures collateral """ CROSS = "cross" ISOLATED = "isolated" diff --git a/freqtrade/enums/liqformula.py b/freqtrade/enums/liqformula.py index 48157f5c2..471a45624 100644 --- a/freqtrade/enums/liqformula.py +++ b/freqtrade/enums/liqformula.py @@ -38,13 +38,21 @@ class LiqFormula(Enum): def exception(name: str, trading_mode: TradingMode, collateral: Collateral): """ Raises an exception if exchange used doesn't support desired leverage mode - :param trading_mode: cross, isolated, cross_futures or isolated_futures + :param name: Name of the exchange + :param trading_mode: spot, margin, futures + :param collateral: cross, isolated """ raise OperationalException( f"{name} does not support {collateral.value} {trading_mode.value} trading") def binance(name: str, trading_mode: TradingMode, collateral: Collateral): + """ + Calculates the liquidation price on Binance + :param name: Name of the exchange + :param trading_mode: spot, margin, futures + :param collateral: cross, isolated + """ # TODO-lev: Additional arguments, fill in formulas if trading_mode == TradingMode.MARGIN and collateral == Collateral.CROSS: @@ -65,6 +73,12 @@ def binance(name: str, trading_mode: TradingMode, collateral: Collateral): def kraken(name: str, trading_mode: TradingMode, collateral: Collateral): + """ + Calculates the liquidation price on Kraken + :param name: Name of the exchange + :param trading_mode: spot, margin, futures + :param collateral: cross, isolated + """ # TODO-lev: Additional arguments, fill in formulas if collateral == Collateral.CROSS: @@ -80,6 +94,12 @@ def kraken(name: str, trading_mode: TradingMode, collateral: Collateral): def ftx(name: str, trading_mode: TradingMode, collateral: Collateral): + """ + Calculates the liquidation price on FTX + :param name: Name of the exchange + :param trading_mode: spot, margin, futures + :param collateral: cross, isolated + """ if collateral == Collateral.CROSS: # TODO-lev: Additional arguments, fill in formulas exception(name, trading_mode, collateral) diff --git a/freqtrade/enums/tradingmode.py b/freqtrade/enums/tradingmode.py index 4a5756e4b..a8de60c19 100644 --- a/freqtrade/enums/tradingmode.py +++ b/freqtrade/enums/tradingmode.py @@ -3,8 +3,8 @@ from enum import Enum class TradingMode(Enum): """ - Enum to distinguish between - spot, margin, futures or any other trading method + Enum to distinguish between + spot, margin, futures or any other trading method """ SPOT = "spot" MARGIN = "margin"