Merge pull request #51 from CMTA/fb-format-code

Fb format code
CMTA · Oct 13, 2022 · 077b2cf · 077b2cf
2 parents 5f047cf + ee29e61
commit 077b2cf
Show file tree

Hide file tree

Showing 27 changed files with 2,471 additions and 1,247 deletions.
diff --git a/contracts/CMTAT.sol b/contracts/CMTAT.sol
diff --git a/contracts/interfaces/IRule.sol b/contracts/interfaces/IRule.sol
@@ -3,15 +3,25 @@
 pragma solidity ^0.8.17;
 
 interface IRule {
-  function isTransferValid(
-    address _from, address _to, uint256 _amount)
-  external view returns (bool isValid);
+    function isTransferValid(
+        address _from,
+        address _to,
+        uint256 _amount
+    ) external view returns (bool isValid);
 
-  function detectTransferRestriction(
-    address _from, address _to, uint256 _amount)
-  external view returns (uint8);
+    function detectTransferRestriction(
+        address _from,
+        address _to,
+        uint256 _amount
+    ) external view returns (uint8);
 
-  function canReturnTransferRestrictionCode(uint8 _restrictionCode) external view returns (bool);
+    function canReturnTransferRestrictionCode(uint8 _restrictionCode)
+        external
+        view
+        returns (bool);
 
-  function messageForTransferRestriction(uint8 _restrictionCode) external view returns (string memory);
+    function messageForTransferRestriction(uint8 _restrictionCode)
+        external
+        view
+        returns (string memory);
 }
diff --git a/contracts/interfaces/IRuleEngine.sol b/contracts/interfaces/IRuleEngine.sol
@@ -5,23 +5,28 @@ pragma solidity ^0.8.17;
 import "./IRule.sol";
 
 interface IRuleEngine {
+    function setRules(IRule[] calldata rules_) external;
 
-  function setRules(IRule[] calldata rules_) external;
-  function ruleLength() external view returns (uint256);
-  function rule(uint256 ruleId) external view returns (IRule);
-  function rules() external view returns(IRule[] memory);
+    function ruleLength() external view returns (uint256);
 
-  function validateTransfer(
-    address _from,
-    address _to,
-    uint256 _amount)
-  external view returns (bool);
+    function rule(uint256 ruleId) external view returns (IRule);
 
-  function detectTransferRestriction (
-    address _from,
-    address _to,
-    uint256 _value)
-  external view returns (uint8);
+    function rules() external view returns (IRule[] memory);
 
-  function messageForTransferRestriction (uint8 _restrictionCode) external view returns (string memory);
+    function validateTransfer(
+        address _from,
+        address _to,
+        uint256 _amount
+    ) external view returns (bool);
+
+    function detectTransferRestriction(
+        address _from,
+        address _to,
+        uint256 _value
+    ) external view returns (uint8);
+
+    function messageForTransferRestriction(uint8 _restrictionCode)
+        external
+        view
+        returns (string memory);
 }
diff --git a/contracts/mocks/MinimalForwarderMock.sol b/contracts/mocks/MinimalForwarderMock.sol
@@ -5,7 +5,7 @@ pragma solidity ^0.8.17;
 import "../../openzeppelin-contracts-upgradeable/contracts/metatx/MinimalForwarderUpgradeable.sol";
 
 contract MinimalForwarderMock is MinimalForwarderUpgradeable {
-  function initialize() public initializer {
-    __MinimalForwarder_init();
-  }
+    function initialize() public initializer {
+        __MinimalForwarder_init();
+    }
 }
diff --git a/contracts/mocks/RuleEngineMock.sol b/contracts/mocks/RuleEngineMock.sol
@@ -6,60 +6,67 @@ import "../interfaces/IRule.sol";
 import "../interfaces/IRuleEngine.sol";
 import "./RuleMock.sol";
 
