(Feature) Allow cancellation of a ballot in `VotingToManageEmissionFunds` by its creator for 15 minutes after it's created #168

varasev · 2018-08-15T12:59:49Z

(Mandatory) Description
Solves the issue (Feature) VotingToManageEmissionFunds should allow canceling new ballot by its creator for 15 minutes after it's created #161.
(Mandatory) What is it: (Fix), (Feature), or (Refactor)
(Feature)

wkarshat · 2018-09-09T10:15:43Z

@varasev, perhaps this is the logic you are looking for in _finalize() of VotingToManageEmissionFunds.sol

    uint256 sendVotesCount = _getSendVotes(_id);
    uint256 burnVotesCount = _getBurnVotes(_id);
    uint256 freezeVotesCount = _getFreezeVotes(_id);
    QuorumStates quorumState = QuorumStates.Frozen;
        
    if (sendVotesCount > burnVotesCount)
    {
        if (sendVotesCount > freezeVotesCount)
            quorumState = QuorumStates.Sent;
    } else {
        if (burnVotesCount > sendVotesCount && burnVotesCount > freezeVotesCount)
            quorumState = QuorumStates.Burnt;
    }

However, is that desirable, could say Burn pass with 4:3:3 against Sent and Frozen?

varasev · 2018-09-10T07:38:16Z

@wkarshat Yes, that's a very good simplification, thank you! I merged your code in #181.

wkarshat · 2018-09-10T15:51:04Z

Sure.

What's the expected value, i.e. on Sokol, of:
uint256 validatorsLength = IPoaNetworkConsensus()

Can you help with understand how the section starting line 189 works?
releaseTime = releaseTime.add(releaseThreshold.mul(diff));
I would think you'd increment from CurrentTime and not releaseTime.

varasev · 2018-09-11T06:14:48Z

What's the expected value, i.e. on Sokol, of: uint256 validatorsLength =

There are 25 validators in Sokol for now (including MoC), so validatorsLength will be 24 (excluding MoC), because MoC has no voting rights.

Can you help with understand how the section starting line 189 works?

I'll try to explain it on the picture:

