refactor: split apart methods file

Author: kanej

v-next/hardhat-keystore/src/constants.ts

@@ -0,0 +1 @@
+export const PLUGIN_ID = "hardhat-keystore";

v-next/hardhat-keystore/src/hook-handlers/configuration-variables.ts

@@ -4,7 +4,7 @@ import type {
   HookContext,
 } from "@ignored/hardhat-vnext/types/hooks";
 
-import { get } from "../methods.js";
+import get from "../tasks/get.js";
 import { getKeystore } from "../utils.js";
 
 export default async (): Promise<Partial<ConfigurationVariableHooks>> => {
@@ -20,7 +20,8 @@ export default async (): Promise<Partial<ConfigurationVariableHooks>> => {
         return next(context, variable);
       }
 
-      const value = await get(variable.name);
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- this is temporary as part of a refactor
+      const value = await get({ key: variable.name }, null as any);
 
       return value ?? next(context, variable);
     },

v-next/hardhat-keystore/src/index.ts

@@ -13,7 +13,7 @@ const hardhatKeystorePlugin: HardhatPlugin = {
   },
   tasks: [
     task("keystore", "Store your keys in a secure way")
-      .setAction(async (_, _hre) => {})
+      .setAction(async () => {})
       .build(),
 
     task(

v-next/hardhat-keystore/src/methods.ts

@@ -1,6 +1,8 @@
 import type { NewTaskActionFunction } from "@ignored/hardhat-vnext/types/tasks";
 
-import { remove } from "../methods.js";
+import { isAuthorized } from "../password-manager.js";
+import { showMsgNoKeystoreSet } from "../utils/show-msg-no-keystore-set.js";
+import { getKeystore, removeKey } from "../utils.js";
 
 interface TaskDeleteArguments {
   key: string;
@@ -9,7 +11,17 @@ interface TaskDeleteArguments {
 const taskDelete: NewTaskActionFunction<TaskDeleteArguments> = async ({
   key,
 }) => {
-  await remove(key);
+  const keystore = await getKeystore();
+
+  if (keystore === undefined) {
+    return showMsgNoKeystoreSet();
+  }
+
+  if ((await isAuthorized()) === false) {
+    return;
+  }
+
+  await removeKey(key);
 };
 
 export default taskDelete;

v-next/hardhat-keystore/src/tasks/delete.ts

@@ -1,13 +1,35 @@
 import type { NewTaskActionFunction } from "@ignored/hardhat-vnext/types/tasks";
 
-import { get } from "../methods.js";
+import { io } from "../io.js";
+import { isAuthorized } from "../password-manager.js";
+import { showMsgNoKeystoreSet } from "../utils/show-msg-no-keystore-set.js";
+import { getKeystore } from "../utils.js";
 
 interface TaskGetArguments {
   key: string;
 }
 
 const taskGet: NewTaskActionFunction<TaskGetArguments> = async ({ key }) => {
-  await get(key);
+  const keystore = await getKeystore();
+
+  if (keystore === undefined) {
+    showMsgNoKeystoreSet();
+    return;
+  }
+
+  if ((await isAuthorized()) === false) {
+    return;
+  }
+
+  if (keystore.keys[key] === undefined) {
+    console.log(keystore);
+    io.error(`Key "${key}" not found`);
+    return;
+  }
+
+  io.info(keystore.keys[key]);
+
+  return keystore.keys[key];
 };
 
 export default taskGet;

v-next/hardhat-keystore/src/tasks/get.ts

@@ -1,9 +1,26 @@
 import type { NewTaskActionFunction } from "@ignored/hardhat-vnext/types/tasks";
 
-import { list } from "../methods.js";
+import { io } from "../io.js";
+import { showMsgNoKeystoreSet } from "../utils/show-msg-no-keystore-set.js";
+import { getKeystore } from "../utils.js";
 
 const taskList: NewTaskActionFunction = async () => {
-  await list();
+  const keystore = await getKeystore();
+
+  if (keystore === undefined) {
+    return showMsgNoKeystoreSet();
+  }
+
+  // No authorization needed, it only shows the keys, not the secret values
+  if (Object.keys(keystore.keys).length === 0) {
+    io.info("The keystore does not contain any keys.");
+    return;
+  }
+
+  io.info("Keys:");
+  for (const key of Object.keys(keystore.keys)) {
+    io.info(key);
+  }
 };
 
 export default taskList;

v-next/hardhat-keystore/src/tasks/list.ts

@@ -1,6 +1,13 @@
 import type { NewTaskActionFunction } from "@ignored/hardhat-vnext/types/tasks";
 
-import { set } from "../methods.js";
+import { io } from "../io.js";
+import { isAuthorized } from "../password-manager.js";
+import {
+  addNewSecret,
+  getKeystore,
+  setupKeystore,
+  validateKey,
+} from "../utils.js";
 
 interface TaskGetArguments {
   key: string;
@@ -11,7 +18,23 @@ const taskSet: NewTaskActionFunction<TaskGetArguments> = async ({
   key,
   force,
 }) => {
-  await set(key, force);
+  const keystore = await getKeystore();
+
+  if (keystore === undefined) {
+    await setupKeystore();
+  }
+
+  if (!validateKey(key)) {
+    return;
+  }
+
+  if ((await isAuthorized()) === false) {
+    return;
+  }
+
+  await addNewSecret(key, force);
+
+  io.info(`Key "${key}" set`);
 };
 
 export default taskSet;

v-next/hardhat-keystore/src/tasks/set.ts

@@ -12,8 +12,8 @@ import {
 import chalk from "chalk";
 import envPaths from "env-paths";
 
+import { PLUGIN_ID } from "./constants.js";
 import { io } from "./io.js";
-import { PLUGIN_ID } from "./methods.js";
 import { setUpPassword } from "./password-manager.js";
 
 let keystoreCache: Keystore | undefined;

v-next/hardhat-keystore/src/utils.ts

@@ -0,0 +1,9 @@
+import chalk from "chalk";
+
+import { io } from "../io.js";
+
+export function showMsgNoKeystoreSet(): void {
+  io.info(
+    `No keystore found. Please set one up using ${chalk.blue.italic("npx hardhat keystore set {key}")} `,
+  );
+}