[GUI] New Governance Graphical User Interface #2406

furszy · 2021-05-31T18:56:09Z

Adding visual interface support for the governance system.

Work in conjunction with @Neoperol ☕ who made the wireframes, layouts organization and theme styles.

Implementing the following points:

New governance screen: laying out the network proposals (name, url, votes, status) and the budget distribution (allocated and available) with filtering and sorting capabilities.
New proposal creation wizard making the proposal generation fairly simple with automatic proposal broadcast support.
New proposal voting visual flow, MN controller wallets will be able to vote for proposals using pivx-qt, with multiple MN/s voters selection and change vote capabilities.
Styled for both themes, light and dark.

Demo videos:

1) Proposals view, budget distribution and create proposal wizard.

(Two videos due github's 10mb maximum size restriction)

create_proposals_step_1.mp4

create_proposal_step_2.mp4

2) Proposal voting flow:

proposal_voting_flow.mp4

3) Proposals grid view responsiveness.

proposal_grid_responsiveness.mp4

Important note:

This work is still in-progress, wording and visuals can change a bit moving on :), and there are some issues that i'm currently working on.
Plus, the backend tier two synchronization process requires improvements that I'm planning to do in another PR.. all of the data forced cleanups + re-synchronizations (budget proposals, votes and MNs) are notorious now that we have visual support for it.

To do:

