wearenewt / rousseau-protocol Goto Github PK

We need to create a status function that given a proposalId will return us the current status in which the proposal is and an enum to handle the return.

As the proposal has a uint256 which is the time that it was created by using the global variables we can see in which phase the proposal is:
If block.timestamp - proposal creation time < start vote time then phase = not started yet

After this "time checks" we will check if a vote period is over and we will use an internal function to reach the quorum to see if the function needs to be executed. In the case that the quorum is not reached we will return "Completed" otherwise we should return something like "Queue" or "Pending"

We need to know if a user already has voted on a certain proposal to avoid double votes!

We need an execution function that will check the proposal status function. If it's on pending execution (Queued/Pending check the enum) you will need to run the update internal function and change the status to Executed (you will need to modify the status function and probably add an execution flag)

Scope

• Add the add value modal so users can create a value and integrate it into the values list page
• prepare the transaction to write to the chain
• handle errors and mock the response in the client

Scope

• prepare the propose change dialog when the user clicks propose change.
• pull in all the data and prepare payload for transaction on change
• handle errors and mock the response in the client
• show a loading state when tx is processing

Create global parameters that will be set on the constructor:

• eligibility of voters (set NFT collection)
• proposal period (in hours)
• voting period (in hours)
• quorum ( collaboration with the quorum feature issue required)

We need to create a quorum system to decide if a proposal needs to be executed or not, keeping in mind that the eligibility for a vote is owning an NFT it should probably be a % of the active NFT's. Add onlyOwner functions to change the quorum settings.

Check here for more information about the NFT Collection and isActive() #1

We need to create the data structure for storing proposals. One proposal should have the following properties:

• Value (string)
• Number of votes (mapping enum votetype -> uint256 number of votes)
• Proposal start (uint256), it will be the block.timestamp

• Create the testnet script to deploy all the contracts of the system onto goerli test net.

NFT collection that has an isActive() check (like ENS registry check for resolution). Basically we need to be able to track the "active" owners of the NFT because there can be NFT holders that won't have rights to vote.

Either NFT minted individually (merkle drop) or sent from one minter address.

We don't have info on the metadata, exact needed features for the NFT yet. Maybe soulbound?

I recommend using solmate https://github.com/transmissions11/solmate

At this stage we should have the data structure for a proposal, an enum with the vote types and a ERC721 with a public function called isEligible and a bunch of internal functions to help you do this task. You need to create a propose function that will just create a proposal data structure and save it, you will need to check that no active proposal exists for that array position that the sender is trying to replace (you can create an internal function to do this check for you). You will also need to create the voting function which will just count the votes inside of the proposal datastructure, get in touch with the "Create voting tracking" issue for a validation if somebody has voted.

CRUD functions:

addProposal() method

• call & pass new string (e.g., ‘always be shipping’)
• enter voting period of pre-determined X hours
• voters vote yes/no/abstain
• if quorum reached, then decision made
• if quorum not reached, then automatic no

removeProposal()

• call & pass uint index of the value to remove (9 ⇒ ‘one release at a time’)
• enter voting period to remove of pre-determined X hours
• voters vote yes/no/abstain (to remove)
• if quorum reached, then decision made
• if quorum not reached, then automatic no remove (status quo)

replaceProposal()

• call & pass uint index of the value to remove
• also pass new string (e.g., ‘some ghosts left behind’)
• enter voting period of pre-determined X hours
• voters vote yes/no/abstain
• if quorum reached, then decision made
• if quorum not reached, then automatic no