Subgraphs

Contribution Guidelines

Decide which protocol you want to build a subgraph for
Fork this repository
Add a folder under subgraphs with the name of the protocol you want to work on
Copy over the corresponding schema from the root folder. For example, if you are working on a yield aggregator, you should copy over schema-yield.graphql to your folder and rename it to schema.graphql. Note schema-common.graphql is used for schema design and reference, and should never be used for implementation
Build the subgraph within that folder. Feel free to use the reference subgraph as a reference.
Submit a pull request to this repo after you are done

Start with understanding the protocol and how it works
Go over the smart contracts. Identify the ones that we need to pull data from
- Usually each protocol has a factory contract that's responsible for tracking other contracts (e.g. Uniswap's Factory contract, Aave's Lending Pool Registry, Yearn's Registry)
- Also a pool/vault contract that's responsible for pool level bookkeeping and transactions (e.g. Uniswap's Pair contract, Yearn's Vault contract, Aave's Lending Pool contract)
Go over the schema and think about what data are needed from smart contract events/calls to map to the fields in each entity
- It's easiest to start with more granular entities and build up to aggregated data
- For example, usually it's easier to start writing mappings for transactions and usage metrics
Go over the documents in the docs folder. That should answer lots of questions you may have
Implement the mappings, deploy and test your data using either Hosted Service or The Graph Studio
Document in the README how important metrics are calculated (TVL, fees, revenue). Feel free to reach out to me if anything isn't clear
Verify your subgraph against other sources and include specific links to these sources in the README. Below are some common sources:
- Project's official analytics dashboard
- DeFi Llama (for TVL)
- Dune Analytics
- TokenTerminal

Building ambitious subgraphs (Part I): https://www.youtube.com/watch?v=4V2o5YJooOM
- Schema design
- Error handling
- Interface and union types
Building ambitious subgraphs (Part II) https://www.youtube.com/watch?v=1-8AW-lVfrA
- Performance tips and tricks (for both mappings and queries)
Documentation for the graph-node

🔨 = In progress.
🛠 = Feature complete. Additional testing required.
✅ = Production-ready.