Merge pull request #202 from ainblockchain/release/v0.6.0

Release/v0.6.0

Author: minsulee2

.eslintrc.json

@@ -15,10 +15,7 @@
       "error",
       { "code": 100 }
     ],
-    "object-curly-spacing": [
-      "error",
-      "never"
-    ],
+    "object-curly-spacing": "off",
     "comma-dangle": [
       "error",
       "only-multiline"

.github/workflows/github-actions.yml

@@ -1,32 +1,58 @@
-# This is a basic workflow to help you get started with Actions
+name: AIN-blockchain CI/CD
 
-name: CI
-
-# Controls when the action will run. Triggers the workflow on push or pull request
-# events but only for the master branch
 on:
+  push:
+    branches:
+      - 'develop'
+      - 'release/*'
+      - 'master'
   pull_request:
-    types: [opened, edited]
-
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+    branches:
+      - 'develop'
+      - 'release/*'
+      - 'master'
 jobs:
-  # This workflow contains a single job called "build"
-  build-and-test:
-    # The type of runner that the job will run on
+  build_and_test:
+    if: ${{ github.event_name == 'pull_request' && github.event.action == 'opened' }}
     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'
+          node-version: '12.16'
           registry-url: 'https://registry.npmjs.org'
+      - name: test
+        run: echo ${{github.event_name}}
       - name: npm install
         run: npm install
       - name: run unittest
         run: npm run test_unit
       - name: run integration test
+        if: github.event.pull_request.base.ref == 'master'   # integration test only run when master merging
         run: npm run test_integration
+  check_protocol_version:
+    if: ${{ github.event_name == 'push' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: test
+        if: github.event_name == 'push'
+        run: echo ${{github.event_name}}
+      - name: get current version
+        run: echo "VERSION=$(cat package.json | jq -r '.version')" >> $GITHUB_ENV
+      - name: get min/max versions
+        run: |
+          echo "MIN_VERSION=$(cat client/protocol_versions.json | jq -r --arg var "$VERSION" '.[$var].min')" >> $GITHUB_ENV
+          echo "MAX_VERSION=$(cat client/protocol_versions.json | jq -r --arg var "$VERSION" '.[$var].max')" >> $GITHUB_ENV
+      - name: send results
+        env:
+          SLACK_WEBHOOK_TOKEN: ${{ secrets.SLACK_WEBHOOK_TOKEN }}
+        run: |
+          curl -X POST https://hooks.slack.com/services/$SLACK_WEBHOOK_TOKEN \
+            -H "Content-Type: application/json" \
+            -d '{"username": "ain-blockchain",
+            "channel": "blockchain-testnet-deploy",
+            "text": "New PR has just been merged(${{ github.ref }}, ${{ github.sha }}).\nCurrent version: '"$VERSION"', compatible with min('"$MIN_VERSION"'), max('"$MAX_VERSION"')",
+            "icon_emoji": ":gem:"}'

README.md

@@ -62,7 +62,7 @@ docker pull ainblockchain/tracker-server
 ```
 - Run with Docker image
 ```
-docker run -e HOSTING_ENV="gcp" --network="host" -d ainblockchain/tracker-server:latest
+docker run --network="host" -d ainblockchain/tracker-server:latest
 ```
 -->
 
@@ -92,21 +92,20 @@ yarn install
 ```
 - Run blockchain nodes
 ```
-NUM_VALIDATORS=4 ACCOUNT_INDEX=0 HOSTING_ENV=local DEBUG=false node client/index.js
-NUM_VALIDATORS=4 ACCOUNT_INDEX=1 HOSTING_ENV=local DEBUG=false node client/index.js 
-NUM_VALIDATORS=4 ACCOUNT_INDEX=2 HOSTING_ENV=local DEBUG=false node client/index.js 
-NUM_VALIDATORS=4 ACCOUNT_INDEX=3 HOSTING_ENV=local DEBUG=false node client/index.js 
+ACCOUNT_INDEX=0 DEBUG=false STAKE=250 node client/index.js
+ACCOUNT_INDEX=1 DEBUG=false STAKE=250 node client/index.js 
+ACCOUNT_INDEX=2 DEBUG=false STAKE=250 node client/index.js
 ```
-The environment variable `NUM_VALIDATORS` has default value `5`.
 You can override default port numbering system by setting `PORT` and `P2P_PORT` environment variables.
 Before starting node jobs, remove existing blockchain files and logs if necessary:
 ```
 rm -rf blockchain/blockchains logger/logs
 ```
-The default size of the validator whitelist is 5. Set NUM_VALIDATORS environment variable when running the first node if you'd like to run different number of validator nodes than 5.
-The genesis configs directory used is `blockchain` by default and it can be altered using `GENESIS_CONFIGS_DIR` env variable. For example, afan shard cluster can use the following command line:
+The default minimum size of the validator whitelist is 3. Change MIN_NUM_VALIDATORS parameter in 
+the genesis-configs/base/genesis.json to change this value. You may also need to modify the GENESIS_WHITELIST and GENESIS_VALIDATORS accordingly.
+The genesis configs directory used is `genesis-configs/base` by default and it can be altered using `GENESIS_CONFIGS_DIR` env variable. For example, afan shard cluster can use the following command line:
 ```
-GENESIS_CONFIGS_DIR=blockchain/afan_shard NUM_VALIDATORS=1 ACCOUNT_INDEX=0 HOSTING_ENV=local DEBUG=false node client/index.js
+GENESIS_CONFIGS_DIR=genesis-configs/afan-shard ACCOUNT_INDEX=0 DEBUG=false STAKE=250 node client/index.js
 ```
 
 ### How to run tests
@@ -153,7 +152,7 @@ docker pull ainblockchain/blockchain-database
 ```
 - Run with Docker image
 ```
-docker run -e ACCOUNT_INDEX=0 -e HOSTING_ENV="gcp" -e TRACKER_WS_ADDR="ws://<ip_address_of_tracker_server>:5000" --network="host" -d ainblockchain/ain-blockchain:latest
+docker run -e ACCOUNT_INDEX=0 --network="host" -d ainblockchain/ain-blockchain:latest
 ```
 
 #### Enter Docker container and inspect blockchain files

blockchain/block.js

@@ -10,7 +10,7 @@ const DB = require('../db');
 const {
   PredefinedDbPaths,
   GenesisAccounts,
-  GenesisWhitelist,
+  GENESIS_VALIDATORS,
   GenesisValues,
   GenesisFunctions,
   GenesisRules,
@@ -25,21 +25,20 @@ class Block {
   constructor(lastHash, lastVotes, transactions, number, epoch, timestamp,
       stateProofHash, proposer, validators) {
     this.last_votes = lastVotes;
-    this.transactions = transactions;
+    this.transactions = Block.sanitizeTransactions(transactions);
     // Block's header
     this.last_hash = lastHash;
     this.last_votes_hash = ChainUtil.hashString(stringify(lastVotes));
-    this.transactions_hash = ChainUtil.hashString(stringify(transactions));
+    this.transactions_hash = ChainUtil.hashString(stringify(this.transactions));
     this.number = number;
     this.epoch = epoch;
     this.timestamp = timestamp;
-    // TODO(lia): change this to snake case
-    this.stateProofHash = stateProofHash;
+    this.state_proof_hash = stateProofHash;
     this.proposer = proposer;
     this.validators = validators;
-    this.size = sizeof(this.transactions);
     // Hash of block's header
     this.hash = Block.hash(this);
+    this.size = Block.getSize(this);
   }
 
   get header() {
@@ -50,10 +49,16 @@ class Block {
       number: this.number,
       epoch: this.epoch,
       timestamp: this.timestamp,
-      stateProofHash: this.stateProofHash,
+      state_proof_hash: this.state_proof_hash,
       proposer: this.proposer,
       validators: this.validators,
-      size: this.size
+    };
+  }
+
+  get body() {
+    return {
+      last_votes: this.last_votes,
+      transactions: this.transactions,
     };
   }
 
@@ -66,7 +71,7 @@ class Block {
             number:            ${this.number}
             epoch:             ${this.epoch}
             timestamp:         ${this.timestamp}
-            stateProofHash:    ${this.stateProofHash}
+            state_proof_hash:  ${this.state_proof_hash}
             proposer:          ${this.proposer}
             validators:        ${this.validators}
             size:              ${this.size}
@@ -76,11 +81,29 @@ class Block {
             transactions:      ${stringify(this.transactions)}`;
   }
 
+  static sanitizeTransactions(transactions) {
+    const sanitized = [];
+    transactions.forEach((tx) => {
+      sanitized.push({
+        tx_body: Transaction.sanitizeTxBody(tx.tx_body),
+        signature: tx.signature,
+        hash: tx.hash,
+        address: tx.address
+      });
+    });
+    return sanitized;
+  }
+
   static hash(block) {
     if (!(block instanceof Block)) block = Block.parse(block);
     return ChainUtil.hashString(stringify(block.header));
   }
 
+  static getSize(block) {
+    if (!(block instanceof Block)) block = Block.parse(block);
+    return sizeof({...block.header, ...block.body});
+  }
+
   static create(lastHash, lastVotes, transactions, number, epoch,
       stateProofHash, proposer, validators) {
     return new Block(lastHash, lastVotes, transactions, number, epoch, Date.now(),
@@ -102,35 +125,42 @@ class Block {
     if (blockInfo instanceof Block) return blockInfo;
     return new Block(blockInfo.last_hash, blockInfo.last_votes,
         blockInfo.transactions, blockInfo.number, blockInfo.epoch, blockInfo.timestamp,
-        blockInfo.stateProofHash, blockInfo.proposer, blockInfo.validators);
+        blockInfo.state_proof_hash, blockInfo.proposer, blockInfo.validators);
   }
 
   static hasRequiredFields(block) {
     return (block && block.last_hash !== undefined && block.last_votes !== undefined &&
         block.transactions !== undefined && block.number !== undefined &&
         block.epoch !== undefined && block.timestamp !== undefined &&
-        block.stateProofHash !== undefined && block.proposer !== undefined &&
+        block.state_proof_hash !== undefined && block.proposer !== undefined &&
         block.validators !== undefined);
   }
 
   static validateHashes(block) {
+    const LOG_HEADER = 'validateHashes';
+
     if (block.hash !== Block.hash(block)) {
-      logger.error(`Block hash is incorrect for block ${block.hash}`);
+      logger.error(`[${LOG_HEADER}] Block hash is incorrect for block ${block.hash}`);
       return false;
     }
     if (block.transactions_hash !== ChainUtil.hashString(stringify(block.transactions))) {
-      logger.error(`Transactions or transactions_hash is incorrect for block ${block.hash}`);
+      logger.error(
+          `[${LOG_HEADER}] 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(`Last votes or last_votes_hash is incorrect for block ${block.hash}`);
+      logger.error(
+          `[${LOG_HEADER}] Last votes or last_votes_hash is incorrect for block ${block.hash}`);
       return false;
     }
-    logger.info(`Hash check successfully done`);
+    logger.info(
+        `[${LOG_HEADER}] Hash check successfully done for block: ${block.number} / ${block.epoch}`);
     return true;
   }
 
   static validateProposedBlock(block) {
+    const LOG_HEADER = 'validateProposedBlock';
+
     if (!Block.validateHashes(block)) return false;
     const nonceTracker = {};
     let tx;
@@ -144,15 +174,15 @@ class Block {
         continue;
       }
       if (tx.tx_body.nonce != nonceTracker[tx.address] + 1) {
-        logger.error(`Invalid noncing for ${tx.address} ` +
+        logger.error(`[${LOG_HEADER}] Invalid noncing for ${tx.address} ` +
             `Expected ${nonceTracker[tx.address] + 1} ` +
             `Received ${tx.tx_body.nonce}`);
         return false;
       }
       nonceTracker[tx.address] = tx.tx_body.nonce;
     }
 
-    logger.info(`Valid block of number ${block.number}`);
+    logger.info(`[${LOG_HEADER}] Validated block: ${block.number} / ${block.epoch}`);
     return true;
   }
 
@@ -229,6 +259,34 @@ class Block {
     return Transaction.signTxBody(secondTxBody, privateKey);
   }
 
+  static buildGenesisStakingTxs(timestamp) {
+    const _ = require('lodash');
+    const txs = [];
+    Object.entries(GENESIS_VALIDATORS).forEach(([address, amount], index) => {
+      const privateKey = _.get(GenesisAccounts,
+          `${AccountProperties.OTHERS}.${index}.${AccountProperties.PRIVATE_KEY}`);
+      if (!privateKey) {
+        throw Error(`GenesisAccounts missing values: ${JSON.stringify(GenesisAccounts)}, ${address}`);
+      }
+      const txBody = {
+        nonce: -1,
+        timestamp,
+        operation: {
+          type: 'SET_VALUE',
+          ref: ChainUtil.formatPath([
+            PredefinedDbPaths.DEPOSIT_CONSENSUS,
+            address,
+            1,
+            PredefinedDbPaths.DEPOSIT_VALUE
+          ]),
+          value: amount
+        }
+      };
+      txs.push(Transaction.signTxBody(txBody, privateKey));
+    });
+    return txs;
+  }
+
   static getGenesisBlockData(genesisTime) {
     const ownerAddress = ChainUtil.getJsObject(
         GenesisAccounts, [AccountProperties.OWNER, AccountProperties.ADDRESS]);
@@ -237,8 +295,10 @@ class Block {
 
     const firstTx = this.buildDbSetupTx(genesisTime, ownerPrivateKey);
     const secondTx = this.buildAccountsSetupTx(ownerAddress, genesisTime, ownerPrivateKey);
+    // TODO(lia): Change the logic to staking & signing by the current node
+    const stakingTxs = this.buildGenesisStakingTxs(genesisTime);
 
-    return [firstTx, secondTx];
+    return [firstTx, secondTx, ...stakingTxs];
   }
 
   static getGenesisStateProofHash() {
@@ -270,7 +330,7 @@ class Block {
     const number = 0;
     const epoch = 0;
     const proposer = ownerAddress;
-    const validators = GenesisWhitelist;
+    const validators = GENESIS_VALIDATORS;
     const stateProofHash = Block.getGenesisStateProofHash();
     return new Block(lastHash, lastVotes, transactions, number, epoch, genesisTime,
         stateProofHash, proposer, validators);