Applesauce
    Preparing search index...

    Type Alias SyncAuthContext

    The context passed to a SyncAuthHandler when a relay signals that authentication is required. This structurally matches applesauce-relay's RelayAuthContext (RAUTH-01), narrowed to the fields a sync-loader-level handler actually needs. One-way assignability: a handler written against this type accepts a real Relay for relay (a Relay satisfies SyncAuthRelay), but a handler written against applesauce-relay's full RelayAuthContext is NOT assignable to a SyncAuthHandler — RelayAuthContext.relay is a concrete Relay, which is not assignable backwards to the narrower SyncAuthRelay some other caller of that wider handler type might expect.

    type SyncAuthContext = {
        challenge: string | null;
        missingPubkeys: string[] | null;
        reason: string;
        relay: SyncAuthRelay;
        requirement: SyncAuthRequirement;
        url: string;
    }
    Index
    challenge missingPubkeys reason relay requirement url
    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: SyncAuthRelay

    The relay that requires authentication

    requirement: SyncAuthRequirement

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

    url: string

    The URL of the relay

    Settings
    Member Visibility

    On This Page
    Properties