Class RelayPool

Implements

IPool

Index

Constructors

Properties

blacklist groups$ options? relays$

Accessors

Methods

event filterBlacklist group publish relay remove req request subscription

Constructors

constructor

new RelayPool(options?: RelayOptions): RelayPool
Parameters
- Optionaloptions: RelayOptions
Returns RelayPool
- Defined in packages/relay/src/pool.ts:32

Properties

blacklist

blacklist: Set<string> = ...

An array of relays to never connect to

groups$

groups$: BehaviorSubject<Map<string, RelayGroup>> = ...

`Optional`options

options?: RelayOptions

relays$

relays$: BehaviorSubject<Map<string, Relay>> = ...

Accessors

groups

get groups(): Map<string, RelayGroup>
Returns Map<string, RelayGroup>
- Defined in packages/relay/src/pool.ts:20

relays

get relays(): Map<string, Relay>
Returns Map<string, Relay>
- Defined in packages/relay/src/pool.ts:25

Methods

event

event(relays: string[], event: Event): Observable<PublishResponse>
Send an EVENT message to multiple relays
Parameters
- relays: string[]
- event: Event
Returns Observable<PublishResponse>
Implementation of IPool.event
- Defined in packages/relay/src/pool.ts:95

`Protected`filterBlacklist

filterBlacklist(urls: string[]): string[]
Parameters
- urls: string[]
Returns string[]
- Defined in packages/relay/src/pool.ts:34

group

group(relays: string[]): RelayGroup
Create a group of relays
Parameters
- relays: string[]
Returns RelayGroup
Implementation of IPool.group
- Defined in packages/relay/src/pool.ts:58

publish

publish(
    relays: string[],
    event: Event,
    opts?: PublishOptions,
): Promise<PublishResponse[]>
Publish an event to multiple relays
Parameters
- relays: string[]
- event: Event
- Optionalopts: PublishOptions
Returns Promise<PublishResponse[]>
Implementation of IPool.publish
- Defined in packages/relay/src/pool.ts:100

relay

relay(url: string): Relay
Get or create a new relay connection
Parameters
- url: string
Returns Relay
Implementation of IPool.relay
- Defined in packages/relay/src/pool.ts:39

remove

remove(relay: string | IRelay, close?: boolean): void
Removes a relay from the pool and defaults to closing the connection
Parameters
- relay: string | IRelay
- close: boolean = true
Returns void
Implementation of IPool.remove
- Defined in packages/relay/src/pool.ts:75

req

req(
    relays: string[],
    filters: FilterInput,
    id?: string,
): Observable<SubscriptionResponse>
Make a REQ to multiple relays that does not deduplicate events
Parameters
- relays: string[]
- filters: FilterInput
- Optionalid: string
Returns Observable<SubscriptionResponse>
Implementation of IPool.req
- Defined in packages/relay/src/pool.ts:90

request

request(
    relays: string[],
    filters: FilterInput,
    opts?: SubscriptionOptions,
): Observable<Event>
Request events from multiple relays
Parameters
- relays: string[]
- filters: FilterInput
- Optionalopts: SubscriptionOptions
Returns Observable<Event>
Implementation of IPool.request
- Defined in packages/relay/src/pool.ts:105

subscription

subscription(
    relays: string[],
    filters: FilterInput,
    opts?: SubscriptionOptions,
): Observable<SubscriptionResponse>
Open a subscription to multiple relays
Parameters
- relays: string[]
- filters: FilterInput
- Optionalopts: SubscriptionOptions
Returns Observable<SubscriptionResponse>
Implementation of IPool.subscription
- Defined in packages/relay/src/pool.ts:110