[Binance] fix binance futures referral checks

GuillaumeDSM · GuillaumeDSM · commit fe38ffc814e8 · 2025-01-22T16:54:51.000+01:00
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -131,9 +131,10 @@ def add_headers(self, headers_dict):
 
 
 class ExchangeManager:
-    def __init__(self, is_margin=False, is_future=False):
+    def __init__(self, is_margin=False, is_future=False, is_sandboxed=False):
         self.is_future = is_future
         self.is_margin = is_margin
+        self.is_sandboxed = is_sandboxed
 
 
 class ExchangeWrapper:
diff --git a/tests/exchanges/test_binance.py b/tests/exchanges/test_binance.py
@@ -160,6 +160,45 @@ async def test_is_valid_account(binance_exchange):
             _get_api_key_rights_mock.assert_not_called()
 
 
+    # futures trading
+    exchange._exchange.exchange_manager.is_future = True
+    with mock.patch.object(
+        exchange, "_get_api_key_rights", mock.AsyncMock(return_value=[
+            trading_backend.enums.APIKeyRights.FUTURES_TRADING, trading_backend.enums.APIKeyRights.WITHDRAWALS
+        ])
+    ) as _get_api_key_rights_mock:
+        with mock.patch.object(exchange._exchange.connector.client, "sapi_get_apireferral_ifnewuser",
+                               mock.AsyncMock(return_value={"rebateWorking": True, "ifNewUser": True})) \
+                as sapi_get_apireferral_ifnewuser_mock:
+            with mock.patch.object(exchange, "_allow_withdrawal_right", mock.Mock(return_value=True)) as \
+                 _allow_withdrawal_right_mock:
+                assert (await exchange.is_valid_account()) == (True, None)
+                sapi_get_apireferral_ifnewuser_mock.assert_not_called()
+                _get_api_key_rights_mock.assert_called_once()
+                _allow_withdrawal_right_mock.assert_called_once()
+            with mock.patch.object(exchange, "_allow_withdrawal_right", mock.Mock(return_value=False)) as \
+                 _allow_withdrawal_right_mock:
+                with pytest.raises(trading_backend.errors.APIKeyPermissionsError):
+                    assert (await exchange.is_valid_account()) == (True, None)
+                _allow_withdrawal_right_mock.assert_called_once()
+    with mock.patch.object(
+        exchange, "_get_api_key_rights", mock.AsyncMock(return_value=[
+            trading_backend.enums.APIKeyRights.SPOT_TRADING, trading_backend.enums.APIKeyRights.WITHDRAWALS
+        ])
+    ) as _get_api_key_rights_mock:
+        with mock.patch.object(exchange._exchange.connector.client, "sapi_get_apireferral_ifnewuser",
+                               mock.AsyncMock(return_value={"rebateWorking": True, "ifNewUser": True})) \
+                as sapi_get_apireferral_ifnewuser_mock:
+            with mock.patch.object(exchange, "_allow_withdrawal_right", mock.Mock(return_value=True)) as \
+                 _allow_withdrawal_right_mock:
+                with pytest.raises(trading_backend.errors.APIKeyPermissionsError):
+                    # futures trading permissions are required
+                    assert (await exchange.is_valid_account()) == (True, None)
+                sapi_get_apireferral_ifnewuser_mock.assert_not_called()
+                _get_api_key_rights_mock.assert_called_once()
+                _allow_withdrawal_right_mock.assert_not_called()
+
+
 @pytest.mark.asyncio
 async def test_ensure_broker_status(binance_exchange):
     exchange = exchanges.Binance(binance_exchange)
diff --git a/tests/exchanges/test_exchange.py b/tests/exchanges/test_exchange.py
@@ -53,6 +53,12 @@ async def test_is_valid_account(default_exchange):
         with pytest.raises(trading_backend.errors.TimeSyncError):
             assert await exchange.is_valid_account() == (True, None)
         fetch_balance_mock.assert_called_once()
+    with (mock.patch.object(exchange, "_inner_is_valid_account",
+                           mock.AsyncMock(side_effect=trading_backend.errors.InvalidIdError))
+          as _inner_is_valid_account_mock):
+        with pytest.raises(trading_backend.errors.ExchangeAuthError):
+            assert await exchange.is_valid_account() == (True, None)
+        _inner_is_valid_account_mock.assert_called_once()
 
 
 @pytest.mark.asyncio
diff --git a/trading_backend/errors.py b/trading_backend/errors.py
@@ -25,3 +25,7 @@ class ExchangeAuthError(RuntimeError):
 
 class APIKeyPermissionsError(RuntimeError):
     pass
+
+
+class InvalidIdError(RuntimeError):
+    pass
diff --git a/trading_backend/exchanges/binance.py b/trading_backend/exchanges/binance.py
@@ -17,6 +17,7 @@
 import aiohttp.streams
 
 import trading_backend.exchanges as exchanges
+import trading_backend.errors
 import trading_backend.enums
 
 class Binance(exchanges.Exchange):
@@ -57,6 +58,9 @@ def get_orders_parameters(self, params=None) -> dict:
 
     async def _ensure_broker_status(self):
         try:
+            if self._exchange.exchange_manager.is_future:
+                # no way to check on futures accounts (raising AgentCode is not exist)
+                return f"Broker rebate can't be checked when trading futures."
             details = await self._get_account_referral_details()
             if not details.get("rebateWorking", False):
                 if (ref_id := details.get("referrerId", None)) and ref_id == self.LEGACY_REF_ID:
@@ -106,6 +110,9 @@ async def _get_api_key_rights(self) -> list[trading_backend.enums.APIKeyRights]:
     async def _inner_is_valid_account(self) -> (bool, str):
         details = None
         try:
+            if self._exchange.exchange_manager.is_future and not self._exchange.exchange_manager.is_sandboxed:
+                # no way to check on futures accounts (raising AgentCode is not exist)
+                return True, None
             details = await self._get_account_referral_details()
             if not details.get("rebateWorking", False):
                 ref_id = details.get("referrerId", None)
@@ -129,6 +136,13 @@ async def _inner_is_valid_account(self) -> (bool, str):
             raise
         except ValueError as err:
             raise ccxt.AuthenticationError(f"Invalid key format ({err})")
+        except ccxt.ExchangeError as err:
+            if "AgentCode is not exist" in str(err):
+                # err: BadRequest('binance {"code":-9000,"msg":"apiAgentCode is not exist"}')
+                raise trading_backend.errors.InvalidIdError(
+                    f"{self.__class__.__name__} Agent code error (configured local id) is invalid. Please update it ({err})"
+                )
+            raise err
         except AttributeError:
             if isinstance(details, aiohttp.streams.StreamReader):
                 return False, "Error when fetching exchange data (unreadable response)"
diff --git a/trading_backend/exchanges/exchange.py b/trading_backend/exchanges/exchange.py
@@ -153,6 +153,15 @@ async def is_valid_account(self, always_check_key_rights=False) -> (bool, str):
             raise trading_backend.errors.TimeSyncError(err)
         except ccxt.ExchangeError as err:
             raise trading_backend.errors.ExchangeAuthError(err)
+        except trading_backend.errors.InvalidIdError as err:
+            try:
+                import octobot_commons.logging as logging
+                logging.get_logger(self.__class__.__name__).error(
+                    f"{trading_backend.errors.InvalidIdError.__name__} when checking account validity: {err}"
+                )
+            except ImportError:
+                pass
+            raise trading_backend.errors.ExchangeAuthError(err)
 
     async def _inner_is_valid_account(self) -> (bool, str):
         # check account validity regarding exchange requirements, exchange specific
