Interface OutboxRelayPool

Relay pool contract the router drives. Implementors adapt their pool library while the router retains relay selection and event attribution.

interface OutboxRelayPool {
    isAvailable(): boolean;
    publish(
        event: NostrEvent,
        relayUrls: string[],
    ): void | Record<string, boolean> | Promise<Record<string, boolean>>;
    subscribe(
        filters: NostrFilter[],
        relayUrls: string[],
        callback: (item: NostrEvent | "EOSE") => void,
    ): { unsubscribe(): void };
}

Index

Methods

isAvailable publish subscribe

Methods

isAvailable

isAvailable(): boolean
Whether the relay pool can handle requests.

Returns boolean
- Defined in packages/services/src/relay-pool-outbox-types.ts:34

publish

publish(
event: NostrEvent,
relayUrls: string[],
): void | Record<string, boolean> | Promise<Record<string, boolean>>
Publish event to relayUrls, optionally returning per-relay outcomes.
Parameters
- event: NostrEvent
- relayUrls: string[]
Returns void | Record<string, boolean> | Promise<Record<string, boolean>>
- Defined in packages/services/src/relay-pool-outbox-types.ts:29

subscribe(
    filters: NostrFilter[],
    relayUrls: string[],
    callback: (item: NostrEvent | "EOSE") => void,
): { unsubscribe(): void }
Subscribe to filters on exactly relayUrls.
Parameters
- filters: NostrFilter[]
- relayUrls: string[]
- callback: (item: NostrEvent | "EOSE") => void
Returns { unsubscribe(): void }
- Defined in packages/services/src/relay-pool-outbox-types.ts:23

Interface OutboxRelayPool

Index

Methods

Methods

isAvailable

Returns boolean

publish

Parameters

Returns void | Record<string, boolean> | Promise<Record<string, boolean>>

Parameters

Returns { unsubscribe(): void }

Settings

On This Page