Merge pull request #2879 from w3f/staging

Staging

Author: ironoa

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

@@ -61,6 +61,11 @@ spec:
                   "minSelfStake": 10000000000000,
                   "commission": 150000000,
                   "unclaimedEraThreshold": 4,
+                  "sanctionedGeoArea": {
+                    "skip": true,
+                    "sanctionedCountries": ["XXX"],
+                    "sanctionedRegions": ["XXX" ]
+                  },
                   "forceClientVersion": "v1.10.0"
                 },
                 "cron": {

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

@@ -60,6 +60,11 @@ spec:
                   "minSelfStake": 50000000000000,
                   "commission": 50000000,
                   "unclaimedEraThreshold": 1,
+                  "sanctionedGeoArea": {
+                    "skip": true,
+                    "sanctionedCountries": ["XXX"],
+                    "sanctionedRegions": ["XXX" ]
+                  },
                   "forceClientVersion": "v1.10.0"
                 },
                 "cron": {

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.1.16
+    targetRevision: v3.2.0
     plugin:
       env:
         - name: HELM_VALUES
@@ -59,6 +59,11 @@ spec:
                   "minSelfStake": 10000000000000,
                   "commission": 150000000,
                   "unclaimedEraThreshold": 4,
+                  "sanctionedGeoArea": {
+                    "skip": true,
+                    "sanctionedCountries": ["XXX"],
+                    "sanctionedRegions": ["XXX" ]
+                  },
                   "forceClientVersion": "v1.10.0"
                 },
                 "cron": {

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.1.16
+    targetRevision: v3.2.0
     plugin:
       env:
         - name: HELM_VALUES
@@ -58,6 +58,11 @@ spec:
                   "minSelfStake": 50000000000000,
                   "commission": 50000000,
                   "unclaimedEraThreshold": 1,
+                  "sanctionedGeoArea": {
+                    "skip": true,
+                    "sanctionedCountries": ["XXX"],
+                    "sanctionedRegions": ["XXX" ]
+                  },
                   "forceClientVersion": "v1.10.0"
                 },
                 "cron": {

charts/otv-backend/Chart.yaml

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

charts/otv-backend/values.yaml

@@ -48,7 +48,12 @@ config: |
     },
     "constraints": {
       "skipConnectionTime": false,
-      "skipIdentity": false
+      "skipIdentity": false,
+      "sanctionedGeoArea": {
+        "skip": false,
+        "sanctionedCountries": ["XXX"],
+        "sanctionedRegions": ["XXX" ]
+      }
     },
     "db": {
       "mongo": {

packages/common/package.json

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

packages/common/src/config.ts

@@ -31,6 +31,11 @@ export type ConfigSchema = {
     minSelfStake: number;
     commission: number;
     unclaimedEraThreshold: number;
+    sanctionedGeoArea?: {
+      skip: boolean;
+      sanctionedCountries: string[];
+      sanctionedRegions: string[];
+    };
   };
   cron: {
     monitor: string;

packages/common/src/constraints/CheckCandidates.ts

@@ -15,6 +15,7 @@ import {
   checkSelfStake,
   checkUnclaimed,
   checkValidateIntention,
+  checkSanctionedGeoArea,
 } from "./ValidityChecks";
 import { percentage, timeRemaining } from "../utils/util";
 
@@ -129,6 +130,12 @@ export const checkCandidate = async (
       logger.info(`${candidate.name} beefy keys not valid`, constraintsLabel);
     }
 
+    const sanctionedGeoAreaValid =
+      constraints.config?.constraints?.sanctionedGeoArea?.skip == true
+        ? true
+        : (await checkSanctionedGeoArea(constraints.config, candidate)) ||
+          false;
+
     valid =
       onlineValid &&
       validateValid &&
@@ -142,7 +149,8 @@ export const checkCandidate = async (
       blockedValid &&
       kusamaValid &&
       providerValid &&
-      beefyValid;
+      beefyValid &&
+      sanctionedGeoAreaValid;
 
     await setValid(candidate, valid);
 

packages/common/src/constraints/ValidityChecks.ts

@@ -15,6 +15,7 @@ import {
   setSelfStakeInvalidity,
   setUnclaimedInvalidity,
   setValidateIntentionValidity,
+  setSanctionedGeoAreaValidity,
 } from "../db";
 import { ChainData, Config, Constants, queries, Util } from "../index";
 import axios from "axios";
@@ -434,3 +435,61 @@ export const checkBeefyKeys = async (
     throw new Error("could not make validity check");
   }
 };
+
+// Checks if the candidate is in a sanctioned location
+export const checkSanctionedGeoArea = async (
+  config: Config.ConfigSchema,
+  candidate: Candidate,
+): Promise<boolean> => {
+  try {
+    if (
+      !config.constraints?.sanctionedGeoArea?.sanctionedCountries?.length &&
+      !config.constraints?.sanctionedGeoArea?.sanctionedRegions?.length
+    ) {
+      await setSanctionedGeoAreaValidity(candidate, true);
+      return true;
+    }
+
+    const location = await queries.getCandidateLocation(candidate.slotId);
+    if (!location?.region || !location?.country) {
+      await setSanctionedGeoAreaValidity(candidate, true);
+      return true;
+    }
+
+    const sanctionedCountries = config.constraints?.sanctionedGeoArea
+      ?.sanctionedCountries
+      ? config.constraints.sanctionedGeoArea.sanctionedCountries.map((x) =>
+          x.trim().toLowerCase(),
+        )
+      : [];
+    const sanctionedRegions = config.constraints?.sanctionedGeoArea
+      ?.sanctionedRegions
+      ? config.constraints.sanctionedGeoArea.sanctionedRegions.map((x) =>
+          x.trim().toLowerCase(),
+        )
+      : [];
+
+    if (
+      sanctionedCountries.includes(location.country.trim().toLowerCase()) ||
+      sanctionedRegions.includes(location.region.trim().toLowerCase())
+    ) {
+      logger.info(
+        `${candidate.name} is in a sanctioned location: Country: ${location.country}, Region: ${location.region}`,
+        {
+          label: "Constraints",
+        },
+      );
+      await setSanctionedGeoAreaValidity(candidate, false);
+      return false;
+    }
+
+    await setSanctionedGeoAreaValidity(candidate, true);
+    return true;
+  } catch (e) {
+    logger.error(
+      `Error checking location for sanctions: ${e}`,
+      constraintsLabel,
+    );
+    throw new Error("could not make validity check");
+  }
+};