feat: compute vote fiat value

feat: add index to vp_value

Author: wa0x6e

src/helpers/actions.ts

@@ -92,6 +92,7 @@ export async function getProposal(space, id) {
     params: {}
   };
   proposal.choices = jsonParse(proposal.choices);
+  proposal.vp_value_by_strategy = jsonParse(proposal.vp_value_by_strategy, []);
 
   return proposal;
 }

src/helpers/utils.ts

@@ -266,3 +266,41 @@ export function getSpaceController(space: string, network = NETWORK) {
 
   return snapshot.utils.getSpaceController(space, networkId, { broviderUrl });
 }
+
+/**
+ * Computes the dot product of two arrays by multiplying corresponding elements and summing the results.
+ *
+ * This function performs a dot product calculation between two arrays of numbers.
+ * Both arrays are flattened to handle nested structures of unlimited depth before
+ * calculation using Array.flat(Infinity).
+ *
+ * @param arrayA - First array of numbers. Can contain deeply nested arrays of any depth
+ * @param arrayB - Second array of numbers. Must have the same structure as arrayA after flattening
+ * @returns The computed dot product as a number. Returns 0 if arrays are invalid or mismatched.
+ *
+ * @example
+ * // Simple arrays
+ * dotProduct([1, 2, 3], [10, 20, 30]) // Returns 140 (1*10 + 2*20 + 3*30)
+ *
+ * @example
+ * // Nested arrays (2 levels)
+ * dotProduct([1, [2, 3]], [10, [20, 30]]) // Returns 140 (1*10 + 2*20 + 3*30)
+ *
+ * @example
+ * // Deep nested arrays (unlimited depth)
+ * dotProduct([1, [2, [3, 4]]], [10, [20, [30, 40]]]) // Returns 340 (1*10 + 2*20 + 3*30 + 4*40)
+ */
+export function dotProduct(arrayA: any[], arrayB: any[]): number {
+  if (!Array.isArray(arrayA) || !Array.isArray(arrayB)) {
+    return 0;
+  }
+
+  const flatArrayA = arrayA.flat(Infinity).map(val => Number(val) || 0);
+  const flatArrayB = arrayB.flat(Infinity).map(val => Number(val) || 0);
+
+  if (flatArrayA.length !== flatArrayB.length) {
+    return 0;
+  }
+
+  return flatArrayA.reduce((sum, val, i) => sum + val * flatArrayB[i], 0);
+}

src/writer/vote.ts

@@ -2,7 +2,7 @@ import snapshot from '@snapshot-labs/snapshot.js';
 import { getProposal } from '../helpers/actions';
 import log from '../helpers/log';
 import db from '../helpers/mysql';
-import { captureError, hasStrategyOverride, jsonParse } from '../helpers/utils';
+import { captureError, dotProduct, hasStrategyOverride, jsonParse } from '../helpers/utils';
 import { updateProposalAndVotes } from '../scores';
 
 const scoreAPIUrl = process.env.SCORE_API_URL || 'https://score.snapshot.org';
@@ -116,6 +116,9 @@ export async function action(body, ipfs, receipt, id, context): Promise<void> {
   const withOverride = hasStrategyOverride(context.proposal.strategies);
   if (vpState === 'final' && withOverride) vpState = 'pending';
 
+  // Compute vote value
+  const voteValue = dotProduct(context.proposal.vp_value_by_strategy, context.vp.vp_by_strategy);
+
   const params = {
     id,
     ipfs,
@@ -130,6 +133,7 @@ export async function action(body, ipfs, receipt, id, context): Promise<void> {
     vp: context.vp.vp,
     vp_by_strategy: JSON.stringify(context.vp.vp_by_strategy),
     vp_state: vpState,
+    vp_value: voteValue,
     cb: 0
   };
 
@@ -152,7 +156,7 @@ export async function action(body, ipfs, receipt, id, context): Promise<void> {
     await db.queryAsync(
       `
       UPDATE votes
-      SET id = ?, ipfs = ?, created = ?, choice = ?, reason = ?, metadata = ?, app = ?, vp = ?, vp_by_strategy = ?, vp_state = ?
+      SET id = ?, ipfs = ?, created = ?, choice = ?, reason = ?, metadata = ?, app = ?, vp = ?, vp_by_strategy = ?, vp_state = ?, vp_value = ?
       WHERE voter = ? AND proposal = ? AND space = ?;
       UPDATE leaderboard SET last_vote = ? WHERE user = ? AND space = ? LIMIT 1;
     `,
@@ -167,6 +171,7 @@ export async function action(body, ipfs, receipt, id, context): Promise<void> {
         params.vp,
         params.vp_by_strategy,
         params.vp_state,
+        params.vp_value,
         voter,
         proposalId,
         msg.space,

test/schema.sql

@@ -100,6 +100,7 @@ CREATE TABLE votes (
   vp DECIMAL(64,30) NOT NULL,
   vp_by_strategy JSON NOT NULL,
   vp_state VARCHAR(24) NOT NULL,
+  vp_value DECIMAL(8,3) NOT NULL DEFAULT '0.000',
   cb INT(11) NOT NULL,
   PRIMARY KEY (voter, space, proposal),
   UNIQUE KEY id (id),
@@ -111,6 +112,7 @@ CREATE TABLE votes (
   INDEX app (app),
   INDEX vp (vp),
   INDEX vp_state (vp_state),
+  INDEX vp_value (vp_value),
   INDEX cb (cb)
 );