feat(signature): Update tests + Docs

taylorjdawson · taylorjdawson · commit 64ef5613b476 · 2019-11-07T11:22:32.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
@@ -1425,15 +1425,15 @@ Creates an instance of Signature.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| web3data |  |  The web3data instance. | &nbsp; |
+| web3data | `object`  |  The web3data instance. | &nbsp; |
 
 
 
 
 ##### Examples
 
 ```javascript
-
+new Signature(new Web3Data('API_KEY'))
 ```
 
 
@@ -1446,6 +1446,39 @@ Creates an instance of Signature.
 
 
 
+#### getAudit(hash)
+
+
+Alias for getSignature.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| hash | `string`  |  The (keccak 256) of the signature. | &nbsp; |
+
+
+
+
+##### Examples
+
+```javascript
+const signatureDetails = await web3data.signature.getAudit('0xe2f0a05a')
+```
+
+
+##### Returns
+
+
+- `Promise.<Array>`  Information pertaining to the specified signature hash.
+
+
+
+
+
 #### getSignature(hash)
 
 
@@ -1473,7 +1506,7 @@ const signatureDetails = await web3data.signature.getSignature('0xe2f0a05a')
 ##### Returns
 
 
-- `Promise.<array>`  Information pertaining to the specified signature hash.
+- `Promise.<Array>`  Information pertaining to the specified signature hash.
 
 
 
diff --git a/package.json b/package.json
@@ -101,7 +101,6 @@
       "jsdoc/implements-on-classes": 1,
       "jsdoc/match-description": 1,
       "jsdoc/newline-after-description": 1,
-      "jsdoc/no-types": 1,
       "jsdoc/no-undefined-types": 1,
       "jsdoc/require-description": 1,
       "jsdoc/require-description-complete-sentence": 1,
