Merge branch 'feeds-renaming' into 'main'

Add FTM and DAI renamings

See merge request flarenetwork/ftso/ftso-scaling!154

Author: alenabelium

libs/fsp-rewards/src/constants.ts

@@ -333,7 +333,7 @@ export const CALCULATIONS_FOLDER = () => {
             })(network);
     }
 };
-export const FEEDS_RENAMING_FILE = () => "libs/ftso-core/src/reward-calculation/feeds-renaming.json";
+export const FEEDS_RENAMING_FILE = () => "libs/fsp-rewards/src/reward-calculation/feeds-renaming.json";
 export const FUTURE_VOTING_ROUNDS = () => 30;
 // Used to limit querying of too old events and handling the missing event for the voting round
 export const COSTON_FAST_UPDATER_SWITCH_VOTING_ROUND_ID = 779191;

libs/fsp-rewards/src/reward-calculation/feeds-renaming.json

@@ -4,5 +4,17 @@
         "newName": "POL/USD",
         "oldFeedId": "0x014d415449432f5553440000000000000000000000",
         "newFeedId": "0x01504f4c2f55534400000000000000000000000000"
+    },
+    {
+        "oldName": "FTM/USD",
+        "newName": "S/USD",
+        "oldFeedId": "0x0146544d2f55534400000000000000000000000000",
+        "newFeedId": "0x01532f555344000000000000000000000000000000"
+    },
+    {
+        "oldName": "DAI/USD",
+        "newName": "USDS/USD",
+        "oldFeedId": "0x014441492f55534400000000000000000000000000",
+        "newFeedId": "0x01555344532f555344000000000000000000000000"
     }
 ]

libs/fsp-rewards/src/reward-calculation/reward-calculation.ts

@@ -1,8 +1,6 @@
 import { DataAvailabilityStatus } from "../../../ftso-core/src/DataManager";
 import { RewardEpochManager } from "../../../ftso-core/src/RewardEpochManager";
-import {
-  FTSO2_PROTOCOL_ID
-} from "../../../ftso-core/src/constants";
+import { FTSO2_PROTOCOL_ID } from "../../../ftso-core/src/constants";
 import { calculateMedianResults } from "../../../ftso-core/src/ftso-calculation/ftso-median";
 import { RewardEpochDuration } from "../../../ftso-core/src/utils/RewardEpochDuration";
 import { MedianCalculationResult } from "../../../ftso-core/src/voting-types";
@@ -28,7 +26,7 @@ import {
   FEEDS_RENAMING_FILE,
   FINALIZATION_VOTER_SELECTION_THRESHOLD_WEIGHT_BIPS,
   FTSO2_FAST_UPDATES_PROTOCOL_ID,
-  PENALTY_FACTOR
+  PENALTY_FACTOR,
 } from "../constants";
 import { FUFeedValue } from "../data-calculation-interfaces";
 import { IPartialRewardOfferForRound } from "../utils/PartialRewardOffer";
@@ -285,9 +283,7 @@ export async function partialRewardClaimsForVotingRound(
       }
     }
     const fuFeedValueMap = new Map<string, FUFeedValue>();
-    if (
-      rewardEpochInfo.fuInflationRewardsOffered.feedConfigurations.length > data.fastUpdatesData.feedValues.length
-    ) {
+    if (rewardEpochInfo.fuInflationRewardsOffered.feedConfigurations.length > data.fastUpdatesData.feedValues.length) {
       throw new Error("Critical error: Feed configurations contain more feeds then feed values");
     }
     // if new feeds are introduced during the voting round, they are ignored
@@ -377,8 +373,8 @@ export async function partialRewardClaimsForVotingRound(
         data.fdcData.firstSuccessfulFinalization,
         data.fdcData.finalizations,
         data,
-        new Set(data.eligibleFinalizers),
-        new Set(data.eligibleFinalizers),
+        new Set(data.eligibleFinalizersFdc),
+        new Set(data.eligibleFinalizersFdc),
         RewardTypePrefix.FDC_FINALIZATION
       );
 
@@ -393,9 +389,10 @@ export async function partialRewardClaimsForVotingRound(
         rewardEpochInfo,
         data,
         PENALTY_FACTOR(),
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         data.dataForCalculations.votersWeightsMap!,
         RewardTypePrefix.FDC_OFFENDERS
-      )
+      );
 
       allRewardClaims.push(...fdCFinalizationRewardClaims);
       allRewardClaims.push(...fdcSigningRewardClaims);
