feat(contract): Method getAbi - refac + test + docs

Author: taylorjdawson

dist/web3data.min.js

@@ -2595,7 +2595,7 @@
      *
      * @param hash - The address.
      * @returns The detailed information for the specified contract.
-     * @example
+     * @example const details = await web3data.contract.getDetails('0x06012c8cf97bead5deae237070f9587f8e7a266d')
      */
     getDetails(hash) {
       throwIf$2(is$3.notHash(hash), NO_ADDRESS$2);
@@ -2625,14 +2625,17 @@
       })
     }
 
-    getAbi(hash, filterOptions) {
-      if (is$3.notHash(hash)) return Promise.reject(new Error(NO_ADDRESS$2))
-      return get$3(this.web3data, {
-        pathParam: hash,
-        endpoint: ENDPOINT$2,
-        subendpoint: 'abi',
-        filterOptions
-      })
+    /**
+     * Retrieves the contract's abi.
+     *
+     * @param hash - The contract address.
+     * @returns The abi of the contract.
+     * @example
+     * const abi = await web3data.contract.getAbi('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+     */
+    getAbi(hash) {
+      throwIf$2(is$3.notHash(hash), NO_ADDRESS$2);
+      return this.getDetails(hash).then(({abi}) => abi)
     }
 
     getSourceCode(hash, filterOptions) {

docs/api.md

@@ -641,7 +641,7 @@ Retrieves all the detailed information for the specified contract (ABI, bytecode
 ##### Examples
 
 ```javascript
-
+const details = await web3data.contract.getDetails('0x06012c8cf97bead5deae237070f9587f8e7a266d')
 ```
 
 
@@ -654,6 +654,39 @@ Retrieves all the detailed information for the specified contract (ABI, bytecode
 
 
 
+#### getAbi(hash)
+
+
+Retrieves the contract's abi.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| hash |  |  The contract address. |   |
+
+
+
+
+##### Examples
+
+```javascript
+const abi = await web3data.contract.getAbi('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+```
+
+
+##### Returns
+
+
+-  The abi of the contract.
+
+
+
+
+
 ### src/market.js
 
 

src/contract.js

@@ -23,7 +23,7 @@ class Contract {
    *
    * @param hash - The address.
    * @returns The detailed information for the specified contract.
-   * @example
+   * @example const details = await web3data.contract.getDetails('0x06012c8cf97bead5deae237070f9587f8e7a266d')
    */
   getDetails(hash) {
     throwIf(is.notHash(hash), NO_ADDRESS)
@@ -53,14 +53,17 @@ class Contract {
     })
   }
 
-  getAbi(hash, filterOptions) {
-    if (is.notHash(hash)) return Promise.reject(new Error(NO_ADDRESS))
-    return get(this.web3data, {
-      pathParam: hash,
-      endpoint: ENDPOINT,
-      subendpoint: 'abi',
-      filterOptions
-    })
+  /**
+   * Retrieves the contract's abi.
+   *
+   * @param hash - The contract address.
+   * @returns The abi of the contract.
+   * @example
+   * const abi = await web3data.contract.getAbi('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+   */
+  getAbi(hash) {
+    throwIf(is.notHash(hash), NO_ADDRESS)
+    return this.getDetails(hash).then(({abi}) => abi)
   }
 
   getSourceCode(hash, filterOptions) {

test/contract.test.js

@@ -54,9 +54,9 @@ test('throws exception when calling getAudit without hash', async t => {
 });
 
 /*********** Test getAbi() ***********/
-test('Successfully gets contract abi', async t => {
-    let response = await t.context.web3data.contract.getAbi(TOKEN_ADDRESS);
-    t.is(response.status, 200)
+test('Successfully calls getAbi()', async t => {
+    const abi = await t.context.web3data.contract.getAbi(TOKEN_ADDRESS);
+    t.true(Array.isArray(abi))
 });
 test('throws exception when calling getAbi without hash', async t => {
     await t.throwsAsync(async () => {