Optimisations, CI workflow, & deploy script

.env.example

@@ -0,0 +1,8 @@
+PRIVATE_KEY=""
+
+MAINNET_NODE=""
+GOERLI_NODE=""
+
+ETHERSCAN_API_KEY=""
+
+ADMIN_ADDRESS=""

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: Truffle CI
+
+on:
+  push:
+    branches: [dev, master, main]
+  pull_request:
+    branches: [dev, master, main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup NodeJS 16
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.17.0
+
+      - name: Show NodeJS version
+        run: npm --version
+
+      - name: Checkout submodules
+        run: git submodule update --init --recursive
+
+      - name: Install Truffle
+        run: npm install -g truffle
+
+      - name: Install Project Dependencies
+        run: npm install
+
+      - name: Run Truffle Test
+        run: npm t

.gitignore

@@ -15,3 +15,5 @@ artifacts
 cache
 #manticore
 mcore_*
+#secrets
+.env

.nvmrc

@@ -0,0 +1 @@
+v16.17.0

contracts/libraries/Errors.sol

@@ -0,0 +1,29 @@
+//SPDX-License-Identifier: MPL-2.0
+
+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 SnapshotAlreadyExists();
+    error SnapshotAlreadyDone();
+    error SnapshotNotScheduled();
+    error SnapshotNotFound();
+    error SnapshotNeverScheduled();
+    error AddressZeroNotAllowed();
+    error DirectCallToImplementation();
+    error WrongAllowance(uint256 allowance, uint256 currentAllowance);
+    error SameValue();
+}

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 = 0; i < ruleArrayLength; ++i) {
+        for (uint256 i; i < ruleArrayLength; ) {
             uint8 restriction = _rules[i].detectTransferRestriction(
                 _from,
                 _to,
@@ -52,6 +52,9 @@ contract RuleEngineMock is IRuleEngine {
             if (restriction != uint8(REJECTED_CODE_BASE.TRANSFER_OK)) {
                 return restriction;
             }
+            unchecked {
+                ++i;
+            }
         }
         return uint8(REJECTED_CODE_BASE.TRANSFER_OK);
     }
@@ -72,11 +75,14 @@ contract RuleEngineMock is IRuleEngine {
         uint8 _restrictionCode
     ) public view override returns (string memory) {
         uint256 ruleArrayLength = _rules.length;
-        for (uint256 i = 0; i < ruleArrayLength; ++i) {
+        for (uint256 i; i < ruleArrayLength; ) {
             if (_rules[i].canReturnTransferRestrictionCode(_restrictionCode)) {
                 return
                     _rules[i].messageForTransferRestriction(_restrictionCode);
             }
+            unchecked {
+                ++i;
+            }
         }
         return "Unknown restriction code";
     }

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";
@@ -24,6 +23,8 @@ import "./wrapper/optional/DebtModule/CreditEventsModule.sol";
 import "./security/AuthorizationModule.sol";
 import "../interfaces/IEIP1404/IEIP1404Wrapper.sol";
 
+import "../libraries/Errors.sol";
+
 abstract contract CMTAT_BASE is
     Initializable,
     ContextUpgradeable,
@@ -40,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,
@@ -67,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,
@@ -130,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
@@ -167,10 +168,8 @@ abstract contract CMTAT_BASE is
         address to,
         uint256 amount
     ) internal view override(ERC20Upgradeable) {
-        require(
-            ValidationModule.validateTransfer(from, to, amount),
-            "CMTAT: transfer rejected by validation module"
-        );
+        if (!ValidationModule.validateTransfer(from, to, amount))
+            revert Errors.InvalidTransfer(from, to, amount);
         // We call the SnapshotModule only if the transfer is valid
         /*
         SnapshotModule:
@@ -179,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
@@ -191,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

contracts/modules/internal/EnforcementModuleInternal.sol

@@ -64,7 +64,7 @@ abstract contract EnforcementModuleInternal is
      */
     function _freeze(
         address account,
-        string memory reason
+        string calldata reason
     ) internal virtual returns (bool) {
         if (_frozen[account]) return false;
         _frozen[account] = true;
@@ -79,7 +79,7 @@ abstract contract EnforcementModuleInternal is
      */
     function _unfreeze(
         address account,
-        string memory reason
+        string calldata reason
     ) internal virtual returns (bool) {
         if (!_frozen[account]) return false;
         _frozen[account] = false;