Move eth2.0 related changes

Author: arman37

eth2.0/testing/args.js

@@ -0,0 +1,47 @@
+const argv = require('argv');
+const _ = require('underscore');
+const { join } = require('path');
+const { lstatSync, readdirSync } = require('fs');
+const isDirectory = source => lstatSync(source).isDirectory();
+const getDirectories = source => readdirSync(source).map(name => join(source, name)).filter(isDirectory);
+
+const args = argv.option([
+  {
+    name: 'validator',
+    short: 'v',
+    type: 'string',
+    description: 'When available, an individual validator (specified by directory name in validators) to run test on, defaults to all.',
+    example: "'npm run test-validator -- --validator=piedao'"
+  },
+  {
+    name: 'timestamp',
+    short: 'ts',
+    type: 'number',
+    description: 'When available, defines a unix timestamp to run the test at, defaults to latest.',
+    example: "'npm run test-validator -- --validator=piedao -- --timestamp=1602667372'"
+  }
+]).run();
+
+const validators = args.options.validator ? [args.options.validator] : getDirectories('eth2.0/validators').map((dir) => dir.split('/')[dir.split('/').length - 1]);
+
+module.exports = {
+  validators: _.map(validators, (validator) => {
+    let path = `eth2.0/validators/${validator}`;
+    let dataObj = {};
+
+    try {
+      dataObj = {
+        ...require(`../../${path}`)
+      }
+    } catch (error) {
+      console.log(error.message);
+    }
+
+    return {
+      path,
+      validator,
+      ...dataObj
+    };
+  }),
+  timestamp: args.options.timestamp ? Number(args.options.timestamp) : undefined,
+};

eth2.0/testing/run.js

@@ -0,0 +1,101 @@
+const fs = require('fs');
+const chai = require('chai');
+const _ = require('underscore');
+const moment = require('moment');
+const shell = require('shelljs');
+const sdk = require('../../sdk');
+const BigNumber = require('bignumber.js');
+
+const balanceCallTimeLimit = 1000 * 60 * 5;
+let testResult = null;
+
+/**
+ *
+ * @param {Object} stakingAdapter
+ * @param {String/Number} timeUnit
+ * @param {Number} timeOffset
+ * @returns {Promise<{output}>}
+ * @private
+ */
+const _run = async (stakingAdapter, timeUnit = 'day', timeOffset = 0) => {
+  try {
+    let addresses = [];
+    let timestamp;
+
+    if (typeof timeUnit === 'number') {
+      timestamp = timeUnit;
+    } else {
+      timestamp = moment().utcOffset(0).startOf(timeUnit).add(timeOffset, timeUnit).unix();
+    }
+
+    if (!Array.isArray(stakingAdapter.address)) {
+      addresses = [stakingAdapter.address];
+    }
+
+    const tvl = await Promise.all(addresses.map(async (address) => {
+      const data = await sdk.api.util.testStakingAdapter(timestamp, address);
+
+      return {
+        depositAddress: address,
+        ...data,
+      }
+    }));
+
+    return {
+      timestamp,
+      tvl,
+    }
+  } catch (error) {
+    console.error(error);
+  }
+};
+
+/**
+ *
+ * @param {Object} stakingAdapter
+ * @param {String/Number} timeUnit
+ * @param {Number} timeOffset
+ */
+module.exports = async (stakingAdapter, timeUnit, timeOffset = 0) => {
+  let label;
+
+  if (typeof timeUnit === 'number') {
+    label = `returns valid tvl data at ${moment.unix(timeUnit).utcOffset(0).format()}`;
+  } else {
+    label = `returns valid tvl data at ${timeUnit} ${timeOffset}`;
+  }
+
+  it(label, async function() {
+    this.timeout(balanceCallTimeLimit);
+    const projectRun = await _run(stakingAdapter, timeUnit, timeOffset);
+    testResult = projectRun;
+    const tvl = projectRun.tvl;
+
+    chai.expect(tvl).to.be.an('array');
+    chai.expect(tvl.length).to.be.at.least(1);
+
+    _.each(tvl, ({ depositAddress, timestamp, block, balance }) => {
+      chai.expect(depositAddress).to.be.a('string');
+
+      chai.expect(timestamp).to.be.a('number');
+      chai.expect(timestamp).to.be.finite;
+
+      chai.expect(block).to.be.a('number');
+      chai.expect(block).to.be.finite;
+
+      chai.expect(balance).to.be.a('number');
+      chai.expect(balance).to.be.finite;
+      chai.expect(balance).to.be.at.least(0);
+    })
+  });
+
+
+  afterEach('save staking adapter output', () => {
+    const time = moment.unix(testResult.timestamp).utcOffset(0).format();
+    const path = `eth2.0/output/${stakingAdapter.name}/staking-tvl`;
+    const name = `${time}.json`;
+
+    shell.mkdir('-p', path);
+    fs.writeFileSync(`${path}/${name}`, JSON.stringify(testResult, null, 2));
+  });
+};

