add the protocolVersion in the event

Author: SatyamSB

contracts/SecurityTokenRegistry.sol

@@ -104,7 +104,8 @@ contract SecurityTokenRegistry is EternalStorage, Proxy {
         address _registrant,
         bool _fromAdmin,
         uint256 _usdFee,
-        uint256 _polyFee
+        uint256 _polyFee,
+        uint256 _protocolVersion
     );
     // Emit after ticker registration
     event RegisterTicker(
@@ -517,7 +518,16 @@ contract SecurityTokenRegistry is EternalStorage, Proxy {
         _deployToken(_name, ticker, _tokenDetails, msg.sender, _divisible, protocolVersion); 
     }
 
-    function _deployToken(string memory _name, string memory _ticker, string memory _tokenDetails, address _issuer, bool _divisible, uint256 _protocolVersion) internal {
+    function _deployToken(
+        string memory _name,
+        string memory _ticker,
+        string memory _tokenDetails,
+        address _issuer,
+        bool _divisible,
+        uint256 _protocolVersion
+    ) 
+        internal
+    {
         (uint256 _usdFee, uint256 _polyFee) = _takeFee(STLAUNCHFEE);
         address newSecurityTokenAddress = ISTFactory(getAddressValue(Encoder.getKey("protocolVersionST", _protocolVersion))).deployToken(
             _name,
@@ -533,7 +543,7 @@ contract SecurityTokenRegistry is EternalStorage, Proxy {
         _storeSecurityTokenData(newSecurityTokenAddress, _ticker, _tokenDetails, now);
         set(Encoder.getKey("tickerToSecurityToken", _ticker), newSecurityTokenAddress);
         /*solium-disable-next-line security/no-block-members*/
-        emit NewSecurityToken(_ticker, _name, newSecurityTokenAddress, msg.sender, now, msg.sender, false, _usdFee, _polyFee);
+        _emitSecurityTokenEvent(_ticker, _name, newSecurityTokenAddress, msg.sender, now, msg.sender, false, _usdFee, _polyFee, _protocolVersion);
     }
 
     /**
@@ -544,18 +554,20 @@ contract SecurityTokenRegistry is EternalStorage, Proxy {
      * @param _securityToken is the address of the securityToken
      * @param _tokenDetails is the off-chain details of the token
      * @param _deployedAt is the timestamp at which the security token is deployed
+     * @param _protocolVersion Version of securityToken contract
      */
     function modifySecurityToken(
         string calldata _name,
         string calldata _ticker,
         address _owner,
         address _securityToken,
         string calldata _tokenDetails,
-        uint256 _deployedAt
+        uint256 _deployedAt,
+        uint256 _protocolVersion
     )
         external
         onlyOwner
-    {
+    {   
         require(bytes(_name).length > 0 && bytes(_ticker).length > 0, "Bad data");
         require(bytes(_ticker).length <= 10, "Bad ticker");
         require(_deployedAt != 0 && _owner != address(0), "Bad data");
@@ -571,7 +583,29 @@ contract SecurityTokenRegistry is EternalStorage, Proxy {
         set(Encoder.getKey("tickerToSecurityToken", ticker), _securityToken);
         _modifyTicker(_owner, ticker, _name, registrationTime, expiryTime, true);
         _storeSecurityTokenData(_securityToken, ticker, _tokenDetails, _deployedAt);
-        emit NewSecurityToken(ticker, _name, _securityToken, _owner, _deployedAt, msg.sender, true, uint256(0), uint256(0));
+        _emitSecurityTokenEvent(
+            ticker, _name, _securityToken, _owner, _deployedAt, msg.sender, true, uint256(0), uint256(0), 
+            (_protocolVersion == uint256(0) ? getUintValue(Encoder.getKey("latestVersion")) : _protocolVersion)
+        );
+    }
+
+    function _emitSecurityTokenEvent(
+        string memory _ticker,
+        string memory _name,
+        address _securityToken,
+        address _owner,
+        uint256 _addedAt,
+        address _registrant,
+        bool _fromAdmin,
+        uint256 _usdFee,
+        uint256 _polyFee,
+        uint256 _protocolVersion 
+    ) 
+        internal
+    {
+        emit NewSecurityToken(
+            _ticker, _name, _securityToken, _owner, _addedAt, _registrant, _fromAdmin, _usdFee, _polyFee, _protocolVersion
+        );
     }
 
     /**

contracts/interfaces/ISecurityTokenRegistry.sol

@@ -5,13 +5,22 @@ pragma solidity ^0.5.0;
  */
 interface ISecurityTokenRegistry {
     /**
-     * @notice Creates a new Security Token and saves it to the registry
-     * @param _name Name of the token
-     * @param _ticker Ticker ticker of the security token
-     * @param _tokenDetails Off-chain details of the token
-     * @param _divisible Whether the token is divisible or not
-     */
-    function generateSecurityToken(string calldata _name, string calldata _ticker, string calldata _tokenDetails, bool _divisible) external;
+     * @notice Deploys an instance of a new Security Token and records it to the registry
+     * @param _name is the name of the token
+     * @param _ticker is the ticker symbol of the security token
+     * @param _tokenDetails is the off-chain details of the token
+     * @param _divisible is whether or not the token is divisible
+     * @param _protocolVersion Version of securityToken contract
+     * - `_protocolVersion` is the packed value of uin8[3] array (it will be calculated offchain)
+     * - if _protocolVersion == 0 then latest version of securityToken will be generated
+     */
+    function generateSecurityToken(
+        string calldata _name,
+        string calldata _ticker,
+        string calldata _tokenDetails,
+        bool _divisible,
+        uint256 _protocolVersion
+    ) external;
 
     /**
      * @notice Adds a new custom Security Token and saves it to the registry. (Token should follow the ISecurityToken interface)
@@ -21,14 +30,16 @@ interface ISecurityTokenRegistry {
      * @param _securityToken Address of the securityToken
      * @param _tokenDetails Off-chain details of the token
      * @param _deployedAt Timestamp at which security token comes deployed on the ethereum blockchain
+     * @param _protocolVersion Version of the protocol
      */
     function modifySecurityToken(
         string calldata _name,
         string calldata _ticker,
         address _owner,
         address _securityToken,
         string calldata _tokenDetails,
-        uint256 _deployedAt
+        uint256 _deployedAt,
+        uint256 _protocolVersion
     )
     external;
 

test/n_security_token_registry.js

@@ -755,7 +755,7 @@ contract("SecurityTokenRegistry", async (accounts) => {
     describe("Generate custom tokens", async () => {
         it("Should fail if msg.sender is not polymath", async () => {
             await catchRevert(
-                I_STRProxied.modifySecurityToken("LOGAN", "LOG", account_temp, dummy_token, "I am custom ST", currentTime, {
+                I_STRProxied.modifySecurityToken("LOGAN", "LOG", account_temp, dummy_token, "I am custom ST", currentTime, 0, {
                     from: account_delegate
                 }),
                 "tx revert -> msg.sender is not polymath account"
@@ -764,7 +764,7 @@ contract("SecurityTokenRegistry", async (accounts) => {
 
         it("Should fail to genrate the custom security token -- ticker length is greater than 10 chars", async () => {
             await catchRevert(
-                I_STRProxied.modifySecurityToken("LOGAN", "LOGLOGLOGLOG", account_temp, dummy_token, "I am custom ST", currentTime, {
+                I_STRProxied.modifySecurityToken("LOGAN", "LOGLOGLOGLOG", account_temp, dummy_token, "I am custom ST", currentTime, 0, {
                     from: account_polymath
                 }),
                 "tx revert -> ticker length is greater than 10 chars"
@@ -773,7 +773,7 @@ contract("SecurityTokenRegistry", async (accounts) => {
 
         it("Should fail to generate the custom security token -- name should not be 0 length ", async () => {
             await catchRevert(
-                I_STRProxied.modifySecurityToken("", "LOG", account_temp, dummy_token, "I am custom ST", currentTime, {
+                I_STRProxied.modifySecurityToken("", "LOG", account_temp, dummy_token, "I am custom ST", currentTime, 0, {
                     from: account_polymath
                 }),
                 "tx revert -> name should not be 0 length"
@@ -782,7 +782,7 @@ contract("SecurityTokenRegistry", async (accounts) => {
 
         it("Should fail if ST address is 0 address", async () => {
             await catchRevert(
-                I_STRProxied.modifySecurityToken("LOGAN", "LOG", account_temp, address_zero, "I am custom ST", currentTime, {
+                I_STRProxied.modifySecurityToken("LOGAN", "LOG", account_temp, address_zero, "I am custom ST", currentTime, 0, {
                     from: account_polymath
                 }),
                 "tx revert -> Security token address is 0"
@@ -791,7 +791,7 @@ contract("SecurityTokenRegistry", async (accounts) => {
 
         it("Should fail if symbol length is 0", async () => {
             await catchRevert(
-                I_STRProxied.modifySecurityToken("", "0x0", account_temp, dummy_token, "I am custom ST", currentTime, {
+                I_STRProxied.modifySecurityToken("", "0x0", account_temp, dummy_token, "I am custom ST", currentTime, 0, {
                     from: account_polymath
                 }),
                 "tx revert -> zero length of the symbol is not allowed"
@@ -800,7 +800,7 @@ contract("SecurityTokenRegistry", async (accounts) => {
 
         it("Should fail to generate the custom ST -- deployedAt param is 0", async () => {
             await catchRevert(
-                I_STRProxied.modifySecurityToken(name2, symbol2, token_owner, dummy_token, "I am custom ST", new BN(0), { from: account_polymath }),
+                I_STRProxied.modifySecurityToken(name2, symbol2, token_owner, dummy_token, "I am custom ST", new BN(0), 0, { from: account_polymath }),
                 "tx revert -> because deployedAt param is 0"
             );
         });
@@ -815,7 +815,7 @@ contract("SecurityTokenRegistry", async (accounts) => {
             tickersListArray = await I_Getter.getTickersByOwner.call(account_temp);
             console.log(tickersListArray);
             // Generating the ST
-            let tx = await I_STRProxied.modifySecurityToken("LOGAN", "LOG", account_temp, dummy_token, "I am custom ST", currentTime, {
+            let tx = await I_STRProxied.modifySecurityToken("LOGAN", "LOG", account_temp, dummy_token, "I am custom ST", currentTime, 0, {
                 from: account_polymath
             });
             tickersListArray = await I_Getter.getTickersByOwner.call(account_temp);
@@ -837,7 +837,7 @@ contract("SecurityTokenRegistry", async (accounts) => {
             // await catchRevert(I_STRProxied.modifySecurityToken("LOGAN2", "LOG2", account_temp, dummy_token, "I am custom ST", await latestTime(), {from: account_polymath}));
             // await I_STRProxied.modifyTicker(account_temp, "LOG2", "LOGAN2", await latestTime(), currentTime.add(new BN(duration.days(10))), false, {from: account_polymath});
             // await increaseTime(duration.days(1));
-            let tx = await I_STRProxied.modifySecurityToken("LOGAN2", "LOG2", account_temp, dummy_token, "I am custom ST", currentTime, {
+            let tx = await I_STRProxied.modifySecurityToken("LOGAN2", "LOG2", account_temp, dummy_token, "I am custom ST", currentTime, 0, {
                 from: account_polymath
             });
             assert.equal(tx.logs[1].args._ticker, "LOG2", "Symbol should match with the registered symbol");