fixed utils for clashing tests

Author: Kotsin

package-lock.json

@@ -11,7 +11,7 @@
         "flat": "bash scripts/make_flat.sh",
         "solidity-docgen": "rm -rf docs/docs/api* && npm i && npx hardhat docgen --exclude interfaces,libs,ERC677BridgeTokenRewardable.sol,Migrations.sol . contracts docs && node docs/website/sidebars-fix.js",
         "generate-uml": "sol2uml ./contracts -o docs/classDiagram.svg",
-        "test": "npx hardhat test",
+        "test": "node scripts/check_for_clashing.js && npx hardhat test",
         "testNoUpgradeProxy": "export CONTRACTS_NO_UPGRADE_PROXY=true && node scripts/check_for_clashing.js && bash scripts/test.sh",
         "testOnTestnet": "export CONTRACTS_NO_UPGRADE_PROXY=true && ./node_modules/.bin/truffle test  --network testNet test/KeyGenHistory.js test/mockContracts/BlockRewardHbbftCoinsMock.sol  test/mockContracts/RandomHbbftMock.sol test/mockContracts/ValidatorSetHbbftMock.sol test/mockContracts/StakingHbbftCoinsMock.sol",
         "getFunctionSignatures": "node scripts/getFunctionSignatures.js"
@@ -47,8 +47,10 @@
         "hardhat-contract-sizer": "^2.6.1",
         "hardhat-gas-reporter": "^1.0.8",
         "lodash": "^4.17.21",
+        "solc": "^0.8.17",
         "solidity-coverage": "^0.7.21",
         "solidity-docgen": "^0.6.0-beta.29",
-        "typechain": "^8.1.0"
+        "typechain": "^8.1.0",
+        "typescript": "^4.8.4"
     }
 }

package.json

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const solc = require('solc');
+const path = require('node:path');
 
 async function compile(dir, contractName) {
   const input = {
@@ -17,30 +18,36 @@ async function compile(dir, contractName) {
       evmVersion: "istanbul",
       outputSelection: {
         '*': {
-          '*': [ 'abi', 'evm.bytecode.object', 'evm.methodIdentifiers' ]
+          '*': ['abi', 'evm.bytecode.object', 'evm.methodIdentifiers']
         }
       }
     }
   }
 
-  const compiled = JSON.parse(solc.compile(JSON.stringify(input), function(path) {
-    let content;
-    try {
-      content = fs.readFileSync(dir + path);
-    } catch (e) {
-      if (e.code == 'ENOENT') {
-        try {
-          content = fs.readFileSync(dir + '../' + path);
-        } catch (e) {
-          content = fs.readFileSync(dir + '../node_modules/' + path);
-        }
-      }
+  const intermediateFoldersOfCurrentContract = dir.slice(1, -1);
+
+  function findImports(path) {
+    console.log(path)
+    let sourceCodeToImport;
+    if (path[0] === "@") { // directly into node_ module
+      sourceCodeToImport = fs.readFileSync(`../../../node_modules/${path}`);
+      return { contents: `${sourceCodeToImport}` };
     }
-    return {
-      contents: content.toString()
+    if (dir.length === 2) { // array contract path is "./" + contract.sol, i.e simple import in the same folder as the compile.js
+      sourceCodeToImport = fs.readFileSync(`./${path}`);
+      return { contents: `${sourceCodeToImport}` };
     }
-  }));
+    if (!path.includes("/")) { // === contract to import is in the same folder as the contract we are compiling i.e the import path from the contract fiel doesn't include "/"
+      sourceCodeToImport = fs.readFileSync(`./${intermediateFoldersOfCurrentContract}/${path}`);
+      return { contents: `${sourceCodeToImport}` };
+    }
+    else { // if neither of these, contract must be (in my case) accessible from the compile.js, i.e no need to change the path
+      sourceCodeToImport = fs.readFileSync(`./contracts/${path}`);
+      return { contents: `${sourceCodeToImport}` }
+    }
+  }
 
+  const compiled = JSON.parse(solc.compile(JSON.stringify(input), { import: findImports }))
   return compiled.contracts[''][contractName];
 }