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);
    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

Index

Constructors

constructor

new NDKRelay(url: string, authPolicy?: NDKAuthPolicy, ndk?: default): NDKRelay
Parameters
- url: string
- Optional authPolicy: NDKAuthPolicy
- Optional ndk: default
Returns NDKRelay
Overrides EventEmitter<{ connect: () => void; ready: () => void; /** * Emitted when the relay has reached the end of stored events. */ disconnect: () => void; flapping: (stats: NDKRelayConnectionStats) => void; notice: (notice: string) => void; auth: (challenge: string) => void; authed: () => void; published: (event: NDKEvent) => void; "publish:failed": (event: NDKEvent, error: Error) => void; "delayed-connect": (delayInMs: number) => void; }>.constructor
- Defined in ndk/src/relay/index.ts:113

Properties

`Optional` authPolicy

authPolicy?: NDKAuthPolicy

complaining

complaining: boolean = false

connectivity

connectivity: NDKRelayConnectivity

`Readonly` debug

debug: Debugger

`Readonly` scores

scores: Map<NDKUser, number>

trusted

trusted: boolean = false

Whether this relay is trusted.

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

`Readonly` url

url: string

`Optional` validationRatio

validationRatio?: number

Accessors

connectionStats

get connectionStats(): NDKRelayConnectionStats
Returns NDKRelayConnectionStats
- Defined in ndk/src/relay/index.ts:129

status

get status(): NDKRelayStatus
Returns NDKRelayStatus
- Defined in ndk/src/relay/index.ts:125

Methods

activeSubscriptions

activeSubscriptions(): Map<NDKFilter[], NDKSubscription[]>
Returns Map<NDKFilter[], NDKSubscription[]>
- Defined in ndk/src/relay/index.ts:201

addSkippedEvent

addSkippedEvent(): void
Returns void
- Defined in ndk/src/relay/index.ts:209

addValidatedEvent

addValidatedEvent(): void
Returns void
- Defined in ndk/src/relay/index.ts:205

connect

connect(timeoutMs?: number, reconnect?: boolean): Promise<void>
Connects to the relay.
Parameters
- Optional timeoutMs: number
- reconnect: boolean = true
Returns Promise<void>
- Defined in ndk/src/relay/index.ts:136

disconnect

disconnect(): void
Disconnects from the relay.

Returns void
- Defined in ndk/src/relay/index.ts:143

getValidationRatio

getValidationRatio(): number
Returns number
- Defined in ndk/src/relay/index.ts:213

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
- Defined in ndk/src/relay/index.ts:172

referenceTags

referenceTags(): NDKTag[]
Returns NDKTag[]
- Defined in ndk/src/relay/index.ts:197

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
- Defined in ndk/src/relay/index.ts:182

shouldValidateEvent

shouldValidateEvent(): boolean
Returns boolean
- Defined in ndk/src/relay/index.ts:221

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
- Defined in ndk/src/relay/index.ts:158

tagReference

tagReference(marker?: string): NDKTag
Parameters
- Optional marker: string
Returns NDKTag

Deprecated
Use referenceTags instead.
- Defined in ndk/src/relay/index.ts:187

Class NDKRelay

Emits

Emits

Emits

Emits

Emits

Emits

Emits

Emits

Emits

Emits

Emits

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

url: string

Optional authPolicy: NDKAuthPolicy

Optional ndk: default

Returns NDKRelay

Properties

Optional authPolicy

complaining

connectivity

Readonly debug

Readonly scores

trusted

Readonly url

Optional validationRatio

Accessors

connectionStats

Returns NDKRelayConnectionStats

status

Returns NDKRelayStatus

Methods

activeSubscriptions

Returns Map<NDKFilter[], NDKSubscription[]>

addSkippedEvent

Returns void

addValidatedEvent

Returns void

connect

Parameters

Optional timeoutMs: number

reconnect: boolean = true

Returns Promise<void>

disconnect

Returns void

getValidationRatio

Returns number

publish

Parameters

event: NDKEvent

timeoutMs: number = 2500

Returns Promise<boolean>

referenceTags

Returns NDKTag[]

scoreSlowerEvent

Parameters

timeDiffInMs: number

Returns void

shouldValidateEvent

Returns boolean

subscribe

Parameters

subscription: NDKSubscription

filters: NDKFilter[]

Returns void

tagReference

Parameters

Optional marker: string

Returns NDKTag

Deprecated

Settings

Member Visibility

`Optional` authPolicy: NDKAuthPolicy

`Optional` ndk: default

`Optional` authPolicy

`Readonly` debug

`Readonly` scores

`Readonly` url

`Optional` validationRatio

`Optional` timeoutMs: number

`Optional` marker: string