Merge pull request #60 from web3data/feat/signature

Feat/signature

Author: TrevorJTClarke

dist/web3data.min.js

@@ -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.
 
 
 
@@ -782,6 +782,72 @@ const details = await web3data.contract.getDetails('0x06012c8cf97bead5deae237070
 
 
 
+#### getFunctions(hash)
+
+
+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.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| hash |  |  The contract address. |   |
+
+
+
+
+##### Examples
+
+```javascript
+const functions = await web3data.contract.getFunctions('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+```
+
+
+##### Returns
+
+
+-  The functions or decompiled functions of the specified contract.
+
+
+
+
+
+#### getSecurityAudit(hash)
+
+
+Retrieves the vulnerabilities audit for the specified contract (if available).
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| hash |  |  The contract address. |   |
+
+
+
+
+##### Examples
+
+```javascript
+const audit = await web3data.contract.getAudit('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+```
+
+
+##### Returns
+
+
+-  The vulnerabilities audit for the specified contract.
+
+
+
+
+
 #### getAbi(hash)
 
 
@@ -848,6 +914,39 @@ const source = await web3data.contract.getSourceCode('0x06012c8cf97bead5deae2370
 
 
 
+#### getCode(hash)
+
+
+Returns the contract's bytecode.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| hash |  |  The contract address. |   |
+
+
+
+
+##### Examples
+
+```javascript
+const code = await web3data.contract.getCode('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+```
+
+
+##### Returns
+
+
+-  The contract's bytecode.
+
+
+
+
+
 ### src/market.js
 
 
@@ -1297,6 +1396,122 @@ 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 | `object`  |  The web3data instance. |   |
+
+
+
+
+##### Examples
+
+```javascript
+new Signature(new Web3Data('API_KEY'))
+```
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+
+
+#### getAudit(hash)
+
+
+Alias for getSignature.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| hash | `string`  |  The (keccak 256) of the signature. |   |
+
+
+
+
+##### Examples
+
+```javascript
+const signatureDetails = await web3data.signature.getAudit('0xe2f0a05a')
+```
+
+
+##### Returns
+
+
+- `Promise.<Array>`  Information pertaining to the specified signature hash.
+
+
+
+
+
+#### getSignature(hash)
+
+
+Retrieves detailed information about the specified signature hash.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| hash | `string`  |  The (keccak 256) of the signature. | &nbsp; |
+
+
+
+
+##### Examples
+
+```javascript
+const signatureDetails = await web3data.signature.getSignature('0xe2f0a05a')
+```
+
+
+##### Returns
+
+
+- `Promise.<Array>`  Information pertaining to the specified signature hash.
+
+
+
+
+
 ### src/transaction.js
 
 

docs/api.md

@@ -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,

package.json

@@ -5,7 +5,7 @@ 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 {
   /**
@@ -33,24 +33,36 @@ class Contract {
     }).then(onFulfilled, onError)
   }
 
-  getFunctions(hash, filterOptions) {
+  /**
+   * 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 hash - The contract address.
+   * @returns The functions or decompiled functions of the specified contract.
+   * @example const functions = await web3data.contract.getFunctions('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+   */
+  getFunctions(hash) {
     if (is.notHash(hash)) return Promise.reject(new Error(NO_ADDRESS))
     return get(this.web3data, {
       pathParam: hash,
       endpoint: ENDPOINT,
-      subendpoint: 'functions',
-      filterOptions
-    })
+      subendpoint: 'functions'
+    }).then(onFulfilled, onError)
   }
 
-  getAudit(hash, filterOptions) {
+  /**
+   * Retrieves the vulnerabilities audit for the specified contract (if available).
+   *
+   * @param hash - The contract address.
+   * @returns The vulnerabilities audit for the specified contract.
+   * @example const audit = await web3data.contract.getAudit('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+   */
+  getSecurityAudit(hash) {
     if (is.notHash(hash)) return Promise.reject(new Error(NO_ADDRESS))
     return get(this.web3data, {
       pathParam: hash,
       endpoint: ENDPOINT,
-      subendpoint: 'audit',
-      filterOptions
-    })
+      subendpoint: 'audit'
+    }).then(onFulfilled, onError)
   }
 
   /**
@@ -81,6 +93,13 @@ class Contract {
     }).then(onFulfilled, onError)
   }
 
+  /**
+   * Returns the contract's bytecode.
+   *
+   * @param hash - The contract address.
+   * @returns The contract's bytecode.
+   * @example const code = await web3data.contract.getCode('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+   */
   getCode(hash) {
     return this.getDetails(hash).then(details => details.bytecode || '0x')
   }

src/contract.js

@@ -1,17 +1,47 @@
-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 {object} web3data - The web3data instance.
+   * @example new Signature(new Web3Data('API_KEY'))
+   */
   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})
+  /**
+   * 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.
+   * @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
+    )
   }
 }
 

src/signature.js

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