Merge pull request #559 from bancorprotocol/module-bot-cleanup

Module bot cleanup

fastlane_bot/events/utils.py

@@ -991,7 +991,6 @@ def handle_subsequent_iterations(
     arb_mode: str,
     bot: CarbonBot,
     flashloan_tokens: List[str],
-    polling_interval: int,
     randomizer: int,
     run_data_validator: bool,
     target_tokens: List[str] = None,
@@ -1013,8 +1012,6 @@ def handle_subsequent_iterations(
         The bot object.
     flashloan_tokens : List[str]
         A list of flashloan tokens.
-    polling_interval : int
-        The polling interval.
     randomizer : int
         The randomizer.
     run_data_validator : bool
@@ -1059,7 +1056,6 @@ def handle_subsequent_iterations(
 
         # Run the bot
         bot.run(
-            polling_interval=polling_interval,
             flashloan_tokens=flashloan_tokens,
             arb_mode=arb_mode,
             run_data_validator=run_data_validator,
@@ -1802,32 +1798,6 @@ def handle_target_token_addresses(static_pool_data: pd.DataFrame, target_tokens:
     return target_token_addresses
 
 
-def handle_replay_from_block(replay_from_block: int) -> (int, int, bool):
-    """
-    Handle the replay from block flag.
-
-    Parameters
-    ----------
-    replay_from_block : int
-        The block number to replay from.
-
-    Returns
-    -------
-    polling_interval : int
-        The time interval at which the bot polls for new events.
-
-    """
-    if replay_from_block:
-        assert (
-            replay_from_block > 0
-        ), "The block number to replay from must be greater than 0."
-    reorg_delay = 0
-    use_cached_events = False
-    polling_interval = 0
-    return polling_interval, reorg_delay, use_cached_events
-
-
-# %%
 def get_current_block(
     last_block: int,
     mgr: Any,

fastlane_bot/helpers/__init__.py

@@ -14,3 +14,4 @@
 from .univ3calc import Univ3Calculator
 from .wrap_unwrap_processor import add_wrap_or_unwrap_trades_to_route
 from .carbon_trade_splitter import split_carbon_trades
+from .routehandler import maximize_last_trade_per_tkn

fastlane_bot/helpers/routehandler.py

@@ -68,19 +68,10 @@ class RouteStruct:
     customData: bytes
 
 
-def maximize_last_trade_per_tkn(route_struct: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
+def maximize_last_trade_per_tkn(route_struct: List[Dict[str, Any]]):
     """
     Sets the source amount of the last trade to 0 per-token, ensuring that all tokens held will be used in the last trade.
-
-    TODO: this function seems to be only used in this module and therefore should
-    be made a private function (_maximize_last_trade_per_tkn); I also would suggest
-    to move it to the TxRouteHandler class, either as static or class method.
-    
     :param route_struct: the route struct object
-
-    Returns:
-    List[RouteStruct] the route struct object with the sourceAmount adjusted to 0 for each last-trade per token.
-
     """
 
     tkns_traded = [route_struct[0]["sourceToken"]]
@@ -99,8 +90,6 @@ def maximize_last_trade_per_tkn(route_struct: List[Dict[str, Any]]) -> List[Dict
                 route_struct[idx].sourceAmount = 0
                 tkns_traded.append(trade.sourceToken)
 
-    return route_struct
-
 
 @dataclass
 class TxRouteHandler:

fastlane_bot/tests/test_039_TestMultiMode.py

@@ -179,14 +179,14 @@ def test_test_combos_and_tokens():
 
     # +
     arb_finder = bot._get_arb_finder("multi")
-    finder2 = arb_finder(
+    finder = arb_finder(
                 flashloan_tokens=flashloan_tokens,
                 CCm=CCm,
                 mode="bothin",
-                result=bot.AO_TOKENS,
+                result=arb_finder.AO_TOKENS,
                 ConfigObj=bot.ConfigObj,
             )
-    all_tokens, combos = finder2.find_arbitrage()
+    all_tokens, combos = finder.find_arbitrage()
 
     # subjected to the length of `TAX_TOKENS`    
     assert type(all_tokens) == set, f"[NBTest 039 TestMultiMode] all_tokens is wrong data type. Expected set, found: {type(all_tokens)}"
@@ -210,7 +210,7 @@ def test_test_expected_output():
                 flashloan_tokens=flashloan_tokens,
                 CCm=CCm,
                 mode="bothin",
-                result=bot.AO_CANDIDATES,
+                result=arb_finder.AO_CANDIDATES,
                 ConfigObj=bot.ConfigObj,
             )
 

fastlane_bot/tests/test_040_TestSingleMode.py

@@ -159,14 +159,14 @@ def test_test_tokens_and_combos():
 
     # +
     arb_finder = bot._get_arb_finder("single")
-    finder2 = arb_finder(
+    finder = arb_finder(
                 flashloan_tokens=flashloan_tokens,
                 CCm=CCm,
                 mode="bothin",
-                result=bot.AO_TOKENS,
+                result=arb_finder.AO_TOKENS,
                 ConfigObj=bot.ConfigObj,
             )
-    all_tokens, combos = finder2.find_arbitrage()
+    all_tokens, combos = finder.find_arbitrage()
 
     assert type(all_tokens) == set, f"[TestSingleMode] all_tokens is wrong data type. Expected set, found: {type(all_tokens)}"
     assert type(combos) == list, f"[TestSingleMode] combos is wrong data type. Expected list, found: {type(combos)}"
@@ -178,7 +178,7 @@ def test_test_tokens_and_combos():
                 flashloan_tokens=flashloan_tokens,
                 CCm=CCm,
                 mode="bothin",
-                result=bot.AO_CANDIDATES,
+                result=arb_finder.AO_CANDIDATES,
                 ConfigObj=bot.ConfigObj,
             )
     r = finder.find_arbitrage()

fastlane_bot/tests/test_042_TestBancorV3ModeTwoHop.py

@@ -13,11 +13,11 @@
 """
 from fastlane_bot import Bot, Config
 from fastlane_bot.bot import CarbonBot
+from fastlane_bot.helpers import TxRouteHandler
 from fastlane_bot.tools.cpc import ConstantProductCurve
 from fastlane_bot.tools.cpc import ConstantProductCurve as CPC
 from fastlane_bot.events.exchanges import UniswapV2, UniswapV3,  CarbonV1, BancorV3
 from fastlane_bot.events.interface import QueryInterface
-from fastlane_bot.helpers import TxRouteHandler
 from fastlane_bot.events.managers.manager import Manager
 from fastlane_bot.events.interface import QueryInterface
 from joblib import Parallel, delayed
@@ -192,7 +192,7 @@ def test_test_trade_merge():
     # Convert the trade instructions
     ordered_trade_instructions_objects = bot._convert_trade_instructions(
         ordered_scaled_dcts)
-    tx_route_handler = bot.TxRouteHandlerClass(
+    tx_route_handler = TxRouteHandler(
                 trade_instructions=ordered_trade_instructions_objects
             )
     agg_trade_instructions = (

fastlane_bot/tests/test_043_TestEmptyCarbonOrders.py

@@ -13,6 +13,7 @@
 """
 from fastlane_bot import Bot, Config
 from fastlane_bot.bot import CarbonBot
+from fastlane_bot.helpers import TxRouteHandler
 from fastlane_bot.tools.cpc import ConstantProductCurve as CPC
 from fastlane_bot.events.exchanges import UniswapV2, UniswapV3,  CarbonV1, BancorV3
 from fastlane_bot.events.interface import QueryInterface
@@ -217,7 +218,7 @@ def test_test_empty_carbon_orders_removed():
 
     ordered_trade_instructions_objects = bot._convert_trade_instructions(ordered_scaled_dcts, )
     # print(f"ordered_trade_instructions_objects: {ordered_trade_instructions_objects}")
-    tx_route_handler = bot.TxRouteHandlerClass(
+    tx_route_handler = TxRouteHandler(
                 trade_instructions=ordered_trade_instructions_objects
             )
     agg_trade_instructions = (

fastlane_bot/tests/test_045_Validator.py

@@ -143,7 +143,7 @@ def test_test_validator():
             flashloan_tokens=flashloan_tokens,
             CCm=CCm,
             mode="bothin",
-            result=bot.AO_CANDIDATES,
+            result=arb_finder.AO_CANDIDATES,
             ConfigObj=bot.ConfigObj,
         )
         r = finder.find_arbitrage()

fastlane_bot/tests/test_047_Randomizer.py

@@ -145,7 +145,7 @@ def test_test_randomizer():
                 flashloan_tokens=flashloan_tokens,
                 CCm=CCm,
                 mode="bothin",
-                result=bot.AO_CANDIDATES,
+                result=arb_finder.AO_CANDIDATES,
                 ConfigObj=bot.ConfigObj,
             )
     r = finder.find_arbitrage()
@@ -161,7 +161,6 @@ def test_test_randomizer():
     arb_opp_2 = bot.randomize(arb_opps=r, randomizer=1)
     arb_opp_3 = bot.randomize(arb_opps=r, randomizer=1)
     arb_opp_25 = bot.randomize(arb_opps=r, randomizer=1)
-    arb_opp_None = bot.randomize(arb_opps=None, randomizer=5)
 
     assert len(arb_opp_0) == 5, f"[NB047 Randomizer], expected 1 arb back from randomizer with length of 5, found length of {len(arb_opp_0)}"
     assert len(arb_opp_1) == 5, f"[NB047 Randomizer], expected 1 arb back from randomizer with length of 5, found length of {len(arb_opp_1)}"
@@ -176,16 +175,12 @@ def test_test_randomizer():
     assert isinstance(np.float64(arb_opp_3[0]), np.floating), f"[NB047 Randomizer], expected first value back from randomizer to be of type np.float64, found type {type(arb_opp_3[0])}"
     assert isinstance(np.float64(arb_opp_25[0]), np.floating), f"[NB047 Randomizer], expected first value back from randomizer to be of type np.float64, found type {type(arb_opp_25[0])}"
 
-    arb_opp_0[2]
-
     assert type(arb_opp_0[2])  == tuple, f"[NB047 Randomizer], expected third value back from randomizer to be of type list, found type {type(arb_opp_0[2])}"
     assert type(arb_opp_1[2])  == tuple, f"[NB047 Randomizer], expected third value back from randomizer to be of type list, found type {type(arb_opp_1[2])}"
     assert type(arb_opp_2[2])  == tuple, f"[NB047 Randomizer], expected third value back from randomizer to be of type list, found type {type(arb_opp_2[2])}"
     assert type(arb_opp_3[2])  == tuple, f"[NB047 Randomizer], expected third value back from randomizer to be of type list, found type {type(arb_opp_3[2])}"
     assert type(arb_opp_25[2]) == tuple, f"[NB047 Randomizer], expected third value back from randomizer to be of type list, found type {type(arb_opp_25[2])}"
 
-    assert arb_opp_None == None, f"[NB047 Randomizer], expected randomizer to return None when it receives None, but it returned {type(arb_opp_None)}"
-
 
 # ------------------------------------------------------------
 # Test      047

fastlane_bot/tests/test_050_TestBancorV2.py

@@ -13,6 +13,7 @@
 """
 from fastlane_bot import Bot, Config
 from fastlane_bot.bot import CarbonBot
+from fastlane_bot.helpers import TxRouteHandler
 from fastlane_bot.tools.cpc import ConstantProductCurve as CPC
 from fastlane_bot.events.exchanges import UniswapV2, UniswapV3,  CarbonV1, BancorV3
 from fastlane_bot.events.interface import QueryInterface
@@ -155,14 +156,14 @@ def test_test_combos_and_tokens():
 # ------------------------------------------------------------
 
     arb_finder = bot._get_arb_finder("multi")
-    finder2 = arb_finder(
+    finder = arb_finder(
                 flashloan_tokens=flashloan_tokens,
                 CCm=CCm,
                 mode="bothin",
-                result=bot.AO_TOKENS,
+                result=arb_finder.AO_TOKENS,
                 ConfigObj=bot.ConfigObj,
             )
-    all_tokens, combos = finder2.find_arbitrage()
+    all_tokens, combos = finder.find_arbitrage()
     assert type(all_tokens) == set, f"[NBTest_50_TestBancorV2] all_tokens is wrong data type. Expected set, found: {type(all_tokens)}"
     assert type(combos) == list, f"[NBTest_50_TestBancorV2] combos is wrong data type. Expected list, found: {type(combos)}"
     assert len(all_tokens) > 100, f"[NBTest_50_TestBancorV2] Using wrong dataset, expected at least 100 tokens, found {len(all_tokens)}"
@@ -184,7 +185,7 @@ def test_test_expected_output_bancorv2():
                 flashloan_tokens=flashloan_tokens,
                 CCm=CCm,
                 mode="bothin",
-                result=bot.AO_CANDIDATES,
+                result=arb_finder.AO_CANDIDATES,
                 ConfigObj=bot.ConfigObj,
             )
     r = finder.find_arbitrage()
@@ -207,7 +208,7 @@ def test_test_expected_output_bancorv2():
                 flashloan_tokens=flashloan_tokens,
                 CCm=CCm,
                 mode="bothin",
-                result=bot.AO_CANDIDATES,
+                result=arb_finder.AO_CANDIDATES,
                 ConfigObj=bot.ConfigObj,
             )
     r = finder.find_arbitrage()
@@ -250,7 +251,7 @@ def test_test_expected_output_bancorv2():
     )
 
     # Create the tx route handler
-    tx_route_handler = bot.TxRouteHandlerClass(
+    tx_route_handler = TxRouteHandler(
         trade_instructions=ordered_trade_instructions_objects
     )
 

fastlane_bot/tests/test_053_TknMaxTrade.py

@@ -15,7 +15,7 @@
 
 from fastlane_bot import Bot
 from fastlane_bot.events.exchanges import UniswapV2, UniswapV3, CarbonV1, BancorV3
-from fastlane_bot.helpers.routehandler import RouteStruct, maximize_last_trade_per_tkn
+from fastlane_bot.helpers import maximize_last_trade_per_tkn
 from fastlane_bot.tools.cpc import ConstantProductCurve as CPC
 
 print("{0.__name__} v{0.__VERSION__} ({0.__DATE__})".format(CPC))
@@ -39,34 +39,24 @@
 # Segment   Test_use_0_for_sourceAmount
 # ------------------------------------------------------------
 def test_maximize_last_trade_per_tkn():
-    route_struct_0 = [
-                            {"sourceAmount": 10, "sourceToken": "bob_tkn", "minReturn": 10, "targetToken": "fred_tkn"},
-                            {"sourceAmount": 10, "sourceToken": "bob_tkn", "minReturn": 10, "targetToken": "fred_tkn"},
-                            {"sourceAmount": 10, "sourceToken": "fred_tkn", "minReturn": 10, "targetToken": "grog_tkn"},
-                            {"sourceAmount": 10, "sourceToken": "fred_tkn", "minReturn": 10, "targetToken": "grog_tkn"},
-                            {"sourceAmount": 10, "sourceToken": "grog_tkn", "minReturn": 10, "targetToken": "bob_tkn"},
-                            {"sourceAmount": 10, "sourceToken": "grog_tkn", "minReturn": 10, "targetToken": "bob_tkn"},
-
-                    ]
-
-    source_token = route_struct_0[0]["sourceToken"]
-    maximize_test_result = maximize_last_trade_per_tkn(route_struct_0)
-
-    assert len(maximize_test_result) == len(route_struct_0)
-
-    for trade in maximize_test_result:
+    route_struct = [
+        {"sourceAmount": 10, "sourceToken": "bob_tkn", "minReturn": 10, "targetToken": "fred_tkn"},
+        {"sourceAmount": 10, "sourceToken": "bob_tkn", "minReturn": 10, "targetToken": "fred_tkn"},
+        {"sourceAmount": 10, "sourceToken": "fred_tkn", "minReturn": 10, "targetToken": "grog_tkn"},
+        {"sourceAmount": 10, "sourceToken": "fred_tkn", "minReturn": 10, "targetToken": "grog_tkn"},
+        {"sourceAmount": 10, "sourceToken": "grog_tkn", "minReturn": 10, "targetToken": "bob_tkn"},
+        {"sourceAmount": 10, "sourceToken": "grog_tkn", "minReturn": 10, "targetToken": "bob_tkn"},
+    ]
+
+    source_token = route_struct[0]["sourceToken"]
+    maximize_last_trade_per_tkn(route_struct)
+
+    for trade in route_struct:
         if trade["sourceToken"] == source_token:
             assert trade["sourceAmount"] > 0
-    assert maximize_test_result[0]["sourceAmount"] == 10
-    assert maximize_test_result[1]["sourceAmount"] == 10
-    assert maximize_test_result[2]["sourceAmount"] == 10
-    assert maximize_test_result[3]["sourceAmount"] == 0
-    assert maximize_test_result[4]["sourceAmount"] == 10
-    assert maximize_test_result[5]["sourceAmount"] == 0
-
-    # -
-
-
-
-
-
+    assert route_struct[0]["sourceAmount"] == 10
+    assert route_struct[1]["sourceAmount"] == 10
+    assert route_struct[2]["sourceAmount"] == 10
+    assert route_struct[3]["sourceAmount"] == 0
+    assert route_struct[4]["sourceAmount"] == 10
+    assert route_struct[5]["sourceAmount"] == 0

fastlane_bot/tests/test_060_TestRoutehandlerCarbonPrecision.py

@@ -25,10 +25,7 @@
 from fastlane_bot.events.exchanges import UniswapV2, UniswapV3, CarbonV1, BancorV3
 from fastlane_bot.events.interface import QueryInterface
 from fastlane_bot.events.managers.manager import Manager
-from fastlane_bot.helpers import (
-    TxRouteHandler,
-    TradeInstruction,
-)
+from fastlane_bot.helpers import TxRouteHandler, TradeInstruction
 from fastlane_bot.tools.cpc import ConstantProductCurve as CPC
 
 print("{0.__name__} v{0.__VERSION__} ({0.__DATE__})".format(CPC))
@@ -177,7 +174,7 @@ def test_test_precision_using_all_tokens_in_carbon():
                 flashloan_tokens=flashloan_tokens,
                 CCm=CCm,
                 mode="bothin",
-                result=bot.AO_CANDIDATES,
+                result=arb_finder.AO_CANDIDATES,
                 ConfigObj=bot.ConfigObj,
             )
     r = finder.find_arbitrage()
@@ -386,7 +383,7 @@ def calculate_trade_outputs(tx_route_handler: TxRouteHandler,
         )
 
         # Create the tx route handler
-        tx_route_handler = bot.TxRouteHandlerClass(
+        tx_route_handler = TxRouteHandler(
             trade_instructions=ordered_trade_instructions_objects
         )