Skip to content

utils

utils

Validator service utility functions.

Classes

Functions

validate_candidate async 

validate_candidate(
    relay: Relay,
    proxy_url: str | None,
    probe_timeout: float,
    *,
    allow_insecure: bool = False,
) -> bool

Validate a relay candidate via WebSocket Nostr protocol probe.

Delegates to is_nostr_relay. The caller is responsible for acquiring the per-network semaphore.

Parameters:

  • relay (Relay) –

    The Relay to probe.

  • proxy_url (str | None) –

    Optional SOCKS5 proxy for overlay networks.

  • probe_timeout (float) –

    WebSocket probe timeout in seconds.

  • allow_insecure (bool, default: False ) –

    Fall back to insecure transport on SSL failure.

Returns:

  • bool –

    True if the relay speaks Nostr protocol, False otherwise.

Source code in src/bigbrotr/services/validator/utils.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
async def validate_candidate(
    relay: Relay,
    proxy_url: str | None,
    probe_timeout: float,
    *,
    allow_insecure: bool = False,
) -> bool:
    """Validate a relay candidate via WebSocket Nostr protocol probe.

    Delegates to [is_nostr_relay][bigbrotr.utils.protocol.is_nostr_relay].
    The caller is responsible for acquiring the per-network semaphore.

    Args:
        relay: The [Relay][bigbrotr.models.relay.Relay] to probe.
        proxy_url: Optional SOCKS5 proxy for overlay networks.
        probe_timeout: WebSocket probe timeout in seconds.
        allow_insecure: Fall back to insecure transport on SSL failure.

    Returns:
        ``True`` if the relay speaks Nostr protocol, ``False`` otherwise.
    """
    try:
        return await is_nostr_relay(relay, proxy_url, probe_timeout, allow_insecure=allow_insecure)
    except (TimeoutError, OSError):
        return False