@marinade.finance/scoring 1.0.0 → 1.0.1

package/computing/validators.ts

@@ -0,0 +1,133 @@
+import { AggregatedValidator, AggregatedValidators, ValidatorDto } from '../dto/validators.dto';
+import { JitoValidatorDto } from '../dto/jito.dto';
+import { mean, sum } from '../utils/maths';
+import { ClusterInfo } from '../dto/cluster.dto';
+
+export function aggregateValidatorData (
+  validator: ValidatorDto,
+  mevRecord: JitoValidatorDto,
+  blacklist: Set<string>,
+  firstEpoch: number,
+  lastEpoch: number
+): AggregatedValidator {
+  const currentMarinadeStake = Number(validator.epochStats[lastEpoch]?.marinade_native_stake || 0) / 1e9 + Number(validator.epochStats[lastEpoch]?.marinade_stake || 0) / 1e9;
+  const voteAccount = validator.vote_account;
+  const name = validator.info_name || 'Unknown';
+  const epochs: number[] = [];
+  const commission: number[] = [];
+  const stake: number[] = [];
+  const externalStake: number[] = [];
+  const credits: number[] = [];
+  const blocksProduced: number[] = [];
+  const leaderSlots: number[] = [];
+  const dataAvailable: boolean[] = [];
+
+  const currentStake = Number(validator.epochStats[lastEpoch]?.activated_stake || 0) / 1e9;
+
+  const blacklisted = blacklist.has(voteAccount);
+
+  for (let epoch = lastEpoch; epoch >= firstEpoch; epoch--) {
+    const epochStat = validator.epochStats?.[epoch];
+
+    epochs.push(epoch);
+    commission.push(epochStat?.commission_max_observed || epochStat?.commission_advertised || 0);
+    stake.push(Number(epochStat?.activated_stake || 0) / 1e9);
+    externalStake.push(Number(epochStat?.activated_stake || 0) / 1e9 - Number(epochStat?.marinade_stake || 0) / 1e9 - Number(epochStat?.marinade_native_stake || 0) / 1e9);
+    credits.push(epochStat?.credits || 0);
+    blocksProduced.push(epochStat?.blocks_produced || 0);
+    leaderSlots.push(epochStat?.leader_slots || 0);
+    dataAvailable.push(!!epochStat);
+  }
+
+  const mevCommission = mevRecord?.running_jito ? mevRecord.mev_commission_bps / 100 : 100;
+  return {
+    voteAccount,
+    name,
+    epochs,
+    currentMarinadeStake,
+    currentStake,
+    commission,
+    stake,
+    externalStake,
+    credits,
+    blocksProduced,
+    leaderSlots,
+    dataAvailable,
+    mevCommission,
+    country: validator.dc_country || 'Unknown',
+    city: validator.dc_full_city || 'Unknown',
+    aso: validator.dc_aso || 'Unknown',
+    blacklisted,
+    version: validator.version
+  };
+}
+export async function aggregateValidatorsData (
+  validators: ValidatorDto[],
+  basicEligibilityEpochs: number,
+  bonusEligibilityExtraEpochs: number
+): Promise<AggregatedValidators> {
+  const lastEpoch = this.getMaxEpoch(validators);
+  const firstEpoch = lastEpoch - basicEligibilityEpochs - bonusEligibilityExtraEpochs;
+
+  const jitoMevRecords: Record<string, JitoValidatorDto> = await this.dataProvider.fetchValidatorsJitoMEV(true);
+  const blacklist: Set<string> = await this.dataProvider.fetchBlacklist(true);
+
+  const result: { [voteAccount: string]: AggregatedValidator } = {};
+
+  for (const validator of validators) {
+    const mevRecord = jitoMevRecords[validator.vote_account] ?? {
+      vote_account: validator.vote_account,
+      mev_commission_bps: 100,
+      running_jito: false,
+      active_stake: Number(validator.activated_stake)
+    } as JitoValidatorDto;
+
+    if (mevRecord) {
+      const aggregatedData = this.aggregateValidatorData(validator, mevRecord, blacklist, firstEpoch, lastEpoch);
+      result[validator.vote_account] = aggregatedData;
+    }
+  }
+
+  return result;
+}
+export function getMaxEpoch (validators: ValidatorDto[]): number {
+  return validators.reduce((maxEpoch, validator) => {
+    const validatorMaxEpoch = validator.epoch_stats.reduce((max, { epoch }) => {
+      return Math.max(epoch, max);
+    }, 0);
+    return Math.max(maxEpoch, validatorMaxEpoch);
+  }, 0);
+}
+export function selectExternalStakeMin (validator: AggregatedValidator, fullEpochs: number): number {
+  if (validator.externalStake.length === 0) {
+    throw new Error('Validator has no external stake data.');
+  }
+  return Math.min(...validator.externalStake.slice(0, fullEpochs + 1));
+}
+export function selectCreditsPctMean (validator: AggregatedValidator, clusterInfo: ClusterInfo, fullEpochs: number): number {
+  return mean(validator.epochs.slice(1, fullEpochs + 1).map((epoch, fullEpochIndex) =>
+    (validator.credits[fullEpochIndex + 1] ?? 0) / (clusterInfo.targetCreditsByEpoch.get(epoch) ?? 1)));
+}
+export function selectBlockProductionMean (validator: AggregatedValidator, fullEpochs: number): number {
+  const leaderSlots = sum(validator.leaderSlots.slice(1, fullEpochs + 1));
+  return leaderSlots === 0 ? 1 : sum(validator.blocksProduced.slice(1, fullEpochs + 1)) / leaderSlots;
+}
+export function selectCommissionInflationMax (validator: AggregatedValidator, epochs: number): number {
+  return Math.max(...validator.commission.slice(0, epochs));
+}
+export function selectCommissionMEV (validator: AggregatedValidator): number {
+  return validator.mevCommission;
+}
+export function selectCountryStakeConcentration (validator: AggregatedValidator, clusterInfo: ClusterInfo): number {
+  return clusterInfo.country.get(validator.country ?? '???') ?? 0;
+}
+export function selectCityStakeConcentration (validator: AggregatedValidator, clusterInfo: ClusterInfo): number {
+  return clusterInfo.city.get(validator.city ?? '???') ?? 0;
+}
+export function selectASOStakeConcentration (validator: AggregatedValidator, clusterInfo: ClusterInfo): number {
+  return clusterInfo.aso.get(validator.aso ?? '???') ?? 0;
+}
+export function selectNodeStake (validator: AggregatedValidator): number {
+  return validator.stake[0] ?? 0;
+}
+

