Beefy CLM Subgraph

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

Deployments

Goldsky.com

Latest endpoints

• Arbitrum
• Base
• Optimism

Historical endpoints

• Arbitrum (beta, old subgraph)
• Arbitrum (beta)
• Base (beta)
• Optimism (beta)

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.
   • Find the uniswap v3, QuoterV2 contract address on uniswap's documentation
   • Find the /USD price feed on chainlink's documentation. Verify that it's a ChainLink AggregatorV3Interface with the latestRoundData() method.
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 a new deploy:<network>:<provider> script in package.json.

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

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

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

Dependecies on the underlying contracts

- vaultFactory: ProxyCreated(address)
- vault.balances()
- vault.totalSupply()
- vault.balanceOf()
- vault.strategy()
- vault.wants()
- vault: Initialized(uint8)
- vault: Transfer(indexed address,indexed address,uint256)

- strategyFactory: GlobalPause(bool)
- strategy.pool()
- strategy.vault()
- strategy.output()
- strategy.price()
- strategy.range()
- strategy.balanceOfPool()
- strategy.lpToken1ToNativePrice()
- strategy.lpToken0ToNativePrice()
- strategy.ouptutToNativePrice()
- strategy: Initialized(uint8)
- strategy: Paused(address)
- strategy: Unpaused(address)
- strategy: Harvest(uint256,uint256)
- strategy: ClaimedFees(uint256,uint256,uint256,uint256)
- strategy: ClaimedOutput(uint256)

- rewardPoolFactory: ProxyCreated(address)
- rewardPool.stakedToken()
- rewardPool: Initialized(uint8)