Class RelayLiveness

constructor

• new RelayLiveness(options?: LivenessOptions): RelayLiveness

  Create a new RelayLiveness instance

  Parameters

  • options: LivenessOptions = {}

    Configuration options for the liveness tracker

  Returns RelayLiveness

  Throws

  if an option is outside its supported range

dead$

healthy$

offline$

online$

Readonlyseen

Optional Readonlystorage

unhealthy$

dead

• get dead(): string[]

  Relays that are known to be dead

  Returns string[]

healthy

• get healthy(): string[]

  Relays that are online or not in backoff

  Returns string[]

offline

• get offline(): string[]

  Relays that are known to be offline

  Returns string[]

online

• get online(): string[]

  Relays that are known to be online

  Returns string[]

unhealthy

• get unhealthy(): string[]

  Relays that are dead or in backoff

  Returns string[]

connectToPool

• connectToPool(pool: RelayPool): void

  Connect to a RelayPool instance and track relay connections

  Parameters

  • pool: RelayPool

  Returns void

destroy

• destroy(): void

  Disconnects pools and removes browser listeners and retry timers

  Returns void

disconnectFromPool

• disconnectFromPool(pool: RelayPool): void

  Disconnect from a RelayPool instance

  Parameters

  • pool: RelayPool

  Returns void

filter

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

  Filter relay list, removing dead relays and relays in backoff

  Parameters

  • relays: string[]

  Returns string[]

getBackoffRemaining

• getBackoffRemaining(relay: string): number

  Get remaining backoff time for a relay (in ms)

  Parameters

  • relay: string

  Returns number

getSeenRelays

• getSeenRelays(): string[]

  Get all seen relays (for debugging/monitoring)

  Returns string[]

getState

• getState(relay: string): RelayState | undefined

  Get current relay health state for a relay

  Parameters

  • relay: string

  Returns RelayState | undefined

isInBackoff

• isInBackoff(relay: string): boolean

  Check if a relay is currently in backoff period

  Parameters

  • relay: string

  Returns boolean

load

• load(): Promise<void>

  Load relay states from storage

  Returns Promise<void>

recordFailure

• recordFailure(relay: string): void

  Record a failed connection

  Parameters

  • relay: string

    The relay URL that failed

  Returns void

recordRequestFailure

• recordRequestFailure(relay: string, error: unknown, startedAt?: number): void

  Records transport failures from requests while ignoring policy errors and ambiguous deadlines

  Parameters

  • relay: string
  • error: unknown
  • OptionalstartedAt: number

  Returns void

recordSuccess

• recordSuccess(relay: string): void

  Record a successful connection

  Parameters

  • relay: string

    The relay URL that succeeded

  Returns void

reset

• reset(relay?: string): void

  Reset state for one or all relays

  Parameters

  • Optionalrelay: string

    Optional specific relay URL to reset, or reset all if not provided

  Returns void

revive

• revive(relay: string): void

  Revive a dead relay with the max backoff delay

  Parameters

  • relay: string

  Returns void

save

• save(): Promise<void>

  Save all known relays and their states to storage

  Returns Promise<void>

setNetworkAvailable

• setNetworkAvailable(available: boolean): void

  Sets client connectivity from a platform network signal

  Parameters

  • available: boolean

  Returns void

state

• state(relay: string): Observable<RelayState | undefined>

  Subscribe to a relays state

  Parameters

  • relay: string

  Returns Observable<RelayState | undefined>