Rename governor extension data extension to params

OpenZeppelin · Jan 17, 2022 · ae3119a · ae3119a
1 parent bcddb1e
commit ae3119a
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 34 deletions.
diff --git a/contracts/governance/Governor.sol b/contracts/governance/Governor.sol
@@ -68,10 +68,10 @@ abstract contract Governor is Context, ERC165, EIP712, IGovernor {
      */
     function supportsInterface(bytes4 interfaceId) public view virtual override(IERC165, ERC165) returns (bool) {
         // In addition to the current interfaceId, also support previous version of the interfaceId that did not
-        // include the castVoteWithData() and castVoteWithReasonAndData() functions as standard
+        // include the castVoteWithParams() and castVoteWithReasonAndParams() functions as standard
         return
             interfaceId ==
-            (type(IGovernor).interfaceId ^ this.castVoteWithReasonAndData.selector ^ this.castVoteWithData.selector) ||
+            (type(IGovernor).interfaceId ^ this.castVoteWithReasonAndParams.selector ^ this.castVoteWithParams.selector) ||
             interfaceId == type(IGovernor).interfaceId ||
             super.supportsInterface(interfaceId);
     }
@@ -190,7 +190,7 @@ abstract contract Governor is Context, ERC165, EIP712, IGovernor {
         address account,
         uint8 support,
         uint256 weight,
-        bytes memory data
+        bytes memory params
     ) internal virtual;
 
     /**
@@ -314,15 +314,15 @@ abstract contract Governor is Context, ERC165, EIP712, IGovernor {
     }
 
     /**
-     * @dev See {IGovernor-castVoteWithData}.
+     * @dev See {IGovernor-castVoteWithParams}.
      */
-    function castVoteWithData(
+    function castVoteWithParams(
         uint256 proposalId,
         uint8 support,
-        bytes memory data
+        bytes memory params
     ) public virtual override returns (uint256) {
         address voter = _msgSender();
-        return _castVote(proposalId, voter, support, "", data);
+        return _castVote(proposalId, voter, support, "", params);
     }
 
     /**
@@ -333,20 +333,20 @@ abstract contract Governor is Context, ERC165, EIP712, IGovernor {
         uint8 support,
         string calldata reason
     ) public virtual override returns (uint256) {
-        return castVoteWithReasonAndData(proposalId, support, reason, "");
+        return castVoteWithReasonAndParams(proposalId, support, reason, "");
     }
 
     /**
-     * @dev See {IGovernor-castVoteWithReasonAndData}.
+     * @dev See {IGovernor-castVoteWithReasonAndParams}.
      */
-    function castVoteWithReasonAndData(
+    function castVoteWithReasonAndParams(
         uint256 proposalId,
         uint8 support,
         string calldata reason,
-        bytes memory data
+        bytes memory params
     ) public virtual override returns (uint256) {
         address voter = _msgSender();
-        return _castVote(proposalId, voter, support, reason, data);
+        return _castVote(proposalId, voter, support, reason, params);
     }
 
     /**
@@ -379,13 +379,13 @@ abstract contract Governor is Context, ERC165, EIP712, IGovernor {
         address account,
         uint8 support,
         string memory reason,
-        bytes memory data
+        bytes memory params
     ) internal virtual returns (uint256) {
         ProposalCore storage proposal = _proposals[proposalId];
         require(state(proposalId) == ProposalState.Active, "Governor: vote not currently active");
 
         uint256 weight = getVotes(account, proposal.voteStart.getDeadline());
-        _countVote(proposalId, account, support, weight, data);
+        _countVote(proposalId, account, support, weight, params);
 
         emit VoteCast(account, proposalId, support, weight, reason);
 

diff --git a/contracts/governance/IGovernor.sol b/contracts/governance/IGovernor.sol
@@ -193,14 +193,14 @@ abstract contract IGovernor is IERC165 {
     function castVote(uint256 proposalId, uint8 support) public virtual returns (uint256 balance);
 
     /**
-     * @dev Cast a vote with contextual data
+     * @dev Cast a vote with additional encoded parameters
      *
      * Emits a {VoteCast} event.
      */
-    function castVoteWithData(
+    function castVoteWithParams(
         uint256 proposalId,
         uint8 support,
-        bytes memory data
+        bytes memory params
     ) public virtual returns (uint256 balance);
 
     /**
@@ -215,15 +215,15 @@ abstract contract IGovernor is IERC165 {
     ) public virtual returns (uint256 balance);
 
     /**
-     * @dev Cast a vote with a reason and contextual data
+     * @dev Cast a vote with a reason and additional encoded parameters
      *
      * Emits a {VoteCast} event.
      */
-    function castVoteWithReasonAndData(
+    function castVoteWithReasonAndParams(
         uint256 proposalId,
         uint8 support,
         string calldata reason,
-        bytes memory data
+        bytes memory params
     ) public virtual returns (uint256 balance);
 
     /**

diff --git a/contracts/governance/compatibility/GovernorCompatibilityBravo.sol b/contracts/governance/compatibility/GovernorCompatibilityBravo.sol
@@ -266,9 +266,9 @@ abstract contract GovernorCompatibilityBravo is IGovernorTimelock, IGovernorComp
         address account,
         uint8 support,
         uint256 weight,
-        bytes memory data
+        bytes memory params
     ) internal virtual override {
-        (data); // silence compiler warnings
+        (params); // silence compiler warnings
 
         ProposalDetails storage details = _proposalDetails[proposalId];
         Receipt storage receipt = details.receipts[account];

diff --git a/contracts/governance/extensions/GovernorCountingSimple.sol b/contracts/governance/extensions/GovernorCountingSimple.sol
@@ -87,9 +87,9 @@ abstract contract GovernorCountingSimple is Governor {
         address account,
         uint8 support,
         uint256 weight,
-        bytes memory data
+        bytes memory params
     ) internal virtual override {
-        (data); // silence compiler warnings
+        (params); // silence compiler warnings
         ProposalVote storage proposalvote = _proposalVotes[proposalId];
 
         require(!proposalvote.hasVoted[account], "GovernorVotingSimple: vote already cast");

diff --git a/contracts/governance/extensions/GovernorPreventLateQuorum.sol b/contracts/governance/extensions/GovernorPreventLateQuorum.sol
@@ -57,9 +57,9 @@ abstract contract GovernorPreventLateQuorum is Governor {
         address account,
         uint8 support,
         string memory reason,
-        bytes memory data
+        bytes memory params
     ) internal virtual override returns (uint256) {
-        uint256 result = super._castVote(proposalId, account, support, reason, data);
+        uint256 result = super._castVote(proposalId, account, support, reason, params);
 
         Timers.BlockNumber storage extendedDeadline = _extendedDeadlines[proposalId];
 

diff --git a/contracts/mocks/GovernorPreventLateQuorumMock.sol b/contracts/mocks/GovernorPreventLateQuorumMock.sol
@@ -54,8 +54,8 @@ contract GovernorPreventLateQuorumMock is
         address account,
         uint8 support,
         string memory reason,
-        bytes memory data
+        bytes memory params
     ) internal virtual override(Governor, GovernorPreventLateQuorum) returns (uint256) {
-        return super._castVote(proposalId, account, support, reason, data);
+        return super._castVote(proposalId, account, support, reason, params);
     }
 }
diff --git a/test/governance/Governor.test.js b/test/governance/Governor.test.js
@@ -41,7 +41,7 @@ contract('Governor', function (accounts) {
   shouldSupportInterfaces([
     'ERC165',
     'Governor',
-    'GovernorWithData',
+    'GovernorWithParams',
   ]);
 
   it('deployment check', async function () {

diff --git a/test/governance/extensions/GovernorTimelockCompound.test.js b/test/governance/extensions/GovernorTimelockCompound.test.js
@@ -48,7 +48,7 @@ contract('GovernorTimelockCompound', function (accounts) {
   shouldSupportInterfaces([
     'ERC165',
     'Governor',
-    'GovernorWithData',
+    'GovernorWithParams',
     'GovernorTimelock',
   ]);
 

diff --git a/test/governance/extensions/GovernorTimelockControl.test.js b/test/governance/extensions/GovernorTimelockControl.test.js
@@ -43,7 +43,7 @@ contract('GovernorTimelockControl', function (accounts) {
   shouldSupportInterfaces([
     'ERC165',
     'Governor',
-    'GovernorWithData',
+    'GovernorWithParams',
     'GovernorTimelock',
   ]);
 

diff --git a/test/utils/introspection/SupportsInterface.behavior.js b/test/utils/introspection/SupportsInterface.behavior.js
@@ -69,7 +69,7 @@ const INTERFACES = {
     'castVoteWithReason(uint256,uint8,string)',
     'castVoteBySig(uint256,uint8,uint8,bytes32,bytes32)',
   ],
-  GovernorWithData: [
+  GovernorWithParams: [
     'name()',
     'version()',
     'COUNTING_MODE()',
@@ -85,9 +85,9 @@ const INTERFACES = {
     'propose(address[],uint256[],bytes[],string)',
     'execute(address[],uint256[],bytes[],bytes32)',
     'castVote(uint256,uint8)',
-    'castVoteWithData(uint256,uint8,bytes)',
+    'castVoteWithParams(uint256,uint8,bytes)',
     'castVoteWithReason(uint256,uint8,string)',
-    'castVoteWithReasonAndData(uint256,uint8,string,bytes)',
+    'castVoteWithReasonAndParams(uint256,uint8,string,bytes)',
     'castVoteBySig(uint256,uint8,uint8,bytes32,bytes32)',
   ],
   GovernorTimelock: [