Solidity API

DXDVotingMachine

A voting machine is used to to determine the outcome of a dao proposal. The proposals are submitted through schemes. Each scheme has voting parameters and a staking token balance and ETH balance. The proposals can be executed in two final states, Queue or Boost. A boosted proposal is a proposal that received a favorable stake on an option. An stake is deposit done in the staking token, this adds a financial incentive and risk on a proposal to be executed faster. A proposal in queue needs at least 50% (or more) of votes in favour in order to be executed. A proposal in boost state might need a % of votes in favour in order to be executed. If a proposal ended and it has staked tokens on it the tokens can be redeemed by the stakers. If a staker staked on the winning option it receives a reward. If a staker staked on a loosing option it lose his stake.

ProposalState

enum ProposalState {
  None,
  Expired,
  ExecutedInQueue,
  ExecutedInBoost,
  Queued,
  PreBoosted,
  Boosted,
  QuietEndingPeriod
}

ExecutionState

enum ExecutionState {
  None,
  Failed,
  QueueBarCrossed,
  QueueTimeOut,
  PreBoostedBarCrossed,
  BoostedTimeOut,
  BoostedBarCrossed
}

Parameters

struct Parameters {
  uint256 queuedVoteRequiredPercentage;
  uint256 queuedVotePeriodLimit;
  uint256 boostedVotePeriodLimit;
  uint256 preBoostedVotePeriodLimit;
  uint256 thresholdConst;
  uint256 limitExponentValue;
  uint256 quietEndingPeriod;
  uint256 proposingRepReward;
  uint256 minimumDaoBounty;
  uint256 daoBountyConst;
  uint256 boostedVoteRequiredPercentage;
}

Voter

struct Voter {
  uint256 vote;
  uint256 reputation;
  bool preBoosted;
}

Staker

struct Staker {
  uint256 vote;
  uint256 amount;
  uint256 amount4Bounty;
}

Proposal

struct Proposal {
  bytes32 schemeId;
  address callbacks;
  enum DXDVotingMachine.ProposalState state;
  enum DXDVotingMachine.ExecutionState executionState;
  uint256 winningVote;
  address proposer;
  uint256 currentBoostedVotePeriodLimit;
  bytes32 paramsHash;
  uint256 daoBountyRemain;
  uint256 daoBounty;
  uint256 totalStakes;
  uint256 confidenceThreshold;
  uint256 secondsFromTimeOutTillExecuteBoosted;
  uint256[3] times;
  bool daoRedeemItsWinnings;
}

Scheme

struct Scheme {
  address avatar;
  uint256 stakingTokenBalance;
  uint256 voteGasBalance;
  uint256 voteGas;
  uint256 maxGasPrice;
  uint256 averagesDownstakesOfBoosted;
  uint256 orgBoostedProposalsCnt;
}

VoteDecision

struct VoteDecision {
  uint256 voteDecision;
  uint256 amount;
}

ExecuteFunctionParams

struct ExecuteFunctionParams {
  uint256 totalReputation;
  uint256 executionBar;
  uint256 boostedExecutionBar;
  uint256 averageDownstakesOfBoosted;
  uint256 confidenceThreshold;
}

NewProposal

event NewProposal(bytes32 _proposalId, address _avatar, uint256 _numOfChoices, address _proposer, bytes32 _paramsHash)

ExecuteProposal

event ExecuteProposal(bytes32 _proposalId, address _avatar, uint256 _decision, uint256 _totalReputation)

VoteProposal

event VoteProposal(bytes32 _proposalId, address _avatar, address _voter, uint256 _vote, uint256 _reputation)

CancelProposal

event CancelProposal(bytes32 _proposalId, address _avatar)

CancelVoting

event CancelVoting(bytes32 _proposalId, address _avatar, address _voter)

Stake

event Stake(bytes32 _proposalId, address _avatar, address _staker, uint256 _vote, uint256 _amount)

Redeem

event Redeem(bytes32 _proposalId, address _avatar, address _beneficiary, uint256 _amount)

RedeemDaoBounty

event RedeemDaoBounty(bytes32 _proposalId, address _avatar, address _beneficiary, uint256 _amount)

RedeemReputation

event RedeemReputation(bytes32 _proposalId, address _avatar, address _beneficiary, uint256 _amount)

