Class NDKRelay

The NDKRelay class represents a connection to a relay.

Emits

NDKRelay#connect

Emits

NDKRelay#ready

Emits

NDKRelay#disconnect

Emits

NDKRelay#notice

Emits

NDKRelay#event

Emits

NDKRelay#published when an event is published to the relay

Emits

NDKRelay#publish:failed when an event fails to publish to the relay

Emits

NDKRelay#eose when the relay has reached the end of stored events

Emits

NDKRelay#auth when the relay requires authentication

Emits

NDKRelay#authed when the relay has authenticated

Emits

NDKRelay#delayed-connect when the relay will wait before reconnecting

Hierarchy

  • EventEmitter<{
        auth: ((challenge: string) => void);
        auth:failed: ((error: Error) => void);
        authed: (() => void);
        connect: (() => void);
        delayed-connect: ((delayInMs: number) => void);
        disconnect: (() => void);
        flapping: ((stats: NDKRelayConnectionStats) => void);
        notice: ((notice: string) => void);
        publish:failed: ((event: NDKEvent, error: Error) => void);
        published: ((event: NDKEvent) => void);
        ready: (() => void);
    }>
    • NDKRelay

Constructors

constructor

Properties

authPolicy? close complaining connectivity debug lowestValidationRatio? req scores targetValidationRatio? trusted url validationRatioFn?

Accessors

connected connectionStats status validationRatio

Methods

addNonValidatedEvent addValidatedEvent connect disconnect publish referenceTags shouldValidateEvent subscribe defaultValidationRatioUpdateFn

Constructors

constructor

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

  • Parameters

    Returns NDKRelay

Properties

OptionalauthPolicy

authPolicy?: NDKAuthPolicy

close

close: ((subId: string) => void)

complaining

complaining: boolean = false

connectivity

connectivity: NDKRelayConnectivity

Readonlydebug

debug: Debugger

OptionallowestValidationRatio

lowestValidationRatio?: number

The lowest validation ratio this relay can reach.

req

req: ((relaySub: NDKRelaySubscription) => void)

Readonlyscores

scores: Map<NDKUser, number>

OptionaltargetValidationRatio

targetValidationRatio?: number

Current validation ratio this relay is targeting.

trusted

trusted: boolean = false

Whether this relay is trusted.

Trusted relay's events do not get their signature verified.

Readonlyurl

url: string

OptionalvalidationRatioFn

validationRatioFn?: ((relay: NDKRelay, validatedCount: number, nonValidatedCount: number) => number)

Accessors

connected

connectionStats

status

validationRatio

  • get validationRatio(): number

  • The current validation ratio this relay has achieved.

    Returns number

Methods

addNonValidatedEvent

addValidatedEvent

connect

  • connect(timeoutMs?: number, reconnect?: boolean): Promise<void>

  • Connects to the relay.

    Parameters

    • OptionaltimeoutMs: number
    • reconnect: boolean = true

    Returns Promise<void>

disconnect

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

shouldValidateEvent

subscribe

StaticdefaultValidationRatioUpdateFn

  • defaultValidationRatioUpdateFn(relay: NDKRelay, validatedCount: number, nonValidatedCount: number): number

  • Parameters

    • relay: NDKRelay
    • validatedCount: number
    • nonValidatedCount: number

    Returns number

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods