feat: erc20-balance-starknet strategy

Author: wa0x6e

src/strategies/erc20-balance-starknet/README.md

@@ -0,0 +1,15 @@
+# erc20-balance-starknet
+
+This strategy returns the balance of the voters for a specific Starknet ERC20 token.
+
+Here is an example of parameters:
+
+```json
+{
+  "address": "0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7",
+  "symbol": "ETH",
+  "decimals": 18
+}
+```
+
+List of tokens and its details can be found on https://starkscan.co/top-tokens

src/strategies/erc20-balance-starknet/examples.json

@@ -0,0 +1,35 @@
+[
+  {
+    "name": "Top STRK Holders's balance",
+    "strategy": {
+      "name": "erc20-balance-of",
+      "params": {
+        "address": "0x04718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d",
+        "symbol": "STRK",
+        "decimals": 18
+      }
+    },
+    "network": "1",
+    "addresses": [
+      "0x00ca1702e64c81d9a07b86bd2c540188d92a2c73cf5cc0e508d949015e7e84a7",
+      "0x076601136372fcdbbd914eea797082f7504f828e122288ad45748b0c8b0c9696",
+      "0x04164013f90b05d67f026779bf96e9c401c96f3485b645a786166e6935fba116",
+      "0x0620102ea610be8518125cf2de850d0c4f5d0c5d81f969cff666fb53b05042d2",
+      "0x04098bc6868cc52385b33ebcc7ede01ff6e6bc2ee7f1da6bebece088ee23f6c2",
+      "0x032cfb78d9f64ece832b7f868253c232f085a374365d0ed859ee0164a2ac0588",
+      "0x059a943ca214c10234b9a3b61c558ac20c005127d183b86a99a8f3c60a08b4ff",
+      "0x02a67f5ab24f4354755dbc4ab684ba6d5c1520ea45aad99f4e7a9f996ced075d",
+      "0x07cd150a7a0b45b5f413e56e45964c7ecdd665dca029d1bc8bdae7d4b71470fd",
+      "0x0480eeffbc7f47d92e72fa330883c17f6fb34f109c0d6ccc6aaebb88ea393071",
+      "0x0294e0596df21f2eb007a898cc1492a58aaee07de9ffcb95532dc0182153397d",
+      "0x00000005dd3d2f4429af886cd1a3b08289dbcea99a294197e9eb43b0e0325b4b",
+      "0x069a7818562b608ce8c5d0039e7f6d1c6ee55f36978f633b151858d85c022d2f",
+      "0x048f1578bdca1a208441e1c58982c2789c8d3a4e7f56690bb8f1838db439d0dc",
+      "0x044716d416ff66f83a4c3ac811d713cf256017f6906d3412b976ae1f4f35af36",
+      "0x002f96a7f4baf4d6e59534cd1614973778c205f419bbcb513c20fa1b717e8fde",
+      "0x0213c67ed78bc280887234fe5ed5e77272465317978ae86c25a71531d9332a2d",
+      "0x07dddb7d3a1321a854691e736f951704deaf33bde78c49a32e9e7e8e8a1e9537"
+    ],
+    "snapshot": 1459522
+  }
+]

src/strategies/erc20-balance-starknet/index.ts

@@ -0,0 +1,49 @@
+import { BigNumberish } from '@ethersproject/bignumber';
+import { formatUnits } from '@ethersproject/units';
+import { Multicaller } from '../../utils';
+
+export const author = 'waOx6e';
+export const version = '0.O.1';
+
+const abi = [
+  {
+    name: 'balanceOf',
+    type: 'function',
+    inputs: [
+      {
+        name: 'account',
+        type: 'core::starknet::contract_address::ContractAddress'
+      }
+    ],
+    outputs: [
+      {
+        type: 'core::integer::u256'
+      }
+    ],
+    state_mutability: 'view'
+  }
+];
+
+export async function strategy(
+  space: string,
+  network: string,
+  provider,
+  addresses: string[],
+  options: { address: string; decimals: number; symbol?: string },
+  snapshot: 'latest' | number
+): Promise<Record<string, number>> {
+  const blockTag = typeof snapshot === 'number' ? snapshot : 'latest';
+
+  const multi = new Multicaller(network, provider, abi, { blockTag });
+  addresses.forEach((voterAddress) =>
+    multi.call(voterAddress, options.address, 'balanceOf', [voterAddress])
+  );
+  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/erc20-balance-starknet/schema.json

@@ -0,0 +1,35 @@
+{
+  "$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. STRK"],
+          "maxLength": 16
+        },
+        "address": {
+          "type": "string",
+          "title": "Contract address",
+          "examples": ["e.g. 0x049d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7"],
+          "pattern": "^0x[a-fA-F0-9]{64}$",
+          "minLength": 66,
+          "maxLength": 66,
+          "errorMessage": "Must be a valid lowercase and padded Starknet contract address"
+        },
+        "decimals": {
+          "type": "number",
+          "title": "Decimals",
+          "examples": ["e.g. 18"],
+          "minimum": 0
+        }
+      },
+      "required": ["address", "decimals"],
+      "additionalProperties": false
+    }
+  }
+}

src/strategies/index.ts

@@ -36,6 +36,7 @@ import * as erc20BalanceOfWithDelegation from './erc20-balance-of-with-delegatio
 import * as erc20BalanceOfQuadraticDelegation from './erc20-balance-of-quadratic-delegation';
 import * as erc20BalanceOfTopHolders from './erc20-balance-of-top-holders';
 import * as erc20BalanceOfWeighted from './erc20-balance-of-weighted';
+import * as erc20BalanceStarknet from './erc20-balance-starknet';
 import * as ethalendBalanceOf from './ethalend-balance-of';
 import * as prepoVesting from './prepo-vesting';
 import * as erc20BalanceOfIndexed from './erc20-balance-of-indexed';
@@ -539,6 +540,7 @@ const strategies = {
   'erc20-balance-of-top-holders': erc20BalanceOfTopHolders,
   'erc20-balance-of-weighted': erc20BalanceOfWeighted,
   'erc20-balance-of-indexed': erc20BalanceOfIndexed,
+  'erc20-balance-starknet': erc20BalanceStarknet,
   'erc20-price': erc20Price,
   'ethalend-balance-of': ethalendBalanceOf,
   'balance-of-with-min': balanceOfWithMin,