add kyc validity check

Author: will pankiewicz

packages/common/src/constraints/CheckCandidates.ts

@@ -129,6 +129,12 @@ export const checkCandidate = async (
       logger.info(`${candidate.name} beefy keys not valid`, constraintsLabel);
     }
 
+    // TODO: enable at deadline
+    const kycValid = true; //await checkKYC(candidate);
+    if (!kycValid) {
+      logger.info(`${candidate.name} kyc not valid`, constraintsLabel);
+    }
+
     valid =
       onlineValid &&
       validateValid &&
@@ -142,7 +148,8 @@ export const checkCandidate = async (
       blockedValid &&
       kusamaValid &&
       providerValid &&
-      beefyValid;
+      beefyValid &&
+      kycValid;
 
     await setValid(candidate, valid);
 

packages/common/src/constraints/ValidityChecks.ts

@@ -8,6 +8,7 @@ import {
   setConnectionTimeInvalidity,
   setIdentityInvalidity,
   setKusamaRankInvalidity,
+  setKYCInvalidity,
   setLatestClientReleaseValidity,
   setOfflineAccumulatedInvalidity,
   setOnlineValidity,
@@ -434,3 +435,20 @@ export const checkBeefyKeys = async (
     throw new Error("could not make validity check");
   }
 };
+
+export const checkKYC = async (candidate: Candidate): Promise<boolean> => {
+  try {
+    const isKYC = await queries.isKYC(candidate.stash);
+    if (isKYC) {
+      const invalidityString = `${candidate.name} is not KYC`;
+      await setKYCInvalidity(candidate, false, invalidityString);
+      return false;
+    } else {
+      await setKYCInvalidity(candidate, true);
+      return true;
+    }
+  } catch (e) {
+    logger.warn(`Error trying to get beefy keys...`, constraintsLabel);
+    throw new Error("could not make validity check");
+  }
+};

packages/common/src/db/queries/Candidate.ts

@@ -1053,6 +1053,21 @@ export const setBeefyKeysInvalidity = async (
   );
 };
 
+export const setKYCInvalidity = async (
+  candidate: Candidate,
+  isValid: boolean,
+  message?: string,
+): Promise<void> => {
+  const invalidityMessage = message ? message : `${candidate.name} is not KYC`;
+  setCandidateInvalidity(
+    candidate,
+    InvalidityReasonType.BEEFY,
+    isValid,
+    invalidityMessage,
+    true,
+  );
+};
+
 // Sets valid boolean for node
 export const setValid = async (
   candidate: Candidate,