Merge pull request #58 from web3data/feat/contract

Feat/contract

Author: TrevorJTClarke

dist/web3data.min.js

@@ -1,4 +1,4 @@
-# [web3data-js](https://github.com/web3data/web3data-js#readme) *0.5.15*
+# [web3data-js](https://github.com/web3data/web3data-js#readme) *0.5.16*
 
 > A javascript wrapper for accessing amberdata's public API.
 
@@ -699,6 +699,155 @@ Retrieves the blocks specified by its id (number or hash).
 
 
 
+### src/contract.js
+
+
+
+#### Class: Contract
+
+
+Contains methods pertaining to the `/contract` endpoint of Amberdata's API.
+
+
+
+
+
+
+
+
+
+#### constructor(web3data)
+
+
+Creates an instance of Contract.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| web3data |  |  The web3data instance. |   |
+
+
+
+
+##### Examples
+
+```javascript
+
+```
+
+
+##### Returns
+
+
+- `Void`
+
+
+
+
+
+#### getDetails(hash)
+
+
+Retrieves all the detailed information for the specified contract (ABI, bytecode, sourcecode...).
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| hash |  |  The address. |   |
+
+
+
+
+##### Examples
+
+```javascript
+const details = await web3data.contract.getDetails('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+```
+
+
+##### Returns
+
+
+-  The detailed information for the specified contract.
+
+
+
+
+
+#### 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.
+
+
+
+
+
+#### 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
 
 

docs/api.md

@@ -1,6 +1,6 @@
 {
   "name": "web3data-js",
-  "version": "0.5.15",
+  "version": "0.5.16",
   "description": "A javascript wrapper for accessing amberdata's public API.",
   "main": "index.js",
   "browser": "dist/web3data.min.js",

package.json

@@ -2,20 +2,35 @@ const {
   ERROR_MESSAGE_CONTRACT_NO_ADDRESS: NO_ADDRESS,
   CONTRACTS_ENDPOINT: ENDPOINT
 } = require('./constants')
-const {is, get} = require('./utils')
+const {is, get, throwIf, onFulfilled, onError} = require('./utils')
 
+/**
+ * Contains methods pertaining to the `/contract` endpoint of Amberdata's API.
+ */
 class Contract {
+  /**
+   * Creates an instance of Contract.
+   *
+   * @param web3data - The web3data instance.
+   * @example
+   */
   constructor(web3data) {
     this.web3data = web3data
   }
 
-  getDetails(hash, filterOptions) {
-    if (is.notHash(hash)) return Promise.reject(new Error(NO_ADDRESS))
+  /**
+   * Retrieves all the detailed information for the specified contract (ABI, bytecode, sourcecode...).
+   *
+   * @param hash - The address.
+   * @returns The detailed information for the specified contract.
+   * @example const details = await web3data.contract.getDetails('0x06012c8cf97bead5deae237070f9587f8e7a266d')
+   */
+  getDetails(hash) {
+    throwIf(is.notHash(hash), NO_ADDRESS)
     return get(this.web3data, {
       pathParam: hash,
-      endpoint: ENDPOINT,
-      filterOptions
-    })
+      endpoint: ENDPOINT
+    }).then(onFulfilled, onError)
   }
 
   getFunctions(hash, filterOptions) {
@@ -38,43 +53,36 @@ 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) {
-    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)
   }
 
-  async getCode(hash) {
-    const response = await this.getDetails(hash)
-    return new Promise((resolve, reject) => {
-      if (
-        is.null(response) ||
-        is.undefined(response) ||
-        response.status !== 200
-      ) {
-        reject(new Error('Failed to retrieve contract code.'))
-      } else if (!response.payload) {
-        reject(new Error('Failed to retrieve contract code.'))
-      } else if (response.payload.bytecode) {
-        resolve(response.payload.bytecode)
-      } else {
-        resolve('0x')
-      }
-    })
+  getCode(hash) {
+    return this.getDetails(hash).then(details => details.bytecode || '0x')
   }
 }
 

src/contract.js

@@ -21,15 +21,15 @@ test.beforeEach(t => {
  **********************************/
 
 /*********** Test getDetails() ***********/
-test('Successfully gets contract details', async t => {
-    let response = await t.context.web3data.contract.getDetails(TOKEN_ADDRESS);
-    t.is(response.status, 200)
-});
+test('Successfully calls getDetails()', async t => {
+    const details = await t.context.web3data.contract.getDetails(TOKEN_ADDRESS)
+    t.true(details.hasProp('abi'))
+})
 test('throws exception when calling getDetails without hash', async t => {
     await t.throwsAsync(async () => {
         await t.context.web3data.contract.getDetails()
-    }, { instanceOf: Error, message: 'No contract address supplied' });
-});
+    }, { instanceOf: Error, message: 'No contract address supplied' })
+})
 
 /*********** Test getFunctions() ***********/
 test('Successfully gets contract functions', async t => {
@@ -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 () => {
@@ -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' });