本指南将探讨在 Hardhat 中创建任务，这是用于自动化的核心组件。

任务是带有一些关联元数据的 JavaScript 异步函数。 Hardhat 使用此元数据为您自动执行某些操作。处理参数解析、验证和帮助消息。

您在 Hardhat 中可以做的所有事情都被定义为一项任务。开箱即用的默认操作是内置任务，它们使用与您作为用户可用的相同 API 来实现。

要查看项目中当前可用的任务，请运行 npx hardhat：

$ npx hardhat
Hardhat version 2.9.10

Usage: hardhat [GLOBAL OPTIONS] <TASK> [TASK OPTIONS]

GLOBAL OPTIONS:

  --config              A Hardhat config file.
  --emoji               Use emoji in messages.
  --help                Shows this message, or a task's help if its name is provided
  --max-memory          The maximum amount of memory that Hardhat can use.
  --network             The network to connect to.
  --show-stack-traces   Show stack traces.
  --tsconfig            A TypeScript config file.
  --verbose             Enables Hardhat verbose logging
  --version             Shows hardhat's version.


AVAILABLE TASKS:

  check         Check whatever you need
  clean         Clears the cache and deletes all artifacts
  compile       Compiles the entire project, building all artifacts
  console       Opens a hardhat console
  flatten       Flattens and prints contracts and their dependencies
  help          Prints this message
  node          Starts a JSON-RPC server on top of Hardhat Network
  run           Runs a user-defined script after compiling the project
  test          Runs mocha tests

To get help for a specific task run: npx hardhat help [task]

您可以创建其他任务，这些任务将显示在此列表中。例如，您可以创建一个任务来重置开发环境的状态，或与您的合约交互，或打包您的项目。

让我们来看看创建一个与智能合约交互的过程。

您可以在 hardhat.config.js 文件中创建自己的任务。 Config API 将在全局环境中可用，具有用于定义任务的功能。如果您希望保持明确，也可以使用 require("hardhat/config") 导入 API，并利用编辑器的自动完成功能。

通过调用 task 函数来创建任务。它将返回一个 TaskDefinition 对象，该对象可用于定义任务的参数。

您可以定义的最简单的任务是

task(
  "hello",
  "Prints 'Hello, World!'",
  async function (taskArguments, hre, runSuper) {
    console.log("Hello, World!");
  }
);

task 的第一个参数是任务名称。第二个是它的描述，用于在 CLI 中打印帮助消息。第三个是接收以下参数的异步函数：

编写任务的唯一要求是其操作返回的“承诺”必须在它启动的每个异步进程完成之前解决。

这是其操作不满足此要求的任务示例：

task("BAD", "This task is broken", async () => {
  setTimeout(() => {
    throw new Error(
      "This task's action returned a promise that resolved before I was thrown"
    );
  }, 1000);
});

这个其他任务使用“Promise”来等待超时触发：

task("delayed-hello", "Prints 'Hello, World!' after a second", async () => {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      console.log("Hello, World!");
      resolve();
    }, 1000);
  });
});

安全帽任务可以接收带值的命名参数（例如 --parameter-name parameterValue）、没有值的标志（例如 --flag-name）、位置参数或可变参数。可变参数的作用类似于 JavaScript 的其余参数。 Config API task 函数返回一个对象，其中包含定义所有方法的方法。一旦定义，Hardhat 就可以控制解析参数、验证它们并打印帮助消息。

向 hello 任务添加可选参数如下所示：

task("hello", "Prints a greeting'")
  .addOptionalParam("greeting", "The greeting to print", "Hello, World!")
  .setAction(async ({ greeting }) => console.log(greeting));

并且将使用 npx hardhat hello --greeting Hola 运行。

位置和可变参数不必命名，并且具有编程语言的通常限制：

• 没有位置参数可以跟随可变参数
• 必需/强制参数不能跟随可选参数。

不遵守这些限制将导致加载安全帽时引发异常。

Hardhat 负责验证和解析为每个参数提供的值。您可以声明参数的类型，Hardhat 将获取 CLI 字符串并将它们转换为您想要的类型。如果此转换失败，它将打印一条错误消息，解释原因。

Config API 中可以通过 types 对象使用多种类型。这个对象在处理你的 hardhat.config.js 之前被注入到全局范围中，但你也可以使用 const { types } = require("hardhat/config") 显式地导入它，并利用编辑器的自动完成功能。

为其参数之一定义类型的任务的示例是

task("hello", "Prints 'Hello' multiple times")
  .addOptionalParam(
    "times",
    "The number of times to print 'Hello'",
    1,
    types.int
  )
  .setAction(async ({ times }) => {
    for (let i = 0; i < times; i++) {
      console.log("Hello");
    }
  });

使用 npx hardhat hello --times notanumber 调用它会导致错误。

定义与现有任务同名的任务将覆盖现有任务。这对于更改或扩展内置和插件提供的任务的行为很有用。

任务覆盖的工作方式与扩展类时的覆盖方法非常相似。您可以设置自己的操作，该操作可以调用被覆盖的操作。覆盖任务时的唯一限制是您不能添加或删除参数。

任务覆盖顺序很重要，因为操作只能使用 runSuper 函数调用立即覆盖的定义。

创建具有大量逻辑的任务使得扩展或自定义它们变得困难。制作多个相互调用的小而专注的任务是允许扩展的更好方法。如果您以这种方式设计任务，则只想更改其中一小部分的用户可以覆盖您的子任务之一。

例如，compile 任务被实现为多个任务的管道。它只调用像compile:get-source-paths、compile:get-dependency-graph和compile:build-artifacts这样的子任务。我们建议在中间任务前加上主要任务和冒号。

为避免帮助消息因大量中间任务而变得混乱，您可以使用 subtask 配置 API 函数定义这些任务。 subtask 函数的工作方式几乎与 task 完全一样。唯一的区别是用它定义的任务不会包含在帮助消息中。

要运行子任务或任何任务，您可以使用“运行”功能。它有两个参数：要运行的任务的名称，以及一个带有参数的对象。

这是运行子任务的任务示例：

task("hello-world", "Prints a hello world message").setAction(
  async (taskArgs, hre) => {
    await hre.run("print", { message: "Hello, World!" });
  }
);

subtask("print", "Prints a message")
  .addParam("message", "The message to print")
  .setAction(async (taskArgs) => {
    console.log(taskArgs.message);
  });