Interface RelayStatus

Status information for a single relay

interface RelayStatus {
    authenticated: boolean;
    authenticatedAs: string | null;
    authRequiredForPublish: boolean;
    authRequiredForRead: boolean;
    connected: boolean;
    ready: boolean;
    url: string;
}

Properties

authenticated: boolean

Authentication state (true = successfully authenticated)

authenticatedAs: string | null

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

authRequiredForPublish: boolean

Whether authentication is required for publish operations (EVENT)

authRequiredForRead: boolean

Whether authentication is required for read operations (REQ/COUNT)

connected: boolean

WebSocket connection state (true = socket is open)

ready: boolean

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

url: string

Relay URL