Class InviteManager

InviteManager orchestrates the lifecycle of reading Welcome invites.

It takes gift-wrapped events from the app, handles decryption/parsing, persists invites to storage, and provides interfaces for consumption.

The app is responsible for:

Syncing events from relays
Passing gift wrap events (kind 1059) to ingestEvent()
Calling decryptGiftWraps() to decrypt (triggers nip-44 decryption prompts)
Reading unread invites via getUnread(), watchUnread(), or event listeners
Marking invites as read after processing

State lifecycle:

RECEIVED: Gift wrap ingested, stored, awaiting decryption
UNREAD: Decrypted and parsed, ready for app consumption
SEEN: Event ID tracked to prevent re-processing
(DELETED): Read invites are removed from storage

Store layout:

__seen key holds a serialized set of all seen event IDs
received:<eventId> keys hold undecrypted gift wraps
unread:<rumorId> keys hold decrypted welcome rumors

Hierarchy

EventEmitter<InviteManagerEvents>
- InviteManager

Index

Client - Invite Manager

constructor

new InviteManager(options: InviteManagerOptions): InviteManager
Parameters
- options: InviteManagerOptions
Returns InviteManager
Overrides EventEmitter<InviteManagerEvents>.constructor
- Defined in ../home/robert/Projects/marmot-ts/src/client/invite-manager.ts:100

clear

clear(): Promise<void>
Clear all stored invites (received and unread).

Note: This does NOT clear the seen index to maintain deduplication history. If you need to clear seen events, use clearSeen() or create a fresh store.

Returns Promise<void>
- Defined in ../home/robert/Projects/marmot-ts/src/client/invite-manager.ts:379

clearSeen

clearSeen(): Promise<void>
Clear the seen event IDs. Warning: This will allow previously processed events to be re-ingested.

Returns Promise<void>
- Defined in ../home/robert/Projects/marmot-ts/src/client/invite-manager.ts:392

decryptGiftWrap

decryptGiftWrap(
eventId: string | ReceivedGiftWrap,
): Promise<UnreadInvite | null>
Process a single received (undecrypted) gift wrap by event ID.

Attempts to decrypt and parse the specified event.
- On success: moves to 'unread' state and emits 'newInvite' event
- On failure: emits 'error' event (event remains in 'seen' to prevent retry)
This method prompts the user via signer for decryption.
Parameters
- eventId: string | ReceivedGiftWrap
  The gift wrap event ID to decrypt, or the gift wrap event itself
Returns Promise<UnreadInvite | null>
The decrypted welcome rumor, or null if failed to decrypt

Throws
Error if the event is not found in received store
- Defined in ../home/robert/Projects/marmot-ts/src/client/invite-manager.ts:191

decryptGiftWraps

decryptGiftWraps(): Promise<UnreadInvite[]>
Decrypts all received gift wraps.

Attempts to decrypt and parse each received gift wrap.
- On success: moves to 'unread' state and emits 'newInvite' event
- On failure: emits 'error' event (event remains in 'seen' to prevent retry)
This method prompts the user via signer for each decryption, so it should be called deliberately by the app (not automatically).
Returns Promise<UnreadInvite[]>
Array of successfully decrypted welcome rumors
- Defined in ../home/robert/Projects/marmot-ts/src/client/invite-manager.ts:255

getReceived

getReceived(): Promise<ReceivedGiftWrap[]>
Get all received (encrypted) invites.

Returns Promise<ReceivedGiftWrap[]>
Array of received invites awaiting decryption
- Defined in ../home/robert/Projects/marmot-ts/src/client/invite-manager.ts:298

getUnread

getUnread(): Promise<UnreadInvite[]>
Get all unread invites.

Returns Promise<UnreadInvite[]>
Array of unread welcome rumors
- Defined in ../home/robert/Projects/marmot-ts/src/client/invite-manager.ts:280

ingestEvent

ingestEvent(event: NostrEvent): Promise<boolean>
Ingest a gift wrap event (kind 1059).

The event is checked against the seen index for deduplication. If new, it's stored in the 'received' state awaiting decryption.
Parameters
- event: NostrEvent
  Gift wrap event (kind 1059)
Returns Promise<boolean>
true if event was new and stored, false if already seen

Throws
Error if event is not kind 1059
- Defined in ../home/robert/Projects/marmot-ts/src/client/invite-manager.ts:134

ingestEvents

ingestEvents(events: NostrEvent[]): Promise<number>
Ingest multiple gift wrap events in batch.
Parameters
- events: NostrEvent[]
  Array of gift wrap events
Returns Promise<number>
Count of new events stored
- Defined in ../home/robert/Projects/marmot-ts/src/client/invite-manager.ts:164

markAsRead

markAsRead(inviteId: string): Promise<void>
Mark an invite as read and remove it from storage.

Emits 'inviteRead' event after removal.
Parameters
- inviteId: string
  The rumor ID (from the welcome rumor)
Returns Promise<void>
- Defined in ../home/robert/Projects/marmot-ts/src/client/invite-manager.ts:318

watchReceived

watchReceived(): AsyncGenerator<ReceivedGiftWrap[]>
Watch for received (encrypted) invites.

Yields the current list of received gift wraps, then yields again whenever the received list changes (via 'ReceivedGiftWrap' or 'receivedProcessed' events).

Returns AsyncGenerator<ReceivedGiftWrap[]>
- Defined in ../home/robert/Projects/marmot-ts/src/client/invite-manager.ts:356

watchUnread

watchUnread(): AsyncGenerator<UnreadInvite[]>
Watch for unread invites.

