Use NodeId instead of Address in first dimension

By using the NodeId instead of the Address in the first
dimension of the consensus matrice we save quite some
space in the payload which is sent to the browser.

The commit also contains some minor refactoring.

packages/backend/src/Chain.ts

@@ -168,24 +168,24 @@ export default class Chain {
     this.updateConsensusInfo(node);
   }
 
-  private initialiseConsensusView(height: BlockNumber, id1: string, id2: string) {
+  private initialiseConsensusView(height: BlockNumber, id_node1: string, addr_node2: string) {
     if (this.chainConsensusCache[height] === undefined) {
       this.chainConsensusCache[height] = {};
     }
-    if (this.chainConsensusCache[height][id1] === undefined) {
-      this.chainConsensusCache[height][id1] = {};
-      this.chainConsensusCache[height][id1][id2] = {} as Types.ConsensusInfo;
+    if (this.chainConsensusCache[height][id_node1] === undefined) {
+      this.chainConsensusCache[height][id_node1] = {};
+      this.chainConsensusCache[height][id_node1][addr_node2] = {} as Types.ConsensusInfo;
     }
-    if (this.chainConsensusCache[height][id1][id2] === undefined) {
-      this.chainConsensusCache[height][id1][id2] = {} as Types.ConsensusInfo;
+    if (this.chainConsensusCache[height][id_node1][addr_node2] === undefined) {
+      this.chainConsensusCache[height][id_node1][addr_node2] = {} as Types.ConsensusInfo;
     }
   }
 
   private updateConsensusInfo(node: Node) {
     for (let height in node.consensusCache) {
       if (height !== undefined) {
-        this.initialiseConsensusView(parseInt(height) as BlockNumber, String(node.address), String(node.address));
-        this.chainConsensusCache[height][String(node.address)] = node.consensusCache[height];
+        this.initialiseConsensusView(parseInt(height) as BlockNumber, String(node.id), String(node.address));
+        this.chainConsensusCache[height][String(node.id)] = node.consensusCache[height];
       }
     }
 

packages/backend/src/Node.ts

@@ -324,13 +324,12 @@ export default class Node {
     }
   }
 
-  public initialiseConsensusView(height: BlockNumber, id1_: string) {
-    let id1 = id1_;
+  public initialiseConsensusView(height: Types.BlockNumber, addr: Maybe<Types.Address>) {
     if (!(height in this.consensusCache)) {
       this.consensusCache[height] = {};
     }
-    if (!(id1 in this.consensusCache[height])) {
-      this.consensusCache[height][id1] = {} as Types.ConsensusInfo;
+    if (addr && !(addr in this.consensusCache[height])) {
+      this.consensusCache[height][addr] = {} as Types.ConsensusInfo;
     }
   }
 
@@ -348,16 +347,15 @@ export default class Node {
       height: height,
     } = message;
 
-    let addr = String(this.address);
-    this.initialiseConsensusView(height as BlockNumber, addr);
-    this.consensusCache[height as BlockNumber][addr].FinalizedHash = best;
+    this.initialiseConsensusView(height as BlockNumber, this.address);
+    this.consensusCache[height as BlockNumber][String(this.address)].FinalizedHash = best;
     this.events.emit('consensus-info');
   }
 
   public markFinalized(finalizedHeight: BlockNumber, finalizedHash: BlockHash) {
     let addr = String(this.address);
 
-    this.initialiseConsensusView(finalizedHeight, addr);
+    this.initialiseConsensusView(finalizedHeight, this.address);
     this.consensusCache[finalizedHeight][addr].Finalized = true;
     this.consensusCache[finalizedHeight][addr].FinalizedHash = finalizedHash;
     this.consensusCache[finalizedHeight][addr].FinalizedHeight = finalizedHeight;
@@ -373,7 +371,7 @@ export default class Node {
   public markImplicitlyFinalized(finalizedHeight: BlockNumber) {
     let addr = String(this.address);
 
-    this.initialiseConsensusView(finalizedHeight, addr);
+    this.initialiseConsensusView(finalizedHeight, this.address);
     this.consensusCache[finalizedHeight][addr].Finalized = true;
     this.consensusCache[finalizedHeight][addr].FinalizedHeight = finalizedHeight;
     this.consensusCache[finalizedHeight][addr].ImplicitFinalized = true;
@@ -402,8 +400,7 @@ export default class Node {
       target_number: targetNumber,
       target_hash: targetHash,
     } = message;
-    const voter = String(message.voter.replace(/"/g, ''));
-
+    const voter = this.extractVoter(message.voter);
     this.initialiseConsensusView(targetNumber as BlockNumber, voter);
     this.consensusCache[targetNumber as BlockNumber][voter].Precommit = true;
 
@@ -438,8 +435,7 @@ export default class Node {
       target_number: targetNumber,
       target_hash: targetHash,
     } = message;
-    const voter = String(message.voter.replace(/"/g, ''));
-
+    const voter = this.extractVoter(message.voter);
     this.initialiseConsensusView(targetNumber as BlockNumber, voter);
     this.consensusCache[targetNumber as BlockNumber][voter].Prevote = true;
 
@@ -485,28 +481,6 @@ export default class Node {
     }
   }
 
-  // fill the block cache back from the `to` number to the last block.
-  // the function `f` is used to evaluate if we should continue backfilling.
-  private backfill(voter_: string, to: BlockNumber, f: Maybe<(i: BlockNumber) => boolean>) {
-    // if this is the first block in the cache then we don't fill latter blocks
-    if (Object.keys(this.consensusCache).length < 1) {
-      return to;
-    }
-
-    let cont = true;
-    while (cont && to-- > 0) {
-      if (this.consensusCache[to] !== undefined) {
-        // we reached the next block prior to this
-        return to;
-      }
-
-      this.initialiseConsensusView(to, voter_);
-      cont = f ? f(to) : true;
-    }
-
-    return to;
-  }
-
   private onAfgFinalized(message: AfgFinalized) {
     const {
       finalized_number: finalizedNumber,
@@ -516,17 +490,15 @@ export default class Node {
     this.markFinalized(finalizedNumber, finalizedHash);
 
     let to = finalizedNumber;
-    let addr = String(this.address);
-    this.backfill(addr, to as BlockNumber, (i) => {
+    this.backfill(this.address, to as BlockNumber, (i) => {
       i = i as BlockNumber;
-      let addr = String(this.address);
-      const info = this.consensusCache[i][addr];
+      const info = this.consensusCache[i][String(this.address)];
       if (info.Finalized || info.ImplicitFinalized) {
         return false;
       }
 
       this.markImplicitlyFinalized(i);
-      this.consensusCache[i][addr].ImplicitPointer = to;
+      this.consensusCache[i][String(this.address)].ImplicitPointer = to;
 
       let firstBlockReached = String(i) === Object.keys(this.consensusCache)[0];
       if (!this.alreadyFinalized && firstBlockReached) {
@@ -540,6 +512,36 @@ export default class Node {
     this.events.emit('consensus-info');
   }
 
+  // fill the block cache back from the `to` number to the last block.
+  // the function `f` is used to evaluate if we should continue backfilling.
+  private backfill(voter: Maybe<Types.Address>, to: BlockNumber, f: Maybe<(i: BlockNumber) => boolean>) {
+    if (!voter) {
+      return false;
+    }
+
+    // if this is the first block in the cache then we don't fill latter blocks
+    if (Object.keys(this.consensusCache).length < 1) {
+      return to;
+    }
+
+    let cont = true;
+    while (cont && to-- > 0) {
+      if (this.consensusCache[to] !== undefined) {
+        // we reached the next block prior to this
+        return to;
+      }
+
+      this.initialiseConsensusView(to, voter);
+      cont = f ? f(to) : true;
+    }
+
+    return to;
+  }
+
+  private extractVoter(message_voter: String): Types.Address {
+    return String(message_voter.replace(/"/g, '')) as Types.Address;
+  }
+
   private updateLatency(now: Types.Timestamp) {
     // if (this.pingStart) {
     //   console.error(`${this.name} timed out on ping message.`);
@@ -582,7 +584,7 @@ export default class Node {
       }
 
       const target = this.best.number as BlockNumber;
-      this.backfill(String(this.address), target, null);
+      this.backfill(this.address, target, null);
     }
   }
 

packages/common/src/types.ts

@@ -38,7 +38,7 @@ export declare type ConsensusInfo = {
   BlockNumber: ConsensusView;
 };
 export declare type ConsensusView = {
-  Address: ConsensusState;
+  NodeId: ConsensusState;
 };
 export declare type ConsensusState = {
   Address: ConsensusDetail;

packages/frontend/src/components/Consensus/ConsensusBlock.tsx

@@ -105,24 +105,24 @@ export class ConsensusBlock extends React.Component<ConsensusBlock.Props, {}> {
   }
 
   private isFinalized(node: Node): boolean {
-    const { address } = node;
+    const { address, id } = node;
     const consensus = this.props.consensusView;
 
     return consensus !== undefined &&
-      address in consensus &&
-      address in consensus[address] &&
-      consensus[address][address].Finalized === true;
+      id in consensus &&
+      address in consensus[id] &&
+      consensus[id][address].Finalized === true;
   }
 
   private getFinalizedHash(node: Node): Types.BlockHash {
-    const { address } = node;
+    const { address, id } = node;
     const consensus = this.props.consensusView;
 
     if (consensus !== undefined &&
-      address in consensus &&
-      address in consensus[address] &&
-      consensus[address][address].Finalized === true) {
-      return consensus[address][address].FinalizedHash;
+      id in consensus &&
+      address in consensus[id] &&
+      consensus[id][address].Finalized === true) {
+      return consensus[id][address].FinalizedHash;
     }
     return '' as Types.BlockHash;
   }
@@ -132,7 +132,7 @@ export class ConsensusBlock extends React.Component<ConsensusBlock.Props, {}> {
     let finalizedHash;
 
     if (this.isFinalized(node)) {
-      const matrice = this.props.consensusView[node.address][node.address];
+      const matrice = this.props.consensusView[node.id][node.address];
       finalizedInfo = matrice.ImplicitFinalized ?
         <Tooltip text={`${node.name} finalized this block in ${matrice.ImplicitPointer}`}>
           <Icon className="implicit" src={finalizedIcon} alt="" />
@@ -196,9 +196,9 @@ export class ConsensusBlock extends React.Component<ConsensusBlock.Props, {}> {
 
   private getMatriceContent(rowNode: Node, columnNode: Node) {
     const consensusInfo = this.props.consensusView &&
-      rowNode.address in this.props.consensusView &&
-      columnNode.address in this.props.consensusView[rowNode.address] ?
-      this.props.consensusView[rowNode.address][columnNode.address] : null;
+      rowNode.id in this.props.consensusView &&
+      columnNode.address in this.props.consensusView[rowNode.id] ?
+      this.props.consensusView[rowNode.id][columnNode.address] : null;
 
     let tooltipText = consensusInfo ?
         rowNode.name + ' has seen this of ' + columnNode.name + ': ' +