scout margin formula

.user.cfg.example

@@ -5,7 +5,9 @@ current_coin=
 bridge=USDT
 tld=com
 hourToKeepScoutHistory=1
+use_margin=no
 scout_multiplier=5
+scout_margin=0.8
 scout_sleep_time=1
 strategy=default
 enable_paper_trading=False

README.md

@@ -55,7 +55,9 @@ Create a .cfg file named `user.cfg` based off `.user.cfg.example`, then add your
 -   **bridge** - Your bridge currency of choice. Notice that different bridges will allow different sets of supported coins. For example, there may be a Binance particular-coin/USDT pair but no particular-coin/BUSD pair.
 -   **tld** - 'com' or 'us', depending on your region. Default is 'com'.
 -   **hourToKeepScoutHistory** - Controls how many hours of scouting values are kept in the database. After the amount of time specified has passed, the information will be deleted.
+-   **use_margin** - 'yes' to use `scout_margin`. 'no' to use `scout_multiplier`.
 -   **scout_multiplier** - Controls the value by which the difference between the current state of coin ratios and previous state of ratios is multiplied. For bigger values, the bot will wait for bigger margins to arrive before making a trade.
+-   **scout_margin** - Minimum percentage coin gain per trade. 0.8 translates to a scout multiplier of 5 at 0.1% fee.
 -   **strategy** - The trading strategy to use. See [`binance_trade_bot/strategies`](binance_trade_bot/strategies/README.md) for more information
 -   **scout_sleep_time** - Controls how many seconds bot should wait between analysis of current prices. Since the bot now operates on websockets this value should be set to something low (like 1), the reasons to set it above 1 are when you observe high CPU usage by bot or you got api errors about requests weight limit.
 -   **enable_paper_trading** - (`True` or `False` default `False`) run bot with virtual wallet to check its performance without risking any money.

binance_trade_bot/auto_trader.py

@@ -233,13 +233,18 @@ def _get_ratios(
             # Obtain (current coin)/(optional coin)
             coin_opt_coin_ratio = coin_sell_price / optional_coin_buy_price
 
-            transaction_fee = self.manager.get_fee(coin.symbol, self.config.BRIDGE.symbol, True) + self.manager.get_fee(
-                to_coin.symbol, self.config.BRIDGE.symbol, False
-            )
+            from_fee = self.manager.get_fee(coin.symbol, self.config.BRIDGE.symbol, True)
+            to_fee = self.manager.get_fee(to_coin.symbol, self.config.BRIDGE.symbol, False)
+            transaction_fee = from_fee + to_fee - from_fee * to_fee
 
-            ratio_dict[(coin.idx, to_coin.idx)] = (
-                coin_opt_coin_ratio - transaction_fee * self.config.SCOUT_MULTIPLIER * coin_opt_coin_ratio
-            ) - ratio
+            if self.config.USE_MARGIN == "yes":
+                ratio_dict[(coin.idx, to_coin.idx)] = (
+                    (1 - transaction_fee) * coin_opt_coin_ratio / ratio - 1 - self.config.SCOUT_MARGIN / 100
+                )
+            else:
+                ratio_dict[(coin.idx, to_coin.idx)] = (
+                    coin_opt_coin_ratio - transaction_fee * self.config.SCOUT_MULTIPLIER * coin_opt_coin_ratio
+                ) - ratio
 
         if len(scout_logs) > 0:
             self.db.batch_log_scout(scout_logs)

binance_trade_bot/config.py

@@ -13,7 +13,9 @@ def __init__(self):
         config = configparser.ConfigParser()
         config["DEFAULT"] = {
             "bridge": "USDT",
+            "use_margin": "no",
             "scout_multiplier": "5",
+            "scout_margin": "0.8",
             "scout_sleep_time": "1",
             "hourToKeepScoutHistory": "1",
             "tld": "com",
@@ -43,6 +45,10 @@ def __init__(self):
             os.environ.get("SCOUT_SLEEP_TIME") or config.get(USER_CFG_SECTION, "scout_sleep_time")
         )
 
+        self.USE_MARGIN = os.environ.get("USE_MARGIN") or config.get(USER_CFG_SECTION, "use_margin")
+        self.SCOUT_MARGIN = os.environ.get("SCOUT_MARGIN") or config.get(USER_CFG_SECTION, "scout_margin")
+        self.SCOUT_MARGIN = float(self.SCOUT_MARGIN)
+
         # Get config for binance
         self.BINANCE_API_KEY = os.environ.get("API_KEY") or config.get(USER_CFG_SECTION, "api_key")
         self.BINANCE_API_SECRET_KEY = os.environ.get("API_SECRET_KEY") or config.get(USER_CFG_SECTION, "api_secret_key")