Interface PoolLivenessSource

A liveness source that can filter relay lists synchronously, required by the RelayPool liveness option

interface PoolLivenessSource {
    seen?: Set<string>;
    unhealthy$: Observable<string[]>;
    connectToPool?(pool: RelayPool): void;
    filter(relays: string[]): string[];
}

Hierarchy (View Summary)

RelayLivenessSource
- PoolLivenessSource

Index

Properties

seen? unhealthy$

Methods

connectToPool? filter

Properties

`Optional`seen

seen?: Set<string>

The relay hints encountered by consumers

unhealthy$

unhealthy$: Observable<string[]>

An observable of relays temporarily excluded from selection

Methods

`Optional`connectToPool

connectToPool?(pool: RelayPool): void
Starts tracking a pool's relays, called by RelayPool when the source is passed as an option
Parameters
- pool: RelayPool
Returns void
Inherited from RelayLivenessSource.connectToPool
- Defined in packages/relay/src/liveness.ts:17

filter

filter(relays: string[]): string[]
Removes relays this source currently excludes from a relay list
Parameters
- relays: string[]
Returns string[]
Overrides RelayLivenessSource.filter
- Defined in packages/relay/src/liveness.ts:23