Class RelayGroup

Index

Constructors

Properties

relays$ status$

Accessors

Methods

add count event has internalPublish internalSubscription negentropy publish remove req request subscription sync completeAfterFirstRelay completeOnAll completeOnAllEose completeOnAny

Constructors

constructor

new RelayGroup(relays: GroupRelayInput): RelayGroup
Parameters
- relays: GroupRelayInput
Returns RelayGroup
- Defined in packages/relay/src/group.ts:72

Properties

`Protected`relays$

relays$: Observable<Relay[]> | BehaviorSubject<Relay[]> = ...

status$

status$: Observable<Record<string, RelayStatus>>

Observable of relay status for all relays in the group

Accessors

relays

get relays(): Relay[]
Returns Relay[]
- Defined in packages/relay/src/group.ts:67

Methods

add

add(relay: Relay): void
Add a relay to the group
Parameters
- relay: Relay
Returns void
- Defined in packages/relay/src/group.ts:114

count

count(
filters: Filter | Filter[],
id?: string,
): Observable<Record<string, RelayCountResponse>>
Count events on all relays in the group
Parameters
- filters: Filter | Filter[]
- id: string = ...
Returns Observable<Record<string, RelayCountResponse>>
- Defined in packages/relay/src/group.ts:284

event

event(event: NostrEvent): Observable<PublishResponse>
Send an event to all relays
Parameters
- event: NostrEvent
Returns Observable<PublishResponse>
- Defined in packages/relay/src/group.ts:203

has

has(relay: string | Relay): boolean
Check if a relay is in the group
Parameters
- relay: string | Relay
Returns boolean
- Defined in packages/relay/src/group.ts:106

`Protected`internalPublish

internalPublish(
project: (relay: Relay) => Observable<PublishResponse>,
): Observable<PublishResponse>
Internal logic for handling publishes to multiple relays
Parameters
- project: (relay: Relay) => Observable<PublishResponse>
Returns Observable<PublishResponse>
- Defined in packages/relay/src/group.ts:163

`Protected`internalSubscription

internalSubscription(
project: (relay: Relay) => Observable<RelayReqMessage>,
): Observable<GroupReqMessage>
Internal logic for handling requests to multiple relays
Parameters
- project: (relay: Relay) => Observable<RelayReqMessage>
Returns Observable<GroupReqMessage>
- Defined in packages/relay/src/group.ts:126

negentropy

negentropy(
    store: NegentropyReadStore,
    filter: Filter,
    reconcile: ReconcileFunction,
    opts?: GroupNegentropySyncOptions,
): Promise<boolean>
Negentropy sync events with the relays and an event store
Parameters
- store: NegentropyReadStore
- filter: Filter
- reconcile: ReconcileFunction
- Optionalopts: GroupNegentropySyncOptions
Returns Promise<boolean>
- Defined in packages/relay/src/group.ts:208

publish

publish(event: NostrEvent, opts?: PublishOptions): Promise<PublishResponse[]>
Publish an event to all relays with retries ( default 3 retries )
Parameters
- event: NostrEvent
- Optionalopts: PublishOptions
Returns Promise<PublishResponse[]>
- Defined in packages/relay/src/group.ts:229

remove

remove(relay: Relay): void
Remove a relay from the group
Parameters
- relay: Relay
Returns void
- Defined in packages/relay/src/group.ts:120

req

req(filters: FilterInput, opts?: RelayReqOptions): Observable<GroupReqMessage>
Send a REQ to all relays and returns all responses
Parameters
- filters: FilterInput
- Optionalopts: RelayReqOptions
Returns Observable<GroupReqMessage>
- Defined in packages/relay/src/group.ts:198

request

request(
filters: FilterInput,
opts?: GroupRequestOptions,
): Observable<NostrEvent>
Request events from all relays and complete based on condition
Parameters
- filters: FilterInput
- Optionalopts: GroupRequestOptions
Returns Observable<NostrEvent>
- Defined in packages/relay/src/group.ts:236

subscription

subscription(
filters: FilterInput,
opts?: GroupSubscriptionOptions,
): Observable<NostrEvent>
Open a subscription to all relays with retries ( default 3 retries )
Parameters
- filters: FilterInput
- Optionalopts: GroupSubscriptionOptions
Returns Observable<NostrEvent>
- Defined in packages/relay/src/group.ts:267

sync

sync(
    store: NostrEvent[] | NegentropySyncStore,
    filter: Filter,
    direction?: SyncDirection,
): Observable<NostrEvent>
Negentropy sync events with the relays and an event store
Parameters
- store: NostrEvent[] | NegentropySyncStore
- filter: Filter
- Optionaldirection: SyncDirection
Returns Observable<NostrEvent>
- Defined in packages/relay/src/group.ts:295

`Static`completeAfterFirstRelay

completeAfterFirstRelay(timeout?: number): GroupRequestCompleteOperator
Creates a complete condition that waits for the first EOSE message from a relay and then starts a timeout for the remaining relays
Parameters
- timeout: number = 5_000
  The timeout in milliseconds for the remaining relays
Returns GroupRequestCompleteOperator
- Defined in packages/relay/src/group.ts:316

`Static`completeOnAll

completeOnAll(
...conditions: GroupRequestCompleteOperator[],
): GroupRequestCompleteOperator
A group request complete condition that completes when any of the provided conditions are truthy (AND)
Parameters
- ...conditions: GroupRequestCompleteOperator[]
Returns GroupRequestCompleteOperator
- Defined in packages/relay/src/group.ts:351

`Static`completeOnAllEose

completeOnAllEose(): GroupRequestCompleteOperator
Creates a group request complete operator that waits for all relays to send an EOSE message or timeout

Returns GroupRequestCompleteOperator
- Defined in packages/relay/src/group.ts:330

`Static`completeOnAny

completeOnAny(
...conditions: GroupRequestCompleteOperator[],
): GroupRequestCompleteOperator
A group request complete condition that completes when any of the provided conditions are truthy (OR)
Parameters
- ...conditions: GroupRequestCompleteOperator[]
Returns GroupRequestCompleteOperator
- Defined in packages/relay/src/group.ts:343