Class EventStore

A wrapper around an event database that handles replaceable events, deletes, and models

Hierarchy (View Summary)

EventModels
- EventStore

Implements

IEventStore

Constructors

constructor

new EventStore(options?: EventStoreOptions): EventStore
Parameters
- Optionaloptions: EventStoreOptions
Returns EventStore
Overrides EventModels.constructor
- Defined in packages/core/src/event-store/event-store.ts:106

Properties

database

database: IEventDatabase

`Optional`eventLoader

eventLoader?: (
pointer: AddressPointer | EventPointer | AddressPointerWithoutD,
) => Promise<NostrEvent | undefined> | Observable<NostrEvent>

A method that will be called when an event isn't found in the store

insert$

insert$: Subject<NostrEvent> = ...

A stream of new events added to the store

keepDeleted

keepDeleted: boolean = false

Keep deleted events in the store

keepExpired

keepExpired: boolean = false

Keep expired events in the store

keepOldVersions

keepOldVersions: boolean = false

Enable this to keep old versions of replaceable events

memory

memory: EventMemory

Optional memory database for ensuring single event instances

modelKeepWarm

modelKeepWarm: number = 60_000

How long a model should be kept "warm" while nothing is subscribed to it

models

models: Map<
ModelConstructor<any, any[], IEventStore | IAsyncEventStore>,
Map<string, Observable<any>>,
> = ...

A directory of all active models

remove$

remove$: Subject<NostrEvent> = ...

A stream of events that have been removed

update$

update$: Subject<NostrEvent> = ...

A stream of events that have been updated (Warning: this is a very noisy stream, use with caution)

Accessors

verifyEvent

get verifyEvent(): ((event: NostrEvent) => boolean) | undefined
Get the method used to verify events

Returns ((event: NostrEvent) => boolean) | undefined
- Defined in packages/core/src/event-store/event-store.ts:80
set verifyEvent(method: ((event: NostrEvent) => boolean) | undefined): void
Sets the method used to verify events
Parameters
- method: ((event: NostrEvent) => boolean) | undefined
Returns void
- Defined in packages/core/src/event-store/event-store.ts:85

Methods

add

add(event: NostrEvent, fromRelay?: string): NostrEvent | null
Adds an event to the store and update subscriptions
Parameters
- event: NostrEvent
- OptionalfromRelay: string
Returns NostrEvent | null
The existing event or the event that was added, if it was ignored returns null
Implementation of IEventStore.add
- Defined in packages/core/src/event-store/event-store.ts:213

addressable

addressable(pointer: AddressPointer): Observable<NostrEvent | undefined>
Subscribe to an addressable event by pointer
Parameters
- pointer: AddressPointer
Returns Observable<NostrEvent | undefined>
Implementation of IEventStore.addressable
Inherited from EventModels.addressable
- Defined in packages/core/src/event-store/event-models.ts:124

claim

claim(event: NostrEvent): void
Increments the claim count on the event and touches it
Parameters
- event: NostrEvent
Returns void
Implementation of IEventStore.claim
- Defined in packages/core/src/event-store/event-store.ts:413

clearClaim

clearClaim(event: NostrEvent): void
Removes all claims on an event
Parameters
- event: NostrEvent
Returns void
Implementation of IEventStore.clearClaim
- Defined in packages/core/src/event-store/event-store.ts:425

contacts

contacts(user: string | ProfilePointer): Observable<ProfilePointer[]>
Subscribe to a users contacts
Parameters
- user: string | ProfilePointer
Returns Observable<ProfilePointer[]>
Implementation of IEventStore.contacts
Inherited from EventModels.contacts
- Defined in packages/core/src/event-store/event-models.ts:140

event

event(
pointer: string | AddressPointer | EventPointer | AddressPointerWithoutD,
): Observable<NostrEvent | undefined>
Subscribe to an event by pointer
Parameters
- pointer: string | AddressPointer | EventPointer | AddressPointerWithoutD
Returns Observable<NostrEvent | undefined>
Implementation of IEventStore.event
Inherited from EventModels.event
- Defined in packages/core/src/event-store/event-models.ts:99

filters

filters(filters: Filter | Filter[], onlyNew?: boolean): Observable<NostrEvent>
Creates an observable that streams all events that match the filter
Parameters
- filters: Filter | Filter[]
- OptionalonlyNew: boolean = false
  Only subscribe to new events
