fix: review comments

Author: ameeshaagrawal

.env.example

@@ -1,11 +1,10 @@
 #global settings
 NODE_ENV="production"
 DOTENV_CONFIG_PATH=./.env
-DEPLOYMENT_MODE=dev
+DEPLOYMENT_MODE="dev | surge | prod"
 
-# deployment keys/mnmeonic/relayers
+# deployment keys/relayers
 SOCKET_SIGNER_KEY=xxx
-MNEMONIC=xxx
 
 RELAYER_URL_DEV=""
 RELAYER_URL_SURGE=""
@@ -29,9 +28,6 @@ BSC_TESTNET_RPC='https://data-seed-prebsc-1-s1.binance.org:8545'
 ETHEREUM_RPC='https://rpc.ankr.com/eth'
 GOERLI_RPC='https://rpc.ankr.com/eth_goerli'
 
-# default rpc
-INFURA_API_KEY=xxx
-
 # etherscan verification
 ETHERSCAN_API_KEY=xxx
 POLYGONSCAN_API_KEY=xxx

README.md

@@ -41,7 +41,7 @@ yarn install
 │   └── forge-std - forge dependencies installed as git submodules
 |
 └── scripts
-|   └── contains different scripts needed for
+|   └── contains different scripts needed for deployment, configuration and admin related transactions
 |
 └── test
 |   └── Contract.t.sol - Tests for core contracts

hardhat.config.ts

@@ -9,7 +9,10 @@ import "hardhat-change-network";
 
 import { config as dotenvConfig } from "dotenv";
 import type { HardhatUserConfig } from "hardhat/config";
-import type { NetworkUserConfig } from "hardhat/types";
+import type {
+  HardhatNetworkAccountUserConfig,
+  NetworkUserConfig,
+} from "hardhat/types";
 import { resolve } from "path";
 import fs from "fs";
 
@@ -19,24 +22,16 @@ import { ChainKey, chainKeyToSlug } from "./src";
 
 const dotenvConfigPath: string = process.env.DOTENV_CONFIG_PATH || "./.env";
 dotenvConfig({ path: resolve(__dirname, dotenvConfigPath) });
-
 const isProduction = process.env.NODE_ENV === "production";
 
 // Ensure that we have all the environment variables we need.