ActionSigned

event ActionSigned(bytes32 proposalId, address voter, uint256 voteDecision, uint256 amount, uint256 nonce, uint256 actionType, bytes signature)

StateChange

event StateChange(bytes32 _proposalId, enum DXDVotingMachine.ProposalState _proposalState)

ExpirationCallBounty

event ExpirationCallBounty(bytes32 _proposalId, address _beneficiary, uint256 _amount)

ConfidenceLevelChange

event ConfidenceLevelChange(bytes32 _proposalId, uint256 _confidenceThreshold)

ProposalExecuteResult

event ProposalExecuteResult(string)

VoteSignaled

event VoteSignaled(bytes32 proposalId, address voter, uint256 voteDecision, uint256 amount)

Event used to signal votes to be executed on chain

DXDVotingMachine__ProposalIsNotVotable

error DXDVotingMachine__ProposalIsNotVotable()

DXDVotingMachine__WrongDecisionValue

error DXDVotingMachine__WrongDecisionValue()

DXDVotingMachine__WrongStakingToken

error DXDVotingMachine__WrongStakingToken()

DXDVotingMachine__SetParametersError

error DXDVotingMachine__SetParametersError(string)

DXDVotingMachine__WrongProposalStateToRedeem

error DXDVotingMachine__WrongProposalStateToRedeem()

Emited when proposal is not in ExecutedInQueue, ExecutedInBoost or Expired status

DXDVotingMachine__TransferFailed

error DXDVotingMachine__TransferFailed(address to, uint256 amount)

DXDVotingMachine__WrongProposalStateToRedeemDaoBounty

error DXDVotingMachine__WrongProposalStateToRedeemDaoBounty()

Emited when proposal is not in ExecutedInQueue or ExecutedInBoost status

DXDVotingMachine__WrongSigner

error DXDVotingMachine__WrongSigner()

DXDVotingMachine__InvalidNonce

error DXDVotingMachine__InvalidNonce()

DXDVotingMachine__OnlySchemeOrAvatarCanSetSchemeRefound

error DXDVotingMachine__OnlySchemeOrAvatarCanSetSchemeRefound()

DXDVotingMachine__AddressNotRegisteredInSchemeRefounds

error DXDVotingMachine__AddressNotRegisteredInSchemeRefounds()

DXDVotingMachine__SchemeRefundBalanceIsZero

error DXDVotingMachine__SchemeRefundBalanceIsZero()

DXDVotingMachine__ProposalAlreadyVoted

error DXDVotingMachine__ProposalAlreadyVoted()

DXDVotingMachine__VoterMustHaveReputation

error DXDVotingMachine__VoterMustHaveReputation()

DXDVotingMachine__NotEnoughtReputation

error DXDVotingMachine__NotEnoughtReputation()

DXDVotingMachine__WrongVoteShared

error DXDVotingMachine__WrongVoteShared()

DXDVotingMachine__StakingAmountShouldBeBiggerThanZero

error DXDVotingMachine__StakingAmountShouldBeBiggerThanZero()

DXDVotingMachine__TransferFromStakerFailed

error DXDVotingMachine__TransferFromStakerFailed()

DXDVotingMachine__StakingAmountIsTooHight

error DXDVotingMachine__StakingAmountIsTooHight()

DXDVotingMachine__TotalStakesIsToHight

error DXDVotingMachine__TotalStakesIsToHight()

DXDVotingMachine__InvalidChoicesAmount

error DXDVotingMachine__InvalidChoicesAmount()

Emited when _choicesAmount is less than NUM_OF_CHOICES

DXDVotingMachine__InvalidParameters

error DXDVotingMachine__InvalidParameters()

proposalVotes

mapping(bytes32 => mapping(uint256 => uint256)) proposalVotes

proposalId => vote => reputation

proposalPreBoostedVotes

mapping(bytes32 => mapping(uint256 => uint256)) proposalPreBoostedVotes

proposalId => vote => reputation

proposalVoters

mapping(bytes32 => mapping(address => struct DXDVotingMachine.Voter)) proposalVoters

proposalId => address => voter

proposalStakes

mapping(bytes32 => mapping(uint256 => uint256)) proposalStakes

