Node.js SDK for Bytom protocol
修订版 | 795ee7a21afe461426dda24e3a1032a1048c6402 (tree) |
---|---|
时间 | 2018-05-15 20:40:54 |
作者 | Yongfeng LI <wliyongfeng@gmai...> |
Commiter | Yongfeng LI |
improve assets api doc
@@ -69,7 +69,7 @@ const assetsApi = (connection) => { | ||
69 | 69 | * @param {module:AssetsApi~quorum} quorum - The number of keys required to sign transactions for the account. |
70 | 70 | * @param {module:AssetsApi~alias} alias - Asset alias. |
71 | 71 | * @param {module:AssetsApi~definition} definition - Asset definition. |
72 | - * @returns {Promise<Response>} Newly created asset response. | |
72 | + * @returns {Promise<Asset>} Newly created asset. | |
73 | 73 | */ |
74 | 74 | create: (xpubs, quorum, alias, definition) => connection.request('/create-asset', { |
75 | 75 | alias, |
@@ -81,26 +81,25 @@ const assetsApi = (connection) => { | ||
81 | 81 | /** |
82 | 82 | * List all assets in one Bytom node. |
83 | 83 | * |
84 | - * @returns {Promise<Response>} target assets response. | |
84 | + * @returns {Promise<Array<Asset>>} target assets. | |
85 | 85 | */ |
86 | - listAssets: () => connection.request('/list-assets', {}), | |
86 | + list: () => connection.request('/list-assets', {}), | |
87 | 87 | |
88 | 88 | /** |
89 | 89 | * Get asset by the asset id. |
90 | 90 | * |
91 | 91 | * @param {module:AssetsApi~id} id - Asset id. |
92 | - * @returns {Promise<Response>} target asset response. | |
92 | + * @returns {Promise<Asset>} target asset. | |
93 | 93 | */ |
94 | - getAsset: (id) => connection.request('/get-asset', {id}), | |
94 | + getById: (id) => connection.request('/get-asset', {id}), | |
95 | 95 | |
96 | 96 | /** |
97 | 97 | * Update asset alias. |
98 | 98 | * |
99 | 99 | * @param {module:AssetsApi~id} id - Asset id. |
100 | 100 | * @param {String} newAlias - new alias. |
101 | - * @returns {Promise<Response>} update response. | |
102 | 101 | */ |
103 | - updateAssetAlias: (id, newAlias) => connection.request('/update-asset-alias', {id, alias: newAlias}) | |
102 | + updateAlias: (id, newAlias) => connection.request('/update-asset-alias', {id, alias: newAlias}) | |
104 | 103 | } |
105 | 104 | } |
106 | 105 |