Class

IdKeystore

(async) dcp/wallet.IdKeystore()

Subclass of Keystore

Constructor

# async new IdKeystore()

See Keystore constructor for documentation on all the ways to call this constructor.

Extends

Methods

# async getPrivateKey() → {module:dcp/wallet.PrivateKey}

Returns private key, may prompt for password. If you need this you're probably doing something wrong.

Inherited From:
module:dcp/wallet.PrivateKey

# isLocked() → {boolean}

Is the keystore presently locked?

Inherited From:
boolean

# isUnlocked() → {boolean}

Is the keystore presently unlocked?

Inherited From:
boolean

# lock()

Lock the Keystore, the private key is no longer accessible without password entry.

Inherited From:

# async makeSignature(messageBody) → {Promise.<Signature>}

Creates and returns signature for messageBody { owner: this.address, signature: signature, auth: messageLightWeight, body: messageBody }; The signature is computed only on messageLightWeight, in order to improve perf when messageBody is large.

Parameters:
Name Type Description
messageBody object
Inherited From:
Promise.<Signature>

# async makeSignedLightWeightMessageObject(messageLightWeight, messageBody) → {Promise.<SignedLightWeightMessageObject>}

Creates and returns SignedLightWeightMessageObject in the format: { owner: this.address, signature: signature, auth: messageLightWeight, body: messageBody }; The signature is computed only on messageLightWeight, in order to improve perf when messageBody is large.

Parameters:
Name Type Description
messageLightWeight object
messageBody object
Inherited From:
Promise.<SignedLightWeightMessageObject>

# async makeSignedMessage(messageBody) → {Promise.<string>}

Creates and returns stringification of SignedMessageObject in the format: JSON.stringify({ owner: this.address, signature: signature, body: messageBody })

Parameters:
Name Type Description
messageBody object
Inherited From:
Promise.<string>

# async makeSignedMessageObject(messageBody) → {Promise.<SignedMessageObject>}

Creates and returns stringification of SignedMessageObject in the format: { owner: this.address, signature: signature, body: messageBody }

Parameters:
Name Type Description
messageBody object
Inherited From:
Promise.<SignedMessageObject>

# toJSON() → {object}

Generate JSON object literal representation of this keystore. This can later be passed to the constructor to generate a new Keystore object.

Inherited From:
object

# async unlock(passphraseopt, lockTimerDuration, autoResetopt)

This method unlocks the Keystore object for either a single use or a given amount of time. When the object is unlocked, getPrivateKey and related operations do not need to ask for a passphrase, as the private key is "remembered" internally. If time is not specified, the object will be immediately locked after the next call to getPrivateKey; otherwise, it will remain unlocked until the timer runs out.

When the unlock timer is running, calling unlock can have multiple effects. In all cases the current running timer will be increased to lockTimerDuration if that will increase the time left.

  1. If the autoReset flag is true for this invocation, the autoReset duration is updated only if it will be increased. Thus autoReset is a sticky setting, it can be turned on but not off (except by locking)
  2. If the autoReset flag is false for this invocation, the current unlock duration is increased, but the autoReset duration remains the same.
Parameters:
Name Type Attributes Description
passphrase string <optional>

Passphrase to unlock keystore. If null|undefined, passphrasePrompt function is invoked to solicit it from the user if the keystore is not already unlocked.
lockTimerDuration number

Number of seconds to keep keystore unlocked for. Intended to implement features like sudo
autoReset boolean <optional>

Flag to determine if unlock timer should reset on subsequent calls.
Inherited From:

Error with code "KS_NOT_UNLOCKED" when keystore could not be unlocked.