Version 1 plan - Githubissues

davekaj commented 5 years ago

Requirements

See: Crypto Projects Registry document in notion

See: Crypto Projects Registry document in notion

More or less this is also explained in See: Crypto Projects Registry document in notion

However, I will add:

Solium and prettier are used for linting
The contracts are based of https://github.com/skmgoldin/tcr , but changed heavily due to the requirements. It is mostly simplified
We are using erc725, as implemented here https://github.com/ERC725Alliance/erc725/tree/master/contracts/contracts
Truffle, Ethers, and OpenZeppelin contracts and test helpers are used.
Bonding curve is still being decided upon
Upgradeability will follow the upgradeability patterns outlined by Open Zeppelin

None planned for now. When the app is actually released we might need some documentation.

Test the bonding curve
Test the voting
Test the registry
Test the parameterization
We might add in static analysis, it depends how long it will take. But it will be valuable for us to learn how to

Get the TCR working as required. This involves:
- TCR voting module working as required
- TCR registrar working as required
- TCR Registry working as required
ERC-725 contracts used as project owners, and are created within the contract, or existing erc725 contracts can be used
Continuous organization chosen
Continuous organization implemented
Bonding curve working as required
Make all contracts upgradeable
Write scripts to populate ganache data
Write the subgraph to track this script data

The estimates below are in days.

updated target - 12 days from Nov 26th = Dec 16th

[x] TCR working
- [x] Voting - 1 .5 day
- [x] Registrar - done
- [x] Registry - done
[ ] ERC-725 - 1 day (EIP 165 too)
[ ] Continuous organization chosen and implemented - 2 days
[ ] Bonding curve - 2 days
[ ] At this point, get brandon and yaniv to review, while in tandem I work on upgradeability and testing
[ ] Make all contracts upgradeable - 2 days
[ ] Full test coverage - 2 days (ADDED IN)
[ ] Write scripts to populate ganache data - 1.5 days
[ ] Write subgraph - 1.5 days

Maybe tasks (Total would be 14.5 days)

[ ] Audit contracts - external task
[ ] Static analysis - 3 days
[ ] Implement a solution for appoveAndCall() so users don't need to start off doing two txs

[ ] TBD. I would say that there may not even be a V2. I think we can get there all the way with V1. The only thing would be after implementing it, we notice some things we want to change, and then do so.

pcowgill commented 5 years ago

@davekaj Thanks for the update! Happy to help with hacking on this if needed - I'm comfortable with that set of tools.

I'll track progress in this repo so we can get the contracts and subgraph wired up with the front end when they're ready https://github.com/metacartel/everest-web-app

davekaj commented 5 years ago

Thanks @pcowgill !

I am still wrapping my head around the project as a whole, and the design is still in flux, so when things are more stable I may reach out for help!