@@ -450,6 +447,14 @@ export async function prepareDataForRewardCalculations(
   const eligibleFinalizationRewardVotersInGracePeriod = new Set(
     randomVoterSelector.randomSelectThresholdWeightVoters(initialHash)
   );
+  const initialHashFdc = RandomVoterSelector.initialHashSeed(
+    rewardEpoch.signingPolicy.seed,
+    FDC_PROTOCOL_ID,
+    votingRoundId
+  );
+  const eligibleFinalizationRewardVotersInGracePeriodFdc = new Set(
+    randomVoterSelector.randomSelectThresholdWeightVoters(initialHashFdc)
+  );
 
   const randomData = calculateRandom(rewardDataForCalculations.dataForCalculations);
   const calculationResults = [
@@ -463,6 +468,7 @@ export async function prepareDataForRewardCalculations(
     medianResults,
     randomData,
     [...eligibleFinalizationRewardVotersInGracePeriod],
+    [...eligibleFinalizationRewardVotersInGracePeriodFdc],
     false,
     calculationFolder
   );
@@ -515,6 +521,15 @@ export async function prepareDataForRewardCalculationsForRange(
       randomVoterSelector.randomSelectThresholdWeightVoters(initialHash)
     );
 
+    const initialHashFdc = RandomVoterSelector.initialHashSeed(
+      rewardEpoch.signingPolicy.seed,
+      FDC_PROTOCOL_ID,
+      votingRoundId
+    );
+    const eligibleFinalizationRewardVotersInGracePeriodFdc = new Set(
+      randomVoterSelector.randomSelectThresholdWeightVoters(initialHashFdc)
+    );
+
     const randomData = calculateRandom(rewardDataForCalculations.dataForCalculations);
     const calculationResults = [
       MerkleTreeStructs.fromRandomCalculationResult(randomData),
@@ -533,6 +548,7 @@ export async function prepareDataForRewardCalculationsForRange(
       medianResults,
       randomData,
       [...eligibleFinalizationRewardVotersInGracePeriod],
+      [...eligibleFinalizationRewardVotersInGracePeriodFdc],
       tempRewardEpochFolder,
       calculationFolder
     );

libs/fsp-rewards/src/utils/stat-info/reward-calculation-data.ts

@@ -4,16 +4,22 @@ import { RelayMessage } from "../../../../ftso-core/src/fsp-utils/RelayMessage";
 import { ISignaturePayload } from "../../../../ftso-core/src/fsp-utils/SignaturePayload";
 import { GenericSubmissionData, ParsedFinalizationData } from "../../../../ftso-core/src/IndexerClient";
 import { VoterWeights } from "../../../../ftso-core/src/RewardEpoch";
-import { Address, Feed, MedianCalculationResult, MessageHash, RandomCalculationResult } from "../../../../ftso-core/src/voting-types";
+import {
+  Address,
+  Feed,
+  MedianCalculationResult,
+  MessageHash,
+  RandomCalculationResult,
+} from "../../../../ftso-core/src/voting-types";
 import { IRevealData } from "../../../../ftso-core/src/data/RevealData";
 import { bigIntReplacer, bigIntReviver } from "../../../../ftso-core/src/utils/big-number-serialization";
 import { REWARD_CALCULATION_DATA_FILE, TEMP_REWARD_EPOCH_FOLDER_PREFIX } from "./constants";
 import { RewardEpochInfo } from "./reward-epoch-info";
-import {CALCULATIONS_FOLDER} from "../../constants";
+import { CALCULATIONS_FOLDER } from "../../constants";
 import {
   DataForRewardCalculation,
   FastUpdatesDataForVotingRound,
-  SFDCDataForVotingRound
+  SFDCDataForVotingRound,
 } from "../../data-calculation-interfaces";
 
 export interface RevealRecords {
@@ -68,7 +74,7 @@ export function prepareDataForCalculations(rewardEpochId: number, data: DataForR
     voterMedianVotingWeights,
     randomGenerationBenchingWindow: data.dataForCalculations.randomGenerationBenchingWindow,
     benchingWindowRevealOffenders: [...data.dataForCalculations.benchingWindowRevealOffenders],
-    feedOrder: data.dataForCalculations.feedOrder
+    feedOrder: data.dataForCalculations.feedOrder,
   };
   return result;
 }
@@ -97,7 +103,10 @@ export interface SDataForRewardCalculation {
   fdcData?: SFDCDataForVotingRound;
   // usually added after results of the next voting round are known
   nextVotingRoundRandomResult?: string;
+  // eligible finalizers for FTSO Scaling
   eligibleFinalizers: string[];
+  // eligible finalizers for FDC
+  eligibleFinalizersFdc: string[];
   // not serialized, reconstructed on augmentation
   signaturesMap?: Map<MessageHash, GenericSubmissionData<ISignaturePayload>[]>;
 }
@@ -120,6 +129,7 @@ export function serializeDataForRewardCalculation(
   medianResults: MedianCalculationResult[],
   randomResult: RandomCalculationResult,
   eligibleFinalizationRewardVotersInGracePeriod: string[],
+  eligibleFinalizationRewardVotersInGracePeriodFdc: string[],
   tempRewardEpochFolder = false,
   calculationFolder = CALCULATIONS_FOLDER()
 ): void {
@@ -142,7 +152,6 @@ export function serializeDataForRewardCalculation(
     hashSignatures.push(hashRecord);
   }
 
-
   let fdcData: SFDCDataForVotingRound | undefined;
 
   if (rewardCalculationData.fdcData) {
@@ -165,7 +174,7 @@ export function serializeDataForRewardCalculation(
       consensusBitVote: rewardCalculationData.fdcData.consensusBitVote,
       consensusBitVoteIndices: rewardCalculationData.fdcData.consensusBitVoteIndices,
       fdcOffenders: rewardCalculationData.fdcData.fdcOffenders,
-    }
+    };
   }
 
   for (const finalization of rewardCalculationData.finalizations) {
@@ -183,8 +192,9 @@ export function serializeDataForRewardCalculation(
     medianCalculationResults: medianResults,
     randomResult: simplifyRandomCalculationResult(randomResult),
     eligibleFinalizers: eligibleFinalizationRewardVotersInGracePeriod,
+    eligibleFinalizersFdc: eligibleFinalizationRewardVotersInGracePeriodFdc,
     fastUpdatesData: rewardCalculationData.fastUpdatesData,
-    fdcData
+    fdcData,
   };
   writeFileSync(rewardCalculationsDataPath, JSON.stringify(data, bigIntReplacer));
 }
@@ -294,17 +304,14 @@ export function augmentDataForRewardCalculation(
 /**
  * After deserialization, the data is augmented with additional maps and sets for easier access.
  */
-export function augmentFdcDataForRewardCalculation(
-  data: SFDCDataForVotingRound,
-): void {
+export function augmentFdcDataForRewardCalculation(data: SFDCDataForVotingRound): void {
   const signaturesMap = new Map<string, GenericSubmissionData<ISignaturePayload>[]>();
   for (const hashSignature of data.signatures) {
     signaturesMap.set(hashSignature.hash, hashSignature.signatures);
   }
   data.signaturesMap = signaturesMap;
 }
 
-
 export function deserializeDataForRewardCalculation(
   rewardEpochId: number,
   votingRoundId: number,

libs/fsp-rewards/src/utils/stat-info/reward-calculation-status.ts

@@ -2,7 +2,7 @@ import { existsSync, readFileSync, writeFileSync } from "fs";
 import path from "path/posix";
 import { RewardEpoch } from "../../../../ftso-core/src/RewardEpoch";
 import { STATUS_FILE, TEMP_REWARD_EPOCH_FOLDER_PREFIX } from "./constants";
-import {CALCULATIONS_FOLDER} from "../../constants";
+import { CALCULATIONS_FOLDER } from "../../constants";
 
 export enum RewardCalculationStatus {
   PENDING = "PENDING",

scripts/get-passes.sh

@@ -0,0 +1,14 @@
+NETWORK=$1
+REWARD_EPOCH_ID=$2
+# check if parameters are passed
+if [ -z "$NETWORK" ] || [ -z "$REWARD_EPOCH_ID" ]; then
+  echo "Provide the network and reward epoch id as parameters"
+  exit 1
+fi
+
+wget "https://raw.githubusercontent.com/flare-foundation/fsp-rewards/refs/heads/main/$NETWORK/$REWARD_EPOCH_ID/passes.json"
+mkdir -p calculations
+mkdir -p calculations/$NETWORK
+mkdir -p calculations/$NETWORK/$REWARD_EPOCH_ID
+rm -f calculations/$NETWORK/$REWARD_EPOCH_ID/passes.json
+mv passes.json calculations/$NETWORK/$REWARD_EPOCH_ID/passes.json