graphprotocol / graphprotocol/graph-network-subgraph

TODOS for organization, improvements, processes and documentation

Open
#81 2 comments 0 reactions 2 assignees View on GitHub

@davekay100 is already working on this.

Since Jan 13, 2021.

Dominant language
TypeScript
Stars
82
Forks
47
PR merge metrics
No merged PRs in 30d

Description

Organization

  • Remove all fields that are not implemented, or label them NOT IMPLEMENTED
  • Clean up the schema
  • Clean up all the mappings and other files

Improvements to the Subgraph

  • Add in the proxy implementation code (it is commented out and now working)
  • Add a field that shows total delegation fees paid by a delegator, all time
  • Renaming of fields
    • totalStaked on Delegators should really be called totalDelegated
  • Rename all fields and names from signalled to signaled
  • Add collected GRT to the epoch, to go alongside rebate amount
  • Move GRT and transfers out of the main subgraph (some discussion still needed here)
  • Implement GRT in USD and ETH by querying the uniswap subgraph (you could argue this should be in the GRT balances subgraph, as it would cause a ton of txs as well
  • Load AND CREATE all entities by default to avoid future bugs
  • Remove lastRunEpoch

Process improvements

  • Start following standard Graph QL api upgrading procedures
  • Look into hiding deprecated fields in Graph QL
  • Figure out the best way to set up a hook or github action for the subgraph
  • Develop an updating process:
    • Changelog
    • Release versions (on github, no need for NPM right now)
    • For Versions, have the subgraph ID in a file in the code, automatically updated
    • Consider doing monthly updates, and running a dev subgraph and a prod subgraph
  • Linting on push

Documentation for the subgraph

  • Explain parts per million
  • Deep explanation on subgraphs vs. subgraph deployments (might be able to dig up docs on notion)
  • Explain CURRENT and cumulative
  • Explain GRT values are all 10^18
  • Explain how network issuance rate works ( 1.000000012184945188^(3656060*24/13) )
  • Explain subgraph metadata for semantic versioning
  • Document all mappings
  • See if we can autogen docs from the schema
  • See if we can autogen docs from the event signatures

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.