Getting us syncd with head repo

.env.example

@@ -0,0 +1,4 @@
+SNAPSHOT_API_STRATEGY_SALT=12345 # Salt for the snapshot API strategy to send a key in header (optional)
+PASSPORT_API_KEY= # API key for the passport API (optional for other strategies)
+PASSPORT_SCORER_ID= # Scorer ID for the passport API (optional for other strategies)
+MOXIE_API_KEY= # API key for the moxie APIs (optional for other strategies)

.eslintrc

@@ -13,6 +13,7 @@
   },
   "rules": {
     "no-console": "off",
+    "no-eval": "error",
     "prettier/prettier": "error",
     "@typescript-eslint/explicit-function-return-type": "off",
     "@typescript-eslint/ban-ts-ignore": "off",
@@ -21,6 +22,7 @@
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/ban-ts-comment": "off",
     "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/no-loss-of-precision": "off",
     "prefer-spread": "off"
   }
 }

.github/dependabot.yml

@@ -0,0 +1,14 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    allow:
+      # Allow updates for @snapshot-labs/* only
+      - dependency-name: "@snapshot-labs/*"

.github/workflows/nodejs.yml → .github/workflows/build.yml

@@ -1,18 +1,17 @@
-name: Node CI
+name: Build CI
 
 on: [push, pull_request]
 
 jobs:
-  build:
-
+  build_lint:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [16.10.x]
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2.3.4
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v1
       with:
@@ -21,4 +20,3 @@ jobs:
       run: |
         yarn install --frozen-lockfile
         yarn build
-        yarn lint

.github/workflows/main.yml → .github/workflows/fix-lint.yml

@@ -1,21 +1,21 @@
-name: Lint
+name: Fix lint
 on:
  workflow_dispatch:
  schedule:
    - cron: 0 10 * * 0
 
 jobs:
-  lint:
+  fix-lint:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: '14.x'
+          node-version: '16.10.x'
       - name: Run lint script
         run: |
           yarn install --frozen-lockfile
-          yarn lint
+          yarn lint:fix
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v3
         with:

.github/workflows/lint.yml

@@ -0,0 +1,8 @@
+name: Lint
+
+on: [push]
+
+jobs:
+  lint:
+    uses: snapshot-labs/actions/.github/workflows/lint.yml@main
+    secrets: inherit

.github/workflows/validation.yml

@@ -0,0 +1,34 @@
+name: Test validation
+on:
+  pull_request:
+    types:
+      - edited
+      - labeled
+      - synchronize
+      - ready_for_review
+      - review_requested
+      - reopened
+
+jobs:
+  test-validation:
+    if: contains(toJson(github.event.pull_request.labels), 'validation')
+    runs-on: ubuntu-latest
+    env:
+      PR_TITLE: ${{ github.event.pull_request.title }}
+
+    steps:
+    - uses: actions/[email protected]
+
+    - name: Create env file
+      run: |
+        touch .env
+        echo PASSPORT_API_KEY=${{ secrets.PASSPORT_API_KEY }}  >> .env
+        echo PASSPORT_SCORER_ID=${{ secrets.PASSPORT_SCORER_ID }}  >> .env
+
+    - name: yarn install and test validation
+      run: |
+        yarn install --frozen-lockfile
+        VALIDATION=$(echo $PR_TITLE | sed -e 's/.*\[\(.*\)\].*/\1/')
+        if [ -n "$VALIDATION" ]; then
+          yarn test:validation --validation=$VALIDATION
+        fi

.gitignore

@@ -5,3 +5,5 @@ dist
 # Remove some common IDE working directories
 .idea
 .vscode
+.env
+.history

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "none"
+}

README.md

@@ -14,7 +14,7 @@ yarn
 yarn build
 ```
 
-### Test strategy with predefined tests
+### Test strategy with predefined tests (params from examples.json file)
 
 > Note: If you're writing a new strategy, make sure to add it to strategies/index.ts before testing*
 
@@ -28,6 +28,12 @@ yarn test --strategy=eth-balance
 yarn test --strategy=eth-balance --more=200
 ```
 
+### Test validation with predefined tests (params from examples.json file)
+
+```
+yarn test:validation --validation=basic
+```
+
 ### Test strategy with different parameters
 
 Change values inside test/scores.ts and run
