refactor: both the core and drt subgraphs

Author: jaybuidl

.github/workflows/deploy-subgraph.yml

@@ -6,12 +6,20 @@ on:
       network:
         description: The network to deploy the subgraph to
         required: true
-        default: 'arbitrum-goerli'
+        default: 'arbitrum-sepolia'
         type: choice
         options:
-          - arbitrum-goerli-devnet
-          - arbitrum-goerli
+          - arbitrum-sepolia-devnet
+          - arbitrum-sepolia
           - arbitrum
+      subgraph:
+        description: The name of the subgraph to deploy
+        required: true
+        default: 'core'
+        type: choice
+        options:
+          - core
+          - drt
       update:
         description: Whether to update the subgraph with the current artifacts for the selected network.
         required: true
@@ -58,19 +66,19 @@ jobs:
         if: ${{ inputs.update }}
         run: |
           export PATH=$PWD/../bin:$PATH
-          yarn update:${{ inputs.network }}
+          yarn update:${{ inputs.subgraph }}:${{ inputs.network }}
         working-directory: subgraph
 
       - name: Build the subgraph
         run: |
-          yarn codegen
-          yarn build
+          yarn codegen:${{ inputs.subgraph }}
+          yarn build:${{ inputs.subgraph }}
         working-directory: subgraph
 
       - name: Authenticate with TheGraph
         run: yarn graph auth "${{ secrets.SUBGRAPH_AUTH_TOKEN }}" --product hosted-service
         working-directory: subgraph
 
       - name: Deploy the subgraph
-        run: yarn deploy:${{ inputs.network }}
+        run: yarn deploy:${{ inputs.subgraph }}:${{ inputs.network }}
         working-directory: subgraph

subgraph/README.md

@@ -2,23 +2,30 @@
 
 ## Deployments
 
-### Arbitrum Sepolia (hosted service)
+### Testnet
 
