WIP - adding updated metrics and blockchains

Author: TrevorJTClarke

ava.config.js

@@ -2,7 +2,7 @@ export default {
   files: ['test/**.test.js'],
   ignoredByWatcher: ['dist/**/*'],
   cache: true,
-  concurrency: 5,
+  concurrency: 2,
   require: ['@babel/register'],
   babel: true,
   inherit: true

package-lock.json

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

package.json

@@ -137,9 +137,13 @@ class Block {
   }
 
   getMetrics(filterOptions) {
+    const subendpoint =
+      filterOptions && (filterOptions.startDate || filterOptions.endDate)
+        ? 'historical'
+        : 'latest'
     return get(this.web3data, {
-      endpoint: ENDPOINT,
-      subendpoint: 'metrics/latest',
+      endpoint: `${ENDPOINT}/metrics`,
+      subendpoint,
       filterOptions
     }).then(onFulfilled, onError)
   }

src/block.js

@@ -0,0 +1,23 @@
+const {BLOCKCHAINS_ENDPOINT: ENDPOINT} = require('./constants')
+
+const {get, onFulfilled, onError} = require('./utils')
+
+class Blockchain {
+  constructor(web3data) {
+    this.web3data = web3data
+  }
+
+  getMetrics(filterOptions) {
+    const subendpoint =
+      filterOptions && (filterOptions.startDate || filterOptions.endDate)
+        ? 'historical'
+        : 'latest'
+    return get(this.web3data, {
+      endpoint: `${ENDPOINT}/metrics`,
+      subendpoint,
+      filterOptions
+    }).then(onFulfilled, onError)
+  }
+}
+
+module.exports = Blockchain

src/blockchain.js

@@ -20,6 +20,7 @@ module.exports.ADDRESSES_ENDPOINT = '/addresses'
 module.exports.TOKENS_ENDPOINT = '/tokens'
 module.exports.TRANSACTIONS_ENDPOINT = '/transactions'
 module.exports.BLOCKS_ENDPOINT = '/blocks'
+module.exports.BLOCKCHAINS_ENDPOINT = '/blockchains'
 module.exports.CONTRACTS_ENDPOINT = '/contracts'
 module.exports.SIGNATURES_ENDPOINT = '/signatures'
 module.exports.MARKET_ENDPOINT = '/market'

src/constants.js

@@ -12,6 +12,7 @@ const Token = require('./token')
 const Contract = require('./contract')
 const Transaction = require('./transaction')
 const Block = require('./block')
+const Blockchain = require('./blockchain')
 const Signature = require('./signature')
 const Market = require('./market')
 const Eth = require('./eth')
@@ -71,6 +72,7 @@ class Web3DataFactory {
     this.contract = new Contract(this)
     this.transaction = new Transaction(this)
     this.block = new Block(this)
+    this.blockchain = new Blockchain(this)
     this.signature = new Signature(this)
     this.market = new Market(this)
   }

src/web3data.js

@@ -1,5 +1,5 @@
 import test, {only} from "ava"
-import { ADDRESS, DATES } from "./constants";
+import { ADDRESS, TOKEN_ADDRESS, DATES } from "./constants";
 import {ERROR_MESSAGE_ADDRESS_NO_ADDRESS as NO_ADDRESS} from "../src/constants";
 import {
     setUpPolly,
@@ -64,7 +64,7 @@ test('Successfully gets address information', async t => {
     t.true(info.hasProp('balance'))
 })
 test('Successfully gets address information + pricing data', async t => {
-    const info = await t.context.web3data.address.getInformation(ADDRESS, {includePrice: true, currency: 'usd'})
+    const info = await t.context.web3data.address.getInformation(TOKEN_ADDRESS, {includePrice: true, currency: 'usd'})
     t.true(info.hasProp('balance'))
     t.true(info.hasProp('price'))
     t.true(info.price.balance.hasProp('currency'))
@@ -178,7 +178,7 @@ test('Successfully gets address transactions - no filters', async t => {
 })
 
 test('Successfully gets address transactions - with filters', async t => {
-    const [transaction] = await t.context.web3data.address.getTransactions(ADDRESS, {includePrice: true})
+    const [transaction] = await t.context.web3data.address.getTransactions(TOKEN_ADDRESS, {includePrice: true})
     t.true(transaction.hasProp('price'))
 })
 
@@ -195,7 +195,7 @@ test('Successfully gets address pending transactions - no filters', async t => {
 })
 
 test('Successfully gets address pending transactions - with filters', async t => {
-    const [pendingTxn] = await t.context.web3data.address.getPendingTransactions(ADDRESS, {includePrice: true})
+    const [pendingTxn] = await t.context.web3data.address.getPendingTransactions(TOKEN_ADDRESS, {includePrice: true})
     t.true(pendingTxn.hasProp('price'))
 })
 
@@ -218,7 +218,7 @@ test('Successfully gets address tokens - no filters', async t => {
 })
 
 test('Successfully gets address tokens - with filters', async t => {
-    const [token] = await t.context.web3data.address.getTokens(ADDRESS, {includePrice: true})
+    const [token] = await t.context.web3data.address.getTokens(TOKEN_ADDRESS, {includePrice: true})
     t.false(token.hasProp('price'))
 })
 
@@ -289,7 +289,7 @@ test('Successfully gets latest address balance (no filters)', async t => {
 })
 
 test('Successfully gets latest address balance (with filters)', async t => {
-    const balance = await t.context.web3data.address.getBalance(ADDRESS, {includePrice: true, currency: 'btc'})
+    const balance = await t.context.web3data.address.getBalance(TOKEN_ADDRESS, {includePrice: true, currency: 'btc'})
     t.true(balance.hasProp('price'))
     /* Test that balance is numerical */
     t.is(balance.price.balance.currency, 'btc')
@@ -302,7 +302,7 @@ test('Successfully gets historical address balance (no filters)', async t => {
 })
 
 test('Successfully gets historical address balance (with filters)', async t => {
-    const histBalance = await t.context.web3data.address.getBalance(ADDRESS, {startDate: DATES["2019-10-14"], endDate: DATES["2019-10-15"], includePrice: true})
+    const histBalance = await t.context.web3data.address.getBalance(TOKEN_ADDRESS, {startDate: DATES["2019-10-14"], endDate: DATES["2019-10-15"], includePrice: true})
     t.true(histBalance.hasProp('data'))
     t.true(Array.isArray(histBalance.data))
     t.true(histBalance.metadata.columns.includes('price'))
@@ -324,10 +324,10 @@ test('Successfully gets latest address balance + token balances for multiple add
 })
 
 test('Successfully gets latest address balance + token balances + pricing data for multiple addresses ', async t => {
-    const balances = await t.context.web3data.address.getBalance([ADDRESS, '0xce9af648a831ddf0cd6d05e3fe5787b3c7987246'], {includeTokens: true, includePrice: true})
-    t.true(balances.hasProp(ADDRESS))
-    t.true(balances[ADDRESS].hasProp('price'))
-    t.true(balances[ADDRESS].hasProp('tokens'))
+    const balances = await t.context.web3data.address.getBalance([TOKEN_ADDRESS, '0xce9af648a831ddf0cd6d05e3fe5787b3c7987246'], {includeTokens: true, includePrice: true})
+    t.true(balances.hasProp(TOKEN_ADDRESS))
+    t.true(balances[TOKEN_ADDRESS].hasProp('price'))
+    t.true(balances[TOKEN_ADDRESS].hasProp('tokens'))
 
     /* Test that balance is numerical */
     t.regex(balances[ADDRESS].balance, /[0-9]/)

test/address.test.js

@@ -1,5 +1,6 @@
 import test from 'ava'
 import {ERROR_MESSAGE_BLOCK_NO_ID as NO_BLOCK_ID} from '../src/constants'
+import { DATES } from './constants'
 
 import {setUpPolly, getNewWeb3DataInstance} from './utils'
 
@@ -195,7 +196,13 @@ test('Successfully gets block functions - with filters', async t => {
 })
 
 /** ********* Test getMetrics() ***********/
-test('Successfully gets block metrics', async t => {
-    const metrics = await t.context.web3data.block.getMetrics(8805274)
+test.only('Successfully gets block current metrics', async t => {
+    const metrics = await t.context.web3data.block.getMetrics()
     t.true(metrics.hasProp('issuanceTotal'))
 })
+
+test.only('Successfully gets block historical metrics', async t => {
+    const metrics = await t.context.web3data.block.getMetrics({startDate: 1583625600000, endDate: 1583712000000})
+    t.true(metrics.hasProp('records'))
+    t.true(metrics.records[0].hasProp('issuanceTotal'))
+})

test/block.test.js

@@ -0,0 +1,30 @@
+import test from 'ava'
+import {setUpPolly, getNewWeb3DataInstance} from './utils'
+
+/**********************************
+ * -------- Tests Setup ---------- *
+ **********************************/
+test.before(t => {
+    t.context.polly = setUpPolly('blockchain')
+})
+
+test.after(async t => {
+    await t.context.polly.stop()
+})
+
+test.beforeEach(t => {
+    t.context.web3data = getNewWeb3DataInstance()
+})
+
+/** ********* Test getMetrics() ***********/
+test.only('Successfully gets blockchain current metrics', async t => {
+    const metrics = await t.context.web3data.blockchain.getMetrics()
+    t.true(metrics.hasProp('sizeTotal'))
+})
+
+// NOTE: This feature is not yet available
+// test.only('Successfully gets blockchain historical metrics', async t => {
+//     const metrics = await t.context.web3data.blockchain.getMetrics({startDate: 1583625600000, endDate: 1583712000000})
+//     t.true(metrics.hasProp('records'))
+//     t.true(metrics.records[0].hasProp('sizeTotal'))
+// })