remove GovernorVotesComp and GovernorVotesComp

OpenZeppelin · May 25, 2023 · 5a7efab · 5a7efab
1 parent d1bd445
commit 5a7efab
Show file tree

Hide file tree

Showing 11 changed files with 5 additions and 813 deletions.
diff --git a/contracts/governance/README.adoc b/contracts/governance/README.adoc
@@ -22,8 +22,6 @@ Votes modules determine the source of voting power, and sometimes quorum number.
 
 * {GovernorVotes}: Extracts voting weight from an {ERC20Votes}, or since v4.5 an {ERC721Votes} token.
 
-* {GovernorVotesComp}: Extracts voting weight from a COMP-like or {ERC20VotesComp} token.
-
 * {GovernorVotesQuorumFraction}: Combines with `GovernorVotes` to set the quorum as a fraction of the total token supply.
 
 Counting modules determine valid voting options.
@@ -66,8 +64,6 @@ NOTE: Functions of the `Governor` contract do not include access control. If you
 
 {{GovernorVotesQuorumFraction}}
 
-{{GovernorVotesComp}}
-
 === Extensions
 
 {{GovernorTimelockControl}}

diff --git a/contracts/governance/extensions/GovernorVotesComp.sol b/contracts/governance/extensions/GovernorVotesComp.sol
diff --git a/contracts/mocks/governance/GovernorCompMock.sol b/contracts/mocks/governance/GovernorCompMock.sol
diff --git a/contracts/mocks/governance/GovernorCompatibilityBravoMock.sol b/contracts/mocks/governance/GovernorCompatibilityBravoMock.sol
@@ -5,13 +5,13 @@ pragma solidity ^0.8.0;
 import "../../governance/compatibility/GovernorCompatibilityBravo.sol";
 import "../../governance/extensions/GovernorTimelockCompound.sol";
 import "../../governance/extensions/GovernorSettings.sol";
-import "../../governance/extensions/GovernorVotesComp.sol";
+import "../../governance/extensions/GovernorVotes.sol";
 
 abstract contract GovernorCompatibilityBravoMock is
     GovernorCompatibilityBravo,
     GovernorSettings,
     GovernorTimelockCompound,
-    GovernorVotesComp
+    GovernorVotes
 {
     function quorum(uint256) public pure override returns (uint256) {
         return 0;

diff --git a/contracts/mocks/token/VotesTimestamp.sol b/contracts/mocks/token/VotesTimestamp.sol
@@ -3,7 +3,6 @@
 pragma solidity ^0.8.0;
 
 import "../../token/ERC20/extensions/ERC20Votes.sol";
-import "../../token/ERC20/extensions/ERC20VotesComp.sol";
 import "../../token/ERC721/extensions/ERC721Votes.sol";
 
 abstract contract ERC20VotesTimestampMock is ERC20Votes {
@@ -17,17 +16,6 @@ abstract contract ERC20VotesTimestampMock is ERC20Votes {
     }
 }
 
-abstract contract ERC20VotesCompTimestampMock is ERC20VotesComp {
-    function clock() public view virtual override returns (uint48) {
-        return SafeCast.toUint48(block.timestamp);
-    }
-
-    // solhint-disable-next-line func-name-mixedcase
-    function CLOCK_MODE() public view virtual override returns (string memory) {
-        return "mode=timestamp";
-    }
-}
-
 abstract contract ERC721VotesTimestampMock is ERC721Votes {
     function clock() public view virtual override returns (uint48) {
         return SafeCast.toUint48(block.timestamp);

diff --git a/contracts/token/ERC20/README.adoc b/contracts/token/ERC20/README.adoc
@@ -21,7 +21,6 @@ Additionally there are multiple custom extensions, including:
 * {ERC20Permit}: gasless approval of tokens (standardized as ERC2612).
 * {ERC20FlashMint}: token level support for flash loans through the minting and burning of ephemeral tokens (standardized as ERC3156).
 * {ERC20Votes}: support for voting and vote delegation.
-* {ERC20VotesComp}: support for voting and vote delegation (compatible with Compound's token, with uint96 restrictions).
 * {ERC20Wrapper}: wrapper to create an ERC20 backed by another ERC20, with deposit and withdraw methods. Useful in conjunction with {ERC20Votes}.
 * {ERC4626}: tokenized vault that manages shares (represented as ERC20) that are backed by assets (another ERC20).
 
@@ -55,8 +54,6 @@ NOTE: This core set of contracts is designed to be unopinionated, allowing devel
 
 {{ERC20Votes}}
 
-{{ERC20VotesComp}}
-
 {{ERC20Wrapper}}
 
 {{ERC20FlashMint}}

diff --git a/contracts/token/ERC20/extensions/ERC20Votes.sol b/contracts/token/ERC20/extensions/ERC20Votes.sol
@@ -11,7 +11,7 @@ import "../../../utils/math/SafeCast.sol";
  * @dev Extension of ERC20 to support Compound-like voting and delegation. This version is more generic than Compound's,
  * and supports token supply up to 2^224^ - 1, while COMP is limited to 2^96^ - 1.
  *
- * NOTE: If exact COMP compatibility is required, use the {ERC20VotesComp} variant of this module.
+ * NOTE: This contract does not provide interface compatibility with Compound's COMP token.
  *
  * This extension keeps a history (checkpoints) of each account's vote power. Vote power can be delegated either
  * by calling the {delegate} function directly, or by providing a signature to be used with {delegateBySig}. Voting

diff --git a/contracts/token/ERC20/extensions/ERC20VotesComp.sol b/contracts/token/ERC20/extensions/ERC20VotesComp.sol
diff --git a/test/governance/compatibility/GovernorCompatibilityBravo.test.js b/test/governance/compatibility/GovernorCompatibilityBravo.test.js
@@ -21,8 +21,8 @@ function makeContractAddress(creator, nonce) {
 }
 
 const TOKENS = [
-  { Token: artifacts.require('$ERC20VotesComp'), mode: 'blocknumber' },
-  { Token: artifacts.require('$ERC20VotesCompTimestampMock'), mode: 'timestamp' },
+  { Token: artifacts.require('$ERC20Votes'), mode: 'blocknumber' },
+  { Token: artifacts.require('$ERC20VotesTimestampMock'), mode: 'timestamp' },
 ];
 
 contract('GovernorCompatibilityBravo', function (accounts) {

diff --git a/test/governance/extensions/GovernorComp.test.js b/test/governance/extensions/GovernorComp.test.js