Interface OutboxRouter

Abstract outbox router. Implementors own relay discovery (NIP-65 / NIP-66), routing, fallback, deduplication, signature validation, signing, and publish fanout. The service translates wire envelopes into these calls and back.

interface OutboxRouter {
    publish(
        template: EventTemplate,
        options?: OutboxPublishOptions,
    ): Promise<OutboxPublishResult>;
    query(
        filters: NostrFilter[],
        options?: OutboxQueryOptions,
    ): Promise<OutboxResult>;
    resolveRelays(target: OutboxTarget): Promise<OutboxRelayPlan>;
    subscribe(
        filters: NostrFilter[],
        options: OutboxSubscribeOptions | undefined,
        sink: OutboxSubscriptionSink,
    ): OutboxRouterSubscription;
}

Index

Methods

publish query resolveRelays subscribe

Methods

publish

publish(
template: EventTemplate,
options?: OutboxPublishOptions,
): Promise<OutboxPublishResult>
Sign template and fan it out to the relevant write/inbox relays.
Parameters
- template: EventTemplate
- Optionaloptions: OutboxPublishOptions
Returns Promise<OutboxPublishResult>
- Defined in packages/services/src/outbox-service.ts:158

query

query(
filters: NostrFilter[],
options?: OutboxQueryOptions,
): Promise<OutboxResult>
Resolve relays, query them, dedup by id, validate signatures, collect events.
Parameters
- filters: NostrFilter[]
- Optionaloptions: OutboxQueryOptions
Returns Promise<OutboxResult>
- Defined in packages/services/src/outbox-service.ts:150

resolveRelays

resolveRelays(target: OutboxTarget): Promise<OutboxRelayPlan>
Return the relay plan the shell would use for a read/write target.
Parameters
- target: OutboxTarget
Returns Promise<OutboxRelayPlan>
- Defined in packages/services/src/outbox-service.ts:160

subscribe(
    filters: NostrFilter[],
    options: OutboxSubscribeOptions | undefined,
    sink: OutboxSubscriptionSink,
): OutboxRouterSubscription
Open a live outbox-aware subscription, streaming through sink.
Parameters
- filters: NostrFilter[]
- options: OutboxSubscribeOptions | undefined
- sink: OutboxSubscriptionSink
Returns OutboxRouterSubscription
- Defined in packages/services/src/outbox-service.ts:152

Interface OutboxRouter

Index

Methods

Methods

publish

Parameters

Returns Promise<OutboxPublishResult>

query

Parameters

Returns Promise<OutboxResult>

resolveRelays

Parameters

Returns Promise<OutboxRelayPlan>

Parameters

Returns OutboxRouterSubscription

Settings

On This Page