Merge pull request #2902 from w3f/optimize-check-candidate

optimize checkValidateIntention

Author: ironoa

packages/common/src/constraints/CheckCandidates.ts

@@ -1,4 +1,4 @@
-import { logger } from "../index";
+import { ChainData, logger } from "../index";
 import { allCandidates, Candidate, setLastValid, setValid } from "../db";
 import { constraintsLabel, OTV } from "./constraints";
 import {
@@ -22,6 +22,7 @@ import { percentage, timeRemaining } from "../utils/util";
 export const checkCandidate = async (
   constraints: OTV,
   candidate: Candidate,
+  validators: string[],
 ): Promise<boolean> => {
   try {
     let valid = false;
@@ -35,6 +36,7 @@ export const checkCandidate = async (
       constraints.config,
       constraints.chaindata,
       candidate,
+      validators,
     );
     if (!validateValid) {
       logger.info(
@@ -166,14 +168,16 @@ export const checkCandidate = async (
 
 export const checkAllCandidates = async (
   constraints: OTV,
+  chaindata: ChainData,
 ): Promise<boolean> => {
   try {
     const candidates = await allCandidates();
+    const validators = await chaindata.getValidators();
     logger.info(`checking ${candidates.length} candidates`, constraintsLabel);
     for (const [index, candidate] of candidates.entries()) {
       const start = Date.now();
 
-      const isValid = await constraints.checkCandidate(candidate);
+      const isValid = await constraints.checkCandidate(candidate, validators);
       const end = Date.now();
       const time = `(${end - start}ms)`;
       const remaining = timeRemaining(

packages/common/src/constraints/ValidityChecks.ts

@@ -46,9 +46,9 @@ export const checkValidateIntention = async (
   config: Config.ConfigSchema,
   chaindata: ChainData,
   candidate: Candidate,
+  validators: string[],
 ): Promise<boolean> => {
   try {
-    const validators = await chaindata.getValidators();
     if (
       !validators?.length ||
       validators.includes(Util.formatAddress(candidate?.stash, config))
@@ -65,28 +65,6 @@ export const checkValidateIntention = async (
   }
 };
 
-// checks the validate intention for all validators
-export const checkAllValidateIntentions = async (
-  config: Config.ConfigSchema,
-  chaindata: ChainData,
-  candidates: Candidate[],
-): Promise<boolean> => {
-  try {
-    const validators = await chaindata.getValidators();
-    for (const candidate of candidates) {
-      if (!validators.includes(Util.formatAddress(candidate.stash, config))) {
-        await setValidateIntentionValidity(candidate, false);
-      } else {
-        await setValidateIntentionValidity(candidate, true);
-      }
-    }
-    return true;
-  } catch (e) {
-    logger.error(`Error checking validate intentions: ${e}`, constraintsLabel);
-    throw new Error("could not make validity check");
-  }
-};
-
 // checks that the validator is on the latest client version
 export const checkLatestClientVersion = async (
   config: Config.ConfigSchema,

packages/common/src/constraints/constraints.ts

@@ -100,12 +100,15 @@ export class OTV implements Constraints {
 
   // Checks the validity of all candidates
   async checkAllCandidates(): Promise<boolean> {
-    return await checkAllCandidates(this);
+    return await checkAllCandidates(this, this.chaindata);
   }
 
   // Check the candidate and set any invalidity fields
-  async checkCandidate(candidate: Candidate): Promise<boolean> {
-    return await checkCandidate(this, candidate);
+  async checkCandidate(
+    candidate: Candidate,
+    validators: string[],
+  ): Promise<boolean> {
+    return await checkCandidate(this, candidate, validators);
   }
 
   async scoreAllCandidates(): Promise<boolean> {

packages/common/src/scorekeeper/Round.ts

@@ -76,10 +76,11 @@ export const startRound = async (
 
   // Get all Candidates and set validity
   const allCandidates = await queries.allCandidates();
+  const validators = await chaindata.getValidators();
 
   // Set Validity
   for (const [index, candidate] of allCandidates.entries()) {
-    const isValid = await constraints.checkCandidate(candidate);
+    const isValid = await constraints.checkCandidate(candidate, validators);
 
     const progress = Math.floor((index / allCandidates.length) * 100);
     jobStatusEmitter.emit("jobProgress", {

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

@@ -35,6 +35,7 @@ export const validityJob = async (
   try {
     const { constraints } = metadata;
     const candidates = await allCandidates();
+    const validators = await metadata.chaindata.getValidators();
     logger.info(`Checking ${candidates.length} candidates`, constraintsLabel);
 
     // Calculate total number of candidates
@@ -43,7 +44,7 @@ export const validityJob = async (
     for (const [index, candidate] of candidates.entries()) {
       const start = Date.now();
 
-      const isValid = await constraints.checkCandidate(candidate);
+      const isValid = await constraints.checkCandidate(candidate, validators);
       const end = Date.now();
       const time = `(${end - start}ms)`;
       const remaining = timeRemaining(index + 1, totalCandidates, end - start);
@@ -82,57 +83,6 @@ export const validityJobWithTiming = withExecutionTimeLogging(
   "Validity Job Done",
 );
 
-export const candidateValidityJob = async (
-  constraints: Constraints.OTV,
-  candidateAddress: string,
-) => {
-  try {
-    const start = Date.now();
-
-    const candidate = await queries.getCandidateByStash(candidateAddress);
-    if (candidate) {
-      await constraints.checkCandidate(candidate);
-
-      const end = Date.now();
-      const executionTime = (end - start) / 1000;
-
-      logger.info(
-        `validity for ${candidate.name} Done. (${executionTime}s)`,
-        constraintsLabel,
-      );
-    }
-  } catch (e) {
-    logger.error(`Error running validity job: ${e}`, constraintsLabel);
-  }
-};
-
-export const individualScoreJob = async (
-  constraints: Constraints.OTV,
-  candidateAddress: string,
-) => {
-  try {
-    const start = Date.now();
-    const candidate = await queries.getCandidateByStash(candidateAddress);
-    if (candidate) {
-      let scoreMetadata = await queries.getLatestValidatorScoreMetadata();
-      if (!scoreMetadata) {
-        logger.warn(
-          `no score metadata, cannot score candidates`,
-          constraintsLabel,
-        );
-        await constraints.setScoreMetadata();
-        scoreMetadata = await queries.getLatestValidatorScoreMetadata();
-      }
-      await constraints.scoreCandidate(candidate, scoreMetadata);
-
-      const end = Date.now();
-      const executionTime = (end - start) / 1000;
-    }
-  } catch (e) {
-    logger.error(`Error running individual score job: ${e}`, constraintsLabel);
-  }
-};
-
 export const scoreJob = async (
   metadata: JobRunnerMetadata,
 ): Promise<boolean> => {