Returns Observable<NostrEvent>
Implementation of IEventStore.filters
Inherited from EventModels.filters
- Defined in packages/core/src/event-store/event-models.ts:93

getByFilters

getByFilters(filters: Filter | Filter[]): NostrEvent[]
Get all events matching a filter
Parameters
- filters: Filter | Filter[]
Returns NostrEvent[]
Implementation of IEventStore.getByFilters
- Defined in packages/core/src/event-store/event-store.ts:393

getEvent

getEvent(
id: string | AddressPointer | EventPointer | AddressPointerWithoutD,
): NostrEvent | undefined
Get an event by id from the store
Parameters
- id: string | AddressPointer | EventPointer | AddressPointerWithoutD
Returns NostrEvent | undefined
Implementation of IEventStore.getEvent
- Defined in packages/core/src/event-store/event-store.ts:360

getReplaceable

getReplaceable(
    kind: number,
    pubkey: string,
    identifier?: string,
): NostrEvent | undefined
Gets the latest version of a replaceable event
Parameters
- kind: number
- pubkey: string
- Optionalidentifier: string
Returns NostrEvent | undefined
Implementation of IEventStore.getReplaceable
- Defined in packages/core/src/event-store/event-store.ts:375

getReplaceableHistory

getReplaceableHistory(
    kind: number,
    pubkey: string,
    identifier?: string,
): NostrEvent[] | undefined
Returns all versions of a replaceable event
Parameters
- kind: number
- pubkey: string
- Optionalidentifier: string
Returns NostrEvent[] | undefined
Implementation of IEventStore.getReplaceableHistory
- Defined in packages/core/src/event-store/event-store.ts:384

getTimeline

getTimeline(filters: Filter | Filter[]): NostrEvent[]
Returns a timeline of events that match filters
Parameters
- filters: Filter | Filter[]
Returns NostrEvent[]
Implementation of IEventStore.getTimeline
- Defined in packages/core/src/event-store/event-store.ts:402

hasEvent

hasEvent(
id: string | AddressPointer | EventPointer | AddressPointerWithoutD,
): boolean
Check if the store has an event by id
Parameters
- id: string | AddressPointer | EventPointer | AddressPointerWithoutD
Returns boolean
Implementation of IEventStore.hasEvent
- Defined in packages/core/src/event-store/event-store.ts:352

hasReplaceable

hasReplaceable(kind: number, pubkey: string, d?: string): boolean
Check if the store has a replaceable event
Parameters
- kind: number
- pubkey: string
- Optionald: string
Returns boolean
Implementation of IEventStore.hasReplaceable
- Defined in packages/core/src/event-store/event-store.ts:369

isClaimed

isClaimed(event: NostrEvent): boolean
Checks if an event is claimed by anything
Parameters
- event: NostrEvent
Returns boolean
Implementation of IEventStore.isClaimed
- Defined in packages/core/src/event-store/event-store.ts:417

mailboxes

mailboxes(
user: string | ProfilePointer,
): Observable<{ inboxes: string[]; outboxes: string[] } | undefined>
Subscribe to a users mailboxes
Parameters
- user: string | ProfilePointer
Returns Observable<{ inboxes: string[]; outboxes: string[] } | undefined>
Implementation of IEventStore.mailboxes
Inherited from EventModels.mailboxes
- Defined in packages/core/src/event-store/event-models.ts:146

model

model<T extends unknown, Args extends any[]>(
constructor: ModelConstructor<T, Args, IEventStore | IAsyncEventStore>,
...args: Args,
): Observable<T>
Get or create a model on the event store
Type Parameters
- T extends unknown
- Args extends any[]
Parameters
- constructor: ModelConstructor<T, Args, IEventStore | IAsyncEventStore>
- ...args: Args
Returns Observable<T>
Implementation of IEventStore.model
Inherited from EventModels.model
- Defined in packages/core/src/event-store/event-models.ts:50

profile

profile(user: string | ProfilePointer): Observable<ProfileContent | undefined>
Subscribe to a users profile
Parameters
- user: string | ProfilePointer
Returns Observable<ProfileContent | undefined>
Implementation of IEventStore.profile
Inherited from EventModels.profile
- Defined in packages/core/src/event-store/event-models.ts:134

prune

prune(limit?: number): number
Removes any event that is not being used by a subscription
Parameters
- Optionallimit: number
Returns number
- Defined in packages/core/src/event-store/event-store.ts:433

remove

