Class NDKRelaySet

constructor

• new NDKRelaySet(relays: Set<NDKRelay>, ndk: default): NDKRelaySet

• Parameters

  • relays: Set<NDKRelay>
  • ndk: default

  Returns NDKRelaySet

Readonlyrelays

relayUrls

• get relayUrls(): string[]

• Returns string[]

size

• get size(): number

• Returns number

addRelay

• addRelay(relay: NDKRelay): void

• Adds a relay to this set.

  Parameters

  • relay: NDKRelay

  Returns void

publish

• publish(event: NDKEvent, timeoutMs?: number, requiredRelayCount?: number): Promise<Set<NDKRelay>>

• Publish an event to all relays in this set. Returns the number of relays that have received the event.

  Parameters

  • event: NDKEvent
  • OptionaltimeoutMs: number

    timeout in milliseconds for each publish operation and connection operation
  • requiredRelayCount: number = 1

  Returns Promise<Set<NDKRelay>>

  A set where the event was successfully published to

  Throws

  NDKPublishError if no relay was able to receive the event

  Example

  const event = new NDKEvent(ndk, {kinds: [NDKKind.Message], "#d": ["123"]});
  try {
     const publishedToRelays = await relaySet.publish(event);
     console.log(`published to ${publishedToRelays.size} relays`)
  } catch (error) {
    console.error("error publishing to relays", error);
  
    if (error instanceof NDKPublishError) {
       for (const [relay, err] of error.errors) {
          console.error(`error publishing to relay ${relay.url}`, err);
        }
    }
  }
  Copy

StaticfromRelayUrls

• fromRelayUrls(relayUrls: string[], ndk: default, connect?: boolean): NDKRelaySet

• Creates a relay set from a list of relay URLs.

  If no connection to the relay is found in the pool it will temporarily connect to it.

  Parameters

  • relayUrls: string[]

    list of relay URLs to include in this set
  • ndk: default
  • connect: boolean = true

    whether to connect to the relay immediately if it was already in the pool but not connected

  Returns NDKRelaySet

  NDKRelaySet