fix: introduce forceContrectsToCompile to ensure that contracts not p…

…resent in the source path are compiled (#1290)

Co-authored-by: Marko Arambasic <makiarambasic@gmail.com>

packages/hardhat-zksync-solc/src/index.ts

@@ -193,6 +193,10 @@ subtask(TASK_COMPILE_SOLIDITY_GET_SOURCE_NAMES, async (args: { sourcePaths: stri
         return await runSuper(args);
     }
 
+    if (hre.config.zksolc.settings.forceContractsToCompile) {
+        return hre.config.zksolc.settings.forceContractsToCompile;
+    }
+
     const contractsToCompile: string[] | undefined = hre.config.zksolc.settings.contractsToCompile;
 
     if (!contractsToCompile || contractsToCompile.length === 0) {

packages/hardhat-zksync-solc/src/types.ts

@@ -40,8 +40,10 @@ export interface ZkSolcConfig {
         forceEvmla?: boolean;
         // Evmla intermediate representation
         forceEVMLA?: boolean;
-        // Specific contracts to be compiled
+        // Specific contracts present in source to be compiled
         contractsToCompile?: string[];
+        // Specific only contracts forced to be compiled even if they are not present in source
+        forceContractsToCompile?: string[];
         // Dump all IR (Yul, EVMLA, LLVM IR, assembly) to files in the specified directory. Only for testing and debugging.
         debugOutputDir?: string;
     };

packages/hardhat-zksync-solc/test/fixture-projects/multiple-contracts/overrideContracts/Greeter.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity >=0.4.22 <0.9.0;
+
+contract Greeter {
+
+    string greeting;
+    string bad;
+    constructor(string memory _greeting) {
+        greeting = _greeting;
+        bad = "baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaad";
+    }
+
+    function greet() public view returns (string memory) {
+        return greeting;
+    }
+
+}

packages/hardhat-zksync-solc/test/fixture-projects/multiple-contracts/overrideContracts/Greeter2.sol

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity >=0.4.22 <0.9.0;
+
+contract Greeter2 {
+
+    string greeting;
+    string bad;
+    constructor(string memory _greeting) {
+        greeting = _greeting;
+        bad = "baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaad";
+    }
+
+    function greet() public view returns (string memory) {
+        return greeting;
+    }
+
+}

packages/hardhat-zksync-solc/test/tests/tests.ts

@@ -94,6 +94,21 @@ describe('zksolc plugin', async function () {
             assert.equal(1, sourceNames.length);
             assert.equal('contracts/Greeter.sol', sourceNames[0]);
         });
+
+        it('Should successfully return only Greeter contract for compiling which is not present in source paths', async function () {
+            this.env.config.zksolc.settings.forceContractsToCompile = ['overrideContracts/Greeter.sol'];
+
+            const rootPath = this.env.config.paths.root;
+            const sourcePaths: string[] = [`${rootPath}/contracts/Greeter.sol`, `${rootPath}/contracts/Greeter2.sol`];
+
+            const sourceNames: string[] = await this.env.run(TASK_COMPILE_SOLIDITY_GET_SOURCE_NAMES, {
+                rootPath,
+                sourcePaths,
+            });
+
+            assert.equal(1, sourceNames.length);
+            assert.equal('overrideContracts/Greeter.sol', sourceNames[0]);
+        });
     });
 
     describe('Compilation jobs', async function () {