proposalId => address => stakes

proposalStakers

mapping(bytes32 => mapping(address => struct DXDVotingMachine.Staker)) proposalStakers

proposalId => address => staker

parameters

mapping(bytes32 => struct DXDVotingMachine.Parameters) parameters

A mapping from hashes to parameters

proposals

mapping(bytes32 => struct DXDVotingMachine.Proposal) proposals

Mapping from the ID of the proposal to the proposal itself.

schemes

mapping(bytes32 => struct DXDVotingMachine.Scheme) schemes

schemeId => scheme

NUM_OF_CHOICES

uint256 NUM_OF_CHOICES

NO

uint256 NO

YES

uint256 YES

proposalsCnt

uint256 proposalsCnt

stakingToken

contract IERC20 stakingToken

Total number of proposals

MAX_BOOSTED_PROPOSALS

uint256 MAX_BOOSTED_PROPOSALS

SIGNED_ACTION_HASH_EIP712

bytes32 SIGNED_ACTION_HASH_EIP712

Digest describing the data the user signs according EIP 712. Needs to match what is passed to Metamask.

stakesNonce

mapping(address => uint256) stakesNonce

votesSignaled

mapping(bytes32 => mapping(address => struct DXDVotingMachine.VoteDecision)) votesSignaled

numOfChoices

mapping(bytes32 => uint256) numOfChoices

The number of choices of each proposal

onlyProposalOwner

modifier onlyProposalOwner(bytes32 _proposalId)

votable

modifier votable(bytes32 _proposalId)

Check that the proposal is votable. A proposal is votable if it is in one of the following states: PreBoosted, Boosted, QuietEndingPeriod or Queued

validDecision

modifier validDecision(bytes32 proposalId, uint256 decision)

constructor

constructor(contract IERC20 _stakingToken) public

Constructor

Parameters

Name	Type	Description
_stakingToken	contract IERC20	ERC20 token used as staking token

setParameters

function setParameters(uint256[10] _params) external returns (bytes32 paramsHash)

Hash the parameters, save them if necessary, and return the hash value

Parameters

Name	Type	Description
_params	uint256[10]	A parameters array

_params[0] - _queuedVoteRequiredPercentage,
_params[1] - _queuedVotePeriodLimit, //the time limit for a proposal to be in an absolute voting mode.
_params[2] - _boostedVotePeriodLimit, //the time limit for a proposal to be in an relative voting mode.
_params[3] - _preBoostedVotePeriodLimit, //the time limit for a proposal to be in an preparation state (stable) before boosted.
_params[4] -_thresholdConst
_params[5] -_quietEndingPeriod
_params[6] -_proposingRepReward
_params[7] -_minimumDaoBounty
_params[8] -_daoBountyConst
_params[9] - _boostedVoteRequiredPercentage |

Return Values

Name	Type	Description
paramsHash	bytes32	Hash of the given parameters

redeem

function redeem(bytes32 _proposalId, address _beneficiary) public returns (uint256[2] rewards)

Redeem a reward for a successful stake, vote or proposing. The function use a beneficiary address as a parameter (and not msg.sender) to enable users to redeem on behalf of someone else.

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal
_beneficiary	address	The beneficiary address

Return Values

Name	Type	Description
rewards	uint256[2]	[0]=stakerTokenReward [1]=proposerReputationReward

redeemDaoBounty

function redeemDaoBounty(bytes32 _proposalId, address _beneficiary) public returns (uint256 redeemedAmount, uint256 potentialAmount)

redeemDaoBounty a reward for a successful stake. The function use a beneficiary address as a parameter (and not msg.sender) to enable users to redeem on behalf of someone else.

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal
_beneficiary	address	The beneficiary address

Return Values

Name	Type	Description
redeemedAmount	uint256	Redeem token amount
potentialAmount	uint256	Potential redeem token amount (if there is enough tokens bounty at the dao owner of the scheme )

calcExecuteCallBounty

function calcExecuteCallBounty(bytes32 _proposalId) public view returns (uint256 executeCallBounty)

Calculate the execute boosted call bounty

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal

Return Values

Name	Type	Description
executeCallBounty	uint256	The execute boosted call bounty

shouldBoost