-
 contract RuleEngineMock is IRuleEngine {
-  IRule[] internal _rules;
+    IRule[] internal _rules;
 
-  constructor() {
-    _rules.push(new RuleMock());
-  }
+    constructor() {
+        _rules.push(new RuleMock());
+    }
 
-  function setRules(IRule[] calldata rules_) external override {
-    _rules = rules_;
-  }
+    function setRules(IRule[] calldata rules_) external override {
+        _rules = rules_;
+    }
 
-  function ruleLength() external view override returns (uint256) {
-    return _rules.length;
-  }
+    function ruleLength() external view override returns (uint256) {
+        return _rules.length;
+    }
 
-  function rule(uint256 ruleId) external view override returns (IRule) {
-    return _rules[ruleId];
-  }
+    function rule(uint256 ruleId) external view override returns (IRule) {
+        return _rules[ruleId];
+    }
 
-  function rules() external view override returns(IRule[] memory) {
-    return _rules;
-  }
+    function rules() external view override returns (IRule[] memory) {
+        return _rules;
+    }
 
-  function detectTransferRestriction(
-    address _from,
-    address _to,
-    uint256 _amount)
-  public view override returns (uint8)
-  {
-    for (uint256 i = 0; i < _rules.length; i++) {
-      uint8 restriction = _rules[i].detectTransferRestriction(_from, _to, _amount);
-      if (restriction > 0) {
-        return restriction;
-      }
+    function detectTransferRestriction(
+        address _from,
+        address _to,
+        uint256 _amount
+    ) public view override returns (uint8) {
+        for (uint256 i = 0; i < _rules.length; i++) {
+            uint8 restriction = _rules[i].detectTransferRestriction(
+                _from,
+                _to,
+                _amount
+            );
+            if (restriction > 0) {
+                return restriction;
+            }
+        }
+        return 0;
     }
-    return 0;
-  }
 
-  function validateTransfer(
-    address _from,
-    address _to,
-    uint256 _amount)
-  public view override returns (bool)
-  {
-    return detectTransferRestriction(_from, _to, _amount) == 0;
-  }
+    function validateTransfer(
+        address _from,
+        address _to,
+        uint256 _amount
+    ) public view override returns (bool) {
+        return detectTransferRestriction(_from, _to, _amount) == 0;
+    }
 
-  function messageForTransferRestriction(uint8 _restrictionCode) public view override returns (string memory) {
-    for (uint256 i = 0; i < _rules.length; i++) {
-      if (_rules[i].canReturnTransferRestrictionCode(_restrictionCode)) {
-        return _rules[i].messageForTransferRestriction(_restrictionCode);
-      }
+    function messageForTransferRestriction(uint8 _restrictionCode)
+        public
+        view
+        override
+        returns (string memory)
+    {
+        for (uint256 i = 0; i < _rules.length; i++) {
+            if (_rules[i].canReturnTransferRestrictionCode(_restrictionCode)) {
+                return
+                    _rules[i].messageForTransferRestriction(_restrictionCode);
+            }
+        }
+        return "Unknown restriction code";
     }
-    return "Unknown restriction code";
-  }
 }
diff --git a/contracts/mocks/RuleMock.sol b/contracts/mocks/RuleMock.sol
@@ -4,31 +4,45 @@ pragma solidity ^0.8.17;
 
 import "../interfaces/IRule.sol";
 
-
 contract RuleMock is IRule {
-  uint8 constant AMOUNT_TOO_HIGH = 10;
-  string constant TEXT_AMOUNT_TOO_HIGH = "Amount too high";
-  string constant TEXT_CODE_NOT_FOUND = "Code not found";
-
-  function isTransferValid(
-    address _from, address _to, uint256 _amount)
-  public pure override returns (bool isValid)
-  {
-    return detectTransferRestriction(_from, _to, _amount) == 0;
-  }
-
-  function detectTransferRestriction(
-    address /* _from */, address /* _to */, uint256 _amount)
-  public pure override returns (uint8)
-  {
-    return _amount < 20 ? 0 : AMOUNT_TOO_HIGH;
-  }
-
-  function canReturnTransferRestrictionCode(uint8 _restrictionCode) public pure override returns (bool) {
-    return _restrictionCode == AMOUNT_TOO_HIGH;
-  }
-
-  function messageForTransferRestriction(uint8 _restrictionCode) external pure override returns (string memory) {
-    return _restrictionCode == AMOUNT_TOO_HIGH ? TEXT_AMOUNT_TOO_HIGH : TEXT_CODE_NOT_FOUND;
-  }
+    uint8 constant AMOUNT_TOO_HIGH = 10;
+    string constant TEXT_AMOUNT_TOO_HIGH = "Amount too high";
+    string constant TEXT_CODE_NOT_FOUND = "Code not found";
+
+    function isTransferValid(
+        address _from,
+        address _to,
+        uint256 _amount
+    ) public pure override returns (bool isValid) {
+        return detectTransferRestriction(_from, _to, _amount) == 0;
+    }
+
+    function detectTransferRestriction(
+        address, /* _from */
+        address, /* _to */
+        uint256 _amount
+    ) public pure override returns (uint8) {
+        return _amount < 20 ? 0 : AMOUNT_TOO_HIGH;
+    }
+
+    function canReturnTransferRestrictionCode(uint8 _restrictionCode)
+        public
+        pure
+        override
+        returns (bool)
+    {
+        return _restrictionCode == AMOUNT_TOO_HIGH;
+    }
+
+    function messageForTransferRestriction(uint8 _restrictionCode)
+        external
+        pure
+        override
+        returns (string memory)
+    {
+        return
+            _restrictionCode == AMOUNT_TOO_HIGH
+                ? TEXT_AMOUNT_TOO_HIGH
+                : TEXT_CODE_NOT_FOUND;
+    }
 }
diff --git a/contracts/modules/AuthorizationModule.sol b/contracts/modules/AuthorizationModule.sol
@@ -4,5 +4,4 @@ pragma solidity ^0.8.17;
 
 import "../../openzeppelin-contracts-upgradeable/contracts/access/AccessControlUpgradeable.sol";
 
-abstract contract AuthorizationModule is AccessControlUpgradeable {
-}
+abstract contract AuthorizationModule is AccessControlUpgradeable {}
diff --git a/contracts/modules/BaseModule.sol b/contracts/modules/BaseModule.sol
@@ -6,10 +6,9 @@ pragma solidity ^0.8.17;
 import "../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializable.sol";
 import "../../openzeppelin-contracts-upgradeable/contracts/token/ERC20/ERC20Upgradeable.sol";
 
-
 abstract contract BaseModule is Initializable, ERC20Upgradeable {
     /* Events */
-    event Spend (address indexed owner, address indexed spender, uint amount);
+    event Spend(address indexed owner, address indexed spender, uint256 amount);
 
     /* Variables */
     uint8 private _decimals;
@@ -23,14 +22,24 @@ abstract contract BaseModule is Initializable, ERC20Upgradeable {
      * All two of these values are immutable: they can only be set once during
      * construction.
      */
-    function __Base_init(string memory name_, string memory symbol_, uint8 decimals_, string memory tokenId_, string memory terms_) internal initializer {
+    function __Base_init(
+        string memory name_,
+        string memory symbol_,
+        uint8 decimals_,
+        string memory tokenId_,
+        string memory terms_
+    ) internal initializer {
         __ERC20_init(name_, symbol_);
         _decimals = decimals_;
         tokenId = tokenId_;
         terms = terms_;
     }
 
-    function __Base_init_unchained(uint8 decimals_, string memory tokenId_, string memory terms_) internal initializer {
+    function __Base_init_unchained(
+        uint8 decimals_,
+        string memory tokenId_,
+        string memory terms_
+    ) internal initializer {
         _decimals = decimals_;
         tokenId = tokenId_;
         terms = terms_;
@@ -67,7 +76,11 @@ abstract contract BaseModule is Initializable, ERC20Upgradeable {
      * - the caller must have allowance for ``sender``'s tokens of at least
      * `amount`.
      */
-    function transferFrom(address sender, address recipient, uint256 amount) public virtual override returns (bool) {
+    function transferFrom(
+        address sender,
+        address recipient,
+        uint256 amount
+    ) public virtual override returns (bool) {
         bool result = super.transferFrom(sender, recipient, amount);
         if (result == true) {
             emit Spend(sender, _msgSender(), amount);
@@ -83,8 +96,15 @@ abstract contract BaseModule is Initializable, ERC20Upgradeable {
      *
      * - `spender` cannot be the zero address.
      */
-    function approve(address spender, uint256 amount, uint256 currentAllowance) public virtual returns (bool) {
-        require(allowance(_msgSender(), spender) == currentAllowance, "CMTAT: current allowance is not right");
+    function approve(
+        address spender,
+        uint256 amount,
+        uint256 currentAllowance
+    ) public virtual returns (bool) {
+        require(
+            allowance(_msgSender(), spender) == currentAllowance,
+            "CMTAT: current allowance is not right"
+        );
         super.approve(spender, amount);
         return true;
     }

diff --git a/contracts/modules/BurnModule.sol b/contracts/modules/BurnModule.sol
@@ -7,5 +7,5 @@ import "../../openzeppelin-contracts-upgradeable/contracts/proxy/utils/Initializ
 abstract contract BurnModule is Initializable {
     bytes32 public constant BURNER_ROLE = keccak256("BURNER_ROLE");
 
-    event Burn (address indexed owner, uint amount);
+    event Burn(address indexed owner, uint256 amount);
 }