chore(gateway-contracts): add getRequiredAddressEnvVar util for tasks (#1278)

Author: melanciani

gateway-contracts/tasks/deployment/contracts.ts

@@ -2,7 +2,7 @@ import { Wallet } from "ethers";
 import { task, types } from "hardhat/config";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 
-import { getRequiredEnvVar, loadGatewayAddresses, pascalCaseToAddressEnvVar } from "../utils";
+import { getRequiredAddressEnvVar, getRequiredEnvVar, loadGatewayAddresses } from "../utils";
 import { setPaymentBridgingContractAddresses } from "./paymentBridging/setAddresses";
 import { GATEWAY_CONFIG_EMPTY_PROXY_NAME, REGULAR_EMPTY_PROXY_NAME } from "./utils";
 
@@ -28,11 +28,8 @@ async function deployContractImplementation(
     loadGatewayAddresses();
   }
 
-  // Determine env variable name for the proxy contract address
-  const addressEnvVarName = pascalCaseToAddressEnvVar(name);
-
   // Get the proxy address
-  const proxyAddress = getRequiredEnvVar(addressEnvVarName);
+  const proxyAddress = getRequiredAddressEnvVar(name);
 
   // Force import
   const proxy = await upgrades.forceImport(proxyAddress, proxyImplementation);

gateway-contracts/tasks/deployment/paymentBridging/setAddresses.ts

@@ -1,14 +1,14 @@
 import { task, types } from "hardhat/config";
 
-import { getRequiredEnvVar, loadAddressEnvVarsFromFile, pascalCaseToAddressEnvVar } from "../../utils";
+import { getRequiredAddressEnvVar, loadAddressEnvVarsFromFile } from "../../utils";
 import { appendAddressToSolidityFile, createSolidityAddressesFile } from "../utils";
 import { MOCKED_PAYMENT_BRIDGING_ADDRESSES_ENV_FILE_NAME } from "./mocked";
 
 // Define the file names for registering the payment bridging contract addresses
 const PAYMENT_BRIDGING_ADDRESSES_SOLIDITY_FILE_NAME = "PaymentBridgingAddresses.sol";
 
 function setPaymentBridgingContractAddress(name: string) {
-  const address = getRequiredEnvVar(pascalCaseToAddressEnvVar(name));
+  const address = getRequiredAddressEnvVar(name);
 
   console.log(`Setting ${name} address`);
   appendAddressToSolidityFile(name, address, PAYMENT_BRIDGING_ADDRESSES_SOLIDITY_FILE_NAME);

gateway-contracts/tasks/ownership.ts

@@ -1,8 +1,7 @@
 import { Wallet } from "ethers";
 import { task, types } from "hardhat/config";
 
-import { getRequiredEnvVar } from "./utils/loadVariables";
-import { pascalCaseToSnakeCase } from "./utils/stringOps";
+import { getRequiredAddressEnvVar, getRequiredEnvVar } from "./utils/loadVariables";
 
 task(
   "task:transferGatewayOwnership",
@@ -14,9 +13,7 @@ task(
     const deployer = new Wallet(getRequiredEnvVar("DEPLOYER_PRIVATE_KEY")).connect(ethers.provider);
 
     // Get the GatewayConfig contract: its owner is the owner of all gateway contracts
-    const gatewayConfigSnakeCase = pascalCaseToSnakeCase("GatewayConfig");
-    const gatewayConfigAddressEnvVarName = `${gatewayConfigSnakeCase.toUpperCase()}_ADDRESS`;
-    const gatewayConfigContractAddress = getRequiredEnvVar(gatewayConfigAddressEnvVarName);
+    const gatewayConfigContractAddress = getRequiredAddressEnvVar("GatewayConfig");
     const gatewayConfigContract = await ethers.getContractAt("GatewayConfig", gatewayConfigContractAddress);
 
     if ((await gatewayConfigContract.owner()) !== deployer.address) {
@@ -44,9 +41,7 @@ task(
   const newOwner = new Wallet(getRequiredEnvVar("NEW_OWNER_PRIVATE_KEY")).connect(ethers.provider);
 
   // Get the GatewayConfig contract: its owner is the owner of all gateway contracts
-  const gatewayConfigSnakeCase = pascalCaseToSnakeCase("GatewayConfig");
-  const gatewayConfigAddressEnvVarName = `${gatewayConfigSnakeCase.toUpperCase()}_ADDRESS`;
-  const gatewayConfigContractAddress = getRequiredEnvVar(gatewayConfigAddressEnvVarName);
+  const gatewayConfigContractAddress = getRequiredAddressEnvVar("GatewayConfig");
   const gatewayConfigContract = await ethers.getContractAt("GatewayConfig", gatewayConfigContractAddress);
 
   if ((await gatewayConfigContract.pendingOwner()) !== newOwner.address) {

gateway-contracts/tasks/pauseContracts.ts

@@ -2,8 +2,7 @@ import { Wallet } from "ethers";
 import { task, types } from "hardhat/config";
 import { HardhatEthersHelpers } from "hardhat/types";
 
-import { getRequiredEnvVar, loadGatewayAddresses } from "./utils";
-import { pascalCaseToSnakeCase } from "./utils/stringOps";
+import { getRequiredAddressEnvVar, getRequiredEnvVar, loadGatewayAddresses } from "./utils";
 
 // Helper function to get a Gateway contract and its proxy address
 async function getGatewayContract(
@@ -21,12 +20,8 @@ async function getGatewayContract(
     loadGatewayAddresses();
   }
 
-  // Determine env variable name for the proxy contract address
-  const nameSnakeCase = pascalCaseToSnakeCase(name);
-  const addressEnvVarName = `${nameSnakeCase.toUpperCase()}_ADDRESS`;
-
   // Get the proxy address
-  const proxyAddress = getRequiredEnvVar(addressEnvVarName);
+  const proxyAddress = getRequiredAddressEnvVar(name);
 
   const contract = await ethers.getContractAt(name, proxyAddress, account);
 

gateway-contracts/tasks/utils/loadVariables.ts

@@ -14,6 +14,13 @@ export function getRequiredEnvVar(name: string): string {
   return process.env[name]!;
 }
 
+// Get the required address from the environment variable, throw an error if it's not set
+// We only check if the variable is set, not if it's empty
+export function getRequiredAddressEnvVar(name: string): string {
+  const addressEnvVarName = pascalCaseToAddressEnvVar(name);
+  return getRequiredEnvVar(addressEnvVarName);
+}
+
 // Load the addresses as environment variables from the env file
 export function loadAddressEnvVarsFromFile(fileName: string) {
   const envFilePath = path.join(ADDRESSES_DIR, fileName);