[SUBGRAPH | METADATA] tech debt refactor (#1692)

* tech debt refactor

- remove config files
- new script for retrieving hosted service networks
- new script for building network config file
- modify deploy.sh to use new network config builder
- build hosted service network json in necessary workflow files

* Delete hosted-service-networks.json

* fix up workflow

.github/workflows/call.check-query-schema-against-subgraph.yml

@@ -34,6 +34,10 @@ jobs:
         run: yarn build
         working-directory: ./packages/ethereum-contracts
 
+      - name: Get Hosted Service Networks from metadata
+        run: npx ts-node ./scripts/getHostedServiceNetworks.ts
+        working-directory: ./packages/subgraph
+
       - name: Run schema check
         run: |
           ./tasks/setupTestEnvironment.sh

.github/workflows/call.deploy-subgraph.yml

@@ -97,6 +97,10 @@ jobs:
         run: "yarn codegen"
         working-directory: ${{ env.subgraph-working-directory }}
 
+      - name: Get Hosted Service Networks from metadata
+        run: npx ts-node ./scripts/getHostedServiceNetworks.ts
+        working-directory: ${{ env.subgraph-working-directory }}
+
       # - name: Ensure deployment_env property is passed
       #   run: |
       #     if [ "${{ inputs.deployment_env }}" == "" ];then

.github/workflows/call.test-local-subgraph.yml

@@ -8,6 +8,9 @@ jobs:
     name: Run subgraph unit tests
     runs-on: ubuntu-latest
 
+    env:
+      subgraph-working-directory: ./packages/subgraph
+
     defaults:
       run:
         shell: nix develop -c bash -xe {0}
@@ -34,10 +37,14 @@ jobs:
       - name: "Build contracts"
         run: yarn build
         working-directory: ./packages/ethereum-contracts
+
+      - name: "Build"
+        run: npx ts-node scripts/buildNetworkConfig.ts polygon-mainnet
+        working-directory: ${{ env.subgraph-working-directory }}
 
       - name: "Run unit tests"
         run: yarn matchstick
-        working-directory: ./packages/subgraph
+        working-directory: ${{ env.subgraph-working-directory }}
 
   subgraph-end-to-end-integration:
     name: Run subgraph integration tests

packages/metadata/module/networks/list.d.ts

@@ -23,7 +23,7 @@ interface ContractAddresses {
 }
 interface SubgraphData {
     readonly name: string;
-    readonly hostedEndpoint: string;
+    readonly hostedEndpoint?: string;
     readonly satsumaEndpoint?: string;
 }
 export interface NetworkMetaData {

packages/subgraph/.gitignore

@@ -8,4 +8,5 @@ tasks/config
 src/addresses.ts
 **/*.wasm
 **/*.latest.json
-tests/.bin
+tests/.bin
+hosted-service-networks.json

packages/subgraph/package.json

@@ -18,8 +18,8 @@
         "pretest": "yarn testenv:start",
         "test": "npx hardhat test",
         "matchstick": "run-s matchstick:*",
-        "matchstick:prepare-manifest": "mustache config/matic.json subgraph.template.yaml > subgraph.yaml",
-        "matchstick:prepare-addresses": "mustache config/matic.json src/addresses.template.ts > src/addresses.ts",
+        "matchstick:prepare-manifest": "mustache config/polygon-mainnet.json subgraph.template.yaml > subgraph.yaml",
+        "matchstick:prepare-addresses": "mustache config/polygon-mainnet.json src/addresses.template.ts > src/addresses.ts",
         "matchstick:prepare-generated": "yarn getAbi && yarn codegen && yarn generate-sf-meta-local",
         "matchstick:test": "graph test",
         "dev": "nodemon -e ts -x yarn matchstick:test",

packages/subgraph/scripts/buildNetworkConfig.ts

@@ -0,0 +1,48 @@
+import fs from "fs";
+import metadata from "@superfluid-finance/metadata";
+
+interface SubgraphConfig {
+    readonly network: string;
+    readonly hostStartBlock: number;
+    readonly hostAddress: string;
+    readonly cfaAddress: string;
+    readonly idaAddress: string;
+    readonly superTokenFactoryAddress: string;
+    readonly resolverV1Address: string;
+    readonly nativeAssetSuperTokenAddress: string;
+}
+
+// script usage: npx ts-node ./scripts/buildNetworkConfig.ts <NETWORK_NAME>
+function main() {
+    const networkName = process.argv[2];
+
+    const networkMetadata = metadata.getNetworkByName(networkName);
+
+    if (!networkMetadata) {
+        throw new Error("No metadata found");
+    }
+    const newThing: SubgraphConfig = {
+        network: networkMetadata.shortName,
+        hostStartBlock: networkMetadata.startBlockV1,
+        hostAddress: networkMetadata.contractsV1.host,
+        cfaAddress: networkMetadata.contractsV1.cfaV1,
+        idaAddress: networkMetadata.contractsV1.idaV1,
+        superTokenFactoryAddress: networkMetadata.contractsV1.superTokenFactory,
+        resolverV1Address: networkMetadata.contractsV1.resolver,
+        nativeAssetSuperTokenAddress: networkMetadata.nativeTokenWrapper,
+    };
+
+    const writeToDir =
+        __dirname.split("subgraph")[0] + `subgraph/config/${networkName}.json`;
+
+    fs.writeFile(writeToDir, JSON.stringify(newThing), (err) => {
+        if (err) {
+            console.log(err);
+            process.exit(1);
+        } else {
+            process.exit(0);
+        }
+    });
+}
+
+main();

packages/subgraph/scripts/getHostedServiceNetworks.ts

@@ -0,0 +1,28 @@
+import fs from "fs";
+import metadata from "@superfluid-finance/metadata";
+
+// This script is used to retrieve the list of networks which have a hosted
+// service endpoint.
+// script usage: npx ts-node ./scripts/getHostedServiceNetworks.ts
+function main() {
+    const networks = JSON.stringify(
+        metadata.networks
+            .filter((x) => x.subgraphV1.hostedEndpoint != null)
+            .map((x) => x.name)
+    );
+
+    const writeToDir =
+        __dirname.split("subgraph")[0] +
+        "subgraph/hosted-service-networks.json";
+
+    fs.writeFile(writeToDir, networks, (err) => {
+        if (err) {
+            console.log(err);
+            process.exit(1);
+        } else {
+            process.exit(0);
+        }
+    });
+}
+
+main();