diff --git a/src/signature.js b/src/signature.js
@@ -11,18 +11,29 @@ class Signature {
   /**
    * Creates an instance of Signature.
    *
-   * @param web3data - The web3data instance.
-   * @example
+   * @param {object} web3data - The web3data instance.
+   * @example new Signature(new Web3Data('API_KEY'))
    */
   constructor(web3data) {
     this.web3data = web3data
   }
 
+  /**
+   * Alias for getSignature.
+   *
+   * @param {string} hash - The (keccak 256) of the signature.
+   * @returns {Promise<Array>} Information pertaining to the specified signature hash.
+   * @example const signatureDetails = await web3data.signature.getAudit('0xe2f0a05a')
+   */
+  getAudit(hash) {
+    return this.getSignature(hash)
+  }
+
   /**
    * Retrieves detailed information about the specified signature hash.
    *
    * @param {string} hash - The (keccak 256) of the signature.
-   * @returns {Promise<array>} Information pertaining to the specified signature hash.
+   * @returns {Promise<Array>} Information pertaining to the specified signature hash.
    * @example const signatureDetails = await web3data.signature.getSignature('0xe2f0a05a')
    */
   getSignature(hash) {
diff --git a/src/web3data.js b/src/web3data.js
@@ -24,6 +24,7 @@ const WebSocketClient = require('./websocket')
 
 /**
  * Contains common methods used in.
+ *
  * @private
  */
 class Web3DataFactory {
diff --git a/test/recordings/signature_1605069165/recording.har b/test/recordings/signature_1605069165/recording.har
@@ -8,7 +8,7 @@
     },
     "entries": [
       {
-        "_id": "4471f38f4456bcefd3a52ee0248276ba",
+        "_id": "c1eed826d36016f8aa9bbc4ee94388c9",
         "_order": 0,
         "cache": {},
         "request": {
@@ -32,55 +32,198 @@
           "httpVersion": "HTTP/1.1",
           "method": "GET",
           "queryString": [],
-          "url": "https://web3api.io/api/v2/signatures/0xe2f0a05a?x-api-key="
+          "url": "https://web3api.io/api/v2/signatures/0x3d7d3f5a?x-api-key="
         },
         "response": {
-          "bodySize": 282,
+          "bodySize": 295,
           "content": {
             "mimeType": "application/json; charset=utf-8",
-            "size": 282,
-            "text": "{\"status\":200,\"title\":\"OK\",\"description\":\"Successful request\",\"payload\":[{\"fullHexadecimalSignature\":\"0xe2f0a05a7dfb6af94ccaa246f780bf8b96a0c98efb8a48e33bd347addaa71d42\",\"hexadecimalSignature\":\"0xe2f0a05a\",\"numParameters\":4,\"textSignature\":\"TokenCLC(uint256,string,uint8,string)\"}]}"
+            "size": 295,
+            "text": "{\"status\":200,\"title\":\"OK\",\"description\":\"Successful request\",\"payload\":[{\"fullHexadecimalSignature\":\"0x3d7d3f5ab1b3b4946cf6ce26758c354d9eb67adf6a0432ce7ec60ddc563202e4\",\"hexadecimalSignature\":\"0x3d7d3f5a\",\"numParameters\":4,\"textSignature\":\"createSaleAuction(uint256,uint256,uint256,uint256)\"}]}"
           },
           "cookies": [
             {
-              "expires": "2019-10-15T06:45:36.000Z",
+              "expires": "2019-11-14T18:46:05.000Z",
               "name": "AWSALB",
               "path": "/",
-              "value": "+VK72WbYnnJcwg6sHAx6b0xxAG2Jj5sEupyrtxyPIcZe+b+kGU8nmQcqnENhl1lefaC8sPOssBXClKZ+Y1RQ2ZNJK2B/L41gKYA8OSZCM+7oWsd0zjrQYwMIsfhw"
+              "value": "lEFEZkhCB7RO9ZFY9ogrxyHF6Jrp+L/gge/EPLLfz5auTEpUtbdtwdGi+LZnkDFGQsy1miErD70UxxhJDyh1HMCqnoxvWuTFUADkpB0KirJcM0tyfQHMo1f1l6NC"
             }
           ],
           "headers": [
+            {
+              "name": "hasprop"
+            },
+            {
+              "name": "values"
+            },
+            {
+              "name": "content-type",
+              "value": "application/json; charset=utf-8"
+            },
+            {
+              "name": "content-length",
+              "value": "295"
+            },
+            {
+              "name": "connection",
+              "value": "close"
+            },
+            {
+              "name": "date",
+              "value": "Thu, 07 Nov 2019 18:46:05 GMT"
+            },
+            {
+              "name": "x-amzn-requestid",
+              "value": "f51e2bd3-b3d4-457e-b020-f0f7e0ced776"
+            },
+            {
+              "name": "access-control-allow-origin",
+              "value": "*"
+            },
+            {
+              "name": "x-response-time",
+              "value": "20.973ms"
+            },
+            {
+              "name": "x-amzn-remapped-content-length",
+              "value": "295"
+            },
+            {
+              "name": "x-amzn-remapped-connection",
+              "value": "keep-alive"
+            },
+            {
+              "_fromType": "array",
+              "name": "set-cookie",
+              "value": "AWSALB=lEFEZkhCB7RO9ZFY9ogrxyHF6Jrp+L/gge/EPLLfz5auTEpUtbdtwdGi+LZnkDFGQsy1miErD70UxxhJDyh1HMCqnoxvWuTFUADkpB0KirJcM0tyfQHMo1f1l6NC; Expires=Thu, 14 Nov 2019 18:46:05 GMT; Path=/"
+            },
+            {
+              "name": "x-amz-apigw-id",
+              "value": "CzTxKGOBIAMFctg="
+            },
+            {
+              "name": "etag",
+              "value": "W/\"127-B6FEkb5Db7uuTR/oTAZ2EqfORKg\""
+            },
+            {
+              "name": "x-amzn-remapped-date",
+              "value": "Thu, 07 Nov 2019 18:46:05 GMT"
+            },
+            {
+              "name": "x-cache",
+              "value": "Miss from cloudfront"
+            },
+            {
+              "name": "via",
+              "value": "1.1 030fe0607711293dda988e571617a9f3.cloudfront.net (CloudFront)"
+            },
+            {
+              "name": "x-amz-cf-pop",
+              "value": "HIO50-C1"
+            },
+            {
+              "name": "x-amz-cf-id",
+              "value": "R2mX0BNqK5hxhcowQzm1C1QGIUK9S39PsCOD6ZUbjqpjWnrcuEVbAg=="
+            }
+          ],
+          "headersSize": 1051,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2019-11-07T18:46:02.757Z",
+        "time": 4044,
+        "timings": {
+          "blocked": -1,
+          "connect": -1,
+          "dns": -1,
+          "receive": 0,
+          "send": 0,
+          "ssl": -1,
+          "wait": 4044
+        }
+      },
+      {
+        "_id": "c1eed826d36016f8aa9bbc4ee94388c9",
+        "_order": 1,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "name": "accept",
+              "value": "application/json, text/plain, */*"
+            },
+            {
+              "name": "user-agent",
+              "value": "axios/0.19.0"
+            },
+            {
+              "name": "host",
+              "value": "web3api.io"
+            }
+          ],
+          "headersSize": 199,
+          "httpVersion": "HTTP/1.1",
+          "method": "GET",
+          "queryString": [],
+          "url": "https://web3api.io/api/v2/signatures/0x3d7d3f5a?x-api-key="
+        },
+        "response": {
+          "bodySize": 295,
+          "content": {
+            "mimeType": "application/json; charset=utf-8",
+            "size": 295,
+            "text": "{\"status\":200,\"title\":\"OK\",\"description\":\"Successful request\",\"payload\":[{\"fullHexadecimalSignature\":\"0x3d7d3f5ab1b3b4946cf6ce26758c354d9eb67adf6a0432ce7ec60ddc563202e4\",\"hexadecimalSignature\":\"0x3d7d3f5a\",\"numParameters\":4,\"textSignature\":\"createSaleAuction(uint256,uint256,uint256,uint256)\"}]}"
+          },
+          "cookies": [
+            {
+              "expires": "2019-11-14T18:46:15.000Z",
+              "name": "AWSALB",
+              "path": "/",
+              "value": "j07B6YXkBhO/afEQp+JSRWH5MnaJ15USiUlR838FVjwEbGPt7fOPxqfysxitmXBJ+8pe3tbeQEQRzsyaETGRoeHPL7VXVPExoFK0D0igwSkoTvDn27md565yzJb0"
+            }
+          ],
+          "headers": [
+            {
+              "name": "hasprop"
+            },
+            {
+              "name": "values"
+            },
             {
               "name": "content-type",
               "value": "application/json; charset=utf-8"
             },
             {
               "name": "content-length",
-              "value": "282"
+              "value": "295"
             },
             {
               "name": "connection",
               "value": "close"
             },
             {
               "name": "date",
-              "value": "Tue, 08 Oct 2019 06:45:36 GMT"
+              "value": "Thu, 07 Nov 2019 18:46:15 GMT"
             },
             {
               "name": "x-amzn-requestid",
-              "value": "af8f9124-8dc9-467f-b871-fda2d32251de"
+              "value": "51b2677f-5df0-44d4-abad-6f11592768e0"
             },
             {
               "name": "access-control-allow-origin",
               "value": "*"
             },
             {
               "name": "x-response-time",
-              "value": "4.530ms"
+              "value": "36.738ms"
             },
             {
               "name": "x-amzn-remapped-content-length",
-              "value": "282"
+              "value": "295"
             },
             {
               "name": "x-amzn-remapped-connection",
@@ -89,53 +232,53 @@
             {
               "_fromType": "array",
               "name": "set-cookie",
-              "value": "AWSALB=+VK72WbYnnJcwg6sHAx6b0xxAG2Jj5sEupyrtxyPIcZe+b+kGU8nmQcqnENhl1lefaC8sPOssBXClKZ+Y1RQ2ZNJK2B/L41gKYA8OSZCM+7oWsd0zjrQYwMIsfhw; Expires=Tue, 15 Oct 2019 06:45:36 GMT; Path=/"
+              "value": "AWSALB=j07B6YXkBhO/afEQp+JSRWH5MnaJ15USiUlR838FVjwEbGPt7fOPxqfysxitmXBJ+8pe3tbeQEQRzsyaETGRoeHPL7VXVPExoFK0D0igwSkoTvDn27md565yzJb0; Expires=Thu, 14 Nov 2019 18:46:15 GMT; Path=/"
             },
             {
               "name": "x-amz-apigw-id",
-              "value": "BOyGhFnIIAMFxNQ="
+              "value": "CzTywEckIAMFeUQ="
             },
             {
               "name": "etag",
-              "value": "W/\"11a-J/h5Ote302XQH1HQ35hHvSM3AHw\""
+              "value": "W/\"127-B6FEkb5Db7uuTR/oTAZ2EqfORKg\""
             },
             {
               "name": "x-amzn-remapped-date",
-              "value": "Tue, 08 Oct 2019 06:45:36 GMT"
+              "value": "Thu, 07 Nov 2019 18:46:15 GMT"
             },
             {
               "name": "x-cache",
               "value": "Miss from cloudfront"
             },
             {
               "name": "via",
-              "value": "1.1 5beb4c3232a40c8c6a3e48c902092760.cloudfront.net (CloudFront)"
+              "value": "1.1 030fe0607711293dda988e571617a9f3.cloudfront.net (CloudFront)"
             },
             {
               "name": "x-amz-cf-pop",
-              "value": "IAD89-C2"
+              "value": "HIO50-C1"
             },
             {
               "name": "x-amz-cf-id",
-              "value": "z-jAjdzcBZbiutQRKe5SxEbgeB1LHd5tdauNaF1sJMqv7V4kzAIzYQ=="
+              "value": "ZyTNnRtFKFKiGAP4yhXPQoqAKDlJq8Ml-TKkatlKhwC9gQnymPEQwA=="
             }
           ],
-          "headersSize": 836,
+          "headersSize": 1051,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2019-10-08T06:45:35.426Z",
-        "time": 762,
+        "startedDateTime": "2019-11-07T18:46:14.017Z",
+        "time": 2422,
         "timings": {
           "blocked": -1,
           "connect": -1,
           "dns": -1,
           "receive": 0,
           "send": 0,
           "ssl": -1,
-          "wait": 762
+          "wait": 2422
         }
       }
     ],
diff --git a/test/signature.test.js b/test/signature.test.js
