TODOS for organization, improvements, processes and documentation

[davekay100]

Organization

• [x] Remove all fields that are not implemented, or label them NOT IMPLEMENTED
• [x] 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

• [x] Start following standard Graph QL api upgrading procedures
• [x] 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

• [x] Explain parts per million
• [x] Deep explanation on subgraphs vs. subgraph deployments (might be able to dig up docs on notion)
• [x] Explain CURRENT and cumulative
• [x] Explain GRT values are all 10^18
• [x] Explain how network issuance rate works ( 1.000000012184945188^(3656060*24/13) )
• [x] 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

[fordN]

Solid list!

@davekaj I can help out with setting up a github workflow for continuous integration next week.

[juanmardefago]

This got kinda forgotten amongst the work for the July launch, but we could revisit a few things, and maybe add a few new bullet points like brainstorming ways of splitting the subgraph for better indexing performance (extracting the ERC20 tracking from the core subgraph, dividing subgraph per linked roles, etc)