Interface RelayStatus

Status information for a single relay

interface RelayStatus {
    authenticated: boolean;
    authenticatedAs: string | null;
    authenticatedPubkeys: string[];
    authentications: Record<string, RelayAuthState>;
    challenge: string | null;
    connected: boolean;
    ready: boolean;
    url: string;
}

Properties

authenticated: boolean

Authentication state (true = at least one pubkey successfully authenticated)

authenticatedAs: string | null

The pubkey of the authenticated user, or null if not authenticated

authenticatedPubkeys: string[]

The pubkeys that are currently authenticated on the connection

authentications: Record<string, RelayAuthState>

All AUTH attempts on the connection keyed by pubkey

challenge: string | null

The authentication challenge string from the relay, or null if not yet received

connected: boolean

WebSocket connection state (true = socket is open)

ready: boolean

Application-layer ready state (true = safe to use)

url: string

Relay URL