Beefy beefy-balances Subgraph

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

Deployments

Goldsky.com

Latest endpoints

• Avalanche
• Arbitrum
• Berachain
• Base
• Bsc
• Ethereum
• Fantom
• Fraxtal
• Gnosis
• Linea
• Lisk
• Manta
• Mantle
• Metis
• Mode
• Moonbeam
• Optimism
• Polygon
• Rootstock
• Scroll
• Sei
• Sonic
• Unichain
• Zksync

Contributing

Prerequisites

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

Setup the project

yarn install

Running a local instance of graph-node locally

yarn infra:strat

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.
   • indexerHintPrune is the number of blocks to keep for the indexer hint, aim for 2 months. Can be set to "auto" to prune as much as possible. Recommended for performance and cost. Or set to "never" to keep all updates history. (Thegraph docs)
2. Add the data configuration data/.json
3. Add the chain in .github/workflows/Release.yml to configure deployments.
4. Add the endpoint link to the README in alphabetical order.
5. Release the first version of the subgraph for the new network using the ./bin/release.sh script.
   • Must be logged in to goldsky with the provided cli.
   • Only used to deploy the first version, see below for updating a subgraph.

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/beefy-balances-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