-const mnemonic: string | undefined = process.env.MNEMONIC;
-
-const infuraApiKey: string | undefined = process.env.INFURA_API_KEY;
-if (!infuraApiKey && isProduction) {
-  throw new Error("Please set your INFURA_API_KEY in a .env file");
-}
+if (!process.env.SOCKET_SIGNER_KEY) throw new Error("No private key found");
+const privateKey: HardhatNetworkAccountUserConfig = process.env
+  .SOCKET_SIGNER_KEY as unknown as HardhatNetworkAccountUserConfig;
 
 function getChainConfig(chain: keyof typeof chainKeyToSlug): NetworkUserConfig {
   return {
-    accounts: {
-      count: 10,
-      mnemonic,
-      path: "m/44'/60'/0'/0",
-    },
+    accounts: [`0x${privateKey}`],
     chainId: chainKeyToSlug[chain],
     gasPrice: gasPrice[chain] ? gasPrice[chain] : "auto",
     url: getJsonRpcUrl(chain),
@@ -52,7 +47,7 @@ function getRemappings() {
 }
 
 let liveNetworks = {};
-if (mnemonic && infuraApiKey && isProduction) {
+if (isProduction) {
   liveNetworks = {
     "arbitrum-goerli": getChainConfig(ChainKey.ARBITRUM_GOERLI),
     "optimism-goerli": getChainConfig(ChainKey.OPTIMISM_GOERLI),
@@ -113,20 +108,6 @@ const config: HardhatUserConfig = {
     },
     ...liveNetworks,
   },
-  namedAccounts: {
-    socketOwner: {
-      default: 0,
-    },
-    counterOwner: {
-      default: 1,
-    },
-    pauser: {
-      default: 2,
-    },
-    user: {
-      default: 3,
-    },
-  },
   paths: {
     sources: "./contracts",
     cache: "./cache_hardhat",

scripts/constants/networks.ts

@@ -6,8 +6,6 @@ import { ChainKey, networkToChainSlug } from "../../src";
 const dotenvConfigPath: string = process.env.DOTENV_CONFIG_PATH || "./.env";
 dotenvConfig({ path: resolve(__dirname, dotenvConfigPath) });
 
-const infuraApiKey: string | undefined = process.env.INFURA_API_KEY;
-
 export const gasPrice: {
   [chainKEY in ChainKey]?: number | "auto" | undefined;
 } = {
@@ -79,7 +77,7 @@ export function getJsonRpcUrl(chain: ChainKey): string {
       break;
 
     default:
-      jsonRpcUrl = "https://" + chain + ".infura.io/v3/" + infuraApiKey;
+      throw new Error("JSON RPC URL not found!!");
   }
 
   return jsonRpcUrl;

scripts/deploy/DEPLOY.md

@@ -6,6 +6,7 @@ To deploy the entire setup, follow these steps:
 - [Grant Roles](#grant-roles): grant roles for different actions (watcher/transmitter/executor/governance, etc.)
 - [Configure](#configure): configure chains for their siblings
 - [Connect](#connect): configure example counters to send messages to siblings
+- [Verify setup](#verify-setup): queries contracts available in `${mode}_addresses.json` and checks if everything is set as expected.
 
 There are three different modes for deployment (prod, dev, and surge) which are used in naming address JSON and selecting configurations. All deploy scripts use [config.ts](./config.ts).
 
@@ -59,3 +60,11 @@ This script:
   `npx hardhat run scripts/deploy/connect.ts`
 
 This script connects the plugs to their siblings for all the chains that exist in the `integrations` object for that chain.
+
+### Verify Setup
+
+- To run this script, make sure the contract addresses exist in `${mode}_addresses.json`
+- Run the script with the command:
+  `npx hardhat run scripts/deploy/verifyDeployments.ts`
+
+The output will show if all the configurations are set properly.

scripts/deploy/scripts/deploy-gasprice-oracle.ts

@@ -14,10 +14,8 @@ import { mode, transmitterAddresses } from "../config";
 export const main = async () => {
   try {
     // assign deployers
-    const { getNamedAccounts } = hre;
-    const { socketOwner } = await getNamedAccounts();
-    const socketSigner: SignerWithAddress = await ethers.getSigner(socketOwner);
-
+    const socketSigners: SignerWithAddress = await ethers.getSigners();
+    const socketSigner = socketSigners[0];
     const network = hre.network.name;
 
     const gasPriceOracle: Contract = await deployContractWithArgs(

scripts/deploy/scripts/outbound.ts

@@ -2,7 +2,7 @@ import { config as dotenvConfig } from "dotenv";
 dotenvConfig();
 
 import fs from "fs";
-import { getNamedAccounts, ethers } from "hardhat";
+import { ethers } from "hardhat";
 import { SignerWithAddress } from "@nomiclabs/hardhat-ethers/signers";
 
 import { getInstance, getChainSlug, deployedAddressPath } from "../utils";
@@ -23,8 +23,8 @@ export const main = async () => {
       fs.readFileSync(deployedAddressPath(mode), "utf-8")
     );
 
-    const { counterOwner } = await getNamedAccounts();
-    const signer: SignerWithAddress = await ethers.getSigner(counterOwner);
+    const socketSigners: SignerWithAddress = await ethers.getSigners();
+    const signer = socketSigners[0];
 
     const counter: Contract = await getInstance(
       "Counter",

scripts/deploy/scripts/untrip-path-in-switchboard.ts

@@ -8,12 +8,13 @@ import {
 } from "../../../src";
 import { mode } from "../config";
 
+const srcChainSlug = ChainSlug.GOERLI;
+const privateKey = process.env.SOCKET_SIGNER_KEY;
+
+// update the inputs to the
 export const main = async () => {
   try {
     const chainSlug = await getChainSlug();
-    const srcChainSlug = ChainSlug.GOERLI;
-    const privateKey = "";
-
     const signer = new ethers.Wallet(privateKey, ethers.provider);
 
     const switchBoardAddress = getSwitchboardAddress(

scripts/deploy/scripts/upgradeSigVerifier.ts

@@ -2,7 +2,7 @@ import { config as dotenvConfig } from "dotenv";
 dotenvConfig();
 
 import fs from "fs";
-import { getNamedAccounts, ethers } from "hardhat";
+import { ethers } from "hardhat";
 import { SignerWithAddress } from "@nomiclabs/hardhat-ethers/signers";
 
 import {
@@ -24,11 +24,11 @@ export const main = async () => {
     const config: any = JSON.parse(
       fs.readFileSync(deployedAddressPath(mode) + chainSlug + ".json", "utf-8")
     );
-    const { socketOwner } = await getNamedAccounts();
 
-    const socketSigner: SignerWithAddress = await ethers.getSigner(socketOwner);
-    const notary = await getInstance("AdminNotary", config["notary"]);
+    const socketSigners: SignerWithAddress = await ethers.getSigners();
+    const socketSigner = socketSigners[0];
 
+    const notary = await getInstance("AdminNotary", config["notary"]);
     const signatureVerifier: Contract = await deployContractWithArgs(
       "SignatureVerifier",
       [],

scripts/deploy/utils/signers.ts

@@ -2,7 +2,7 @@
   "compilerOptions": {
     "target": "es2018",
     "module": "commonjs",
-    "strict": false,
+    "strict": true,
     "esModuleInterop": true,
     "outDir": "dist",
     "declaration": true,