Merge pull request #152 from yuzu-finance/izzyg/fix-solidity-compiler…

…-warnings

Address all solidity compiler (`solc`) warnings.

contracts/ERC1400.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * This code has not been reviewed.
  * Do not use or deploy this code before reviewing it personally first.
@@ -165,29 +166,27 @@ contract ERC1400 is IERC20, IERC1400, Ownable, ERC1820Client, ERC1820Implementer
 
   /**
    * @dev Initialize ERC1400 + register the contract implementation in ERC1820Registry.
-   * @param name Name of the token.
-   * @param symbol Symbol of the token.
-   * @param granularity Granularity of the token.
-   * @param controllers Array of initial controllers.
+   * @param tokenName Name of the token.
+   * @param tokenSymbol Symbol of the token.
+   * @param tokenGranularity Granularity of the token.
+   * @param initialControllers Array of initial controllers.
    * @param defaultPartitions Partitions chosen by default, when partition is
    * not specified, like the case ERC20 tranfers.
    */
   constructor(
-    string memory name,
-    string memory symbol,
-    uint256 granularity,
-    address[] memory controllers,
+    string memory tokenName,
+    string memory tokenSymbol,
+    uint256 tokenGranularity,
+    address[] memory initialControllers,
     bytes32[] memory defaultPartitions
-  )
-    public
-  {
-    _name = name;
-    _symbol = symbol;
+  ) {
+    _name = tokenName;
+    _symbol = tokenSymbol;
     _totalSupply = 0;
-    require(granularity >= 1); // Constructor Blocked - Token granularity can not be lower than 1
-    _granularity = granularity;
+    require(tokenGranularity >= 1); // Constructor Blocked - Token granularity can not be lower than 1
+    _granularity = tokenGranularity;
 
-    _setControllers(controllers);
+    _setControllers(initialControllers);
 
     _defaultPartitions = defaultPartitions;
 
@@ -285,26 +284,26 @@ contract ERC1400 is IERC20, IERC1400, Ownable, ERC1820Client, ERC1820Implementer
   /************************************* Document Management **************************************/
   /**
    * @dev Access a document associated with the token.
-   * @param name Short name (represented as a bytes32) associated to the document.
+   * @param documentName Short name (represented as a bytes32) associated to the document.
    * @return Requested document + document hash + document timestamp.
    */
-  function getDocument(bytes32 name) external override view returns (string memory, bytes32, uint256) {
-    require(bytes(_documents[name].docURI).length != 0); // Action Blocked - Empty document
+  function getDocument(bytes32 documentName) external override view returns (string memory, bytes32, uint256) {
+    require(bytes(_documents[documentName].docURI).length != 0); // Action Blocked - Empty document
     return (
-      _documents[name].docURI,
-      _documents[name].docHash,
-      _documents[name].timestamp
+      _documents[documentName].docURI,
+      _documents[documentName].docHash,
+      _documents[documentName].timestamp
     );
   }
   /**
    * @dev Associate a document with the token.
-   * @param name Short name (represented as a bytes32) associated to the document.
+   * @param documentName Short name (represented as a bytes32) associated to the document.
    * @param uri Document content.
    * @param documentHash Hash of the document [optional parameter].
    */
-  function setDocument(bytes32 name, string calldata uri, bytes32 documentHash) external override {
+  function setDocument(bytes32 documentName, string calldata uri, bytes32 documentHash) external override {
     require(_isController[msg.sender]);
-    _documents[name] = Doc({
+    _documents[documentName] = Doc({
       docURI: uri,
       docHash: documentHash,
       timestamp: block.timestamp
@@ -315,14 +314,14 @@ contract ERC1400 is IERC20, IERC1400, Ownable, ERC1820Client, ERC1820Implementer
       _indexOfDocHashes[documentHash] = _docHashes.length;
     }
 
-    emit DocumentUpdated(name, uri, documentHash);
+    emit DocumentUpdated(documentName, uri, documentHash);
   }
 
-  function removeDocument(bytes32 _name) external override {
+  function removeDocument(bytes32 documentName) external override {
     require(_isController[msg.sender], "Unauthorized");
-    require(bytes(_documents[_name].docURI).length != 0, "Document doesnt exist"); // Action Blocked - Empty document
+    require(bytes(_documents[documentName].docURI).length != 0, "Document doesnt exist"); // Action Blocked - Empty document
 
-    Doc memory data = _documents[_name];
+    Doc memory data = _documents[documentName];
 
     uint256 index1 = _indexOfDocHashes[data.docHash];
     require(index1 > 0, "Invalid index"); //Indexing starts at 1, 0 is not allowed
@@ -336,9 +335,9 @@ contract ERC1400 is IERC20, IERC1400, Ownable, ERC1820Client, ERC1820Implementer
     _docHashes.pop();
     _indexOfDocHashes[data.docHash] = 0;
 
-    delete _documents[_name];
+    delete _documents[documentName];
 
-    emit DocumentRemoved(_name, data.docURI, data.docHash);
+    emit DocumentRemoved(documentName, data.docURI, data.docHash);
   }
 
   function getAllDocuments() external override view returns (bytes32[] memory) {
@@ -1436,7 +1435,7 @@ contract ERC1400 is IERC20, IERC1400, Ownable, ERC1820Client, ERC1820Implementer
     return _name;
   }
 
-  function domainVersion() public override view returns (string memory) {
+  function domainVersion() public override pure returns (string memory) {
     return "1";
   }
   /************************************************************************************************/

contracts/IERC1400.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * This code has not been reviewed.
  * Do not use or deploy this code before reviewing it personally first.

contracts/Migrations.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 

contracts/certificate/ERC1400HoldableCertificateToken.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * This code has not been reviewed.
  * Do not use or deploy this code before reviewing it personally first.
@@ -71,7 +72,6 @@ contract ERC1400HoldableCertificateToken is ERC1400, IExtensionTypes {
     address certificateSigner,
     CertificateValidation certificateActivated
   )
-    public
     ERC1400(name, symbol, granularity, controllers, defaultPartitions)
   {
     if(extension != address(0)) {

contracts/extensions/tokenExtensions/ERC1400TokensChecker.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * This code has not been reviewed.
  * Do not use or deploy this code before reviewing it personally first.
@@ -33,7 +34,7 @@ contract ERC1400TokensChecker is IERC1400TokensChecker, ERC1820Client, ERC1820Im
   string constant internal ERC1400_TOKENS_SENDER = "ERC1400TokensSender";
   string constant internal ERC1400_TOKENS_RECIPIENT = "ERC1400TokensRecipient";
 
-  constructor() public {
+  constructor() {
     ERC1820Implementer._setInterface(ERC1400_TOKENS_CHECKER);
   }
 

contracts/extensions/tokenExtensions/ERC1400TokensValidator.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * This code has not been reviewed.
  * Do not use or deploy this code before reviewing it personally first.
@@ -469,9 +470,9 @@ contract ERC1400TokensValidator is IERC1400TokensValidator, Pausable, Certificat
     if (_holdsActivated[token] && from != address(0)) {
       if(operator != from) {
         (, bytes32 holdId) = _retrieveHoldHashId(token, partition, operator, from, to, value);
-        Hold storage hold = _holds[token][holdId];
+        Hold storage hold_ = _holds[token][holdId];
 
-        if (_holdCanBeExecutedAsNotary(hold, operator, value) && value <= IERC1400(token).balanceOfByPartition(partition, from)) {
+        if (_holdCanBeExecutedAsNotary(hold_, operator, value) && value <= IERC1400(token).balanceOfByPartition(partition, from)) {
           return true;
         }
       }
@@ -877,8 +878,8 @@ contract ERC1400TokensValidator is IERC1400TokensValidator, Pausable, Certificat
   /**
    * @dev Execute hold.
    */
-  function executeHold(address token, bytes32 holdId, uint256 value, bytes32 secret) external override returns (bool) {
-    return _executeHold(
+  function executeHold(address token, bytes32 holdId, uint256 value, bytes32 secret) external override {
+    _executeHold(
       token,
       holdId,
       msg.sender,
@@ -891,8 +892,8 @@ contract ERC1400TokensValidator is IERC1400TokensValidator, Pausable, Certificat
   /**
    * @dev Execute hold and keep open.
    */
-  function executeHoldAndKeepOpen(address token, bytes32 holdId, uint256 value, bytes32 secret) external returns (bool) {
-    return _executeHold(
+  function executeHoldAndKeepOpen(address token, bytes32 holdId, uint256 value, bytes32 secret) external {
+    _executeHold(
       token,
       holdId,
       msg.sender,
@@ -912,7 +913,7 @@ contract ERC1400TokensValidator is IERC1400TokensValidator, Pausable, Certificat
     uint256 value,
     bytes32 secret,
     bool keepOpenIfHoldHasBalance
-  ) internal returns (bool)
+  ) internal
   {
     Hold storage executableHold = _holds[token][holdId];
 
@@ -1017,7 +1018,7 @@ contract ERC1400TokensValidator is IERC1400TokensValidator, Pausable, Certificat
   /**
    * @dev Increase held balance.
    */
-  function _increaseHeldBalance(address token, Hold storage executableHold, bytes32 holdId) private {
+  function _increaseHeldBalance(address token, Hold storage executableHold, bytes32/*holdId*/) private {
     _heldBalance[token][executableHold.sender] = _heldBalance[token][executableHold.sender].add(executableHold.value);
     _totalHeldBalance[token] = _totalHeldBalance[token].add(executableHold.value);
 

contracts/extensions/tokenExtensions/IERC1400TokensChecker.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * This code has not been reviewed.
  * Do not use or deploy this code before reviewing it personally first.

contracts/extensions/tokenExtensions/IERC1400TokensValidator.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * This code has not been reviewed.
  * Do not use or deploy this code before reviewing it personally first.

contracts/extensions/userExtensions/IERC1400TokensRecipient.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * This code has not been reviewed.
  * Do not use or deploy this code before reviewing it personally first.

contracts/extensions/userExtensions/IERC1400TokensSender.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * This code has not been reviewed.
  * Do not use or deploy this code before reviewing it personally first.

contracts/interface/ERC1820Implementer.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * This code has not been reviewed.
  * Do not use or deploy this code before reviewing it personally first.

contracts/interface/HoldStatusCode.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 enum HoldStatusCode {

contracts/interface/IERC1643.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 /// @title IERC1643 Document Management (part of the ERC1400 Security Token Standards)

contracts/interface/IERC20HoldableToken.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * This code has not been reviewed.
  * Do not use or deploy this code before reviewing it personally first.
@@ -40,12 +41,12 @@ interface IERC20HoldableToken is IERC20 {
 
     /**
      @notice Called by the sender to hold some tokens for a recipient that the sender can not release back to themself until after the expiration date.
+     @param holdId a unique identifier for the hold.
      @param recipient optional account the tokens will be transferred to on execution. If a zero address, the recipient must be specified on execution of the hold.
      @param notary account that can execute the hold. Typically the recipient but can be a third party or a smart contact.
      @param amount of tokens to be transferred to the recipient on execution. Must be a non zero amount.
      @param expirationDateTime UNIX epoch seconds the held amount can be released back to the sender by the sender. Past dates are allowed.
      @param lockHash optional keccak256 hash of a lock preimage. An empty hash will not enforce the hash lock when the hold is executed.
-     @return bool Whether the call was successful or not.
      */
     function hold(
         bytes32 holdId,
@@ -54,7 +55,7 @@ interface IERC20HoldableToken is IERC20 {
         uint256 amount,
         uint256 expirationDateTime,
         bytes32 lockHash
-    ) external returns (bool);
+    ) external;
 
     function retrieveHoldData(bytes32 holdId) external view returns (ERC20HoldData memory);
 

contracts/interface/IHoldableERC1400TokenExtension.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 import "./HoldStatusCode.sol";
@@ -8,7 +9,7 @@ interface IHoldableERC1400TokenExtension {
         bytes32 holdId,
         uint256 value,
         bytes32 lockPreimage
-    ) external returns (bool);
+    ) external;
 
     function retrieveHoldData(address token, bytes32 holdId) external view returns (
         bytes32 partition,

contracts/mocks/AllowlistMock.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 // MOCK CONTRACT TO REACH FULL COVERAGE BY CALLING "onlyNotAllowlisted" MODIFIER

contracts/mocks/BlocklistMock.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 // MOCK CONTRACT TO REACH FULL COVERAGE BY CALLING "onlyNotBlocklisted" MODIFIER

contracts/mocks/CertificateSignerMock.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 // MOCK CONTRACT TO REACH FULL COVERAGE BY CALLING "onlyNotPausered" MODIFIER

contracts/mocks/Clock.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 // MOCK CONTRACT TO RETRIEVE TIME ON CHAIN

contracts/mocks/ERC1400TokensRecipientMock.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 import "../extensions/userExtensions/IERC1400TokensRecipient.sol";
@@ -24,7 +25,7 @@ contract ERC1400TokensRecipientMock is IERC1400TokensRecipient, ERC1820Implement
   ) // Comments to avoid compilation warnings for unused variables.
     external
     override
-    view
+    pure
     returns(bool)
   {
     return(_canReceive(from, to, value, data));
@@ -42,6 +43,7 @@ contract ERC1400TokensRecipientMock is IERC1400TokensRecipient, ERC1820Implement
   ) // Comments to avoid compilation warnings for unused variables.
     external
     override
+    pure
   {
     require(_canReceive(from, to, value, data), "57"); // 0x57	invalid receiver
   }

contracts/mocks/ERC1400TokensSenderMock.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 import "../extensions/userExtensions/IERC1400TokensSender.sol";
@@ -23,7 +24,7 @@ contract ERC1400TokensSenderMock is IERC1400TokensSender, ERC1820Implementer {
     bytes calldata /*operatorData*/
   ) // Comments to avoid compilation warnings for unused variables.
     external
-    view
+    pure
     override
     returns(bool)
   {
@@ -41,6 +42,7 @@ contract ERC1400TokensSenderMock is IERC1400TokensSender, ERC1820Implementer {
     bytes calldata /*operatorData*/
   ) // Comments to avoid compilation warnings for unused variables.
     external
+    pure
     override
   {
     require(_canTransfer(from, to, value, data), "56"); // 0x56	invalid sender

contracts/mocks/ERC1400TokensValidatorMock.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 import "../extensions/tokenExtensions/ERC1400TokensValidator.sol";

contracts/mocks/FakeERC1400Mock.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 import "../ERC1400.sol";
@@ -35,7 +36,6 @@ contract FakeERC1400Mock is ERC1400 {
     address extension,
     address mockAddress
   )
-    public
     ERC1400(name, symbol, granularity, controllers, defaultPartitions)
   {
     if(extension != address(0)) {

contracts/mocks/MinterRoleMock.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 // MOCK CONTRACT TO REACH FULL COVERAGE BY CALLING "onlyMinter" MODIFIER

contracts/mocks/PauserMock.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
 // MOCK CONTRACT TO REACH FULL COVERAGE BY CALLING "onlyNotPausered" MODIFIER

contracts/roles/AllowlistAdminRole.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * This code has not been reviewed.
  * Do not use or deploy this code before reviewing it personally first.

contracts/roles/AllowlistedRole.sol

@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
 /*
  * This code has not been reviewed.
  * Do not use or deploy this code before reviewing it personally first.