Merge pull request #553 from PolymathNetwork/upgradable-modules

Upgradable modules

Author: maxsam4

CHANGELOG.md

@@ -21,6 +21,7 @@ All notable changes to this project will be documented in this file.
 * Replaced `updatePolyTokenAddress()` function with `updateFromRegistry()` in `SecurityTokenRegistry`.  
 * Migrate all the getters of `SecurityTokenRegsitry.sol` to `STRGetter.sol` contract.
 * Removed `_polyToken` parameter from `initialize` function in `SecurityTokenRegistry`.
+* Return SecurityToken version in the `getSecurityTokenData()` function.
 
 ## GeneralTransferManager
 * `modifyWhitelist()` function renamed to `modifyKYCData()`.

contracts/ModuleRegistry.sol

@@ -137,8 +137,8 @@ contract ModuleRegistry is IModuleRegistry, EternalStorage {
 
     function _isCompatibleModule(address _moduleFactory, address _securityToken) internal view returns(bool) {
         uint8[] memory _latestVersion = ISecurityToken(_securityToken).getVersion();
-        uint8[] memory _lowerBound = IModuleFactory(_moduleFactory).getLowerSTVersionBounds();
-        uint8[] memory _upperBound = IModuleFactory(_moduleFactory).getUpperSTVersionBounds();
+        uint8[] memory _lowerBound = IModuleFactory(_moduleFactory).lowerSTVersionBounds();
+        uint8[] memory _upperBound = IModuleFactory(_moduleFactory).upperSTVersionBounds();
         bool _isLowerAllowed = VersionUtils.compareLowerBound(_lowerBound, _latestVersion);
         bool _isUpperAllowed = VersionUtils.compareUpperBound(_upperBound, _latestVersion);
         return (_isLowerAllowed && _isUpperAllowed);
@@ -162,15 +162,15 @@ contract ModuleRegistry is IModuleRegistry, EternalStorage {
         //Enforce type uniqueness
         uint256 i;
         uint256 j;
-        uint8[] memory moduleTypes = moduleFactory.getTypes();
+        uint8[] memory moduleTypes = moduleFactory.types();
         for (i = 1; i < moduleTypes.length; i++) {
             for (j = 0; j < i; j++) {
                 require(moduleTypes[i] != moduleTypes[j], "Type mismatch");
             }
         }
         require(moduleTypes.length != 0, "Factory must have type");
         // NB - here we index by the first type of the module.
-        uint8 moduleType = moduleFactory.getTypes()[0];
+        uint8 moduleType = moduleFactory.types()[0];
         set(Encoder.getKey("registry", _moduleFactory), uint256(moduleType));
         set(
             Encoder.getKey("moduleListIndex", _moduleFactory),
@@ -263,14 +263,14 @@ contract ModuleRegistry is IModuleRegistry, EternalStorage {
         uint256 i;
         uint256 j;
         for (i = 0; i < _modules.length; i++) {
-            counter = counter + IModuleFactory(_modules[i]).getTags().length;
+            counter = counter + IModuleFactory(_modules[i]).tags().length;
         }
         bytes32[] memory tags = new bytes32[](counter);
         address[] memory modules = new address[](counter);
         bytes32[] memory tempTags;
         counter = 0;
         for (i = 0; i < _modules.length; i++) {
-            tempTags = IModuleFactory(_modules[i]).getTags();
+            tempTags = IModuleFactory(_modules[i]).tags();
             for (j = 0; j < tempTags.length; j++) {
                 tags[counter] = tempTags[j];
                 modules[counter] = _modules[i];

contracts/STRGetter.sol

@@ -1,6 +1,7 @@
 pragma solidity ^0.5.0;
 
 import "./storage/EternalStorage.sol";
+import "./interfaces/ISecurityToken.sol";
 import "./libraries/Util.sol";
 import "./libraries/Encoder.sol";
 import "./interfaces/IOwnable.sol";
@@ -199,13 +200,15 @@ contract STRGetter is EternalStorage {
     * @return address is the issuer of the security Token.
     * @return string is the details of the security token.
     * @return uint256 is the timestamp at which security Token was deployed.
+    * @return version of the securityToken
     */
-    function getSecurityTokenData(address _securityToken) external view returns (string memory, address, string memory, uint256) {
+    function getSecurityTokenData(address _securityToken) external view returns (string memory, address, string memory, uint256, uint8[] memory) {
         return (
             getStringValue(Encoder.getKey("securityTokens_ticker", _securityToken)),
             IOwnable(_securityToken).owner(),
             getStringValue(Encoder.getKey("securityTokens_tokenDetails", _securityToken)),
-            getUintValue(Encoder.getKey("securityTokens_deployedAt", _securityToken))
+            getUintValue(Encoder.getKey("securityTokens_deployedAt", _securityToken)),
+            ISecurityToken(_securityToken).getVersion()
         );
     }
 

contracts/interfaces/IModule.sol

@@ -17,6 +17,6 @@ interface IModule {
     /**
      * @notice Used to withdraw the fee by the factory owner
      */
-    function takeFee(uint256 _amount) external returns(bool);
+    function takeUsageFee() external returns(bool);
 
 }

contracts/interfaces/IModuleFactory.sol

@@ -12,33 +12,52 @@ interface IModuleFactory {
         address indexed _moduleFactory,
         address _creator,
         uint256 _setupCost,
-        uint256 _setupCostInPoly,
-        uint256 _timestamp
+        uint256 _setupCostInPoly
     );
     event ChangeSTVersionBound(string _boundType, uint8 _major, uint8 _minor, uint8 _patch);
 
     //Should create an instance of the Module, or throw
     function deploy(bytes calldata _data) external returns(address);
 
     /**
-     * @notice Type of the Module factory
+     * @notice Get the tags related to the module factory
+     */
+    function version() external view returns(string memory);
+
+    /**
+     * @notice Get the tags related to the module factory
+     */
+    function name() external view returns(bytes32);
+
+    /**
+     * @notice Returns the title associated with the module
      */
-    function getTypes() external view returns(uint8[] memory);
+    function title() external view returns(string memory);
 
     /**
-     * @notice Get the name of the Module
+     * @notice Returns the description associated with the module
      */
-    function getName() external view returns(bytes32);
+    function description() external view returns(string memory);
 
     /**
-     * @notice Returns the instructions associated with the module
+     * @notice Get the setup cost of the module in USD
+     */
+    function usageCost() external returns(uint256);
+
+    /**
+     * @notice Get the setup cost of the module in USD
+     */
+    function setupCost() external returns(uint256);
+
+    /**
+     * @notice Type of the Module factory
      */
-    function getInstructions() external view returns(string memory);
+    function types() external view returns(uint8[] memory);
 
     /**
      * @notice Get the tags related to the module factory
      */
-    function getTags() external view returns(bytes32[] memory);
+    function tags() external view returns(bytes32[] memory);
 
     /**
      * @notice Used to change the setup fee
@@ -62,23 +81,23 @@ interface IModuleFactory {
     /**
      * @notice Get the setup cost of the module in USD
      */
-    function getSetupCost() external view returns(uint256);
+    function usageCostInPoly() external returns(uint256);
 
     /**
      * @notice Get the setup cost of the module
      */
-    function getSetupCostInPoly() external returns (uint256);
+    function setupCostInPoly() external returns (uint256);
 
     /**
      * @notice Used to get the lower bound
      * @return Lower bound
      */
-    function getLowerSTVersionBounds() external view returns(uint8[] memory);
+    function lowerSTVersionBounds() external view returns(uint8[] memory);
 
     /**
      * @notice Used to get the upper bound
      * @return Upper bound
      */
-    function getUpperSTVersionBounds() external view returns(uint8[] memory);
+    function upperSTVersionBounds() external view returns(uint8[] memory);
 
 }

contracts/interfaces/ISecurityTokenRegistry.sol

@@ -79,9 +79,10 @@ interface ISecurityTokenRegistry {
      * @return string Symbol of the Security Token.
      * @return address Address of the issuer of Security Token.
      * @return string Details of the Token.
-     * @return uint256 Timestamp at which Security Token get launched on Polymath platform.
+     * @return uint256 Timestamp at which Security Token get launched on Polymath platform
+     * @return version of the securityToken
      */
-    function getSecurityTokenData(address _securityToken) external view returns(string memory, address, string memory, uint256);
+    function getSecurityTokenData(address _securityToken) external view returns(string memory, address, string memory, uint256, uint8[] memory);
 
     /**
      * @notice Get the current STFactory Address

contracts/libraries/TokenLib.sol

@@ -1,6 +1,7 @@
 pragma solidity ^0.5.0;
 
 import "../interfaces/IPoly.sol";
+import "../modules/UpgradableModuleFactory.sol";
 import "../interfaces/IDataStore.sol";
 import "../tokens/SecurityTokenStorage.sol";
 import "../interfaces/ITransferManager.sol";
@@ -14,6 +15,8 @@ library TokenLib {
     bytes32 internal constant WHITELIST = "WHITELIST";
     bytes32 internal constant INVESTORSKEY = 0xdf3a8dd24acdd05addfc6aeffef7574d2de3f844535ec91e8e0f3e45dba96731; //keccak256(abi.encodePacked("INVESTORS"))
 
+    // Emit when Module get upgraded from the securityToken
+    event ModuleUpgraded(uint8[] _types, address _module);
     // Emit when Module is archived from the SecurityToken
     event ModuleArchived(uint8[] _types, address _module);
     // Emit when Module is unarchived from the SecurityToken
@@ -26,28 +29,37 @@ library TokenLib {
     /**
     * @notice Archives a module attached to the SecurityToken
     * @param _moduleData Storage data
-    * @param _module Address of module to archive
     */
-    function archiveModule(SecurityTokenStorage.ModuleData storage _moduleData, address _module) public {
+    function archiveModule(SecurityTokenStorage.ModuleData storage _moduleData) public {
         require(!_moduleData.isArchived, "Module archived");
         require(_moduleData.module != address(0), "Module missing");
         /*solium-disable-next-line security/no-block-members*/
-        emit ModuleArchived(_moduleData.moduleTypes, _module);
+        emit ModuleArchived(_moduleData.moduleTypes, _moduleData.module);
         _moduleData.isArchived = true;
     }
 
     /**
     * @notice Unarchives a module attached to the SecurityToken
     * @param _moduleData Storage data
-    * @param _module Address of module to unarchive
     */
-    function unarchiveModule(SecurityTokenStorage.ModuleData storage _moduleData, address _module) public {
+    function unarchiveModule(SecurityTokenStorage.ModuleData storage _moduleData) public {
         require(_moduleData.isArchived, "Module unarchived");
         /*solium-disable-next-line security/no-block-members*/
-        emit ModuleUnarchived(_moduleData.moduleTypes, _module);
+        emit ModuleUnarchived(_moduleData.moduleTypes, _moduleData.module);
         _moduleData.isArchived = false;
     }
 
+    /**
+    * @notice Upgrades a module attached to the SecurityToken
+    * @param _moduleData Storage data
+    */
+    function upgradeModule(SecurityTokenStorage.ModuleData storage _moduleData) public {
+        require(_moduleData.module != address(0), "Module missing");
+        // Will revert if module isn't upgradable
+        UpgradableModuleFactory(_moduleData.moduleFactory).upgrade(_moduleData.module);
+        emit ModuleUpgraded(_moduleData.moduleTypes, _moduleData.module);
+    }
+
     /**
     * @notice Removes a module attached to the SecurityToken
     * @param _module address of module to unarchive
@@ -259,11 +271,11 @@ library TokenLib {
         uint256 value,
         bytes memory data,
         bool transfersFrozen
-    ) 
-        public 
+    )
+        public
         view
-        returns(bool, bytes32) 
-    {   
+        returns(bool, bytes32)
+    {
         if (!transfersFrozen) {
             bool isInvalid = false;
             bool isValid = false;