kexleybeefy / lrt-subgraph

Beefy LRT Subgraph

This Subgraph sources events from the Beefy LRT contracts in different networks.

Deployments

Goldsky.com

Latest endpoints

• Arbitrum
• Base
• BSC
• Ethereum
• Mode
• Linea
• Optimism

Contributing

Prerequisites

• Git: git-scm.com
• Node.js: nodejs.org, see version in .nvmrc
• Yarn: yarnpkg.com
• Docker: docker.com
• Docker Compose: docker.com

Setup the project

yarn install

Running a local instance of graph-node locally

yarn infra:strat

Deploying the subgraph locally

yarn remove-local # if you have already deployed the subgraph
yarn create-local # create the subgraph locally
yarn prepare:<network> # apply configuration for the network
yarn codegen # generate the typescript types
yarn build # build the subgraph code
yarn deploy-local # deploy the subgraph locally

Run tests

yarn test # run all tests
yarn test:graph # run only matchstick-as graph tests
yarn test:lint # run prettier linter

HOWTOs

How to add a new network

1. Add the network configuration config/.json.
   • clockTickBlocks is the number of blocks between each clock tick, aim for a clock tick every ~5 minutes.
2. Add dev RPCs in graph-node config docker/graph-node/config.toml.
3. Add a new prepare:<network> script in package.json.
4. Add the chain in .github/workflows/Release.yml to configure deployments.
5. Test the build
   • Apply the configuration: npm run prepare:<chain>
   • Build the application: npm run build
   • Run Tests: npm run test
   • The PROD env is the uncommented url in the lrt-api .graphqlclient file
   • Deploy the new chain in DEV: ./bin/deploy.sh <chain> <dev provider>
   • Test the data in the dev provider subgraph explorer
   • Manually deploy the new chain in PROD for the first version: ./bin/deploy.sh <chain> <dev provider>
6. Update the Deployments section subgraph URLs in this README
7. Update the LRT API
8. Standard formatting with npm run format

How to update the schema

1. Create or update the schema.graphql file.

• See TheGraph docs for defining entities

2. Run yarn codegen to generate the typescript types.

• See TheGraph docs for TypeScript code generation

3. Update subgraph.template.yaml with the new entity bindings and/or data sources if needed.

• TheGraph docs for defining a call handler
• TheGraph docs for defining a block handler
• TheGraph docs for defining a data source template

4. Update or create the mappings in the mappings folder to handle the new entity.

• TheGraph docs for defining mappings
• TheGraph AssemblyScript API

5. Write tests for the new mappings in the tests folder.

• TheGraph docs for testing mappings

Deploy the subgraph

Manually

./bin/deploy.sh <network> goldsky
./bin/deploy.sh <network> 0xgraph

# or both
./bin/deploy.sh <network> goldsky 0xgraph

Release a new version

• Go to https://github.com/beefyfinance/lrt-subgraph/releases
• Add a new realease with a tag matching semver (tag matching X.X.X)
• Github actions will update all subgraph
• Monitor the indexing progress in the subgraph explorer