style(addresses): [refactor] Remove extra methods in lieu of single getBalance multipurpose method

Author: taylorjdawson

dist/web3data.min.js

@@ -412,6 +412,7 @@ Returns null if no address is found.
 | ---- | ---- | ----------- | -------- |
 | hash | `string`  |  The address of the account. |   |
 | filterOptions | `object`  |  The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#getcurrentaccountbalance) for more details. | *Optional* |
+| filterOptions.includeTokens=false | `object`  |  Return the token balances that the address is holding. | *Optional* |
 
 
 
@@ -432,177 +433,6 @@ const balance = await web3data.address.getBalance('0x06012c8cf97bead5deae237070f
 
 
 
-#### getLatestBalance(hash[, filterOptions])
-
-
-Retrieves the latest balance data of the given address. Returns null if no address is found.
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| hash | `string`  |  The address of the account. |   |
-| filterOptions | `object`  |  The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#getcurrentaccountbalance) for more details. | *Optional* |
-
-
-
-
-##### Examples
-
-```javascript
-const latestBalance = await web3data.address.getLatestBalance('0x06012c8cf97bead5deae237070f9587f8e7a266d')
-```
-
-
-##### Returns
-
-
-- `Promise.<object>`  The balance data of the account or if no address is found.
-
-
-
-
-
-#### getHistoricalBalance(hash[, filterOptions])
-
-
-Retrieves the historical balance data of the given address. Returns null if no address is found.
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| hash | `string`  |  The address of the account. | &nbsp; |
-| filterOptions | `object`  |  The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#gethistoricalaccountbalance) for more details. | *Optional* |
-
-
-
-
-##### Examples
-
-```javascript
-const historicalBalance = await web3data.address.getHistoricalBalance('0x06012c8cf97bead5deae237070f9587f8e7a266d')
-```
-
-
-##### Returns
-
-
-- `Promise.<object>`  The historical balance data of the account or if no address is found.
-
-
-
-
-
-#### getMultipleBalances(hashes[, filterOptions])
-
-
-Retrieves the latest account and token balances for the specified address(es).
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| hashes | `Array`  |  The array or string containing the address(es) of the account. | &nbsp; |
-| filterOptions | `object`  |  The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#accountbalances) for more details. | *Optional* |
-
-
-
-
-##### Examples
-
-```javascript
-const balances = await web3data.address.getMultipleBalances(['0x06012c8cf97bead5deae237070f9587f8e7a266d', '0x3f5ce5fbfe3e9af3971dd833d26ba9b5c936f0be'])
-```
-
-
-##### Returns
-
-
-- `Promise.<object>`  The balance data of the account(s).
-
-
-
-
-
-#### getBalances(hash[, filterOptions])
-
-
-Retrieves the latest account and token balances for the specified address.
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| hash | `string`  |  The address of the account. | &nbsp; |
-| filterOptions | `object`  |  The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#accountbalances) for more details. | *Optional* |
-
-
-
-
-##### Examples
-
-```javascript
-const balances = await web3data.address.getBalances('0x06012c8cf97bead5deae237070f9587f8e7a266d')
-```
-
-
-##### Returns
-
-
-- `Promise.<object>`  The balance data of the account.
-
-
-
-
-
-#### getBalancesBatch(hashes[, filterOptions])
-
-
-Retrieves the latest account and token balances for the specified addresses.
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| hashes | `string`  |  The array containing the address(es) of the account. | &nbsp; |
-| filterOptions | `object`  |  The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#accountbalancesbatch) for more details. | *Optional* |
-
-
-
-
-##### Examples
-
-```javascript
-const balanceBatch = await web3data.addresses.getBalancesBatch(['0x3f5ce5fbfe3e9af3971dd833d26ba9b5c936f0be', '0x06012c8cf97bead5deae237070f9587f8e7a266d'], { includePrice: true
-})
-```
-
-
-##### Returns
-
-
-- `Promise.<object>`  The balance data of the account(s).
-
-
-
-
-
 #### getTokens(hash[, filterOptions])
 
 

docs/api.md

@@ -214,110 +214,27 @@ Returns null if no address is found.
    *
    * @param {string} hash - The address of the account.
    * @param {object} [filterOptions] - The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#get-current-account-balance) for more details.
+   * @param {object} [filterOptions.includeTokens=false] - Return the token balances that the address is holding.
    * @returns {Promise<object>} The balance data of the account or if no address is found.
    * @example
    * const balance = await web3data.address.getBalance('0x06012c8cf97bead5deae237070f9587f8e7a266d')
    */
   getBalance(hash, filterOptions = {}) {
     throwIf(is.notHash(hash), NO_ADDRESS)
-    return filterOptions.startDate || filterOptions.endDate
-      ? this.web3data.address
-          .getHistoricalBalance(hash, filterOptions)
-          .then(data => data)
-      : this.web3data.address
-          .getLatestBalance(hash, filterOptions)
-          .then(data => data)
-  }
+    let subendpoint = 'information'
 
-  /**
-   * Retrieves the latest balance data of the given address. Returns null if no address is found.
-   *
-   * @param {string} hash - The address of the account.
-   * @param {object} [filterOptions] - The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#get-current-account-balance) for more details.
-   * @returns {Promise<object>} The balance data of the account or if no address is found.
-   * @example
-   * const latestBalance = await web3data.address.getLatestBalance('0x06012c8cf97bead5deae237070f9587f8e7a266d')
-   */
-  getLatestBalance(hash, filterOptions = {}) {
-    throwIf(is.notHash(hash), NO_ADDRESS)
-    return get(this.web3data, {
-      hash,
-      endpoint: ENDPOINT,
-      subendpoint: 'account-balances/latest',
-      filterOptions
-    }).then(onFulfilled, onError)
-  }
+    if (Array.isArray(hash)) {
+      subendpoint = 'balances'
+      filterOptions.addresses = hash
+    } else if (filterOptions.includeTokens) subendpoint = 'balances'
+    else if (filterOptions.startDate || filterOptions.endDate)
+      subendpoint = 'account-balances/historical'
 
-  /**
-   * Retrieves the historical balance data of the given address. Returns null if no address is found.
-   *
-   * @param {string} hash - The address of the account.
-   * @param {object} [filterOptions] - The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#get-historical-account-balance) for more details.
-   * @returns {Promise<object>} The historical balance data of the account or if no address is found.
-   * @example
-   * const historicalBalance = await web3data.address.getHistoricalBalance('0x06012c8cf97bead5deae237070f9587f8e7a266d')
-   */
-  getHistoricalBalance(hash, filterOptions = {}) {
-    throwIf(is.notHash(hash), NO_ADDRESS)
-    return get(this.web3data, {
-      hash,
-      endpoint: ENDPOINT,
-      subendpoint: 'account-balances/historical',
-      filterOptions
-    }).then(onFulfilled, onError)
-  }
-
-  /**
-   * Retrieves the latest account and token balances for the specified address(es).
-   *
-   * @param {Array} hashes - The array or string containing the address(es) of the account.
-   * @param {object} [filterOptions] - The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#account-balances) for more details.
-   * @returns {Promise<object>} The balance data of the account(s).
-   * @example
-   * const balances = await web3data.address.getMultipleBalances(['0x06012c8cf97bead5deae237070f9587f8e7a266d', '0x3f5ce5fbfe3e9af3971dd833d26ba9b5c936f0be'])
-   */
-  getMultipleBalances(hashes, filterOptions = {}) {
-    return Array.isArray(hashes)
-      ? this.web3data.address.getBalancesBatch(hashes, filterOptions)
-      : this.web3data.address.getBalances(hashes, filterOptions)
-  }
-
-  /**
-   * Retrieves the latest account and token balances for the specified address.
-   *
-   * @param {string} hash - The address of the account.
-   * @param {object} [filterOptions] - The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#account-balances) for more details.
-   * @returns {Promise<object>} The balance data of the account.
-   * @example
-   * const balances = await web3data.address.getBalances('0x06012c8cf97bead5deae237070f9587f8e7a266d')
-   */
-  getBalances(hash, filterOptions = {}) {
-    throwIf(is.notHash(hash), NO_ADDRESS)
-    return get(this.web3data, {
-      hash,
-      endpoint: ENDPOINT,
-      subendpoint: 'balances',
-      filterOptions
-    }).then(onFulfilled, onError)
-  }
-
-  /**
-   * Retrieves the latest account and token balances for the specified addresses.
-   *
-   * @param {string} hashes - The array containing the address(es) of the account.
-   * @param {object} [filterOptions] - The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#account-balances-batch) for more details.
-   * @returns {Promise<object>} The balance data of the account(s).
-   * @example const balanceBatch = await web3data.addresses.getBalancesBatch(['0x3f5ce5fbfe3e9af3971dd833d26ba9b5c936f0be', '0x06012c8cf97bead5deae237070f9587f8e7a266d'], {
-   * includePrice: true
-   * })
-   */
-  getBalancesBatch(hashes, filterOptions = {}) {
-    throwIf(!Array.isArray(hashes), 'Must be array of valid address hashes')
-    hashes.forEach(hash => throwIf(is.notHash(hash), NO_ADDRESS))
-    filterOptions.addresses = hashes
     return get(this.web3data, {
+      // Include 'hash' only if filterOptions.addresses not defined
+      ...(filterOptions.addresses ? {} : {hash}),
       endpoint: ENDPOINT,
-      subendpoint: 'balances',
+      subendpoint,
       filterOptions
     }).then(onFulfilled, onError)
   }

src/address.js

@@ -60,7 +60,8 @@ module.exports.ETH_METHODS = {
   getTransactions: 'block',
   getTransaction: 'transaction',
   getPendingTransactions: 'transaction',
-  getEtherPrice: 'market'
+  getEtherPrice: 'market',
+  getBalance: 'address'
 }
 
 module.exports.BTC_METHODS = {
@@ -71,10 +72,6 @@ module.exports.BTC_METHODS = {
     'getTransactions',
     'getPendingTransactions',
     'getBalance',
-    'getLatestBalance',
-    'getHistoricalBalance',
-    'getMultipleBalances',
-    'getBalancesBatch',
     'getMetrics'
   ],
   block: [
@@ -96,10 +93,6 @@ module.exports.LTC_METHODS = {
     'getTransactions',
     'getPendingTransactions',
     'getBalance',
-    'getLatestBalance',
-    'getHistoricalBalance',
-    'getMultipleBalances',
-    'getBalancesBatch',
     'getMetrics'
   ],
   block: [

src/constants.js

@@ -1,4 +1,4 @@
-const {throwIf, ethFactory} = require('./utils')
+const {ethFactory} = require('./utils')
 const {BLOCKCHAIN_ID_ETHEREUM_MAINNET: BLOCKCHAIN_ID} = require('./constants')
 
 /**
@@ -22,25 +22,6 @@ class Eth {
     }
   }
 
-  /**
-   * Returns the balance of the account in wei or null if the account doesn't
-exist.
-   *
-   * @param hash - The address of the account.
-   * @returns Promise<object> - The balance or null if it doesn't exist.
-   * @example
-   */
-  async getBalance(hash) {
-    let balance
-    try {
-      balance = await this.web3data.address.getBalance(hash)
-    } catch (error) {
-      throwIf(true, error.message)
-    }
-
-    return balance && balance.value ? balance.value : null
-  }
-
   /* See Web3Data class for details on rpc method */
   rpc(method, params) {
     return this.web3data.rpc(method, params)

src/eth.js

@@ -24,6 +24,7 @@ const WebSocketClient = require('./websocket')
 
 /**
  * Contains common methods used in.
+ *
  * @private
  */
 class Web3DataFactory {