-
Notifications
You must be signed in to change notification settings - Fork 433
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
11e46fa
commit daacdb6
Showing
17 changed files
with
1,035 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| 'openzeppelin-solidity': patch | ||
| --- | ||
|
|
||
| `VotesExtended`: Create an extension of `Votes` which checkpoints balances and delegates. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| 'openzeppelin-solidity': patch | ||
| --- | ||
|
|
||
| `GovernorCountingOverridable`: Add a governor counting module that enables token holders to override the vote of their delegate. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
237 changes: 237 additions & 0 deletions
237
contracts/governance/extensions/GovernorCountingOverridableUpgradeable.sol
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,237 @@ | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| pragma solidity ^0.8.20; | ||
|
|
||
| import {SignatureChecker} from "@openzeppelin/contracts/utils/cryptography/SignatureChecker.sol"; | ||
| import {SafeCast} from "@openzeppelin/contracts/utils/math/SafeCast.sol"; | ||
| import {VotesExtendedUpgradeable} from "../utils/VotesExtendedUpgradeable.sol"; | ||
| import {GovernorVotesUpgradeable} from "./GovernorVotesUpgradeable.sol"; | ||
| import {Initializable} from "../../proxy/utils/Initializable.sol"; | ||
|
|
||
| /** | ||
| * @dev Extension of {Governor} which enables delegatees to override the vote of their delegates. This module requires a | ||
| * token token that inherits `VotesExtended`. | ||
| */ | ||
| abstract contract GovernorCountingOverridableUpgradeable is Initializable, GovernorVotesUpgradeable { | ||
| bytes32 public constant OVERRIDE_BALLOT_TYPEHASH = | ||
| keccak256("OverrideBallot(uint256 proposalId,uint8 support,address voter,uint256 nonce,string reason)"); | ||
|
|
||
| /** | ||
| * @dev Supported vote types. Matches Governor Bravo ordering. | ||
| */ | ||
| enum VoteType { | ||
| Against, | ||
| For, | ||
| Abstain | ||
| } | ||
|
|
||
| struct VoteReceipt { | ||
| uint8 casted; // 0 if vote was not casted. Otherwise: support + 1 | ||
| bool hasOverriden; | ||
| uint208 overridenWeight; | ||
| } | ||
|
|
||
| struct ProposalVote { | ||
| uint256[3] votes; | ||
| mapping(address voter => VoteReceipt) voteReceipt; | ||
| } | ||
|
|
||
| event VoteReduced(address indexed voter, uint256 proposalId, uint8 support, uint256 weight); | ||
| event OverrideVoteCast(address indexed voter, uint256 proposalId, uint8 support, uint256 weight, string reason); | ||
|
|
||
| error GovernorAlreadyOverridenVote(address account); | ||
|
|
||
| /// @custom:storage-location erc7201:openzeppelin.storage.GovernorCountingOverridable | ||
| struct GovernorCountingOverridableStorage { | ||
| mapping(uint256 proposalId => ProposalVote) _proposalVotes; | ||
| } | ||
|
|
||
| // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.GovernorCountingOverridable")) - 1)) & ~bytes32(uint256(0xff)) | ||
| bytes32 private constant GovernorCountingOverridableStorageLocation = 0xbffde6e7ca736efb3d8171f99b09abc076e81f804bf1703dc71fb0b1f7715100; | ||
|
|
||
| function _getGovernorCountingOverridableStorage() private pure returns (GovernorCountingOverridableStorage storage $) { | ||
| assembly { | ||
| $.slot := GovernorCountingOverridableStorageLocation | ||
| } | ||
| } | ||
|
|
||
| function __GovernorCountingOverridable_init() internal onlyInitializing { | ||
| } | ||
|
|
||
| function __GovernorCountingOverridable_init_unchained() internal onlyInitializing { | ||
| } | ||
| /** | ||
| * @dev See {IGovernor-COUNTING_MODE}. | ||
| */ | ||
| // solhint-disable-next-line func-name-mixedcase | ||
| function COUNTING_MODE() public pure virtual override returns (string memory) { | ||
| return "support=bravo,override&quorum=for,abstain&overridable=true"; | ||
| } | ||
|
|
||
| /** | ||
| * @dev See {IGovernor-hasVoted}. | ||
| */ | ||
| function hasVoted(uint256 proposalId, address account) public view virtual override returns (bool) { | ||
| GovernorCountingOverridableStorage storage $ = _getGovernorCountingOverridableStorage(); | ||
| return $._proposalVotes[proposalId].voteReceipt[account].casted != 0; | ||
| } | ||
|
|
||
| /** | ||
| * @dev Check if an `account` has overridden their delegate for a proposal. | ||
| */ | ||
| function hasVotedOverride(uint256 proposalId, address account) public view virtual returns (bool) { | ||
| GovernorCountingOverridableStorage storage $ = _getGovernorCountingOverridableStorage(); | ||
| return $._proposalVotes[proposalId].voteReceipt[account].hasOverriden; | ||
| } | ||
|
|
||
| /** | ||
| * @dev Accessor to the internal vote counts. | ||
| */ | ||
| function proposalVotes( | ||
| uint256 proposalId | ||
| ) public view virtual returns (uint256 againstVotes, uint256 forVotes, uint256 abstainVotes) { | ||
| GovernorCountingOverridableStorage storage $ = _getGovernorCountingOverridableStorage(); | ||
| uint256[3] storage votes = $._proposalVotes[proposalId].votes; | ||
| return (votes[uint8(VoteType.Against)], votes[uint8(VoteType.For)], votes[uint8(VoteType.Abstain)]); | ||
| } | ||
|
|
||
| /** | ||
| * @dev See {Governor-_quorumReached}. | ||
| */ | ||
| function _quorumReached(uint256 proposalId) internal view virtual override returns (bool) { | ||
| GovernorCountingOverridableStorage storage $ = _getGovernorCountingOverridableStorage(); | ||
| uint256[3] storage votes = $._proposalVotes[proposalId].votes; | ||
| return quorum(proposalSnapshot(proposalId)) <= votes[uint8(VoteType.For)] + votes[uint8(VoteType.Abstain)]; | ||
| } | ||
|
|
||
| /** | ||
| * @dev See {Governor-_voteSucceeded}. In this module, the forVotes must be strictly over the againstVotes. | ||
| */ | ||
| function _voteSucceeded(uint256 proposalId) internal view virtual override returns (bool) { | ||
| GovernorCountingOverridableStorage storage $ = _getGovernorCountingOverridableStorage(); | ||
| uint256[3] storage votes = $._proposalVotes[proposalId].votes; | ||
| return votes[uint8(VoteType.For)] > votes[uint8(VoteType.Against)]; | ||
| } | ||
|
|
||
| /** | ||
| * @dev See {Governor-_countVote}. In this module, the support follows the `VoteType` enum (from Governor Bravo). | ||
| * | ||
| * NOTE: called by {Governor-_castVote} which emits the {IGovernor-VoteCast} (or {IGovernor-VoteCastWithParams}) | ||
| * event. | ||
| */ | ||
| function _countVote( | ||
| uint256 proposalId, | ||
| address account, | ||
| uint8 support, | ||
| uint256 totalWeight, | ||
| bytes memory /*params*/ | ||
| ) internal virtual override returns (uint256) { | ||
| GovernorCountingOverridableStorage storage $ = _getGovernorCountingOverridableStorage(); | ||
| ProposalVote storage proposalVote = $._proposalVotes[proposalId]; | ||
|
|
||
| if (support > uint8(VoteType.Abstain)) { | ||
| revert GovernorInvalidVoteType(); | ||
| } | ||
|
|
||
| if (proposalVote.voteReceipt[account].casted != 0) { | ||
| revert GovernorAlreadyCastVote(account); | ||
| } | ||
|
|
||
| totalWeight -= proposalVote.voteReceipt[account].overridenWeight; | ||
| proposalVote.votes[support] += totalWeight; | ||
| proposalVote.voteReceipt[account].casted = support + 1; | ||
|
|
||
| return totalWeight; | ||
| } | ||
|
|
||
| /// @dev Variant of {Governor-_countVote} that deals with vote overrides. | ||
| function _countOverride(uint256 proposalId, address account, uint8 support) internal virtual returns (uint256) { | ||
| GovernorCountingOverridableStorage storage $ = _getGovernorCountingOverridableStorage(); | ||
| ProposalVote storage proposalVote = $._proposalVotes[proposalId]; | ||
|
|
||
| if (support > uint8(VoteType.Abstain)) { | ||
| revert GovernorInvalidVoteType(); | ||
| } | ||
|
|
||
| if (proposalVote.voteReceipt[account].hasOverriden) { | ||
| revert GovernorAlreadyOverridenVote(account); | ||
| } | ||
|
|
||
| uint256 proposalSnapshot = proposalSnapshot(proposalId); | ||
| uint256 overridenWeight = VotesExtendedUpgradeable(address(token())).getPastBalanceOf(account, proposalSnapshot); | ||
| address delegate = VotesExtendedUpgradeable(address(token())).getPastDelegate(account, proposalSnapshot); | ||
| uint8 delegateCasted = proposalVote.voteReceipt[delegate].casted; | ||
|
|
||
| proposalVote.voteReceipt[account].hasOverriden = true; | ||
| proposalVote.votes[support] += overridenWeight; | ||
| if (delegateCasted == 0) { | ||
| proposalVote.voteReceipt[delegate].overridenWeight += SafeCast.toUint208(overridenWeight); | ||
| } else { | ||
| uint8 delegateSupport = delegateCasted - 1; | ||
| proposalVote.votes[delegateSupport] -= overridenWeight; | ||
| emit VoteReduced(delegate, proposalId, delegateSupport, overridenWeight); | ||
| } | ||
|
|
||
| return overridenWeight; | ||
| } | ||
|
|
||
| /// @dev variant of {Governor-_castVote} that deals with vote overrides. | ||
| function _castOverride( | ||
| uint256 proposalId, | ||
| address account, | ||
| uint8 support, | ||
| string calldata reason | ||
| ) internal virtual returns (uint256) { | ||
| _validateStateBitmap(proposalId, _encodeStateBitmap(ProposalState.Active)); | ||
|
|
||
| uint256 overridenWeight = _countOverride(proposalId, account, support); | ||
|
|
||
| emit OverrideVoteCast(account, proposalId, support, overridenWeight, reason); | ||
|
|
||
| _tallyUpdated(proposalId); | ||
|
|
||
| return overridenWeight; | ||
| } | ||
|
|
||
| /// @dev Public function for casting an override vote | ||
| function castOverrideVote( | ||
| uint256 proposalId, | ||
| uint8 support, | ||
| string calldata reason | ||
| ) public virtual returns (uint256) { | ||
| address voter = _msgSender(); | ||
| return _castOverride(proposalId, voter, support, reason); | ||
| } | ||
|
|
||
| /// @dev Public function for casting an override vote using a voter's signature | ||
| function castOverrideVoteBySig( | ||
| uint256 proposalId, | ||
| uint8 support, | ||
| address voter, | ||
| string calldata reason, | ||
| bytes calldata signature | ||
| ) public virtual returns (uint256) { | ||
| bool valid = SignatureChecker.isValidSignatureNow( | ||
| voter, | ||
| _hashTypedDataV4( | ||
| keccak256( | ||
| abi.encode( | ||
| OVERRIDE_BALLOT_TYPEHASH, | ||
| proposalId, | ||
| support, | ||
| voter, | ||
| _useNonce(voter), | ||
| keccak256(bytes(reason)) | ||
| ) | ||
| ) | ||
| ), | ||
| signature | ||
| ); | ||
|
|
||
| if (!valid) { | ||
| revert GovernorInvalidSignature(voter); | ||
| } | ||
|
|
||
| return _castOverride(proposalId, voter, support, reason); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.