Allow token name change (#600)

* Allow owner to change name

* Reduce size

* Update ST interface

* Added update name event

* Updated OZ

* Updated storage verification test

Author: maxsam4

contracts/interfaces/ISecurityToken.sol

@@ -269,6 +269,12 @@ interface ISecurityToken {
      */
     function updateTokenDetails(string calldata _newTokenDetails) external;
 
+    /**
+    * @notice Allows owner to change token name
+    * @param _name new name of the token
+    */
+    function changeName(string calldata _name) external;
+
     /**
     * @notice Allows the owner to change token granularity
     * @param _granularity Granularity level of the token

contracts/tokens/OZStorage.sol

@@ -8,10 +8,6 @@ contract OZStorage {
 
     uint256 private _totalSupply;
 
-    string private _name;
-    string private _symbol;
-    uint8 private _decimals;
-
     address private _owner;
 
     /// @dev counter to allow mutex lock with only one SSTORE operation
@@ -25,4 +21,4 @@ contract OZStorage {
         return _balances[_investor];
     }
 
-}
+}

contracts/tokens/SecurityToken.sol

@@ -16,7 +16,6 @@ import "../interfaces/ITransferManager.sol";
 import "openzeppelin-solidity/contracts/ownership/Ownable.sol";
 import "openzeppelin-solidity/contracts/utils/ReentrancyGuard.sol";
 import "openzeppelin-solidity/contracts/token/ERC20/ERC20.sol";
-import "openzeppelin-solidity/contracts/token/ERC20/ERC20Detailed.sol";
 
 /**
  * @title Security Token contract
@@ -28,7 +27,7 @@ import "openzeppelin-solidity/contracts/token/ERC20/ERC20Detailed.sol";
  * @notice - ST does not inherit from ISecurityToken due to:
  * @notice - https://github.com/ethereum/solidity/issues/4847
  */
-contract SecurityToken is ERC20, ERC20Detailed, Ownable, ReentrancyGuard, SecurityTokenStorage, IERC1594, IERC1643, IERC1644, Proxy {
+contract SecurityToken is ERC20, Ownable, ReentrancyGuard, SecurityTokenStorage, IERC1594, IERC1643, IERC1644, Proxy {
 
     using SafeMath for uint256;
 
@@ -45,6 +44,8 @@ contract SecurityToken is ERC20, ERC20Detailed, Ownable, ReentrancyGuard, Securi
 
     // Emit when the token details get updated
     event UpdateTokenDetails(string _oldDetails, string _newDetails);
+    // Emit when the token name get updated
+    event UpdateTokenName(string _oldName, string _newName);
     // Emit when the granularity get changed
     event GranularityChanged(uint256 _oldGranularity, uint256 _newGranularity);
     // Emit when is permanently frozen by the issuer
@@ -134,13 +135,15 @@ contract SecurityToken is ERC20, ERC20Detailed, Ownable, ReentrancyGuard, Securi
         address _delegate
     )
         public
-        ERC20Detailed(_name, _symbol, _decimals)
     {
         _zeroAddressCheck(_polymathRegistry);
         _zeroAddressCheck(_delegate);
         polymathRegistry = _polymathRegistry;
         //When it is created, the owner is the STR
         updateFromRegistry();
+        name = _name;
+        symbol = _symbol;
+        decimals = _decimals;
         delegate = _delegate;
         tokenDetails = _tokenDetails;
         granularity = _granularity;
@@ -289,6 +292,15 @@ contract SecurityToken is ERC20, ERC20Detailed, Ownable, ReentrancyGuard, Securi
         dataStore = _dataStore;
     }
 
+    /**
+    * @notice Allows owner to change token name
+    * @param _name new name of the token
+    */
+    function changeName(string calldata _name) external onlyOwner {
+        emit UpdateTokenName(name, _name);
+        name = _name;
+    }
+
     /**
      * @notice Allows to change the treasury wallet address
      * @param _wallet Ethereum address of the treasury wallet

contracts/tokens/SecurityTokenStorage.sol

@@ -46,6 +46,11 @@ contract SecurityTokenStorage {
         uint256 value;
     }
 
+    // ERC20 Details
+    string public name;
+    string public symbol;
+    uint8 public decimals;
+
     // Address of the controller which is a delegated entity
     // set by the issuer/owner of the token
     address public controller;
@@ -108,5 +113,4 @@ contract SecurityTokenStorage {
     mapping(bytes32 => Document) internal _documents;
     // mapping to store the document name indexes
     mapping(bytes32 => uint256) internal _docIndexes;
-
 }

package.json

@@ -81,7 +81,7 @@
     "fs": "0.0.2",
     "ganache-cli": "6.1.8",
     "mocha-junit-reporter": "^1.18.0",
-    "openzeppelin-solidity": "2.1.2",
+    "openzeppelin-solidity": "2.2.0",
     "prettier": "^1.15.3",
     "prompt": "^1.0.0",
     "request": "^2.88.0",

test/n_security_token_registry.js

@@ -668,8 +668,9 @@ contract("SecurityTokenRegistry", async (accounts) => {
             I_TokenLib = await TokenLib.new();
             await STFactoryV2.link(TokenLib);
             await SecurityTokenMock.link(TokenLib);
+            console.log("ST linked");
             I_STFactory002 = await STFactoryV2.new(I_GeneralTransferManagerFactory.address, I_DataStoreFactory.address, I_STGetter.address, { from: account_polymath });
-
+            console.log("STF deployed");
             assert.notEqual(
                 I_STFactory002.address.valueOf(),
                 address_zero,

test/o_security_token.js

@@ -203,6 +203,17 @@ contract("SecurityToken", async (accounts) => {
             assert.equal(web3.utils.toUtf8(log.args._name), "GeneralTransferManager");
         });
 
+        it("Should not allow unauthorized address to change name", async() => {
+            await catchRevert(I_SecurityToken.changeName("new token name"));
+        });
+
+        it("Should allow authorized address to change name", async() => {
+            let snapId = await takeSnapshot(); 
+            await I_SecurityToken.changeName("new token name", { from: token_owner });
+            assert.equal((await I_SecurityToken.name()).replace(/\u0000/g, ""), "new token name");
+            await revertToSnapshot(snapId);
+        });
+
         it("Should intialize the auto attached modules", async () => {
             let moduleData = (await stGetter.getModulesByType(transferManagerKey))[0];
             I_GeneralTransferManager = await GeneralTransferManager.at(moduleData);
@@ -1358,49 +1369,46 @@ contract("SecurityToken", async (accounts) => {
             `);
             assert.equal(
                 await I_SecurityToken.name.call(),
-                (web3.utils.toAscii(await readStorage(I_SecurityToken.address, 3)).replace(/\u0000/g, "")).replace(/\u0014/g, "")
+                (web3.utils.toAscii(await readStorage(I_SecurityToken.address, 5)).replace(/\u0000/g, "")).replace(/\u0014/g, "")
             )
             console.log(`
                 Name of the ST:                     ${await I_SecurityToken.name.call()}
-                Name of the ST from the storage:    ${web3.utils.toUtf8(await readStorage(I_SecurityToken.address, 3))}
+                Name of the ST from the storage:    ${web3.utils.toUtf8(await readStorage(I_SecurityToken.address, 5))}
             `);
             assert.equal(
                 await I_SecurityToken.symbol.call(),
-                (web3.utils.toUtf8(await readStorage(I_SecurityToken.address, 4)).replace(/\u0000/g, "")).replace(/\u0006/g, "")
+                (web3.utils.toUtf8(await readStorage(I_SecurityToken.address, 6)).replace(/\u0000/g, "")).replace(/\u0006/g, "")
             );
             console.log(`
                 Symbol of the ST:                     ${await I_SecurityToken.symbol.call()}
-                Symbol of the ST from the storage:    ${web3.utils.toUtf8(await readStorage(I_SecurityToken.address, 4))}
+                Symbol of the ST from the storage:    ${web3.utils.toUtf8(await readStorage(I_SecurityToken.address, 6))}
             `);
 
             console.log(`
                 Address of the owner:                   ${await I_SecurityToken.owner.call()}
-                Address of the owner from the storage:  ${(await readStorage(I_SecurityToken.address, 5)).substring(0, 42)}
+                Address of the owner from the storage:  ${(await readStorage(I_SecurityToken.address, 3)).substring(0, 42)}
             `)
             assert.equal(
                 await I_SecurityToken.owner.call(),
-                web3.utils.toChecksumAddress((await readStorage(I_SecurityToken.address, 5)).substring(0, 42))
+                web3.utils.toChecksumAddress((await readStorage(I_SecurityToken.address, 3)).substring(0, 42))
             );
 
         });
 
         it("Verify the storage of the STStorage", async() => {
-            // for (let j = 7; j < 35; j++) {
-            //     console.log(await readStorage(I_SecurityToken.address, j));
-            // }
 
             console.log(`
-                Controller address from the contract:         ${await stGetter.controller.call()}
-                Controller address from the storage:          ${await readStorage(I_SecurityToken.address, 7)}
+                Controller address from the contract:                   ${await stGetter.controller.call()}
+                decimals from the contract:                             ${await stGetter.decimals.call()} 
+                controller address from the storage + uint8 decimals:   ${await readStorage(I_SecurityToken.address, 7)}
             `)
-            // Different versions of web3 behave differently :/
+
+            // Controller address is packed with decimals so if controller address is 0x0, only decimals will be returned from read storage.
             assert.oneOf(
                 await readStorage(I_SecurityToken.address, 7),
                 [
-                    (await stGetter.controller.call()).toLowerCase(),
-                    (await stGetter.controller.call()).substring(0, 4),
-                    (await stGetter.controller.call()).substring(0, 3),
-                    await stGetter.controller.call()
+                    (await stGetter.controller.call()).toLowerCase() + "12",
+                    "0x12" // When controller address = 0x0, web3 converts 0x00000..000012 to 0x12
                 ]
             );
 

yarn.lock

@@ -5148,10 +5148,10 @@ onetime@^2.0.0:
   dependencies:
     mimic-fn "^1.0.0"
 
-openzeppelin-solidity@2.1.2:
-  version "2.1.2"
-  resolved "https://registry.yarnpkg.com/openzeppelin-solidity/-/openzeppelin-solidity-2.1.2.tgz#94e2bb92b60e91abb22c6fe27d983d92850fb324"
-  integrity sha512-1ggh+AZFpMAgGfgnVMQ8dwYawjD2QN4xuWkQS4FUbeUz1fnCKJpguUl2cyadyfDYjBq1XJ6MA6VkzYpTZtJMqw==
+openzeppelin-solidity@^2.2.0:
+  version "2.2.0"
+  resolved "https://registry.yarnpkg.com/openzeppelin-solidity/-/openzeppelin-solidity-2.2.0.tgz#1f0e857f53bda29b77a8e72f9a629db81015fd34"
+  integrity sha512-HfQq0xyT+EPs/lTWEd5Odu4T7CYdYe+qwf54EH28FQZthp4Bs6IWvOlOumTdS2dvpwZoTXURAopHn2LN1pwAGQ==
 
 optimist@^0.6.1:
   version "0.6.1"