Skip to main content

KeyStoreJson class

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

An implementation of AbstractKeyStore that uses a JSON object to store the relationships between keys, their IDs, aliases and KMS implementations, as they are known and managed by a Veramo agent.

An instance of this class can be used by KeyManager as the data storage layer.

This class must be initialized with a VeramoJsonStore, which serves as the JSON object storing data in memory as well as providing an update notification callback to persist this data. For correct usage, this MUST use the same VeramoJsonStore instance as the one used by DIDManager.

This API may change without a BREAKING CHANGE notice.

Signature:

export declare class KeyStoreJson extends AbstractKeyStore

Extends: AbstractKeyStore

Constructors

ConstructorModifiersDescription
(constructor)(jsonStore)(BETA) Constructs a new instance of the KeyStoreJson class

Methods

MethodModifiersDescription
deleteKey({ kid })(BETA)
getKey({ kid })(BETA)
importKey(args)(BETA)
listKeys(args)(BETA)