poanetwork / poa-dapps-voting

POA Network Governance Dapp

POA Network Governance Dapp

Base supported networks

• Core POA network (RPC endpoint: https://core.poa.network)
• Sokol testnet (RPC endpoint: https://sokol.poa.network)
• Kovan testnet (RPC endpoint: https://kovan.infura.io/)

Supported browsers

• Google Chrome v 59.0.3071.115+

MetaMask/Nifty Wallet extensions setup

• Connect to POA Network in MetaMask extension (See POA Network on MetaMask) or in Nifty Wallet extension (See POA Network on Nifty Wallet) and import your voting key.

Governance Dapp overview

Please check related posts in wiki Governance Overview and Ballots life cycle

Configuration

Governance DApp is configured with POA Network governance contracts

There are contracts' addresses for Sokol, Core, and Kovan.

Building from source

1. npm i

2. npm start

poa-dapps-voting's Issues

Updating of validator's info with payout key changing

(Feature) Validation for creation of ballots in new design

Problem: we need validation for form on ballots' creation page
Solution: add validation

When click "Yes" button to vote it doesn't vote

According to the console log,
it looks like it doesn't properly translate "Yes" to correct number:
https://github.com/poanetwork/poa-dapps-voting/blob/core/src/contracts/VotingToChangeKeys.contract.js#L20
When I investigated the above method here are params that were passed:

vote 0 0 0x4471974679e4c956f379bd6761b62e65c169a83a

while Yes should be translated to 1, not 0

https://github.com/poanetwork/poa-network-consensus-contracts/blob/master/contracts/VotingToChangeKeys.sol#L13
According to our smart contract,
0 means Invalid
1 means accepted
2 means Rejected

UI - Ballot Contract Design

I was thinking - in order to help drill through the intended logic -

Add Key, Remove Key, Sway Key radio buttons are removed and replaced with a drop down. This would save space.

Then below this, remove the 'col' with the: mining key, payout key, voting key - and instead have another drop down.

This would have the effect of forcing a logical progression: Management Function -> Key Type

(Fix) Error message is not friendly

Problem:
When I opened dapp I see error message which is not friendly

Solution:
add a human-readable error message

Support for new BallotType: AddValidator or OnBoard Validator Ballot which takes (3) keys

Currently, to add/onboard a Validator using Governance. (3) Ballots are required, 1 for each key ( mining, voting, payout ). There is some questions whether these ballots can be done concurrently or if the mining key needs to be added first.

There is now a 48 hour minimum for a Ballot so would take a minimum of 4 days to fully onboard a Validator.

I propose a single Ballot that support specifying the (3) keys in a single Ballot ( i.e. Add Validator or OnBoard Validator Ballot ).

There has been some discussion of decoupling the process these keys are added some, but my feeling is that to be a fully-qualified Validator you need all (3) keys so think best to keep them together. This would reduce the onboarding of a Validator to 48 hours and mitigate risk of decoupling the process.

Doesn't work

1. Don't navigate to the next screen as if I were proposing a new" miner creation if I selected a ballot to REMOVE key
   Please also have some explanations for each field, what they mean and how to use it. (mining key, affected key, etc.)

2. When I created a ballot, I should be automatically voted (doesn't work now)

3. For some reason I had 20 rows of proposals when I created a ballot

4. I was able to vote NO for proposal.

5. I was able to vote YES for proposal

6. UI - please change Button's fields from VOTE TO Yes/No (or better names)

7. Please change YES to the right and No to the left. ( I believe that's how it's being used in most UI popups)

8. Let the creator choose EXPIRATION DATE for ballot

(Bug) When adding new miner, have dropdown show as new miner which will be 0x0000 address

(Feature) View list of ballots' cards in new design

Problem: we need to get information about ballots to list it in voting dApp
Solution: get all fields for ballots from voting contracts

Use UTC time for setting end Ballot time

Done in #88

(Bug) Show start time if ballot is not started yet

Check tx status after ballot is created

if status is 0x0 don't show successful message

(Fix) replace header & footer for dapps

Problem:
dapps use logo of Oracles Network (header and footer) and network renamed to POA Network
Solution:
replace logos in all dapps
https://www.dropbox.com/home/block_notary/oracles/dapps_logo

(Fix) Replace repo name from oracles-dapps-voting

Replace to poa-dapps-voting

(UI) 48 hours window alert

Relates to poanetwork/poa-network-consensus-contracts#41
Add check to validation, that (endTime - startTime) > 48 hours

(Fix) prepare 2 branches: core and sokol

Problem: repository should have 2 branches: for core network and sokol test network. dApp should be deployed to github pages from core network branch
Solution: create 2 branches: core and sokol and deploy dApp from core branch to github pages.

(Feature) Creation of all types of ballots in new design

Problem: we need page for creation of all types of ballots in new design
Solution: create such page

(Fix) Lorem Ipsum should be replaced

Problem:
Lorem ipsum descriptions are made for design purposes not to use in production
Solution:
Replace lorem ipusm with meaningful text. Please check grammar on grammarly.com before committing

UX - Error Trapping - Max Time

Perhaps limit the max time that a ballot contract may be open to X (whatever X is deemed ok). This would limit the potential for ballots that never resolve or resolve over long periods of time.

I would suggest 14 calendar days as the upper boundary for this.

(Fix) change title of DApp

As proposed here: https://github.com/poanetwork/poa-dapps-voting/pull/31/files/ab1761adf93cfd81c999fb66f1ec9a9ef8567e83#r158846016

(Fix) Add ability to autocomplete address with react-places-autocomplete

Problem: Address, postal code, US state is filled in manually
Solution: Add address autocomplete with react-places-autocomplete

(Fix) Actualize social links

Problem: Social links are empty in new design
Solution: Update social links

Get rid of sokol branch. Provide Dynamic Loading of addresses based on Metamask netId

(UI) time should be in US format

(Feature) Vote for ballots in new design

Problem: Vote functionality is absent in new design
Solution: Add vote functionality

(Refactor) Has to be 1 card with inherited props

There is a lot of duplication of code right now. We need to clean it up

(UI) Add miners' information

When ballot for keys,
We have to see which miner's key the ballot is about

(Fix) give the ability to choose a time for ballot's end time

Problem: User can only choose a date for ballot's end time field.
Solution: Give the ability to choose a time for ballot's end time too

(UI) indicate if you already voted for the ballot visually

Swap type creates incorrect ballot type: Add

When I select Swap key ballot type, it should create ballotType = 3
Actual Result:
it creates as Ballot type add, ballotType = 1

(Fix) invalid title for dApp

Problem: invalid title for voting dApp https://github.com/poanetwork/poa-dapps-voting/blob/core/public/index.html#L22

Solution: change to actual one: PoA governance dApp

(Error handling) explain why validator cannot vote if the ballot is not active yet

(Fix) actualize README for new version of dApp

Problem: README is outdated
Solution: update README

(Feature) Add filter for active ballots

Problem: filter is absent in new design
Solution: add filter to the top-left corner of navigation bar.

how to finish ballot?

@vbaranov

(Feature) add search on ballots content in new design

Problem: Search is absent in new design
Solution: Add search input at the right-top of dApp navigation panel

Warning in JS console

Something is not being rendered properly:

index.js:2177 Warning: Cannot update during an existing state transition (such as within `render` or another component's constructor). Render methods should be a pure function of props and state; constructor side-effects are an anti-pattern, but can be moved to `componentWillMount`.

Needs further investigation

web3.js is loaded twice

According to the logs, it looks like it is loaded twice:

Injected web3 detected.
getWeb3.js:17 netId 99
getWeb3.js:21 This is Core 99
getWeb3.js:17 netId 99
getWeb3.js:21 This is Core 99

Ballots UI -- Need BALLOT MEMO or DESCRIPTION other observations/suggestions

Need MEMO or BALLOT DESCRIPTION so know what we are voting on.

-NAME suggest PROPOSER
-PROXY BALLOT ID suggest BALLOT ID
-Unnecessary text ("Finalization is available after ballot time is finished ") when Ballot is already Finalized
-TIME suggest BALLOT TIME
-Add STATUS column
-Does search work? and/or add filtering
-Sort order by BALLOT ID descending, i.e. most recent ballots first.

In general, inefficient use of space ... perhaps move towards summary -> detail ( drill down ) model.
I will try to provide mock up to describe what I mean.

(Feature) Notifications on new ballots

Problem:

validators don't get notifications on new ballots. It may problems in governance where a malicious group of three or more validators will create series of proposals to remove other validators from consensus.

Possible solutions:

Server side or client/cloud side. I propose to implement the feature on client side first, with a combination of UI changes and hooks on deployment side.

• web push notifications. https://developers.google.com/web/fundamentals/push-notifications/ https://www.netlify.com/blog/2017/10/31/service-workers-explained/
  Flow:
  • all validators subscribe to notifications on the webpage
  • a validator creates a ballot
  • all subscribed validators receive a chrome notification
• email notifications.
  For deployment, we use Netlify and can reuse Form handling feature which sends filled forms to email.
  https://www.netlify.com/docs/form-handling/
  We should have separate form handlers for Core and Sokol networks.

Risks:

• A malicious validator can deploy dapp code locally and prevent from
  Mitigation: server-side ethereum event listener, subscribed to governance dapps

• A malicious validator can prevent form submission. This risk we will mitigate in future server side version of notification service which will subscribe to events
  Mitigation: server-side ethereum event listener, subscribed to governance dapps

With server-side deployment, we have new types of risks:

• a compromised server
• malicious devops

(UI) show if ballot is finalized

(Testing) Write end to end tests

Test cases:

1. Add new validator - reach threshold
2. Ballot to change consensus
3. Ballot to change proxy contract

(UI - error handling) show current loaded key in metamask if voting key is invalid

UI - Sokol Vs. Mainnet Web Banners

I was at: https://sokol-validators.poa.network/poa-dapps-validators/set

And noticed that the banner graphic, which made me think I was interacting on the POA Network (or mainnet) - even though that I could see per the URL that I was on Sokol.

This is minor - but maybe have a different graphics asset for pages that are Sokol showing. To min potential confusion:

Affected key together with mining key for ballots

As voting dapp should be only single instrument to add/change/remove production keys, there is suggestion to add an affected key (it could be mining, voting or payout key) together with a mining key (to store this pair in the Oracles contract) of affected notary to a ballot.

(UI) run `areBallotParamsValid` smart contract function before creating ballot

(Feature) Finalize ballots

Problem: Finalize ballots functionality is missing
Solution: Add finalization button functionality to new version of dApp

(Design UI) Need different style for inactive ballots

Right now we have the following picture:

Old ballots first, new ballots to the bottom

@igorbarinov need your call on that...
I believe we should style old ballots differently and display new ones on the top

Move personal data to 2nd screen

Personal data is needed, if Add action is chosen and affected key = mining key. The suggestion is to move personal data to second screen and open it only for adding of new mining key.

(Bug) When there are 3 types of ballots are created, loading hangs