feat(tokens): [Method] getTransfers - Add docs + tests.

Author: taylorjdawson

dist/web3data.min.js

@@ -1740,7 +1740,7 @@ const historicalSupplies = await t.context.web3data.token.getSupplies('0x06012c8
 #### getTransfers(hash[, filterOptions])
 
 
-
+Retrieves all token transfers involving the specified address.
 
 
 
@@ -1749,7 +1749,7 @@ const historicalSupplies = await t.context.web3data.token.getSupplies('0x06012c8
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| hash | `string`  |  The address for which to retrieve token holders. |   |
+| hash | `string`  |  The address for which to retrieve token transfers. |   |
 | filterOptions | `object`  |  The filters associated with the request. | *Optional* |
 
 
@@ -1758,90 +1758,14 @@ const historicalSupplies = await t.context.web3data.token.getSupplies('0x06012c8
 ##### Examples
 
 ```javascript
-
+const transfers = await web3data.token.getTransfers('0x06012c8cf97bead5deae237070f9587f8e7a266d', {validationMethod: 'full'})
 ```
 
 
 ##### Returns
 
 
-- `Promise.<object>`  
-
-
-
-
-
-### 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(). | &nbsp; |
-| subendpoint |  |  The subendpoint. | &nbsp; |
-| endpoint |  |  The endpoint. | &nbsp; |
-| hash |  |  The address hash. | &nbsp; |
-| pathParam |  |  The path parameter. | &nbsp; |
-| filterOptions |  |  The filters associated with a given endpoint. | &nbsp; |
-
-
-
-
-##### Examples
-
-```javascript
-
-```
-
-
-##### Returns
-
-
--  Returns a Promise of the rawQuery request from web3data.
-
-
-
-
-
-#### uuid(data)
-
-
-Generates a uuid see [this gist]() for more details.
-
-
-
-
-##### Parameters
-
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| data |  |  | &nbsp; |
-
-
-
-
-##### Examples
-
-```javascript
-
-```
-
-
-##### Returns
-
-
-- `Void`
+- `Promise.<Array>`  All token transfers involving the specified address.
 
 
 
@@ -2177,6 +2101,82 @@ const metrics = await web3data.transaction.getMetrics()
 
 
 
+### 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(). | &nbsp; |
+| subendpoint |  |  The subendpoint. | &nbsp; |
+| endpoint |  |  The endpoint. | &nbsp; |
+| hash |  |  The address hash. | &nbsp; |
+| pathParam |  |  The path parameter. | &nbsp; |
+| filterOptions |  |  The filters associated with a given endpoint. | &nbsp; |
+
+
+
+
+##### Examples
+
+```javascript
+
+```
+
+
+##### Returns
+
+
+-  Returns a Promise of the rawQuery request from web3data.
+
+
+
+
+
+#### uuid(data)
+
+
+Generates a uuid see [this gist]() for more details.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| data |  |  | &nbsp; |
+
+
+
+
+##### Examples
+
+```javascript
+
+```
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+
+
 ### src/web3data.js
 
 

docs/api.md

@@ -1,4 +1,11 @@
-const {is, get, onFulfilled, onError, throwIf} = require('./utils')
+const {
+  is,
+  get,
+  onFulfilled,
+  onError,
+  throwIf,
+  recordsFormatter
+} = require('./utils')
 const {
   ERROR_MESSAGE_TOKEN_NO_ADDRESS: NO_ADDRESS,
   ERROR_MESSAGE_TOKEN_NO_HOLDER_ADDRESS: NO_HOLDER_ADDRESS,
@@ -136,10 +143,13 @@ class Token {
   }
 
   /**
-   * @param {string} hash - The address for which to retrieve token holders.
+   * Retrieves all token transfers involving the specified address.
+   *
+   * @param {string} hash - The address for which to retrieve token transfers.
    * @param {object} [filterOptions] - The filters associated with the request.
-   * @returns {Promise<object>}
+   * @returns {Promise<Array>} All token transfers involving the specified address.
    * @example
+   * const transfers = await web3data.token.getTransfers('0x06012c8cf97bead5deae237070f9587f8e7a266d', {validationMethod: 'full'})
    */
   getTransfers(hash, filterOptions = {}) {
     throwIf(is.notHash(hash), NO_ADDRESS)
@@ -148,7 +158,7 @@ class Token {
       endpoint: ENDPOINT,
       subendpoint: 'transfers',
       filterOptions
-    }).then(onFulfilled, onError)
+    }).then(onFulfilled.bind({formatter: recordsFormatter}), onError)
   }
 }
 

src/token.js

@@ -92,10 +92,6 @@ test('Rejects promise if no holder address supplied', async t => {
     }, { instanceOf: Error, message: NO_HOLDER_ADDRESS })
 });
 
-
-
-test([rejectsPromise], {method: 'getTransfers'}, NO_ADDRESS)
-
 /*********** Test getRankings() ***********/
 test('Successfully calls getRankings()', async t => {
     const {data: [rank1]} = await t.context.web3data.token.getRankings();
@@ -160,3 +156,15 @@ test('Successfully calls getSupplies() - historical with filters', async t => {
     t.is(supplies.metadata.columns[3], 'totalSupply')
     t.true(isISOFormat(supplies.metadata.startDate))
 })
+
+/*********** Test getTransfers() ***********/
+test([rejectsPromise], {method: 'getTransfers'}, NO_ADDRESS)
+test('Successfully calls getTransfers()', async t => {
+    const [transfer] = await t.context.web3data.token.getTransfers(TOKEN_ADDRESS);
+    t.true(transfer.hasProp('transactionHash'))
+})
+test('Successfully calls getTransfers() - with filters', async t => {
+    const [transfer] = await t.context.web3data.token.getTransfers(TOKEN_ADDRESS, {validationMethod: 'full'});
+    t.true(transfer.hasProp('validation'))
+})
+