Class RelayPool

constructor

• new RelayPool(options?: RelayPoolOptions): RelayPool

  Parameters

  • Optionaloptions: RelayPoolOptions

  Returns RelayPool

add$

added$

Readonlyliveness

Optionaloptions

relays$

remove$

removed$

status$

relays

• get relays(): Map<string, Relay>

  Returns Map<string, Relay>

close

• close(): void

  Closes and removes every relay in the pool, tearing down all of their connections and timers

  Returns void

count

• count(
      relays: PoolRelayInput,
      filters: Filter | Filter[],
      id?: string,
      opts?: RelayCountOptions,
  ): Observable<RelayCountOutcomes>

  Count events on multiple relays

  Parameters

  • relays: PoolRelayInput
  • filters: Filter | Filter[]
  • Optionalid: string
  • Optionalopts: RelayCountOptions

  Returns Observable<RelayCountOutcomes>

event

• event(relays: PoolRelayInput, event: NostrEvent): Observable<PublishResponse>

  Send an EVENT message to multiple relays

  Parameters

  • relays: PoolRelayInput
  • event: NostrEvent

  Returns Observable<PublishResponse>

filterRelays

• filterRelays(relays: string[]): string[]

  Removes relays that any liveness source currently considers unhealthy

  Parameters

  • relays: string[]

  Returns string[]

group

• group(relays: PoolRelayInput): RelayGroup

  Create a group of relays, skipping relays the liveness sources currently consider unhealthy

  Parameters

  • relays: PoolRelayInput

  Returns RelayGroup

outboxSubscription

• outboxSubscription(
      outboxes: OutboxMap | Observable<OutboxMap>,
      filter: Omit<Filter, "authors">,
      options?: GroupSubscriptionOptions,
  ): Observable<NostrEvent>

  Open a subscription for an OutboxMap and filter

  Parameters

  • outboxes: OutboxMap | Observable<OutboxMap>
  • filter: Omit<Filter, "authors">
  • Optionaloptions: GroupSubscriptionOptions

  Returns Observable<NostrEvent>

publish

• publish(
      relays: PoolRelayInput,
      event: NostrEvent,
      opts?: PublishOptions,
  ): Promise<PublishResponse[]>

  Publish an event to multiple relays

  Parameters

  • relays: PoolRelayInput
  • event: NostrEvent
  • Optionalopts: PublishOptions

  Returns Promise<PublishResponse[]>

relay

• relay(url: string): Relay

  Get or create a new relay connection

  Parameters

  • url: string

  Returns Relay

remove

• remove(relay: string | Relay, close?: boolean): void

  Removes a relay from the pool and defaults to closing the connection

  Parameters

  • relay: string | Relay
  • close: boolean = true

  Returns void

req

• req(
      relays: PoolRelayInput,
      filters: FilterInput,
      opts?: RelayReqOptions,
  ): Observable<GroupReqMessage>

  Make a REQ to multiple relays that does not deduplicate events

  Parameters

  • relays: PoolRelayInput
  • filters: FilterInput
  • Optionalopts: RelayReqOptions

  Returns Observable<GroupReqMessage>

request

• request(
      relays: PoolRelayInput,
      filters: FilterInput,
      opts?: GroupRequestOptions,
  ): Observable<NostrEvent>

  Request events from multiple relays

  Parameters

  • relays: PoolRelayInput
  • filters: FilterInput
  • Optionalopts: GroupRequestOptions

  Returns Observable<NostrEvent>

subscription

• subscription(
      relays: PoolRelayInput,
      filters: FilterInput,
      options?: GroupSubscriptionOptions,
  ): Observable<NostrEvent>

  Open a subscription to multiple relays

  Parameters

  • relays: PoolRelayInput
  • filters: FilterInput
  • Optionaloptions: GroupSubscriptionOptions

  Returns Observable<NostrEvent>

subscriptionMap

• subscriptionMap(
      relays: FilterMap | Observable<FilterMap>,
      options?: GroupSubscriptionOptions,
  ): Observable<NostrEvent>

  Open a subscription for a map of relays and filters

  Parameters

  • relays: FilterMap | Observable<FilterMap>
  • Optionaloptions: GroupSubscriptionOptions

  Returns Observable<NostrEvent>

sync

• sync(
      relays: PoolRelayInput,
      store: NostrEvent[] | NegentropySyncStore,
      filter: Filter,
      direction?: SyncDirection,
      opts?: RelaySyncOptions,
  ): Observable<GroupSyncMessage>

  Negentropy sync events with the relays and an event store

  Parameters

  • relays: PoolRelayInput
  • store: NostrEvent[] | NegentropySyncStore
  • filter: Filter
  • Optionaldirection: SyncDirection
  • Optionalopts: RelaySyncOptions

  Returns Observable<GroupSyncMessage>