function shouldBoost(bytes32 _proposalId) public view returns (bool shouldProposalBeBoosted)

Check if a proposal should be shifted to boosted phase.

Parameters

Name	Type	Description
_proposalId	bytes32	the ID of the proposal

Return Values

Name	Type	Description
shouldProposalBeBoosted	bool	True or false depending on whether the proposal should be boosted or not.

threshold

function threshold(bytes32 _paramsHash, bytes32 _schemeId) public view returns (uint256 schemeThreshold)

Returns the scheme's score threshold which is required by a proposal to shift to boosted state. This threshold is dynamically set and it depend on the number of boosted proposal.

Parameters

Name	Type	Description
_paramsHash	bytes32	The scheme parameters hash
_schemeId	bytes32	The scheme identifier

Return Values

Name	Type	Description
schemeThreshold	uint256	Scheme's score threshold as real number.

stake

function stake(bytes32 _proposalId, uint256 _vote, uint256 _amount) external returns (bool proposalExecuted)

Staking function

Parameters

Name	Type	Description
_proposalId	bytes32	id of the proposal
_vote	uint256	NO(1) or YES(2).
_amount	uint256	The betting amount

Return Values

Name	Type	Description
proposalExecuted	bool	true if the proposal was executed, false otherwise.

stakeWithSignature

function stakeWithSignature(bytes32 proposalId, address staker, uint256 stakeDecision, uint256 amount, uint256 nonce, bytes signature) external returns (bool proposalExecuted)

stakeWithSignature function

Parameters

Name	Type	Description
proposalId	bytes32	Id of the proposal
staker	address	Address of staker
stakeDecision	uint256	NO(1) or YES(2).
amount	uint256	The betting amount
nonce	uint256	Nonce value ,it is part of the signature to ensure that a signature can be received only once.
signature	bytes	Signed data by the staker

Return Values

Name	Type	Description
proposalExecuted	bool	True if the proposal was executed, false otherwise.

setSchemeRefund

function setSchemeRefund(address avatar, address scheme, uint256 _voteGas, uint256 _maxGasPrice) external payable

Allows the voting machine to receive ether to be used to refund voting costs

Config the vote refund for each scheme

Parameters

Name	Type	Description
avatar	address	Avatar contract address
scheme	address	Scheme contract address to set vote refund config
_voteGas	uint256	The amount of gas that will be used as vote cost
_maxGasPrice	uint256	The maximum amount of gas price to be paid, if the gas used is higher than this value only a portion of the total gas would be refunded

withdrawRefundBalance

function withdrawRefundBalance(address scheme) public

Withdraw scheme refund balance

Parameters

Name	Type	Description
scheme	address	Scheme contract address to withdraw refund balance from

vote

function vote(bytes32 _proposalId, uint256 _vote, uint256 _amount) external returns (bool proposalExecuted)

Voting function from old voting machine changing only the logic to refund vote after vote done

Parameters

Name	Type	Description
_proposalId	bytes32	id of the proposal
_vote	uint256	NO(1) or YES(2).
_amount	uint256	The reputation amount to vote with, 0 will use all available REP

Return Values

Name	Type	Description
proposalExecuted	bool	True if the proposal was executed, false otherwise.

execute

function execute(bytes32 _proposalId) external returns (bool proposalExecuted)

Check if the proposal has been decided, and if so, execute the proposal

Parameters

Name	Type	Description
_proposalId	bytes32	The id of the proposal

Return Values

Name	Type	Description
proposalExecuted	bool	True if the proposal was executed, false otherwise.

voteInfo

function voteInfo(bytes32 _proposalId, address _voter) external view returns (uint256 voterVote, uint256 voterReputation)

Returns the vote and the amount of reputation of the user committed to this proposal

Parameters

Name	Type	Description
_proposalId	bytes32	the ID of the proposal
_voter	address	The address of the voter

Return Values

Name	Type	Description
voterVote	uint256	The voters vote
voterReputation	uint256	Amount of reputation committed by _voter to _proposalId

voteStatus

function voteStatus(bytes32 _proposalId, uint256 _choice) external view returns (uint256 voted)

Returns the reputation voted for a proposal for a specific voting choice.

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal
_choice	uint256	The index in the voting choice

Return Values

Name	Type	Description
voted	uint256	Reputation for the given choice

