This repo contains subgraphs defined using a set of standardized schemas. These subgraphs are used to extract raw blockchain data and transform them into meaningful metrics, for products and analytics. Our goal is to build a subgraph for every DeFi protocol in the space.
- Decide which protocol you want to build a subgraph for.
- Fork this repository.
- Add a folder under
subgraphswith 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.graphqlto your folder and rename it toschema.graphql. Noteschema-common.graphqlis 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 PR (pull request) to this repo after you are done. Make sure you submit your PR as a draft if it's a work-in-progress. Include a link to your deployment in your PR description.
- Start with understanding the protocol. An easy start could be interacting with the protocol UI on testnets, check transaction details on Etherscan and pay attention to key events that are emitted.
- 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
docsfolder. 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.
- For metrics calculation (e.g. revenue, fees, TVL), please refer to the
README.mdin the protocol's subgraph folder for methodology. There is also a broader explanation of how different fields are defined in the schema indocs/Schema.md. Feel free to reach out to me if anything isn't clear. - We've built a handy debugging/validation dashboard for you to quickly visualize the data in your subgraph. It's deployed to subgraphs.xyz and the source code is under
dashboardif you want to spin it up locally. - 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
For other contributing guidelines, please refer to Contributing.md
- Learn the basics of GraphQL: https://graphql.org/learn/
- Query subgraphs using GraphQL: https://thegraph.com/docs/en/developer/graphql-api/
- Get familiar with The Graph: https://thegraph.academy/developers/
- Defining a subgraph: https://thegraph.academy/developers/defining-a-subgraph/
- Creating a subgraph: https://thegraph.com/docs/en/developer/create-subgraph-hosted/
- Deploying a subgraph using The Graph Studio: https://thegraph.com/docs/en/studio/deploy-subgraph-studio/
- AssemblyScript API
- Unit Test Using Matchstick
- Building a Subgraph for Sushiswap
- Building a Subgraph for Loopring
- Using templates (dynamic data sources)
- Indexing proxies
- 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
We've moved development status here.