feat: add caching and calculation for node operator accrued fees

Author: DiRaiks

features/metrics.ts

@@ -49,3 +49,36 @@ export const getSettledGrowthsByBlockNumbers = async (
 
   return settledGrowths;
 };
+
+export const getNodeOperatorAccruedFeeByBlockNumbers = async (
+  vaultAddress: string,
+  blockNumbers: number[],
+  dashboardContract: DashboardContract,
+) => {
+  // Get settled growth for each report block with caching
+  const nodeOperatorAccruedFees: bigint[] = [];
+  for (const blockNumber of blockNumbers) {
+    let nodeOperatorAccruedFee = await cache.getNodeOperatorAccruedFee(
+      vaultAddress,
+      blockNumber,
+    );
+    if (nodeOperatorAccruedFee === null) {
+      nodeOperatorAccruedFee = await callReadMethodSilent(
+        dashboardContract,
+        'accruedFee',
+        {
+          blockNumber: BigInt(blockNumber),
+        },
+      );
+      await cache.setNodeOperatorAccruedFee(
+        vaultAddress,
+        blockNumber,
+        nodeOperatorAccruedFee,
+      );
+    }
+
+    nodeOperatorAccruedFees.push(nodeOperatorAccruedFee);
+  }
+
+  return nodeOperatorAccruedFees;
+};

programs/use-cases/metrics/read.ts

@@ -32,8 +32,7 @@ import {
 import {
   checkQuarantine,
   chooseVaultAndGetDashboard,
-  getNodeOperatorFeeRatesByBlockNumbers,
-  getSettledGrowthsByBlockNumbers,
+  getNodeOperatorAccruedFeeByBlockNumbers,
 } from 'features';
 
 import { metrics } from './main.js';
@@ -154,14 +153,12 @@ metricsRead
     );
 
     const blockNumbers = history.map((r) => r.blockNumber);
-    const [nodeOperatorFeeBPs, settledGrowths] = await Promise.all([
-      getNodeOperatorFeeRatesByBlockNumbers(
+    const nodeOperatorAccruedFees =
+      await getNodeOperatorAccruedFeeByBlockNumbers(
         vault,
         blockNumbers,
         dashboardContract,
-      ),
-      getSettledGrowthsByBlockNumbers(vault, blockNumbers, dashboardContract),
-    ]);
+      );
 
     const [
       grossStakingRewards,
@@ -174,22 +171,12 @@ metricsRead
       dailyLidoFees,
     ] = await Promise.all([
       prepareGrossStakingRewards(history),
-      prepareNodeOperatorRewards(history, nodeOperatorFeeBPs, settledGrowths),
-      prepareNetStakingRewards(history, nodeOperatorFeeBPs, settledGrowths),
+      prepareNodeOperatorRewards(history, nodeOperatorAccruedFees),
+      prepareNetStakingRewards(history, nodeOperatorAccruedFees),
       prepareGrossStakingAPR(history),
-      prepareNetStakingAPR(history, nodeOperatorFeeBPs, settledGrowths),
-      prepareCarrySpread(
-        history,
-        nodeOperatorFeeBPs,
-        vaultAddress,
-        settledGrowths,
-      ),
-      prepareBottomLine(
-        history,
-        nodeOperatorFeeBPs,
-        vaultAddress,
-        settledGrowths,
-      ),
+      prepareNetStakingAPR(history, nodeOperatorAccruedFees),
+      prepareCarrySpread(history, nodeOperatorAccruedFees, vaultAddress),
+      prepareBottomLine(history, nodeOperatorAccruedFees, vaultAddress),
       prepareDailyLidoFees(history),
     ]);
 

utils/cache.ts

@@ -34,6 +34,8 @@ const getSettledGrowthCacheFile = (vaultAddress: string) =>
   path.resolve('cache', `settled-growth-cache-${vaultAddress}.json`);
 const getIndexedEventsCacheFile = (poolAddress: string) =>
   path.resolve('cache', `indexed-events-cache-${poolAddress}.json`);