isVotable

function isVotable(bytes32 _proposalId) external view returns (bool isProposalVotable)

Check if the proposal is votable

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal

Return Values

Name	Type	Description
isProposalVotable	bool	True or false depending on whether the proposal is voteable

shareSignedAction

function shareSignedAction(bytes32 proposalId, address voter, uint256 voteDecision, uint256 amount, uint256 nonce, uint256 actionType, bytes signature) external

Share the vote of a proposal for a voting machine on a event log

Parameters

Name	Type	Description
proposalId	bytes32	id of the proposal
voter	address	Address of voter
voteDecision	uint256	The vote decision, NO(1) or YES(2).
amount	uint256	The reputation amount to vote with, 0 will use all available REP
nonce	uint256	Nonce value ,it is part of the signature to ensure that a signature can be received only once.
actionType	uint256	1=vote, 2=stake
signature	bytes	The encoded vote signature

signalVote

function signalVote(bytes32 proposalId, uint256 voteDecision, uint256 amount) external

Signal the vote of a proposal in this voting machine to be executed later

Parameters

Name	Type	Description
proposalId	bytes32	Id of the proposal to vote
voteDecision	uint256	The vote decisions, NO(1) or YES(2).
amount	uint256	The reputation amount to vote with, 0 will use all available REP

executeSignedVote

function executeSignedVote(bytes32 proposalId, address voter, uint256 voteDecision, uint256 amount, uint256 nonce, bytes signature) external

Execute a signed vote

Parameters

Name	Type	Description
proposalId	bytes32	Id of the proposal to execute the vote on
voter	address	The signer of the vote
voteDecision	uint256	The vote decision, NO(1) or YES(2).
amount	uint256	The reputation amount to vote with, 0 will use all available REP
nonce	uint256	Nonce value ,it is part of the signature to ensure that a signature can be received only once.
signature	bytes	The signature of the hashed vote

propose

function propose(uint256 _totalOptions, bytes32 _paramsHash, address _proposer, address _avatar) external returns (bytes32 proposalId)

Register a new proposal with the given parameters. Every proposal has a unique ID which is being generated by calculating keccak256 of a incremented counter.

Parameters

Name	Type	Description
_totalOptions	uint256	The amount of options to be voted on
_paramsHash	bytes32	parameters hash
_proposer	address	address
_avatar	address	address

Return Values

Name	Type	Description
proposalId	bytes32	ID of the new proposal registered

internalVote

function internalVote(bytes32 _proposalId, address _voter, uint256 _vote, uint256 _rep) internal returns (bool proposalExecuted)

Vote for a proposal, if the voter already voted, cancel the last vote and set a new one instead

Parameters

Name	Type	Description
_proposalId	bytes32	id of the proposal
_voter	address	used in case the vote is cast for someone else
_vote	uint256	a value between 0 to and the proposal's number of choices.
_rep	uint256	how many reputation the voter would like to stake for this vote. if _rep==0 the voter full reputation will be use.

Return Values

Name	Type	Description
proposalExecuted	bool	true if the proposal was executed, false otherwise.
Throws if proposal is not open or if it has been executed
NB: executes the proposal if a decision has been reached

executeSignaledVote

function executeSignaledVote(bytes32 proposalId, address voter) external

Execute a signaled vote on a votable proposal

Parameters

Name	Type	Description
proposalId	bytes32	id of the proposal to vote
voter	address	The signer of the vote

hashAction

function hashAction(bytes32 proposalId, address signer, uint256 option, uint256 amount, uint256 nonce, uint256 actionType) public view returns (bytes32 actionHash)

Hash the vote data that is used for signatures

Parameters

Name	Type	Description
proposalId	bytes32	id of the proposal
signer	address	The signer of the vote
option	uint256	The vote decision, NO(1) or YES(2).
amount	uint256	The reputation amount to vote with, 0 will use all available REP
nonce	uint256	Nonce value, it is part of the signature to ensure that a signature can be received only once.
actionType	uint256	The governance action type to hash

Return Values

Name	Type	Description
actionHash	bytes32	Hash of the action

score

function score(bytes32 _proposalId) public view returns (uint256 proposalScore)

Returns the proposal score

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal

Return Values

