graphprotocol / graphprotocol/contracts
chore: master document containing a log of the TODO comments found in the project files
Nobody has claimed this yet.
- Dominant language
- Solidity
- Stars
- 374
- Forks
- 176
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 4
Description
While reviewing the OZ audit N-04 I found advice to document TODO comments inside our project issues backlog.
I found the following TODO's at commit 4387c6cdc7cf437e75b46d3af3f1d88aa1fdb925
The following TODO's are on .sol files.
- Line 19 of
packages\horizon\contracts\interfaces\internal\IHorizonStakingBase.sol - Line 44 of
packages\horizon\contracts\interfaces\internal\IHorizonStakingExtension.sol - Line 5 of
packages\horizon\contracts\interfaces\internal\IHorizonStakingTypes.sol - Lines 44, 390, 558, 717, 766 of
packages\horizon\contracts\staking\HorizonStaking.sol - Lines 242, 257 of
packages\horizon\contracts\staking\HorizonStakingBase.sol - Lines 25, 92, 105, 119, 219, 229, 240, 254, 310 of
packages\horizon\contracts\staking\HorizonStakingExtension.sol - Line 11 of
packages\horizon\contracts\staking\HorizonStakingStorage.sol - Line 7 of
packages\horizon\contracts\staking\utilities\Managed.sol - Line 59 of
packages\horizon\contracts\utilities\GraphDirectory.sol - Line 64 of
packages\horizon\test\staking\delegation\addToPool.t.sol - Line 104 of
packages\subgraph-service\test\shared\SubgraphServiceShared.t.sol - Line 255 of
packages\subgraph-service\test\subgraphService\SubgraphService.t.sol - Lines 34, 75 of
packages\subgraph-service\test\subgraphService\collect\indexing\indexing.t.sol
The following TODO's are on other files (not .sol).
- Lines 2, 3, 5, 6, 7 of
packages\contracts\config\graph.arbitrum-goerli.yml - Lines 2, 3 of
packages\contracts\config\graph.arbitrum-sepolia.yml - Line 15 of
packages\contracts\tasks\migrate\protocol.ts - Line 39 of
packages\contracts\test\e2e\deployment\config\l2\l2GraphTokenGateway.test.ts - Line 9 of
packages\contracts\test\e2e\upgrades\exponential-rebates\post-upgrade.ts - Line 80 of
packages\contracts\test\unit\lib\gnsUtils.ts - Lines 14, 15 of
packages\sdk\.eslintrc - Line 123 of
packages\sdk\src\deployments\lib\address-book.ts - Line 14 of
packages\sdk\src\deployments\lib\config.ts - Line 3 of
packages\sdk\src\deployments\lib\types\address-book.ts - Line 16 of
packages\sdk\src\deployments\network\deployment\address-book.ts - Lines 101, 117 of
packages\sdk\src\deployments\network\deployment\config.ts - Lines 164, 276, 283, 292 of
packages\sdk\src\deployments\network\deployment\contracts\deploy.ts - Line 238 of
packages\sdk\src\gre\README.md - Line 58 of
packages\token-distribution\deploy\4_l1_transfer_tool.ts - Line 46 of
packages\token-distribution\deploy\6_l2_transfer_tool.ts
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at commit 4387c6c and review the listed TODO locations across the Horizon, subgraph-service, contracts, SDK, and token-distribution packages. Create the requested master backlog document containing those TODO comments and their file locations; completion is a checked-in document covering the identified entries.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- solidity, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100