Merge pull request #135 from ainblockchain/release/0.3.2

Release/0.3.2

Author: minsulee2

.github/workflows/github-actions.yml

@@ -0,0 +1,32 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  pull_request:
+    types: [opened, edited]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build-and-test:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+      # Setup node environment for testing
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '10.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: npm install
+        run: npm install
+      - name: run unittest
+        run: npm run test_unit
+      - name: run integration test
+        run: npm run test_integration

blockchain/block.js

@@ -2,7 +2,7 @@ const stringify = require('fast-json-stable-stringify');
 const zipper = require('zip-local');
 const sizeof = require('object-sizeof');
 const ainUtil = require('@ainblockchain/ain-util');
-const logger = require('../logger');
+const logger = require('../logger')('BLOCK');
 const ChainUtil = require('../chain-util');
 const Transaction = require('../tx-pool/transaction');
 const DB = require('../db');
@@ -19,8 +19,6 @@ const {
 } = require('../constants');
 const BlockFilePatterns = require('./block-file-patterns');
 
-const LOG_PREFIX = 'BLOCK';
-
 class Block {
   constructor(lastHash, lastVotes, transactions, number, epoch, timestamp, stateProofHash, proposer, validators) {
     this.last_votes = lastVotes;
@@ -111,18 +109,18 @@ class Block {
 
   static validateHashes(block) {
     if (block.hash !== Block.hash(block)) {
-      logger.error(`[${LOG_PREFIX}] Block hash is incorrect for block ${block.hash}`);
+      logger.error(`Block hash is incorrect for block ${block.hash}`);
       return false;
     }
     if (block.transactions_hash !== ChainUtil.hashString(stringify(block.transactions))) {
-      logger.error(`[${LOG_PREFIX}] Transactions or transactions_hash is incorrect for block ${block.hash}`);
+      logger.error(`Transactions or transactions_hash is incorrect for block ${block.hash}`);
       return false;
     }
     if (block.last_votes_hash !== ChainUtil.hashString(stringify(block.last_votes))) {
-      logger.error(`[${LOG_PREFIX}] Last votes or last_votes_hash is incorrect for block ${block.hash}`);
+      logger.error(`Last votes or last_votes_hash is incorrect for block ${block.hash}`);
       return false;
     }
-    logger.info(`[${LOG_PREFIX}] Hash check successfully done`);
+    logger.info(`Hash check successfully done`);
     return true;
   }
 
@@ -140,15 +138,15 @@ class Block {
         continue;
       }
       if (transaction.nonce != nonceTracker[transaction.address] + 1) {
-        logger.error(`[${LOG_PREFIX}] Invalid noncing for ${transaction.address} ` +
+        logger.error(`Invalid noncing for ${transaction.address} ` +
                      `Expected ${nonceTracker[transaction.address] + 1} ` +
                      `Received ${transaction.nonce}`);
         return false;
       }
       nonceTracker[transaction.address] = transaction.nonce;
     }
 
-    logger.info(`[${LOG_PREFIX}] Valid block of number ${block.number}`);
+    logger.info(`Valid block of number ${block.number}`);
     return true;
   }
 
@@ -246,7 +244,7 @@ class Block {
     for (const tx of genesisTransactions) {
       const res = tempGenesisState.executeTransaction(tx);
       if (ChainUtil.transactionFailed(res)) {
-        logger.error(`[${LOG_PREFIX}] Genesis transaction failed:\n${JSON.stringify(tx, null, 2)}\nRESULT: ${JSON.stringify(res)}`)
+        logger.error(`Genesis transaction failed:\n${JSON.stringify(tx, null, 2)}\nRESULT: ${JSON.stringify(res)}`)
         return null;
       }
     }

blockchain/index.js

@@ -4,15 +4,13 @@ const fs = require('fs');
 const glob = require('glob');
 const zipper = require('zip-local');
 const naturalSort = require('node-natural-sort');
-const logger = require('../logger')
+const logger = require('../logger')('BLOCKCHAIN');
 const { Block } = require('./block');
 const BlockFilePatterns = require('./block-file-patterns');
 const { BLOCKCHAINS_DIR } = require('../constants');
 const CHAIN_SUBSECT_LENGTH = 20;
 const ON_MEM_CHAIN_LENGTH = 20;
 
-const LOG_PREFIX = 'BLOCKCHAIN';
-
 class Blockchain {
   constructor(blockchainDir) {
     // Finalized chain
@@ -173,11 +171,11 @@ class Blockchain {
   static isValidChain(chain) {
     const firstBlock = Block.parse(chain[0]);
     if (!firstBlock || firstBlock.hash !== Block.genesis().hash) {
-      logger.error(`[${LOG_PREFIX}] First block is not the Genesis block`);
+      logger.error(`First block is not the Genesis block`);
       return false;
     }
     if (!Block.validateHashes(firstBlock)) {
-      logger.error(`[${LOG_PREFIX}] Genesis block is corrupted`);
+      logger.error(`Genesis block is corrupted`);
       return false;
     }
     // TODO (lia): Check if the tx nonces are correct.
@@ -241,20 +239,20 @@ class Blockchain {
     const refBlockNumber = !!refBlock ? refBlock.number : -1;
     const nextBlockNumber = refBlockNumber + 1;
 
-    logger.info(`[${LOG_PREFIX}] Current last block number: ${this.lastBlockNumber()}, ` +
-                `[${LOG_PREFIX}] Requester's last block number: ${refBlockNumber}`);
+    logger.info(`Current last block number: ${this.lastBlockNumber()}, ` +
+                `Requester's last block number: ${refBlockNumber}`);
 
     const blockFiles = this.getBlockFiles(nextBlockNumber, nextBlockNumber + CHAIN_SUBSECT_LENGTH);
 
     if (blockFiles.length > 0 &&
         (!!(refBlock) && Block.loadBlock(blockFiles[0]).last_hash !== refBlock.hash)) {
-      logger.error(`[${LOG_PREFIX}] Invalid blockchain request. Requesters last block does not belong to this blockchain`);
+      logger.error(`Invalid blockchain request. Requesters last block does not belong to this blockchain`);
       return;
     }
 
     const refBlockHash = refBlock ? refBlock.hash : null;
     if (refBlockHash === this.lastBlock().hash) {
-      logger.info(`[${LOG_PREFIX}] Requesters blockchain is up to date with this blockchain`);
+      logger.info(`Requesters blockchain is up to date with this blockchain`);
       return [this.lastBlock()];
     }
 
@@ -267,9 +265,9 @@ class Blockchain {
 
   merge(chainSubSection) {
     // Call to shift here is important as it removes the first element from the list !!
-    logger.info(`[${LOG_PREFIX}] Last block number before merge: ${this.lastBlockNumber()}`);
+    logger.info(`Last block number before merge: ${this.lastBlockNumber()}`);
     if (!chainSubSection || chainSubSection.length === 0) {
-      logger.info(`[${LOG_PREFIX}] Empty chain sub section`);
+      logger.info(`Empty chain sub section`);
       if (!this.syncedAfterStartup) {
         // Regard this situation as if you're synced.
         // TODO (lia): ask the tracker server for another peer.
@@ -278,11 +276,11 @@ class Blockchain {
       return false;
     }
     if (chainSubSection[chainSubSection.length - 1].number < this.lastBlockNumber()) {
-      logger.info(`[${LOG_PREFIX}] Received chain is of lower block number than current last block number`);
+      logger.info(`Received chain is of lower block number than current last block number`);
       return false;
     }
     if (chainSubSection[chainSubSection.length - 1].number === this.lastBlockNumber()) {
-      logger.info(`[${LOG_PREFIX}] Received chain is at the same block number`);
+      logger.info(`Received chain is at the same block number`);
       if (!this.syncedAfterStartup) {
         // Regard this situation as if you're synced.
         // TODO (lia): ask the tracker server for another peer.
@@ -305,13 +303,13 @@ class Blockchain {
     } else {
       // Case 2: A cold start.
       if (firstBlock.last_hash !== '') {
-        logger.info(`[${LOG_PREFIX}] First block of hash ${firstBlock.hash.substring(0, 5)} ` +
+        logger.info(`First block of hash ${firstBlock.hash.substring(0, 5)} ` +
                     `and last hash ${firstBlock.last_hash.substring(0, 5)} is not a genesis block`);
         return false;
       }
     }
     if (!Blockchain.isValidChainSubsection(chainSubSection)) {
-      logger.error(`[${LOG_PREFIX}] Invalid chain subsection`);
+      logger.error(`Invalid chain subsection`);
       return false;
     }
     for (let i = 0; i < chainSubSection.length; i++) {
@@ -322,11 +320,11 @@ class Blockchain {
       }
       // TODO(lia): validate the state proof of each block
       if (!this.addNewBlockToChain(block)) {
-        logger.error(`[${LOG_PREFIX}] Failed to add block ` + block);
+        logger.error(`Failed to add block ` + block);
         return false;
       }
     }
-    logger.info(`[${LOG_PREFIX}] Last block number after merge: ${this.lastBlockNumber()}`);
+    logger.info(`Last block number after merge: ${this.lastBlockNumber()}`);
     return true;
   }
 
@@ -339,10 +337,10 @@ class Blockchain {
     });
 
     if (Blockchain.isValidChain(newChain)) {
-      logger.info(`[${LOG_PREFIX}] Valid chain of size ${newChain.length}`);
+      logger.info(`Valid chain of size ${newChain.length}`);
       return newChain;
     }
-    logger.error(`[${LOG_PREFIX}] Invalid chain`);
+    logger.error(`Invalid chain`);
     rimraf.sync(chainPath + '/*');
     return null;
   }

chain-util.js

@@ -131,6 +131,14 @@ class ChainUtil {
     return (formatted.startsWith('/') ? '' : '/') + formatted;
   }
 
+  static appendPath(path, ...pathsToAppend) {
+    const labels = ChainUtil.parsePath(path);
+    for (let toAppend of pathsToAppend) {
+      labels.push(...ChainUtil.parsePath(toAppend));
+    }
+    return ChainUtil.formatPath(labels);
+  }
+
   static getJsObject(obj, path) {
     if (!ChainUtil.isArray(path)) {
       return null;

client/index.js

@@ -5,7 +5,7 @@ const fs = require('fs');
 const semver = require('semver');
 const express = require('express');
 const jayson = require('jayson');
-const logger = require('../logger');
+const logger = require('../logger')('CLIENT');
 const BlockchainNode = require('../node');
 const P2pServer = require('../server');
 const ChainUtil = require('../chain-util');
@@ -14,11 +14,10 @@ const { ConsensusStatus } = require('../consensus/constants');
 const CURRENT_PROTOCOL_VERSION = require('../package.json').version;
 
 const MAX_BLOCKS = 20;
-const CLIENT_PREFIX = 'CLIENT';
 
 // NOTE(seo): This is very useful when the server dies without any logs.
 process.on('uncaughtException', function (err) {
-  logger.error(`[${CLIENT_PREFIX}]` + err);
+  logger.error(err);
 });
 
 process.on('SIGINT', _ => {
@@ -34,17 +33,9 @@ if (!semver.valid(CURRENT_PROTOCOL_VERSION)) {
   throw Error("Wrong version format is specified in package.json");
 }
 const VERSION_LIST = JSON.parse(fs.readFileSync(PROTOCOL_VERSIONS));
-const MAJOR_MINOR_VERSION =
-    `${semver.major(CURRENT_PROTOCOL_VERSION)}.${semver.minor(CURRENT_PROTOCOL_VERSION)}`;
-if (!semver.valid(semver.coerce(MAJOR_MINOR_VERSION))) {
-  throw Error("Given major and minor version does not correctly setup");
-}
-if (!VERSION_LIST[MAJOR_MINOR_VERSION]) {
-  throw Error("Current protocol version doesn't exist in the protocol versions file");
-}
-const minProtocolVersion =
-    VERSION_LIST[MAJOR_MINOR_VERSION].min || CURRENT_PROTOCOL_VERSION;
-const maxProtocolVersion = VERSION_LIST[MAJOR_MINOR_VERSION].max;
+const { min, max } = matchVersions(CURRENT_PROTOCOL_VERSION);
+const minProtocolVersion = min === undefined ? CURRENT_PROTOCOL_VERSION : min;
+const maxProtocolVersion = max;
 
 const app = express();
 app.use(express.json()); // support json encoded bodies
@@ -326,6 +317,14 @@ app.get('/get_address', (req, res, next) => {
     .end();
 });
 
+app.get('/get_sharding', (req, res, next) => {
+  const result = node.getSharding();
+  res.status(200)
+    .set('Content-Type', 'application/json')
+    .send({code: result !== null ? 0 : 1, result})
+    .end();
+});
+
 app.get('/get_raw_consensus_state', (req, res) => {
   const result = p2pServer.consensus.getRawState();
   res.status(200)
@@ -345,8 +344,8 @@ app.get('/get_consensus_state', (req, res) => {
 // We will want changes in ports and the database to be broadcast across
 // all instances so lets pass this info into the p2p server
 const server = app.listen(PORT, () => {
-  logger.info(`[${CLIENT_PREFIX}] App listening on port ${PORT}`);
-  logger.info(`[${CLIENT_PREFIX}] Press Ctrl+C to quit.`);
+  logger.info(`App listening on port ${PORT}`);
+  logger.info(`Press Ctrl+C to quit.`);
 });
 
 server.keepAliveTimeout = 620 * 1000; // 620 seconds
@@ -410,13 +409,37 @@ function checkIfTransactionShouldBeNonced(input) {
   return input.is_nonced_transaction !== undefined ? input.is_nonced_transaction : true;
 }
 
+function isValidVersionMatch(ver) {
+  return ver && semver.valid(semver.coerce(ver.min)) &&
+      (!ver.max || semver.valid(semver.coerce(ver.max)));
+}
+
+function matchVersions(ver) {
+  let match = VERSION_LIST[ver];
+  if (isValidVersionMatch(match)) {
+    return match;
+  }
+  const majorVer = semver.major(ver);
+  const majorMinorVer = `${majorVer}.${semver.minor(ver)}`;
+  match = VERSION_LIST[majorMinorVer];
+  if (isValidVersionMatch(match)) {
+    return match;
+  }
+  match = VERSION_LIST[majorVer];
+  if (isValidVersionMatch(match)) {
+    return match;
+  }
+  return {};
+}
+
 function validateVersion(req, res, next) {
   let version = null;
   if (req.query.protoVer) {
     version = req.query.protoVer;
   } else if (req.body.params) {
     version = req.body.params.protoVer;
   }
+  const coercedVer = semver.coerce(version);
   if (req.body.method === 'ain_getProtocolVersion' ||
       req.body.method === 'ain_checkProtocolVersion') {
     next();
@@ -426,14 +449,14 @@ function validateVersion(req, res, next) {
     .send({code: 1, message: "Protocol version not specified.",
            protoVer: CURRENT_PROTOCOL_VERSION})
     .end();
-  } else if (!semver.valid(version)) {
+  } else if (!semver.valid(coercedVer)) {
     res.status(200)
       .set('Content-Type', 'application/json')
       .send({code: 1, message: "Invalid protocol version.",
              protoVer: CURRENT_PROTOCOL_VERSION})
       .end();
-  } else if (semver.gt(minProtocolVersion, version) ||
-      (maxProtocolVersion && semver.lt(maxProtocolVersion, version))) {
+  } else if (semver.lt(coercedVer, minProtocolVersion) ||
+      (maxProtocolVersion && semver.gt(coercedVer, maxProtocolVersion))) {
     res.status(200)
     .set('Content-Type', 'application/json')
     .send({code: 1, message: "Incompatible protocol version.",

client/protocol_versions.json

@@ -1,6 +1,5 @@
 {
-    "0.3": {
-        "min": "0.3.1",
-        "max": "0.3.1"
-    }
+  "0.3.2": {
+    "min": "0.3.2"
+  }
 }