Class EventMemory<E>

An in-memory database of events

Type Parameters

E extends StoreEvent = NostrEvent

Implements

IEventMemory<E>

Constructors

constructor

new EventMemory<E extends StoreEvent = NostrEvent>(): EventMemory<E>
Type Parameters
- E extends StoreEvent = NostrEvent
Returns EventMemory<E>

Properties

`Protected`authors

authors: Map<string, Set<E>> = ...

`Protected`claims

claims: WeakMap<E, number> = ...

A weak map of events to claim reference counts

`Protected`created_at

created_at: TimeIndex<E> = ...

events

events: LRU<E> = ...

LRU cache of last events touched

`Protected`kindAuthor

kindAuthor: Map<string, Set<E>> = ...

Composite index for kind+author queries (common pattern)

`Protected`kinds

kinds: Map<number, Set<E>> = ...

Indexes

`Protected`log

log: Debugger = ...

`Protected`replaceable

replaceable: Map<string, E[]> = ...

A sorted array of replaceable events by address

`Protected`tags

tags: LRU<Set<E>> = ...

Accessors

size

get size(): number
The number of events in the database

Returns number
- Defined in packages/core/src/event-store/event-memory.ts:52

Methods

add

add(event: E): E
Inserts an event into the database and notifies all subscriptions
Parameters
- event: E
Returns E
Implementation of IEventMemory.add
- Defined in packages/core/src/event-store/event-memory.ts:115

`Protected`buildTagIndexes

buildTagIndexes(tagAndValues: Iterable<string>): Map<string, Set<E>>
Builds the indexes for any tag values that are not indexed yet with a single pass over the events
Parameters
- tagAndValues: Iterable<string>
Returns Map<string, Set<E>>
- Defined in packages/core/src/event-store/event-memory.ts:323

claim

claim(event: E): void
Increments the claim count on the event and touches it
Parameters
- event: E
Returns void
Implementation of IEventMemory.claim
- Defined in packages/core/src/event-store/event-memory.ts:248

clearClaim

clearClaim(event: E): void
Removes all claims on an event
Parameters
- event: E
Returns void
Implementation of IEventMemory.clearClaim
- Defined in packages/core/src/event-store/event-memory.ts:273

`Protected`getAuthorsIndex

getAuthorsIndex(author: string): Set<E>
Parameters
- author: string
Returns Set<E>
- Defined in packages/core/src/event-store/event-memory.ts:309

getByFilters

getByFilters(filters: Filter | Filter[]): E[]
Gets all events that match the filters
Parameters
- filters: Filter | Filter[]
Returns E[]
Implementation of IEventMemory.getByFilters
- Defined in packages/core/src/event-store/event-memory.ts:83

getEvent

getEvent(id: string): E | undefined
Gets a single event based on id
Parameters
- id: string
Returns E | undefined
Implementation of IEventMemory.getEvent
- Defined in packages/core/src/event-store/event-memory.ts:61

`Protected`getEventsForFilter

getEventsForFilter(filter: Filter): Set<E>
Returns all events that match the filter
Parameters
- filter: Filter
Returns Set<E>
- Defined in packages/core/src/event-store/event-memory.ts:440

`Protected`getEventsForFilters

getEventsForFilters(filters: Filter[]): Set<E>
Returns all events that match the filters
Parameters
- filters: Filter[]
Returns Set<E>
- Defined in packages/core/src/event-store/event-memory.ts:554

`Protected`getKindAuthorIndex

getKindAuthorIndex(kind: number, pubkey: string): Set<E>
Parameters
- kind: number
- pubkey: string
Returns Set<E>
- Defined in packages/core/src/event-store/event-memory.ts:313

`Protected`getKindIndex

getKindIndex(kind: number): Set<E>
Index helper methods
Parameters
- kind: number
Returns Set<E>
- Defined in packages/core/src/event-store/event-memory.ts:305

getReplaceable

getReplaceable(kind: number, pubkey: string, identifier?: string): E | undefined
Gets the latest replaceable event
Parameters
- kind: number
- pubkey: string
- Optionalidentifier: string
Returns E | undefined
Implementation of IEventMemory.getReplaceable
- Defined in packages/core/src/event-store/event-memory.ts:71

getReplaceableHistory

getReplaceableHistory(
    kind: number,
    pubkey: string,
    identifier?: string,
): E[] | undefined
Gets the history of a replaceable event
Parameters
- kind: number
- pubkey: string
- Optionalidentifier: string
Returns E[] | undefined
Implementation of IEventMemory.getReplaceableHistory
- Defined in packages/core/src/event-store/event-memory.ts:77

getSyncPairs

getSyncPairs(filters: Filter | Filter[]): SyncPair[]
Gets matching sync pairs without populating event memory
Parameters
- filters: Filter | Filter[]
Returns SyncPair[]
Implementation of IEventMemory.getSyncPairs
- Defined in packages/core/src/event-store/event-memory.ts:87

`Protected`getTagIndex

getTagIndex(tagAndValue: string): Set<E>
Parameters
- tagAndValue: string
Returns Set<E>
- Defined in packages/core/src/event-store/event-memory.ts:318

`Protected`getTagSets

getTagSets(tag: string, values: string[]): Set<E>[]
Returns the tag index sets for the values, building any that are missing
Parameters
- tag: string
- values: string[]
Returns Set<E>[]
- Defined in packages/core/src/event-store/event-memory.ts:541

getTimeline

getTimeline(filters: Filter | Filter[]): E[]
Gets a timeline of events that match the filters
Parameters
- filters: Filter | Filter[]
Returns E[]
Implementation of IEventMemory.getTimeline
- Defined in packages/core/src/event-store/event-memory.ts:95

