@nomicfoundation/hardhat-keystore/src/index.ts

A module for managing keystore files that store a map from IDs to encrypted string values.

import type { HardhatPlugin } from "hardhat/types/plugins";

import "./internal/type-extensions.js";

import { emptyTask, task } from "hardhat/config";
import { ArgumentType } from "hardhat/types/arguments";

import { PLUGIN_ID } from "./internal/constants.js";

const hardhatKeystorePlugin: HardhatPlugin = {
  id: PLUGIN_ID,
  hookHandlers: {
    config: import.meta.resolve("./internal/hook-handlers/config.js"),
    configurationVariables: import.meta.resolve(
      "./internal/hook-handlers/configuration-variables.js",
    ),
  },
  tasks: [
    emptyTask("keystore", "Store your keys in a secure way").build(),

    task(
      ["keystore", "set"],
      "Sets a new value in the keystore associated with the specified key",
    )
      .addPositionalArgument({
        name: "key",
        type: ArgumentType.STRING,
        description: "Specifies the key to set in the keystore",
      })
      .addFlag({
        name: "force",
        description: "Forces overwrite if the key already exists.",
      })
      .setAction(import.meta.resolve("./internal/tasks/set.js"))
      .build(),

    task(["keystore", "get"], "Get a value given a key")
      .addPositionalArgument({
        name: "key",
        type: ArgumentType.STRING,
        description: "Specifies the key to retrieve the value for",
      })
      .setAction(import.meta.resolve("./internal/tasks/get.js"))
      .build(),

    task(["keystore", "list"], "List all keys in the keystore")
      .setAction(import.meta.resolve("./internal/tasks/list.js"))
      .build(),

    task(["keystore", "delete"], "Delete a key from the keystore")
      .addPositionalArgument({
        name: "key",
        type: ArgumentType.STRING,
        description: "Specifies the key to delete from the keystore",
      })
      .addFlag({
        name: "force",
        description:
          "Forces to not throw an error if the key does not exist during deletion.",
      })
      .setAction(import.meta.resolve("./internal/tasks/delete.js"))
      .build(),
  ],
  npmPackage: "@nomicfoundation/hardhat-keystore",
};

export default hardhatKeystorePlugin;