Job Story
HOPR has deployed several subgraphs for applications (e.g. network analytics dashboard, staking program website, DAO voting) to consume relevant on-chain data. Despite its wide use, none of them is documented on https://docs.hoprnet.org. We look for bounty hunters to complete this void.
Thanks Graph advocate Paul for proactively extending their hand on this task, from which this bounty is inspired.
Description
Currently 4 subgraphs are in use. Therefore, the scope is to document the following 4 subgraphs. Their subgraph mainnet deployments and source code are listed below.
| Name | Deployment | Source code |
|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| HOPR channels (monte_rosa release) | Feg6Jero3aQzesVYuqk253NNLyNAZZppbDPKFYEGJ1Hj | hopr-community/subgraph-channels |
| HOPR stake season 6 | C7cu6NvvMxgjdaK9pKSGezZ3EgRCmM4tWrmTtGUDG15t | hopr-devrel/subgraph-stake-s6 |
| HOPR token (mainnet) | 5GJcMEW1uKvE9CRddN6yg8qbPnsGuB5dg4wA1UTEQv5W | hopr-community/subgraph-hopr-token |
| HOPR token (gnosis) | njToE7kpetd3P9sJdYQPSq6yQjBs7w9DahQpBj6WAoD | hopr-devrel/hopr-on-gnosis |
A new section under hoprnet/hoprnet/docs/hopr-documentation/docs/developers should be created for subgraph docs.
For each subgraph,
- General description
- Contract addresses that the subgraph indexes
- Links to playground, source code, query endpoints (Here is an example)
- Full documentation on entities
- Sample queries that gives some interesting info, with link to its respective sample query in GraphQL explorer. should be included.
There is a good example of the subgraph documentation. Our community member paulieb.eth has listed their subgraph documentation work. Those examples generally reflect our expectation on the submission.
<!-- ### Submission Deadline Add submission deadline if applicable: - If the bounty must be completed before specific date, expiry date must be included. -->Definition of Done
- [ ] Create a new section "Subgraph Documentation" under "developers"
- [ ] Create subpages for each subgraph, which provides information listed in the description
- [ ] The new documentation website is successfully deployed in preview
How to submit
- Create a pull request to the hoprnet repository mentioning this github issue
What is HOPR?
Find out more about HOPR at the following links:
This bounty is part of The Bounty Program