Merge pull request #2676 from w3f/will-filtered

Add Nominator FIltering

Author: wpank

apps/1kv-backend/templates/kusama-otv-backend.yaml

@@ -17,7 +17,7 @@ spec:
   source:
     repoURL: https://w3f.github.io/helm-charts/
     chart: otv-backend
-    targetRevision: v3.0.24
+    targetRevision: v3.0.25
     plugin:
       env:
         - name: HELM_VALUES

apps/1kv-backend/templates/polkadot-otv-backend.yaml

@@ -17,7 +17,7 @@ spec:
   source:
     repoURL: https://w3f.github.io/helm-charts/
     chart: otv-backend
-    targetRevision: v3.0.24
+    targetRevision: v3.0.25
     plugin:
       env:
         - name: HELM_VALUES

charts/otv-backend/Chart.yaml

@@ -1,5 +1,5 @@
 description: 1K Validators Backend
 name: otv-backend
-version: v3.0.24
-appVersion: v3.0.24
+version: v3.0.25
+appVersion: v3.0.25
 apiVersion: v2

packages/common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1kv/common",
-  "version": "3.0.24",
+  "version": "3.0.25",
   "description": "Services for running the Thousand Validator Program.",
   "main": "build/index.js",
   "types": "build/index.d.ts",

packages/common/src/chaindata/chaindata.ts

