Class NostrSystem

Manages nostr content retrieval system

Hierarchy

EventEmitter<NostrSystemEvents>
- NostrSystem

Implements

SystemInterface

Constructors

constructor

new NostrSystem(props): NostrSystem
Parameters
- props: NostrsystemProps
Returns NostrSystem
Overrides EventEmitter<NostrSystemEvents>.constructor
- Defined in packages/system/src/nostr-system.ts:92

Properties

`Private` #log

#log: Debugger = ...

`Private` #queryManager

#queryManager: QueryManager

checkSigs

checkSigs: boolean

Check event signatures (reccomended)

`Readonly` eventsCache

eventsCache: FeedCache<NostrEvent>

`Readonly` optimizer

optimizer: Optimizer

Optimizer instance, contains optimized functions for processing data

`Readonly` pool

pool: ConnectionPool

`Readonly` profileCache

profileCache: FeedCache<CachedMetadata>

Storage class for user profiles

`Readonly` profileLoader

profileLoader: ProfileLoaderService

Profile loading service

`Readonly` relayCache

relayCache: FeedCache<UsersRelays>

Storage class for user relay lists

`Readonly` relayLoader

relayLoader: RelayMetadataLoader

`Readonly` relayMetricsCache

relayMetricsCache: FeedCache<RelayMetrics>

Storage class for relay metrics (connects/disconnects)

`Readonly` relayMetricsHandler

relayMetricsHandler: RelayMetricHandler

Relay metrics handler cache

`Static` prefixed

prefixed: string | boolean

Accessors

Sockets

get Sockets(): ConnectionStateSnapshot[]
Get a snapshot of the relay connections

Returns ConnectionStateSnapshot[]
Implementation of SystemInterface.Sockets
- Defined in packages/system/src/nostr-system.ts:154

Methods

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[]>
Implementation of SystemInterface.BroadcastEvent
- Defined in packages/system/src/nostr-system.ts:196

ConnectEphemeralRelay

ConnectEphemeralRelay(address): Promise<undefined | Connection>
Parameters
- address: string
Returns Promise<undefined | Connection>
- Defined in packages/system/src/nostr-system.ts:172

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>
Implementation of SystemInterface.ConnectToRelay
- Defined in packages/system/src/nostr-system.ts:168

DisconnectRelay

DisconnectRelay(address): void
Disconnect permanent relay connection
Parameters
- address: string
  Relay URL
Returns void
Implementation of SystemInterface.DisconnectRelay
- Defined in packages/system/src/nostr-system.ts:176

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[]>
Implementation of SystemInterface.Fetch
- Defined in packages/system/src/nostr-system.ts:184

GetQuery

GetQuery(id): undefined | QueryLike
Get an active query by ID
Parameters
- id: string
  Query ID
Returns undefined | QueryLike
Implementation of SystemInterface.GetQuery
- Defined in packages/system/src/nostr-system.ts:180

HandleEvent

HandleEvent(ev): void
Push an event into the system from external source
Parameters
- ev: TaggedNostrEvent
Returns void
Implementation of SystemInterface.HandleEvent
- Defined in packages/system/src/nostr-system.ts:192

Init

Init(): Promise<void>
Do some initialization

Returns Promise<void>
Implementation of SystemInterface.Init
- Defined in packages/system/src/nostr-system.ts:158

Query

Query(req): QueryLike
Open a new query to relays
Parameters
- req: RequestBuilder
  Request to send to relays
Returns QueryLike
Implementation of SystemInterface.Query
- Defined in packages/system/src/nostr-system.ts:188

WriteOnceToRelay

WriteOnceToRelay(address, ev): Promise<OkResponse>
Connect to a specific relay and send an event and wait for the response
Parameters
- address: string
  Relay URL
- ev: NostrEvent
  Event to send
Returns Promise<OkResponse>
Implementation of SystemInterface.WriteOnceToRelay
- Defined in packages/system/src/nostr-system.ts:201

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends keyof NostrSystemEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<NostrSystemEvents>[Extract<T, keyof NostrSystemEvents>]
      Returns void