remove(event: string | NostrEvent): boolean
Removes an event from the store and updates subscriptions
Parameters
- event: string | NostrEvent
Returns boolean
Implementation of IEventStore.remove
- Defined in packages/core/src/event-store/event-store.ts:294

removeByFilters

removeByFilters(filters: Filter | Filter[]): number
Remove multiple events that match the given filters
Parameters
- filters: Filter | Filter[]
Returns number
- Defined in packages/core/src/event-store/event-store.ts:317

removeClaim

removeClaim(event: NostrEvent): void
Decrements the claim count on an event
Parameters
- event: NostrEvent
Returns void
Implementation of IEventStore.removeClaim
- Defined in packages/core/src/event-store/event-store.ts:421

replaceable

replaceable(
pointer: AddressPointer | AddressPointerWithoutD,
): Observable<NostrEvent | undefined>
Subscribe to a replaceable event by pointer
Parameters
- pointer: AddressPointer | AddressPointerWithoutD
Returns Observable<NostrEvent | undefined>
Implementation of IEventStore.replaceable
Inherited from EventModels.replaceable
- Defined in packages/core/src/event-store/event-models.ts:105
replaceable(
    kind: number,
    pubkey: string,
    identifier?: string,
): Observable<NostrEvent | undefined>
Subscribe to a replaceable event with legacy arguments
Parameters
- kind: number
- pubkey: string
- Optionalidentifier: string
Returns Observable<NostrEvent | undefined>
Implementation of IEventStore.replaceable
Inherited from EventModels.replaceable
- Defined in packages/core/src/event-store/event-models.ts:106

timeline

timeline(
filters: Filter | Filter[],
includeOldVersion?: boolean,
): Observable<NostrEvent[]>
Creates a TimelineModel
Parameters
- filters: Filter | Filter[]
- includeOldVersion: boolean = false
Returns Observable<NostrEvent[]>
Implementation of IEventStore.timeline
Inherited from EventModels.timeline
- Defined in packages/core/src/event-store/event-models.ts:129

touch

touch(event: NostrEvent): void
Passthrough method for the database.touch
Parameters
- event: NostrEvent
Returns void
Implementation of IEventStore.touch
- Defined in packages/core/src/event-store/event-store.ts:409

unclaimed

unclaimed(): Generator<NostrEvent>
Pass through method for the database.unclaimed

Returns Generator<NostrEvent>
Implementation of IEventStore.unclaimed
- Defined in packages/core/src/event-store/event-store.ts:429

update

update(event: NostrEvent): boolean
Add an event to the store and notifies all subscribes it has updated
Parameters
- event: NostrEvent
Returns boolean
Implementation of IEventStore.update
- Defined in packages/core/src/event-store/event-store.ts:339

`Static`copySymbolsToDuplicateEvent

copySymbolsToDuplicateEvent(source: NostrEvent, dest: NostrEvent): boolean
Copies important metadata from and identical event to another
Parameters
- source: NostrEvent
- dest: NostrEvent
Returns boolean
- Defined in packages/core/src/event-store/event-store.ts:178

Class EventStore

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EventStore

Properties

database

OptionaleventLoader

insert$

keepDeleted

keepExpired

keepOldVersions

memory

modelKeepWarm

models

remove$

update$

Accessors

verifyEvent

Returns ((event: NostrEvent) => boolean) | undefined

Parameters

Returns void

Methods

add

Parameters

Returns NostrEvent | null

addressable

Parameters

Returns Observable<NostrEvent | undefined>

claim

Parameters

Returns void

clearClaim

Parameters

Returns void

contacts

Parameters

Returns Observable<ProfilePointer[]>

event

Parameters

Returns Observable<NostrEvent | undefined>

filters

Parameters

Returns Observable<NostrEvent>

getByFilters

Parameters

Returns NostrEvent[]

getEvent

Parameters

Returns NostrEvent | undefined

getReplaceable

Parameters

Returns NostrEvent | undefined

getReplaceableHistory

Parameters

Returns NostrEvent[] | undefined

getTimeline

Parameters

Returns NostrEvent[]

hasEvent

Parameters

Returns boolean

hasReplaceable

Parameters

Returns boolean

isClaimed

Parameters

Returns boolean

mailboxes

Parameters

Returns Observable<{ inboxes: string[]; outboxes: string[] } | undefined>

model

Type Parameters

`Optional`eventLoader

`Static`copySymbolsToDuplicateEvent