Governor Votes Quorum Fraction Upgradeable
Extension of {Governor} for voting weight extraction from an {ERC20Votes} token and a quorum expressed as a fraction of the total supply. Available since v4.3.
Methods
BALLOT_TYPEHASH
Returns
COUNTING_MODE
module:voting
A description of the possible support
values for {castVote} and the way these votes are counted, meant to be consumed by UIs to show correct vote options and interpret the results. The string is a URL-encoded sequence of key-value pairs that each describe one aspect, for example support=bravo&quorum=for,abstain
. There are 2 standard keys: support
and quorum
. - support=bravo
refers to the vote options 0 = For, 1 = Against, 2 = Abstain, as in GovernorBravo
. - quorum=bravo
means that only For votes are counted towards quorum. - quorum=for,abstain
means that both For and Abstain votes are counted towards quorum. NOTE: The string can be decoded by the standard https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams[URLSearchParams
] JavaScript class.
Returns
castVote
See {IGovernor-castVote}.
Parameters
Returns
castVoteBySig
See {IGovernor-castVoteBySig}.
Parameters
Returns
castVoteWithReason
See {IGovernor-castVoteWithReason}.
Parameters
Returns
execute
See {IGovernor-execute}.
Parameters
Returns
getVotes
Read the voting weight from the token's built in snapshot mechanism (see {IGovernor-getVotes}).
Parameters
Returns
hasVoted
module:voting
Returns weither account
has cast a vote on proposalId
.
Parameters
Returns
hashProposal
See {IGovernor-hashProposal}. The proposal id is produced by hashing the RLC encoded targets
array, the values
array, the calldatas
array and the descriptionHash (bytes32 which itself is the keccak256 hash of the description string). This proposal id can be produced from the proposal data which is part of the {ProposalCreated} event. It can even be computed in advance, before the proposal is submitted. Note that the chainId and the governor address are not part of the proposal id computation. Consequently, the same proposal (with same operation and same description) will have the same id if submitted on multiple governors accross multiple networks. This also means that in order to execute the same operation twice (on the same governor) the proposer will have to change the description in order to avoid proposal id conflicts.
Parameters
Returns
name
See {IGovernor-name}.
Returns
proposalDeadline
See {IGovernor-proposalDeadline}.
Parameters
Returns
proposalSnapshot
See {IGovernor-proposalSnapshot}.
Parameters
Returns
propose
See {IGovernor-propose}.
Parameters
Returns
quorum
module:user-config
Minimum number of cast voted required for a proposal to be successful. Note: The blockNumber
parameter corresponds to the snaphot used for counting vote. This allows to scale the quroum depending on values such as the totalSupply of a token at this block (see {ERC20Votes}).
Parameters
Returns
quorumDenominator
Returns
quorumNumerator
Returns
state
See {IGovernor-state}.
Parameters
Returns
supportsInterface
See {IERC165-supportsInterface}.
Parameters
Returns
token
Returns
updateQuorumNumerator
Parameters
version
See {IGovernor-version}.
Returns
votingDelay
module:user-config
delay, in number of block, between the proposal is created and the vote starts. This can be increassed to leave time for users to buy voting power, of delegate it, before the voting of a proposal starts.
Returns
votingPeriod
module:user-config
delay, in number of blocks, between the vote start and vote ends. Note: the {votingDelay} can delay the start of the vote. This must be considered when setting the voting duration compared to the voting delay.
Returns
Events
ProposalCanceled
Parameters
ProposalCreated
Parameters
ProposalExecuted
Parameters
QuorumNumeratorUpdated
Parameters
VoteCast
Parameters
Last updated