Interface SystemInterface

checkSigs

Sockets

• get Sockets(): ConnectionStateSnapshot[]

• Get a snapshot of the relay connections

  Returns ConnectionStateSnapshot[]

eventsCache

• get eventsCache(): FeedCache<NostrEvent>

• Generic cache store for events

  Returns FeedCache<NostrEvent>

optimizer

• get optimizer(): Optimizer

• Query optimizer

  Returns Optimizer

pool

• get pool(): ConnectionPool

• Main connection pool

  Returns ConnectionPool

profileLoader

• get profileLoader(): ProfileLoaderService

• Profile cache/loader

  Returns ProfileLoaderService

relayCache

• get relayCache(): RelayCache

• Relay cache for "Gossip" model

  Returns RelayCache

relayLoader

• get relayLoader(): RelayMetadataLoader

• Relay loader loads relay metadata for a set of profiles

  Returns RelayMetadataLoader

BroadcastEvent

• BroadcastEvent(ev, cb?): Promise<OkResponse[]>

• Send an event to all permanent connections

  Parameters

  • ev: NostrEvent

    Event to broadcast

  • Optional cb: ((rsp) => void)

    Callback to handle OkResponse as they arrive

    • • (rsp): void

      • Parameters

        • rsp: OkResponse

        Returns void

  Returns Promise<OkResponse[]>

ConnectToRelay

• ConnectToRelay(address, options): Promise<void>

• Create a new permanent connection to a relay

  Parameters

  • address: string

    Relay URL

  • options: RelaySettings

    Read/Write settings

  Returns Promise<void>

DisconnectRelay

• DisconnectRelay(address): void

• Disconnect permanent relay connection

  Parameters

  • address: string

    Relay URL

  Returns void

Fetch

• Fetch(req, cb?): Promise<TaggedNostrEvent[]>

• Fetch data from nostr relays asynchronously

  Parameters

  • req: RequestBuilder

    Request to send to relays

  • Optional cb: ((evs) => void)

    A callback which will fire every 100ms when new data is received

    • • (evs): void

      • Parameters

        • evs: TaggedNostrEvent[]

        Returns void

  Returns Promise<TaggedNostrEvent[]>

GetQuery

• GetQuery(id): undefined | QueryLike

• Get an active query by ID

  Parameters

  • id: string

    Query ID

  Returns undefined | QueryLike

HandleEvent

• HandleEvent(ev): void

• Push an event into the system from external source

  Parameters

  • ev: TaggedNostrEvent

  Returns void

Init

• Init(): Promise<void>

• Do some initialization

  Returns Promise<void>

Query

• Query(req): QueryLike

• Open a new query to relays

  Parameters

  • req: RequestBuilder

    Request to send to relays

  Returns QueryLike

WriteOnceToRelay

• WriteOnceToRelay(relay, ev): Promise<OkResponse>

• Connect to a specific relay and send an event and wait for the response

  Parameters

  • relay: string

    Relay URL

  • ev: NostrEvent

    Event to send

  Returns Promise<OkResponse>