feat(contract): Method getSourceCode test + docs

Author: taylorjdawson

dist/web3data.min.js

@@ -2630,22 +2630,27 @@
      *
      * @param hash - The contract address.
      * @returns The abi of the contract.
-     * @example
-     * const abi = await web3data.contract.getAbi('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+     * @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) {
-      if (is$3.notHash(hash)) return Promise.reject(new Error(NO_ADDRESS$2))
+    /**
+     * Retrieves the contract's source code.
+     *
+     * @param hash - The contract address.
+     * @returns The source of the contract.
+     * @example const source = await web3data.contract.getSourceCode('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+     */
+    getSourceCode(hash) {
+      throwIf$2(is$3.notHash(hash), NO_ADDRESS$2);
       return get$3(this.web3data, {
         pathParam: hash,
         endpoint: ENDPOINT$2,
-        subendpoint: 'source-code',
-        filterOptions
-      })
+        subendpoint: 'source-code'
+      }).then(onFulfilled$3, onError$3)
     }
 
     getCode(hash) {

docs/api.md

@@ -687,6 +687,39 @@ const abi = await web3data.contract.getAbi('0x06012c8cf97bead5deae237070f9587f8e
 
 
 
+#### getSourceCode(hash)
+
+
+Retrieves the contract's source code.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| hash |  |  The contract address. |   |
+
+
+
+
+##### Examples
+
+```javascript
+const source = await web3data.contract.getSourceCode('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+```
+
+
+##### Returns
+
+
+-  The source of the contract.
+
+
+
+
+
 ### src/market.js
 
 
@@ -1136,15 +1169,27 @@ const batTokenAddress = web3data.market.getAssetAddresses('bat') const assetAddr
 
 
 
-### src/utils.js
+### src/web3data.js
 
 
 
-#### get(web3data, subendpoint, endpoint, hash, pathParam, filterOptions)
+#### Class: Web3DataFactory
 
 
-Builds the endpoint url to pass to .rawQuery(). Checks for non empties and appends
-the appropriate parameter(s) where applicable.
+Contains common methods used in.
+
+
+
+
+
+
+
+
+
+#### constructor(apiKey, options, blockchainId:, -, -)
+
+
+Creates a Web3Data instance.
 
 
 
@@ -1153,12 +1198,11 @@ the appropriate parameter(s) where applicable.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| web3data |  |  Instance on which to call .rawQuery(). |   |
-| subendpoint |  |  The subendpoint. |   |
-| endpoint |  |  The endpoint. |   |
-| hash |  |  The address hash. |   |
-| pathParam |  |  The path parameter. |   |
-| filterOptions |  |  The filters associated with a given endpoint. |   |
+| apiKey |  |  The Amberdata api key needed to access data. |   |
+| options | `object`  | Contains additional configuration options: |   |
+| blockchainId: |  | specifies the blockchain to get data from |   |
+| - |  | baseUrl: the base url of API calls |   |
+| - |  | websocketUrl: the websocket url to use |   |
 
 
 
@@ -1173,16 +1217,17 @@ the appropriate parameter(s) where applicable.
 ##### Returns
 
 
--  Returns a Promise of the rawQuery request from web3data.
+- `Void`
 
 
 
 
 
-#### uuid(data)
+#### rawQuery(url)
 
 
-Generates a uuid see [this gist]() for more details.
+Appends the API base url with the endpoint  url. Then sends an
+http request to the Amberdata API endpoint.
 
 
 
@@ -1191,7 +1236,7 @@ Generates a uuid see [this gist]() for more details.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| data |  |  |   |
+| url |  |  The endpoint url with any query/path params if set. |   |
 
 
 
@@ -1206,71 +1251,69 @@ Generates a uuid see [this gist]() for more details.
 ##### Returns
 
 
-- `Void`
+-  The axios request object.
 
 
 
 
 
-### src/web3data.js
+#### rpc(method, params)
 
 
+Method used to interact with web3api json rpc endpoints.
 
-#### Class: Web3DataFactory
 
 
-Contains common methods used in.
 
+##### Parameters
 
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| method |  |  The json rpc method to call. |   |
+| params |  |  The parameters to the json rpc call. |   |
 
 
 
 
+##### Examples
 
+```javascript
 
+```
 
-#### constructor(apiKey, options, blockchainId:, -, -)
 
+##### Returns
 
-Creates a Web3Data instance.
 
+-  Returns the json rpc result.
 
 
 
-##### Parameters
 
-| Name | Type | Description |  |
-| ---- | ---- | ----------- | -------- |
-| apiKey |  |  The Amberdata api key needed to access data. |   |
-| options | `object`  | Contains additional configuration options: |   |
-| blockchainId: |  | specifies the blockchain to get data from |   |
-| - |  | baseUrl: the base url of API calls |   |
-| - |  | websocketUrl: the websocket url to use |   |
 
+#### Class: Web3Data
 
 
+Class Web3data contains methods for hitting Amberdata's
+API endpoints.
 
-##### Examples
 
-```javascript
 
-```
 
 
-##### Returns
 
 
-- `Void`
 
 
+### src/utils.js
 
 
 
-#### rawQuery(url)
+#### get(web3data, subendpoint, endpoint, hash, pathParam, filterOptions)
 
 
-Appends the API base url with the endpoint  url. Then sends an
-http request to the Amberdata API endpoint.
+Builds the endpoint url to pass to .rawQuery(). Checks for non empties and appends
+the appropriate parameter(s) where applicable.
 
 
 
@@ -1279,7 +1322,12 @@ http request to the Amberdata API endpoint.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| url |  |  The endpoint url with any query/path params if set. |   |
+| web3data |  |  Instance on which to call .rawQuery(). |   |
+| subendpoint |  |  The subendpoint. |   |
+| endpoint |  |  The endpoint. |   |
+| hash |  |  The address hash. |   |
+| pathParam |  |  The path parameter. |   |
+| filterOptions |  |  The filters associated with a given endpoint. |   |
 
 
 
@@ -1294,16 +1342,16 @@ http request to the Amberdata API endpoint.
 ##### Returns
 
 
--  The axios request object.
+-  Returns a Promise of the rawQuery request from web3data.
 
 
 
 
 
-#### rpc(method, params)
+#### uuid(data)
 
 
-Method used to interact with web3api json rpc endpoints.
+Generates a uuid see [this gist]() for more details.
 
 
 
@@ -1312,8 +1360,7 @@ Method used to interact with web3api json rpc endpoints.
 
 | Name | Type | Description |  |
 | ---- | ---- | ----------- | -------- |
-| method |  |  The json rpc method to call. |   |
-| params |  |  The parameters to the json rpc call. |   |
+| data |  |  |   |
 
 
 
@@ -1328,21 +1375,7 @@ Method used to interact with web3api json rpc endpoints.
 ##### Returns
 
 
--  Returns the json rpc result.
-
-
-
-
-
-#### Class: Web3Data
-
-
-Class Web3data contains methods for hitting Amberdata's
-API endpoints.
-
-
-
-
+- `Void`
 
 
 

src/contract.js

@@ -58,22 +58,27 @@ class Contract {
    *
    * @param hash - The contract address.
    * @returns The abi of the contract.
-   * @example
-   * const abi = await web3data.contract.getAbi('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+   * @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) {
-    if (is.notHash(hash)) return Promise.reject(new Error(NO_ADDRESS))
+  /**
+   * Retrieves the contract's source code.
+   *
+   * @param hash - The contract address.
+   * @returns The source of the contract.
+   * @example const source = await web3data.contract.getSourceCode('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+   */
+  getSourceCode(hash) {
+    throwIf(is.notHash(hash), NO_ADDRESS)
     return get(this.web3data, {
       pathParam: hash,
       endpoint: ENDPOINT,
-      subendpoint: 'source-code',
-      filterOptions
-    })
+      subendpoint: 'source-code'
+    }).then(onFulfilled, onError)
   }
 
   getCode(hash) {

test/contract.test.js

@@ -65,11 +65,11 @@ test('throws exception when calling getAbi without hash', async t => {
 });
 
 /*********** Test getSourceCode() ***********/
-test.skip('Successfully gets contract source code', async t => {
-    let response = await t.context.web3data.contract.getSourceCode(TOKEN_ADDRESS);
-    t.is(response.status, 200)
+test.only('Successfully gets contract source code', async t => {
+    const source = await t.context.web3data.contract.getSourceCode(TOKEN_ADDRESS);
+    t.is(typeof source, 'string')
 });
-test.skip('throws exception when calling getSourceCode without hash', async t => {
+test('throws exception when calling getSourceCode without hash', async t => {
     await t.throwsAsync(async () => {
         await t.context.web3data.contract.getSourceCode()
     }, { instanceOf: Error, message: 'No contract address supplied' });