update node-sdk

[bytom/bytom-node-sdk.git] / src / api / keys.js

diff --git a/src/api/keys.js b/src/api/keys.js
index 638b2ed..ad9ed8d 100644 (file)
--- a/src/api/keys.js
+++ b/src/api/keys.js
@@ -18,41 +18,62 @@
  * @module KeysApi
  */
 const keysApi = connection => {
+  /**
+   * @typedef {Object} createRequest
+   *
+   * @property {String} [alias]
+   * User specified, unique identifier.
+   *
+   * @property {String} [password]
+   * password of the key.
+   *
+   * @property {String} [language]
+   * mnemonic language of the key.
+   *
+   * @option params [String] mnemonic
+   * mnemonic of the key, create key by specified mnemonic.
+   */
+
   return {
     /**
      * Create a new key.
      *
-     * @param {String} alias - User specified, unique identifier.
-     * @param {String} password - User specified, key password.
+     * @param {module:KeysApi~createRequest} params - Parameters for asset creation.
      * @returns {Promise<Key>} Newly created key.
      */
-    create: (alias, password) => connection.request('/create-key', {alias, password}),
+    create: (params) => connection.request('/create-key', params),
 
     /**
      * Got all the keys in one Bytom node.
      * @returns {Promise<Array<Key>>} All keys.
      */
-    list: () => connection.request('/list-keys'),
+    listAll: () => connection.request('/list-keys'),
 
     /**
+     * @param {Object} params={} - Deletion information.
+     * @param {String} params.xpub - Hex-encoded string representation of the key.
+     * @param {String} params.password - Key password.
+     */
+    delete: (params) => connection.request('/delete-key', params),
+
+    /**
+     * Reset key password.
      *
-     * @param {String} xpub - Hex-encoded string representation of the key.
-     * @param {String} password - Key password.
+     * @param {Object} params={} - Password checking information.
+     * @param {String} params.xpub - Hex-encoded string representation of the key.
+     * @param {String} params.password - password.
      */
-    delete: (xpub, password) => connection.request('/delete-key', {xpub, password}),
+    checkPassword: (params) => connection.request('/check-key-password', params),
 
     /**
      * Reset key password.
      *
-     * @param {String} xpub - Hex-encoded string representation of the key.
-     * @param {String} oldPassword - Old password.
-     * @param {String} newPassword - New password.
+     * @param {Object} params={} - Key password reset information.
+     * @param {String} params.xpub - Hex-encoded string representation of the key.
+     * @param {String} params.oldPassword - Old password.
+     * @param {String} params.newPassword - New password.
      */
-    resetPassword: (xpub, oldPassword, newPassword) => connection.request('/reset-key-password', {
-      xpub,
-      old_password: oldPassword,
-      new_password: newPassword
-    })
+    resetPassword: (params) => connection.request('/reset-key-password', params)
   }
 }