Module: KeyStore

Provides a local key manager for OrbitDB.

Source:

Examples

Create a keystore with defaults.

const keystore = await KeyStore()

Create a keystore with custom storage.

const storage = await MemoryStorage()
const keystore = await KeyStore({ storage })

Namespaces

KeyStore

Methods

(async) KeyStore(params) → {module:KeyStore~KeyStore}

Creates an instance of KeyStore.

Parameters:
Name Type Description
params Object

One or more parameters for configuring KeyStore.

Properties
Name Type Attributes Default Description
storage Object <optional>

An instance of a storage class. Can be one of ComposedStorage, IPFSBlockStorage, LevelStorage, etc. Defaults to ComposedStorage.

path string <optional>
./keystore

The path to a valid storage.

Source:
Returns:

An instance of KeyStore.

Type
module:KeyStore~KeyStore