Name	Type	Description
proposalScore	uint256	Proposal score as real number.

_execute

function _execute(bytes32 _proposalId) internal returns (bool proposalExecuted)

Check if the proposal has been decided, and if so, execute the proposal

Parameters

Name	Type	Description
_proposalId	bytes32	The id of the proposal

Return Values

Name	Type	Description
proposalExecuted	bool	True if the proposal was executed, false otherwise.

_score

function _score(bytes32 _proposalId) internal view returns (uint256 proposalScore)

Returns the proposal score (Confidence level) For dual choice proposal S = (S+)/(S-)

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal

Return Values

Name	Type	Description
proposalScore	uint256	Proposal score as real number.

_isVotable

function _isVotable(bytes32 _proposalId) internal view returns (bool isProposalVotable)

Check if the proposal is votable

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal

Return Values

Name	Type	Description
isProposalVotable	bool	True or false depending on whether the proposal is voteable

_stake

function _stake(bytes32 _proposalId, uint256 _vote, uint256 _amount, address _staker) internal returns (bool proposalExecuted)

staking function

Parameters

Name	Type	Description
_proposalId	bytes32	id of the proposal
_vote	uint256	NO(1) or YES(2).
_amount	uint256	The betting amount
_staker	address	Address of the staker

Return Values

Name	Type	Description
proposalExecuted	bool	True if the proposal was executed, false otherwise.

_propose

function _propose(uint256 _choicesAmount, bytes32 _paramsHash, address _proposer, address _avatar) internal returns (bytes32 proposalId)

Register a new proposal with the given parameters. Every proposal has a unique ID which is being generated by calculating keccak256 of a incremented counter.

Parameters

Name	Type	Description
_choicesAmount	uint256	the total amount of choices for the proposal
_paramsHash	bytes32	parameters hash
_proposer	address	Proposer address
_avatar	address	Avatar address

Return Values

Name	Type	Description
proposalId	bytes32	ID of the new proposal registered

_refundVote

function _refundVote(bytes32 schemeId) internal

Refund a vote gas cost to an address

Parameters

Name	Type	Description
schemeId	bytes32	The id of the scheme that should do the refund

getParametersHash

function getParametersHash(uint256[10] _params) public pure returns (bytes32 paramsHash)

Returns a hash of the given parameters

Parameters

Name	Type	Description
_params	uint256[10]	Array of params (10) to hash

Return Values

Name	Type	Description
paramsHash	bytes32	Hash of the given parameters

getProposalTimes

function getProposalTimes(bytes32 _proposalId) external view returns (uint256[3] times)

Returns proposals times variables.

Parameters

Name	Type	Description
_proposalId	bytes32	ID of the proposal

Return Values

Name	Type	Description
times	uint256[3]	Times array

getProposalSchemeId

function getProposalSchemeId(bytes32 _proposalId) external view returns (bytes32 schemeId)

Returns the schemeId for a given proposal

Parameters

Name	Type	Description
_proposalId	bytes32	ID of the proposal

Return Values

Name	Type	Description
schemeId	bytes32	Scheme identifier

getStaker

function getStaker(bytes32 _proposalId, address _staker) external view returns (uint256 vote, uint256 amount)

Returns the vote and stake amount for a given proposal and staker

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal
_staker	address	Staker address

Return Values

Name	Type	Description
vote	uint256	Proposal staker vote
amount	uint256	Proposal staker amount

getAllowedRangeOfChoices

function getAllowedRangeOfChoices() external pure returns (uint256 min, uint256 max)

Returns the allowed range of choices for a voting machine.

Return Values

Name	Type	Description
min	uint256	minimum number of choices
max	uint256	maximum number of choices

getNumberOfChoices

function getNumberOfChoices(bytes32 _proposalId) public view returns (uint256 proposalChoicesNum)

Returns the number of choices possible in this proposal

Parameters

Name	Type	Description
_proposalId	bytes32	The proposal id

Return Values

Name	Type	Description
proposalChoicesNum	uint256	Number of choices for given proposal

proposalStatus

function proposalStatus(bytes32 _proposalId) external view returns (uint256 preBoostedVotesNo, uint256 preBoostedVotesYes, uint256 totalStakesNo, uint256 totalStakesYes)

