Improve model clarity

tests/difference/core/model/src/common.ts

@@ -83,9 +83,13 @@ type Undelegate = {
 
 type ConsumerSlash = {
   kind: string;
+  // The validator unique id, corresponds to real validator identity
+  // ie. the provider indentity
   val: Validator;
   infractionHeight: number;
   isDowntime: boolean;
+  // The vscid at which the validator was active, used to map
+  // the validator unique id to a consumer consensus address.
   vscid: number;
 };
 
@@ -108,7 +112,7 @@ type EndAndBeginBlock = {
 type SystemSnapshot = {
   h: Record<Chain, number>;
   t: Record<Chain, number>;
-  lastVscid: Record<Chain, number>;
+  latestVscid: Record<Chain, number>;
   tokens: number[];
   status: Status[];
   undelegationQ: Undelegation[];

tests/difference/core/model/src/main.ts

@@ -124,7 +124,7 @@ class ActionGenerator {
       // since the last maturity.
       return (
         this.model.blocks
-          .getNonMaturedRecentConsumerValidators()
+          .getConsumerValidatorRecentActiveVSCIDs()
           .has((a as ConsumerSlash).val) &&
         2 <= this.didSlash.filter((x) => !x).length
       );
@@ -155,14 +155,15 @@ class ActionGenerator {
     // Update internal state to prevent jailing all validators
     if (a.kind === 'ConsumerSlash') {
       const val = (a as ConsumerSlash).val;
+      // Don't slash the same validator twice
       this.didSlash[val] = true;
       const vscids = this.model.blocks
-        .getNonMaturedRecentConsumerValidators()
+        .getConsumerValidatorRecentActiveVSCIDs()
         .get(val);
       const items = Array.from(vscids as Set<number>);
+      // Take a random vscid
       const vscid = items[Math.floor(Math.random() * items.length)];
       (a as ConsumerSlash).vscid = vscid;
-      // console.log((a as ConsumerSlash).val, (a as ConsumerSlash).vscid);
     }
     // Update internal state to prevent expiring light clients
     // Client is also updated for Deliver, because this is needed in practice

tests/difference/core/model/src/model.ts

@@ -631,7 +631,7 @@ class Model {
     return cloneDeep({
       h: this.h,
       t: this.t,
-      lastVscid: {
+      latestVscid: {
         provider: this.ccvP.vscID,
         consumer: this.ccvC.hToVscID[this.h[C] + 1],
       },

tests/difference/core/model/src/properties.ts

@@ -11,6 +11,7 @@ import {
   CommittedBlock,
   Status,
   SystemSnapshot,
+  Validator,
 } from './common.js';
 
 /**
@@ -147,11 +148,12 @@ class BlockHistory {
   };
 
   /**
-   * @returns Get a map of vscid to the set of validators
-   * who were validating at that vscid on the consumer chain.
+   * @returns a map of validator id to the set of vscids
+   * where that validator was validating, since the last
+   * maturity sent by the consumer
    */
-  getNonMaturedRecentConsumerValidators = (): Map<
-    number,
+  getConsumerValidatorRecentActiveVSCIDs = (): Map<
+    Validator,
     Set<number>
   > => {
     const greatestCommittedConsumerHeight = _.max(
@@ -173,7 +175,7 @@ class BlockHistory {
               ret.set(i, new Set<number>());
             }
             const set = ret.get(i);
-            const vscid = ss.lastVscid[C];
+            const vscid = ss.latestVscid[C];
             set?.add(vscid);
           }
         });