Interface RelayPoolOutboxRouterOptions

Options for createRelayPoolOutboxRouter.

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 query timeout when options.timeoutMs is unset. Default 4000ms.

fallbackRelays

fallbackRelays: string[]

Relays to fall back to when NIP-65 data is absent, stale, or empty. Required.

relayPool

relayPool: OutboxRelayPool

Relay pool the router subscribes/publishes through. Required.

Methods

`Optional`isRelayAllowed

isRelayAllowed?(url: string): boolean
Gate relay URLs (e.g. block private-network hosts). Defaults to allowing only ws:// / wss:// URLs — options.relays hints pass through this too.
Parameters
- url: string
Returns boolean
- Defined in packages/services/src/relay-pool-outbox-router.ts:125

loadRelayLists

loadRelayLists(
pubkeys: string[],
): Map<string, RelayListEntry> | Promise<Map<string, RelayListEntry>>
Resolve NIP-65 relay lists for a set of pubkeys. Pubkeys with no known list are simply omitted from the returned map (they become missingAuthors).
Parameters
- pubkeys: string[]
Returns Map<string, RelayListEntry> | Promise<Map<string, RelayListEntry>>
- Defined in packages/services/src/relay-pool-outbox-router.ts:108

`Optional`signEvent

signEvent?(template: EventTemplate): Promise<NostrEvent>
Sign a template before publish (shell-mediated; napplets never sign). When omitted, publish resolves with { ok: false, error: 'publish denied' }.
Parameters
- template: EventTemplate
Returns Promise<NostrEvent>
- Defined in packages/services/src/relay-pool-outbox-router.ts:115

`Optional`verifyEvent

verifyEvent?(event: NostrEvent): boolean | Promise<boolean>
Validate an event signature before delivering it to a napplet. May be sync or async. Defaults to accepting every event (host pools often pre-verify).
Parameters
- event: NostrEvent
Returns boolean | Promise<boolean>
- Defined in packages/services/src/relay-pool-outbox-router.ts:120