package/{src/dto → dto}/bonds.dto.ts

@@ -6,9 +6,7 @@ export type BondDto = {
   updated_at: string;
   epoch: number;
 }
-
 export type BondsDto = {
   bonds: BondDto[];
 }
-
 export type Bonds = Record<string, number>;

package/{src/dto → dto}/cluster.dto.ts

@@ -6,7 +6,6 @@ export type ClusterInfo = {
     meanBlockProductionOverBasicEligibilityPeriod: number,
     stdDevBlockProductionOverBasicEligibilityPeriod: number,
 }
-
 export type BlockProductionResult = {
   mean: number;
   stdDev: number;

package/{src/dto → dto}/eligibility.dto.ts

@@ -9,7 +9,6 @@ export type EligibilityConfig = {
     maxStakeShare: number;
     maxWarnings: number;
 }
-
 export type ValidatorEligibility = {
     basicEligibility: boolean;
     bonusEligibility: boolean;
@@ -17,17 +16,14 @@ export type ValidatorEligibility = {
     capFromBond: number;
     capFromExternalStake: number;
 }
-
 export type EvaluationResult = {
     criticals: number;
     warnings: number;
 }
-
 export type Issue = {
     type: IssueType;
     message: string;
 }
-
 export const enum IssueType {
     NO_DATA = 'NO_DATA',
     NO_BOND = 'NO_BOND',
@@ -39,5 +35,4 @@ export const enum IssueType {
     VOTE_CREDITS_LOW = 'VOTE_CREDITS_LOW',
     VOTE_CREDITS_WARNING = 'VOTE_CREDITS_WARNING',
 }
-
 export type ValidatorsEligibilities = Record<string, ValidatorEligibility>

package/{src/dto → dto}/jito.dto.ts

@@ -4,7 +4,6 @@ export class JitoValidatorDto {
   running_jito: boolean;
   active_stake: number;
 }
-
 export class JitoValidatorsResponseDto {
   validators: JitoValidatorDto[];
-}
+}

package/{src/dto → dto}/marinade.dto.ts

@@ -15,4 +15,4 @@ export type TvlStats = {
   total_virtual_staked_usd: number;
   marinade_native_stake_sol: number;
   marinade_native_stake_usd: number;
-}
+}

package/{src/dto → dto}/rewards.dto.ts

@@ -7,7 +7,6 @@ export class RewardPairDto {
     this.amount = pair[1];
   }
 }
-
 export class RewardsResponseDto {
   rewards_mev: RewardPairDto[];
   rewards_inflation_est: RewardPairDto[];
@@ -17,5 +16,4 @@ export class RewardsResponseDto {
     this.rewards_inflation_est = data.rewards_inflation_est.map(pair => new RewardPairDto(pair));
   }
 }
-
-export type Rewards = { inflation: number, mev: number }
+export type Rewards = { inflation: number, mev: number }

package/{src/dto → dto}/scoring.dto.ts

@@ -9,7 +9,6 @@ export type ScoreDto = {
     scoreErrors: boolean[]
     tooltips: string[]
 }
