feat(signature): Refactor response to ret only payload. Update tests. Added docs.

taylorjdawson · taylorjdawson · commit dc94c2914c00 · 2019-11-04T10:26:06.000-08:00
diff --git a/dist/web3data.min.js b/dist/web3data.min.js
diff --git a/docs/api.md b/docs/api.md
@@ -706,7 +706,7 @@ Retrieves the blocks specified by its id (number or hash).
 #### Class: Contract
 
 
-Contains methods pertaining to the `/contract` endpoint of Amberdata's API.
+Contains methods pertaining to the `/contracts` endpoint of Amberdata's API.
 
 
 
@@ -728,7 +728,7 @@ Creates an instance of Contract.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| web3data | `Web3Data`  |  The web3data instance. | &nbsp; |
+| web3data |  |  The web3data instance. | &nbsp; |
 
 
 
@@ -761,7 +761,7 @@ Retrieves all the detailed information for the specified contract (ABI, bytecode
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| hash | `string`  |  The address. | &nbsp; |
+| hash |  |  The address. | &nbsp; |
 
 
 
@@ -776,7 +776,7 @@ const details = await web3data.contract.getDetails('0x06012c8cf97bead5deae237070
 ##### Returns
 
 
-- `Promise.<object>`  The detailed information for the specified contract.
+-  The detailed information for the specified contract.
 
 
 
@@ -794,22 +794,22 @@ Retrieves the functions of the specified contract (if available). If not availab
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| hash | `string`  |  The contract address. | &nbsp; |
+| hash |  |  The contract address. | &nbsp; |
 
 
 
 
 ##### Examples
 
 ```javascript
-
+const functions = await web3data.contract.getFunctions('0x06012c8cf97bead5deae237070f9587f8e7a266d')
 ```
 
 
 ##### Returns
 
 
-- `Promise.<object>`  The functions or decompiled functions of the specified contract.
+-  The functions or decompiled functions of the specified contract.
 
 
 
@@ -827,7 +827,7 @@ Retrieves the vulnerabilities audit for the specified contract (if available).
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| hash | `string`  |  The contract address. | &nbsp; |
+| hash |  |  The contract address. | &nbsp; |
 
 
 
@@ -842,7 +842,7 @@ const audit = await web3data.contract.getAudit('0x06012c8cf97bead5deae237070f958
 ##### Returns
 
 
-- `Promise.<object>`  The vulnerabilities audit for the specified contract.
+-  The vulnerabilities audit for the specified contract.
 
 
 
@@ -860,7 +860,7 @@ Retrieves the contract's abi.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| hash | `string`  |  The contract address. | &nbsp; |
+| hash |  |  The contract address. | &nbsp; |
 
 
 
@@ -875,7 +875,7 @@ const abi = await web3data.contract.getAbi('0x06012c8cf97bead5deae237070f9587f8e
 ##### Returns
 
 
-- `Promise.<array>`  The abi of the contract.
+-  The abi of the contract.
 
 
 
@@ -893,7 +893,7 @@ Retrieves the contract's source code.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| hash | `string`  |  The contract address. | &nbsp; |
+| hash |  |  The contract address. | &nbsp; |
 
 
 
@@ -908,7 +908,7 @@ const source = await web3data.contract.getSourceCode('0x06012c8cf97bead5deae2370
 ##### Returns
 
 
-- `Promise.<string>`  The source of the contract.
+-  The source of the contract.
 
 
 
@@ -926,7 +926,7 @@ Returns the contract's bytecode.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| hash | `string`  |  The contract address. | &nbsp; |
+| hash |  |  The contract address. | &nbsp; |
 
 
 
@@ -941,7 +941,7 @@ const code = await web3data.contract.getCode('0x06012c8cf97bead5deae237070f9587f
 ##### Returns
 
 
-- `Promise.<string>`  The contract's bytecode.
+-  The contract's bytecode.
 
 
 
@@ -1396,6 +1396,89 @@ const batTokenAddress = web3data.market.getAssetAddresses('bat') const assetAddr
 
 
 
+### src/signature.js
+
+
+
+#### Class: Signature
+
+
+Contains methods pertaining to the `/signatures` endpoint of Amberdata's API.
+
+
+
+
+
+
+
+
+
+#### constructor(web3data)
+
+
+Creates an instance of Signature.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| web3data |  |  The web3data instance. | &nbsp; |
+
+
+
+
+##### Examples
+
+```javascript
+
+```
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+
+
+#### getSignature(hash)
+
+
+Retrieves detailed information about the specified signature hash.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| hash |  |  The (keccak 256) of the signature. | &nbsp; |
+
+
+
+
+##### Examples
+
+```javascript
+const signatureDetails = await web3data.signature.getSignature('0xe2f0a05a')
+```
+
+
+##### Returns
+
+
+-  Information pertaining to the specified signature hash.
+
+
+
+
+
 ### src/transaction.js
 
 
diff --git a/src/contract.js b/src/contract.js
@@ -5,13 +5,13 @@ const {
 const {is, get, throwIf, onFulfilled, onError} = require('./utils')
 
 /**
- * Contains methods pertaining to the `/contract` endpoint of Amberdata's API.
+ * Contains methods pertaining to the `/contracts` endpoint of Amberdata's API.
  */
 class Contract {
   /**
    * Creates an instance of Contract.
    *
-   * @param {Web3Data} web3data - The web3data instance.
+   * @param web3data - The web3data instance.
    * @example
    */
   constructor(web3data) {
@@ -21,8 +21,8 @@ class Contract {
   /**
    * Retrieves all the detailed information for the specified contract (ABI, bytecode, sourcecode...).
    *
-   * @param {string} hash - The address.
-   * @returns {Promise<object>} The detailed information for the specified contract.
+   * @param hash - The address.
+   * @returns The detailed information for the specified contract.
    * @example const details = await web3data.contract.getDetails('0x06012c8cf97bead5deae237070f9587f8e7a266d')
    */
   getDetails(hash) {
@@ -36,8 +36,8 @@ class Contract {
   /**
    * Retrieves the functions of the specified contract (if available). If not available on chain, the byte code is decompiled and a list of functions is extracted from it.
    *
-   * @param {string} hash - The contract address.
-   * @returns {Promise<object>} The functions or decompiled functions of the specified contract.
+   * @param hash - The contract address.
+   * @returns The functions or decompiled functions of the specified contract.
    * @example const functions = await web3data.contract.getFunctions('0x06012c8cf97bead5deae237070f9587f8e7a266d')
    */
   getFunctions(hash) {
@@ -52,8 +52,8 @@ class Contract {
   /**
    * Retrieves the vulnerabilities audit for the specified contract (if available).
    *
-   * @param {string} hash - The contract address.
-   * @returns {Promise<object>} The vulnerabilities audit for the specified contract.
+   * @param hash - The contract address.
+   * @returns The vulnerabilities audit for the specified contract.
    * @example const audit = await web3data.contract.getAudit('0x06012c8cf97bead5deae237070f9587f8e7a266d')
    */
   getSecurityAudit(hash) {
@@ -68,8 +68,8 @@ class Contract {
   /**
    * Retrieves the contract's abi.
    *
-   * @param {string} hash - The contract address.
-   * @returns {Promise<array>} The abi of the contract.
+   * @param hash - The contract address.
+   * @returns The abi of the contract.
    * @example const abi = await web3data.contract.getAbi('0x06012c8cf97bead5deae237070f9587f8e7a266d')
    */
   getAbi(hash) {
@@ -80,8 +80,8 @@ class Contract {
   /**
    * Retrieves the contract's source code.
    *
-   * @param {string} hash - The contract address.
-   * @returns {Promise<string>} The source of the contract.
+   * @param hash - The contract address.
+   * @returns The source of the contract.
    * @example const source = await web3data.contract.getSourceCode('0x06012c8cf97bead5deae237070f9587f8e7a266d')
    */
   getSourceCode(hash) {
@@ -96,8 +96,8 @@ class Contract {
   /**
    * Returns the contract's bytecode.
    *
-   * @param {string} hash - The contract address.
-   * @returns {Promise<string>} The contract's bytecode.
+   * @param hash - The contract address.
+   * @returns The contract's bytecode.
    * @example const code = await web3data.contract.getCode('0x06012c8cf97bead5deae237070f9587f8e7a266d')
    */
   getCode(hash) {
diff --git a/src/signature.js b/src/signature.js
@@ -1,17 +1,36 @@
-const {get, is} = require('./utils')
+const {get, is, throwIf, onError, onFulfilled} = require('./utils')
 const {
   SIGNATURES_ENDPOINT: ENDPOINT,
   ERROR_MESSAGE_SIGNATURE_NO_HASH: NO_HASH
 } = require('./constants')
 
+/**
+ * Contains methods pertaining to the `/signatures` endpoint of Amberdata's API.
+ */
 class Signature {
+  /**
+   * Creates an instance of Signature.
+   *
+   * @param web3data - The web3data instance.
+   * @example
+   */
   constructor(web3data) {
     this.web3data = web3data
   }
 
-  get4Byte(hash) {
-    if (is.notHash(hash)) return Promise.reject(new Error(NO_HASH))
-    return get(this.web3data, {hash, endpoint: ENDPOINT})
+  /**
+   * Retrieves detailed information about the specified signature hash.
+   *
+   * @param hash - The (keccak 256) of the signature.
+   * @returns Information pertaining to the specified signature hash.
+   * @example const signatureDetails = await web3data.signature.getSignature('0xe2f0a05a')
+   */
+  getSignature(hash) {
+    throwIf(is.notHash(hash), NO_HASH)
+    return get(this.web3data, {hash, endpoint: ENDPOINT}).then(
+      onFulfilled,
+      onError
+    )
   }
 }
 
diff --git a/test/signature.test.js b/test/signature.test.js
@@ -1,8 +1,8 @@
 import test from "ava"
-import {ERROR_MESSAGE_SIGNATURE_NO_HASH as NO_HASH, ADDRESS} from "../src/constants";
+import {ERROR_MESSAGE_SIGNATURE_NO_HASH as NO_HASH} from "../src/constants";
 import {setUpPolly, getNewWeb3DataInstance} from "./utils";
 
-/**********************************
+/**********************************gs
  * -------- Tests Setup ---------- *
  **********************************/
 test.before(t => {
@@ -25,8 +25,8 @@ test.beforeEach(t => {
  * @return {Promise<void>}
  */
 let statusSuccess = async (t, { method, params = {} }) => {
-    let response = await t.context.web3data.signature[method]('0xe2f0a05a')
-    t.is(response.status, 200)
+    const [signatureDetails] = await t.context.web3data.signature[method]('0xe2f0a05a')
+    t.true(signatureDetails.hasProp('textSignature'))
 }
 statusSuccess.title = (providedTitle = '', input) =>  `Successfully calls ${input.method} and returns status of 200`
 
@@ -46,4 +46,4 @@ let rejectsPromise = async (t, { method, params = {} }, errorMessage) => {
 }
 rejectsPromise.title = (providedTitle = '', input) => `throws exception when calling ${input} without hash`
 
-test([statusSuccess, rejectsPromise], {method: 'get4Byte'}, NO_HASH)
+test([statusSuccess, rejectsPromise], {method: 'getSignature'}, NO_HASH)
