From: Yongfeng LI <wliyongfeng@gmail.com>
Date: Mon, 14 May 2018 02:01:59 +0000 (+0800)
Subject: fix accountsApi doc
X-Git-Tag: v1.0.1~34
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;ds=sidebyside;h=4e92dbbd75b250426d889b092cc13e5319e1d262;p=bytom%2Fbytom-node-sdk.git

fix accountsApi doc
---

diff --git a/src/api/accounts.js b/src/api/accounts.js
new file mode 100644
index 0000000..196f6fb
--- /dev/null
+++ b/src/api/accounts.js
@@ -0,0 +1,110 @@
+/**
+ * An account is an object in Bytom that tracks ownership of assets on a
+ * blockchain.
+ *
+ * @typedef {Object} Account
+ * @global
+ *
+ * @property {String} id
+ * Unique account identifier in one Bytom node.
+ *
+ * @property {String} alias
+ * User specified, unique identifier in one Bytom node.
+ *
+ * @property {Key[]} keys
+ * The list of keys used to create control programs under the account.
+ * Signatures from these keys are required for spending funds held in the account.
+ *
+ * @property {Number} quorum
+ * The number of keys required to sign transactions for the account.
+ */
+
+/**
+ * API for interacting with {@link Account accounts}.
+ *
+ * @module AccountsApi
+ */
+const Accounts = (connection) => {
+  /**
+   * @typedef {String[]} xpubs
+   * The list of keys used to create control programs under the account.
+   */
+
+  /**
+   * @typedef {String} [alias]
+   * User specified, unique identifier.
+   */
+
+  /**
+   * @typedef {Number} quorum
+   * The number of keys required to sign transactions for the account.
+   */
+
+  /**
+   * @typedef {String} id
+   * Unique account identifier in one Bytom node.
+   */
+
+  return {
+    /**
+     * Create a new account.
+     *
+     * @param {module:AccountsApi~xpubs} xpubs - Keys for account creation.
+     * @param {module:AccountsApi~quorum} quorum - The number of keys required to sign transactions for the account.
+     * @param {module:AccountsApi~alias} alias - Account alias.
+     * @returns {Promise<Response>} Newly created account response.
+     */
+    create(xpubs, quorum, alias) {
+      this.connection.request('/create-account', {
+        root_xpubs: xpubs,
+        quorum,
+        alias
+      })
+    },
+
+    /**
+     * List accounts whose id starts with the given id.
+     *
+     * @param {module:AccountsApi~id} id - Account id prefix.
+     * @return {Promise<Response>} target accounts response.
+     */
+    listAccounts(id) {
+      this.connection.request('/list-accounts', {id})
+    },
+
+    /**
+     * Create account receiver.
+     *
+     * @param {module:AccountsApi~id} accountId - Id for the target account.
+     * @return {Promise<Response>} target receiver response.
+     */
+    createReceiverById(accountId) {
+      this.connection.request('/create-account-receiver', {
+        account_id: accountId
+      })
+    },
+
+    /**
+     * List all addresses for one account.
+     * @param {module:AccountsApi~id} accountId - Id for the target account.
+     * @return {Promise<Response>} target addresses response.
+     */
+    listAddressesById(accountId) {
+      this.connection.request('/list-addresses', {
+        account_id: accountId
+      })
+    },
+
+    /**
+     * Delete account.
+     * @param {module:AccountsApi~id} id - Target account id.
+     */
+    deleteById(id) {
+      this.connection.request('/delete-account', {
+        account_info: id
+      })
+    }
+  }
+}
+
+export default Accounts
diff --git a/src/api/accountsApi.js b/src/api/accountsApi.js
deleted file mode 100644
index fe38db9..0000000
--- a/src/api/accountsApi.js
+++ /dev/null
@@ -1,66 +0,0 @@
-import ApiBase from './base'
-
-/**
- * An account is an object in Bytom that tracks ownership of assets on a
- * blockchain.
- *
- * @typedef {Object} Account
- * @global
- *
- * @property {String} id
- * Unique account identifier in one Bytom node.
- *
- * @property {String} alias
- * User specified, unique identifier in one Bytom node.
- *
- * @property {Key[]} keys
- * The list of keys used to create control programs under the account.
- * Signatures from these keys are required for spending funds held in the account.
- *
- * @property {Number} quorum
- * The number of keys required to sign transactions for the account.
- *
- */
-
-/**
- * API for interacting with {@link Account accounts}.
- *
- * @module AccountsApi
- */
-class AccountsApi {
-  constructor(connection) {
-    this.connection = connection
-  }
-
-  create(xpubs, quorum, alias) {
-    this.connection.request('/create-account', {
-      root_xpubs: xpubs,
-      quorum,
-      alias
-    })
-  }
-
-  listAccounts(id) {
-    this.connection.request('/list-accounts', {id})
-  }
-
-  createReceiverById(accountId) {
-    this.connection.request('/create-account-receiver', {
-      account_id: accountId
-    })
-  }
-
-  listAddressesById(accountId) {
-    this.connection.request('/list-addresses', {
-      account_id: accountId
-    })
-  }
-
-  deleteById(id) {
-    this.connection.request('/delete-account', {
-      account_info: id
-    })
-  }
-}
-
-export default AccountsApi