refactor: centralize fiat handling in a dedicated helper

Author: wa0x6e

src/helpers/entityValue.ts

@@ -0,0 +1,20 @@
+type Proposal = {
+  scores_by_strategy: string;
+  vp_value_by_strategy: string;
+};
+
+/**
+ * Calculates the total proposal value based on the vote's 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(proposal: Proposal): number {
+  const scoresByStrategy: number[][] = JSON.parse(proposal.scores_by_strategy);
+  const vpValueByStrategy: number[] = JSON.parse(proposal.vp_value_by_strategy);
+
+  return (
+    scoresByStrategy[0]
+      ?.map((_, index) => scoresByStrategy.reduce((sum, array) => sum + array[index], 0))
+      ?.map((value, index) => value * vpValueByStrategy[index])
+      ?.reduce((sum, value) => sum + value, 0) || 0
+  );
+}

src/scores.ts

@@ -1,4 +1,5 @@
 import snapshot from '@snapshot-labs/snapshot.js';
+import { getProposalValue } from './helpers/entityValue';
 import log from './helpers/log';
 import db from './helpers/mysql';
 import { getDecryptionKey } from './helpers/shutter';
@@ -102,17 +103,8 @@ async function updateProposalScoresValue(proposalId: string) {
     'SELECT vp_value_by_strategy, scores_by_strategy FROM proposals WHERE id = ? LIMIT 1;',
     [proposalId]
   );
-  const scoresByStrategy: number[][] = JSON.parse(proposal.scores_by_strategy);
-  const vpValueByStrategy: number[] = JSON.parse(proposal.vp_value_by_strategy);
-
-  const score_total_value =
-    scoresByStrategy[0]
-      ?.map((_, index) => scoresByStrategy.reduce((sum, array) => sum + array[index], 0))
-      ?.map((value, index) => value * vpValueByStrategy[index])
-      ?.reduce((sum, value) => sum + value, 0) || 0;
-
   const query = 'UPDATE proposals SET scores_total_value = ? WHERE id = ? LIMIT 1;';
-  await db.queryAsync(query, [score_total_value, proposalId]);
+  await db.queryAsync(query, [getProposalValue(proposal), proposalId]);
 }
 
 const pendingRequests = {};

test/unit/helpers/entityValue.test.ts

@@ -0,0 +1,109 @@
+import { getProposalValue } from '../../../src/helpers/entityValue';
+
+describe('getProposalValue', () => {
+  it('should calculate correct proposal value with single strategy', () => {
+    const proposal = {
+      scores_by_strategy: '[[100], [200]]',
+      vp_value_by_strategy: '[2.5]'
+    };
+
+    const result = getProposalValue(proposal);
+
+    expect(result).toBe(750); // (100 + 200) * 2.5 = 300 * 2.5 = 750
+  });
+
+  it('should calculate correct proposal value with multiple strategies', () => {
+    const proposal = {
+      scores_by_strategy: '[[100, 50], [200, 75], [300, 25]]',
+      vp_value_by_strategy: '[1.5, 3.0]'
+    };
+
+    const result = getProposalValue(proposal);
+
+    expect(result).toBe(1350); // (100+200+300)*1.5 + (50+75+25)*3.0 = 600*1.5 + 150*3.0 = 900 + 450 = 1350
+  });
+
+  it('should return 0 when scores_by_strategy is empty', () => {
+    const proposal = {
+      scores_by_strategy: '[]',
+      vp_value_by_strategy: '[2.0]'
+    };
+
+    const result = getProposalValue(proposal);
+
+    expect(result).toBe(0);
+  });
+
+  it('should return 0 when first strategy array is empty', () => {
+    const proposal = {
+      scores_by_strategy: '[[]]',
+      vp_value_by_strategy: '[2.0]'
+    };
+
+    const result = getProposalValue(proposal);
+
+    expect(result).toBe(0);
+  });
+
+  it('should handle zero values correctly', () => {
+    const proposal = {
+      scores_by_strategy: '[[0, 0], [0, 0]]',
+      vp_value_by_strategy: '[2.0, 1.5]'
+    };
+
+    const result = getProposalValue(proposal);
+
+    expect(result).toBe(0);
+  });
+
+  it('should handle zero vp_value_by_strategy correctly', () => {
+    const proposal = {
+      scores_by_strategy: '[[100, 50], [200, 75]]',
+      vp_value_by_strategy: '[0, 0]'
+    };
+
+    const result = getProposalValue(proposal);
+
+    expect(result).toBe(0);
+  });
+
+  it('should handle decimal values correctly', () => {
+    const proposal = {
+      scores_by_strategy: '[[10.5, 20.5], [15.5, 25.5]]',
+      vp_value_by_strategy: '[0.1, 0.2]'
+    };
+
+    const result = getProposalValue(proposal);
+
+    expect(result).toBe(11.8); // (10.5+15.5)*0.1 + (20.5+25.5)*0.2 = 26*0.1 + 46*0.2 = 2.6 + 9.2 = 11.8
+  });
+
+  it('should handle single vote scenario', () => {
+    const proposal = {
+      scores_by_strategy: '[[100]]',
+      vp_value_by_strategy: '[2.0]'
+    };
+
+    const result = getProposalValue(proposal);
+
+    expect(result).toBe(200); // 100 * 2.0 = 200
+  });
+
+  it('should throw error for invalid JSON in scores_by_strategy', () => {
+    const proposal = {
+      scores_by_strategy: 'invalid json',
+      vp_value_by_strategy: '[2.0]'
+    };
+
+    expect(() => getProposalValue(proposal)).toThrow();
+  });
+
+  it('should throw error for invalid JSON in vp_value_by_strategy', () => {
+    const proposal = {
+      scores_by_strategy: '[[100]]',
+      vp_value_by_strategy: 'invalid json'
+    };
+
+    expect(() => getProposalValue(proposal)).toThrow();
+  });
+});