Merge pull request #11 from Alethio/ibft2-validators

POA validators

Author: baxy

.env.sample

@@ -4,6 +4,7 @@ TZ=UTC
 
 NETWORK_ID=1
 NETWORK_NAME=mainnet
+NETWORK_ALGO=ethash
 
 APP_HOST=localhost
 APP_PORT=3000

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [1.5.2] - 2019-06-05
+- Add support for validators/signers on POA networks ("ibft2" and "clique" consensus algorithms)
+
 ## [1.5.1] - 2019-05-22
 - Add "clientTimeout" message sent to the client when inactive for more then 3 minutes
 

app/controllers/api/BlocksController.js

@@ -1,4 +1,5 @@
 import AbstractController from './AbstractController.js';
+import BlockUtils from '../../lib/BlockUtils.js';
 
 export default class BlocksController extends AbstractController {
   get(request, response) {
@@ -138,7 +139,7 @@ export default class BlocksController extends AbstractController {
       this.models.Usage.get({nodeName: nodeName, timestampEnd: confirmationTimestamp, order: 'desc', limit: 1})
     ];
 
-    return Promise.all(allPromises).then(results => {
+    return Promise.all(allPromises).then(async results => {
       let nodeData = {
         nodeData: (results[0] && results[0].rowLength > 0) ? results[0].rows[0] : null,
         firstLogin: (results[1] && results[1].rowLength > 0) ? results[1].rows[0] : null,
@@ -154,6 +155,17 @@ export default class BlocksController extends AbstractController {
         nodeData.lastLogin = nodeData.firstLogin;
       }
 
+      if (nodeData.lastBlock) {
+        if (this.appConfig.NETWORK_ALGO === 'ibft2' && nodeData.lastBlock.extraData) {
+          nodeData.lastBlock.validators = BlockUtils.getIBFT2Validators(nodeData.lastBlock.extraData);
+        }
+
+        if (this.appConfig.NETWORK_ALGO === 'clique') {
+          let validators = await this.models.Validators.get({blockNumber: nodeData.lastBlock.number, blockHash: nodeData.lastBlock.hash});
+          nodeData.lastBlock.validators = (validators && validators.rowLength > 0) ? JSON.parse(validators.rows[0].validators) : [];
+        }
+      }
+
       nodeData.nodeData.isActive = true;
       return this.result.setupNodeData(nodeData, false);
     });

app/controllers/consumer/BlocksController.js

@@ -1,4 +1,5 @@
 import AbstractController from './AbstractController.js';
+import BlockUtils from '../../lib/BlockUtils.js';
 
 export default class BlocksController extends AbstractController {
   add(params, callback) {
@@ -206,6 +207,10 @@ export default class BlocksController extends AbstractController {
       if (setAsLastBlock) {
         this._setLastBlock(newBlockParams);
         this._sendLastBlockToDeepstream(newBlockParams);
+
+        if (this.appConfig.NETWORK_ALGO === 'ibft2') {
+          this.dsDataLoader.sendValidatorsToDeepstream(BlockUtils.getIBFT2Validators(params));
+        }
       }
 
       if (sendStatisticsToDeepstream) {

app/controllers/server/AbstractController.js

@@ -165,4 +165,46 @@ export default class AbstractController {
       }
     }
   }
+
+  async getConfig(spark, params) {
+    let responseObject = this.lodash.cloneDeep(this.responseObject);
+    let requestValidation = {
+      request: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          configName: {type: 'string'}
+        },
+        required: ['configName']
+      }
+    };
+
+    let validParams = this.validator.validate(requestValidation.request, params);
+    if (!validParams) {
+      responseObject.success = false;
+      responseObject.errors = this.validatorError.getReadableErrorMessages(this.validator.errors);
+
+      return responseObject;
+    }
+
+    let availableConfigs = ['NETWORK_ALGO'];
+
+    if (!availableConfigs.includes(params.configName)) {
+      responseObject.success = false;
+      responseObject.errors.push('Config not found');
+
+      return responseObject;
+    }
+
+    let session = this.session.getAll(spark.id);
+    if (session.isLoggedIn === true) {
+      responseObject.data.push({[params.configName]: this.appConfig[params.configName]});
+      responseObject.dataLength = responseObject.data.length;
+    } else {
+      responseObject.success = false;
+      responseObject.errors.push('Not logged in');
+    }
+
+    return responseObject;
+  }
 }

app/controllers/server/AuthController.js

@@ -179,6 +179,10 @@ export default class AuthController extends AbstractController {
       nodeUsage: null
     };
 
+    if (['ibft2', 'clique'].includes(this.appConfig.NETWORK_ALGO)) {
+      dataToSend.nodeData.isValidator = false;
+    }
+
     let nodesList = this.deepstream.record.getList(`${this.appConfig.DEEPSTREAM_NAMESPACE}/nodes`);
     nodesList.whenReady(list => {
       if (list.getEntries().includes(dsNodeId)) {

app/controllers/server/BlocksController.js

@@ -294,4 +294,54 @@ export default class BlocksController extends AbstractController {
       return responseObject;
     });
   }
+
+  async addValidators(spark, params) {
+    let responseObject = this.lodash.cloneDeep(this.responseObject);
+    let requestValidation = {
+      request: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+          blockNumber: {type: 'integer'},
+          blockHash: {type: 'string'},
+          validators: {type: 'array'}
+        },
+        required: ['blockNumber', 'blockHash', 'validators']
+      }
+    };
+
+    let validParams = this.validator.validate(requestValidation.request, params);
+    if (!validParams) {
+      responseObject.success = false;
+      responseObject.errors = this.validatorError.getReadableErrorMessages(this.validator.errors);
+
+      return responseObject;
+    }
+
+    let session = this.session.getAll(spark.id);
+    if (session.isLoggedIn === true) {
+      this.cache.getVar('lastBlockForValidators').then(lastBlockForValidators => {
+        lastBlockForValidators = (lastBlockForValidators === null) ? null : JSON.parse(lastBlockForValidators);
+        if (lastBlockForValidators && ((params.blockNumber - lastBlockForValidators.blockNumber < 0) || (lastBlockForValidators.blockNumber === params.blockNumber && lastBlockForValidators.blockHash === params.blockHash))) {
+          // do nothing
+        } else {
+          this.log.debug(`[${spark.id}] - DB insert validators => ${JSON.stringify(params)}`);
+
+          this.models.Validators.add(params).then(() => {
+            this.dsDataLoader.sendValidatorsToDeepstream(params.validators);
+          });
+
+          this.cache.setVar('lastBlockForValidators', JSON.stringify({
+            blockNumber: params.blockNumber,
+            blockHash: params.blockHash
+          }), this.appConfig.CACHE_LAST_BLOCK_EXPIRE);
+        }
+      });
+    } else {
+      responseObject.success = false;
+      responseObject.errors.push('Not logged in');
+    }
+
+    return responseObject;
+  }
 }

app/lib/AppConfig.js

@@ -43,6 +43,7 @@ export default class AppConfig {
 
   initConfigs(config) {
     config.NETWORK_ID = this._convertToInt(config.NETWORK_ID || 1);
+    config.NETWORK_ALGO = config.NETWORK_ALGO || 'ethash';
 
     config.LOG_SHOW_DATETIME = this._convertToBoolean(config.LOG_SHOW_DATETIME || 1);
     config.LOG_SHOW_INFOS = this._convertToBoolean(this.cli.flags.verbose || config.LOG_SHOW_INFOS || 0);

app/lib/BlockUtils.js

@@ -0,0 +1,22 @@
+import * as rlp from 'rlp';
+
+export default class BlockUtils {
+  static getIBFT2Validators(block) {
+    let validators = [];
+
+    if (block.extraData) {
+      try {
+        let decodedExtraData = rlp.decode(block.extraData);
+        let validatorsRaw = decodedExtraData[1] || [];
+
+        validatorsRaw.forEach(validator => {
+          validators.push('0x' + validator.toString('hex'));
+        });
+      } catch (error) {
+        this.log.error(`Could not decode IBFT2 extraData to get validators for block ${block.number}::${block.hash} => ${error.message}`);
+      }
+    }
+
+    return validators;
+  }
+}

app/lib/DsDataLoader.js

@@ -1,3 +1,6 @@
+import ethonDictionary from './EthonDictionary.js';
+import BlockUtils from './BlockUtils.js';
+
 export default class DsDataLoader {
   constructor(diContainer) {
     this.appConfig = diContainer.appConfig;
@@ -121,8 +124,20 @@ export default class DsDataLoader {
         return this.result.setupNodeData(nodeData, true);
       }
 
-      return this.models.Blocks.getBlock({number: nodeData.lastConfirmations[0].blockNumber, hash: nodeData.lastConfirmations[0].blockHash}).then(lastBlock => {
+      return this.models.Blocks.getBlock({number: nodeData.lastConfirmations[0].blockNumber, hash: nodeData.lastConfirmations[0].blockHash}).then(async lastBlock => {
         nodeData.lastBlock = lastBlock;
+
+        if (nodeData.lastBlock) {
+          if (this.appConfig.NETWORK_ALGO === 'ibft2' && nodeData.lastBlock.extraData) {
+            nodeData.lastBlock.validators = BlockUtils.getIBFT2Validators(nodeData.lastBlock.extraData);
+          }
+
+          if (this.appConfig.NETWORK_ALGO === 'clique') {
+            let validators = await this.models.Validators.get({blockNumber: nodeData.lastBlock.number, blockHash: nodeData.lastBlock.hash});
+            nodeData.lastBlock.validators = (validators && validators.rowLength > 0) ? JSON.parse(validators.rows[0].validators) : [];
+          }
+        }
+
         return this.result.setupNodeData(nodeData, true);
       });
     });
@@ -203,4 +218,22 @@ export default class DsDataLoader {
       this.log.debug(`Deepstream record '${recordId}' delete`);
     });
   }
+
+  sendValidatorsToDeepstream(validators) {
+    this.log.debug(`Deepstream update 'validators': ${JSON.stringify(validators)}`);
+
+    let nodesList = this.deepstream.record.getList(`${this.appConfig.DEEPSTREAM_NAMESPACE}/nodes`);
+    nodesList.whenReady(list => {
+      list.getEntries().forEach(dsNodeId => {
+        this.getRecord(`${dsNodeId}/nodeData`).whenReady(node => {
+          let nodeData = node.get()[ethonDictionary.nodeData];
+          if (nodeData) {
+            if (validators.includes(nodeData[ethonDictionary.coinbase])) {
+              this.setRecord(`${dsNodeId}/nodeData`, 'nodeData.isValidator', true);
+            }
+          }
+        });
+      });
+    });
+  }
 }