feat: add token-locker-weight

package.json

@@ -57,7 +57,7 @@
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "jest": "^29.5.0",
+    "jest": "^29.7.0",
     "prettier": "^2.7.1",
     "ts-jest": "^29.1.0",
     "typescript": "^4.7.4"

src/strategies/index.ts

@@ -462,6 +462,7 @@ import * as moxie from './moxie';
 import * as stakingAmountDurationLinear from './staking-amount-duration-linear';
 import * as stakingAmountDurationExponential from './staking-amount-duration-exponential';
 import * as sacraSubgraph from './sacra-subgraph';
+import * as tokenLockerWeight from './token-locker-weight';
 
 const strategies = {
   'delegatexyz-erc721-balance-of': delegatexyzErc721BalanceOf,
@@ -934,7 +935,8 @@ const strategies = {
   moxie: moxie,
   'staking-amount-duration-linear': stakingAmountDurationLinear,
   'staking-amount-duration-exponential': stakingAmountDurationExponential,
-  'sacra-subgraph': sacraSubgraph
+  'sacra-subgraph': sacraSubgraph,
+  'token-locker-weight': tokenLockerWeight
 };
 
 Object.keys(strategies).forEach(function (strategyName) {

src/strategies/token-locker-weight/README.md

@@ -0,0 +1,13 @@
+# ve-asf
+
+This strategy returns the veASF balance in token locker of the voters (it actually returns the weight)
+
+Here is an example of parameters:
+
+```json
+{
+  "address": "0xF119B5Aa93a7755b09952B3a88D04cdAf5329034",
+  "symbol": "veASF",
+  "decimals": 1
+}
+```

src/strategies/token-locker-weight/examples.json

@@ -0,0 +1,20 @@
+[
+  {
+    "name": "Example query",
+    "strategy": {
+      "name": "token-locker-weight",
+      "params": {
+        "address": "0xF119B5Aa93a7755b09952B3a88D04cdAf5329034",
+        "symbol": "veASF",
+        "decimals": 1
+      }
+    },
+    "network": "1",
+    "addresses": [
+      "0x288adAe4E3639DD1f4a558E8636BD15F998Ae2C1",
+      "0x4f9ccE86D68Ee24275B9A2EDfC4eF52bd5e5b87c",
+      "0x318d0059efE546b5687FA6744aF4339391153981"
+    ],
+    "snapshot": 21112712
+  }
+]

src/strategies/token-locker-weight/index.ts

@@ -0,0 +1,36 @@
+import { BigNumberish } from '@ethersproject/bignumber';
+import { formatUnits } from '@ethersproject/units';
+import { Multicaller } from '../../utils';
+
+export const author = 'johnnyonline';
+export const version = '0.1.1';
+
+const TOKEN_LOCKER = '0xF119B5Aa93a7755b09952B3a88D04cdAf5329034';
+
+const abi = [
+  'function getAccountWeight(address account) external view returns (uint256)'
+];
+
+export async function strategy(
+  space,
+  network,
+  provider,
+  addresses,
+  options,
+  snapshot
+): Promise<Record<string, number>> {
+  const blockTag = typeof snapshot === 'number' ? snapshot : 'latest';
+
+  const multi = new Multicaller(network, provider, abi, { blockTag });
+  addresses.forEach((address) =>
+    multi.call(address, TOKEN_LOCKER, 'getAccountWeight', [address])
+  );
+  const result: Record<string, BigNumberish> = await multi.execute();
+
+  return Object.fromEntries(
+    Object.entries(result).map(([address, balance]) => [
+      address,
+      parseFloat(formatUnits(balance, options.decimals))
+    ])
+  );
+}

src/strategies/token-locker-weight/schema.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/Strategy",
+  "definitions": {
+    "Strategy": {
+      "title": "Strategy",
+      "type": "object",
+      "properties": {
+        "symbol": {
+          "type": "string",
+          "title": "Symbol",
+          "examples": ["e.g. UNI"],
+          "maxLength": 16
+        },
+        "address": {
+          "type": "string",
+          "title": "Contract address",
+          "examples": ["e.g. 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984"],
+          "pattern": "^0x[a-fA-F0-9]{40}$",
+          "minLength": 42,
+          "maxLength": 42
+        },
+        "decimals": {
+          "type": "number",
+          "title": "Decimals",
+          "examples": ["e.g. 18"],
+          "minimum": 0
+        }
+      },
+      "required": ["address", "decimals"],
+      "additionalProperties": false
+    }
+  }
+}