feat: robust multivalidator period handling (#379)

* chore: warn if period height data is missing, we gonna miss period data in the db in this case

chore: move periodVotes out of consensus

Make validators store collected periodVotes in a bridgeState object directly, not in a
bridgeState.currentState. The latter represents a consensus state, something the nodes should agree upon.
Collected period votes have nothing to do with a consensus and only needed for proposing validator to submit
a period.

refactored period submission logic

store stalePeriodProposal in db as well

* improve coverage and fix some tests

index.js

@@ -77,7 +77,8 @@ async function run() {
     db,
     privKey,
     config,
-    eventsRelay.relayBuffer
+    eventsRelay.relayBuffer,
+    sender
   );
   global.blockTicker = new BlockTicker(bridgeState.web3, [
     bridgeState.onNewBlock,
@@ -91,8 +92,8 @@ async function run() {
   const nodeConfig = Object.assign({}, cliArgs, { network: config });
 
   app.useTx(txHandler(bridgeState, nodeConfig));
-  app.useBlock(blockHandler(bridgeState, db, nodeConfig, sender));
-  app.usePeriod(periodHandler(bridgeState, sender));
+  app.useBlock(blockHandler(bridgeState, db, nodeConfig));
+  app.usePeriod(periodHandler(bridgeState));
 
   const lastGoodState = await bridgeState.loadState();
 

src/api/createDb.js

@@ -107,6 +107,14 @@ const createDb = levelDb => {
     await levelDb.put('chainState', JSON.stringify(state));
   };
 
+  const getNodeState = () => {
+    return getNullable('nodeState');
+  };
+
+  const storeNodeState = async state => {
+    await levelDb.put('nodeState', JSON.stringify(state));
+  };
+
   const storePeriods = async submissions => {
     const dbOpsBatch = levelDb.batch();
     await Promise.all(
@@ -135,8 +143,10 @@ const createDb = levelDb => {
     getTransaction,
     getTransactionByPrevOut,
     getChainState,
+    getNodeState,
     storeChainState,
     storePeriods,
+    storeNodeState,
     getPeriodData,
   };
 };

src/api/createDb.test.js

@@ -308,4 +308,26 @@ describe('db', () => {
       );
     });
   });
+
+  describe('nodeState', () => {
+    test('store', async () => {
+      const state = { someState: { state: 1 }};
+      const db = createDb(levelMock);
+
+      await db.storeNodeState(state);
+
+      expect(levelMock.put).toHaveBeenCalledWith(
+        'nodeState',
+        JSON.stringify(state)
+      );
+    });
+
+    test('read', async () => {
+      const db = createDb(levelMock);
+
+      await db.getNodeState();
+
+      expect(levelMock.get).toHaveBeenCalledWith('nodeState');
+    });
+  })
 });

src/block/index.js

@@ -1,18 +1,20 @@
 const { logNode } = require('../utils/debug');
 
 const addBlock = require('./addBlock');
-const updatePeriod = require('./updatePeriod');
 const updateValidators = require('./updateValidators');
 const updateEpoch = require('./updateEpoch');
-const isReplay = require('../period/utils/isReplay');
+const handleSlotActivation = require('../validator/handleSlotActivation');
+const handlePeriod = require('../validator/handlePeriod');
 
-module.exports = (bridgeState, db, nodeConfig = {}, sender) => async (
+module.exports = (bridgeState, db, nodeConfig = {}) => async (
   state,
   chainInfo
 ) => {
-  bridgeState.checkCallsCount = 0;
+  const { height } = chainInfo;
 
-  if (chainInfo.height % 32 === 0 && !isReplay(bridgeState)) {
+  bridgeState.checkCallsCount = 0;
+
+  if (height % 32 === 0 && !bridgeState.isReplay()) {
     // catch this, it is not fatal if it fails here
     logNode('Saving state');
     try {
@@ -22,22 +24,24 @@ module.exports = (bridgeState, db, nodeConfig = {}, sender) => async (
     }
   }
 
-  // delete collected votes for submitted period
-  delete (state.periodVotes || {})[bridgeState.lastBlocksRoot];
+  await handlePeriod(height, bridgeState);
 
-  await updatePeriod(state, chainInfo, bridgeState, sender);
+  await handleSlotActivation(height, bridgeState);
+
   await addBlock(state, chainInfo, {
     bridgeState,
     db,
   });
+
   if (!nodeConfig.no_validators_updates && state.slots.length > 0) {
     await updateValidators(state, chainInfo);
   }
 
   updateEpoch(state, chainInfo);
+
   logNode(
     'Height: %d, epoch: %d, epochLength: %d',
-    chainInfo.height,
+    height,
     state.epoch.epoch,
     state.epoch.epochLength
   );
@@ -46,5 +50,5 @@ module.exports = (bridgeState, db, nodeConfig = {}, sender) => async (
   bridgeState.currentState = state;
   bridgeState.blockHeight = chainInfo.height;
 
-  await bridgeState.saveSubmissions();
+  await bridgeState.saveNodeState();
 };