+const getNodeOperatorAccruedFeeCacheFile = (vaultAddress: string) =>
+  path.resolve('cache', `node-operator-accrued-fee-cache-${vaultAddress}.json`);
 
 export const cache = {
   async getShareRate(blockNumber: number): Promise<bigint | null> {
@@ -184,6 +186,54 @@ export const cache = {
     );
   },
 
+  async getNodeOperatorAccruedFee(
+    vaultAddress: string,
+    blockNumber: number,
+  ): Promise<bigint | null> {
+    try {
+      const data = JSON.parse(
+        await fs.readFile(
+          getNodeOperatorAccruedFeeCacheFile(vaultAddress),
+          'utf-8',
+        ),
+      );
+      if (data[blockNumber] !== undefined) return BigInt(data[blockNumber]);
+    } catch {
+      /* ignore */
+    }
+    return null;
+  },
+
+  async setNodeOperatorAccruedFee(
+    vaultAddress: string,
+    blockNumber: number,
+    value: bigint,
+  ) {
+    let data: Record<string, string> = {};
+    try {
+      data = JSON.parse(
+        await fs.readFile(
+          getNodeOperatorAccruedFeeCacheFile(vaultAddress),
+          'utf-8',
+        ),
+      );
+    } catch {
+      /* ignore */
+    }
+    data[blockNumber] = value.toString();
+    await fs.mkdir(
+      path.dirname(getNodeOperatorAccruedFeeCacheFile(vaultAddress)),
+      {
+        recursive: true,
+      },
+    );
+    await fs.writeFile(
+      getNodeOperatorAccruedFeeCacheFile(vaultAddress),
+      JSON.stringify(data),
+      'utf-8',
+    );
+  },
+
   async getIndexedEventsByBlock(
     poolAddress: string,
     blockNumber: bigint,

utils/charts/blessed/charts-apr.ts

@@ -4,10 +4,7 @@ import { Address } from 'viem';
 
 import { callReadMethodSilent, getVaultReportHistory } from 'utils';
 import { getDashboardContract } from 'contracts';
-import {
-  getNodeOperatorFeeRatesByBlockNumbers,
-  getSettledGrowthsByBlockNumbers,
-} from 'features';
+import { getNodeOperatorAccruedFeeByBlockNumbers } from 'features';
 
 import { lineOpts, getMinMax } from './utils.js';
 import { LIMIT } from './constants.js';
@@ -55,32 +52,23 @@ export const fetchAprChartsData = async ({
   if (!history || history.length < 2) throw new Error('Not enough data');
 
   const blockNumbers = history.map((r) => r.blockNumber);
-  const [nodeOperatorFeeBPs, settledGrowths] = await Promise.all([
-    getNodeOperatorFeeRatesByBlockNumbers(
-      vault,
-      blockNumbers,
-      dashboardContract,
-    ),
-    getSettledGrowthsByBlockNumbers(vault, blockNumbers, dashboardContract),
-  ]);
+  const nodeOperatorAccruedFees = await getNodeOperatorAccruedFeeByBlockNumbers(
+    vault,
+    blockNumbers,
+    dashboardContract,
+  );
 
   const grossStakingAPR = prepareGrossStakingAPR(history);
-  const netStakingAPR = prepareNetStakingAPR(
-    history,
-    nodeOperatorFeeBPs,
-    settledGrowths,
-  );
+  const netStakingAPR = prepareNetStakingAPR(history, nodeOperatorAccruedFees);
   const carrySpread = await prepareCarrySpread(
     history,
-    nodeOperatorFeeBPs,
+    nodeOperatorAccruedFees,
     vault,
-    settledGrowths,
   );
   const bottomLine = await prepareBottomLine(
     history,
-    nodeOperatorFeeBPs,
+    nodeOperatorAccruedFees,
     vault,
-    settledGrowths,
   );
   const lidoAPR = await prepareLidoAPR(history);
 

utils/charts/blessed/charts-rewards.ts

@@ -4,10 +4,7 @@ import contrib from 'blessed-contrib';
 import { Address } from 'viem';
 import { callReadMethodSilent, getVaultReportHistory } from 'utils';
 import { getDashboardContract } from 'contracts';
-import {
-  getNodeOperatorFeeRatesByBlockNumbers,
-  getSettledGrowthsByBlockNumbers,
-} from 'features';
+import { getNodeOperatorAccruedFeeByBlockNumbers } from 'features';
 
 import { lineOpts } from './utils.js';
 import { LIMIT } from './constants.js';
@@ -48,25 +45,20 @@ export const fetchRewardsChartsData = async ({
 
   // Get nodeOperatorFeeBP for each report block with caching
   const blockNumbers = history.map((r) => r.blockNumber);
-  const [nodeOperatorFeeBPs, settledGrowths] = await Promise.all([
-    getNodeOperatorFeeRatesByBlockNumbers(
-      vault,
-      blockNumbers,
-      dashboardContract,
-    ),
-    getSettledGrowthsByBlockNumbers(vault, blockNumbers, dashboardContract),
-  ]);
+  const nodeOperatorAccruedFees = await getNodeOperatorAccruedFeeByBlockNumbers(
+    vault,
+    blockNumbers,
+    dashboardContract,
+  );
 
   const grossStakingRewards = prepareGrossStakingRewards(history);
   const nodeOperatorRewards = prepareNodeOperatorRewards(
     history,
-    nodeOperatorFeeBPs,
-    settledGrowths,
+    nodeOperatorAccruedFees,
   );
   const netStakingRewards = prepareNetStakingRewards(
     history,
-    nodeOperatorFeeBPs,
-    settledGrowths,
+    nodeOperatorAccruedFees,
   );
 
   const grossStakingRewardsChart =

utils/charts/blessed/datasets/prepare-metrics.ts

@@ -8,7 +8,6 @@ import {
   getCarrySpread,
   calculateLidoAPR,
   getGrossStakingRewards,
-  getNodeOperatorRewards,
   getNetStakingRewards,
   getDailyLidoFees,
 } from 'utils';
@@ -17,9 +16,8 @@ import { getRebaseRewardFromCache, getShareRateFromCache } from 'utils';
 
 export const prepareBottomLine = async (
   history: VaultReport[],
-  nodeOperatorFeeBPs: bigint[],
+  nodeOperatorAccruedFees: bigint[],
   vaultAddress: string,
-  settledGrowth: bigint[],
 ) => {
   const bottomLine = [];
   const timestamp = [];
@@ -40,9 +38,8 @@ export const prepareBottomLine = async (
     const bottomLineValue = getBottomLine(
       current,
       previous,
-      nodeOperatorFeeBPs[i] ?? 0n,
+      nodeOperatorAccruedFees[i] ?? 0n,
       stEthLiabilityRebaseRewards,
-      settledGrowth[i] ?? 0n,
     );
 
     bottomLine.push(String(bottomLineValue));
@@ -70,8 +67,7 @@ export const prepareGrossStakingAPR = (history: VaultReport[]) => {
 
 export const prepareNetStakingAPR = (
   history: VaultReport[],
-  nodeOperatorFeeBPs: bigint[],
-  settledGrowth: bigint[],
+  nodeOperatorAccruedFees: bigint[],
 ) => {
   const netStakingAPRPercent = [];
   const timestamp = [];
@@ -85,8 +81,7 @@ export const prepareNetStakingAPR = (
     const value = getNetStakingAPR(
       current,
       previous,
-      nodeOperatorFeeBPs[i] ?? 0n,
-      settledGrowth[i] ?? 0n,
+      nodeOperatorAccruedFees[i] ?? 0n,
     );
 
     netStakingAPRPercent.push(value.apr_percent);
@@ -97,9 +92,8 @@ export const prepareNetStakingAPR = (
 
 export const prepareCarrySpread = async (
   history: VaultReport[],
-  nodeOperatorFeeBPs: bigint[],
+  nodeOperatorAccruedFees: bigint[],
   vaultAddress: string,
-  settledGrowth: bigint[],
 ) => {
   const carrySpreadPercent = [];
   const timestamp = [];
@@ -120,9 +114,8 @@ export const prepareCarrySpread = async (
     const value = getCarrySpread(
       current,
       previous,
-      nodeOperatorFeeBPs[i] ?? 0n,
+      nodeOperatorAccruedFees[i] ?? 0n,
       stEthLiabilityRebaseRewards,
-      settledGrowth[i] ?? 0n,
     );
 
     carrySpreadPercent.push(value.apr_percent);
@@ -175,8 +168,7 @@ export const prepareGrossStakingRewards = (history: VaultReport[]) => {
 
 export const prepareNodeOperatorRewards = (
   history: VaultReport[],
-  nodeOperatorFeeBPs: bigint[],
-  settledGrowth: bigint[],
+  nodeOperatorAccruedFees: bigint[],
 ) => {
   const nodeOperatorRewards = [];
   const timestamp = [];
@@ -186,12 +178,7 @@ export const prepareNodeOperatorRewards = (
     const previous = history[i - 1];
     if (!current || !previous) continue;
 
-    const value = getNodeOperatorRewards(
-      current,
-      previous,
-      nodeOperatorFeeBPs[i] ?? 0n,
-      settledGrowth[i] ?? 0n,
-    );
+    const value = nodeOperatorAccruedFees[i] ?? 0n;
 
     nodeOperatorRewards.push(String(formatEther(value)));
     timestamp.push(current.timestamp);
@@ -201,8 +188,7 @@ export const prepareNodeOperatorRewards = (
 
 export const prepareNetStakingRewards = (
   history: VaultReport[],
-  nodeOperatorFeeBPs: bigint[],
-  settledGrowth: bigint[],
+  nodeOperatorAccruedFees: bigint[],
 ) => {
   const netStakingRewards = [];
   const timestamp = [];
@@ -215,8 +201,7 @@ export const prepareNetStakingRewards = (
     const value = getNetStakingRewards(
       current,
       previous,
-      nodeOperatorFeeBPs[i] ?? 0n,
-      settledGrowth[i] ?? 0n,
+      nodeOperatorAccruedFees[i] ?? 0n,
     );
 
     netStakingRewards.push(String(formatEther(value)));