-
Notifications
You must be signed in to change notification settings - Fork 230
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: implement the governance smart-contract (#193)
* feat: implement the governance smart-contract * refactor * fix totalSuuply * basic test * happy path test * update test * add test
- Loading branch information
1 parent
89275a0
commit 39e2ec2
Showing
5 changed files
with
386 additions
and
6 deletions.
There are no files selected for viewing
121 changes: 121 additions & 0 deletions
121
packages/zevm-app-contracts/contracts/xp-nft/ZetaXPGov.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,121 @@ | ||
| // SPDX-License-Identifier: MIT | ||
| // Compatible with OpenZeppelin Contracts ^5.0.0 | ||
| pragma solidity ^0.8.20; | ||
|
|
||
| import "@openzeppelin/contracts/governance/Governor.sol"; | ||
| import "@openzeppelin/contracts/governance/extensions/GovernorSettings.sol"; | ||
| import "@openzeppelin/contracts/governance/extensions/GovernorCountingSimple.sol"; | ||
| import "@openzeppelin/contracts/governance/extensions/GovernorTimelockControl.sol"; | ||
| import "@openzeppelin/contracts/interfaces/IERC6372.sol"; | ||
|
|
||
| import "./xpNFT_V2.sol"; | ||
|
|
||
| contract ZetaXPGov is Governor, GovernorSettings, GovernorCountingSimple, GovernorTimelockControl { | ||
| bytes32 public tagValidToVote; | ||
| ZetaXP_V2 public xpNFT; | ||
| uint256 public quorumPercentage; // New state to store the quorum percentage | ||
|
|
||
| constructor( | ||
| ZetaXP_V2 _xpNFT, | ||
| TimelockController _timelock, | ||
| uint256 _quorumPercentage, // Set the quorum percentage (e.g., 4%) | ||
| bytes32 _tag | ||
| ) | ||
| Governor("ZetaXPGov") | ||
| GovernorSettings(7200 /* 1 day */, 50400 /* 1 week */, 0) | ||
| GovernorTimelockControl(_timelock) | ||
| { | ||
| xpNFT = _xpNFT; | ||
| quorumPercentage = _quorumPercentage; | ||
| tagValidToVote = _tag; | ||
| } | ||
|
|
||
| function setTagValidToVote(bytes32 _tag) external onlyGovernance { | ||
| tagValidToVote = _tag; | ||
| } | ||
|
|
||
| // Override the _getVotes function to apply custom weight based on NFT levels | ||
| function _getVotes( | ||
| address account, | ||
| uint256 blockNumber, | ||
| bytes memory params | ||
| ) internal view override returns (uint256) { | ||
| uint256 tokenId = xpNFT.tokenByUserTag(account, tagValidToVote); | ||
| uint256 level = xpNFT.getLevel(tokenId); | ||
|
|
||
| // Assign voting weight based on NFT level | ||
| if (level == 1) { | ||
| return 1; // Rosegold | ||
| } else if (level == 2) { | ||
| return 2; // Black | ||
| } else if (level == 3) { | ||
| return 3; // Green | ||
| } else { | ||
| return 0; // Silver cannot vote | ||
| } | ||
| } | ||
|
|
||
| // Manually implement the quorum function to define quorum based on the total percentage of votes | ||
| function quorum(uint256 blockNumber) public view override returns (uint256) { | ||
| uint256 totalSupply = xpNFT.totalSupply(); // Total number of NFTs in circulation | ||
| return (totalSupply * quorumPercentage) / 100; // Quorum calculation based on the percentage | ||
| } | ||
|
|
||
| // Override the _execute function to resolve the conflict | ||
| function _execute( | ||
| uint256 proposalId, | ||
| address[] memory targets, | ||
| uint256[] memory values, | ||
| bytes[] memory calldatas, | ||
| bytes32 descriptionHash | ||
| ) internal override(Governor, GovernorTimelockControl) { | ||
| super._execute(proposalId, targets, values, calldatas, descriptionHash); | ||
| } | ||
|
|
||
| // Override the supportsInterface function to resolve the conflict | ||
| function supportsInterface( | ||
| bytes4 interfaceId | ||
| ) public view override(Governor, GovernorTimelockControl) returns (bool) { | ||
| return super.supportsInterface(interfaceId); | ||
| } | ||
|
|
||
| // Implementation of clock and CLOCK_MODE functions to comply with IERC6372 | ||
| function clock() public view override returns (uint48) { | ||
| return uint48(block.timestamp); | ||
| } | ||
|
|
||
| function CLOCK_MODE() public view override returns (string memory) { | ||
| return "mode=timestamp"; | ||
| } | ||
|
|
||
| // The rest of the functions required to be overridden by Solidity | ||
|
|
||
| function votingDelay() public view override(IGovernor, GovernorSettings) returns (uint256) { | ||
| return super.votingDelay(); | ||
| } | ||
|
|
||
| function votingPeriod() public view override(IGovernor, GovernorSettings) returns (uint256) { | ||
| return super.votingPeriod(); | ||
| } | ||
|
|
||
| function state(uint256 proposalId) public view override(Governor, GovernorTimelockControl) returns (ProposalState) { | ||
| return super.state(proposalId); | ||
| } | ||
|
|
||
| function proposalThreshold() public view override(Governor, GovernorSettings) returns (uint256) { | ||
| return super.proposalThreshold(); | ||
| } | ||
|
|
||
| function _cancel( | ||
| address[] memory targets, | ||
| uint256[] memory values, | ||
| bytes[] memory calldatas, | ||
| bytes32 descriptionHash | ||
| ) internal override(Governor, GovernorTimelockControl) returns (uint256) { | ||
| return super._cancel(targets, values, calldatas, descriptionHash); | ||
| } | ||
|
|
||
| function _executor() internal view override(Governor, GovernorTimelockControl) returns (address) { | ||
| return super._executor(); | ||
| } | ||
| } |
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
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.