Deploy scripts (CMTA#188)

* Add deploy script for CMTAT --------- Co-authored-by: Diego G <[email protected]>
amun · Jun 1, 2023 · 5fd6d55 · 5fd6d55
1 parent 0652ce6
commit 5fd6d55
Show file tree

Hide file tree

Showing 19 changed files with 2,308 additions and 467 deletions.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,8 @@
+PRIVATE_KEY=""
+
+MAINNET_NODE=""
+GOERLI_NODE=""
+
+ETHERSCAN_API_KEY=""
+
+ADMIN_ADDRESS=""
diff --git a/contracts/libraries/Errors.sol b/contracts/libraries/Errors.sol
@@ -5,9 +5,18 @@ pragma solidity ^0.8.17;
 library Errors {
     error InvalidTransfer(address from, address to, uint256 amount);
     error SnapshotScheduledInThePast(uint256 time, uint256 timestamp);
-    error SnapshotTimestampBeforeLastSnapshot(uint256 time, uint256 lastSnapshotTimestamp);
-    error SnapshotTimestampAfterNextSnapshot(uint256 time, uint256 nextSnapshotTimestamp);
-    error SnapshotTimestampBeforePreviousSnapshot(uint256 time, uint256 previousSnapshotTimestamp);
+    error SnapshotTimestampBeforeLastSnapshot(
+        uint256 time,
+        uint256 lastSnapshotTimestamp
+    );
+    error SnapshotTimestampAfterNextSnapshot(
+        uint256 time,
+        uint256 nextSnapshotTimestamp
+    );
+    error SnapshotTimestampBeforePreviousSnapshot(
+        uint256 time,
+        uint256 previousSnapshotTimestamp
+    );
     error SnapshotAlreadyExists();
     error SnapshotAlreadyDone();
     error SnapshotNotScheduled();
@@ -18,4 +27,3 @@ library Errors {
     error WrongAllowance(uint256 allowance, uint256 currentAllowance);
     error SameValue();
 }
-
diff --git a/contracts/mocks/RuleEngine/RuleEngineMock.sol b/contracts/mocks/RuleEngine/RuleEngineMock.sol
@@ -43,7 +43,7 @@ contract RuleEngineMock is IRuleEngine {
         uint256 _amount
     ) public view override returns (uint8) {
         uint256 ruleArrayLength = _rules.length;
-        for (uint256 i; i < ruleArrayLength;) {
+        for (uint256 i; i < ruleArrayLength; ) {
             uint8 restriction = _rules[i].detectTransferRestriction(
                 _from,
                 _to,
@@ -52,7 +52,9 @@ contract RuleEngineMock is IRuleEngine {
             if (restriction != uint8(REJECTED_CODE_BASE.TRANSFER_OK)) {
                 return restriction;
             }
-            unchecked { ++i; }
+            unchecked {
+                ++i;
+            }
         }
         return uint8(REJECTED_CODE_BASE.TRANSFER_OK);
     }
@@ -73,12 +75,14 @@ contract RuleEngineMock is IRuleEngine {
         uint8 _restrictionCode
     ) public view override returns (string memory) {
         uint256 ruleArrayLength = _rules.length;
-        for (uint256 i; i < ruleArrayLength;) {
+        for (uint256 i; i < ruleArrayLength; ) {
             if (_rules[i].canReturnTransferRestrictionCode(_restrictionCode)) {
                 return
                     _rules[i].messageForTransferRestriction(_restrictionCode);
             }
-            unchecked { ++i; }
+            unchecked {
+                ++i;
+            }
         }
         return "Unknown restriction code";
     }

diff --git a/contracts/modules/CMTAT_BASE.sol b/contracts/modules/CMTAT_BASE.sol
@@ -14,8 +14,7 @@ import "./wrapper/mandatory/ERC20BaseModule.sol";
 /*
 SnapshotModule:
 Add this import in case you add the SnapshotModule
-import "./wrapper/optional/SnapshotModule.sol";
-*/
+import "./wrapper/optional/SnapshotModule.sol";*/
 import "./wrapper/mandatory/PauseModule.sol";
 import "./wrapper/optional/ValidationModule.sol";
 import "./wrapper/optional/MetaTxModule.sol";
@@ -42,10 +41,10 @@ abstract contract CMTAT_BASE is
     CreditEventsModule
 {
     /**
-    @notice 
-    initialize the proxy contract
-    The calls to this function will revert if the contract was deployed without a proxy
-    */
+     * @notice
+     * initialize the proxy contract
+     * The calls to this function will revert if the contract was deployed without a proxy
+     */
     function initialize(
         address admin,
         string memory nameIrrevocable,
@@ -69,8 +68,8 @@ abstract contract CMTAT_BASE is
     }
 
     /**
-    @dev calls the different initialize functions from the different modules
-    */
+     * @dev calls the different initialize functions from the different modules
+     */
     function __CMTAT_init(
         address admin,
         string memory nameIrrevocable,
@@ -132,8 +131,8 @@ abstract contract CMTAT_BASE is
     }
 
     /**
-    @notice Returns the number of decimals used to get its user representation.
-    */
+     * @notice Returns the number of decimals used to get its user representation.
+     */
     function decimals()
         public
         view
@@ -169,7 +168,8 @@ abstract contract CMTAT_BASE is
         address to,
         uint256 amount
     ) internal view override(ERC20Upgradeable) {
-        if(!ValidationModule.validateTransfer(from, to, amount)) revert Errors.InvalidTransfer(from, to, amount);
+        if (!ValidationModule.validateTransfer(from, to, amount))
+            revert Errors.InvalidTransfer(from, to, amount);
         // We call the SnapshotModule only if the transfer is valid
         /*
         SnapshotModule:
@@ -178,9 +178,9 @@ abstract contract CMTAT_BASE is
         */
     }
 
-    /** 
-    @dev This surcharge is not necessary if you do not use the MetaTxModule
-    */
+    /**
+     * @dev This surcharge is not necessary if you do not use the MetaTxModule
+     */
     function _msgSender()
         internal
         view
@@ -190,9 +190,9 @@ abstract contract CMTAT_BASE is
         return MetaTxModule._msgSender();
     }
 
-    /** 
-    @dev This surcharge is not necessary if you do not use the MetaTxModule
-    */
+    /**
+     * @dev This surcharge is not necessary if you do not use the MetaTxModule
+     */
     function _msgData()
         internal
         view