-
 export type Score = {
     vote_account: string,
     score: string,
@@ -37,12 +36,10 @@ export type Score = {
     target_stake_algo: string,
     target_stake: string,
 }
-
 export type ScoreConfig = {
     epochs: number,
     concentrationParams: number[]
 }
-
 export type ScoringConfig = {
   DS_PUBKEY: string;
   REWARDS_PAST_EPOCHS: number;
@@ -94,16 +91,13 @@ export type Variables = {
     aso_stake_concentration_last: number;
     node_stake_last: number;
 };
-
 export type Scores = Record<string, ScoreDto>
 export type ScoreTooltipBuilder = (validator: AggregatedValidator, clusterInfo: ClusterInfo) => string
-
 export type UnstakeHint = {
   vote_account: string;
   marinade_stake: string;
   hints: string[];
 };
-
 export type UnstakeHints = {
   unstake_hints: UnstakeHint[];
-};
+};

package/{src/dto → dto}/snapshots.dto.ts

@@ -3,17 +3,14 @@ export class RecordDto {
   tokenOwner: string;
   validatorVoteAccount: string;
 }
-
 export class veMNDESnapshotDto {
   voteRecordsCreatedAt: string;
   records: RecordDto[];
 }
-
 export class mSolSnapshotDto {
   mSolSnapshotCreatedAt: string;
   voteRecordsCreatedAt: string;
   records: RecordDto[];
 }
-
 export type Votes = Record<string, number>
 

package/{src/dto → dto}/stakes.dto.ts

@@ -8,7 +8,6 @@ export type StakesConfig = {
     formulaStakeBlockSize: string
     formulaStakeBlocksFromScore: string
 }
-
 export type Stake = {
     algoStake: number
     mSolStake: number
@@ -19,7 +18,6 @@ export type Stake = {
     veMndeStakeFromOverflow: number
     totalStakeFromOverlfow: number
 }
-
 export type ProcessedVotesAndTVLs = {
     updatedMSolVotes: Votes;
     updatedVeMndeVotes: Votes;
@@ -27,9 +25,7 @@ export type ProcessedVotesAndTVLs = {
     veMndeTvl: number;
     totalTvl: number;
 };
-
 export type StakingVariables = {
     tvl: number;
 }
-
 export type Stakes = Record<string, Stake>

package/{src/dto → dto}/validators.dto.ts

@@ -1,67 +1,36 @@
-
 export class WarningDto {
   warning: string;
 }
-
 export class EpochStatDto {
-
   epoch: number;
-
   epoch_start_at: string;
-
   epoch_end_at?: string;
-
   commission_max_observed?: number | null;
-
   commission_min_observed?: number | null;
-
   commission_advertised: number;
-
   commission_effective?: number | null;
-
   version: string;
-
   activated_stake: string;
-
   marinade_stake: string;
-
   foundation_stake: string;
-
   marinade_native_stake: string;
-
   self_stake: string;
-
   superminority: boolean;
-
   stake_to_become_superminority: string;
-
   credits: number;
-
   leader_slots: number;
-
   blocks_produced: number;
-
   skip_rate: number;
-
   uptime_pct?: number | null;
-
   uptime?: number | null;
-
   downtime?: number | null;
-
   apr?: number | null;
-
   apy?: number | null;
-
   score: number;
-
   rank_score: number;
-
   rank_activated_stake: number;
-
   rank_apy: number;
 }
-
 export class ValidatorDto {
   identity: string;
   vote_account: string;
@@ -108,19 +77,16 @@ export class ValidatorDto {
   avg_uptime_pct: number;
   avg_apy: number;
 }
-
 export class ValidatorAggregatedDto {
   epoch: number;
   epoch_start_date: string;
   avg_marinade_score?: number | null;
   avg_apy?: number | null;
 }
-
 export class ValidatorsResponseDto {
   validators: ValidatorDto[];
   validators_aggregated: ValidatorAggregatedDto[];
 }
-
 export type AggregatedValidator = {
     voteAccount: string;
     name: string;
@@ -141,6 +107,4 @@ export type AggregatedValidator = {
     blacklisted: boolean;
     version: string;
 };
-
-export type AggregatedValidators = Record<string, AggregatedValidator>
-
+export type AggregatedValidators = Record<string, AggregatedValidator>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@marinade.finance/scoring",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Delegation Strategy Scoring",
   "repository": {
     "type": "git",
@@ -9,16 +9,21 @@
   "publishConfig": {
     "access": "public"
   },
-
   "files": [
-    "src",
+    "computing",
+    "constants",
+    "dto",
+    "errors",
+    "interfaces",
+    "providers",
+    "utils",
     "generated",
     "README.md"
   ],
   "main": "index.js",
   "scripts": {
-    "build": "nest build",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsc",
+    "test": "jest"
   },
   "keywords": [
     "solana",
@@ -29,16 +34,15 @@
   "author": "Marinade Finance",
   "license": "ISC",
   "dependencies": {
-    "@nestjs/cli": "^10.3.2",
-    "@nestjs/common": "^10.3.3",
-    "axios": "^1.6.7",
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.14.1",
+    "axios": "^1.6.8",
     "decimal.js": "^10.4.3",
     "expr-eval": "^2.0.2",
-    "nestjs": "^0.0.1"
+    "log4js": "^6.9.1"
   },
   "devDependencies": {
-    "@types/node": "^20.11.19"
+    "@types/jest": "29.5.0",
+    "@types/node": "^20.12.7",
+    "jest": "29.5.0",
+    "ts-jest": "29.0.5"
   }
-}
+}