hasEvent

hasEvent(id: string): boolean
Checks if the database contains an event without touching it
Parameters
- id: string
Returns boolean
Implementation of IEventMemory.hasEvent
- Defined in packages/core/src/event-store/event-memory.ts:57

hasReplaceable

hasReplaceable(kind: number, pubkey: string, identifier?: string): boolean
Checks if the event set has a replaceable event
Parameters
- kind: number
- pubkey: string
- Optionalidentifier: string
Returns boolean
Implementation of IEventMemory.hasReplaceable
- Defined in packages/core/src/event-store/event-memory.ts:66

isClaimed

isClaimed(event: E): boolean
Checks if an event is claimed by anything
Parameters
- event: E
Returns boolean
Implementation of IEventMemory.isClaimed
- Defined in packages/core/src/event-store/event-memory.ts:256

iterateAuthors

iterateAuthors(authors: Iterable<string>): Generator<E>
Iterates over all events by author
Parameters
- authors: Iterable<string>
Returns Generator<E>
- Defined in packages/core/src/event-store/event-memory.ts:391

iterateIds

iterateIds(ids: Iterable<string>): Generator<E>
Iterates over all events by id
Parameters
- ids: Iterable<string>
Returns Generator<E>
- Defined in packages/core/src/event-store/event-memory.ts:433

iterateKinds

iterateKinds(kinds: Iterable<number>): Generator<E>
Iterates over all events by kind
Parameters
- kinds: Iterable<number>
Returns Generator<E>
- Defined in packages/core/src/event-store/event-memory.ts:417

iterateTag

iterateTag(tag: string, values: Iterable<string>): Generator<E>
Iterates over all events by indexable tag and value
Parameters
- tag: string
- values: Iterable<string>
Returns Generator<E>
- Defined in packages/core/src/event-store/event-memory.ts:402

iterateTime

iterateTime(since: number | undefined, until: number | undefined): Generator<E>
Iterates over all events by time
Parameters
- since: number | undefined
- until: number | undefined
Returns Generator<E>
- Defined in packages/core/src/event-store/event-memory.ts:428

prune

prune(limit?: number): number
Removes events that are not claimed (free up memory)
Parameters
- Optionallimit: number
Returns number
- Defined in packages/core/src/event-store/event-memory.ts:290

remove

remove(eventOrId: string | E): boolean
Removes an event from the database and notifies all subscriptions
Parameters
- eventOrId: string | E
Returns boolean
Implementation of IEventMemory.remove
- Defined in packages/core/src/event-store/event-memory.ts:153

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-memory.ts:218

removeClaim

removeClaim(event: E): void
Decrements the claim count on an event
Parameters
- event: E
Returns void
Implementation of IEventMemory.removeClaim
- Defined in packages/core/src/event-store/event-memory.ts:261

`Protected`removeFromSortedArray

removeFromSortedArray(array: E[], event: E): void
Helper method to remove an event from a sorted array using binary search. Falls back to indexOf if binary search doesn't find exact match.
Parameters
- array: E[]
- event: E
Returns void
- Defined in packages/core/src/event-store/event-memory.ts:344

reset

reset(): void
Resets the event set

Returns void
- Defined in packages/core/src/event-store/event-memory.ts:568

touch

touch(event: E): void
Moves an event to the top of the LRU cache
Parameters
- event: E
Returns void
Implementation of IEventMemory.touch
- Defined in packages/core/src/event-store/event-memory.ts:239

unclaimed

unclaimed(): Generator<E>
Returns a generator of unclaimed events in order of least used

Returns Generator<E>
Implementation of IEventMemory.unclaimed
- Defined in packages/core/src/event-store/event-memory.ts:277

update

update(_event: E): void
Notify the database that an event has updated
Parameters
- _event: E
Returns void
- Defined in packages/core/src/event-store/event-memory.ts:231

Class EventMemory<E>

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns EventMemory<E>

Properties

Protectedauthors

Protectedclaims

Protectedcreated_at

events

ProtectedkindAuthor

Protectedkinds

Protectedlog

Protectedreplaceable

Protectedtags

Accessors

size

Returns number

Methods

add

Parameters

Returns E

ProtectedbuildTagIndexes

Parameters

Returns Map<string, Set<E>>

claim

Parameters

Returns void

clearClaim

Parameters

Returns void

ProtectedgetAuthorsIndex

Parameters

Returns Set<E>

getByFilters

Parameters

Returns E[]

getEvent

Parameters

Returns E | undefined

ProtectedgetEventsForFilter

Parameters

Returns Set<E>

ProtectedgetEventsForFilters

Parameters

Returns Set<E>

ProtectedgetKindAuthorIndex

Parameters

Returns Set<E>

ProtectedgetKindIndex

Parameters

Returns Set<E>

getReplaceable

Parameters

Returns E | undefined

getReplaceableHistory

Parameters

Returns E[] | undefined

getSyncPairs

Parameters

Returns SyncPair[]

ProtectedgetTagIndex

Parameters

Returns Set<E>

ProtectedgetTagSets

Parameters

Returns Set<E>[]

getTimeline

Parameters

Returns E[]

hasEvent

Parameters

Returns boolean

`Protected`authors

`Protected`claims

`Protected`created_at

`Protected`kindAuthor

`Protected`kinds

`Protected`log

`Protected`replaceable

`Protected`tags

`Protected`buildTagIndexes

`Protected`getAuthorsIndex

`Protected`getEventsForFilter

`Protected`getEventsForFilters

`Protected`getKindAuthorIndex

`Protected`getKindIndex

`Protected`getTagIndex

`Protected`getTagSets

`Protected`removeFromSortedArray