So, we have different timestamps called releaseTime on the timeline. They are separated by emissionReleaseThreshold which is 3 months (as described in poanetwork/RFC#14 (comment)).

Let's assume that the currentTime is 4 July and the current emissionReleaseTime in the smart contract is 1 January. E.g., we didn't create any ballot since 1 January, so emissionReleaseTime was not refreshed so far.

So, now is 4 July and we want to create a new ballot. We should refresh emissionReleaseTime and shift it to 1 July. When we call createBallot function, it will call refreshEmissionReleaseTime automatically.

According to

uint256 diff = currentTime.sub(releaseTime).div(releaseThreshold);

we have

diff = (4 July - 1 January) / 3 months = 2

Therefore

releaseTime = releaseTime.add(releaseThreshold.mul(diff));

will give us

releaseTime = 1 January + (3 months * 2)

i.e.

releaseTime = 1 January + 6 months = 1 July

wkarshat · 2018-09-13T01:22:27Z

So, let me see if I understand the mechanics of this vote, as I could not glean all of it from the code.

Starting on Oct 1st and for seven days thereafter, one of the Validators can introduce this type of a vote, and for 15 minutes after can cancel. Somehow, once this vote has been introduced (and not cancelled) no other Validator can introduce one of this type. Presumably, once cancelled it can be re-introduced. Presumably, once passed, this type of a vote cannot be re-introduced.

The minimum number of votes necessary to pass is 4 (quorum)
Voting has to complete within 7 days (after Oct 1st). BTW, what are the options for the duration, fixed or set by the Validator, within the limits of other vote types, like 48 hours?
The default behavior is Hold, in cases that the Burn or Payout did not win or quorum not achieved or time expired. BTW, I'm not sure I saw a test case for the last one.

In order to pass, Burn or Payout need most votes (more than either one of the other two options, no tie). So, in case of Burn:Pay:Hold votes of 7:6:5, Burn would pass.

varasev · 2018-09-13T07:41:20Z

Starting on Oct 1st and for seven days thereafter, one of the Validators can introduce this type of a vote, and for 15 minutes after can cancel. Somehow, once this vote has been introduced (and not cancelled) no other Validator can introduce one of this type. Presumably, once cancelled it can be re-introduced. Presumably, once passed, this type of a vote cannot be re-introduced.

That's right. Once passed, this type of a vote cannot be re-introduced until the next releaseTime timestamp (in 3 months after Oct 1st) and unless the previous ballot is finalized.

The minimum number of votes necessary to pass is 4 (quorum)

No, for the current set of validators in Sokol (24 persons excluding MoC) the minimum number will be 24 / 2 + 1 = 13.

That's defined here:

poa-network-consensus-contracts/contracts/VotingToManageEmissionFunds.sol

Lines 293 to 295 in 6c2c779

    
           function _getGlobalMinThresholdOfVoters() internal view returns(uint256) { 
        
               return _getBallotsStorage().getProxyThreshold(); 
        
           }

Voting has to complete within 7 days (after Oct 1st).

Yes, 7 days is the maximum period of time when validators can give their votes, so called distribution threshold, as described in poanetwork/RFC#14 (comment)

BTW, what are the options for the duration, fixed or set by the Validator, within the limits of other vote types, like 48 hours?

We have no minimum limit of duration of this type of a ballot assuming that the startTime and endTime timestamps will be calculated automatically and defined by Governance DApp when creating a new ballot. Also, validators might late and create a ballot, for example, on Oct 5th evening, when there are less than 48 hours left to the end of distribution threshold (Oct 7th). However, we could introduce such a minimum limit for this type of a ballot in VotingToManageEmissionFunds smart contract if necessary.

The default behavior is Hold, in cases that the Burn or Payout did not win or quorum not achieved or time expired. BTW, I'm not sure I saw a test case for the last one.

Yes, if time expired and quorum (or majority) not achieved, the finalize function will set frozen state:

poa-network-consensus-contracts/contracts/VotingToManageEmissionFunds.sol

Line 238 in 6c2c779

_setQuorumState(_id, uint256(QuorumStates.Frozen));

and

poa-network-consensus-contracts/contracts/VotingToManageEmissionFunds.sol

Line 258 in 6c2c779

_setQuorumState(_id, uint256(quorumState));

E.g., we have the next unit tests for those cases:

poa-network-consensus-contracts/test/voting_to_manage_emission_funds_test.js

Lines 754 to 812 in 6c2c779

    
           it('freeze funds if it did not pass minimum voters count', async () => { 
        
             await addValidator(votingKey2, miningKey2); 
        
             await addValidator(votingKey3, miningKey3); 
        
             await voting.createBallot( 
        
               VOTING_START_DATE, VOTING_END_DATE, receiver, "memo", {from: votingKey} 
        
             ).should.be.fulfilled; 
        
             (await voting.getMinThresholdOfVoters.call(id)).should.be.bignumber.equal(2); 
        
             await voting.setTime(VOTING_START_DATE); 
        
             await voting.vote(id, choice.burn, {from: votingKey}).should.be.fulfilled; 
        
             await voting.setTime(VOTING_END_DATE + 1); 
        
             await voting.finalize(id, {from: votingKey3}).should.be.fulfilled; 
        
             (await voting.getQuorumState.call(id)).should.be.bignumber.equal(4); 
        
             (await web3.eth.getBalance(emissionFunds.address)).should.be.bignumber.equal(emissionFundsInitBalance); 
        
             emissionFundsInitBalance.should.be.bignumber.above(0); 
        
           }); 
        
           it('freeze funds if there is no majority of 3 votes', async () => { 
        
             await voting.createBallot( 
        
               VOTING_START_DATE, VOTING_END_DATE, receiver, "memo", {from: votingKey} 
        
             ).should.be.fulfilled; 
        
             await addValidator(votingKey2, miningKey2); 
        
             await addValidator(votingKey3, miningKey3); 
        
             await voting.setTime(VOTING_START_DATE); 
        
             await voting.vote(id, choice.send, {from: votingKey}).should.be.fulfilled; 
        
             await voting.vote(id, choice.burn, {from: votingKey2}).should.be.fulfilled; 
        
             await voting.vote(id, choice.freeze, {from: votingKey3}).should.be.fulfilled; 
        
             true.should.be.equal((await voting.getBallotInfo.call(id))[4]); // isFinalized 
        
             (await voting.getQuorumState.call(id)).should.be.bignumber.equal(4); 
        
             (await web3.eth.getBalance(emissionFunds.address)).should.be.bignumber.equal(emissionFundsInitBalance); 
        
             emissionFundsInitBalance.should.be.bignumber.above(0); 
        
           }); 
        
           it('freeze funds if there is no majority of 4 votes', async () => { 
        
             await voting.createBallot( 
        
               VOTING_START_DATE, VOTING_END_DATE, receiver, "memo", {from: votingKey} 
        
             ).should.be.fulfilled; 
        
             await addValidator(votingKey2, miningKey2); 
        
             await addValidator(votingKey3, miningKey3); 
        
             await addValidator(votingKey4, miningKey4); 
        
             await voting.setTime(VOTING_START_DATE); 
        
             await voting.vote(id, choice.send, {from: votingKey}).should.be.fulfilled; 
        
             await voting.vote(id, choice.burn, {from: votingKey2}).should.be.fulfilled; 
        
             await voting.vote(id, choice.send, {from: votingKey3}).should.be.fulfilled; 
        
             await voting.vote(id, choice.burn, {from: votingKey4}).should.be.fulfilled; 
        
             true.should.be.equal((await voting.getBallotInfo.call(id))[4]); // isFinalized 
        
             (await voting.getQuorumState.call(id)).should.be.bignumber.equal(4); 
        
             (await voting.getTotalVoters.call(id)).should.be.bignumber.equal(4); 
        
             (await web3.eth.getBalance(emissionFunds.address)).should.be.bignumber.equal(emissionFundsInitBalance); 
        
             emissionFundsInitBalance.should.be.bignumber.above(0); 
        
           });

In order to pass, Burn or Payout need most votes (more than either one of the other two options, no tie). So, in case of Burn:Pay:Hold votes of 7:6:5, Burn would pass.

Yes, right. A few cases for example:

Burn = 7 (pass, because greater than Pay and Hold)
Pay = 6
Hold = 5

Burn = 6
Pay = 6
Hold = 5 (pass, because of tie for Burn and Pay)

Burn = 6 (pass, because greater than Pay and Hold)
Pay = 5
Hold = 5

Burn = 5
Pay = 6 (pass, because greater than Burn and Hold)
Hold = 5

Burn = 4
Pay = 6 (pass, because greater than Burn and Hold)
Hold = 5

etc.

wkarshat · 2018-09-13T16:49:33Z

At which point does the check for 13 votes kick in, please?

varasev · 2018-09-14T06:29:27Z

It happens on the next line:

poa-network-consensus-contracts/contracts/VotingToManageEmissionFunds.sol

Line 237 in 6c2c779

if (getTotalVoters(_id) < getMinThresholdOfVoters(_id)) {

When we call createBallot function, it calls VotingTo._createBallot:

poa-network-consensus-contracts/contracts/VotingToManageEmissionFunds.sol

Line 86 in 6c2c779

uint256 ballotId = super._createBallot(

which sets MinThresholdOfVoters here:

poa-network-consensus-contracts/contracts/abstracts/VotingTo.sol

Line 149 in 6c2c779

_setMinThresholdOfVoters(ballotId, _getGlobalMinThresholdOfVoters());

It calls VotingToManageEmissionFunds._getGlobalMinThresholdOfVoters function which overrides VotingTo._getGlobalMinThresholdOfVoters.

The code of VotingToManageEmissionFunds._getGlobalMinThresholdOfVoters is:

poa-network-consensus-contracts/contracts/VotingToManageEmissionFunds.sol

Lines 293 to 295 in 6c2c779

    
           function _getGlobalMinThresholdOfVoters() internal view returns(uint256) { 
        
               return _getBallotsStorage().getProxyThreshold(); 
        
           }

I.e., it calls BallotsStorage.getProxyThreshold():

poa-network-consensus-contracts/contracts/BallotsStorage.sol

Lines 131 to 133 in 6c2c779

    
           function getProxyThreshold() public view returns(uint256) { 
        
               return _getTotalNumberOfValidators().div(2).add(1); 
        
           }

wkarshat · 2018-09-16T05:07:53Z

@varasev, thanks hugely for the details. I'm impressed by how the system of smart contracts is layered and hangs together.
So, my understanding is that the smallest number of votes that can win is 5, if the votes are 5:4:4, for a total of 13.

varasev · 2018-09-17T06:57:16Z

@wkarshat

thanks hugely for the details. I'm impressed by how the system of smart contracts is layered and hangs together.

Thank you.

So, my understanding is that the smallest number of votes that can win is 5, if the votes are 5:4:4, for a total of 13.

Yes, right.

shkron · 2018-09-19T21:44:25Z

@varasev, do I understand this correctly, in the scenario like this:

Burn = 12
Pay = 12
Hold = 0 (pass, because of tie for Burn and Pay)

Also could you please provide the definitions for those options.

UPD: also what happens in this case?

Burn = 0
Pay = 12
Hold = 12

6proof · 2018-09-19T21:55:14Z

I think most Validators would expect minimum voting period to be 48 hours (as is case for other ballots). This would seem to be a minimum floor, particularly for subject of this type of ballot, and would hope this minimum would be added.

varasev · 2018-09-20T06:57:51Z

@shkron

do I understand this correctly, in the scenario like this:
Burn = 12
Pay = 12
Hold = 0 (pass, because of tie for Burn and Pay)

Yes, you do, because there is no majority of votes: Burn = Pay, so we can't make a concrete decision.

also what happens in this case?
Burn = 0
Pay = 12
Hold = 12

In this case Hold wins for the same reason as above. Hold always wins in case of no majority.

Also could you please provide the definitions for those options.

You can see conditions here:

poa-network-consensus-contracts/contracts/VotingToManageEmissionFunds.sol

Lines 237 to 256 in 8acbbe1

    
           if (getTotalVoters(_id) < getMinThresholdOfVoters(_id)) { 
        
               _setQuorumState(_id, uint256(QuorumStates.Frozen)); 
        
               _emissionFunds.freezeFunds(amount); 
        
               return; 
        
           } 
        
           uint256 sendVotesCount = _getSendVotes(_id); 
        
           uint256 burnVotesCount = _getBurnVotes(_id); 
        
           uint256 freezeVotesCount = _getFreezeVotes(_id); 
        
           QuorumStates quorumState = QuorumStates.Frozen; 
        
           if (sendVotesCount > burnVotesCount) { 
        
               if (sendVotesCount > freezeVotesCount) { 
        
                   quorumState = QuorumStates.Sent; 
        
               } 
        
           } else { 
        
               if (burnVotesCount > sendVotesCount && burnVotesCount > freezeVotesCount) { 
        
                   quorumState = QuorumStates.Burnt; 
        
               } 
        
           }

varasev · 2018-09-20T07:07:57Z

@6proof ok, the corresponding issue has been opened: #190.

vbaranov · 2018-09-20T14:15:56Z

@varasev maybe, we could create a page in Governance section of wiki repo, that describes every threshold and the process overall? I assume it will be more transparent for everyone.

varasev · 2018-09-20T14:39:23Z

@vbaranov Sure, I'll create one.

varasev · 2018-09-27T12:26:13Z

maybe, we could create a page in Governance section of wiki repo, that describes every threshold and the process overall? I assume it will be more transparent for everyone.

Description of Emission Funds Ballot is now available on Wiki: https://github.com/poanetwork/wiki/wiki/Manage-Emission-Funds

(Feature) Allow cancellation of a ballot in VotingToManageEmissionFunds

58f8694

varasev merged commit 9675136 into poanetwork:security-audit Aug 15, 2018

varasev mentioned this pull request Aug 15, 2018

(Feature) VotingToManageEmissionFunds should allow canceling new ballot by its creator for 15 minutes after it's created #161

Closed

varasev mentioned this pull request Sep 19, 2018

(Feature) Votings to Manage Emission Funds poanetwork/poa-dapps-voting#173

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(Feature) Allow cancellation of a ballot in `VotingToManageEmissionFunds` by its creator for 15 minutes after it's created #168

(Feature) Allow cancellation of a ballot in `VotingToManageEmissionFunds` by its creator for 15 minutes after it's created #168

varasev commented Aug 15, 2018

wkarshat commented Sep 9, 2018

varasev commented Sep 10, 2018

wkarshat commented Sep 10, 2018

varasev commented Sep 11, 2018

wkarshat commented Sep 13, 2018

varasev commented Sep 13, 2018 •

edited

Loading

wkarshat commented Sep 13, 2018

varasev commented Sep 14, 2018

wkarshat commented Sep 16, 2018

varasev commented Sep 17, 2018

shkron commented Sep 19, 2018 •

edited

Loading

6proof commented Sep 19, 2018

varasev commented Sep 20, 2018

varasev commented Sep 20, 2018

vbaranov commented Sep 20, 2018

varasev commented Sep 20, 2018

varasev commented Sep 27, 2018

(Feature) Allow cancellation of a ballot in VotingToManageEmissionFunds by its creator for 15 minutes after it's created #168

(Feature) Allow cancellation of a ballot in VotingToManageEmissionFunds by its creator for 15 minutes after it's created #168

Conversation

varasev commented Aug 15, 2018

wkarshat commented Sep 9, 2018

varasev commented Sep 10, 2018

wkarshat commented Sep 10, 2018

varasev commented Sep 11, 2018

wkarshat commented Sep 13, 2018

varasev commented Sep 13, 2018 • edited Loading

wkarshat commented Sep 13, 2018

varasev commented Sep 14, 2018

wkarshat commented Sep 16, 2018

varasev commented Sep 17, 2018

shkron commented Sep 19, 2018 • edited Loading

6proof commented Sep 19, 2018

varasev commented Sep 20, 2018

varasev commented Sep 20, 2018

vbaranov commented Sep 20, 2018

varasev commented Sep 20, 2018

varasev commented Sep 27, 2018

(Feature) Allow cancellation of a ballot in `VotingToManageEmissionFunds` by its creator for 15 minutes after it's created #168

(Feature) Allow cancellation of a ballot in `VotingToManageEmissionFunds` by its creator for 15 minutes after it's created #168

varasev commented Sep 13, 2018 •

edited

Loading

shkron commented Sep 19, 2018 •

edited

Loading