Module: KeysApi

API for interacting with keys.

Methods


<inner> checkPassword(params)

Reset key password.

Parameters:
Name Type Description
params Object

Password checking information.

Properties
Name Type Description
xpub String

Hex-encoded string representation of the key.

password String

password.


<inner> create(params)

Create a new key.

Parameters:
Name Type Description
params module:KeysApi~createRequest

Parameters for asset creation.

Returns:

Newly created key.

Type
Promise.<Key>

<inner> delete(params)

Parameters:
Name Type Description
params Object

Deletion information.

Properties
Name Type Description
xpub String

Hex-encoded string representation of the key.

password String

Key password.


<inner> listAll()

Got all the keys in one Bytom node.

Returns:

All keys.

Type
Promise.<Array.<Key>>

<inner> resetPassword(params)

Reset key password.

Parameters:
Name Type Description
params Object

Key password reset information.

Properties
Name Type Description
xpub String

Hex-encoded string representation of the key.

oldPassword String

Old password.

newPassword String

New password.

Type Definitions


createRequest

Type:
  • Object
Properties:
Name Type Argument Description
alias String <optional>

User specified, unique identifier.

password String <optional>

password of the key.

language String <optional>

mnemonic language of the key.