Skip to content

maker.directory_pool

maker.directory_pool

Maker-specific :class:DirectoryClientPool subclass.

Layers maker-only construction details onto the shared pool:

  • location -- the bot's published onion host:port (or the protocol sentinel "NOT-SERVING-ONION" when the maker is not yet serving an onion). Directories use this as the maker's contact address for direct peer connections.
  • neutrino_compat -- whether the backend can answer neutrino-style queries, advertised to directories at handshake time.

Lifecycle hooks (starting listener tasks, announcing offers, emitting operator notifications) are intentionally NOT placed here -- they remain in :mod:maker.background_tasks where they have direct access to the bot's mutable state. This keeps the pool focused on connection plumbing and matches the taker's separation of concerns.

Classes

MakerDirectoryPool

Bases: DirectoryClientPool

Pool of directory clients for the maker bot.

Adds location and neutrino_compat to the per-connection DirectoryClient kwargs and otherwise defers to the base implementation.

Args: config: The :class:MakerConfig to read onion_host, onion_serving_port, socks_host, socks_port, connection_timeout, stream_isolation, and directory_servers from. nick_identity: Long-lived directory handshake identity. neutrino_compat: Advertised to directories; takers use this to route requests for neutrino-aware metadata.

Source code in maker/src/maker/directory_pool.py 
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
class MakerDirectoryPool(DirectoryClientPool):
    """
    Pool of directory clients for the maker bot.

    Adds ``location`` and ``neutrino_compat`` to the per-connection
    ``DirectoryClient`` kwargs and otherwise defers to the base
    implementation.

    Args:
        config: The :class:`MakerConfig` to read ``onion_host``,
            ``onion_serving_port``, ``socks_host``, ``socks_port``,
            ``connection_timeout``, ``stream_isolation``, and
            ``directory_servers`` from.
        nick_identity: Long-lived directory handshake identity.
        neutrino_compat: Advertised to directories; takers use this to
            route requests for neutrino-aware metadata.
    """

    def __init__(
        self,
        *,
        config: MakerConfig,
        nick_identity: Any,  # NickIdentity, kept Any to avoid import cycle
        neutrino_compat: bool,
        onion_host: str | None = None,
        onion_serving_port: int | None = None,
    ):
        self._config = config
        self._neutrino_compat = neutrino_compat
        self._onion_host = onion_host
        self._onion_serving_port = onion_serving_port
        self._dir_creds: tuple[str | None, str | None]
        super().__init__(
            directory_servers=list(config.directory_servers),
            network=config.network.value,
            nick_identity=nick_identity,
            socks_host=config.socks_host,
            socks_port=config.socks_port,
            connection_timeout=config.connection_timeout,
            stream_isolation=config.stream_isolation,
            nick_auth_mode=config.nick_auth_mode,
            nick_auth_directory_ids=config.nick_auth_directory_ids,
        )
        # Identity renewal requires a fresh Tor circuit even when general
        # component stream isolation is disabled. Keep credentials stable
        # within this pool, but unique across maker generations.
        directory_username = self._dir_creds[0] or "jm-maker-generation"
        self._dir_creds = (directory_username, secrets.token_hex(32))

    def _build_client_kwargs(self, host: str, port: int) -> dict[str, Any]:
        kwargs = super()._build_client_kwargs(host, port)
        onion_host = self._onion_host if self._onion_host is not None else self._config.onion_host
        if onion_host:
            port = self._onion_serving_port or self._config.onion_serving_port
            location = f"{onion_host}:{port}"
        else:
            location = "NOT-SERVING-ONION"
        kwargs["location"] = location
        kwargs["neutrino_compat"] = self._neutrino_compat
        kwargs["allow_clearnet_connections"] = self._config.allow_clearnet_connections
        return kwargs

    def refresh_neutrino_compat(self, neutrino_compat: bool) -> None:
        """
        Update the advertised neutrino capability for future connections.

        Existing clients are unaffected; the new value applies to any
        subsequent :meth:`connect_to_directory` /
        :meth:`reconnect_disconnected` call.
        """
        self._neutrino_compat = neutrino_compat
Methods:
__init__(*, config: MakerConfig, nick_identity: Any, neutrino_compat: bool, onion_host: str | None = None, onion_serving_port: int | None = None)
Source code in maker/src/maker/directory_pool.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def __init__(
    self,
    *,
    config: MakerConfig,
    nick_identity: Any,  # NickIdentity, kept Any to avoid import cycle
    neutrino_compat: bool,
    onion_host: str | None = None,
    onion_serving_port: int | None = None,
):
    self._config = config
    self._neutrino_compat = neutrino_compat
    self._onion_host = onion_host
    self._onion_serving_port = onion_serving_port
    self._dir_creds: tuple[str | None, str | None]
    super().__init__(
        directory_servers=list(config.directory_servers),
        network=config.network.value,
        nick_identity=nick_identity,
        socks_host=config.socks_host,
        socks_port=config.socks_port,
        connection_timeout=config.connection_timeout,
        stream_isolation=config.stream_isolation,
        nick_auth_mode=config.nick_auth_mode,
        nick_auth_directory_ids=config.nick_auth_directory_ids,
    )
    # Identity renewal requires a fresh Tor circuit even when general
    # component stream isolation is disabled. Keep credentials stable
    # within this pool, but unique across maker generations.
    directory_username = self._dir_creds[0] or "jm-maker-generation"
    self._dir_creds = (directory_username, secrets.token_hex(32))
refresh_neutrino_compat(neutrino_compat: bool) -> None

Update the advertised neutrino capability for future connections.

Existing clients are unaffected; the new value applies to any subsequent :meth:connect_to_directory / :meth:reconnect_disconnected call.

Source code in maker/src/maker/directory_pool.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
def refresh_neutrino_compat(self, neutrino_compat: bool) -> None:
    """
    Update the advertised neutrino capability for future connections.

    Existing clients are unaffected; the new value applies to any
    subsequent :meth:`connect_to_directory` /
    :meth:`reconnect_disconnected` call.
    """
    self._neutrino_compat = neutrino_compat