update API

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

diff --git a/src/api/config.js b/src/api/config.js
index f05b612..73189f5 100644 (file)
--- a/src/api/config.js
+++ b/src/api/config.js
@@ -5,20 +5,20 @@
  * More info: {}
  * @typedef {Object} CoreInfo
  *
- * @property {Boolean} listening, whether the node is listening.
- * @property {Boolean} syncing, whether the node is syncing.
- * @property {Boolean} mining, whether the node is mining.
- * @property {Integer} peer_count, current count of connected peers.
- * @property {Integer} current_block, current block height in the node's blockchain.
- * @property {Integer} highest_block, current highest block of the connected peers.
- * @property {String} network_id, network id.
- * @property {Object} version_info, bytomd version information:
- * @property {String} version, current version of the running bytomd.
- * @property {uint16} update, whether there exists an update.
+ * @property {Boolean} listening whether the node is listening.
+ * @property {Boolean} syncing whether the node is syncing.
+ * @property {Boolean} mining whether the node is mining.
+ * @property {Integer} peer_count current count of connected peers.
+ * @property {Integer} current_block current block height in the node's blockchain.
+ * @property {Integer} highest_block current highest block of the connected peers.
+ * @property {String} network_id network id.
+ * @property {Object} version_info bytomd version information:
+ * @property {String} version current version of the running bytomd.
+ * @property {uint16} update whether there exists an update.
  *                      0: no update;
  *                      1: small update;
  *                      2: significant update.
- * @property {String} new_version, the newest version of bytomd if there is one.
+ * @property {String} new_version the newest version of bytomd if there is one.
  */
 
 /**
@@ -26,6 +26,7 @@
  * existing blockchain network.
  *
  * More info: {}
+ * API for interacting with {@link Config configs}.
  * @module ConfigApi
  */
 const configAPI = (connection) => {
@@ -40,19 +41,18 @@ const configAPI = (connection) => {
     /**
      * Get info on specified Bytom Core.
      *
-     * @param {objectCallback} [callback] - Optional callback. Use instead of Promise return value as desired.
-     * @returns {Promise<CoreInfo>} Requested info of specified Bytom Core.
+     * @returns {Promise<CoreInfo>} Requested Net Info of specified Bytom Core.
      */
     netInfo: () => connection.request('/net-info',{}),
 
     /**
      *
      * @param params
-     * @param {String} params.address, address for account.
-     * @param {String} params.derived_xpub, derived xpub.
-     * @param {String} params.message, message for signature by derived_xpub.
-     * @param {String} params.signature, signature for message.
-     * @returns {*|AxiosPromise<any>}
+     * @param {String} params.address address for account.
+     * @param {String} params.derived_xpub derived xpub.
+     * @param {String} params.message message for signature by derived_xpub.
+     * @param {String} params.signature signature for message.
+     * @returns {Promise<Object>} [Boolean] result, verify result.
      */
     verifyMessage: (params) => connection.request('verify-message', params)
   }