X- Create Proposal, add autocomplete dropdown for the address field.
Add tooltip for proposal card status, disabled mn voter, forum URL copy.
Complete dark theme. missing checkbox disabled icon and fix for proposal card status border, mnselection list, among others (double check prototype).
Fix DAO nav icon location.
Add "sync not finished, proposal and budget data may be outdated".
Budget signal to trigger visual refresh (currently only refreshing in the screen's show event).
Lay out and connect proposals sort action.
Create proposal, validate name and url max length.
Continue testing..

random-zebra

I like this very much.
Awesome job 🍻

Left some first impressions going through the code, will do more accurate reviewing/testing later.

One general point of discussion would be to remove the dependence of GovernanceModel on WalletModel (ofc for the future, as no-wallet builds are broken atm).
The proposal-creation could be its own module, depending on GovernanceModel and WalletModel, which would be disabled when the wallet support is not compiled (and, for example,. the "Create Proposal" button would be hidden).

Ideally a node built without wallet would not be able to create new proposals (as it couldn't send the fee tx), but should still be able to inspect the existing budgets.

src/qt/pivx/governancemodel.cpp

src/qt/pivx/governancemodel.h

src/qt/pivx/governancewidget.cpp

random-zebra · 2021-07-26T14:44:55Z

src/operationresult.h

@@ -19,6 +19,7 @@ class OperationResult
    OperationResult(bool _res) : m_res(_res) { }

    std::string getError() const { return (m_error ? *m_error : ""); }
+    bool getRes() const { return m_res; }


(b6b638d)

Nit: As already discussed in #2453, we can remove getRes() and just explicitly cast to bool.

src/qt/pivx/governancemodel.cpp

random-zebra · 2021-07-26T16:58:38Z

src/rpc/budget.cpp

+                pwallet->GetKey(mnKeyID, mnKey);
+            }
+            if (mnKey.IsValid()) {


(b6dbb02)

Better to check the return value of GetKey directly, rather than ignoring it and then checking if the key is valid.

Also, this loops over ALL masternodes in the list (if no filter is given) to see whther we have any of the voting keys... probably keeping the lock outside the loop (as it was) is better, performance-wise, than thousands of LOCK/UNLOCK operations for a single function call.

better to improve this in another focused PR and remove the for-loop entirely. The node/wallet can know and maintain an indicator and/or a cached list of the enabled DMNs for which it can vote for.

Sure, but in the meantime we can (and imo should) keep it as it was: LOCK outside of the loop, and return value of GetKey checked.

src/rpc/budget.cpp

src/budget/budgetproposal.h

src/qt/pivx/forms/createproposaldialog.ui

furszy · 2021-08-01T16:19:33Z

great that you liked it zebra 😄, lot of work 🍺 .
Will be working on all the comments and rebasing this work 👍 .

ambassador000 · 2021-08-04T14:22:43Z

Some new feedback on this PR:

(1)
When typing Amount bigger than the maximum possible amount, box is Red, but it still allows user to proceed with the NEXT button:

However, when trying to press NEXT button afterwards, it will show an error that the amount is too high.
Suggestion: NEXT button should not be accepted in the first place if the amount entered in the box is too high.

(2)
ENTER button is not working when trying to go NEXT using the keyboard instead of the mouse click.

(3)
There is some visual inconsistency around the button in the last step of the proposal creation (another smaller box within the NEXT button box):

(4)
I think I saw a commit to fix this earlier, but cannot find it anymore. This is still being showed during the sync process, which would look ugly on mainnet especially when sync is fast.

(5)
It is better now because there is a limit in title length, but if you type proposal name such as "-/-0'90'00909''0--*-", it will not recognize some signs as a letters and again it will allow the too long proposal name to pass, which crashes the wallet again:

NOTE: Crash is bad enough so that it corrupts the wallet.dat file so users would lose funds if they don't have earlier backup of their wallet.dat file. Also, wallet cannot be started again without deleting the wallet.dat file or using the non-corrupted one:

Another NOTE: Unfortunately, I don't have MNs on testnet to be able to test voting on the proposals, but proposals were created and live for the next 6 cycles if someone wants to vote and give it a try.

(6)
There is something wrong with the NEXT and BACK buttons code, because after the Error shows up and you still click NEXT multiple times, it gets "stuck" and you BACK button is not accepted anymore (sometimes it does get accepted after clicking 5-10 times after few seconds), so user have to click X button in the top right corner and start with the proposal creation process all over again.

For example: If user has only 1 UTXO of 1000 PIVs for example, creates 1 proposal which deducts 50 PIV but makes the user's available balance at 0 (because the entire wallet's balance is in unconfirmed state), if user tries to create new proposal, he will get an Error that there is not enough funds or similar. However, after waiting the couple minutes (few block confirmations) and the amount gets available again, user will NOT be able to click the SEND button and proceed with the proposal creation although there are enough funds now, so he will need to press X and go with the proposal creation process all over again.

(7)
Take this bug report with a grain of salt, but I think that's the issue or bug as well. After I crashed the wallet.dat file in the issue 5 mentioned above, I deleted the wallet.dat file and everything in the wallets folder in the data directory (including database, .walletlock, etc.). After that, I started the PIVX Core again, and after it synced 100%, it shows the proposal that I created from the PREVIOUS corrupted wallet.dat file that got deleted and it is not used anymore! (fresh wallet.dat file was created after opening the PIVX Core after crash):

(8)
I think we discussed this few months back already, but just reporting again that 2 proposals with the same names, amounts and URLs are allowed to be created:

(9)
User is allowed to type the incorrect URL as long as "https://" or "http://" is mentioned, even if URL is entered with spaces and without dot (.) anywhere:

Will give it another testing round after few more days.

ambassador000 · 2021-08-04T14:33:42Z

Same thing applies to URL length and special characters used:

If user has a DAO tab opened in the wallet while wallet is syncing after being turned on, listed proposals are being updated only if user is changing tabs, for example from DAO to CONTACTS and back to DAO. Although proposals are not something that changes too often, but maybe it would be cool if the DAO tab refreshes automatically every few minutes without needing to switch tabs, for those that are addicted to following the MNO yes and no votes for each and every proposal in real time (not actually in real time, but every minute or few minutes depending on the code if it can be done).

Fuzzbawls

Lots to dive into here, overall a great addition and presentation! Without duplicating @NoobieDev12 's feedback, i've restricted my comments mostly to translation issues and commenting on previous feedbacks. There is one bug that i commented on WRT to allocated/available amount being displayed in the UI.

Note: generally speaking, unless a particular UI element's name isn't self-descriptive enough, any text value set in the .ui file that is always going to be programmatically set in the .cpp file would be better to just use the generic <string notr="true">N/A</string> line in the .ui file

src/qt/pivx/forms/createproposaldialog.ui

src/qt/pivx/proposalcard.cpp

src/qt/pivx/votedialog.cpp

src/qt/walletmodel.cpp

src/qt/pivx/proposalcard.cpp

Plus fixed several warnings for QT duplicate widget container names.

…tion call. * Connect governanceModel stop(). * And not update next superblock height visually until the wallet passed IBD.

Plus whitespace styling corrections.

…ow::getAmountValue()`.

…) function.

This fixes a conversion issue for the QString::toInt() previous usage.

And don't try to create a proposal if the wallet has not enough balance to pay for the proposal fee.

…ing to not overlap.

…ombo-boxes view initialization.

…'t been cleared from the backend yet.

…imum vote update time.

… selection dialog.

… to vote until the minimum vote time passes.

Fuzzbawls

ACK fccb4cc

Lets get this merged sooner rather than later so translation source strings can be updated. any further functional or stylistic changes can be done in smaller follow-up PRs.

random-zebra

ACK fccb4cc

Just few minor things that could also be tackled in a follow-up PR.

src/qt/pivx/governancemodel.cpp

random-zebra · 2021-11-02T15:17:50Z

src/qt/pivx/governancemodel.cpp

+            CBudgetProposal proposal;
+            ss >> proposal;
+            if (!g_budgetman.HaveProposal(proposal.GetHash()) &&
+                proposal.GetBlockStart() < clientModel->getNumBlocks()) {


(c952196)

Suggested change

proposal.GetBlockStart() < clientModel->getNumBlocks()) {

proposal.GetBlockStart() > clientModel->getNumBlocks()) {

great catch 👍

random-zebra · 2021-11-03T16:19:01Z

src/qt/pivx/governancemodel.h

+    enum VoteDirection {
+        ABSTAIN=0,
+        YES=1,
+        NO=2
+    };


why are we duplicating this enum in the VoteInfo struct, instead of using CBudgetVote::VoteDirection directly?
It would be easier to maintain.

the goal was to continue preparing the ground for the removal of the backend objects/functions dependencies on the GUI elements, to only have them in the cpp of the interface layer.

If I would had added CBudgetVote::VoteDirection here, as it's a header file, then every GUI element that has the governancemodel.h dependency, will have access to budgetvote.h, univalue.h and to the transaction.h primitive for example.

will think on a different way to remove the duplication and not end up having all this unneeded dependencies.

furszy · 2021-11-04T15:59:10Z

k great.
Only minor things, will merge it so we can start the strings translations process and tackle them in follow-up PR.

…ock has not passed yet c33f0e5 Bugfix GUI: proposal broadcast should be scheduled only if the block start has not passed yet (furszy) Pull request description: Small follow-up to #2406, solving zebra's comment: #2406 (comment). Fixing the not schedule of waiting proposals for broadcast at startup. Which caused that if the wallet was restarted in the middle of the broadcast process, the waiting proposals will not enter in the broadcast queue. ACKs for top commit: random-zebra: utACK c33f0e5 Fuzzbawls: utACK c33f0e5 Tree-SHA512: d0fd17276c24971571385828001a9cf95cfcf6e472b4e0dce0dcc054e2e633856833ebd39d0058fa81e5d7482483b7f04d163df1aec474c53f30ac8ff7cf564d

furszy self-assigned this Jun 1, 2021

furszy added the GUI label Jun 1, 2021

furszy added this to the 6.0.0 milestone Jun 1, 2021

furszy force-pushed the 2021_GUI_governance branch 5 times, most recently from 92d40df to 1e1e808 Compare June 1, 2021 20:15

furszy force-pushed the 2021_GUI_governance branch 2 times, most recently from 4302a99 to fc81411 Compare June 14, 2021 18:01

furszy force-pushed the 2021_GUI_governance branch 2 times, most recently from cc607ce to a3e5946 Compare June 28, 2021 19:16

furszy force-pushed the 2021_GUI_governance branch 4 times, most recently from 4fa167d to b0f17dc Compare July 7, 2021 14:20

furszy changed the title ~~[WIP][GUI] New Governance Graphical User Interface~~ [GUI] New Governance Graphical User Interface Jul 12, 2021

furszy force-pushed the 2021_GUI_governance branch 3 times, most recently from d981abc to bf6adc6 Compare July 22, 2021 14:03

furszy force-pushed the 2021_GUI_governance branch 2 times, most recently from a88662e to d60b8dc Compare July 25, 2021 21:01

random-zebra reviewed Jul 26, 2021

View reviewed changes

furszy force-pushed the 2021_GUI_governance branch 3 times, most recently from 4dbad6a to deb8f3d Compare August 4, 2021 00:27

Fuzzbawls reviewed Aug 7, 2021

View reviewed changes

furszy added 21 commits October 23, 2021 18:46

GUI: Create proposal dialog, implement months input field spinbox.

33b1b87

Plus fixed several warnings for QT duplicate widget container names.

GUI: Add cs_proposals mutex lock in governancemodel FindProposal func…

37f7118

…tion call. * Connect governanceModel stop(). * And not update next superblock height visually until the wallet passed IBD.

GUI: Reset governance total allocated amount

bf99df9

GUI: Add sync warning for governance screen.

cb73091

GUI: accept only UTF-8 valid proposal names.

87beffe

GUI: Stop translating test strings in the .ui forms.

427913e

Plus whitespace styling corrections.

GUI: refactor GUIUtil::parseValue() to be used equally as `SendMultiR…

2b11018

…ow::getAmountValue()`.

Connect PROPOSAL_MIN_AMOUNT constant to gov model validatePropAmount(…

b8f0ac6

…) function.

GUI create proposal: unify amount parsing using GUIUtil::parseValue().

51d799b

This fixes a conversion issue for the QString::toInt() previous usage.

GUI: request unlock wallet before try to create a proposal

e264153

And don't try to create a proposal if the wallet has not enough balance to pay for the proposal fee.

GUI: Adjust proposal card months label text and the status label padd…

889a720

…ing to not overlap.

GUI: governance widget, Add translations and generalize sort/filter c…

559a095

…ombo-boxes view initialization.

GUI governance: by default, do not show finished proposals that haven…

702db9f

…'t been cleared from the backend yet.

GUI: add proposal card menu.

bc01677

GUI: Check time between MN votes and inform if it didn't pass the min…

6c404df

…imum vote update time.

GUI: Implement and connect proposal information dialog.

162d843

GUI: Create proposal dialog accepting decimal amounts.

759036b

GUI: Create proposal dialog, add key event and show event listeners.

dae3767

GUI: Masternode creation wizard, set max MN name length.

1a4acb2

GUI: Vote for proposal, add previous votes information in the voters'…

36461da

… selection dialog.

GUI: vote for proposal, disable checkbox of MNs that will not be able…

fccb4cc

… to vote until the minimum vote time passes.

furszy force-pushed the 2021_GUI_governance branch from c476899 to fccb4cc Compare October 23, 2021 22:05

Fuzzbawls approved these changes Oct 27, 2021

View reviewed changes

random-zebra approved these changes Nov 4, 2021

View reviewed changes

furszy merged commit b525146 into PIVX-Project:master Nov 4, 2021

furszy mentioned this pull request Nov 4, 2021

[GUI][BugFix] Schedule proposal broadcast only if the block has not passed yet #2626

Merged

random-zebra mentioned this pull request Nov 5, 2021

[GUI] Correct proposal large title for being cut when the app window width isn't big enough #2627

Merged

random-zebra mentioned this pull request Nov 18, 2021

In-Wallet Proposal Creation Tab #361

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GUI] New Governance Graphical User Interface #2406

[GUI] New Governance Graphical User Interface #2406

furszy commented May 31, 2021 •

edited

Loading

random-zebra left a comment

random-zebra Jul 26, 2021

random-zebra Jul 26, 2021

furszy Aug 3, 2021

random-zebra Aug 4, 2021

furszy commented Aug 1, 2021

ambassador000 commented Aug 4, 2021 •

edited

Loading

ambassador000 commented Aug 4, 2021 •

edited

Loading

Fuzzbawls left a comment

Fuzzbawls left a comment

random-zebra left a comment

random-zebra Nov 2, 2021

furszy Nov 4, 2021

random-zebra Nov 3, 2021

furszy Nov 4, 2021

furszy commented Nov 4, 2021

	proposal.GetBlockStart() < clientModel->getNumBlocks()) {
	proposal.GetBlockStart() > clientModel->getNumBlocks()) {

[GUI] New Governance Graphical User Interface #2406

[GUI] New Governance Graphical User Interface #2406

Conversation

furszy commented May 31, 2021 • edited Loading

Adding visual interface support for the governance system.

Demo videos:

1) Proposals view, budget distribution and create proposal wizard.

2) Proposal voting flow:

3) Proposals grid view responsiveness.

Important note:

To do:

random-zebra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

furszy commented Aug 1, 2021

ambassador000 commented Aug 4, 2021 • edited Loading

ambassador000 commented Aug 4, 2021 • edited Loading

Fuzzbawls left a comment

Choose a reason for hiding this comment

Fuzzbawls left a comment

Choose a reason for hiding this comment

random-zebra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

furszy commented Nov 4, 2021

furszy commented May 31, 2021 •

edited

Loading

ambassador000 commented Aug 4, 2021 •

edited

Loading

ambassador000 commented Aug 4, 2021 •

edited

Loading