-- [Subgraph explorer](https://thegraph.com/explorer/subgraph/kleros/kleros-v2-core-arbitrum-sepolia)
-- [Subgraph endpoints](https://api.thegraph.com/subgraphs/name/kleros/kleros-v2-core-arbitrum-sepolia)
+- [Core](https://thegraph.com/studio/subgraph/kleros-v2-core-testnet/)
+- [Dispute Registry Template - Arbitrum Sepolia](https://thegraph.com/studio/subgraph/kleros-v2-drt-arbisep-testnet/)
+
+### Devnet
+
+- [Core](https://thegraph.com/studio/subgraph/kleros-v2-core-devnet/)
+- [Dispute Registry Template - Arbitrum Sepolia](https://thegraph.com/studio/subgraph/kleros-v2-drt-arbisep-devnet/)
+- [Dispute Registry Template - Gnosis]()
+- [Dispute Registry Template - Sepolia]()
 
 ## Build
 
 ```bash
 # update subgraph.yml using the contract deployment artifacts
-$ yarn update:arbitrum-sepolia
+$ yarn update:arbitrum-sepolia-devnet
 
 $ yarn codegen
 
 $ yarn build
 ```
 
-## Deployment to The Graph (hosted service)
+## Deployment to The Graph Studio
 
 ### Using a personal account for development
 
@@ -27,13 +34,13 @@ $ yarn build
 Get an API key from the thegraph.com, then authenticate.
 
 ```bash
-$ yarn run graph auth --product hosted-service
+$ yarn run graph auth --studio
 ```
 
 #### Deployment
 
 ```bash
-yarn deploy:arbitrum-sepolia
+yarn deploy:arbitrum-sepolia-devnet
 ```
 
 ### Using the Kleros organization account

subgraph/schema.graphql renamed to subgraph/core/schema.graphql

@@ -1,10 +1,5 @@
-import {
-  HomeGateway,
-  Dispute as DisputeEvent,
-} from "../generated/HomeGateway/HomeGateway";
-import {
-  GatewayDispute
-} from "../generated/schema";
+import { HomeGateway, Dispute as DisputeEvent } from "../generated/HomeGateway/HomeGateway";
+import { GatewayDispute } from "../generated/schema";
 
 export function handleDisputeEvent(event: DisputeEvent): void {
   const contract = HomeGateway.bind(event.address);

subgraph/src/DisputeKitClassic.ts renamed to subgraph/core/src/DisputeKitClassic.ts

@@ -1,13 +1,8 @@
 import { ClassicContribution } from "../../generated/schema";
-import {
-  Contribution as ContributionEvent,
-  Withdrawal,
-} from "../../generated/DisputeKitClassic/DisputeKitClassic";
+import { Contribution as ContributionEvent, Withdrawal } from "../../generated/DisputeKitClassic/DisputeKitClassic";
 import { DISPUTEKIT_ID } from "../DisputeKitClassic";
 
-export function ensureClassicContributionFromEvent<T>(
-  event: T
-): ClassicContribution | null {
+export function ensureClassicContributionFromEvent<T>(event: T): ClassicContribution | null {
   if (!(event instanceof ContributionEvent) && !(event instanceof Withdrawal)) {
     return null;
   }

subgraph/src/EvidenceModule.ts renamed to subgraph/core/src/EvidenceModule.ts

@@ -26,9 +26,9 @@ dataSources:
         - Counter
       abis:
         - name: DisputeKitClassic
-          file: ../contracts/deployments/arbitrumSepoliaDevnet/DisputeKitClassic.json
+          file: ../../contracts/deployments/arbitrumSepoliaDevnet/DisputeKitClassic.json
         - name: KlerosCore
-          file: ../contracts/deployments/arbitrumSepoliaDevnet/KlerosCore.json
+          file: ../../contracts/deployments/arbitrumSepoliaDevnet/KlerosCore.json
       eventHandlers:
         - event: AppealDecision(indexed uint256,indexed address)
           handler: handleAppealDecision
@@ -75,7 +75,7 @@ dataSources:
         - Court
       abis:
         - name: PolicyRegistry
-          file: ../contracts/deployments/arbitrumSepoliaDevnet/PolicyRegistry.json
+          file: ../../contracts/deployments/arbitrumSepoliaDevnet/PolicyRegistry.json
       eventHandlers:
         - event: PolicyUpdate(indexed uint256,string,string)
           handler: handlePolicyUpdate
@@ -98,9 +98,9 @@ dataSources:
         - ClassicContribution
       abis:
         - name: DisputeKitClassic
-          file: ../contracts/deployments/arbitrumSepoliaDevnet/DisputeKitClassic.json
+          file: ../../contracts/deployments/arbitrumSepoliaDevnet/DisputeKitClassic.json
         - name: KlerosCore
-          file: ../contracts/deployments/arbitrumSepoliaDevnet/KlerosCore.json
+          file: ../../contracts/deployments/arbitrumSepoliaDevnet/KlerosCore.json
       eventHandlers:
         - event: DisputeCreation(indexed uint256,uint256,bytes)
           handler: handleDisputeCreation
@@ -131,7 +131,7 @@ dataSources:
         - ClassicEvidence
       abis:
         - name: EvidenceModule
-          file: ../contracts/deployments/arbitrumSepoliaDevnet/EvidenceModule.json
+          file: ../../contracts/deployments/arbitrumSepoliaDevnet/EvidenceModule.json
       eventHandlers:
         - event: Evidence(indexed uint256,indexed address,string)
           handler: handleEvidenceEvent

subgraph/src/HomeGateway.ts renamed to subgraph/core/src/HomeGateway.ts

@@ -2,26 +2,37 @@
   "name": "@kleros/kleros-v2-subgraph",
   "license": "MIT",
   "scripts": {
-    "update:core:arbitrum-sepolia": "./scripts/update.sh arbitrumSepolia arbitrum-sepolia",
-    "update:core:arbitrum-sepolia-devnet": "./scripts/update.sh arbitrumSepoliaDevnet arbitrum-sepolia",
-    "update:core:arbitrum": "./scripts/update.sh arbitrum arbitrum",
-    "update:core:local": "./scripts/update.sh localhost mainnet",
-    "codegen:core": "graph codegen",
-    "build:core": "graph build",
-    "test:core": "graph test",
-    "clean:core": "graph clean && rm subgraph.yaml.bak.*",
-    "deploy:core:arbitrum-sepolia": "graph deploy --product subgraph-studio kleros-v2-core-testnet-3 -l v0.0.1",
-    "deploy:core:arbitrum-sepolia-devnet": "graph deploy --product subgraph-studio kleros-v2-core-devnet -l v0.0.1",
-    "deploy:core:arbitrum": "graph deploy --product subgraph-studio kleros-v2-core -l v0.0.1",
-    "update:dr:arbitrum-sepolia": "TODO",
-    "update:dr:arbitrum-sepolia-devnet": "TODO",
-    "update:dr:arbitrum": "TODO",
-    "update:dr:local": "TODO",
-    "codegen:dr": "cd DisputeTemplateRegistry && graph codegen ./subgraph.yaml",
-    "build:dr": "cd DisputeTemplateRegistry && graph build ./subgraph.yaml",
-    "test:dr": "TODO",
-    "clean:dr": "cd DisputeTemplateRegistry && graph clean ./subgraph.yaml",
-    "deploy:dr:arbitrum-sepolia-devnet": "cd DisputeTemplateRegistry && graph deploy --product subgraph-studio kleros-v2-dr-devnet -l v0.0.1 ./subgraph.yaml",
+    "update:core:arbitrum-sepolia-devnet": "./scripts/update.sh arbitrumSepoliaDevnet arbitrum-sepolia core/subgraph.yaml",
+    "update:core:arbitrum-sepolia": "./scripts/update.sh arbitrumSepolia arbitrum-sepolia core/subgraph.yaml",
+    "update:core:arbitrum": "./scripts/update.sh arbitrum arbitrum core/subgraph.yaml",
+    "update:core:local": "./scripts/update.sh localhost mainnet core/subgraph.yaml",
+    "codegen:core": "graph codegen --output-dir core/generated/ core/subgraph.yaml",
+    "build:core": "graph build --output-dir core/build/ core/subgraph.yaml",
+    "test:core": "cd core && graph test",
+    "clean:core": "graph clean --codegen-dir core/generated/ --build-dir core/build/ && rm core/subgraph.yaml.bak.*",
+    "deploy:core:arbitrum-sepolia-devnet": "graph deploy --product subgraph-studio kleros-v2-core-devnet -l v0.0.1 core/subgraph.yaml",
+    "deploy:core:arbitrum-sepolia": "graph deploy --product subgraph-studio kleros-v2-core-testnet -l v0.0.1 core/subgraph.yaml",
+    "deploy:core:arbitrum": "graph deploy --product subgraph-studio kleros-v2-core -l v0.0.1 core/subgraph.yaml",
+    "": "------------------------------------------------------------------------------------------",
+    "update:drt:arbitrum-sepolia-devnet": "./scripts/update.sh arbitrumSepoliaDevnet arbitrum-sepolia dispute-template-registry/subgraph.yaml",
+    "update:drt:arbitrum-sepolia": "./scripts/update.sh arbitrumSepolia arbitrum-sepolia dispute-template-registry/subgraph.yaml",
+    "update:drt:arbitrum": "./scripts/update.sh arbitrum arbitrum dispute-template-registry/subgraph.yaml",
+    "update:drt:local": "./scripts/update.sh localhost mainnet dispute-template-registry/subgraph.yaml",
+    "codegen:drt": "graph codegen --output-dir dispute-template-registry/generated/ dispute-template-registry/subgraph.yaml",
+    "build:drt": "graph build --output-dir dispute-template-registry/generated/ dispute-template-registry/subgraph.yaml",
+    "test:drt": "cd dispute-template-registry && graph test ",
+    "clean:drt": "graph clean --codegen-dir dispute-template-registry/generated/ --build-dir dispute-template-registry/build/ && rm dispute-template-registry/subgraph.yaml.bak.*",
+    "deploy:drt:arbitrum-sepolia-devnet": "graph deploy --product subgraph-studio kleros-v2-drt-arbisep-devnet -l v0.0.1 dispute-template-registry/subgraph.yaml",
+    "deploy:drt:arbitrum-sepolia": "graph deploy --product subgraph-studio kleros-v2-drt-arbisep-testnet -l v0.0.1 dispute-template-registry/subgraph.yaml",
+    " ": "-----------------------------------------------------------------------------------------",
+    "update:arbitrum-sepolia-devnet": "./scripts/all.sh update arbitrum-sepolia-devnet",
+    "update:arbitrum-sepolia": "./scripts/all.sh update arbitrum-sepolia",
+    "update:arbitrum": "./scripts/all.sh update arbitrum",
+    "update:local": "./scripts/all.sh update local",
+    "clean": "./scripts/all.sh clean",
+    "codegen": "./scripts/all.sh codegen",
+    "build": "./scripts/all.sh build",
+    "  ": "----------------------------------------------------------------------------------------",
     "create-local": "graph create --node http://localhost:8020/ kleros/kleros-v2-core-local",
     "remove-local": "graph remove --node http://localhost:8020/ kleros/kleros-v2-core-local",
     "deploy-local": "graph deploy --node http://localhost:8020/ --ipfs http://localhost:5001 kleros/kleros-v2-core-local --version-label v$(date +%s)",

subgraph/src/KlerosCore.ts renamed to subgraph/core/src/KlerosCore.ts

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+cmdPrefix="$1"
+cmdPostfix="$2"
+if [ -z "$cmdPrefix" ]
+then
+    echo "Usage: $(basename $0) <cmdPrefix> [<cmdPostfix>]"
+    exit 1
+fi
+
+for subgraph in core drt
+do
+    echo "Running for $subgraph"
+    yarn "${cmdPrefix}:${subgraph}${cmdPostfix:+:}${cmdPostfix}"
+done

subgraph/src/PolicyRegistry.ts renamed to subgraph/core/src/PolicyRegistry.ts

@@ -2,31 +2,32 @@
 
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
 
-function update() #hardhatNetwork #graphNetwork #dataSourceIndex #contract
+function update() #hardhatNetwork #graphNetwork #subgraphConfig #dataSourceIndex #contract
 {
     local hardhatNetwork="$1"
     local graphNetwork="$2"
-    local dataSourceIndex="$3"
-    local contract="$4"
+    local subgraphConfig="$3"
+    local dataSourceIndex="$4"
+    local contract="$5"
     local artifact="$SCRIPT_DIR/../../contracts/deployments/$hardhatNetwork/$contract.json"
 
     # Set the address
     address=$(cat "$artifact" | jq '.address')
-    yq -i ".dataSources[$dataSourceIndex].source.address=$address" "$SCRIPT_DIR"/../subgraph.yaml
+    yq -i ".dataSources[$dataSourceIndex].source.address=$address" "$subgraphConfig"
 
     # Set the start block
     blockNumber="$(cat "$artifact" | jq '.receipt.blockNumber')"
-    yq -i ".dataSources[$dataSourceIndex].source.startBlock=$blockNumber" "$SCRIPT_DIR"/../subgraph.yaml
+    yq -i ".dataSources[$dataSourceIndex].source.startBlock=$blockNumber" "$subgraphConfig"
 
     # Set the Graph network
-    graphNetwork=$graphNetwork yq -i  ".dataSources[$dataSourceIndex].network=env(graphNetwork)" "$SCRIPT_DIR"/../subgraph.yaml
+    graphNetwork=$graphNetwork yq -i  ".dataSources[$dataSourceIndex].network=env(graphNetwork)" "$subgraphConfig"
 
     # Set the ABIs path for this Hardhat network
     abiIndex=0
-    for f in $(yq e .dataSources[$dataSourceIndex].mapping.abis[].file subgraph.yaml -o json -I 0 | jq -sr '.[]')
+    for f in $(yq e .dataSources[$dataSourceIndex].mapping.abis[].file "$subgraphConfig" -o json -I 0 | jq -sr '.[]')
     do
         f2=$(echo $f | sed "s|\(.*\/deployments\/\).*\/|\1$hardhatNetwork\/|")
-        yq -i ".dataSources[$dataSourceIndex].mapping.abis[$abiIndex].file=\"$f2\"" "$SCRIPT_DIR"/../subgraph.yaml
+        yq -i ".dataSources[$dataSourceIndex].mapping.abis[$abiIndex].file=\"$f2\"" "$subgraphConfig"
         (( ++abiIndex ))
     done
 }
@@ -36,13 +37,16 @@ hardhatNetwork=${1:-arbitrumSepolia}
 
 # as per https://thegraph.com/docs/en/developing/supported-networks/
 graphNetwork=${2:-arbitrum\-sepolia}
-i=0
+
+subgraphConfig="$SCRIPT_DIR/../${3:-core\/subgraph.yaml}"
+echo "Updating $subgraphConfig"
 
 # backup
-cp "$SCRIPT_DIR"/../subgraph.yaml "$SCRIPT_DIR"/../subgraph.yaml.bak.$(date +%s)
+cp "$subgraphConfig" "$subgraphConfig.bak.$(date +%s)"
 
-for contract in $(yq .dataSources[].name "$SCRIPT_DIR"/../subgraph.yaml)
+i=0
+for contract in $(yq .dataSources[].name "$subgraphConfig")
 do
-    update $hardhatNetwork $graphNetwork $i $contract
+    update $hardhatNetwork $graphNetwork "$subgraphConfig" $i $contract
     (( ++i ))
 done

subgraph/src/datapoint.ts renamed to subgraph/core/src/datapoint.ts

@@ -1,5 +1,5 @@
 # Do not enter sensitive information here.
 export REACT_APP_DEPLOYMENT=devnet
-export REACT_APP_KLEROS_CORE_SUBGRAPH_DEVNET=https://api.studio.thegraph.com/query/61688/kleros-v2-core-devnet/v0.0.1
-export REACT_APP_DISPUTE_TEMPLATE_ARBSEPOLIA_SUBGRAPH_DEVNET=https://api.studio.thegraph.com/query/61688/kleros-v2-dr-devnet/v0.0.1
+export REACT_APP_CORE_SUBGRAPH=https://api.studio.thegraph.com/query/61738/kleros-v2-core-devnet/v0.0.1
+export REACT_APP_DRT_ARBSEPOLIA_SUBGRAPH=https://api.studio.thegraph.com/query/61738/kleros-v2-drt-arbisep-devnet/v0.0.1
 export REACT_APP_STATUS_URL=https://kleros-v2-devnet.betteruptime.com/badge

subgraph/src/entities/Arbitrable.ts renamed to subgraph/core/src/entities/Arbitrable.ts

@@ -1,4 +1,4 @@
 # Do not enter sensitive information here.
 export REACT_APP_DEPLOYMENT=devnet
-export REACT_APP_KLEROS_CORE_SUBGRAPH_DEVNET=http://localhost:8000/subgraphs/name/kleros/kleros-v2-core-local
-export REACT_APP_DISPUTE_TEMPLATE_ARBSEPOLIA_SUBGRAPH_DEVNET=https://api.thegraph.com/subgraphs/name/alcercu/templateregistrydevnet
+export REACT_APP_CORE_SUBGRAPH=http://localhost:8000/subgraphs/name/kleros/kleros-v2-core-local
+export REACT_APP_DRT_ARBSEPOLIA_SUBGRAPH=https://api.thegraph.com/subgraphs/name/alcercu/templateregistrydevnet

subgraph/src/entities/ClassicContribution.ts renamed to subgraph/core/src/entities/ClassicContribution.ts

@@ -1,5 +1,5 @@
 # Do not enter sensitive information here.
 export REACT_APP_DEPLOYMENT=testnet
-export REACT_APP_KLEROS_CORE_SUBGRAPH_TESTNET=REDEPLOY SUBGRAPH IN ARBSEPOLIA AND PUT API THEGRAPH LINK HERE
-export REACT_APP_DISPUTE_TEMPLATE_ARBSEPOLIA_SUBGRAPH_TESTNET=REDEPLOY SUBGRAPH IN ARBSEPOLIA AND PUT API THEGRAPH LINK HERE
+export REACT_APP_CORE_SUBGRAPH=REDEPLOY SUBGRAPH IN ARBSEPOLIA AND PUT API THEGRAPH LINK HERE
+export REACT_APP_DRT_ARBSEPOLIA_SUBGRAPH=REDEPLOY SUBGRAPH IN ARBSEPOLIA AND PUT API THEGRAPH LINK HERE
 export REACT_APP_STATUS_URL=https://kleros-v2.betteruptime.com/badge

subgraph/src/entities/ClassicDispute.ts renamed to subgraph/core/src/entities/ClassicDispute.ts

@@ -1,30 +1,13 @@
 import request from "graphql-request";
 import { TypedDocumentNode } from "@graphql-typed-document-node/core";
 
-const DEPLOYMENT = process.env.REACT_APP_DEPLOYMENT?.toUpperCase() ?? "TESTNET";
-
-const DEPLOYMENTS_TO_KLEROS_CORE_SUBGRAPHS = {
-  MAINNET: process.env.REACT_APP_KLEROS_CORE_SUBGRAPH_MAINNET,
-  TESTNET: process.env.REACT_APP_KLEROS_CORE_SUBGRAPH_TESTNET,
-  DEVNET: process.env.REACT_APP_KLEROS_CORE_SUBGRAPH_DEVNET,
-};
-
-const DEPLOYMENTS_TO_DISPUTE_TEMPLATE_ARBSEPOLIA_SUBGRAPHS = {
-  MAINNET: process.env.REACT_APP_DISPUTE_TEMPLATE_ARBSEPOLIA_SUBGRAPH_MAINNET,
-  TESTNET: process.env.REACT_APP_DISPUTE_TEMPLATE_ARBSEPOLIA_SUBGRAPH_TESTNET,
-  DEVNET: process.env.REACT_APP_DISPUTE_TEMPLATE_ARBSEPOLIA_SUBGRAPH_DEVNET,
-};
-
 const CHAINID_TO_DISPUTE_TEMPLATE_SUBGRAPH = {
   421614:
-    DEPLOYMENTS_TO_DISPUTE_TEMPLATE_ARBSEPOLIA_SUBGRAPHS[DEPLOYMENT] ??
-    "https://api.thegraph.com/subgraphs/name/alcercu/disputetemplateregistryarbgrli",
+    process.env.REACT_APP_DRT_ARBSEPOLIA_SUBGRAPH ?? "Wrong Subgraph URL. Please check the environment variables.",
 };
 
 export const graphqlUrl = (isDisputeTemplate = false, chainId = 421614) => {
-  const coreUrl =
-    DEPLOYMENTS_TO_KLEROS_CORE_SUBGRAPHS[DEPLOYMENT] ??
-    "https://api.thegraph.com/subgraphs/name/alcercu/kleroscoretest";
+  const coreUrl = process.env.REACT_APP_CORE_SUBGRAPH ?? "Wrong Subgraph URL. Please check the environment variables.";
   return isDisputeTemplate ? CHAINID_TO_DISPUTE_TEMPLATE_SUBGRAPH[chainId] : coreUrl;
 };