GovernorSuperQuorum.sol 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. // SPDX-License-Identifier: MIT
  2. // OpenZeppelin Contracts (last updated v5.3.0) (governance/extensions/GovernorSuperQuorum.sol)
  3. pragma solidity ^0.8.20;
  4. import {Governor} from "../Governor.sol";
  5. import {SafeCast} from "../../utils/math/SafeCast.sol";
  6. import {Checkpoints} from "../../utils/structs/Checkpoints.sol";
  7. /**
  8. * @dev Extension of {Governor} with a super quorum. Proposals that meet the super quorum (and have a majority of for
  9. * votes) advance to the `Succeeded` state before the proposal deadline. Counting modules that want to use this
  10. * extension must implement {proposalVotes}.
  11. */
  12. abstract contract GovernorSuperQuorum is Governor {
  13. /**
  14. * @dev Minimum number of cast votes required for a proposal to reach super quorum. Only FOR votes are counted
  15. * towards the super quorum. Once the super quorum is reached, an active proposal can proceed to the next state
  16. * without waiting for the proposal deadline.
  17. *
  18. * NOTE: The `timepoint` parameter corresponds to the snapshot used for counting the vote. This enables scaling of the
  19. * quorum depending on values such as the `totalSupply` of a token at this timepoint (see {ERC20Votes}).
  20. *
  21. * NOTE: Make sure the value specified for the super quorum is greater than {quorum}, otherwise, it may be
  22. * possible to pass a proposal with less votes than the default quorum.
  23. */
  24. function superQuorum(uint256 timepoint) public view virtual returns (uint256);
  25. /**
  26. * @dev Accessor to the internal vote counts. This must be implemented by the counting module. Counting modules
  27. * that don't implement this function are incompatible with this module
  28. */
  29. function proposalVotes(
  30. uint256 proposalId
  31. ) public view virtual returns (uint256 againstVotes, uint256 forVotes, uint256 abstainVotes);
  32. /**
  33. * @dev Overridden version of the {Governor-state} function that checks if the proposal has reached the super
  34. * quorum.
  35. *
  36. * NOTE: If the proposal reaches super quorum but {_voteSucceeded} returns false, eg, assuming the super quorum
  37. * has been set low enough that both FOR and AGAINST votes have exceeded it and AGAINST votes exceed FOR votes,
  38. * the proposal continues to be active until {_voteSucceeded} returns true or the proposal deadline is reached.
  39. * This means that with a low super quorum it is also possible that a vote can succeed prematurely before enough
  40. * AGAINST voters have a chance to vote. Hence, it is recommended to set a high enough super quorum to avoid these
  41. * types of scenarios.
  42. */
  43. function state(uint256 proposalId) public view virtual override returns (ProposalState) {
  44. ProposalState currentState = super.state(proposalId);
  45. if (currentState != ProposalState.Active) return currentState;
  46. (, uint256 forVotes, ) = proposalVotes(proposalId);
  47. if (forVotes < superQuorum(proposalSnapshot(proposalId)) || !_voteSucceeded(proposalId)) {
  48. return ProposalState.Active;
  49. } else if (proposalEta(proposalId) == 0) {
  50. return ProposalState.Succeeded;
  51. } else {
  52. return ProposalState.Queued;
  53. }
  54. }
  55. }