feat: ignore list

docker/validators/ignore_list.yaml

@@ -0,0 +1,3 @@
+# this list of validators indexes is used to ignore some validators
+# in metrics calculation
+indexes: []

src/common/config/env.validation.ts

@@ -180,6 +180,9 @@ export class EnvironmentVariables {
   @IsString()
   public VALIDATOR_REGISTRY_LIDO_SOURCE_SQLITE_CACHE_PATH = './docker/validators/lido_mainnet.db';
 
+  @IsString()
+  public VALIDATOR_IGNORE_LIST = './docker/validators/ignore_list.yaml';
+
   /**
    * Distance (down) from Blockchain Sync Participation average after which we think that our sync participation is bad
    * For example:

src/duty/duty.metrics.ts

@@ -1,8 +1,10 @@
+import { readFile } from 'fs/promises';
+
 import { LOGGER_PROVIDER } from '@lido-nestjs/logger';
 import { Inject, Injectable, LoggerService } from '@nestjs/common';
+import { load } from 'js-yaml';
 
 import { ConfigService } from 'common/config';
-import { ConsensusProviderService } from 'common/eth-providers';
 import { Epoch } from 'common/eth-providers/consensus-provider/types';
 import { allSettled } from 'common/functions/allSettled';
 import { PrometheusService, TrackTask } from 'common/prometheus';
@@ -21,7 +23,6 @@ export class DutyMetrics {
     @Inject(LOGGER_PROVIDER) protected readonly logger: LoggerService,
     protected readonly config: ConfigService,
     protected readonly prometheus: PrometheusService,
-    protected readonly clClient: ConsensusProviderService,
 
     protected readonly stateMetrics: StateMetrics,
     protected readonly attestationMetrics: AttestationMetrics,
@@ -34,6 +35,7 @@ export class DutyMetrics {
 
   @TrackTask('calc-all-duties-metrics')
   public async calculate(epoch: Epoch, possibleHighRewardValidators: string[]): Promise<any> {
+    await this.storage.setIndexesIgnoreListForMetrics(await this.getIndexesIgnoreListForMetrics());
     this.logger.log('Calculating duties metrics of user validators');
     await allSettled([
       this.withPossibleHighReward(epoch, possibleHighRewardValidators),
@@ -52,4 +54,15 @@ export class DutyMetrics {
       this.syncMetrics.calculate(epoch, possibleHighRewardValidators),
     ]);
   }
+
+  private async getIndexesIgnoreListForMetrics(): Promise<string[] | undefined> {
+    try {
+      const fileContent = await readFile(this.config.get('VALIDATOR_IGNORE_LIST'), 'utf-8');
+      const { indexes } = <{ indexes: string[] }>load(fileContent);
+      return indexes;
+    } catch (e) {
+      this.logger.error(`Error while reading ignore list file: ${e.message}`);
+      return [];
+    }
+  }
 }

src/duty/sync/sync.metrics.ts

@@ -71,13 +71,23 @@ export class SyncMetrics {
   }
 
   private async goodSyncParticipationLastEpoch(chainAvgSyncPercent: number) {
-    const data = await this.storage.getValidatorsCountWithGoodSyncParticipationLastNEpoch(this.processedEpoch, 1, chainAvgSyncPercent);
+    const data = await this.storage.getValidatorsCountWithGoodSyncParticipationLastNEpoch(
+      this.processedEpoch,
+      1,
+      chainAvgSyncPercent,
+      this.storage.ignoreList,
+    );
     setUserOperatorsMetric(this.prometheus.validatorsCountWithGoodSyncParticipation, data, this.operators);
     setOtherOperatorsMetric(this.prometheus.otherValidatorsCountWithGoodSyncParticipation, data);
   }
 
   private async badSyncParticipationLastEpoch(chainAvgSyncPercent: number) {
-    const data = await this.storage.getValidatorsCountWithBadSyncParticipationLastNEpoch(this.processedEpoch, 1, chainAvgSyncPercent);
+    const data = await this.storage.getValidatorsCountWithBadSyncParticipationLastNEpoch(
+      this.processedEpoch,
+      1,
+      chainAvgSyncPercent,
+      this.storage.ignoreList,
+    );
     setUserOperatorsMetric(this.prometheus.validatorsCountWithSyncParticipationLessAvg, data, this.operators);
     setOtherOperatorsMetric(this.prometheus.otherValidatorsCountWithSyncParticipationLessAvg, data);
   }
@@ -87,6 +97,7 @@ export class SyncMetrics {
       this.processedEpoch,
       this.epochInterval,
       chainAvgSyncPercent,
+      this.storage.ignoreList,
     );
     setUserOperatorsMetric(this.prometheus.validatorsCountWithSyncParticipationLessAvgLastNEpoch, data, this.operators, {
       epoch_interval: this.epochInterval,