Multi-manifest setup for subgraph deployments (#978)

BeanstalkFarms · Jul 31, 2024 · 0845c02 · 0845c02
2 parents ed4be2e + 57d8b49
commit 0845c02
Show file tree

Hide file tree

Showing 107 changed files with 2,028 additions and 9,516 deletions.
diff --git a/.github/workflows/ci.subgraph-basin.yaml b/.github/workflows/ci.subgraph-basin.yaml
@@ -44,7 +44,7 @@ jobs:
         run: echo "There are uncommitted changes - execute 'yarn codegen' locally and commit the generated files!"
 
       - name: Build Subgraph
-        run: yarn build
+        run: yarn build -- ethereum
         working-directory: projects/subgraph-basin
   test:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/ci.subgraph-bean.yaml b/.github/workflows/ci.subgraph-bean.yaml
@@ -44,7 +44,7 @@ jobs:
         run: echo "There are uncommitted changes - execute 'yarn codegen' locally and commit the generated files!"
 
       - name: Build Subgraph
-        run: yarn build
+        run: yarn build -- ethereum
         working-directory: projects/subgraph-bean
   test:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/ci.subgraph-beanft.yaml b/.github/workflows/ci.subgraph-beanft.yaml
@@ -44,7 +44,7 @@ jobs:
         run: echo "There are uncommitted changes - execute 'yarn codegen' locally and commit the generated files!"
 
       - name: Build Subgraph
-        run: yarn build
+        run: yarn build -- ethereum
         working-directory: projects/subgraph-beanft
   test:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/ci.subgraph-beanstalk.yaml b/.github/workflows/ci.subgraph-beanstalk.yaml
@@ -44,7 +44,7 @@ jobs:
         run: echo "There are uncommitted changes - execute 'yarn codegen' locally and commit the generated files!"
 
       - name: Build Subgraph
-        run: yarn build
+        run: yarn build -- ethereum
         working-directory: projects/subgraph-beanstalk
   test:
     runs-on: ubuntu-latest

diff --git a/projects/subgraph-basin/README.md b/projects/subgraph-basin/README.md
@@ -21,3 +21,7 @@ All currently used subgraphs live on a centralized host controlled by beanstalk
 ### Testing
 
 To test with Docker, the first time you will need to run `yarn run graph test -d`. This will build the `matchstick` Docker image. Then, you can use the `yarn testd` script to run all tests. Alternatively, use `yarn testd-named <TestName1> ...` to run specific tests. I have found running in Docker to be preferred since otherwise there can be issues with console output and some test cases fail silently.
+
+### Deploying
+
+When using graph cli commands, you will often need to specify which manifest file should be used. This is necessary to support multiple chains in the same codebase. The commands which need it will be evident - as they will fail when unable to find a `subgraph.yaml` file. In those commands, include `./manifest/${chain}.yaml` as the final argument to the command. See scripts inside `package.json` for examples.
diff --git a/projects/subgraph-basin/manifests/codegen-abis.yaml b/projects/subgraph-basin/manifests/codegen-abis.yaml
@@ -0,0 +1,58 @@
+# This file exists solely for the purpose of facilitating all codegen in a shared location such that all ABIs
+# or templates are expanded independently of being used in all chains. Most of the information here is irrelevant,
+# the only important part is in the `abis` and `templates` sections.
+#  - For abis, its only the list of abis that is relevant. The name of the dataSource is also visible.
+#  - For templates, it is only the name of the template that is relevant.
+specVersion: 0.0.4
+schema:
+  file: ../schema.graphql
+dataSources:
+  - kind: ethereum/contract
+    name: Basin-ABIs
+    network: not_relevant
+    source:
+      address: "0xBA51AAAA95aeEFc1292515b36D86C51dC7877773"
+      abi: Aquifer
+      startBlock: 17977922
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.7
+      language: wasm/assemblyscript
+      entities:
+        - Aquifer
+      abis:
+        - name: Aquifer
+          file: ../../subgraph-core/abis/Aquifer.json
+        - name: ERC20
+          file: ../../subgraph-core/abis/ERC20.json
+        - name: Beanstalk
+          file: ../../subgraph-core/abis/Beanstalk/Beanstalk-Replanted.json
+        - name: Well
+          file: ../../subgraph-core/abis/Well.json
+        - name: CurvePrice
+          file: ../../subgraph-core/abis/CurvePrice.json
+        - name: BeanstalkPrice
+          file: ../../subgraph-core/abis/BeanstalkPrice.json
+      eventHandlers:
+        - event: BoreWell(address,address,address[],(address,bytes),(address,bytes)[],bytes)
+          handler: handleBoreWell
+      file: ../src/templates/AquiferHandler.ts
+templates:
+  - kind: ethereum/contract
+    name: Well
+    network: not_relevant
+    source:
+      abi: Well
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.7
+      language: wasm/assemblyscript
+      entities:
+        - Well
+      abis:
+        - name: Well
+          file: ../../subgraph-core/abis/Well.json
+      eventHandlers:
+        - event: Sync(uint256[],uint256,address)
+          handler: handleSync
+      file: ../src/WellHandler.ts
diff --git a/projects/subgraph-basin/subgraph.yaml → ...ts/subgraph-basin/manifests/ethereum.yaml b/projects/subgraph-basin/subgraph.yaml → ...ts/subgraph-basin/manifests/ethereum.yaml
@@ -1,6 +1,6 @@
 specVersion: 0.0.4
 schema:
-  file: ./schema.graphql
+  file: ../schema.graphql
 dataSources:
   - kind: ethereum/contract
     name: Aquifer
@@ -17,13 +17,13 @@ dataSources:
         - Aquifer
       abis:
         - name: Aquifer
-          file: ../subgraph-core/abis/Aquifer.json
+          file: ../../subgraph-core/abis/Aquifer.json
         - name: ERC20
-          file: ../subgraph-core/abis/ERC20.json
+          file: ../../subgraph-core/abis/ERC20.json
       eventHandlers:
         - event: BoreWell(address,address,address[],(address,bytes),(address,bytes)[],bytes)
           handler: handleBoreWell
-      file: ./src/templates/AquiferHandler.ts
+      file: ../src/templates/AquiferHandler.ts
   - kind: ethereum/contract
     name: Beanstalk
     network: mainnet
@@ -39,11 +39,11 @@ dataSources:
         - Beanstalk
       abis:
         - name: Beanstalk
-          file: ../subgraph-core/abis/Beanstalk/Beanstalk-Replanted.json
+          file: ../../subgraph-core/abis/Beanstalk/Beanstalk-Replanted.json
       eventHandlers:
         - event: Sunrise(indexed uint256)
           handler: handleSunrise
-      file: ./src/BeanstalkHandler.ts
+      file: ../src/BeanstalkHandler.ts
 templates:
   - kind: ethereum/contract
     name: Well
@@ -58,13 +58,13 @@ templates:
         - Well
       abis:
         - name: Well
-          file: ../subgraph-core/abis/Well.json
+          file: ../../subgraph-core/abis/Well.json
         - name: CurvePrice
-          file: ../subgraph-core/abis/CurvePrice.json
+          file: ../../subgraph-core/abis/CurvePrice.json
         - name: BeanstalkPrice
-          file: ../subgraph-core/abis/BeanstalkPrice.json
+          file: ../../subgraph-core/abis/BeanstalkPrice.json
         - name: ERC20
-          file: ../subgraph-core/abis/ERC20.json
+          file: ../../subgraph-core/abis/ERC20.json
       eventHandlers:
         - event: AddLiquidity(uint256[],uint256,address)
           handler: handleAddLiquidity
@@ -78,7 +78,7 @@ templates:
           handler: handleShift
         - event: Sync(uint256[],uint256,address)
           handler: handleSync
-      file: ./src/WellHandler.ts
+      file: ../src/WellHandler.ts
 # features:
 #   - grafting
 # graft:

diff --git a/projects/subgraph-basin/matchstick-docker.yaml b/projects/subgraph-basin/matchstick-docker.yaml
@@ -3,4 +3,4 @@
 # subgraph has some dependencies on other projects in the repo.
 testsFolder: repo-mounted/projects/subgraph-basin/tests
 libsFolder: repo-mounted/node_modules
-manifestPath: repo-mounted/projects/subgraph-basin/subgraph.yaml
+manifestPath: repo-mounted/projects/subgraph-basin/manifests/ethereum.yaml
diff --git a/projects/subgraph-basin/matchstick.yaml b/projects/subgraph-basin/matchstick.yaml
@@ -1 +1,2 @@
 libsFolder: ../../node_modules
+manifestPath: ./manifests/ethereum.yaml
diff --git a/projects/subgraph-basin/package.json b/projects/subgraph-basin/package.json
@@ -8,17 +8,17 @@
     "directory": "projects/subgraph-basin"
   },
   "scripts": {
-    "codegen": "rm -rf ./generated && graph codegen",
-    "build": "yarn codegen && graph build",
+    "codegen": "rm -rf ./generated && graph codegen ./manifests/codegen-abis.yaml",
+    "build": "echo Using manifest at ./manifests/$1.yaml && yarn codegen && graph build ./manifests/$1.yaml",
     "test": "graph test",
     "testd": "docker run -it --rm --mount type=bind,source=\"$(pwd)\"/matchstick-docker.yaml,target=/matchstick/matchstick.yaml --mount type=bind,source=\"$(pwd)\"/../../,target=/matchstick/repo-mounted/ matchstick",
     "testd-named": "../subgraph-core/tests/scripts/docker-run-named.sh",
-    "create-local": "graph create --node http://127.0.0.1:8020/ basin",
-    "remove-local": "graph remove --node http://127.0.0.1:8020/ basin",
-    "deploy-local": "yarn codegen && graph deploy --node http://127.0.0.1:8020/ --ipfs http://127.0.0.1:5001 basin"
+    "create-local": "echo Using manifest at ./manifests/$1.yaml && graph create --node http://127.0.0.1:8020/ basin_$1",
+    "remove-local": "echo Using manifest at ./manifests/$1.yaml && graph remove --node http://127.0.0.1:8020/ basin_$1",
+    "deploy-local": "echo Using manifest at ./manifests/$1.yaml && yarn codegen && graph deploy --node http://127.0.0.1:8020/ --ipfs http://127.0.0.1:5001 basin_$1 ./manifests/$1.yaml"
   },
   "dependencies": {
-    "@graphprotocol/graph-cli": "0.69.0",
+    "@graphprotocol/graph-cli": "0.79.2",
     "@graphprotocol/graph-ts": "0.34.0"
   },
   "devDependencies": {

diff --git a/projects/subgraph-basin/src/BeanstalkHandler.ts b/projects/subgraph-basin/src/BeanstalkHandler.ts
@@ -1,6 +1,6 @@
 import { Address } from "@graphprotocol/graph-ts";
 import { AQUIFER } from "../../subgraph-core/utils/Constants";
-import { Sunrise } from "../generated/Beanstalk/Beanstalk";
+import { Sunrise } from "../generated/Basin-ABIs/Beanstalk";
 import { loadOrCreateAquifer } from "./utils/Aquifer";
 import { checkForSnapshot } from "./utils/Well";
 

diff --git a/projects/subgraph-basin/src/WellHandler.ts b/projects/subgraph-basin/src/WellHandler.ts
@@ -1,4 +1,4 @@
-import { AddLiquidity, RemoveLiquidity, RemoveLiquidityOneToken, Shift, Swap, Sync, Transfer } from "../generated/templates/Well/Well";
+import { AddLiquidity, RemoveLiquidity, RemoveLiquidityOneToken, Shift, Swap, Sync, Transfer } from "../generated/Basin-ABIs/Well";
 import { loadOrCreateAccount } from "./utils/Account";
 import { deltaBigIntArray, emptyBigIntArray, ZERO_BI } from "../../subgraph-core/utils/Decimals";
 import { recordAddLiquidityEvent, recordRemoveLiquidityEvent, recordRemoveLiquidityOneEvent, recordSyncEvent } from "./utils/Liquidity";

diff --git a/projects/subgraph-basin/src/templates/AquiferHandler.ts b/projects/subgraph-basin/src/templates/AquiferHandler.ts
@@ -1,6 +1,6 @@
 import { Address, Bytes, log } from "@graphprotocol/graph-ts";
-import { BoreWell } from "../../generated/Aquifer/Aquifer";
-import { ERC20 } from "../../generated/Aquifer/ERC20";
+import { BoreWell } from "../../generated/Basin-ABIs/Aquifer";
+import { ERC20 } from "../../generated/Basin-ABIs/ERC20";
 import { Well } from "../../generated/templates";
 import { loadOrCreateAquifer } from "../utils/Aquifer";
 import { loadOrCreatePump } from "../utils/Pump";

diff --git a/projects/subgraph-basin/src/utils/BeanstalkPrice.ts b/projects/subgraph-basin/src/utils/BeanstalkPrice.ts
@@ -1,6 +1,6 @@
 // Unfortunately this file must be copied across the various subgraph projects. This is due to the codegen
 import { Address, BigInt } from "@graphprotocol/graph-ts";
-import { BeanstalkPrice } from "../../generated/templates/Well/BeanstalkPrice";
+import { BeanstalkPrice } from "../../generated/Basin-ABIs/BeanstalkPrice";
 import { BEANSTALK_PRICE_1, BEANSTALK_PRICE_2, PRICE_2_BLOCK } from "../../../subgraph-core/utils/Constants";
 
 // Gets the BeanstalkPrice contract, bound to the appropriate instance of the contract.

diff --git a/projects/subgraph-basin/src/utils/Liquidity.ts b/projects/subgraph-basin/src/utils/Liquidity.ts
@@ -1,6 +1,6 @@
 import { BigInt } from "@graphprotocol/graph-ts";
 import { Deposit, Withdraw } from "../../generated/schema";
-import { AddLiquidity, RemoveLiquidity, RemoveLiquidityOneToken, Sync } from "../../generated/templates/Well/Well";
+import { AddLiquidity, RemoveLiquidity, RemoveLiquidityOneToken, Sync } from "../../generated/Basin-ABIs/Well";
 import { getBigDecimalArrayTotal } from "../../../subgraph-core/utils/Decimals";
 import { getCalculatedReserveUSDValues, loadWell } from "./Well";
 

diff --git a/projects/subgraph-basin/src/utils/Pump.ts b/projects/subgraph-basin/src/utils/Pump.ts
@@ -1,5 +1,5 @@
 import { Address } from "@graphprotocol/graph-ts";
-import { BoreWellPumpsStruct } from "../../generated/Aquifer/Aquifer";
+import { BoreWellPumpsStruct } from "../../generated/Basin-ABIs/Aquifer";
 import { Pump } from "../../generated/schema";
 
 export function loadOrCreatePump(pumpData: BoreWellPumpsStruct, wellAddress: Address): Pump {

diff --git a/projects/subgraph-basin/src/utils/Swap.ts b/projects/subgraph-basin/src/utils/Swap.ts
@@ -1,4 +1,4 @@
-import { Shift, Swap } from "../../generated/templates/Well/Well";
+import { Shift, Swap } from "../../generated/Basin-ABIs/Well";
 import { Swap as SwapEvent } from "../../generated/schema";
 import { Address, BigInt } from "@graphprotocol/graph-ts";
 

diff --git a/projects/subgraph-basin/src/utils/Token.ts b/projects/subgraph-basin/src/utils/Token.ts
@@ -1,7 +1,7 @@
 import { Address, BigDecimal, BigInt, log } from "@graphprotocol/graph-ts";
-import { ERC20 } from "../../generated/Aquifer/ERC20";
+import { ERC20 } from "../../generated/Basin-ABIs/ERC20";
 import { Token } from "../../generated/schema";
-import { CurvePrice } from "../../generated/templates/Well/CurvePrice";
+import { CurvePrice } from "../../generated/Basin-ABIs/CurvePrice";
 import { BEAN_ERC20, CURVE_PRICE } from "../../../subgraph-core/utils/Constants";
 import { toDecimal, ZERO_BD, ZERO_BI } from "../../../subgraph-core/utils/Decimals";
 import { getBeanstalkPrice } from "./BeanstalkPrice";

diff --git a/projects/subgraph-basin/src/utils/Well.ts b/projects/subgraph-basin/src/utils/Well.ts
@@ -1,7 +1,7 @@
 import { Address, BigDecimal, BigInt, Bytes, log } from "@graphprotocol/graph-ts";
-import { BoreWellWellFunctionStruct } from "../../generated/Aquifer/Aquifer";
+import { BoreWellWellFunctionStruct } from "../../generated/Basin-ABIs/Aquifer";
 import { Well, WellDailySnapshot, WellFunction, WellHourlySnapshot } from "../../generated/schema";
-import { ERC20 } from "../../generated/templates/Well/ERC20";
+import { ERC20 } from "../../generated/Basin-ABIs/ERC20";
 import { BEAN_ERC20 } from "../../../subgraph-core/utils/Constants";
 import { dayFromTimestamp, hourFromTimestamp } from "../../../subgraph-core/utils/Dates";
 import {

diff --git a/projects/subgraph-basin/tests/helpers/Aquifer.ts b/projects/subgraph-basin/tests/helpers/Aquifer.ts
@@ -1,6 +1,6 @@
 import { Address, Bytes, ethereum } from "@graphprotocol/graph-ts";
 import { newMockEvent } from "matchstick-as/assembly/index";
-import { BoreWell } from "../../generated/Aquifer/Aquifer";
+import { BoreWell } from "../../generated/Basin-ABIs/Aquifer";
 import { handleBoreWell } from "../../src/templates/AquiferHandler";
 import { BEAN_ERC20, WETH } from "../../../subgraph-core/utils/Constants";
 import { AQUIFER, IMPLEMENTATION, PUMP, WELL, WELL_DATA, WELL_FUNCTION } from "./Constants";

diff --git a/projects/subgraph-basin/tests/helpers/Well.ts b/projects/subgraph-basin/tests/helpers/Well.ts
@@ -1,6 +1,6 @@
 import { Address, BigInt, ethereum } from "@graphprotocol/graph-ts";
 import { newMockEvent } from "matchstick-as/assembly/index";
-import { AddLiquidity, RemoveLiquidity, RemoveLiquidityOneToken, Shift, Swap, Sync } from "../../generated/templates/Well/Well";
+import { AddLiquidity, RemoveLiquidity, RemoveLiquidityOneToken, Shift, Swap, Sync } from "../../generated/Basin-ABIs/Well";
 import { CURRENT_BLOCK_TIMESTAMP } from "./Constants";
 
 export function createAddLiquidityEvent(well: Address, account: Address, lpAmountOut: BigInt, tokenAmountsIn: BigInt[]): AddLiquidity {

diff --git a/projects/subgraph-bean/README.md b/projects/subgraph-bean/README.md
@@ -23,3 +23,7 @@ All currently used subgraphs live on a centralized host controlled by beanstalk
 ### Testing
 
 To test with Docker, the first time you will need to run `yarn run graph test -d`. This will build the `matchstick` Docker image. Then, you can use the `yarn testd` script to run all tests. Alternatively, use `yarn testd-named <TestName1> ...` to run specific tests. I have found running in Docker to be preferred since otherwise there can be issues with console output and some test cases fail silently.
+
+### Deploying
+
+When using graph cli commands, you will often need to specify which manifest file should be used. This is necessary to support multiple chains in the same codebase. The commands which need it will be evident - as they will fail when unable to find a `subgraph.yaml` file. In those commands, include `./manifest/${chain}.yaml` as the final argument to the command. See scripts inside `package.json` for examples.
diff --git a/projects/subgraph-bean/manifests/codegen-abis.yaml b/projects/subgraph-bean/manifests/codegen-abis.yaml
@@ -0,0 +1,49 @@
+# This file exists solely for the purpose of facilitating all codegen in a shared location such that all ABIs
+# or templates are expanded independently of being used in all chains. Most of the information here is irrelevant,
+# the only important part is in the `abis` and `templates` sections.
+#  - For abis, its only the list of abis that is relevant. The name of the dataSource is also visible.
+#  - For templates, it is only the name of the template that is relevant.
+specVersion: 0.0.4
+schema:
+  file: ../schema.graphql
+dataSources:
+  - kind: ethereum/contract
+    name: Bean-ABIs
+    network: not_relevant
+    source:
+      address: "0xDC59ac4FeFa32293A95889Dc396682858d52e5Db"
+      abi: ERC20
+      startBlock: 12974077
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.7
+      language: wasm/assemblyscript
+      entities:
+        - Bean
+      abis:
+        - name: ERC20
+          file: ../../subgraph-core/abis/ERC20.json
+        - name: UniswapV2Pair
+          file: ../../subgraph-core/abis/UniswapV2Pair.json
+        - name: Bean3CRV
+          file: ../../subgraph-core/abis/Bean3CRV.json
+        - name: Well
+          file: ../../subgraph-core/abis/Well.json
+        - name: PreReplant
+          file: ../../subgraph-core/abis/Beanstalk/Beanstalk-Pre-Replant.json
+        - name: Beanstalk
+          file: ../../subgraph-core/abis/Beanstalk/Beanstalk-Replanted.json
+        - name: BIP37
+          file: ../../subgraph-core/abis/Beanstalk/Beanstalk-BIP37.json
+        - name: SeedGauge
+          file: ../../subgraph-core/abis/Beanstalk/Beanstalk-BIP45.json
+        - name: BeanstalkPrice
+          file: ../../subgraph-core/abis/BeanstalkPrice.json
+        - name: CurvePrice
+          file: ../../subgraph-core/abis/CurvePrice.json
+        - name: CalculationsCurve
+          file: ../../subgraph-core/abis/CalculationsCurve.json
+      eventHandlers:
+        - event: Transfer(indexed address,indexed address,uint256)
+          handler: handleTransfer
+      file: ../src/BeanHandler.ts