feat: filter out addresses not supported by strategies and validation (#1738)

* feat: filter out addresses not supported by strategies and validation

Co-Authored-By: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: add default supported protocols

* refactor: reduce code duplication with a template pattern

* refactor: move the strategies length to the base class

* test: add unit tests for the validation class

* Update src/constants.ts

Co-authored-by: Chaitanya <yourchaitu@gmail.com>

* fix: remove strategies length validation, delegated to score-api

* fix: return false instead of throwing error on unsupported address

* perf: better code

* fix: throw error on invalid address when calling getVp

* ci: run test on CI

* fix: add missing functions to default export in utils.ts

Added sha256, customFetch, and getFormattedAddressesByProtocol to the default export object to ensure consistency between named exports and default export.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* fix: add support for starknet addresses on math strategy

* simplify secret header generation in rocketpool strategy

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Chaitanya <yourchaitu@gmail.com>
Co-authored-by: Claude <noreply@anthropic.com>

Author: 4 people

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Tests CI
+
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: ['16', '20']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: yarn install, build and run tests
+        run: |
+          yarn install --frozen-lockfile
+          yarn build
+          yarn test --coverage
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1,9 +1,10 @@
 .DS_Store
 node_modules
 dist
+coverage
 
 # Remove some common IDE working directories
 .idea
 .vscode
 .env
-.history
+.history

package.json

@@ -13,10 +13,11 @@
   "license": "MIT",
   "scripts": {
     "build": "tsc -p .",
-    "test": "jest -i strategy.test.ts",
+    "test": "yarn test:unit && jest -i strategy.test.ts",
     "test:vp": "jest -i vp.test.ts",
     "test:delegation": "jest -i delegation.test.ts",
     "test:validation": "jest -i validation.test.ts",
+    "test:unit": "jest -i test/unit/",
     "prepublishOnly": "npm run build",
     "postinstall": "npm run build",
     "postbuild": "copyfiles -u 1 \"src/**/*.md\" dist/ && copyfiles -u 1 \"src/**/*.json\" dist/",

src/constants.ts

@@ -0,0 +1,4 @@
+import { Protocol } from './types';
+
+export const DEFAULT_SUPPORTED_PROTOCOLS: Protocol[] = ['evm'];
+export const VALID_PROTOCOLS: Protocol[] = ['evm', 'starknet'];

src/strategies/index.ts

@@ -487,6 +487,8 @@ import * as prlInSpRL2Balance from './prl-in-sprl2-balance';
 import * as edenOnlineOverride from './eden-online-override';
 import * as forteStaking from './forte-staking';
 
+import { DEFAULT_SUPPORTED_PROTOCOLS } from '../constants';
+
 const strategies = {
   'shroomy-voting-power': shroomyVotingPower,
   'apecoin-staking': apecoinStaking,
@@ -1018,6 +1020,7 @@ Object.keys(strategies).forEach(function (strategyName) {
   strategies[strategyName].examples = examples;
   strategies[strategyName].schema = schema;
   strategies[strategyName].about = about;
+  strategies[strategyName].supportedProtocols ||= DEFAULT_SUPPORTED_PROTOCOLS;
 });
 
 export default strategies;

src/strategies/math/index.ts

@@ -13,7 +13,8 @@ import {
 } from './options';
 
 export const author = 'xJonathanLEI';
-export const version = '0.2.2';
+export const version = '0.2.3';
+export const supportedProtocols = ['evm', 'starknet'];
 
 export async function strategy(
   space,

src/strategies/ocean-dao-brightid/index.ts

@@ -81,7 +81,7 @@ export async function strategy(
     .filter((address, index, self) => self.indexOf(address) === index); // Remove duplicates
 
   for (const chain of Object.keys(options.strategies)) {
-    let scores = await getScoresDirect(
+    const scores = await getScoresDirect(
       space,
       options.strategies[chain],
       chain,
@@ -92,7 +92,7 @@ export async function strategy(
 
     // [{ address: '0x...', score: 0.5 },{ address: '0x...', score: 0.5 }]
     // sum scores for each address and return
-    scores = scores.reduce((finalScores: any, score: any) => {
+    const addressScores = scores.reduce((finalScores: any, score: any) => {
       for (const [address, value] of Object.entries(score)) {
         if (!finalScores[address]) {
           finalScores[address] = 0;
@@ -105,19 +105,19 @@ export async function strategy(
 
     // sum delegations
     addresses.forEach((address) => {
-      if (!scores[address]) scores[address] = 0;
+      if (!addressScores[address]) addressScores[address] = 0;
       if (delegations[address]) {
         delegations[address].forEach((delegator: string) => {
-          scores[address] += scores[delegator] ?? 0; // add delegator score
-          scores[delegator] = 0; // set delegator score to 0
+          addressScores[address] += addressScores[delegator] ?? 0; // add delegator score
+          addressScores[delegator] = 0; // set delegator score to 0
         });
       }
     });
 
-    for (const key of Object.keys(scores)) {
+    for (const key of Object.keys(addressScores)) {
       totalScores[key] = totalScores[key]
-        ? totalScores[key] + scores[key]
-        : scores[key];
+        ? totalScores[key] + addressScores[key]
+        : addressScores[key];
     }
   }
 

src/strategies/rocketpool-node-operator-delegate-v8/index.ts

@@ -12,9 +12,11 @@ const signerRegistryAbi = [
   'function signerToNode(address) external view returns (address)'
 ];
 
-const snapshotSecretHeader = sha256(
-  `https://api.rocketpool.net/mainnet/delegates/block/${process.env.SNAPSHOT_API_STRATEGY_SALT}`
-);
+function getSnapshotSecretHeader() {
+  return sha256(
+    `https://api.rocketpool.net/mainnet/delegates/block/${process.env.SNAPSHOT_API_STRATEGY_SALT}`
+  );
+}
 
 export async function strategy(
   space,
@@ -42,7 +44,7 @@ export async function strategy(
     'https://api.rocketpool.net/mainnet/delegates/block/' + blockTag,
     {
       headers: {
-        'X-Snapshot-API-Secret': snapshotSecretHeader
+        'X-Snapshot-API-Secret': getSnapshotSecretHeader()
       }
     }
   );

src/strategies/subgraph-split-delegation/index.ts

@@ -1,6 +1,7 @@
 import { getAddress } from '@ethersproject/address';
 import { subgraphRequest, getScoresDirect } from '../../utils';
 import { Strategy } from '@snapshot-labs/snapshot.js/dist/src/voting/types';
+import { Snapshot } from '../../types';
 
 export const author = 'aragon';
 export const version = '0.1.0';
@@ -35,7 +36,7 @@ export async function strategy(
     subgraphUrl: DEFAULT_BACKEND_URL,
     strategies: []
   },
-  snapshot: string | number
+  snapshot: Snapshot
 ) {
   const blockTag = typeof snapshot === 'number' ? snapshot : 'latest';
   const block = await provider.getBlock(blockTag);

src/strategies/ticket/index.ts

@@ -1,6 +1,8 @@
 export const author = 'bonustrack';
 export const version = '0.1.0';
 
+export const supportedProtocols = ['evm', 'starknet'];
+
 export async function strategy(space, network, provider, addresses, options) {
   return Object.fromEntries(
     addresses.map((address) => [address, options.value || 1])