feat: compute proposal's scores_total_value

Author: wa0x6e

src/helpers/entityValue.ts

@@ -38,3 +38,50 @@ export function getVoteValue(vp_value_by_strategy: number[], vp_by_strategy: num
 
   return vp_value_by_strategy.reduce((sum, value, index) => sum + value * vp_by_strategy[index], 0);
 }
+
+/**
+ * Calculates the proposal total value based on all votes' total voting power and the proposal's value per strategy.
+ * @returns The total value of the given proposal's votes, in the currency unit specified by the proposal's vp_value_by_strategy values
+ */
+export function getProposalValue(
+  scores_by_strategy: number[][],
+  vp_value_by_strategy: number[]
+): number {
+  if (
+    !scores_by_strategy.length ||
+    !scores_by_strategy[0]?.length ||
+    !vp_value_by_strategy.length
+  ) {
+    return 0;
+  }
+
+  // Validate that all voteScores arrays have the same length as vp_value_by_strategy
+  for (const voteScores of scores_by_strategy) {
+    if (voteScores.length !== vp_value_by_strategy.length) {
+      throw new Error(
+        'Array size mismatch: voteScores length does not match vp_value_by_strategy length'
+      );
+    }
+  }
+
+  let totalValue = 0;
+  for (let strategyIndex = 0; strategyIndex < vp_value_by_strategy.length; strategyIndex++) {
+    const strategyTotal = scores_by_strategy.reduce((sum, voteScores) => {
+      const score = voteScores[strategyIndex];
+      if (typeof score !== 'number') {
+        throw new Error(`Invalid score value: expected number, got ${typeof score}`);
+      }
+      return sum + score;
+    }, 0);
+
+    if (typeof vp_value_by_strategy[strategyIndex] !== 'number') {
+      throw new Error(
+        `Invalid vp_value: expected number, got ${typeof vp_value_by_strategy[strategyIndex]}`
+      );
+    }
+
+    totalValue += strategyTotal * vp_value_by_strategy[strategyIndex];
+  }
+
+  return totalValue;
+}

src/helpers/proposalsScoresValue.ts

@@ -0,0 +1,69 @@
+import { capture } from '@snapshot-labs/snapshot-sentry';
+import snapshot from '@snapshot-labs/snapshot.js';
+import { getProposalValue } from './entityValue';
+import db from './mysql';
+import { CB } from '../constants';
+
+type Proposal = {
+  id: string;
+  vp_value_by_strategy: number[];
+  scores_by_strategy: number[][];
+};
+
+const REFRESH_INTERVAL = 10 * 1000;
+const BATCH_SIZE = 25;
+
+async function getProposals(): Promise<Proposal[]> {
+  const query = `
+    SELECT id, vp_value_by_strategy, scores_by_strategy
+    FROM proposals
+    WHERE cb = ? AND end < UNIX_TIMESTAMP() AND scores_state = ?
+    ORDER BY created ASC
+    LIMIT ?
+  `;
+  const proposals = await db.queryAsync(query, [CB.PENDING_CLOSE, 'final', BATCH_SIZE]);
+
+  return proposals.map((p: any) => {
+    p.vp_value_by_strategy = JSON.parse(p.vp_value_by_strategy);
+    p.scores_by_strategy = JSON.parse(p.scores_by_strategy);
+    return p;
+  });
+}
+
+async function refreshScoresTotal(proposals: Proposal[]) {
+  const query: string[] = [];
+  const params: any[] = [];
+
+  proposals.map(proposal => {
+    query.push('UPDATE proposals SET scores_total_value = ?, cb = ? WHERE id = ? LIMIT 1');
+
+    try {
+      const scores_total_value = getProposalValue(
+        proposal.scores_by_strategy,
+        proposal.vp_value_by_strategy
+      );
+      params.push(scores_total_value, CB.FINAL, proposal.id);
+    } catch (e) {
+      capture(e);
+      params.push(0, CB.INELIGIBLE, proposal.id);
+    }
+  });
+
+  if (query.length) {
+    await db.queryAsync(query.join(';'), params);
+  }
+}
+
+export default async function run() {
+  while (true) {
+    const proposals = await getProposals();
+
+    if (proposals.length) {
+      await refreshScoresTotal(proposals);
+    }
+
+    if (proposals.length < BATCH_SIZE) {
+      await snapshot.utils.sleep(REFRESH_INTERVAL);
+    }
+  }
+}

src/index.ts

@@ -6,6 +6,7 @@ import api from './api';
 import log from './helpers/log';
 import initMetrics from './helpers/metrics';
 import refreshModeration from './helpers/moderation';
+import refreshProposalsScoresValue from './helpers/proposalsScoresValue';
 import refreshProposalsVpValue from './helpers/proposalStrategiesValue';
 import rateLimit from './helpers/rateLimit';
 import shutter from './helpers/shutter';
@@ -23,6 +24,7 @@ async function startServer() {
   initLogger(app);
   refreshModeration();
   refreshProposalsVpValue();
+  refreshProposalsScoresValue();
   refreshVotesVpValue();
 
   await initializeStrategies();