OctoBot-Trading 2.4.67__tar.gz → 2.4.69__tar.gz

{OctoBot-Trading-2.4.67 → OctoBot-Trading-2.4.69}/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.4.69] - 2024-03-26
+### Added
+- [TradingMode] update activity from consumer
+
+## [2.4.68] - 2024-03-25
+### Added
+- [TradingMode] last_activity
+
 ## [2.4.67] - 2024-03-23
 ### Updated
 - [TradingMode] Requirements for indexes

{OctoBot-Trading-2.4.67 → OctoBot-Trading-2.4.69/OctoBot_Trading.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: OctoBot-Trading
-Version: 2.4.67
+Version: 2.4.69
 Summary: OctoBot project trading package
 Home-page: https://github.com/Drakkar-Software/OctoBot-Trading
 Author: Drakkar-Software
@@ -16,7 +16,7 @@ Classifier: Operating System :: POSIX
 Requires-Python: >=3.8
 License-File: LICENSE
 
-# OctoBot-Trading [2.4.67](https://github.com/Drakkar-Software/OctoBot-Trading/blob/master/CHANGELOG.md)
+# OctoBot-Trading [2.4.69](https://github.com/Drakkar-Software/OctoBot-Trading/blob/master/CHANGELOG.md)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/903b6b22bceb4661b608a86fea655f69)](https://app.codacy.com/gh/Drakkar-Software/OctoBot-Trading?utm_source=github.com&utm_medium=referral&utm_content=Drakkar-Software/OctoBot-Trading&utm_campaign=Badge_Grade_Dashboard)
 [![PyPI](https://img.shields.io/pypi/v/OctoBot-Trading.svg)](https://pypi.python.org/pypi/OctoBot-Trading/)
 [![Coverage Status](https://coveralls.io/repos/github/Drakkar-Software/OctoBot-Trading/badge.svg?branch=master)](https://coveralls.io/github/Drakkar-Software/OctoBot-Trading?branch=master)

{OctoBot-Trading-2.4.67 → OctoBot-Trading-2.4.69}/OctoBot_Trading.egg-info/SOURCES.txt

@@ -126,6 +126,7 @@ octobot_trading/exchanges/util/symbol_details.py
 octobot_trading/exchanges/util/websockets_util.py
 octobot_trading/modes/__init__.py
 octobot_trading/modes/abstract_trading_mode.py
+octobot_trading/modes/mode_activity.py
 octobot_trading/modes/mode_config.py
 octobot_trading/modes/modes_factory.py
 octobot_trading/modes/modes_util.py

{OctoBot-Trading-2.4.67/OctoBot_Trading.egg-info → OctoBot-Trading-2.4.69}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: OctoBot-Trading
-Version: 2.4.67
+Version: 2.4.69
 Summary: OctoBot project trading package
 Home-page: https://github.com/Drakkar-Software/OctoBot-Trading
 Author: Drakkar-Software
@@ -16,7 +16,7 @@ Classifier: Operating System :: POSIX
 Requires-Python: >=3.8
 License-File: LICENSE
 
-# OctoBot-Trading [2.4.67](https://github.com/Drakkar-Software/OctoBot-Trading/blob/master/CHANGELOG.md)
+# OctoBot-Trading [2.4.69](https://github.com/Drakkar-Software/OctoBot-Trading/blob/master/CHANGELOG.md)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/903b6b22bceb4661b608a86fea655f69)](https://app.codacy.com/gh/Drakkar-Software/OctoBot-Trading?utm_source=github.com&utm_medium=referral&utm_content=Drakkar-Software/OctoBot-Trading&utm_campaign=Badge_Grade_Dashboard)
 [![PyPI](https://img.shields.io/pypi/v/OctoBot-Trading.svg)](https://pypi.python.org/pypi/OctoBot-Trading/)
 [![Coverage Status](https://coveralls.io/repos/github/Drakkar-Software/OctoBot-Trading/badge.svg?branch=master)](https://coveralls.io/github/Drakkar-Software/OctoBot-Trading?branch=master)

{OctoBot-Trading-2.4.67 → OctoBot-Trading-2.4.69}/README.md

@@ -1,4 +1,4 @@
-# OctoBot-Trading [2.4.67](https://github.com/Drakkar-Software/OctoBot-Trading/blob/master/CHANGELOG.md)
+# OctoBot-Trading [2.4.69](https://github.com/Drakkar-Software/OctoBot-Trading/blob/master/CHANGELOG.md)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/903b6b22bceb4661b608a86fea655f69)](https://app.codacy.com/gh/Drakkar-Software/OctoBot-Trading?utm_source=github.com&utm_medium=referral&utm_content=Drakkar-Software/OctoBot-Trading&utm_campaign=Badge_Grade_Dashboard)
 [![PyPI](https://img.shields.io/pypi/v/OctoBot-Trading.svg)](https://pypi.python.org/pypi/OctoBot-Trading/)
 [![Coverage Status](https://coveralls.io/repos/github/Drakkar-Software/OctoBot-Trading/badge.svg?branch=master)](https://coveralls.io/github/Drakkar-Software/OctoBot-Trading?branch=master)

{OctoBot-Trading-2.4.67 → OctoBot-Trading-2.4.69}/octobot_trading/__init__.py

@@ -15,4 +15,4 @@
 #  License along with this library.
 
 PROJECT_NAME = "OctoBot-Trading"
-VERSION = "2.4.67"  # major.minor.revision
+VERSION = "2.4.69"  # major.minor.revision

{OctoBot-Trading-2.4.67 → OctoBot-Trading-2.4.69}/octobot_trading/constants.py

@@ -50,6 +50,7 @@ CONFIG_CANDLES_HISTORY_SIZE_TITLE = "Candles history size"
 CONFIG_CANDLES_HISTORY_SIZE_KEY = CONFIG_CANDLES_HISTORY_SIZE_TITLE.replace(" ", "_")
 CONFIG_BUY_ORDER_AMOUNT = "buy_order_amount"
 CONFIG_SELL_ORDER_AMOUNT = "sell_order_amount"
+TRADING_MODE_ACTIVITY_REASON = "reason"
 
 # Exchange
 DEFAULT_EXCHANGE_TIME_LAG = 10

{OctoBot-Trading-2.4.67 → OctoBot-Trading-2.4.69}/octobot_trading/enums.py

@@ -575,3 +575,9 @@ class OrderUpdateType(enum.Enum):
 class ExchangeSupportedElements(enum.Enum):
     UNSUPPORTED_ORDERS = "unsupported_orders"
     SUPPORTED_BUNDLED_ORDERS = "supported_bundled_orders"
+
+
+class TradingModeActivityType(enum.Enum):
+    CREATED_ORDERS = "created_orders"
+    NOTHING_TO_DO = "nothing_to_do"
+    NO_ACTIVITY = None

{OctoBot-Trading-2.4.67 → OctoBot-Trading-2.4.69}/octobot_trading/modes/__init__.py

@@ -58,6 +58,11 @@ from octobot_trading.modes.modes_factory import (
     create_temporary_trading_mode_with_local_config,
 )
 
+from octobot_trading.modes import mode_activity
+from octobot_trading.modes.mode_activity import (
+    TradingModeActivity,
+)
+
 from octobot_trading.modes import modes_util
 from octobot_trading.modes.modes_util import (
     get_required_candles_count,
@@ -81,6 +86,7 @@ __all__ = [
     "create_trading_modes",
     "create_trading_mode",
     "create_temporary_trading_mode_with_local_config",
+    "TradingModeActivity",
     "get_activated_trading_mode",
     "should_emit_trading_signals_user_input",
     "is_trading_signal_emitter",

{OctoBot-Trading-2.4.67 → OctoBot-Trading-2.4.69}/octobot_trading/modes/abstract_trading_mode.py

@@ -71,9 +71,12 @@ class AbstractTradingMode(abstract_tentacle.AbstractTentacle):
         # The id of the OctoBot using this trading mode
         self.bot_id: str = None
 
-        # Evaluator specific config (Is loaded from tentacle specific file)
+        # Trading Mode specific config (Is loaded from tentacle specific file)
         self.trading_config: dict = None
 
+        # Trading Mode specific config snapshot before a config update
+        self.previous_trading_config: dict = None
+
         # If this mode is enabled
         self.enabled: bool = True
 

{OctoBot-Trading-2.4.67 → OctoBot-Trading-2.4.69}/octobot_trading/modes/channel/abstract_mode_consumer.py

@@ -21,6 +21,7 @@ import octobot_commons.constants as commons_constants
 
 import octobot_trading.exchange_channel as exchange_channel
 import octobot_trading.modes.channel as modes_channel
+import octobot_trading.modes.mode_activity as mode_activity
 import octobot_trading.enums as enums
 import octobot_trading.errors as errors
 import octobot_trading.constants as constants
@@ -205,6 +206,15 @@ class AbstractTradingModeConsumer(modes_channel.ModeChannelConsumer):
         return len(self.exchange_manager.exchange_personal_data.portfolio_manager.portfolio_value_holder
                    .origin_crypto_currencies_values)
 
+    def _update_producer_last_activity(self, activity_type: enums, reason):
+        for producer in self.trading_mode.producers:
+            if isinstance(producer, modes_channel.AbstractTradingModeProducer):
+                if producer.last_activity is None:
+                    producer.last_activity = mode_activity.TradingModeActivity(activity_type)
+                else:
+                    producer.last_activity.type = activity_type
+                producer.last_activity.set_reason(reason)
+
     async def wait_for_active_position(self, symbol, timeout, side=None) -> bool:
         """
         Instantly return when the position is already active.

{OctoBot-Trading-2.4.67 → OctoBot-Trading-2.4.69}/octobot_trading/modes/channel/abstract_mode_producer.py

@@ -35,6 +35,7 @@ import octobot_trading.exchanges.exchanges as exchanges
 import octobot_trading.exchange_channel as exchanges_channel
 import octobot_trading.modes.channel as modes_channel
 import octobot_trading.modes.script_keywords as script_keywords
+import octobot_trading.modes.mode_activity as mode_activity
 import octobot_trading.storage.util as storage_util
 
 
@@ -95,6 +96,8 @@ class AbstractTradingModeProducer(modes_channel.ModeChannelProducer):
         self._is_trigger_completed = asyncio.Event()
         self._is_trigger_completed.set()
 
+        self.last_activity: mode_activity.TradingModeActivity = mode_activity.TradingModeActivity()
+
     def on_reload_config(self):
         """
         Called at constructor and after the associated trading mode's reload_config.

OctoBot-Trading-2.4.69/octobot_trading/modes/mode_activity.py

@@ -0,0 +1,28 @@
+#  Drakkar-Software OctoBot-Trading
+#  Copyright (c) Drakkar-Software, All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 3.0 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library
+import dataclasses
+import enum
+import octobot_trading.enums
+import octobot_trading.constants
+
+
+@dataclasses.dataclass
+class TradingModeActivity:
+    type: enum.Enum = octobot_trading.enums.TradingModeActivityType.NO_ACTIVITY
+    details: dict = dataclasses.field(default_factory=dict)
+
+    def set_reason(self, reason):
+        self.details = {octobot_trading.constants.TRADING_MODE_ACTIVITY_REASON: reason}

{OctoBot-Trading-2.4.67 → OctoBot-Trading-2.4.69}/octobot_trading/personal_data/portfolios/portfolio_value_holder.py

@@ -131,16 +131,18 @@ class PortfolioValueHolder:
                 self.logger.info(f"Missing {asset} price conversion, ignoring {float(asset_holdings.total)} holdings.")
         return total_value
 
+    def get_traded_assets_holdings_value(self, unit):
+        assets = set()
+        for symbol in self.portfolio_manager.exchange_manager.exchange_config.traded_symbols:
+            assets.add(symbol.base)
+            assets.add(symbol.quote)
+        return self.get_assets_holdings_value(
+            assets, unit
+        )
+
     def get_holdings_ratio(self, currency, traded_symbols_only=False, include_assets_in_open_orders=False):
         if traded_symbols_only:
-            # only consider traded assets for total_holdings_value
-            assets = set()
-            for symbol in self.portfolio_manager.exchange_manager.exchange_config.traded_symbols:
-                assets.add(symbol.base)
-                assets.add(symbol.quote)
-            total_holdings_value = self.get_assets_holdings_value(
-                assets, self.portfolio_manager.reference_market
-            )
+            total_holdings_value = self.get_traded_assets_holdings_value(self.portfolio_manager.reference_market)
         else:
             # consider all assets for total_holdings_value
             total_holdings_value = self.portfolio_current_value
@@ -157,7 +159,7 @@ class PortfolioValueHolder:
                 elif order.side is enums.TradeOrderSide.SELL and symbol.quote == currency:
                     assets_in_open_orders += order.total_cost
             currency_holdings += assets_in_open_orders
-        # compute ration
+        # compute ratio
         current_holdings_value = self.value_converter.evaluate_value(currency, currency_holdings)
         return current_holdings_value / total_holdings_value
 

{OctoBot-Trading-2.4.67 → OctoBot-Trading-2.4.69}/tests/modes/test_abstract_mode_consumer.py

@@ -13,22 +13,17 @@
 #
 #  You should have received a copy of the GNU Lesser General Public
 #  License along with this library.
-import decimal
 import mock
 import pytest
 
 import octobot_commons.constants as commons_constants
 from octobot_backtesting.backtesting import Backtesting
-from octobot_commons.asyncio_tools import wait_asyncio_next_cycle
 from octobot_commons.tests.test_config import load_test_config
 from octobot_trading.modes.channel.abstract_mode_consumer import AbstractTradingModeConsumer
-from octobot_trading.enums import EvaluatorStates
-import octobot_trading.constants as constants
-import octobot_trading.errors as errors
-import octobot_trading.enums as enums
+from octobot_trading.enums import EvaluatorStates, TradingModeActivityType
+from octobot_trading.constants import TRADING_MODE_ACTIVITY_REASON
 from octobot_trading.exchanges.exchange_manager import ExchangeManager
-from octobot_trading.modes import AbstractTradingMode
-import octobot_trading.personal_data.portfolios.assets as portfolio_assets
+from octobot_trading.modes import AbstractTradingMode, AbstractTradingModeProducer, TradingModeActivity
 from octobot_trading.exchanges.traders.trader_simulator import TraderSimulator
 from tests import event_loop
 
@@ -144,3 +139,21 @@ async def test_get_number_of_traded_assets():
             "aaa": 3
         }
     assert consumer.get_number_of_traded_assets() == 3
+
+
+async def test_update_producer_last_activity():
+    exchange_manager, symbol, consumer = await _get_tools()
+    mode = consumer.trading_mode
+    producer = AbstractTradingModeProducer(
+        mock.Mock(exchange_manager=exchange_manager), exchange_manager.config, mode, exchange_manager
+    )
+    mode.producers.append(producer)
+    assert producer.last_activity == TradingModeActivity()
+    consumer._update_producer_last_activity(TradingModeActivityType.NOTHING_TO_DO, "plop")
+    assert producer.last_activity == TradingModeActivity(
+        TradingModeActivityType.NOTHING_TO_DO, {TRADING_MODE_ACTIVITY_REASON: "plop"}
+    )
+    consumer._update_producer_last_activity(TradingModeActivityType.CREATED_ORDERS, "11")
+    assert producer.last_activity == TradingModeActivity(
+        TradingModeActivityType.CREATED_ORDERS, {TRADING_MODE_ACTIVITY_REASON: "11"}
+    )