eth2.0/testing/test/index.js

@@ -0,0 +1,35 @@
+const _ = require('underscore');
+const moment = require('moment');
+const args = require('../args');
+const run = require('../run');
+const spotTestCount = 10;
+
+_.each(args.validators, function(stakingAdapter) {
+  describe(`${stakingAdapter.name} eth2.0 staking adapter running & output format`, function () {
+    describe('runs for a variety of points at different times', function() {
+      this.bail(true);
+
+      const latestDay = moment().utcOffset(0).add(-10, 'days').startOf('day').unix();
+      const startDay = moment.unix(stakingAdapter.start).utcOffset(0).startOf('day').unix();
+      const diff = latestDay - startDay;
+      const step = diff / spotTestCount;
+      let spotTests = _.range(latestDay, startDay + 10, -step);
+      spotTests = _.map(spotTests, (spotTest) => {
+        return moment.unix(spotTest).utcOffset(0).startOf('day').unix();
+      });
+
+      spotTests = _.uniq(spotTests);
+
+      run(stakingAdapter, 'hour', 0);
+      run(stakingAdapter, 'hour', -12);
+      run(stakingAdapter, 'hour', -36);
+      run(stakingAdapter, 'hour', -72);
+
+      _.each(spotTests, (timestamp) => {
+        run(stakingAdapter, timestamp, 0,);
+      });
+
+      run(stakingAdapter, startDay < stakingAdapter.start ? startDay + 86400 : startDay);
+    });
+  });
+});

eth2.0/testing/validate/json-validation.js

@@ -0,0 +1,29 @@
+const _ = require('underscore');
+const chai = require('chai');
+const moment = require('moment');
+
+const args = require('../args');
+const categories = [
+  'Pooled',
+  'Custodial',
+];
+
+_.each(args.projects, (stakingAdapter) => {
+  describe(`Checking ${stakingAdapter.name} project adapter metadata`, () => {
+    it('has a valid name', () => {
+      chai.assert.isString(stakingAdapter.name);
+    });
+
+    it('has a valid start time', () => {
+      chai.expect(stakingAdapter.start).to.be.at.most(moment().utcOffset(0).unix(), 'unix start time must be less than the current time')
+    });
+
+    it('category matches one of the defined categories', () => {
+      chai.expect(stakingAdapter.category).to.be.oneOf(categories);
+    });
+
+    it('has a valid staking address', () => {
+      chai.assert.isString(stakingAdapter.symbol);
+    });
+  });
+});

eth2.0/validators/f2pool/index.js

@@ -0,0 +1,6 @@
+module.exports = {
+  name: "F2Pool",
+  category: "Pooled",
+  start: 1602667372,
+  address: '0x61c808d82a3ac53231750dadc13c777b59310bd9'
+};

eth2.0/validators/piedao/index.js

@@ -0,0 +1,6 @@
+module.exports = {
+  name: "Piedao",
+  category: "Pooled",
+  start: 1602667372,
+  address: '0x66827bcd635f2bb1779d68c46aeb16541bca6ba8'
+};