Type Alias RelayAuthContext

The context passed to a RelayAuthHandler when a relay signals that authentication is required for a specific operation (RAUTH-01)

type RelayAuthContext = {
    challenge: string | null;
    missingPubkeys: string[] | null;
    reason: string;
    relay: Relay;
    request: RelayAuthWireRequest;
    requirement: AuthRequirement;
    url: string;
}

Properties

challenge: string | null

The current NIP-42 AUTH challenge string, or null if none has been received yet

missingPubkeys: string[] | null

The pubkeys that are not yet authenticated for requirement, or null when requirement is true

reason: string

The machine-readable reason string reported by the relay

relay: Relay

The relay that requires authentication

The exact wire request the relay refused

The auth requirement configured for the operation that triggered this auth phase

url: string

The URL of the relay