Returns the total votes and stakes for a given proposal

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal

Return Values

Name	Type	Description
preBoostedVotesNo	uint256	preBoostedVotes NO
preBoostedVotesYes	uint256	preBoostedVotes YES
totalStakesNo	uint256	Total stakes NO
totalStakesYes	uint256	Total stakes YES

proposalStatusWithVotes

function proposalStatusWithVotes(bytes32 _proposalId) external view returns (uint256 votesNo, uint256 votesYes, uint256 preBoostedVotesNo, uint256 preBoostedVotesYes, uint256 totalStakesNo, uint256 totalStakesYes)

Returns the total votes, preBoostedVotes and stakes for a given proposal

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal

Return Values

Name	Type	Description
votesNo	uint256	Proposal votes NO
votesYes	uint256	Proposal votes YES
preBoostedVotesNo	uint256	Proposal pre boosted votes NO
preBoostedVotesYes	uint256	Proposal pre boosted votes YES
totalStakesNo	uint256	Proposal total stakes NO
totalStakesYes	uint256	Proposal total stakes YES

voteStake

function voteStake(bytes32 _proposalId, uint256 _vote) external view returns (uint256 totalStakeAmount)

Returns the amount stakes for a given proposal and vote

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal
_vote	uint256	Vote number

Return Values

Name	Type	Description
totalStakeAmount	uint256	Total stake amount

winningVote

function winningVote(bytes32 _proposalId) external view returns (uint256 winningVote)

Returns the winningVote for a given proposal

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal

Return Values

Name	Type	Description
winningVote	uint256	Winning vote for given proposal

state

function state(bytes32 _proposalId) external view returns (enum DXDVotingMachine.ProposalState state)

Returns the state for a given proposal

Parameters

Name	Type	Description
_proposalId	bytes32	The ID of the proposal

Return Values

Name	Type	Description
state	enum DXDVotingMachine.ProposalState	ProposalState proposal state

Files

DXDVotingMachine.md

Latest commit

History

DXDVotingMachine.md

File metadata and controls

Solidity API

DXDVotingMachine

ProposalState

ExecutionState

Parameters

Voter

Staker

Proposal

Scheme

VoteDecision

ExecuteFunctionParams

NewProposal

ExecuteProposal

VoteProposal

CancelProposal

CancelVoting

Stake

Redeem

RedeemDaoBounty

RedeemReputation

ActionSigned

StateChange

ExpirationCallBounty

ConfidenceLevelChange

ProposalExecuteResult

VoteSignaled

DXDVotingMachine__ProposalIsNotVotable

DXDVotingMachine__WrongDecisionValue

DXDVotingMachine__WrongStakingToken

DXDVotingMachine__SetParametersError

DXDVotingMachine__WrongProposalStateToRedeem

DXDVotingMachine__TransferFailed

DXDVotingMachine__WrongProposalStateToRedeemDaoBounty

DXDVotingMachine__WrongSigner

DXDVotingMachine__InvalidNonce

DXDVotingMachine__OnlySchemeOrAvatarCanSetSchemeRefound

DXDVotingMachine__AddressNotRegisteredInSchemeRefounds

DXDVotingMachine__SchemeRefundBalanceIsZero

DXDVotingMachine__ProposalAlreadyVoted

DXDVotingMachine__VoterMustHaveReputation

DXDVotingMachine__NotEnoughtReputation

DXDVotingMachine__WrongVoteShared

DXDVotingMachine__StakingAmountShouldBeBiggerThanZero

DXDVotingMachine__TransferFromStakerFailed

DXDVotingMachine__StakingAmountIsTooHight

DXDVotingMachine__TotalStakesIsToHight

DXDVotingMachine__InvalidChoicesAmount

DXDVotingMachine__InvalidParameters

proposalVotes

proposalPreBoostedVotes

proposalVoters

proposalStakes

proposalStakers

parameters

proposals

schemes

NUM_OF_CHOICES

NO

YES

proposalsCnt

stakingToken

MAX_BOOSTED_PROPOSALS

SIGNED_ACTION_HASH_EIP712

stakesNonce

votesSignaled

numOfChoices

onlyProposalOwner

votable

validDecision

constructor

Parameters

setParameters

Parameters

Return Values