Merge pull request #744 from F-OBrien/IST-Check-Script

IST Check script

Author: pabloruiz55

.circleci/config.yml

@@ -65,7 +65,7 @@ jobs:
       - run: node --version
       - run: truffle version
       - run: npm run clash-check
-      - run: npm run istr-check
+      - run: npm run i-check
       - save_cache:
           key: dependency-cache-{{ checksum "package.json" }}
           paths:

contracts/interfaces/ISecurityToken.sol

@@ -42,7 +42,8 @@ interface ISecurityToken {
         bytes32 _label,
         bool _archived
     );
-
+    // Emit when Module get upgraded from the securityToken
+    event ModuleUpgraded(uint8[] _types, address _module);
     // Emit when the token details get updated
     event UpdateTokenDetails(string _oldDetails, string _newDetails);
     // Emit when the token name get updated
@@ -410,7 +411,7 @@ interface ISecurityToken {
      * @param _tokenHolder Whom balance need to queried
      * @return List of partitions
      */
-    function partitionsOf(address _tokenHolder) external view returns (bytes32[] memory partitions);
+    function partitionsOf(address _tokenHolder) external pure returns (bytes32[] memory partitions);
 
     /**
      * @notice Gets data store address

package.json

@@ -9,7 +9,7 @@
   "scripts": {
     "test": "scripts/test.sh 2> /dev/null",
     "clash-check": "node scripts/clashCheck.js",
-    "istr-check": "node scripts/ISTRCheck.js",
+    "i-check": "node scripts/ICheck.js",
     "gas": "scripts/gasUsage.sh",
     "wintest": "scripts\\wintest.cmd",
     "wincov": "scripts\\wincov.cmd",

scripts/ICheck.js

@@ -0,0 +1,144 @@
+const fs = require('fs');
+const exec = require('child_process').execSync;
+const chalk = require('chalk');
+
+// These functions/events are allowed to differ. (These are present in STR/STRGetter but not used and hence not defined in ISTR)
+let strExceptions = [
+    "initialize",
+    "getBytes32Value",
+    "getBytesValue",
+    "getAddressValue",
+    "getArrayAddress",
+    "getBoolValue",
+    "getStringValue",
+    "getArrayBytes32",
+    "getUintValue",
+    "getArrayUint",
+    undefined, // constructor
+];
+
+// These functions/events are allowed to differ. (These are present in ST/STGetter but not used and hence not defined in IST)
+let stExceptions = [
+    undefined, // constructor
+];
+
+async function readFiles() {
+    if (!fs.existsSync("./build/contracts/ISecurityTokenRegistry.json") || !fs.existsSync("./build/contracts/ISecurityToken.json")) {
+        console.log(chalk.yellow('Compiling contracts. This may take a while, please wait.'));
+        exec('./node_modules/.bin/truffle compile');
+    }
+    let strABIs = [
+        JSON.parse(fs.readFileSync(`./build/contracts/ISecurityTokenRegistry.json`).toString()).abi,
+        JSON.parse(fs.readFileSync(`./build/contracts/SecurityTokenRegistry.json`).toString()).abi,
+        JSON.parse(fs.readFileSync(`./build/contracts/STRGetter.json`).toString()).abi
+    ];
+    let stABIs = [
+        JSON.parse(fs.readFileSync(`./build/contracts/ISecurityToken.json`).toString()).abi,
+        JSON.parse(fs.readFileSync(`./build/contracts/SecurityToken.json`).toString()).abi,
+        JSON.parse(fs.readFileSync(`./build/contracts/STGetter.json`).toString()).abi
+    ];
+    return [strABIs, stABIs];
+    }
+
+async function checkInterfaces() {
+    // Reading ABIs from build files
+    let [strABIs, stABIs] = await readFiles();
+    // Perform checks on the interface files
+    let strMismatch = await interfaceCheck(strABIs, strExceptions, "ISecurityTokenRegistry");
+    let stMismatch = await interfaceCheck(stABIs, stExceptions, "ISecurityToken");
+    if (strMismatch || stMismatch) {process.exit(1)};
+    console.log(chalk.green("Interface checks finished. No mismatch was found between interfaces and contacts"));
+}
+
+async function interfaceCheck(ABIs, exceptions, interfaceName) {
+    // Removing functions/events defined in the exceptions arrays.
+    removeExceptions(ABIs, exceptions);
+    // Removing parameter and return names from ABIs as they can differ.
+    // Only cleaning ABIs of third file as other files can be cleaned in the following loops efficiently.
+    for (let i = 0; i < ABIs[2].length; i++) {
+        cleanABI(ABIs[2][i]);
+    }
+    // Removing one instance of duplicates common to main contract and getter contract
+    removeDuplicates(ABIs);
+    // Combine second and third ABI after duplicates were removed
+    ABIs = [ABIs[0],[...ABIs[1],...ABIs[2]]];
+
+    // This function removes elements that match between the interface and contracts
+    // i.e If the signature matches in Interface and the contract, it is removed from the ABI.
+    // This means that the left over elements after this loop are mistakes.
+    for (let i = 0; i < ABIs[0].length; i++) {
+        let fna = cleanABI(ABIs[0][i]);
+        for (let j = 0; j < ABIs[1].length; j++) {
+            let fnb = ABIs[1][j];
+            if (fna.name == fnb.name && fna.type == fnb.type) {
+                if (JSON.stringify(fna) === JSON.stringify(fnb)) {
+                    ABIs[0].splice(i, 1);
+                    ABIs[1].splice(j, 1);
+                    i--;
+                    break;
+                }
+            }
+        }
+    }
+
+    // If there is any element remaining in either ABI, it is an error and they should be reported.
+    if (ABIs[0].length >= 1 || ABIs[1].length >= 1) {
+        for (let i = 0; i < ABIs[0].length; i++) {
+            console.log(ABIs[0][i].name);
+        }
+        for (let i = 0; i < ABIs[1].length; i++) {
+            console.log(ABIs[1][i].name);
+        }
+        console.log(chalk.red('The above Functions/events had a mismatch with ' + interfaceName + '. Please synchronize the Interface with the contract.\n'));
+        return true;
+    }
+    return false;
+}
+
+// This function removes parameter and return names from ABIs as they can differ.
+function cleanABI(element) {
+    if (element.type === 'event') {
+        for(let i = 0; i < element.inputs.length; i++) {
+            element.inputs[i].name = "";
+        }
+    } else if (element.type === 'function') {
+        for(let i = 0; i < element.inputs.length; i++) {
+            element.inputs[i].name = "";
+        }
+        for(let i = 0; i < element.outputs.length; i++) {
+            element.outputs[i].name = "";
+        }
+    }
+    return element;
+}
+
+// This function removes one instance of duplicates common to main contract and getter
+function removeDuplicates(ABIs) {
+    for (let i = 0; i < ABIs[1].length; i++) {
+        let fna = cleanABI(ABIs[1][i]);
+        for (let j = 0; j < ABIs[2].length; j++) {
+            let fnb = ABIs[2][j];
+            if (fna.name == fnb.name && fna.type == fnb.type) {
+                if (JSON.stringify(fna) === JSON.stringify(fnb)) {
+                    ABIs[1].splice(i, 1);
+                    i--;
+                    break;
+                }
+            }
+        }
+    }
+}
+
+// This function removes functions/events defined in an exceptions arrays.
+function removeExceptions(ABIs, exceptions) {
+    for (let i = 0; i < ABIs.length; i++) {
+        for (let j = 0; j < ABIs[i].length; j++) {
+            if (exceptions.includes(ABIs[i][j].name)) {
+                ABIs[i].splice(j, 1);
+                j--;
+            }
+        }
+    }
+}
+
+checkInterfaces();