flag added to allow zeroAddress (#988)

script/deploy/facets/DeployArbitrumBridgeFacet.s.sol

@@ -28,6 +28,7 @@ contract DeployScript is DeployScriptBase {
             path,
             string.concat(".", network, ".gatewayRouter")
         );
+
         address inbox = _getConfigContractAddress(
             path,
             string.concat(".", network, ".inbox")

script/deploy/facets/DeployCelerCircleBridgeFacet.s.sol

@@ -28,6 +28,7 @@ contract DeployScript is DeployScriptBase {
             path,
             string.concat(".", network, ".circleBridgeProxy")
         );
+
         address usdc = _getConfigContractAddress(
             path,
             string.concat(".", network, ".usdc")

script/deploy/facets/DeployGenericSwapFacetV3.s.sol

@@ -24,10 +24,10 @@ contract DeployScript is DeployScriptBase {
     function getConstructorArgs() internal override returns (bytes memory) {
         // get path of global config file
         string memory path = string.concat(root, "/config/networks.json");
+        string memory json = vm.readFile(path);
 
         // extract network's native address
-        address nativeAddress = _getConfigContractAddress(
-            path,
+        address nativeAddress = json.readAddress(
             string.concat(".", network, ".nativeAddress")
         );
 

script/deploy/facets/DeployReceiver.s.sol

@@ -34,20 +34,20 @@ contract DeployScript is DeployScriptBase {
             ".refundWallet"
         );
 
-        // obtain address of Stargate router in current network from config file
+        // obtain address of Stargate router in current network from config file (may be address(0), if stargate is not available on this chain)
         string memory path = string.concat(root, "/config/stargate.json");
-
         address stargateRouter = _getConfigContractAddress(
             path,
-            string.concat(".composers.", network)
+            string.concat(".composers.", network),
+            true
         );
 
-        // obtain address of Amarok router in current network from config file
+        // obtain address of Amarok router in current network from config file (may be address(0), if amarok is not available on this chain)
         path = string.concat(root, "/config/amarok.json");
-
         address amarokRouter = _getConfigContractAddress(
             path,
-            string.concat(".", network, ".connextHandler")
+            string.concat(".", network, ".connextHandler"),
+            true
         );
 
         path = string.concat(

script/deploy/facets/DeployRelayFacet.s.sol

@@ -21,13 +21,15 @@ contract DeployScript is DeployScriptBase {
 
     function getConstructorArgs() internal override returns (bytes memory) {
         string memory path = string.concat(root, "/config/relay.json");
+        string memory json = vm.readFile(path);
 
         address relayReceiver = _getConfigContractAddress(
             path,
             string.concat(".", network, ".relayReceiver")
         );
-        address relaySolver = _getConfigContractAddress(
-            path,
+
+        // the relaySolver address is the same address on all mainnets (and it's not a contract)
+        address relaySolver = json.readAddress(
             string.concat(".", network, ".relaySolver")
         );
 

script/deploy/facets/utils/ScriptBase.sol

@@ -25,17 +25,40 @@ contract ScriptBase is Script, DSTest {
         fileSuffix = vm.envString("FILE_SUFFIX");
     }
 
-    // reads an address from a config file and makes sure that the address contains code
+    // reads an address from a config file and makes sure that the address contains code, it will not check for contract and still return the address
     function _getConfigContractAddress(
         string memory path,
         string memory key
+    ) internal returns (address contractAddress) {
+        return _getConfigContractAddress(path, key, false);
+    }
+
+    // reads an address from a config file and makes sure that the address contains code
+    function _getConfigContractAddress(
+        string memory path,
+        string memory key,
+        bool allowZeroAddress // if zeroAddress is found, it will not check for contract and still return the address
     ) internal returns (address contractAddress) {
         // load json file
         string memory json = vm.readFile(path);
 
         // read address
         contractAddress = json.readAddress(key);
 
+        // only allow address(0) values if flag is set accordingly, otherwise revert
+        if (contractAddress == address(0))
+            if (allowZeroAddress) return contractAddress;
+            else
+                revert(
+                    string.concat(
+                        "Found address(0) for key ",
+                        key,
+                        " in file ",
+                        path,
+                        " which is not allowed here"
+                    )
+                );
+
         // check if address contains code
         if (!LibAsset.isContract(contractAddress))
             revert(

script/deploy/zksync/DeployGenericSwapFacetV3.zksync.s.sol

@@ -24,10 +24,10 @@ contract DeployScript is DeployScriptBase {
     function getConstructorArgs() internal override returns (bytes memory) {
         // get path of global config file
         string memory path = string.concat(root, "/config/networks.json");
+        string memory json = vm.readFile(path);
 
         // extract network's native address
-        address nativeAddress = _getConfigContractAddress(
-            path,
+        address nativeAddress = json.readAddress(
             string.concat(".", network, ".nativeAddress")
         );
 

script/deploy/zksync/DeployReceiver.zksync.s.sol

@@ -39,15 +39,17 @@ contract DeployScript is DeployScriptBase {
 
         address stargateRouter = _getConfigContractAddress(
             path,
-            string.concat(".composers.", network)
+            string.concat(".composers.", network),
+            true
         );
 
         // obtain address of Amarok router in current network from config file
         path = string.concat(root, "/config/amarok.json");
 
         address amarokRouter = _getConfigContractAddress(
             path,
-            string.concat(".", network, ".connextHandler")
+            string.concat(".", network, ".connextHandler"),
+            true
         );
 
         path = string.concat(

script/deploy/zksync/DeployRelayFacet.zksync.s.sol

@@ -21,13 +21,15 @@ contract DeployScript is DeployScriptBase {
 
     function getConstructorArgs() internal override returns (bytes memory) {
         string memory path = string.concat(root, "/config/relay.json");
+        string memory json = vm.readFile(path);
 
         address relayReceiver = _getConfigContractAddress(
             path,
             string.concat(".", network, ".relayReceiver")
         );
-        address relaySolver = _getConfigContractAddress(
-            path,
+
+        // the relaySolver address is the same address on all mainnets (and it's not a contract)
+        address relaySolver = json.readAddress(
             string.concat(".", network, ".relaySolver")
         );
 

templates/facetDeployScript.template.hbs

@@ -25,7 +25,7 @@ contract DeployScript is DeployScriptBase {
         string memory json = vm.readFile(path);
 
         // If you need to read an address from your config file or from a network deploy log that is supposed to be a contract, use the
-        // following helper function which makes sure that the address contains code:
+        // following helper function which makes sure that the address contains code (and has a optional flag for allowing address(0)):
         //
         // address example = _getConfigContractAddress(json,string.concat(".", network, ".example"));
         //