Interface RelayPoolOutboxRouterOptions

Options for the relay-pool-backed outbox router.

interface RelayPoolOutboxRouterOptions {
    defaultTimeoutMs?: number;
    fallbackRelays: string[];
    relayPool: OutboxRelayPool;
    isRelayAllowed?(url: string): boolean;
    loadRelayLists(
        pubkeys: string[],
    ): Map<string, RelayListEntry> | Promise<Map<string, RelayListEntry>>;
    signEvent?(template: EventTemplate): Promise<NostrEvent>;
    verifyEvent?(event: NostrEvent): boolean | Promise<boolean>;
}

Index

Properties

defaultTimeoutMs? fallbackRelays relayPool

Methods

isRelayAllowed? loadRelayLists signEvent? verifyEvent?

Properties

`Optional`defaultTimeoutMs

defaultTimeoutMs?: number

Default bounded-query and initial-discovery timeout in milliseconds.

fallbackRelays

fallbackRelays: string[]

Relays used when hints and NIP-65 data are unavailable.

relayPool

relayPool: OutboxRelayPool

Relay pool the router subscribes and publishes through.

Methods

`Optional`isRelayAllowed

isRelayAllowed?(url: string): boolean
Gate every relay URL, including caller hints.
Parameters
- url: string
Returns boolean
- Defined in packages/services/src/relay-pool-outbox-types.ts:50

loadRelayLists

loadRelayLists(
pubkeys: string[],
): Map<string, RelayListEntry> | Promise<Map<string, RelayListEntry>>
Resolve NIP-65 relay lists for the requested pubkeys.
Parameters
- pubkeys: string[]
Returns Map<string, RelayListEntry> | Promise<Map<string, RelayListEntry>>
- Defined in packages/services/src/relay-pool-outbox-types.ts:42

`Optional`signEvent

signEvent?(template: EventTemplate): Promise<NostrEvent>
Sign a template before publish. Omission denies publishing.
Parameters
- template: EventTemplate
Returns Promise<NostrEvent>
- Defined in packages/services/src/relay-pool-outbox-types.ts:46

`Optional`verifyEvent

verifyEvent?(event: NostrEvent): boolean | Promise<boolean>
Validate an event before delivery. Host pools may pre-verify.
Parameters
- event: NostrEvent
Returns boolean | Promise<boolean>
- Defined in packages/services/src/relay-pool-outbox-types.ts:48