Skip to content

O
openzeppelin-contracts-upgradeable
Commit f130b81b by github-actions
Options

Transpile ba5c1202

parent 10f0f1a9
Showing with 309 additions and 145 deletions
contracts/governance/GovernorUpgradeable.sol
......@@ -56,6 +56,7 @@ abstract contract GovernorUpgradeable is Initializable, ContextUpgradeable, ERC1
__Context_init_unchained();
__ERC165_init_unchained();
__EIP712_init_unchained(name_, version());
__IGovernor_init_unchained();
__Governor_init_unchained(name_);
}
......@@ -145,26 +146,6 @@ abstract contract GovernorUpgradeable is Initializable, ContextUpgradeable, ERC1
}
/**
* @dev See {IGovernor-votingDelay}
*/
function votingDelay() public view virtual override returns (uint256);
/**
* @dev See {IGovernor-votingPeriod}
*/
function votingPeriod() public view virtual override returns (uint256);
/**
* @dev See {IGovernor-quorum}
*/
function quorum(uint256 blockNumber) public view virtual override returns (uint256);
/**
* @dev See {IGovernor-getVotes}
*/
function getVotes(address account, uint256 blockNumber) public view virtual override returns (uint256);
/**
* @dev Amount of votes already casted passes the threshold limit.
*/
function _quorumReached(uint256 proposalId) internal view virtual returns (bool);
......
contracts/governance/IGovernorUpgradeable.sol
......@@ -3,13 +3,20 @@
pragma solidity ^0.8.0;
import "../utils/introspection/ERC165Upgradeable.sol";
import "../proxy/utils/Initializable.sol";
/**
* @dev Interface of the {Governor} core.
*
* _Available since v4.3._
*/
interface IGovernorUpgradeable is IERC165Upgradeable {
abstract contract IGovernorUpgradeable is Initializable, IERC165Upgradeable {
function __IGovernor_init() internal initializer {
__IGovernor_init_unchained();
}
function __IGovernor_init_unchained() internal initializer {
}
enum ProposalState {
Pending,
Active,
......@@ -57,13 +64,13 @@ interface IGovernorUpgradeable is IERC165Upgradeable {
* @notice module:core
* @dev Name of the governor instance (used in building the ERC712 domain separator).
*/
function name() external view returns (string memory);
function name() public view virtual returns (string memory);
/**
* @notice module:core
* @dev Version of the governor instance (used in building the ERC712 domain separator). Default: "1"
*/
function version() external view returns (string memory);
function version() public view virtual returns (string memory);
/**
* @notice module:voting
......@@ -82,7 +89,7 @@ interface IGovernorUpgradeable is IERC165Upgradeable {
* JavaScript class.
*/
// solhint-disable-next-line func-name-mixedcase
function COUNTING_MODE() external pure returns (string memory);
function COUNTING_MODE() public pure virtual returns (string memory);
/**
* @notice module:core
......@@ -93,32 +100,32 @@ interface IGovernorUpgradeable is IERC165Upgradeable {
uint256[] calldata values,
bytes[] calldata calldatas,
bytes32 descriptionHash
) external pure returns (uint256);
) public pure virtual returns (uint256);
/**
* @notice module:core
* @dev Current state of a proposal, following Compound's convention
*/
function state(uint256 proposalId) external view returns (ProposalState);
function state(uint256 proposalId) public view virtual returns (ProposalState);
/**
* @notice module:core
* @dev block number used to retrieve user's votes and quorum.
*/
function proposalSnapshot(uint256 proposalId) external view returns (uint256);
function proposalSnapshot(uint256 proposalId) public view virtual returns (uint256);
/**
* @notice module:core
* @dev timestamp at which votes close.
*/
function proposalDeadline(uint256 proposalId) external view returns (uint256);
function proposalDeadline(uint256 proposalId) public view virtual returns (uint256);
/**
* @notice module:user-config
* @dev 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.
*/
function votingDelay() external view returns (uint256);
function votingDelay() public view virtual returns (uint256);
/**
* @notice module:user-config
......@@ -127,7 +134,7 @@ interface IGovernorUpgradeable is IERC165Upgradeable {
* Note: the {votingDelay} can delay the start of the vote. This must be considered when setting the voting
* duration compared to the voting delay.
*/
function votingPeriod() external view returns (uint256);
function votingPeriod() public view virtual returns (uint256);
/**
* @notice module:user-config
......@@ -136,7 +143,7 @@ interface IGovernorUpgradeable is IERC165Upgradeable {
* 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}).
*/
function quorum(uint256 blockNumber) external view returns (uint256);
function quorum(uint256 blockNumber) public view virtual returns (uint256);
/**
* @notice module:reputation
......@@ -145,13 +152,13 @@ interface IGovernorUpgradeable is IERC165Upgradeable {
* Note: this can be implemented in a number of ways, for example by reading the delegated balance from one (or
* multiple), {ERC20Votes} tokens.
*/
function getVotes(address account, uint256 blockNumber) external view returns (uint256);
function getVotes(address account, uint256 blockNumber) public view virtual returns (uint256);
/**
* @notice module:voting
* @dev Returns weither `account` has casted a vote on `proposalId`.
*/
function hasVoted(uint256 proposalId, address account) external view returns (bool);
function hasVoted(uint256 proposalId, address account) public view virtual returns (bool);
/**
* @dev Create a new proposal. Vote start {IGovernor-votingDelay} blocks after the proposal is created and ends
......@@ -164,7 +171,7 @@ interface IGovernorUpgradeable is IERC165Upgradeable {
uint256[] memory values,
bytes[] memory calldatas,
string memory description
) external returns (uint256 proposalId);
) public virtual returns (uint256 proposalId);
/**
* @dev Execute a successful proposal. This requiers the quorum to be reached, the vote to be successful, and the
......@@ -179,14 +186,14 @@ interface IGovernorUpgradeable is IERC165Upgradeable {
uint256[] memory values,
bytes[] memory calldatas,
bytes32 descriptionHash
) external payable returns (uint256 proposalId);
) public payable virtual returns (uint256 proposalId);
/**
* @dev Cast a vote
*
* Emits a {VoteCast} event.
*/
function castVote(uint256 proposalId, uint8 support) external returns (uint256 balance);
function castVote(uint256 proposalId, uint8 support) public virtual returns (uint256 balance);
/**
* @dev Cast a with a reason
......@@ -197,7 +204,7 @@ interface IGovernorUpgradeable is IERC165Upgradeable {
uint256 proposalId,
uint8 support,
string calldata reason
) external returns (uint256 balance);
) public virtual returns (uint256 balance);
/**
* @dev Cast a vote using the user cryptographic signature.
......@@ -210,5 +217,6 @@ interface IGovernorUpgradeable is IERC165Upgradeable {
uint8 v,
bytes32 r,
bytes32 s
) external returns (uint256 balance);
) public virtual returns (uint256 balance);
uint256[50] private __gap;
}
contracts/governance/compatibility/GovernorCompatibilityBravoUpgradeable.sol
......@@ -5,6 +5,7 @@ pragma solidity ^0.8.0;
import "../../utils/CountersUpgradeable.sol";
import "../../utils/math/SafeCastUpgradeable.sol";
import "../extensions/IGovernorTimelockUpgradeable.sol";
import "../extensions/GovernorProposalThresholdUpgradeable.sol";
import "../GovernorUpgradeable.sol";
import "./IGovernorCompatibilityBravoUpgradeable.sol";
import "../../proxy/utils/Initializable.sol";
......@@ -17,10 +18,19 @@ import "../../proxy/utils/Initializable.sol";
*
* _Available since v4.3._
*/
abstract contract GovernorCompatibilityBravoUpgradeable is Initializable, IGovernorTimelockUpgradeable, IGovernorCompatibilityBravoUpgradeable, GovernorUpgradeable {
abstract contract GovernorCompatibilityBravoUpgradeable is
Initializable, IGovernorTimelockUpgradeable,
IGovernorCompatibilityBravoUpgradeable,
GovernorUpgradeable,
GovernorProposalThresholdUpgradeable
{
function __GovernorCompatibilityBravo_init() internal initializer {
__Context_init_unchained();
__ERC165_init_unchained();
__IGovernor_init_unchained();
__IGovernorTimelock_init_unchained();
__IGovernorCompatibilityBravo_init_unchained();
__GovernorProposalThreshold_init_unchained();
__GovernorCompatibilityBravo_init_unchained();
}
......@@ -50,20 +60,6 @@ abstract contract GovernorCompatibilityBravoUpgradeable is Initializable, IGover
mapping(uint256 => ProposalDetails) private _proposalDetails;
// public for hooking
function proposalThreshold() public view virtual override returns (uint256);
// public for hooking
function proposalEta(uint256 proposalId) public view virtual override returns (uint256);
// public for hooking
function queue(
address[] memory targets,
uint256[] memory values,
bytes[] memory calldatas,
bytes32 descriptionHash
) public virtual override returns (uint256);
// solhint-disable-next-line func-name-mixedcase
function COUNTING_MODE() public pure virtual override returns (string memory) {
return "support=bravo&quorum=bravo";
......@@ -78,8 +74,9 @@ abstract contract GovernorCompatibilityBravoUpgradeable is Initializable, IGover
uint256[] memory values,
bytes[] memory calldatas,
string memory description
) public virtual override(IGovernorUpgradeable, GovernorUpgradeable) returns (uint256) {
return propose(targets, values, new string[](calldatas.length), calldatas, description);
) public virtual override(IGovernorUpgradeable, GovernorUpgradeable, GovernorProposalThresholdUpgradeable) returns (uint256) {
_storeProposal(_msgSender(), targets, values, new string[](calldatas.length), calldatas, description);
return super.propose(targets, values, calldatas, description);
}
/**
......@@ -92,14 +89,8 @@ abstract contract GovernorCompatibilityBravoUpgradeable is Initializable, IGover
bytes[] memory calldatas,
string memory description
) public virtual override returns (uint256) {
require(
getVotes(msg.sender, block.number - 1) >= proposalThreshold(),
"GovernorCompatibilityBravo: proposer votes below proposal threshold"
);
uint256 proposalId = super.propose(targets, values, _encodeCalldata(signatures, calldatas), description);
_storeProposal(proposalId, _msgSender(), targets, values, signatures, calldatas, description);
return proposalId;
_storeProposal(_msgSender(), targets, values, signatures, calldatas, description);
return propose(targets, values, _encodeCalldata(signatures, calldatas), description);
}
/**
......@@ -128,6 +119,22 @@ abstract contract GovernorCompatibilityBravoUpgradeable is Initializable, IGover
);
}
function cancel(uint256 proposalId) public virtual override {
ProposalDetails storage details = _proposalDetails[proposalId];
require(
_msgSender() == details.proposer || getVotes(details.proposer, block.number - 1) < proposalThreshold(),
"GovernorBravo: proposer above threshold"
);
_cancel(
details.targets,
details.values,
_encodeCalldata(details.signatures, details.calldatas),
details.descriptionHash
);
}
/**
* @dev Encodes calldatas with optional function signature.
*/
......@@ -141,7 +148,7 @@ abstract contract GovernorCompatibilityBravoUpgradeable is Initializable, IGover
for (uint256 i = 0; i < signatures.length; ++i) {
fullcalldatas[i] = bytes(signatures[i]).length == 0
? calldatas[i]
: abi.encodePacked(bytes4(keccak256(bytes(signatures[i]))), calldatas[i]);
: abi.encodeWithSignature(signatures[i], calldatas[i]);
}
return fullcalldatas;
......@@ -151,7 +158,6 @@ abstract contract GovernorCompatibilityBravoUpgradeable is Initializable, IGover
* @dev Store proposal metadata for later lookup
*/
function _storeProposal(
uint256 proposalId,
address proposer,
address[] memory targets,
uint256[] memory values,
......@@ -159,18 +165,32 @@ abstract contract GovernorCompatibilityBravoUpgradeable is Initializable, IGover
bytes[] memory calldatas,
string memory description
) private {
ProposalDetails storage details = _proposalDetails[proposalId];
bytes32 descriptionHash = keccak256(bytes(description));
uint256 proposalId = hashProposal(targets, values, _encodeCalldata(signatures, calldatas), descriptionHash);
details.proposer = proposer;
details.targets = targets;
details.values = values;
details.signatures = signatures;
details.calldatas = calldatas;
details.descriptionHash = keccak256(bytes(description));
ProposalDetails storage details = _proposalDetails[proposalId];
if (details.descriptionHash == bytes32(0)) {
details.proposer = proposer;
details.targets = targets;
details.values = values;
details.signatures = signatures;
details.calldatas = calldatas;
details.descriptionHash = descriptionHash;
}
}
// ==================================================== Views =====================================================
/**
* @dev Part of the Governor Bravo's interface: _"The number of votes required in order for a voter to become a proposer"_.
*/
function proposalThreshold()
public
view
virtual
override(IGovernorCompatibilityBravoUpgradeable, GovernorProposalThresholdUpgradeable)
returns (uint256);
/**
* @dev See {IGovernorCompatibilityBravo-proposals}.
*/
function proposals(uint256 proposalId)
......
contracts/governance/compatibility/IGovernorCompatibilityBravoUpgradeable.sol
......@@ -3,13 +3,21 @@
pragma solidity ^0.8.0;
import "../IGovernorUpgradeable.sol";
import "../../proxy/utils/Initializable.sol";
/**
* @dev Interface extension that adds missing functions to the {Governor} core to provide `GovernorBravo` compatibility.
*
* _Available since v4.3._
*/
interface IGovernorCompatibilityBravoUpgradeable is IGovernorUpgradeable {
abstract contract IGovernorCompatibilityBravoUpgradeable is Initializable, IGovernorUpgradeable {
function __IGovernorCompatibilityBravo_init() internal initializer {
__IGovernor_init_unchained();
__IGovernorCompatibilityBravo_init_unchained();
}
function __IGovernorCompatibilityBravo_init_unchained() internal initializer {
}
/**
* @dev Proposal structure from Compound Governor Bravo. Not actually used by the compatibility layer, as
* {{proposal}} returns a very different structure.
......@@ -44,14 +52,15 @@ interface IGovernorCompatibilityBravoUpgradeable is IGovernorUpgradeable {
/**
* @dev Part of the Governor Bravo's interface.
*/
function quorumVotes() external view returns (uint256);
function quorumVotes() public view virtual returns (uint256);
/**
* @dev Part of the Governor Bravo's interface: _"The official record of all proposals ever proposed"_.
*/
function proposals(uint256)
external
public
view
virtual
returns (
uint256 id,
address proposer,
......@@ -74,24 +83,30 @@ interface IGovernorCompatibilityBravoUpgradeable is IGovernorUpgradeable {
string[] memory signatures,
bytes[] memory calldatas,
string memory description
) external returns (uint256);
) public virtual returns (uint256);
/**
* @dev Part of the Governor Bravo's interface: _"Queues a proposal of state succeeded"_.
*/
function queue(uint256 proposalId) external;
function queue(uint256 proposalId) public virtual;
/**
* @dev Part of the Governor Bravo's interface: _"Executes a queued proposal if eta has passed"_.
*/
function execute(uint256 proposalId) external payable;
function execute(uint256 proposalId) public payable virtual;
/**
* @dev Cancels a proposal only if sender is the proposer, or proposer delegates dropped below proposal threshold.
*/
function cancel(uint256 proposalId) public virtual;
/**
* @dev Part of the Governor Bravo's interface: _"Gets actions of a proposal"_.
*/
function getActions(uint256 proposalId)
external
public
view
virtual
returns (
address[] memory targets,
uint256[] memory values,
......@@ -102,10 +117,11 @@ interface IGovernorCompatibilityBravoUpgradeable is IGovernorUpgradeable {
/**
* @dev Part of the Governor Bravo's interface: _"Gets the receipt for a voter on a given proposal"_.
*/
function getReceipt(uint256 proposalId, address voter) external view returns (Receipt memory);
function getReceipt(uint256 proposalId, address voter) public view virtual returns (Receipt memory);
/**
* @dev Part of the Governor Bravo's interface: _"The number of votes required in order for a voter to become a proposer"_.
*/
function proposalThreshold() external view returns (uint256);
function proposalThreshold() public view virtual returns (uint256);
uint256[50] private __gap;
}
contracts/governance/extensions/GovernorCountingSimpleUpgradeable.sol
......@@ -14,6 +14,7 @@ abstract contract GovernorCountingSimpleUpgradeable is Initializable, GovernorUp
function __GovernorCountingSimple_init() internal initializer {
__Context_init_unchained();
__ERC165_init_unchained();
__IGovernor_init_unchained();
__GovernorCountingSimple_init_unchained();
}
......@@ -75,9 +76,7 @@ abstract contract GovernorCountingSimpleUpgradeable is Initializable, GovernorUp
function _quorumReached(uint256 proposalId) internal view virtual override returns (bool) {
ProposalVote storage proposalvote = _proposalVotes[proposalId];
return
quorum(proposalSnapshot(proposalId)) <=
proposalvote.againstVotes + proposalvote.forVotes + proposalvote.abstainVotes;
return quorum(proposalSnapshot(proposalId)) <= proposalvote.forVotes + proposalvote.abstainVotes;
}
/**
......
contracts/governance/extensions/GovernorProposalThresholdUpgradeable.sol 0 → 100644
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;
import "../GovernorUpgradeable.sol";
import "../../proxy/utils/Initializable.sol";
/**
* @dev Extension of {Governor} for proposal restriction to token holders with a minimum balance.
*
* _Available since v4.3._
*/
abstract contract GovernorProposalThresholdUpgradeable is Initializable, GovernorUpgradeable {
function __GovernorProposalThreshold_init() internal initializer {
__Context_init_unchained();
__ERC165_init_unchained();
__EIP712_init_unchained(name_, version());
__IGovernor_init_unchained();
__GovernorProposalThreshold_init_unchained();
}
function __GovernorProposalThreshold_init_unchained() internal initializer {
}
/**
* @dev See {IGovernor-propose}.
*/
function propose(
address[] memory targets,
uint256[] memory values,
bytes[] memory calldatas,
string memory description
) public virtual override returns (uint256) {
require(
getVotes(msg.sender, block.number - 1) >= proposalThreshold(),
"GovernorCompatibilityBravo: proposer votes below proposal threshold"
);
return super.propose(targets, values, calldatas, description);
}
/**
* @dev Part of the Governor Bravo's interface: _"The number of votes required in order for a voter to become a proposer"_.
*/
function proposalThreshold() public view virtual returns (uint256);
uint256[50] private __gap;
}
contracts/governance/extensions/GovernorTimelockCompoundUpgradeable.sol
......@@ -96,6 +96,8 @@ abstract contract GovernorTimelockCompoundUpgradeable is Initializable, IGoverno
function __GovernorTimelockCompound_init(ICompoundTimelockUpgradeable timelockAddress) internal initializer {
__Context_init_unchained();
__ERC165_init_unchained();
__IGovernor_init_unchained();
__IGovernorTimelock_init_unchained();
__GovernorTimelockCompound_init_unchained(timelockAddress);
}
......
contracts/governance/extensions/GovernorTimelockControlUpgradeable.sol
......@@ -33,6 +33,8 @@ abstract contract GovernorTimelockControlUpgradeable is Initializable, IGovernor
function __GovernorTimelockControl_init(TimelockControllerUpgradeable timelockAddress) internal initializer {
__Context_init_unchained();
__ERC165_init_unchained();
__IGovernor_init_unchained();
__IGovernorTimelock_init_unchained();
__GovernorTimelockControl_init_unchained(timelockAddress);
}
......
contracts/governance/extensions/GovernorVotesCompUpgradeable.sol
......@@ -17,6 +17,7 @@ abstract contract GovernorVotesCompUpgradeable is Initializable, GovernorUpgrade
function __GovernorVotesComp_init(ERC20VotesCompUpgradeable token_) internal initializer {
__Context_init_unchained();
__ERC165_init_unchained();
__IGovernor_init_unchained();
__GovernorVotesComp_init_unchained(token_);
}
......
contracts/governance/extensions/GovernorVotesQuorumFractionUpgradeable.sol
......@@ -19,6 +19,7 @@ abstract contract GovernorVotesQuorumFractionUpgradeable is Initializable, Gover
function __GovernorVotesQuorumFraction_init(uint256 quorumNumeratorValue) internal initializer {
__Context_init_unchained();
__ERC165_init_unchained();
__IGovernor_init_unchained();
__GovernorVotesQuorumFraction_init_unchained(quorumNumeratorValue);
}
......
contracts/governance/extensions/GovernorVotesUpgradeable.sol
......@@ -18,6 +18,7 @@ abstract contract GovernorVotesUpgradeable is Initializable, GovernorUpgradeable
function __GovernorVotes_init(ERC20VotesUpgradeable tokenAddress) internal initializer {
__Context_init_unchained();
__ERC165_init_unchained();
__IGovernor_init_unchained();
__GovernorVotes_init_unchained(tokenAddress);
}
......
contracts/governance/extensions/IGovernorTimelockUpgradeable.sol
......@@ -3,23 +3,32 @@
pragma solidity ^0.8.0;
import "../IGovernorUpgradeable.sol";
import "../../proxy/utils/Initializable.sol";
/**
* @dev Extension of the {IGovernor} for timelock supporting modules.
*
* _Available since v4.3._
*/
interface IGovernorTimelockUpgradeable is IGovernorUpgradeable {
abstract contract IGovernorTimelockUpgradeable is Initializable, IGovernorUpgradeable {
function __IGovernorTimelock_init() internal initializer {
__IGovernor_init_unchained();
__IGovernorTimelock_init_unchained();
}
function __IGovernorTimelock_init_unchained() internal initializer {
}
event ProposalQueued(uint256 proposalId, uint256 eta);
function timelock() external view returns (address);
function timelock() public view virtual returns (address);
function proposalEta(uint256 proposalId) external view returns (uint256);
function proposalEta(uint256 proposalId) public view virtual returns (uint256);
function queue(
address[] calldata targets,
uint256[] calldata values,
bytes[] calldata calldatas,
address[] memory targets,
uint256[] memory values,
bytes[] memory calldatas,
bytes32 descriptionHash
) external returns (uint256 proposalId);
) public virtual returns (uint256 proposalId);
uint256[50] private __gap;
}
contracts/mocks/GovernorCompMockUpgradeable.sol
......@@ -20,6 +20,7 @@ contract GovernorCompMockUpgradeable is Initializable, GovernorUpgradeable, Gove
__Context_init_unchained();
__ERC165_init_unchained();
__EIP712_init_unchained(name_, version());
__IGovernor_init_unchained();
__Governor_init_unchained(name_);
__GovernorVotesComp_init_unchained(token_);
__GovernorCountingSimple_init_unchained();
......@@ -63,7 +64,7 @@ contract GovernorCompMockUpgradeable is Initializable, GovernorUpgradeable, Gove
public
view
virtual
override(GovernorUpgradeable, GovernorVotesCompUpgradeable)
override(IGovernorUpgradeable, GovernorVotesCompUpgradeable)
returns (uint256)
{
return super.getVotes(account, blockNumber);
......
contracts/mocks/GovernorCompatibilityBravoMockUpgradeable.sol
......@@ -23,7 +23,11 @@ contract GovernorCompatibilityBravoMockUpgradeable is Initializable, GovernorCom
__Context_init_unchained();
__ERC165_init_unchained();
__EIP712_init_unchained(name_, version());
__IGovernor_init_unchained();
__IGovernorTimelock_init_unchained();
__IGovernorCompatibilityBravo_init_unchained();
__Governor_init_unchained(name_);
__GovernorProposalThreshold_init_unchained();
__GovernorCompatibilityBravo_init_unchained();
__GovernorTimelockCompound_init_unchained(timelock_);
__GovernorVotesComp_init_unchained(token_);
......@@ -53,11 +57,11 @@ contract GovernorCompatibilityBravoMockUpgradeable is Initializable, GovernorCom
return super.supportsInterface(interfaceId);
}
function votingDelay() public view override(IGovernorUpgradeable, GovernorUpgradeable) returns (uint256) {
function votingDelay() public view override returns (uint256) {
return _votingDelay;
}
function votingPeriod() public view override(IGovernorUpgradeable, GovernorUpgradeable) returns (uint256) {
function votingPeriod() public view override returns (uint256) {
return _votingPeriod;
}
......@@ -65,7 +69,7 @@ contract GovernorCompatibilityBravoMockUpgradeable is Initializable, GovernorCom
return _proposalThreshold;
}
function quorum(uint256) public pure override(IGovernorUpgradeable, GovernorUpgradeable) returns (uint256) {
function quorum(uint256) public pure override returns (uint256) {
return 0;
}
......@@ -83,7 +87,7 @@ contract GovernorCompatibilityBravoMockUpgradeable is Initializable, GovernorCom
public
view
virtual
override(GovernorCompatibilityBravoUpgradeable, GovernorTimelockCompoundUpgradeable)
override(IGovernorTimelockUpgradeable, GovernorTimelockCompoundUpgradeable)
returns (uint256)
{
return super.proposalEta(proposalId);
......@@ -103,7 +107,7 @@ contract GovernorCompatibilityBravoMockUpgradeable is Initializable, GovernorCom
uint256[] memory values,
bytes[] memory calldatas,
bytes32 salt
) public virtual override(GovernorCompatibilityBravoUpgradeable, GovernorTimelockCompoundUpgradeable) returns (uint256) {
) public virtual override(IGovernorTimelockUpgradeable, GovernorTimelockCompoundUpgradeable) returns (uint256) {
return super.queue(targets, values, calldatas, salt);
}
......
contracts/mocks/GovernorMockUpgradeable.sol
......@@ -21,6 +21,7 @@ contract GovernorMockUpgradeable is Initializable, GovernorUpgradeable, Governor
__Context_init_unchained();
__ERC165_init_unchained();
__EIP712_init_unchained(name_, version());
__IGovernor_init_unchained();
__Governor_init_unchained(name_);
__GovernorVotes_init_unchained(token_);
__GovernorVotesQuorumFraction_init_unchained(quorumNumerator_);
......@@ -62,7 +63,7 @@ contract GovernorMockUpgradeable is Initializable, GovernorUpgradeable, Governor
public
view
virtual
override(GovernorUpgradeable, GovernorVotesUpgradeable)
override(IGovernorUpgradeable, GovernorVotesUpgradeable)
returns (uint256)
{
return super.getVotes(account, blockNumber);
......
contracts/mocks/GovernorTimelockCompoundMockUpgradeable.sol
......@@ -22,6 +22,8 @@ contract GovernorTimelockCompoundMockUpgradeable is Initializable, GovernorTimel
__Context_init_unchained();
__ERC165_init_unchained();
__EIP712_init_unchained(name_, version());
__IGovernor_init_unchained();
__IGovernorTimelock_init_unchained();
__Governor_init_unchained(name_);
__GovernorTimelockCompound_init_unchained(timelock_);
__GovernorVotes_init_unchained(token_);
......@@ -52,18 +54,18 @@ contract GovernorTimelockCompoundMockUpgradeable is Initializable, GovernorTimel
return super.supportsInterface(interfaceId);
}
function votingDelay() public view override(IGovernorUpgradeable, GovernorUpgradeable) returns (uint256) {
function votingDelay() public view override returns (uint256) {
return _votingDelay;
}
function votingPeriod() public view override(IGovernorUpgradeable, GovernorUpgradeable) returns (uint256) {
function votingPeriod() public view override returns (uint256) {
return _votingPeriod;
}
function quorum(uint256 blockNumber)
public
view
override(IGovernorUpgradeable, GovernorUpgradeable, GovernorVotesQuorumFractionUpgradeable)
override(IGovernorUpgradeable, GovernorVotesQuorumFractionUpgradeable)
returns (uint256)
{
return super.quorum(blockNumber);
......@@ -114,7 +116,7 @@ contract GovernorTimelockCompoundMockUpgradeable is Initializable, GovernorTimel
public
view
virtual
override(IGovernorUpgradeable, GovernorUpgradeable, GovernorVotesUpgradeable)
override(IGovernorUpgradeable, GovernorVotesUpgradeable)
returns (uint256)
{
return super.getVotes(account, blockNumber);
......
contracts/mocks/GovernorTimelockControlMockUpgradeable.sol
......@@ -22,6 +22,8 @@ contract GovernorTimelockControlMockUpgradeable is Initializable, GovernorTimelo
__Context_init_unchained();
__ERC165_init_unchained();
__EIP712_init_unchained(name_, version());
__IGovernor_init_unchained();
__IGovernorTimelock_init_unchained();
__Governor_init_unchained(name_);
__GovernorTimelockControl_init_unchained(timelock_);
__GovernorVotes_init_unchained(token_);
......@@ -52,18 +54,18 @@ contract GovernorTimelockControlMockUpgradeable is Initializable, GovernorTimelo
return super.supportsInterface(interfaceId);
}
function votingDelay() public view override(IGovernorUpgradeable, GovernorUpgradeable) returns (uint256) {
function votingDelay() public view override returns (uint256) {
return _votingDelay;
}
function votingPeriod() public view override(IGovernorUpgradeable, GovernorUpgradeable) returns (uint256) {
function votingPeriod() public view override returns (uint256) {
return _votingPeriod;
}
function quorum(uint256 blockNumber)
public
view
override(IGovernorUpgradeable, GovernorUpgradeable, GovernorVotesQuorumFractionUpgradeable)
override(IGovernorUpgradeable, GovernorVotesQuorumFractionUpgradeable)
returns (uint256)
{
return super.quorum(blockNumber);
......@@ -114,7 +116,7 @@ contract GovernorTimelockControlMockUpgradeable is Initializable, GovernorTimelo
public
view
virtual
override(IGovernorUpgradeable, GovernorUpgradeable, GovernorVotesUpgradeable)
override(IGovernorUpgradeable, GovernorVotesUpgradeable)
returns (uint256)
{
return super.getVotes(account, blockNumber);
......
docs/modules/ROOT/nav.adoc
......@@ -14,4 +14,6 @@
** xref:erc777.adoc[ERC777]
** xref:erc1155.adoc[ERC1155]
* xref:governance.adoc[Governance]
* xref:utilities.adoc[Utilities]
hardhat.config.js
......@@ -7,9 +7,28 @@ const fs = require('fs');
const path = require('path');
const argv = require('yargs/yargs')()
.env('')
.boolean('enableGasReport')
.boolean('ci')
.string('compileMode')
.options({
ci: {
type: 'boolean',
default: false,
},
gas: {
alias: 'enableGasReport',
type: 'boolean',
default: false,
},
mode: {
alias: 'compileMode',
type: 'string',
choices: [ 'production', 'development' ],
default: 'development',
},
compiler: {
alias: 'compileVersion',
type: 'string',
default: '0.8.3',
},
})
.argv;
require('@nomiclabs/hardhat-truffle5');
......@@ -30,7 +49,7 @@ const withOptimizations = argv.enableGasReport || argv.compileMode === 'producti
*/
module.exports = {
solidity: {
version: '0.8.3',
version: argv.compiler,
settings: {
optimizer: {
enabled: withOptimizations,
......
scripts/upgradeable/patch/05-fix-governor-initializers.patch
......@@ -7,9 +7,9 @@ index 1f6895a6..86518b84 100644
__Context_init_unchained();
__ERC165_init_unchained();
- __EIP712_init_unchained(name_, version());
__GovernorCompatibilityBravo_init_unchained();
}
__IGovernor_init_unchained();
__IGovernorTimelock_init_unchained();
__IGovernorCompatibilityBravo_init_unchained();
diff --git a/contracts/governance/extensions/GovernorCountingSimpleUpgradeable.sol b/contracts/governance/extensions/GovernorCountingSimpleUpgradeable.sol
index 4873166b..6a88e6b4 100644
--- a/contracts/governance/extensions/GovernorCountingSimpleUpgradeable.sol
......@@ -19,9 +19,9 @@ index 4873166b..6a88e6b4 100644
__Context_init_unchained();
__ERC165_init_unchained();
- __EIP712_init_unchained(name_, version());
__IGovernor_init_unchained();
__GovernorCountingSimple_init_unchained();
}
diff --git a/contracts/governance/extensions/GovernorTimelockCompoundUpgradeable.sol b/contracts/governance/extensions/GovernorTimelockCompoundUpgradeable.sol
index c6ed355a..9236c546 100644
--- a/contracts/governance/extensions/GovernorTimelockCompoundUpgradeable.sol
......@@ -31,9 +31,9 @@ index c6ed355a..9236c546 100644
__Context_init_unchained();
__ERC165_init_unchained();
- __EIP712_init_unchained(name_, version());
__IGovernor_init_unchained();
__IGovernorTimelock_init_unchained();
__GovernorTimelockCompound_init_unchained(timelockAddress);
}
diff --git a/contracts/governance/extensions/GovernorTimelockControlUpgradeable.sol b/contracts/governance/extensions/GovernorTimelockControlUpgradeable.sol
index 3d6a5de5..ad5f505e 100644
--- a/contracts/governance/extensions/GovernorTimelockControlUpgradeable.sol
......@@ -43,9 +43,9 @@ index 3d6a5de5..ad5f505e 100644
__Context_init_unchained();
__ERC165_init_unchained();
- __EIP712_init_unchained(name_, version());
__IGovernor_init_unchained();
__IGovernorTimelock_init_unchained();
__GovernorTimelockControl_init_unchained(timelockAddress);
}
diff --git a/contracts/governance/extensions/GovernorVotesCompUpgradeable.sol b/contracts/governance/extensions/GovernorVotesCompUpgradeable.sol
index cc83b3ed..5398f15b 100644
--- a/contracts/governance/extensions/GovernorVotesCompUpgradeable.sol
......@@ -55,9 +55,9 @@ index cc83b3ed..5398f15b 100644
__Context_init_unchained();
__ERC165_init_unchained();
- __EIP712_init_unchained(name_, version());
__IGovernor_init_unchained();
__GovernorVotesComp_init_unchained(token_);
}
diff --git a/contracts/governance/extensions/GovernorVotesQuorumFractionUpgradeable.sol b/contracts/governance/extensions/GovernorVotesQuorumFractionUpgradeable.sol
index 5d7a88bc..39f97903 100644
--- a/contracts/governance/extensions/GovernorVotesQuorumFractionUpgradeable.sol
......@@ -67,9 +67,9 @@ index 5d7a88bc..39f97903 100644
__Context_init_unchained();
__ERC165_init_unchained();
- __EIP712_init_unchained(name_, version());
__IGovernor_init_unchained();
__GovernorVotesQuorumFraction_init_unchained(quorumNumeratorValue);
}
diff --git a/contracts/governance/extensions/GovernorVotesUpgradeable.sol b/contracts/governance/extensions/GovernorVotesUpgradeable.sol
index cdfd0ae7..48408d9c 100644
--- a/contracts/governance/extensions/GovernorVotesUpgradeable.sol
......@@ -79,6 +79,6 @@ index cdfd0ae7..48408d9c 100644
__Context_init_unchained();
__ERC165_init_unchained();
- __EIP712_init_unchained(name_, version());
__IGovernor_init_unchained();
__GovernorVotes_init_unchained(tokenAddress);
}
test/governance/Governor.test.js
......@@ -29,7 +29,7 @@ contract('Governor', function (accounts) {
beforeEach(async function () {
this.owner = owner;
this.token = await Token.new(tokenName, tokenSymbol);
this.mock = await Governor.new(name, this.token.address, 4, 16, 0);
this.mock = await Governor.new(name, this.token.address, 4, 16, 10);
this.receiver = await CallReceiver.new();
await this.token.mint(owner, tokenSupply);
await this.token.delegate(voter1, { from: voter1 });
......@@ -72,7 +72,7 @@ contract('Governor', function (accounts) {
tokenHolder: owner,
voters: [
{ voter: voter1, weight: web3.utils.toWei('1'), support: Enums.VoteType.For, reason: 'This is nice' },
{ voter: voter2, weight: web3.utils.toWei('10'), support: Enums.VoteType.For },
{ voter: voter2, weight: web3.utils.toWei('7'), support: Enums.VoteType.For },
{ voter: voter3, weight: web3.utils.toWei('5'), support: Enums.VoteType.Against },
{ voter: voter4, weight: web3.utils.toWei('2'), support: Enums.VoteType.Abstain },
],
......@@ -194,7 +194,7 @@ contract('Governor', function (accounts) {
],
tokenHolder: owner,
voters: [
{ voter: this.voter, signature, weight: web3.utils.toWei('1'), support: Enums.VoteType.For },
{ voter: this.voter, signature, weight: web3.utils.toWei('10'), support: Enums.VoteType.For },
],
};
});
......@@ -252,8 +252,8 @@ contract('Governor', function (accounts) {
],
tokenHolder: owner,
voters: [
{ voter: voter1, weight: web3.utils.toWei('1'), support: Enums.VoteType.For },
{ voter: voter2, weight: web3.utils.toWei('1'), support: Enums.VoteType.Abstain },
{ voter: voter1, weight: web3.utils.toWei('5'), support: Enums.VoteType.For },
{ voter: voter2, weight: web3.utils.toWei('5'), support: Enums.VoteType.Abstain },
],
};
});
......@@ -285,7 +285,7 @@ contract('Governor', function (accounts) {
],
tokenHolder: owner,
voters: [
{ voter: voter1, weight: web3.utils.toWei('1'), support: Enums.VoteType.For },
{ voter: voter1, weight: web3.utils.toWei('10'), support: Enums.VoteType.For },
],
steps: {
execute: { error: 'Governor: call reverted without message' },
......@@ -306,7 +306,7 @@ contract('Governor', function (accounts) {
],
tokenHolder: owner,
voters: [
{ voter: voter1, weight: web3.utils.toWei('1'), support: Enums.VoteType.For },
{ voter: voter1, weight: web3.utils.toWei('10'), support: Enums.VoteType.For },
],
steps: {
execute: { error: 'CallReceiverMock: reverting' },
......@@ -329,13 +329,13 @@ contract('Governor', function (accounts) {
voters: [
{
voter: voter1,
weight: web3.utils.toWei('1'),
weight: web3.utils.toWei('5'),
support: Enums.VoteType.For,
error: 'Governor: unknown proposal id',
},
{
voter: voter2,
weight: web3.utils.toWei('1'),
weight: web3.utils.toWei('5'),
support: Enums.VoteType.Abstain,
error: 'Governor: unknown proposal id',
},
......@@ -382,8 +382,8 @@ contract('Governor', function (accounts) {
],
tokenHolder: owner,
voters: [
{ voter: voter1, weight: web3.utils.toWei('1'), support: Enums.VoteType.For },
{ voter: voter2, weight: web3.utils.toWei('1'), support: Enums.VoteType.Abstain },
{ voter: voter1, weight: web3.utils.toWei('5'), support: Enums.VoteType.For },
{ voter: voter2, weight: web3.utils.toWei('5'), support: Enums.VoteType.Abstain },
],
};
});
......@@ -406,7 +406,7 @@ contract('Governor', function (accounts) {
voters: [
{
voter: voter1,
weight: web3.utils.toWei('1'),
weight: web3.utils.toWei('10'),
support: new BN('255'),
error: 'GovernorVotingSimple: invalid value for enum VoteType',
},
......@@ -433,12 +433,12 @@ contract('Governor', function (accounts) {
voters: [
{
voter: voter1,
weight: web3.utils.toWei('1'),
weight: web3.utils.toWei('5'),
support: Enums.VoteType.For,
},
{
voter: voter1,
weight: web3.utils.toWei('1'),
weight: web3.utils.toWei('5'),
support: Enums.VoteType.For,
error: 'GovernorVotingSimple: vote already casted',
},
......@@ -459,7 +459,9 @@ contract('Governor', function (accounts) {
],
tokenHolder: owner,
voters: [
{ voter: voter1, weight: web3.utils.toWei('0'), support: Enums.VoteType.For },
{ voter: voter1, weight: web3.utils.toWei('5'), support: Enums.VoteType.For },
{ voter: voter2, weight: web3.utils.toWei('4'), support: Enums.VoteType.Abstain },
{ voter: voter3, weight: web3.utils.toWei('10'), support: Enums.VoteType.Against },
],
steps: {
execute: { error: 'Governor: proposal not successful' },
......@@ -480,7 +482,7 @@ contract('Governor', function (accounts) {
],
tokenHolder: owner,
voters: [
{ voter: voter1, weight: web3.utils.toWei('1'), support: Enums.VoteType.Against },
{ voter: voter1, weight: web3.utils.toWei('10'), support: Enums.VoteType.Against },
],
steps: {
execute: { error: 'Governor: proposal not successful' },
......@@ -501,7 +503,7 @@ contract('Governor', function (accounts) {
],
tokenHolder: owner,
voters: [
{ voter: voter1, weight: web3.utils.toWei('1'), support: Enums.VoteType.For },
{ voter: voter1, weight: web3.utils.toWei('10'), support: Enums.VoteType.For },
],
steps: {
wait: { enable: false },
......@@ -593,7 +595,7 @@ contract('Governor', function (accounts) {
],
tokenHolder: owner,
voters: [
{ voter: voter1, weight: web3.utils.toWei('1'), support: Enums.VoteType.For },
{ voter: voter1, weight: web3.utils.toWei('10'), support: Enums.VoteType.For },
],
steps: {
execute: { enable: false },
......@@ -617,7 +619,7 @@ contract('Governor', function (accounts) {
],
tokenHolder: owner,
voters: [
{ voter: voter1, weight: web3.utils.toWei('1'), support: Enums.VoteType.For },
{ voter: voter1, weight: web3.utils.toWei('10'), support: Enums.VoteType.For },
],
};
});
......@@ -692,7 +694,7 @@ contract('Governor', function (accounts) {
],
tokenHolder: owner,
voters: [
{ voter: voter1, weight: web3.utils.toWei('1'), support: Enums.VoteType.For },
{ voter: voter1, weight: web3.utils.toWei('10'), support: Enums.VoteType.For },
],
steps: {
wait: { enable: false },
......@@ -723,7 +725,7 @@ contract('Governor', function (accounts) {
],
tokenHolder: owner,
voters: [
{ voter: voter1, weight: web3.utils.toWei('1'), support: Enums.VoteType.For },
{ voter: voter1, weight: web3.utils.toWei('10'), support: Enums.VoteType.For },
],
steps: {
execute: { enable: false },
......@@ -753,7 +755,7 @@ contract('Governor', function (accounts) {
],
tokenHolder: owner,
voters: [
{ voter: voter1, weight: web3.utils.toWei('1'), support: Enums.VoteType.For },
{ voter: voter1, weight: web3.utils.toWei('10'), support: Enums.VoteType.For },
],
};
});
......
test/governance/compatibility/GovernorCompatibilityBravo.test.js
......@@ -215,6 +215,51 @@ contract('GovernorCompatibilityBravo', function (accounts) {
runGovernorWorkflow();
});
describe('cancel', function () {
beforeEach(async function () {
this.settings = {
proposal: [
[ this.receiver.address ], // targets
[ web3.utils.toWei('0') ], // values
[ this.receiver.contract.methods.mockFunction().encodeABI() ], // calldatas
'<proposal description>', // description
],
proposer,
tokenHolder: owner,
steps: {
wait: { enable: false },
queue: { enable: false },
execute: { enable: false },
},
};
});
describe('by proposer', function () {
afterEach(async function () {
await this.mock.cancel(this.id, { from: proposer });
});
runGovernorWorkflow();
});
describe('if proposer below threshold', function () {
afterEach(async function () {
await this.token.transfer(voter1, web3.utils.toWei('1'), { from: proposer });
await this.mock.cancel(this.id);
});
runGovernorWorkflow();
});
describe('not if proposer above threshold', function () {
afterEach(async function () {
await expectRevert(
this.mock.cancel(this.id),
'GovernorBravo: proposer above threshold',
);
});
runGovernorWorkflow();
});
});
describe('with compatibility interface', function () {
beforeEach(async function () {
this.settings = {
......
test/token/ERC721/ERC721.behavior.js
......@@ -678,7 +678,7 @@ function shouldBehaveLikeERC721 (errorPrefix, owner, newOwner, approved, another
describe('_burn', function () {
it('reverts when burning a non-existent token id', async function () {
await expectRevert(
this.token.burn(firstTokenId), 'ERC721: owner query for nonexistent token',
this.token.burn(nonExistentTokenId), 'ERC721: owner query for nonexistent token',
);
});
......
test/utils/introspection/SupportsInterface.behavior.js
......@@ -100,7 +100,7 @@ function shouldSupportInterfaces (interfaces = []) {
expect(await this.contractUnderTest.supportsInterface.estimateGas(interfaceId)).to.be.lte(30000);
});
it('claims support', async function () {
it('claims support [skip-on-coverage]', async function () {
expect(await this.contractUnderTest.supportsInterface(interfaceId)).to.equal(true);
});
});
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment