style(transactions): [refactor] standardize methods implementation + responses

Author: taylorjdawson

dist/web3data.min.js

@@ -729,7 +729,7 @@ const orders = await web3data.market.getOrders('eth_usd', ['bitfinex', 'bitstamp
 
 
 
-#### getOrderBooks(pair[, filterOptions])
+#### getOrderBooks(pair, filterOptions)
 
 
 Retrieves order book update events.
@@ -741,8 +741,8 @@ Retrieves order book update events.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| pair | `string`  |  The market pair for which to retrieve the historical best bid and offer data. |   |
-| filterOptions | `object`  |  See [docs](https://docs.amberdata.io/reference#orderbookupdates) for complete list of filters. | *Optional* |
+| pair |  |  The market pair for which to retrieve the historical best bid and offer data. |   |
+| filterOptions |  |  See [docs](https://docs.amberdata.io/reference#orderbookupdates) for complete list of filters. |   |
 
 
 
@@ -982,6 +982,49 @@ const batTokenAddress = web3data.market.getAssetAddresses('bat') const assetAddr
 
 
 
+### src/utils.js
+
+
+
+#### get(web3data, subendpoint, endpoint, hash, pathParam, filterOptions)
+
+
+Builds the endpoint url to pass to .rawQuery(). Checks for non empties and appends
+the appropriate parameter(s) where applicable.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| web3data |  |  Instance on which to call .rawQuery(). |   |
+| subendpoint |  |  The subendpoint. |   |
+| endpoint |  |  The endpoint. |   |
+| hash |  |  The address hash. |   |
+| pathParam |  |  The path parameter. |   |
+| filterOptions |  |  The filters associated with a given endpoint. |   |
+
+
+
+
+##### Examples
+
+```javascript
+
+```
+
+
+##### Returns
+
+
+-  Returns a Promise of the rawQuery request from web3data.
+
+
+
+
+
 ### src/web3data.js
 
 
@@ -1118,49 +1161,6 @@ API endpoints.
 
 
 
-### src/utils.js
-
-
-
-#### get(web3data, subendpoint, endpoint, hash, pathParam, filterOptions)
-
-
-Builds the endpoint url to pass to .rawQuery(). Checks for non empties and appends
-the appropriate parameter(s) where applicable.
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| web3data |  |  Instance on which to call .rawQuery(). |   |
-| subendpoint |  |  The subendpoint. |   |
-| endpoint |  |  The endpoint. |   |
-| hash |  |  The address hash. |   |
-| pathParam |  |  The path parameter. |   |
-| filterOptions |  |  The filters associated with a given endpoint. |   |
-
-
-
-
-##### Examples
-
-```javascript
-
-```
-
-
-##### Returns
-
-
--  Returns a Promise of the rawQuery request from web3data.
-
-
-
-
-
 ### src/websocket.js
 
 

dist/web3data.min.js.map

@@ -159,8 +159,8 @@ class Market {
   /**
    * Retrieves order book update events.
    *
-   * @param {string} pair - The market pair for which to retrieve the historical best bid and offer data.
-   * @param {object} [filterOptions] - See [docs](https://docs.amberdata.io/reference#order-book-updates) for complete list of filters.
+   * @param pair - The market pair for which to retrieve the historical best bid and offer data.
+   * @param [filterOptions] - See [docs](https://docs.amberdata.io/reference#order-book-updates) for complete list of filters.
    * @returns The order book update data.
    * @example const orderBooks = await web3data.market.getOrderBooks('btc_usd')
    */

docs/api.md

@@ -3,80 +3,56 @@ const {
   ERROR_MESSAGE_TRANSACTION_NO_HASH: NO_HASH
 } = require('./constants')
 
-const {is, get, onFulfilled, onError} = require('./utils')
+const {is, get, onFulfilled, onError, throwIf} = require('./utils')
 
 class Transaction {
   constructor(web3data) {
     this.web3data = web3data
   }
 
-  async getTransactions(filterOptions) {
-    const response = await get(this.web3data, {
+  getTransactions(filterOptions) {
+    return get(this.web3data, {
       endpoint: ENDPOINT,
       filterOptions
-    })
-    return new Promise((resolve, reject) => {
-      if (
-        !response ||
-        response.status !== 200 ||
-        !response.payload ||
-        !response.payload.records
-      ) {
-        reject(new Error('Failed to retrieve transactions.'))
-      } else {
-        resolve(response.payload.records)
-      }
-    })
+    }).then(onFulfilled, onError)
   }
 
-  async getTransaction(hash, filterOptions) {
-    if (!hash) return Promise.reject(new Error(NO_HASH))
-    const response = await get(this.web3data, {
+  getTransaction(hash, filterOptions) {
+    throwIf(is.notHash(hash), NO_HASH)
+    return get(this.web3data, {
       pathParam: hash,
       endpoint: ENDPOINT,
       filterOptions
-    })
-    return new Promise((resolve, reject) => {
-      if (!response || response.status !== 200 || !response.payload) {
-        reject(new Error('Failed to retrieve transaction.'))
-      } else {
-        resolve(response.payload)
-      }
-    })
+    }).then(onFulfilled, onError)
   }
 
-  async getPendingTransactions() {
-    const pendingTransactions = await this.getTransactions({status: 'pending'})
-    return new Promise((resolve, reject) => {
-      if (is.undefined(pendingTransactions) || is.null(pendingTransactions)) {
-        reject(new Error('Failed to retrieve pending transactions.'))
-      } else {
-        resolve(pendingTransactions)
-      }
-    })
+  getPendingTransactions() {
+    return this.getTransactions({status: 'pending'}).then(
+      pendingTransactions => {
+        throwIf(
+          is.undefined(pendingTransactions) || is.null(pendingTransactions),
+          'Failed to retrieve pending transactions.'
+        )
+        return pendingTransactions
+      },
+      console.error
+    )
   }
 
   getGasPrediction() {
     return get(this.web3data, {
       endpoint: ENDPOINT,
       subendpoint: 'gas/predictions'
-    })
+    }).then(onFulfilled, onError)
   }
 
-  async getGasPrice() {
-    const response = await this.getGasPrediction()
-    return new Promise((resolve, reject) => {
-      if (
-        is.null(response) ||
-        is.undefined(response) ||
-        response.status !== 200
-      ) {
-        reject(new Error('Failed to retrieve gas price.'))
-      } else if (!response.payload || !response.payload.average) {
-        reject(new Error('Failed to retrieve gas price.'))
-      } else {
-        resolve(`${response.payload.average.gasPrice}`)
-      }
+  getGasPrice() {
+    return this.getGasPrediction().then(gasPrediction => {
+      throwIf(
+        !gasPrediction.average || !gasPrediction.average.gasPrice,
+        'Failed to retrieve gas price.'
+      )
+      return `${gasPrediction.average.gasPrice}`
     })
   }