- Optional context: any
Returns this
Inherited from EventEmitter.addListener
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:45

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof NostrSystemEvents
Parameters
- event: T
- Rest ...args: ArgumentMap<NostrSystemEvents>[Extract<T, keyof NostrSystemEvents>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof NostrSystemEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof NostrSystemEvents)[]
Inherited from EventEmitter.eventNames
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof NostrSystemEvents
Returns number
Inherited from EventEmitter.listenerCount
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof NostrSystemEvents
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from EventEmitter.listeners
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:20

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends keyof NostrSystemEvents
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<NostrSystemEvents>[Extract<T, keyof NostrSystemEvents>]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from EventEmitter.off
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends keyof NostrSystemEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<NostrSystemEvents>[Extract<T, keyof NostrSystemEvents>]
      Returns void
- Optional context: any
Returns this
Inherited from EventEmitter.on
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof NostrSystemEvents
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<NostrSystemEvents>[Extract<T, keyof NostrSystemEvents>]
      Returns void
- Optional context: any
Returns this
Inherited from EventEmitter.once
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof NostrSystemEvents
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof NostrSystemEvents
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<NostrSystemEvents>[Extract<T, keyof NostrSystemEvents>]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:63

takeSnapshot

takeSnapshot(): SystemSnapshot
Returns SystemSnapshot
- Defined in packages/system/src/nostr-system.ts:205

Class NostrSystem

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

props: NostrsystemProps

Returns NostrSystem

Properties

Private #log

Private #queryManager

checkSigs

Readonly eventsCache

Readonly optimizer

Readonly pool

Readonly profileCache

Readonly profileLoader

Readonly relayCache

Readonly relayLoader

Readonly relayMetricsCache

Readonly relayMetricsHandler

Static prefixed

Accessors

Sockets

Returns ConnectionStateSnapshot[]

Methods

BroadcastEvent

Parameters

ev: NostrEvent

Optional cb: ((rsp) => void)

Parameters

rsp: OkResponse

Returns void

Returns Promise<OkResponse[]>

ConnectEphemeralRelay

Parameters

address: string

Returns Promise<undefined | Connection>

ConnectToRelay

Parameters

address: string

options: RelaySettings

Returns Promise<void>

DisconnectRelay

Parameters

address: string

Returns void

Fetch

Parameters

req: RequestBuilder

Optional cb: ((evs) => void)

Parameters

evs: TaggedNostrEvent[]

Returns void

Returns Promise<TaggedNostrEvent[]>

GetQuery

Parameters

id: string

Returns undefined | QueryLike

HandleEvent

Parameters

ev: TaggedNostrEvent

Returns void

Init

Returns Promise<void>

Query

Parameters

req: RequestBuilder

Returns QueryLike

WriteOnceToRelay

Parameters

address: string

ev: NostrEvent

Returns Promise<OkResponse>

addListener

`Private` #log

`Private` #queryManager

`Readonly` eventsCache

`Readonly` optimizer

`Readonly` pool

`Readonly` profileCache

`Readonly` profileLoader

`Readonly` relayCache

`Readonly` relayLoader

`Readonly` relayMetricsCache

`Readonly` relayMetricsHandler

`Static` prefixed

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

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

`Rest` ...args: ArgumentMap<NostrSystemEvents>[Extract<T, keyof NostrSystemEvents>]

`Optional` context: any

`Rest` ...args: ArgumentMap<NostrSystemEvents>[Extract<T, keyof NostrSystemEvents>]

`Optional` fn: ((...args) => void)

`Rest` ...args: ArgumentMap<NostrSystemEvents>[Extract<T, keyof NostrSystemEvents>]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: ArgumentMap<NostrSystemEvents>[Extract<T, keyof NostrSystemEvents>]

`Optional` context: any

`Rest` ...args: ArgumentMap<NostrSystemEvents>[Extract<T, keyof NostrSystemEvents>]

`Optional` context: any

`Optional` event: keyof NostrSystemEvents