Yields the current array of unread invites, then yields again whenever the unread list changes (via 'newInvite' or 'inviteRead' events).

This does NOT automatically mark invites as read - the app must call markAsRead() after processing each invite.

Returns AsyncGenerator<UnreadInvite[]>
- Defined in ../home/robert/Projects/marmot-ts/src/client/invite-manager.ts:333

Other

`Static`prefixed

prefixed: string | boolean

addListener

addListener<T extends keyof InviteManagerEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<InviteManagerEvents>[Extract<
            T,
            keyof InviteManagerEvents,
        >],
    ) => void,
    context?: any,
): this
Type Parameters
- T extends keyof InviteManagerEvents
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<InviteManagerEvents>[Extract<
          T,
          keyof InviteManagerEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.addListener
- Defined in ../home/robert/Projects/marmot-ts/node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:45

emit

emit<T extends keyof InviteManagerEvents>(
    event: T,
    ...args: ArgumentMap<InviteManagerEvents>[Extract<
        T,
        keyof InviteManagerEvents,
    >],
): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof InviteManagerEvents
Parameters
- event: T
- ...args: ArgumentMap<InviteManagerEvents>[Extract<T, keyof InviteManagerEvents>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in ../home/robert/Projects/marmot-ts/node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:32

eventNames

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

Returns (keyof InviteManagerEvents)[]
Inherited from EventEmitter.eventNames
- Defined in ../home/robert/Projects/marmot-ts/node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event: keyof InviteManagerEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof InviteManagerEvents
Returns number
Inherited from EventEmitter.listenerCount
- Defined in ../home/robert/Projects/marmot-ts/node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T extends keyof InviteManagerEvents>(
    event: T,
): (
    (
        ...args: ArgumentMap<InviteManagerEvents>[Extract<
            T,
            keyof InviteManagerEvents,
        >],
    ) => void
)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof InviteManagerEvents
Parameters
- event: T
Returns (
    (
        ...args: ArgumentMap<InviteManagerEvents>[Extract<
            T,
            keyof InviteManagerEvents,
        >],
    ) => void
)[]
Inherited from EventEmitter.listeners
- Defined in ../home/robert/Projects/marmot-ts/node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:20

off

off<T extends keyof InviteManagerEvents>(
    event: T,
    fn?: (
        ...args: ArgumentMap<InviteManagerEvents>[Extract<
            T,
            keyof InviteManagerEvents,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends keyof InviteManagerEvents
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<InviteManagerEvents>[Extract<
          T,
          keyof InviteManagerEvents,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.off
- Defined in ../home/robert/Projects/marmot-ts/node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:69

on

on<T extends keyof InviteManagerEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<InviteManagerEvents>[Extract<
            T,
            keyof InviteManagerEvents,
        >],
    ) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends keyof InviteManagerEvents
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<InviteManagerEvents>[Extract<
          T,
          keyof InviteManagerEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.on
- Defined in ../home/robert/Projects/marmot-ts/node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:40

once

once<T extends keyof InviteManagerEvents>(
    event: T,
    fn: (
        ...args: ArgumentMap<InviteManagerEvents>[Extract<
            T,
            keyof InviteManagerEvents,
        >],
    ) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof InviteManagerEvents
Parameters
- event: T
- fn: (
      ...args: ArgumentMap<InviteManagerEvents>[Extract<
          T,
          keyof InviteManagerEvents,
      >],
  ) => void
- Optionalcontext: any
Returns this
Inherited from EventEmitter.once
- Defined in ../home/robert/Projects/marmot-ts/node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: keyof InviteManagerEvents): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: keyof InviteManagerEvents
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in ../home/robert/Projects/marmot-ts/node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T extends keyof InviteManagerEvents>(
    event: T,
    fn?: (
        ...args: ArgumentMap<InviteManagerEvents>[Extract<
            T,
            keyof InviteManagerEvents,
        >],
    ) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof InviteManagerEvents
Parameters
- event: T
- Optionalfn: (
      ...args: ArgumentMap<InviteManagerEvents>[Extract<
          T,
          keyof InviteManagerEvents,
      >],
  ) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from EventEmitter.removeListener
- Defined in ../home/robert/Projects/marmot-ts/node_modules/.pnpm/eventemitter3@5.0.4/node_modules/eventemitter3/index.d.ts:63

Class InviteManager

Hierarchy

Index

Client - Invite Manager

Other

Client - Invite Manager

constructor

Parameters

Returns InviteManager

clear

Returns Promise<void>

clearSeen

Returns Promise<void>

decryptGiftWrap

Parameters

Returns Promise<UnreadInvite | null>

Throws

decryptGiftWraps

Returns Promise<UnreadInvite[]>

getReceived

Returns Promise<ReceivedGiftWrap[]>

getUnread

Returns Promise<UnreadInvite[]>

ingestEvent

Parameters

Returns Promise<boolean>

Throws

ingestEvents

Parameters

Returns Promise<number>

markAsRead

Parameters

Returns Promise<void>

watchReceived

Returns AsyncGenerator<ReceivedGiftWrap[]>

watchUnread

Returns AsyncGenerator<UnreadInvite[]>

Other

Staticprefixed

addListener

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (keyof InviteManagerEvents)[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: ArgumentMap<InviteManagerEvents>[Extract< T, keyof InviteManagerEvents, >], ) => void)[]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

removeAllListeners

Parameters

Returns this

removeListener

Type Parameters

Parameters

Returns this

Settings

On This Page

`Static`prefixed

Returns (
(
...args: ArgumentMap<InviteManagerEvents>[Extract<
T,
keyof InviteManagerEvents,
>],
) => void
)[]