@@ -83,19 +83,19 @@ export class ChainData {
   }
 
   checkApiConnection = async (retries = 0): Promise<boolean> => {
-    if (!this.api?.isConnected) {
+    if (!this.handler.getApi()?.isConnected) {
       if (retries < CHAINDATA_RETRIES) {
-        logger.warn(
-          `Retries: ${retries} - API is not connected, waiting...`,
-          chaindataLabel,
-        );
+        // logger.warn(
+        //   `Retries: ${retries} - API is not connected, waiting...`,
+        //   chaindataLabel,
+        // );
         await sleep(CHAINDATA_SLEEP);
 
         retries++;
         return await this.checkApiConnection(retries);
       } else {
         logger.warn(`Performing health check on api...`, chaindataLabel);
-        await this.api?.disconnect();
+        await this.handler.getApi()?.disconnect();
         const healthy = await this.handler.healthCheck();
         if (healthy) {
           this.api = this.handler.getApi();

packages/common/src/constants.ts

@@ -41,7 +41,7 @@ export const POLKADOT_API_TIMEOUT = 1000000;
 
 export const CHAINDATA_RETRIES = 20;
 
-export const CHAINDATA_SLEEP = 10000;
+export const CHAINDATA_SLEEP = 300;
 
 export const API_PROVIDER_TIMEOUT = 10000;
 

packages/common/src/nominator/nominator.ts

@@ -36,6 +36,7 @@ export interface NominatorStatus {
   rewardDestination?: string;
   stale?: boolean;
   dryRun?: boolean;
+  shouldNominate?: boolean;
 }
 
 export default class Nominator extends EventEmitter {
@@ -61,6 +62,8 @@ export default class Nominator extends EventEmitter {
     reason: "",
   };
 
+  public _shouldNominate = false;
+
   private _status: NominatorStatus = {
     status: "Init",
     bondedAddress: "",
@@ -130,12 +133,25 @@ export default class Nominator extends EventEmitter {
     this._status = { ...this._status, ...newStatus };
   };
 
+  public async shouldNominate(): Promise<boolean> {
+    const stash = await this.stash();
+    const isBonded = await this.chaindata.isBonded(stash);
+    const [bonded, err] = await this.chaindata.getDenomBondedAmount(stash);
+
+    const currentEra = (await this.chaindata.getCurrentEra()) || 0;
+    const lastNominationEra =
+      (await this.chaindata.getNominatorLastNominationEra(stash)) || 0;
+    this._shouldNominate = isBonded && currentEra - lastNominationEra >= 1;
+    return this._shouldNominate;
+  }
+
   public async init(): Promise<NominatorStatus> {
     try {
       const stash = await this.stash();
       const isBonded = await this.chaindata.isBonded(stash);
       const [bonded, err] = await this.chaindata.getDenomBondedAmount(stash);
 
+      const currentEra = (await this.chaindata.getCurrentEra()) || 0;
       const lastNominationEra =
         (await this.chaindata.getNominatorLastNominationEra(stash)) || 0;
       const currentTargets =
@@ -163,11 +179,14 @@ export default class Nominator extends EventEmitter {
         this.signer.address,
       );
 
+      this._shouldNominate =
+        bonded > 50 && isBonded && currentEra - lastNominationEra >= 1;
+
       const rewardDestination = await this.payee();
-      const currentEra = (await this.chaindata.getCurrentEra()) || 0;
+
       const stale = isBonded && currentEra - lastNominationEra > 8;
       const status: NominatorStatus = {
-        status: "Init",
+        status: this._shouldNominate ? "Initialized" : "Existing Nomination",
         bondedAddress: this.bondedAddress,
         stashAddress: await this.stash(),
         bondedAmount: Number(bonded),
@@ -182,6 +201,7 @@ export default class Nominator extends EventEmitter {
         stale: stale,
         dryRun: this._dryRun,
         updated: Date.now(),
+        shouldNominate: this._shouldNominate,
       };
       this.updateNominatorStatus(status);
       this._canNominate = {

packages/common/src/scorekeeper/Nominating.ts

@@ -45,7 +45,6 @@ export const doNominations = async (
       return null;
     }
 
-    // ensure the group is sorted by least avg stake
     for (const nominator of nominatorGroups) {
       const nomStash = await nominator.stash();
       const nominatorLastNominated =

packages/common/src/scorekeeper/Round.ts

@@ -34,6 +34,12 @@ export const startRound = async (
   if (nominating) return [];
   nominating = true;
 
+  const filteredNominators = await Promise.all(
+    nominatorGroups.filter(async (nom) => {
+      return await nom.shouldNominate();
+    }),
+  );
+
   const now = new Date().getTime();
 
   // The nominations sent now won't be active until the next era.
@@ -48,7 +54,7 @@ export const startRound = async (
     `New round is starting! Era ${newEra} will begin new nominations.`,
   );
 
-  for (const nom of nominatorGroups) {
+  for (const nom of filteredNominators) {
     const nominatorStatus: NominatorStatus = {
       status: `Round Started`,
       updated: Date.now(),
@@ -97,7 +103,7 @@ export const startRound = async (
     }
   }
 
-  for (const nom of nominatorGroups) {
+  for (const nom of filteredNominators) {
     const nominatorStatus: NominatorStatus = {
       status: `Scoring Candidates...`,
       updated: Date.now(),
@@ -135,7 +141,7 @@ export const startRound = async (
   // TODO unit test that assets this  value
   const numValidatorsNominated = await doNominations(
     sortedCandidates,
-    nominatorGroups,
+    filteredNominators,
     chaindata,
     handler,
     bot,

packages/common/src/scorekeeper/jobs/specificJobs/MainScorekeeperJob.ts

@@ -51,12 +51,12 @@ export const mainScorekeeperJob = async (
     mainScoreKeeperLabel,
   );
   const hasOld = await Promise.all(
-    nominatorGroups.map(async (nom) => {
+    nominatorGroups.filter(async (nom) => {
       const stash = await nom.stash();
       if (!stash || stash === "0x") return false;
       const lastNominatedEra =
         await chaindata.getNominatorLastNominationEra(stash);
-      return lastNominatedEra < activeEra - eraBuffer;
+      return lastNominatedEra <= activeEra - 1;
     }),
   );
 
@@ -112,7 +112,7 @@ export const mainScorekeeperJob = async (
       nominating,
       bot,
       constraints,
-      nominatorGroups,
+      hasOld,
       chaindata,
       handler,
       config,