feat(subgraph): add subgraph module for indexing data

.eslintignore

@@ -5,3 +5,8 @@ build
 typechain-types
 .eslintrc.js
 commitlint.config.js
+
+# subgraph
+subgraph.template.yaml
+generated
+subgraph/scripts

cli/testScript.sh

@@ -1,6 +1,6 @@
 #! /bin/bash
-# rm -r ./proofs
-# rm tally.json
+rm -r ./proofs
+rm tally.json
 node build/ts/index.js deployVkRegistry
 node build/ts/index.js setVerifyingKeys \
     --state-tree-depth 10 \
@@ -11,9 +11,18 @@ node build/ts/index.js setVerifyingKeys \
     --process-messages-zkey ./zkeys/ProcessMessages_10-2-1-2_test/ProcessMessages_10-2-1-2_test.0.zkey \
     --tally-votes-zkey ./zkeys/TallyVotes_10-1-2_test/TallyVotes_10-1-2_test.0.zkey
 node build/ts/index.js create -s 10
+
+# swith to subgraph module
+cd ../subgraph 
+pnpm codegen:local
+pnpm create-local
+pnpm deploy-local -l v0.1.2
+
+# switch back to cli module
+cd ../cli
 node build/ts/index.js deployPoll \
     --pubkey macipk.ea638a3366ed91f2e955110888573861f7c0fc0bb5fb8b8dca9cd7a08d7d6b93 \
-    -t 30 -i 1 -m 2 -b 1 -v 2 -se false
+    -t 100 -i 1 -m 2 -b 1 -v 2 -se false
 node build/ts/index.js signup \
     --pubkey macipk.e743ffb5298ef0f5c1f63b6464a48fea19ea7ee5a885c67ae1b24a1d04f03f07 
 node build/ts/index.js publish \

cli/ts/commands/deploy.ts

@@ -17,6 +17,7 @@ import {
   type DeployedContracts,
   type DeployArgs,
 } from "../utils";
+import { backupSubgraphNetworksFile, storeSubgraphNetworks } from "../utils/storage";
 
 /**
  * Deploy MACI and related contracts
@@ -118,6 +119,14 @@ export const deploy = async ({
   storeContractAddress("PoseidonT5", poseidonAddrs.poseidonT5, network?.name);
   storeContractAddress("PoseidonT6", poseidonAddrs.poseidonT6, network?.name);
 
+  // backup previous deployment's contract addresses
+  backupSubgraphNetworksFile();
+
+  // save to the subgraph networks.json file
+  await maciContract.waitForDeployment();
+  const txn = maciContract.deploymentTransaction();
+  storeSubgraphNetworks("MACI", maciContractAddress, txn?.blockNumber ?? 0, network?.name);
+
   logGreen(quiet, success(`MACI deployed at:  ${maciContractAddress}`));
 
   // return all addresses

cli/ts/utils/constants.ts

@@ -8,3 +8,27 @@ export const oldContractAddressStoreName = "contractAddresses.old.json";
 export const contractAddressesStore = path.resolve(__dirname, "..", "..", contractAddressStoreName);
 // local file path where we are storing a previous deployment's contract addresses
 export const oldContractAddressesStore = path.resolve(__dirname, "..", "..", oldContractAddressStoreName);
+// local file name in subgraph module where we are storing the MACI contract address and block number
+export const subgraphNetworkStoreName = "networks.json";
+// local file name in subgraph module where we are storing the previous deployment's MACI contract address and block number
+export const oldSubgraphNetworkStoreName = "networks.old.json";
+// local file path in subgraph module where we are storing the MACI contract address and block number
+export const subgraphNetworkStore = path.resolve(
+  __dirname,
+  "..",
+  "..",
+  "..",
+  "..",
+  "subgraph",
+  subgraphNetworkStoreName,
+);
+// local file path in subgraph module where we are storing the previous deployment's MACI contract address and block number
+export const oldSubgraphNetworkStore = path.resolve(
+  __dirname,
+  "..",
+  "..",
+  "..",
+  "..",
+  "subgraph",
+  oldSubgraphNetworkStoreName,
+);

cli/ts/utils/storage.ts

@@ -1,6 +1,6 @@
 import fs from "fs";
 
-import { contractAddressesStore } from "./constants";
+import { contractAddressesStore, oldSubgraphNetworkStore, subgraphNetworkStore } from "./constants";
 import { logError } from "./theme";
 
 /**
@@ -69,3 +69,58 @@ export const doesPathExist = (paths: string[]): [boolean, string | null] => {
 
   return notFoundPath ? [false, notFoundPath] : [true, null];
 };
+
+/**
+ * Read a networks.json file from disk
+ * @param path - the path of the file
+ * @returns the JSON object
+ */
+export const readNetworksJSONFile = (
+  path: string,
+): Record<string, Record<string, { address: string; startBlock: number } | undefined>> => {
+  if (!fs.existsSync(path)) {
+    logError(`File ${path} does not exist`);
+  }
+
+  return JSON.parse(fs.readFileSync(path).toString()) as Record<
+    string,
+    Record<string, { address: string; startBlock: number } | undefined>
+  >;
+};
+
+/**
+ * Store a contract address to the local address store file in subgraph module
+ * @param contractName - the name of the contract
+ * @param address - the address of the contract
+ * @param blockNumber - the block number of the deployment contract
+ */
+export const storeSubgraphNetworks = (
+  contractName: string,
+  address: string,
+  startBlock = 0,
+  network = "default",
+): void => {
+  // if it does not exist yet, then create it
+  if (!fs.existsSync(subgraphNetworkStore)) {
+    fs.writeFileSync(subgraphNetworkStore, "{}");
+  }
+
+  const networks = readNetworksJSONFile(subgraphNetworkStore);
+
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  if (!networks[network]) {
+    networks[network] = {};
+  }
+
+  networks[network][contractName] = {
+    address,
+    startBlock,
+  };
+  fs.writeFileSync(subgraphNetworkStore, JSON.stringify(networks, null, 2));
+};
+
+export const backupSubgraphNetworksFile = (): void => {
+  if (fs.existsSync(subgraphNetworkStore)) {
+    fs.copyFileSync(subgraphNetworkStore, oldSubgraphNetworkStore);
+  }
+};

lerna.json

@@ -1,5 +1,15 @@
 {
-  "packages": ["circuits", "cli", "contracts", "core", "crypto", "domainobjs", "integrationTests", "website"],
+  "packages": [
+    "circuits",
+    "cli",
+    "contracts",
+    "core",
+    "crypto",
+    "domainobjs",
+    "integrationTests",
+    "website",
+    "subgraph"
+  ],
   "version": "1.1.2",
   "npmClient": "pnpm",
   "changelogPreset": {