Update OpenZeppelin version to the latest commit (~5.0.0), update Sol…

…idity version to 0.8.20, update code and test for MetaTxModule, replace _beforeTokenTransfer by _update
CMTA · Aug 9, 2023 · 11307e4 · 11307e4
1 parent 9f40618
commit 11307e4
Show file tree

Hide file tree

Showing 37 changed files with 749 additions and 6,512 deletions.
diff --git a/contracts/CMTAT_PROXY.sol b/contracts/CMTAT_PROXY.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "./modules/CMTAT_BASE.sol";
 

diff --git a/contracts/CMTAT_STANDALONE.sol b/contracts/CMTAT_STANDALONE.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "./modules/CMTAT_BASE.sol";
 

diff --git a/contracts/mocks/MinimalForwarderMock.sol b/contracts/mocks/MinimalForwarderMock.sol
@@ -1,11 +1,12 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
-import "../../openzeppelin-contracts-upgradeable/contracts/metatx/MinimalForwarderUpgradeable.sol";
+import "../../openzeppelin-contracts-upgradeable/contracts/metatx/ERC2771ForwarderUpgradeable.sol";
 
-contract MinimalForwarderMock is MinimalForwarderUpgradeable {
-    function initialize() public initializer {
-        __MinimalForwarder_init();
+contract MinimalForwarderMock is ERC2771ForwarderUpgradeable {
+    function initialize(string memory name) public initializer {
+        __EIP712_init_unchained(name, "1");
+        __ERC2771Forwarder_init_unchained("");
     }
 }
diff --git a/contracts/mocks/RuleEngine/CodeList.sol b/contracts/mocks/RuleEngine/CodeList.sol
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 abstract contract CodeList {
     // Used by RuleMock.sol

diff --git a/contracts/mocks/RuleEngine/RuleEngineMock.sol b/contracts/mocks/RuleEngine/RuleEngineMock.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "./interfaces/IRule.sol";
 import "./interfaces/IRuleEngine.sol";

diff --git a/contracts/mocks/RuleEngine/RuleMock.sol b/contracts/mocks/RuleEngine/RuleMock.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "./interfaces/IRule.sol";
 import "./CodeList.sol";

diff --git a/contracts/modules/CMTAT_BASE.sol b/contracts/modules/CMTAT_BASE.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 // required OZ imports here
 import "../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
@@ -176,17 +176,20 @@ abstract contract CMTAT_BASE is
     * e.g. override(SnapshotModuleInternal, ERC20Upgradeable)
     * - remove the keyword view
     */
-    function _beforeTokenTransfer(
+    function _update(
         address from,
         address to,
         uint256 amount
-    ) internal view override(ERC20Upgradeable) {
-        if(!ValidationModule.validateTransfer(from, to, amount)) revert Errors.InvalidTransfer(from, to, amount);
+    ) internal override(ERC20Upgradeable) {
+        if(!ValidationModule.validateTransfer(from, to, amount)) {
+            revert Errors.InvalidTransfer(from, to, amount);
+        }
+        ERC20Upgradeable._update(from, to, amount);
         // We call the SnapshotModule only if the transfer is valid
         /*
         SnapshotModule:
         Add this call in case you add the SnapshotModule
-        SnapshotModuleInternal._beforeTokenTransfer(from, to, amount);
+        SnapshotModuleInternal._update(from, to, amount);
         */
     }
 

diff --git a/contracts/modules/internal/EnforcementModuleInternal.sol b/contracts/modules/internal/EnforcementModuleInternal.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../../openzeppelin-contracts-upgradeable/contracts/utils/ContextUpgradeable.sol";
 import "../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";

diff --git a/contracts/modules/internal/SnapshotModuleInternal.sol b/contracts/modules/internal/SnapshotModuleInternal.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../../openzeppelin-contracts-upgradeable/contracts/utils/ContextUpgradeable.sol";
 import "../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
@@ -255,12 +255,12 @@ abstract contract SnapshotModuleInternal is ERC20Upgradeable {
     @dev Update balance and/or total supply snapshots before the values are modified. This is implemented
     in the _beforeTokenTransfer hook, which is executed for _mint, _burn, and _transfer operations.
     */
-    function _beforeTokenTransfer(
+    function _update(
         address from,
         address to,
         uint256 amount
     ) internal virtual override {
-        super._beforeTokenTransfer(from, to, amount);
+        super._update(from, to, amount);
 
         _setCurrentSnapshot();
         if (from != address(0)) {

diff --git a/contracts/modules/internal/ValidationModuleInternal.sol b/contracts/modules/internal/ValidationModuleInternal.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../../openzeppelin-contracts-upgradeable/contracts/utils/ContextUpgradeable.sol";
 import "../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";

diff --git a/contracts/modules/security/AuthorizationModule.sol b/contracts/modules/security/AuthorizationModule.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../../openzeppelin-contracts-upgradeable/contracts/access/AccessControlUpgradeable.sol";
 import "../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";

diff --git a/contracts/modules/security/OnlyDelegateCallModule.sol b/contracts/modules/security/OnlyDelegateCallModule.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../libraries/Errors.sol";
 

diff --git a/contracts/modules/wrapper/mandatory/BaseModule.sol b/contracts/modules/wrapper/mandatory/BaseModule.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 // required OZ imports here
 import "../../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
@@ -103,7 +103,9 @@ abstract contract BaseModule is AuthorizationModule, OnlyDelegateCallModule {
     @notice The call will be reverted if the new value of flag is the same as the current one
     */
     function setFlag(uint256 flag_) public onlyRole(DEFAULT_ADMIN_ROLE) {
-        if(flag == flag_) revert Errors.SameValue();
+        if(flag == flag_) {
+            revert Errors.SameValue();
+        }
         flag = flag_;
         emit Flag(flag_);
     }

diff --git a/contracts/modules/wrapper/mandatory/BurnModule.sol b/contracts/modules/wrapper/mandatory/BurnModule.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../../../openzeppelin-contracts-upgradeable/contracts/token/ERC20/ERC20Upgradeable.sol";
 import "../../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";

diff --git a/contracts/modules/wrapper/mandatory/ERC20BaseModule.sol b/contracts/modules/wrapper/mandatory/ERC20BaseModule.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 // required OZ imports here
 import "../../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";

diff --git a/contracts/modules/wrapper/mandatory/EnforcementModule.sol b/contracts/modules/wrapper/mandatory/EnforcementModule.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../../../openzeppelin-contracts-upgradeable/contracts/security/PausableUpgradeable.sol";
 import "../../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";

diff --git a/contracts/modules/wrapper/mandatory/MintModule.sol b/contracts/modules/wrapper/mandatory/MintModule.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../../../openzeppelin-contracts-upgradeable/contracts/token/ERC20/ERC20Upgradeable.sol";
 import "../../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";

diff --git a/contracts/modules/wrapper/mandatory/PauseModule.sol b/contracts/modules/wrapper/mandatory/PauseModule.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../../../openzeppelin-contracts-upgradeable/contracts/security/PausableUpgradeable.sol";
 import "../../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";

diff --git a/contracts/modules/wrapper/optional/DebtModule/CreditEventsModule.sol b/contracts/modules/wrapper/optional/DebtModule/CreditEventsModule.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../../../../openzeppelin-contracts-upgradeable/contracts/access/AccessControlUpgradeable.sol";
 import "../../../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
@@ -64,7 +64,9 @@ abstract contract CreditEventsModule is
     function setFlagDefault(
         bool flagDefault_
     ) public onlyRole(DEBT_CREDIT_EVENT_ROLE) {
-        if(flagDefault_ == creditEvents.flagDefault) revert Errors.SameValue();
+        if(flagDefault_ == creditEvents.flagDefault) {
+            revert Errors.SameValue();
+        }
         creditEvents.flagDefault = flagDefault_;
         emit FlagDefault(flagDefault_);
     }
@@ -75,7 +77,9 @@ abstract contract CreditEventsModule is
     function setFlagRedeemed(
         bool flagRedeemed_
     ) public onlyRole(DEBT_CREDIT_EVENT_ROLE) {
-        if(flagRedeemed_ == creditEvents.flagRedeemed) revert Errors.SameValue();
+        if(flagRedeemed_ == creditEvents.flagRedeemed) {
+            revert Errors.SameValue();
+        }
         creditEvents.flagRedeemed = flagRedeemed_;
         emit FlagRedeemed(flagRedeemed_);
     }

diff --git a/contracts/modules/wrapper/optional/DebtModule/DebtBaseModule.sol b/contracts/modules/wrapper/optional/DebtModule/DebtBaseModule.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../../../../openzeppelin-contracts-upgradeable/contracts/access/AccessControlUpgradeable.sol";
 import "../../../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
@@ -133,7 +133,9 @@ abstract contract DebtBaseModule is
     @notice The call will be reverted if the new value of interestRate is the same as the current one
     */
     function setInterestRate(uint256 interestRate_) public onlyRole(DEBT_ROLE) {
-        if(interestRate_ == debt.interestRate) revert Errors.SameValue();
+        if(interestRate_ == debt.interestRate) {
+            revert Errors.SameValue();
+        }
         debt.interestRate = interestRate_;
         emit InterestRate(interestRate_);
     }
@@ -142,7 +144,9 @@ abstract contract DebtBaseModule is
     @notice The call will be reverted if the new value of parValue is the same as the current one
     */
     function setParValue(uint256 parValue_) public onlyRole(DEBT_ROLE) {
-        if(parValue_ == debt.parValue) revert Errors.SameValue();
+        if(parValue_ == debt.parValue) {
+            revert Errors.SameValue();
+        }
         debt.parValue = parValue_;
         emit ParValue(parValue_);
     }

diff --git a/contracts/modules/wrapper/optional/MetaTxModule.sol b/contracts/modules/wrapper/optional/MetaTxModule.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../../../openzeppelin-contracts-upgradeable/contracts/metatx/ERC2771ContextUpgradeable.sol";
 import "../../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";

diff --git a/contracts/modules/wrapper/optional/SnapshotModule.sol b/contracts/modules/wrapper/optional/SnapshotModule.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
 import "../../security/AuthorizationModule.sol";

diff --git a/contracts/modules/wrapper/optional/ValidationModule.sol b/contracts/modules/wrapper/optional/ValidationModule.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "../../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
 import "../../security/AuthorizationModule.sol";

diff --git a/contracts/test/CMTATSnapshot/CMTATSnapshotProxyTest.sol b/contracts/test/CMTATSnapshot/CMTATSnapshotProxyTest.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "./CMTAT_BASE_SnapshotTest.sol";
 

diff --git a/contracts/test/CMTATSnapshot/CMTATSnapshotStandaloneTest.sol b/contracts/test/CMTATSnapshot/CMTATSnapshotStandaloneTest.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 import "./CMTAT_BASE_SnapshotTest.sol";
 

diff --git a/contracts/test/CMTATSnapshot/CMTAT_BASE_SnapshotTest.sol b/contracts/test/CMTATSnapshot/CMTAT_BASE_SnapshotTest.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 // required OZ imports here
 import "../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
@@ -168,7 +168,7 @@ abstract contract CMTAT_BASE_SnapshotTest is
     e.g. override(SnapshotModuleInternal, ERC20Upgradeable)
     - remove the keyword view
     */
-    function _beforeTokenTransfer(
+    function _update(
         address from,
         address to,
         uint256 amount
@@ -179,7 +179,7 @@ abstract contract CMTAT_BASE_SnapshotTest is
         SnapshotModule:
         Add this call in case you add the SnapshotModule
         */
-        SnapshotModuleInternal._beforeTokenTransfer(from, to, amount);
+        SnapshotModuleInternal._update(from, to, amount);
     }
 
     /** 

diff --git a/contracts/test/killTest/BaseModuleTest.sol b/contracts/test/killTest/BaseModuleTest.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 // required OZ imports here
 import "../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";

diff --git a/contracts/test/killTest/CMTATKillTest.sol b/contracts/test/killTest/CMTATKillTest.sol
@@ -1,6 +1,6 @@
 //SPDX-License-Identifier: MPL-2.0
 
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.20;
 
 // required OZ imports here
 import "../../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
@@ -183,7 +183,7 @@ contract CMTAT_KILL_TEST is
     e.g. override(SnapshotModuleInternal, ERC20Upgradeable)
     - remove the keyword view
     */
-    function _beforeTokenTransfer(
+    function _update(
         address from,
         address to,
         uint256 amount
@@ -193,7 +193,7 @@ contract CMTAT_KILL_TEST is
         /*
         SnapshotModule:
         Add this call in case you add the SnapshotModule
-        SnapshotModuleInternal._beforeTokenTransfer(from, to, amount);
+        SnapshotModuleInternal._update(from, to, amount);
         */
     }
 

diff --git a/hardhat.config.js b/hardhat.config.js
@@ -4,7 +4,7 @@ require("solidity-coverage")
 require('solidity-docgen')
 module.exports = {
   solidity: {
-    version: '0.8.17',
+    version: '0.8.20',
     settings: {
       optimizer: {
         enabled: true,

diff --git a/openzeppelin-contracts-upgradeable b/openzeppelin-contracts-upgradeable