Class KeyPackageStore

Owns the persisted key package entries — the local private material and the tracked kind-30443 events that advertise each package. Pure storage: it never signs or publishes (that is KeyPackagePublisher's job). Mirrors darkmatter's AccountSecretStore seam.

Hierarchy

EventEmitter<KeyPackageStoreEvents>
- KeyPackageStore

Index

Client - Key Package Manager

constructor add addPublished clear count get getPrivateKey has list markUsed remove snapshot

Other

prefixed addListener emit eventNames listenerCount listeners off on once removeAllListeners removeListener

Client - Key Package Manager

constructor

new KeyPackageStore(
store: GenericKeyValueStore<StoredKeyPackage>,
cryptoProvider?: CryptoProvider,
): KeyPackageStore
Parameters
- store: GenericKeyValueStore<StoredKeyPackage>
- cryptoProvider: CryptoProvider = defaultCryptoProvider
Returns KeyPackageStore
Overrides EventEmitter<KeyPackageStoreEvents>.constructor
- Defined in ../home/runner/work/marmot-ts/marmot-ts/src/client/key-package-store.ts:128

add

add(
    keyPackage: Pick<LocalKeyPackage, "privatePackage" | "publicPackage"> & Partial<
        Pick<LocalKeyPackage, "identifier" | "published">,
    >,
): Promise<string>
Adds a LocalKeyPackage to the store.
Parameters
- keyPackage: Pick<LocalKeyPackage, "privatePackage" | "publicPackage"> & Partial<
  Pick<LocalKeyPackage, "identifier" | "published">,
  >
  Must include publicPackage and privatePackage. Optionally include identifier to persist the addressable slot identifier.
Returns Promise<string>
The storage key (hex ref string)
- Defined in ../home/runner/work/marmot-ts/marmot-ts/src/client/key-package-store.ts:150

addPublished

addPublished(
ref: string | Uint8Array<ArrayBufferLike>,
event: NostrEvent,
): Promise<void>
Appends a kind-30443 Nostr event to the published list of the key package identified by ref. If no entry exists yet, a TrackedKeyPackage is created by decoding the public key package from the event body.

Throws if the event body cannot be decoded as a valid key package, or if the event's i tag (KeyPackageRef) does not match the decoded body.
Parameters
- ref: string | Uint8Array<ArrayBufferLike>
- event: NostrEvent
Returns Promise<void>
- Defined in ../home/runner/work/marmot-ts/marmot-ts/src/client/key-package-store.ts:191

clear

clear(): Promise<void>
Clears all entries (local and tracked) from the store.

Returns Promise<void>
- Defined in ../home/runner/work/marmot-ts/marmot-ts/src/client/key-package-store.ts:368

count

count(): Promise<number>
Returns the number of locally stored key packages (those with private material).

Returns Promise<number>
- Defined in ../home/runner/work/marmot-ts/marmot-ts/src/client/key-package-store.ts:324

get

get(ref: string | Uint8Array<ArrayBufferLike>): Promise<StoredKeyPackage | null>
Retrieves the stored key package entry. Returns any entry regardless of whether it has private material.
Parameters
- ref: string | Uint8Array<ArrayBufferLike>
Returns Promise<StoredKeyPackage | null>
- Defined in ../home/runner/work/marmot-ts/marmot-ts/src/client/key-package-store.ts:267

getPrivateKey

getPrivateKey(
ref: string | Uint8Array<ArrayBufferLike>,
): Promise<PrivateKeyPackage | null>
Retrieves the private key material for a key package.
Parameters
- ref: string | Uint8Array<ArrayBufferLike>
  The key package reference
Returns Promise<PrivateKeyPackage | null>
The private key package, or null if not found
- Defined in ../home/runner/work/marmot-ts/marmot-ts/src/client/key-package-store.ts:341

has

has(ref: string | Uint8Array<ArrayBufferLike>): Promise<boolean>
Checks whether a key package with local private material exists.
Parameters
- ref: string | Uint8Array<ArrayBufferLike>
Returns Promise<boolean>
- Defined in ../home/runner/work/marmot-ts/marmot-ts/src/client/key-package-store.ts:329

list

list(): Promise<ListedKeyPackage[]>
Lists all LocalKeyPackage entries (those with private material), without the private package itself.

Returns Promise<ListedKeyPackage[]>
- Defined in ../home/runner/work/marmot-ts/marmot-ts/src/client/key-package-store.ts:290

markUsed

markUsed(ref: string | Uint8Array<ArrayBufferLike>): Promise<void>
Marks a key package as used by setting used = true on the stored entry.

Does nothing if no entry is found for the given ref.
Parameters
- ref: string | Uint8Array<ArrayBufferLike>
  The key package reference
Returns Promise<void>
- Defined in ../home/runner/work/marmot-ts/marmot-ts/src/client/key-package-store.ts:356

remove

remove(ref: string | Uint8Array<ArrayBufferLike>): Promise<void>
Removes a key package from the backend.
Parameters
- ref: string | Uint8Array<ArrayBufferLike>
Returns Promise<void>
- Defined in ../home/runner/work/marmot-ts/marmot-ts/src/client/key-package-store.ts:275

snapshot

snapshot(): Promise<ListedKeyPackage[]>
Lists all local key packages with their published events defaulted to an empty array, suitable for emitting as a stable snapshot.

Returns Promise<ListedKeyPackage[]>
- Defined in ../home/runner/work/marmot-ts/marmot-ts/src/client/key-package-store.ts:315

Other

`Static`prefixed

prefixed: string | boolean

addListener

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

emit

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

eventNames

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

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

listenerCount

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

listeners

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

off

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

on

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

once

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

removeAllListeners

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

removeListener

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

Class KeyPackageStore

Hierarchy

Index

Client - Key Package Manager

Other

Client - Key Package Manager

constructor

Parameters

Returns KeyPackageStore

add

Parameters

Returns Promise<string>

addPublished

Parameters

Returns Promise<void>

clear

Returns Promise<void>

count

Returns Promise<number>

get

Parameters

Returns Promise<StoredKeyPackage | null>

getPrivateKey

Parameters

Returns Promise<PrivateKeyPackage | null>

has

Parameters

Returns Promise<boolean>

list

Returns Promise<ListedKeyPackage[]>

markUsed

Parameters

Returns Promise<void>

remove

Parameters

Returns Promise<void>

snapshot

Returns Promise<ListedKeyPackage[]>

Other

Staticprefixed

addListener

Type Parameters

Parameters

Returns this

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (keyof KeyPackageStoreEvents)[]

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ( ( ...args: ArgumentMap<KeyPackageStoreEvents>[Extract< T, keyof KeyPackageStoreEvents, >], ) => 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<KeyPackageStoreEvents>[Extract<
T,
keyof KeyPackageStoreEvents,
>],
) => void
)[]