@@ -36,21 +42,24 @@ Change values inside test/scores.ts and run
 ts-node test/scores.ts
 ```
 
-### Checklist for adding a new strategy
+### Checklist for adding a new voting strategy or validation strategy
 
-Here is a simple checklist to look when reviewing a PR for a new strategy:
+Here is a simple checklist to look at when reviewing a PR for a new strategy:
 
 #### Overview
 
 - The strategy must be unique.
 - If the strategy does only a single call with an address as input, it's preferable to use the strategy "contract-call" instead of creating a new one.
+- For validations better to use `basic` validation and use existing strategies
 
 #### Code
 
+- Strategies should always use a `snapshot` to calculate user's voting power. As a result the voting power should not change throughout the proposal duration.
 - There should be a maximum of 5 requests, a request can use "fetch" a "subgraphRequest" or "multicall".
 - The strategy should not send a request for each voters, this doesn't scale.
-- The strategy PR should not add any dependency in Snapshot.js.
-- The score returned by the strategy should use the same casing for address than on the input, or should return checksummed addresses.
+- The strategy PR should not add any new dependency.
+- The score returned by the strategy should use the same casing for address as on the input, or should return checksum addresses.
+- Make sure that voting power of one address does not depend on other addresses.
 
 #### Example
 
@@ -64,7 +73,7 @@ Here is a simple checklist to look when reviewing a PR for a new strategy:
 
 #### Recommended
 
-- Add a README.md file that describe the strategy and provide an example of parameters.
+- Add a README.md file that describes the strategy and provides an example of parameters.
 - Use string ABI instead of object.
 
 ### License

jest.config.js

@@ -4,5 +4,8 @@ module.exports = {
   transform: {
     '^.+\\.tsx?$': 'ts-jest'
   },
-  testRegex: '/test(/(integration|unit))?/.*\\.spec\\.ts$'
+  testRegex: '/test(/(integration|unit))?/.*\\.test\\.ts$',
+  fakeTimers: {
+    enableGlobally: true
+  }
 };

package.json

@@ -13,47 +13,59 @@
   "license": "MIT",
   "scripts": {
     "build": "tsc -p .",
-    "test": "jest -i",
+    "test": "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",
     "prepublishOnly": "npm run build",
-    "prepare": "npm run build",
-    "postbuild": "copyfiles -u 1 src/**/*.md dist/ && copyfiles -u 1 src/**/*.json dist/",
-    "lint": "eslint . --ext .ts,.json --fix"
+    "postinstall": "npm run build",
+    "postbuild": "copyfiles -u 1 \"src/**/*.md\" dist/ && copyfiles -u 1 \"src/**/*.json\" dist/",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src/ test/ --ext .ts,.json",
+    "lint:fix": "yarn lint --fix"
   },
   "dependencies": {
-    "@ethersproject/abi": "^5.0.4",
-    "@ethersproject/address": "^5.0.4",
-    "@ethersproject/bignumber": "^5.0.12",
-    "@ethersproject/bytes": "^5.0.8",
-    "@ethersproject/contracts": "^5.0.3",
-    "@ethersproject/hash": "^5.0.9",
-    "@ethersproject/providers": "^5.3.1",
-    "@ethersproject/solidity": "^5.0.10",
-    "@ethersproject/strings": "^5.0.5",
-    "@ethersproject/units": "^5.0.3",
-    "@ethersproject/wallet": "^5.4.0",
-    "@snapshot-labs/snapshot.js": "^0.4.5",
+    "@ethersproject/abi": "^5.6.4",
+    "@ethersproject/address": "^5.6.1",
+    "@ethersproject/bignumber": "^5.6.2",
+    "@ethersproject/bytes": "^5.6.1",
+    "@ethersproject/contracts": "^5.6.2",
+    "@ethersproject/hash": "^5.6.1",
+    "@ethersproject/providers": "^5.6.8",
+    "@ethersproject/solidity": "^5.6.1",
+    "@ethersproject/strings": "^5.6.1",
+    "@ethersproject/units": "^5.6.1",
+    "@ethersproject/wallet": "^5.6.2",
+    "@snapshot-labs/snapshot.js": "^0.12.41",
+    "@spruceid/didkit-wasm-node": "^0.2.1",
     "@uniswap/sdk-core": "^3.0.1",
-    "@uniswap/v3-sdk": "^3.3.1",
-    "cross-fetch": "^3.0.6",
+    "@uniswap/v3-sdk": "^3.9.0",
+    "blakejs": "^1.2.1",
+    "copyfiles": "^2.4.1",
+    "cross-fetch": "^3.1.6",
+    "dotenv": "^16.0.3",
     "eth-ens-namehash": "^2.0.8",
-    "json-to-graphql-query": "^2.0.0"
+    "json-to-graphql-query": "^2.2.4",
+    "tulons": "^0.0.7"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.23",
-    "@types/node": "^13.9.5",
-    "@typescript-eslint/eslint-plugin": "^4.28.2",
-    "@typescript-eslint/parser": "^4.28.2",
-    "copyfiles": "^2.4.1",
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb-base": "^14.1.0",
-    "eslint-plugin-import": "^2.20.2",
-    "eslint-plugin-prettier": "^3.4.0",
-    "jest": "^28.1.1",
-    "prettier": "2.2.0",
-    "ts-jest": "^28.0.5",
-    "typescript": "^4.2.3"
+    "@types/jest": "^29.5.1",
+    "@types/node": "^18.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
+    "@typescript-eslint/parser": "^5.30.5",
+    "eslint": "^8.19.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.5.0",
+    "prettier": "^2.7.1",
+    "ts-jest": "^29.1.0",
+    "typescript": "^4.7.4"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16.10.0"
+  },
+  "resolutions": {
+    "@uniswap/v3-periphery": "1.4.1"
   }
 }

src/index.ts

@@ -1,7 +1,10 @@
+import 'dotenv/config';
 import strategies from './strategies';
+import validations from './validations';
 import utils from './utils';
 
 export default {
   strategies,
+  validations,
   utils
 };

src/strategies/a51-farming/README.md

@@ -0,0 +1,10 @@
+# A51 Farming
+
+This strategy fetches the user's amount from the farming.
+
+## Params
+
+|| **name**             || **description**                  || **default** ||
+|| farmingVaultAddress  || Address of the A51 farming vault ||             ||
+|| isToken0             || Is the token0 desired token      ||             ||
+|| decimals             || decimals of desired token        ||             ||

src/strategies/a51-farming/examples.json

@@ -0,0 +1,20 @@
+[
+  {
+    "name": "Example query",
+    "strategy": {
+      "name": "a51-farming",
+      "params": {
+        "farmingVaultAddress": "0x5ea84bb07f399fbf58c504929864b5fcbdc8300b",
+        "isToken0": false,
+        "decimals": 18
+      }
+    },
+    "network": "137",
+    "addresses": [
+      "0x0895fcb879d7b0d36f23b3f68b6192c532ffad01",
+      "0x072fb32a9d71482d970090daef0e90cd8c665113",
+      "0x75f2BbF3A10B67134A780fB7D6da5808265111F7"
+    ],
+    "snapshot": 55932446
+  }
+]