feat: input validation

src/commands/config/create.ts

@@ -6,6 +6,7 @@ import { create } from "../../implementations/config/create";
 import { getLogger } from "../../logger";
 import { highlight } from "../../utils";
 import { supportedNetwork } from "../networks";
+import { withWalletOption } from "../shared";
 import { CreateConfigCommand } from "./config.type";
 
 const { trace } = getLogger("config:create");
@@ -15,20 +16,14 @@ export const command = "create [options]";
 export const describe = "Create a config file";
 
 export const builder = (yargs: Argv): Argv =>
-  yargs
-    .option("output-dir", {
+  withWalletOption(
+    yargs.option("output-dir", {
       alias: "od",
       description: "Write output to a directory",
       type: "string",
       demandOption: true,
     })
-    // encrypted wallet path is referenced from command.shared.ts as we need additional properties for this instance.
-    .option("encrypted-wallet-path", {
-      type: "string",
-      description: "Path to wallet.json file",
-      normalize: true,
-      demandOption: true,
-    });
+  );
 
 export const handler = async (args: CreateConfigCommand): Promise<void> => {
   trace(`Args: ${JSON.stringify(args, null, 2)}`);

src/implementations/deploy/token-registry/token-registry.test.ts

@@ -12,77 +12,78 @@ const deployParams: DeployTokenRegistryCommand = {
   dryRun: false,
 };
 
-describe("deploy Token Registry", () => {
-  const mockedEthersContract: jest.Mock<Contract> = Contract as any;
-  // eslint-disable-next-line jest/prefer-spy-on
-  mockedEthersContract.prototype.deploy = jest.fn();
-  const mockedDeploy: jest.Mock = mockedEthersContract.prototype.deploy;
+describe("token-registry", () => {
+  describe("deployTokenRegistry", () => {
+    const mockedEthersContract: jest.Mock<Contract> = Contract as any;
+    // eslint-disable-next-line jest/prefer-spy-on
+    mockedEthersContract.prototype.deploy = jest.fn();
+    const mockedDeploy: jest.Mock = mockedEthersContract.prototype.deploy;
 
-  // increase timeout because ethers is throttling
-  jest.setTimeout(30000);
+    // increase timeout because ethers is throttling
+    jest.setTimeout(30000);
 
-  beforeEach(() => {
-    mockedDeploy.mockReset();
-    mockedDeploy.mockResolvedValue({
-      hash: "hash",
-      blockNumber: "blockNumber",
-      wait: () =>
-        Promise.resolve({
-          events: [
-            {
-              topics: [
-                "0x3588ebb5c75fdf91927f8472318f41513ee567c2612a5ce52ac840dcf6f162f5", // deployment
-                "0x000000000000000000000000426c58c2b29111eafc53bdcb9c99dc7714fdb262",
-                "0x000000000000000000000000e5c75026d5f636c89cc77583b6bce7c99f512763",
-                "0x0000000000000000000000008d366250a96debe81c8619459a503a0eebe33ca6",
-              ],
-              data: "0x000000000000000000000000878a327daa390bc602ae259d3a374610356b6485000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000e0000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000008d366250a96debe81c8619459a503a0eebe33ca60000000000000000000000000000000000000000000000000000000000000011563420546f6b656e20526567697374727900000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000034d54540000000000000000000000000000000000000000000000000000000000",
-              args: [
-                "0xd6C249d0756059E21Ef4Aef4711B69b76927BEA7",
-                "0xC78BA1a49663Ef8b920F36B036E91Ab40D8F26D6",
-                "0x8d366250A96deBE81C8619459a503a0eEBE33ca6",
-                "0x878A327daA390Bc602Ae259D3A374610356b6485",
-                "0x000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000008d366250a96debe81c8619459a503a0eebe33ca60000000000000000000000000000000000000000000000000000000000000011563420546f6b656e20526567697374727900000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000034d54540000000000000000000000000000000000000000000000000000000000",
-              ] as unknown as DeploymentEvent,
-            },
-          ],
-        }),
+    beforeEach(() => {
+      mockedDeploy.mockReset();
+      mockedDeploy.mockResolvedValue({
+        hash: "hash",
+        blockNumber: "blockNumber",
+        wait: () =>
+          Promise.resolve({
+            events: [
+              {
+                topics: [
+                  "0x3588ebb5c75fdf91927f8472318f41513ee567c2612a5ce52ac840dcf6f162f5", // deployment
+                  "0x000000000000000000000000426c58c2b29111eafc53bdcb9c99dc7714fdb262",
+                  "0x000000000000000000000000e5c75026d5f636c89cc77583b6bce7c99f512763",
+                  "0x0000000000000000000000008d366250a96debe81c8619459a503a0eebe33ca6",
+                ],
+                data: "0x000000000000000000000000878a327daa390bc602ae259d3a374610356b6485000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000e0000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000008d366250a96debe81c8619459a503a0eebe33ca60000000000000000000000000000000000000000000000000000000000000011563420546f6b656e20526567697374727900000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000034d54540000000000000000000000000000000000000000000000000000000000",
+                args: [
+                  "0xd6C249d0756059E21Ef4Aef4711B69b76927BEA7",
+                  "0xC78BA1a49663Ef8b920F36B036E91Ab40D8F26D6",
+                  "0x8d366250A96deBE81C8619459a503a0eEBE33ca6",
+                  "0x878A327daA390Bc602Ae259D3A374610356b6485",
+                  "0x000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000000000a00000000000000000000000008d366250a96debe81c8619459a503a0eebe33ca60000000000000000000000000000000000000000000000000000000000000011563420546f6b656e20526567697374727900000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000034d54540000000000000000000000000000000000000000000000000000000000",
+                ] as unknown as DeploymentEvent,
+              },
+            ],
+          }),
+      });
     });
-  });
 
-  it("should pass in the correct params and return the deployed instance", async () => {
-    await deployTokenRegistry(deployParams);
+    it("should pass in the correct params and return the deployed instance", async () => {
+      await deployTokenRegistry(deployParams);
 
-    const expectedInitParams = encodeInitParams({
-      name: deployParams.registryName,
-      symbol: deployParams.registrySymbol,
-      deployer: "0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf",
-    });
+      const expectedInitParams = encodeInitParams({
+        name: deployParams.registryName,
+        symbol: deployParams.registrySymbol,
+        deployer: "0x7E5F4552091A69125d5DfCb7b8C2659029395Bdf",
+      });
 
-    expect(mockedDeploy.mock.calls[0][0]).toEqual("0xC78BA1a49663Ef8b920F36B036E91Ab40D8F26D6");
-    expect(mockedDeploy.mock.calls[0][1]).toEqual(expectedInitParams);
+      expect(mockedDeploy.mock.calls[0][0]).toEqual("0xC78BA1a49663Ef8b920F36B036E91Ab40D8F26D6");
+      expect(mockedDeploy.mock.calls[0][1]).toEqual(expectedInitParams);
 
-    // price should be any length string of digits
-    // expect(mockedDeploy.mock.calls[0][2].gasPrice.toString()).toStrictEqual(expect.stringMatching(/\d+/));
-    // expect(instance.contractAddress).toBe("contractAddress"); // TODO
-  });
+      // price should be any length string of digits
+      // expect(mockedDeploy.mock.calls[0][2].gasPrice.toString()).toStrictEqual(expect.stringMatching(/\d+/));
+      // expect(instance.contractAddress).toBe("contractAddress"); // TODO
+    });
 
-  it("should allow errors to bubble up", async () => {
-    mockedDeploy.mockRejectedValue(new Error("An Error"));
-    await expect(deployTokenRegistry(deployParams)).rejects.toThrow("An Error");
-  });
+    it("should allow errors to bubble up", async () => {
+      mockedDeploy.mockRejectedValue(new Error("An Error"));
+      await expect(deployTokenRegistry(deployParams)).rejects.toThrow("An Error");
+    });
 
-  it("should throw when keys are not found anywhere", async () => {
-    delete process.env.OA_PRIVATE_KEY;
-    await expect(
-      deployTokenRegistry({
-        registryName: "Test",
-        registrySymbol: "Tst",
-        network: "goerli",
-        dryRun: false,
-      })
-    ).rejects.toThrow(
-      "No private key found in OA_PRIVATE_KEY, key, key-file, please supply at least one or supply an encrypted wallet path, or provide aws kms signer information"
-    );
+    it("should throw when keys are not found anywhere", async () => {
+      await expect(
+        deployTokenRegistry({
+          registryName: "Test",
+          registrySymbol: "Tst",
+          network: "goerli",
+          dryRun: false,
+        })
+      ).rejects.toThrow(
+        "No private key found in OA_PRIVATE_KEY, key, key-file, please supply at least one or supply an encrypted wallet path, or provide aws kms signer information"
+      );
+    });
   });
 });

src/implementations/document-store/issue.test.ts

@@ -3,7 +3,6 @@ import { Wallet } from "ethers";
 import { DocumentStoreFactory } from "@govtechsg/document-store";
 import { DocumentStoreIssueCommand } from "../../commands/document-store/document-store-command.type";
 import { addAddressPrefix } from "../../utils";
-import { join } from "path";
 
 jest.mock("@govtechsg/document-store");
 
@@ -15,103 +14,70 @@ const deployParams: DocumentStoreIssueCommand = {
   dryRun: false,
 };
 
-// TODO the following test is very fragile and might break on every interface change of DocumentStoreFactory
-// ideally must setup ganache, and run the function over it
-describe("issue document-store", () => {
+describe("document-store", () => {
   // increase timeout because ethers is throttling
   jest.setTimeout(30000);
-  const mockedDocumentStoreFactory: jest.Mock<DocumentStoreFactory> = DocumentStoreFactory as any;
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore mock static method
-  const mockedConnect: jest.Mock = mockedDocumentStoreFactory.connect;
-  const mockedIssue = jest.fn();
-  const mockCallStaticIssue = jest.fn().mockResolvedValue(undefined);
-
-  beforeEach(() => {
-    delete process.env.OA_PRIVATE_KEY;
-    mockedDocumentStoreFactory.mockReset();
-    mockedConnect.mockReset();
-    mockCallStaticIssue.mockClear();
-    mockedConnect.mockReturnValue({
-      issue: mockedIssue,
-      callStatic: {
-        issue: mockCallStaticIssue,
-      },
-    });
-    mockedIssue.mockReturnValue({
-      hash: "hash",
-      wait: () => Promise.resolve({ transactionHash: "transactionHash" }),
+  describe("issueDocumentStore", () => {
+    const mockedDocumentStoreFactory: jest.Mock<DocumentStoreFactory> = DocumentStoreFactory as any;
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore mock static method
+    const mockedConnect: jest.Mock = mockedDocumentStoreFactory.connect;
+    const mockedIssue = jest.fn();
+    const mockCallStaticIssue = jest.fn().mockResolvedValue(undefined);
+
+    beforeEach(() => {
+      delete process.env.OA_PRIVATE_KEY;
+      mockedDocumentStoreFactory.mockReset();
+      mockedConnect.mockReset();
+      mockCallStaticIssue.mockClear();
+      mockedConnect.mockReturnValue({
+        issue: mockedIssue,
+        callStatic: {
+          issue: mockCallStaticIssue,
+        },
+      });
+      mockedIssue.mockReturnValue({
+        hash: "hash",
+        wait: () => Promise.resolve({ transactionHash: "transactionHash" }),
+      });
     });
-  });
 
-  it("should take in the key from environment variable", async () => {
-    process.env.OA_PRIVATE_KEY = "0000000000000000000000000000000000000000000000000000000000000002";
+    it("should take in the key from environment variable", async () => {
+      process.env.OA_PRIVATE_KEY = "0000000000000000000000000000000000000000000000000000000000000002";
 
-    await issueToDocumentStore({
-      hash: "0xabcd",
-      address: "0x1234",
-      network: "goerli",
-      dryRun: false,
-    });
-
-    const passedSigner: Wallet = mockedConnect.mock.calls[0][1];
-    expect(passedSigner.privateKey).toBe(`0x${process.env.OA_PRIVATE_KEY}`);
-  });
+      await issueToDocumentStore({
+        hash: "0xabcd",
+        address: "0x1234",
+        network: "goerli",
+        dryRun: false,
+      });
 
-  it("should pass in the correct params and return the deployed instance", async () => {
-    const instance = await issueToDocumentStore(deployParams);
+      const passedSigner: Wallet = mockedConnect.mock.calls[0][1];
+      expect(passedSigner.privateKey).toBe(`0x${process.env.OA_PRIVATE_KEY}`);
+    });
 
-    const passedSigner: Wallet = mockedConnect.mock.calls[0][1];
+    it("should pass in the correct params and return the deployed instance", async () => {
+      const instance = await issueToDocumentStore(deployParams);
 
-    expect(passedSigner.privateKey).toBe(`0x${deployParams.key}`);
-    expect(mockedConnect.mock.calls[0][0]).toEqual(deployParams.address);
-    expect(mockCallStaticIssue).toHaveBeenCalledTimes(1);
-    expect(mockedIssue.mock.calls[0][0]).toEqual(deployParams.hash);
-    expect(instance).toStrictEqual({ transactionHash: "transactionHash" });
-  });
+      const passedSigner: Wallet = mockedConnect.mock.calls[0][1];
 
-  it("should take in the key from key file", async () => {
-    await issueToDocumentStore({
-      hash: "0xabcd",
-      address: "0x1234",
-      network: "goerli",
-      keyFile: join(__dirname, "..", "..", "..", "examples", "sample-key"),
-      dryRun: false,
+      expect(passedSigner.privateKey).toBe(`0x${deployParams.key}`);
+      expect(mockedConnect.mock.calls[0][0]).toEqual(deployParams.address);
+      expect(mockCallStaticIssue).toHaveBeenCalledTimes(1);
+      expect(mockedIssue.mock.calls[0][0]).toEqual(deployParams.hash);
+      expect(instance).toStrictEqual({ transactionHash: "transactionHash" });
     });
 
-    const passedSigner: Wallet = mockedConnect.mock.calls[0][1];
-    expect(passedSigner.privateKey).toBe(`0x0000000000000000000000000000000000000000000000000000000000000003`);
-  });
-
-  it("should accept hash without 0x prefix and return deployed instance", async () => {
-    const instance = await issueToDocumentStore({ ...deployParams, hash: addAddressPrefix("abcd") });
+    it("should accept hash without 0x prefix and return deployed instance", async () => {
+      const instance = await issueToDocumentStore({ ...deployParams, hash: addAddressPrefix("abcd") });
 
-    const passedSigner: Wallet = mockedConnect.mock.calls[0][1];
+      const passedSigner: Wallet = mockedConnect.mock.calls[0][1];
 
-    expect(passedSigner.privateKey).toBe(`0x${deployParams.key}`);
-    expect(mockedConnect.mock.calls[0][0]).toEqual(deployParams.address);
-    expect(mockCallStaticIssue).toHaveBeenCalledTimes(1);
-    expect(mockedIssue.mock.calls[0][0]).toEqual(deployParams.hash);
-    expect(instance).toStrictEqual({ transactionHash: "transactionHash" });
-  });
-
-  it("should allow errors to bubble up", async () => {
-    mockedConnect.mockImplementation(() => {
-      throw new Error("An Error");
+      expect(passedSigner.privateKey).toBe(`0x${deployParams.key}`);
+      expect(mockedConnect.mock.calls[0][0]).toEqual(deployParams.address);
+      expect(mockCallStaticIssue).toHaveBeenCalledTimes(1);
+      expect(mockedIssue.mock.calls[0][0]).toEqual(deployParams.hash);
+      expect(instance).toStrictEqual({ transactionHash: "transactionHash" });
     });
-    await expect(issueToDocumentStore(deployParams)).rejects.toThrow("An Error");
-  });
-
-  it("should throw when keys are not found anywhere", async () => {
-    await expect(
-      issueToDocumentStore({
-        hash: "0xabcd",
-        address: "0x1234",
-        network: "goerli",
-        dryRun: false,
-      })
-    ).rejects.toThrow(
-      "No private key found in OA_PRIVATE_KEY, key, key-file, please supply at least one or supply an encrypted wallet path, or provide aws kms signer information"
-    );
   });
 });