feat: add signer_required to SilverbackBot

Author: lumoswiz

silverback/main.py

@@ -109,13 +109,15 @@ class SilverbackBot(ManagerAccessMixin):
         ...  # Connection has been initialized, can call broker methods e.g. `bot.on_(...)`
     """
 
-    def __init__(self, settings: Settings | None = None):
+    def __init__(self, settings: Settings | None = None, signer_required: bool = False):
         """
         Create bot
 
         Args:
             settings (~:class:`silverback.settings.Settings` | None): Settings override.
                 Defaults to environment settings.
+            signer_required (bool): If True, raise at startup when no signer is configured.
+                Defaults to False.
         """
         if not settings:
             settings = Settings()
@@ -153,7 +155,11 @@ def __init__(self, settings: Settings | None = None):
 
         atexit.register(provider_context.__exit__, None, None, None)
 
+        self.signer_required = signer_required
         self.signer = settings.get_signer()
+        if self.signer_required and not self.signer:
+            raise NoSignerLoaded()
+
         if self.signer:
             # NOTE: Monkeypatch `AccountAPI.call` to update bot nonce tracking state
             original_call = self.signer.call
@@ -437,7 +443,7 @@ def broker_task_decorator(
 
         # Register user function as task handler with our broker
         def add_taskiq_task(
-            handler: Callable[..., Any | Awaitable[Any]]
+            handler: Callable[..., Any | Awaitable[Any]],
         ) -> AsyncTaskiqDecoratedTask:
             labels: dict[str, str] = dict()
 

tests/conftest.py

@@ -1,3 +1,6 @@
+import contextlib
+from types import SimpleNamespace
+
 import pytest
 from click.testing import CliRunner
 
@@ -12,3 +15,53 @@ def runner():
 @pytest.fixture
 def cli():
     return root_cli
+
+
+class Settings:
+    def __init__(self, signer=None):
+        self._signer = signer
+        self.BOT_NAME = "bot"
+        self.NEW_BLOCK_TIMEOUT = None
+        self.FORK_MODE = False
+
+    def get_provider_context(self):
+        return contextlib.nullcontext(
+            SimpleNamespace(
+                network=SimpleNamespace(
+                    name="mainnet",
+                    ecosystem=SimpleNamespace(name="ethereum"),
+                ),
+                network_manager=SimpleNamespace(fork=contextlib.nullcontext()),
+            )
+        )
+
+    def get_broker(self):
+        def register_task(*_a, **_k):
+            return object()
+
+        def on_event(*_a, **_k):
+            def deco(fn):
+                return fn
+
+            return deco
+
+        return SimpleNamespace(register_task=register_task, on_event=on_event)
+
+    def get_signer(self):
+        return self._signer
+
+    def model_dump(self):
+        return {}
+
+
+@pytest.fixture
+def signer():
+    return SimpleNamespace(nonce=0, call=lambda txn, *a, **k: {"ok": True})
+
+
+@pytest.fixture
+def settings():
+    def _make(signer=None):
+        return Settings(signer=signer)
+
+    return _make

tests/test_bot_init.py

@@ -0,0 +1,22 @@
+import pytest
+
+from silverback import SilverbackBot
+from silverback.exceptions import NoSignerLoaded
+
+
+def test_signer_required_with_signer_available(settings, signer):
+    bot = SilverbackBot(settings=settings(signer), signer_required=True)
+    assert bot.signer_required is True
+    assert bot.signer is signer
+    assert hasattr(bot.signer, "call")
+
+
+def test_signer_required_raises_when_no_signer(settings):
+    with pytest.raises(NoSignerLoaded):
+        SilverbackBot(settings=settings(None), signer_required=True)
+
+
+def test_signer_not_required_default(settings):
+    bot = SilverbackBot(settings=settings(None))
+    assert bot.signer_required is False
+    assert bot.signer is None