Class NDKRelay

constructor

• new NDKRelay(url: string, authPolicy?: NDKAuthPolicy): NDKRelay

• Parameters

  • url: string

  • Optional authPolicy: NDKAuthPolicy

  Returns NDKRelay

Optional authPolicy

authRequired

complaining

connectivity

Readonly debug

Readonly scores

trusted

Readonly url

connectionStats

• get connectionStats(): NDKRelayConnectionStats

• Returns NDKRelayConnectionStats

status

• get status(): NDKRelayStatus

• Returns NDKRelayStatus

activeSubscriptions

• activeSubscriptions(): Map<NDKFilter[], NDKSubscription[]>

• Returns Map<NDKFilter[], NDKSubscription[]>

auth

• auth(event: NDKEvent): Promise<void>

• Parameters

  • event: NDKEvent

  Returns Promise<void>

connect

• connect(): Promise<void>

• Connects to the relay.

  Returns Promise<void>

disconnect

• disconnect(): void

• Disconnects from the relay.

  Returns void

publish

• publish(event: NDKEvent, timeoutMs?: number): Promise<boolean>

• Publishes an event to the relay with an optional timeout.

  If the relay is not connected, the event will be published when the relay connects, unless the timeout is reached before the relay connects.

  Parameters

  • event: NDKEvent

    The event to publish

  • timeoutMs: number = 2500

    The timeout for the publish operation in milliseconds

  Returns Promise<boolean>

  A promise that resolves when the event has been published or rejects if the operation times out

referenceTags

• referenceTags(): NDKTag[]

• Returns NDKTag[]

scoreSlowerEvent

• scoreSlowerEvent(timeDiffInMs: number): void

• Called when this relay has responded with an event but wasn't the fastest one.

  Parameters

  • timeDiffInMs: number

    The time difference in ms between the fastest and this relay in milliseconds

  Returns void

subscribe

• subscribe(subscription: NDKSubscription, filters: NDKFilter[]): void

• Queues or executes the subscription of a specific set of filters within this relay.

  Parameters

  • subscription: NDKSubscription

    NDKSubscription this filters belong to.

  • filters: NDKFilter[]

    Filters to execute

  Returns void

tagReference

• tagReference(marker?: string): NDKTag

• Parameters

  • Optional marker: string

  Returns NDKTag

  Deprecated

  Use referenceTags instead.