Hardhat 开发框架 - Solidity开发教程连载

news2024/11/25 0:58:18

Decert.me 要连载教程了， 《Solidity 开发教程》 力求系统、深入的介绍 Solidity 开发， 同时这是一套交互式教程，你可以实时的修改教程里的合约代码并运行。

本教程来自贡献者 @Tiny熊，让我们正式开始学习吧。

如果你已经是 Hardhat 的使用者，可以直接跳到文末，参与挑战领取技能认证 NFT。

Hardhat 提供了一个灵活且易于使用的环境，可以轻松地编写、测试和部署智能合约。类似的开发工具或框架还有： Remix IDE， Truffle ， Foundry， 目前最受欢迎的是 Hardhat 与 Foundry。

Hardhat 使用 Node 进行包管理，如果你熟悉 Node 及 Javascript， Hardhat 将非常简单上手。

Hardhat还内置了Hardhat 网络（Hardhat Node），它是为开发而设计的本地以太坊网络。 用来部署合约，运行测试和调试代码。

在本文中，我们将介绍：

  1. 创建及配置Hardhat项目
  2. 编写智能合约
  3. Hardhat 编译合约
  4. 使用 Ethers.js 和为合约编写自动化测试
  5. 使用 console.log()调试 Solidity
  6. 使用 Hardhat 部署合约
  7. 使用 Hardhat Etherscan 进行开源验证。
  8. Hardhat 插件的使用

本文对应的代码在：https://github.com/xilibi2003/training_camp_2/tree/main/w1_hardhat

创建及配置Hardhat项目

Hardhat 构建在Node.js之上， 使用 Hardhat 要求我们在电脑先安装好Node.js (>= 16.0)， 环境准备可以参考这里。

先创建项目目录：

mkdir hardhat-tutorial
cd hardhat-tutorial

初始化 Node 项目：

npm init

安装 Hardhat :

npm install --save-dev hardhat

在安装Hardhat的目录下运行：

npx hardhat

使用键盘选择"创建一个新的hardhat.config.js（Create a JavaScript project）" ，然后回车。

$ npx hardhat
888    888                      888 888               888
888    888                      888 888               888
888    888                      888 888               888
8888888888  8888b.  888d888 .d88888 88888b.   8888b.  888888
888    888     "88b 888P"  d88" 888 888 "88b     "88b 888
888    888 .d888888 888    888  888 888  888 .d888888 888
888    888 888  888 888    Y88b 888 888  888 888  888 Y88b.
888    888 "Y888888 888     "Y88888 888  888 "Y888888  "Y888

👷 Welcome to Hardhat v2.13.0 👷‍

? What do you want to do? …
❯ Create a JavaScript project
  Create a TypeScript project
  Create an empty hardhat.config.js
  Quit

这个 JavaScript Hardhat 工程会默认下载 hardhat-toolbox 插件及一些常规设置：

创建好的Hardhat工程包含文件有：

  • contracts：智能合约目录
  • scripts ：部署脚本文件
  • test：智能合约测试用例文件夹。
  • hardhat.config.js：配置文件，配置hardhat连接的网络及编译选项。

编写合约

合约开发推荐使用 VSCode 编辑器 + solidity 插件，在contracts 下新建一个合约文件 Counter.sol (*.sol 是 Solidity 合约文件的后缀名), 复制如下代码：

//SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

contract Counter {
    uint counter;

    constructor() {
        counter = 0;
    }

    function count() public {
        counter = counter + 1;
    }

    function get() public view returns (uint) {
        return counter;
    }
}

接下来就可以编译这个合约了。

使用OpenZepplin 等第三方库

在编写合约时，尽量不要重复造轮子，基于优质开源的第三方库，不仅可以提交效率，还可以让我们的合约代码更安全，例如要开发一个 Token，可以用npm 安装OpenZepplin 库：

npm install @openzeppelin/contracts --save-dev

然后在合约中 import 相应库中的合约文件及可。

pragma solidity ^0.8.0;

import "@openzeppelin/contracts/token/ERC20/ERC20.sol";

contract Token is ERC20 {
  constructor(uint256 initialSupply) ERC20("Token Name", "Token Symbol") {
    _mint(msg.sender, initialSupply);
  }
}

编译合约

hardhat.config.js 有默认的Solidity 编译器配置：

require("@nomicfoundation/hardhat-toolbox");

/** @type import('hardhat/config').HardhatUserConfig */
module.exports = {
  solidity: "0.8.18",
};

因此我们直接编译合约即可，在终端中运行 npx hardhat compile 。 compile任务是内置任务之一。

$ npx hardhat compile
Compiling 1 file with 0.8.18
Compilation finished successfully

合约已成功编译了。

成功编译后，会在 artifacts/contracts/ 目录下生成Counter.json 和 build-info， Counter.json包含了智能合约的 ABI 、字节码（Bytecode）等。

:::tip

智能合约的 **ABI（Application Binary Interface）**信息，其中包括了合约的函数、事件等接口信息。这个文件通常会在与其他合约交互时使用，因为它可以被其他合约和 DApp 使用。

Bytecode 是部署合约所需的字节码（也称为创建时字节码），部署合约时，就是把该字节码作为交易的输入数据发送链上。:::

:::

编写测试用例

为智能合约编写自动化测试至关重要，因为事关用户资金。

在我们的测试中，使用 Harhdat 内置的网络，使用ethers.js与前面的合约进行交互，并使用 Mocha 作为测试运行器。

在项目 test下，并创建一个名为Counter.js的新文件：

const { ethers } = require("hardhat");
const { expect } = require("chai");

let counter;

describe("Counter", function () {
  async function init() {
    const [owner, otherAccount] = await ethers.getSigners();
    const Counter = await ethers.getContractFactory("Counter");
    counter = await Counter.deploy();
    await counter.deployed();
    console.log("counter:" + counter.address);
  }

  before(async function () {
    await init();
  });

  // 
  it("init equal 0", async function () {
    expect(await counter.get()).to.equal(0);
  });

  it("add 1 equal 1", async function () {
    let tx = await counter.count();
    await tx.wait();
    expect(await counter.get()).to.equal(1);
  });

});

在终端上运行npx hardhat test。 你应该看到以下输出：

> npx hardhat test


  Counter
counter:0x5FbDB2315678afecb367f032d93F642f64180aa3
    ✔ init equal 0
    ✔ add 1 equal 1

  2 passing (1s)

这意味着测试通过了。 现在我们解释主要代码：

  const Counter = await ethers.getContractFactory("Counter");

ethers.js中的ContractFactory是用于部署新智能合约的抽象，因此此处的Counter是用来实例合约的工厂。

counter = await Counter.deploy();

在ContractFactory上调用deploy()将启动部署，并返回解析为Contract的Promise。 该对象包含了智能合约所有函数的方法。

let tx = await counter.count();
await tx.wait();

在counter 上调用合约方法， 并等待交易执行完毕。

注意，默认情况下， ContractFactory和Contract实例连接到第一个签名者（Singer）。

若需要使用其他的签名这， 可以使用合约实例connect 到另一个签名者， 如 counter.connect(otherAccount)

expect(await counter.get()).to.equal(0);

判断相等，我们使用Chai，这是一个断言库。 这些断言函数称为“匹配器”，在此实际上使用的“匹配器”来自Hardhat Chai Matchers。

使用 Console.log 调试合约

在**Hardhat Node **节点上运行合约和测试时，你可以在Solidity代码中调用console.log()打印日志信息和合约变量，可以方便我们调试代码。

在合约代码中导入**Hardhat **的console.log就可以使用它。

pragma solidity ^0.8.0;

import "hardhat/console.sol";

contract Counter {
    uint public counter;

    constructor(uint x) {
        counter = x;
    }

    function count() public {
        counter = counter + 1;
        console.log("counter is %s ", counter);
    }

}

就像在JavaScript中使用一样, 将一些console.log添加函数中，运行测试时，将输出日志记录：

> npx hardhat test

  Counter
counter:0x5FbDB2315678afecb367f032d93F642f64180aa3
    ✔ init equal 0
counter is 1
    ✔ add 1 equal 1 (38ms)


  2 passing (1s)

可以在这里了解更多 console.log 。

部署合约

其实我们在测试时， 合约已经部署到了Hardhat 内置的网络上，部署合约我们需要编写一个部署脚本。

在scripts文件夹，新建一个deploy.js 用来写部署脚本，部署脚本其实和前面测试时 init 函数类似：

const { ethers } = require("hardhat");

async function main() {

   const Counter = await ethers.getContractFactory("Counter");
   const counter = await Counter.deploy();
   await counter.deployed();

  console.log("Counter address:", counter.address);
}

main();

运行 npx hardhat run scripts/deploy.js 时， 可以合约会部署到Hardhat 内置网络上。

> npx hardhat run scripts/deploy.js
Counter address: 0x5FbDB2315678afecb367f032d93F642f64180aa3

为了在运行任何任务时指示Hardhat连接到特定的EVM网络，可以使用--network参数。 像这样：

npx hardhat run scripts/deploy.js --network <network-name>

network-name 需要在 hardhat.config.js 文件中进行配置：

require("@nomicfoundation/hardhat-toolbox");

// 填入自己的私钥或助记词，
const PRIVATE_KEY1 = "0x.... YOUR PRIVATE KEY1";
const PRIVATE_KEY2 = "0x....  YOUR PRIVATE KEY1";
const Mnemonic = "YOUR Mnemonic";


module.exports = {
  solidity: "0.8.9", // solidity的编译版本
  networks: {
    goerli: {
      url: "https://eth-goerli.api.onfinality.io/public",
      accounts: [PRIVATE_KEY1,PRIVATE_KEY2],
      chainId: 5,
    },
    
     mumbai: {
      url: "https://endpoints.omniatech.io/v1/matic/mumbai/public",
      accounts: {
        mnemonic: Mnemonic,
      },
      chainId: 80001,
    },
  }
};

以上配置了两个网络，一个是以太坊测试网 goerli， 一个是 Polygon 测试网mumbai， 我们可以在 https://chainlist.org 找到每个网络的节点 URL 及 chainID。

在网络配置中，需要提供提交交易账号， 可以通过私钥或助记词 进行配置，这里配置的账号（需要提前充币进入到账号中），在hardhat 脚本中（测试及部署脚本）调用getSigners 即可获得：

const [owner, otherAccount] = await ethers.getSigners();

一个私钥对应一个Singer，助记词则对应无数个 Singer ， 为每个项目生成一个独立的账号是比较推荐的做法，使用 ChainTool 开源工具 可以生成账号。

:::tip

助记词可以推导出无数了私钥，可参考：BIP39

:::

另外要注意， 在 Goerli 上进行部署，需要将Goerli-ETH发送到将要进行部署的地址中。 可以从水龙头免费或一些测试币，这是Goerli的一个水龙头:

  • Alchemy Goerli Faucet

最后运行：

npx hardhat run scripts/deploy.js --network goerli

如果一切顺利，你应该看到已部署的合约地址。

代码开源验证

智能代码开源会增加了合约的透明度和可靠性，是项目建立信任很重要的一个步骤。

在 hardhat-toolbox 工具箱里，包含了 hardhat-etherscan 插件用于验证已经部署到区块链网络上的智能合约代码与源代码是否匹配，在完成验证后在区块链浏览器中合约标签上会出现✅， 如图：

image-20230313104044517

在部署智能合约时，合约字节码会被写入到区块链中，这意味着其他人无法检查合约的源代码。代码验证的过程是将已部署合约的字节码与原始Solidity代码再次编译后与部署的字节码进行比较，确保它们是一致的。

相比在区块链浏览器上上传代码验证， hardhat-etherscan 有很多优点，否则会自动使用 hardhat config 值设置的编译器选项，并且当代码中引用的第三方库或合约， hardhat-etherscan 能自动探测并处理。

开源验证的步骤是：

  1. 安装 hardhat-toolbox 或 hardhat-etherscan ， 这一步我们这里已经完成，因为在初始化项目的时候安装了 hardhat-toolbox ， 如果没有安装，可以使用以下命令安装

    npm install --save-dev @nomiclabs/hardhat-etherscan

  2. 在 hardhat.config.js 中配置您的 Etherscan API 密钥和网络设置，例如：

  require("@nomicfoundation/hardhat-toolbox");
  或
  // require("@nomiclabs/hardhat-etherscan");
  
  etherscan: {
    apiKey: ""
  },

如何获取 Etherscan API 密钥？

  1. 访问部署网络对应主网的 Etherscan 网站，并注册一个账号（如果还没有账号的话）。
  2. 登录你的账号并进入 Etherscan 的「我的帐户」页面。
  3. 点击页面左侧的「API-KEYs」标签页。
  4. 在页面上方的「Create New API KEY」部分，输入 API 密钥的名称和描述，然后选择需要访问的 API 权限。
  5. 点击「Generate」按钮来生成 API 密钥。

  1. 执行验证命令：

    npx hardhat verify <deployed-contract-address> "参数(若有)" --network <network-name>

    例如，要在 goerli 网络上验证合约，可以运行以下命令：

    npx hardhat verify 0x..... --network goerli

该命令会为我们上传合约代码并验证其源代码。如果一切顺利（网络顺畅的话），在 Etherscan 上看到的合约被成功验证。

Hardhat 插件（Plugin）的使用

上面代码开源验证时，使用了hardhat-etherscan插件，其实也可以使用 hardhat-verify 插件。

在 https://hardhat.org/hardhat-runner/plugins 链接可以找到当前使用较多的插件，例如：hardhat-gas-reporter 可以对部署合约及函数执行的Gas消耗给出报告；solidity-coverage 可以对测试覆盖率给出报告。

要使用一个插件通常要：

  1. 用 Node.js 包管理先安装相应的插件

  2. 在 hardhat.config.js 文件中引入插件，以便Hardhat 能加载上对应的插件。

参考文档

示例非常简单， 更多使用方法，可参考文档：

  • Hardhat 官方文档：https://hardhat.org/getting-started/

  • Hardhat 中文文档：https://learnblockchain.cn/docs/hardhat/getting-started/

  • Harhdat 入门教程：https://learnblockchain.cn/docs/hardhat/tutorial/

  • Ethers.js 文档：https://learnblockchain.cn/ethers_v5/

小结

本文介绍了 Hardhat 开发框架的一些基本概念和使用方法，了解了如何使用 Hardhat 进行合约编译、部署、调试及测试，在开发中要经常查看文档，了解更多Hardhat 用法。

Hardhat 的使用你掌握了吗？来这里挑战一下看看，挑战完成你就可以领取到一枚技能认证 NFT。

码一个未来

原教程链接：https://decert.me/tutorial/solidity/tools/hardhat
Decert.me – 码一个未来

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/514086.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

C++画图（导入matplotlibcpp.h头文件）

C++画图（导入matplotlibcpp.h头文件）

QTC 导入matplotlibcpp进行画图 准备工作&#xff1a; 1.下载python、QT 2.配置环境&#xff0c;确保QTc、以及python可以正常运行 步骤&#xff1a; 1.先在QT中导入Python.&#xff48;头文件&#xff0c;详细步骤可见此链接&#xff1a;https://blog.csdn.net/weixin_458669…
阅读更多...
跑步课程导入能力，助力科学训练

跑步课程导入能力，助力科学训练

HUAWEI Health Kit为开发者提供用户自定义的跑步课程导入接口&#xff0c;便于用户在华为运动健康App和华为智能穿戴设备上查看来自生态应用的训练课表&#xff0c;开启科学、适度的运动训练。 跑步课程导入能力支持生态应用在获取用户的华为帐号授权后&#xff0c;将跑步课程…
阅读更多...
大学应届生，想转行学云计算，该怎么学，没有基础

大学应届生，想转行学云计算，该怎么学，没有基础

大学应届生&#xff0c;想转行学云计算&#xff0c;该怎么学&#xff0c;没有基础 对于大学生来说&#xff0c;毕业立即学习转行是最明智的选择&#xff0c;因为转行要趁早&#xff01;当然前提也需要你自己了解考虑好&#xff0c;是否真的看好云计算行业&#xff0c;要学习哪些…
阅读更多...
Spring Boot集成ShardingSphere实现数据加密及数据脱敏 | Spring Cloud 48

Spring Boot集成ShardingSphere实现数据加密及数据脱敏 | Spring Cloud 48

一、前言 通过以下系列章节&#xff1a; Spring Boot集成ShardingSphere实现数据分片&#xff08;一&#xff09; | Spring Cloud 40 Spring Boot集成ShardingSphere实现数据分片&#xff08;二&#xff09; | Spring Cloud 41 Spring Boot集成ShardingSphere实现数据分片&…
阅读更多...
C++实现AVL树和红黑树(插入部分）

C++实现AVL树和红黑树(插入部分）

文章目录 前言1.AVL树的相关介绍2.AVL树的旋转1.失衡状态2.旋转调整 3.代码实AVL树1.节点的插入2.插入部分的验证 4.红黑树的相关介绍5.红黑树的插入调整1.处理方式2.代码实现 6.红黑树的检查7.总结 前言 之前介绍了二叉搜索树&#xff0c;本文主要是对AVL树和红黑树进行介绍。…
阅读更多...
中国人民大学与加拿大女王大学金融硕士任晋红：热血中年

中国人民大学与加拿大女王大学金融硕士任晋红：热血中年

任晋红 中国人民大学-加拿大女王大学金融硕士 2021-2022级行业高管班 丰汇租赁有限公司 租赁事业部总经理 2021年9月初的一个傍晚&#xff0c;日暮四合&#xff0c;风轻轻亲了一下叶子&#xff0c;晚霞看见了&#xff0c;悄悄红了脸。线下上课时&#xff0c;窗外的晚霞是最美…
阅读更多...
如何使用ADAudit Plus增强你的网络安全措施

如何使用ADAudit Plus增强你的网络安全措施

网络安全是当今社会中至关重要的话题&#xff0c;因为互联网在我们生活中扮演着越来越重要的角色&#xff0c;人们对网络的依赖程度也越来越高。在这种情况下&#xff0c;网络内部安全威胁也变得越来越普遍。本文将介绍ADAudit Plus&#xff0c;它是一种用于检测和防范网络内部…
阅读更多...
【RS专题】eval层混淆和逻辑完整分析 - 扣代码终结篇

【RS专题】eval层混淆和逻辑完整分析 - 扣代码终结篇

如有侵权、联系本人下架 首先明确一下目标，我们要先获取网页200的源代码，RS5代第一次响应为412，第二次为200。如果是200就表示正常 以下为某 yjj RS5请求成功的结果，具体流程请看完文章，源-码–答-案也会在末 尾公 布 前面是定义了非常多和函数，一直往下拉，直到出现v…
阅读更多...
游戏开发需要具备哪些技术

游戏开发需要具备哪些技术

游戏开发需要具备哪些技术 大家好我是艾西&#xff0c;今天跟大家闲聊一下。开发一款游戏在没有参照物或是底板的情况下开发一款游戏都需要具备哪些技术&#xff0c;在开发过程中我们又会涉及到哪些板块或是领域。 一款游戏的开发需要一个总的游戏策划人&#xff0c;为游戏编写…
阅读更多...
起重机安装拆除安全技术规范

起重机安装拆除安全技术规范

为贯彻安全第一、预防为主、综合治理的方针&#xff0c;确保塔式起重机在安装、使用、拆卸时的安全&#xff0c;制定本规程。 本规程适用于房屋建筑工程、市政工程所用塔式起重机的安装、使用和拆卸。 本规程规定了塔式起重机的安装、使用和拆卸的基本技术要求。当本规程与国…
阅读更多...
一些注意事项

一些注意事项

1&#xff1a;Collection 子接口 1&#xff1a;List 鉴于 Java 中数组用来存储数据的局限性&#xff0c;我们通常使用 java.util.List 替代数组 List 集合类中元素有序、且可重复&#xff0c;集合中的每个元素都有其对应的顺序索引 1.1 List 接口主要实现类&#xff1a;Arra…
阅读更多...
历经3个月，二战华为成功上岸，要个27k应该不过分吧~

历经3个月，二战华为成功上岸，要个27k应该不过分吧~

先说下我基本情况&#xff0c;本科不是计算机专业&#xff0c;现在是学通信&#xff0c;然后做图像处理&#xff0c;可能面试官看我不是科班出身没有问太多计算机相关的问题&#xff0c;因为第一次找工作&#xff0c;华为的游戏专场又是最早开始的&#xff0c;就投递了&#xf…
阅读更多...
嵌入式五大通信协议详解 （一） UART

嵌入式五大通信协议详解 （一） UART

嵌入式C语言学习进阶系列文章 GUN C编译器拓展语法学习笔记(一&#xff09;GNU C特殊语法部分详解 GUN C编译器拓展语法学习笔记(二&#xff09;属性声明 GUN C编译器拓展语法学习笔记(三&#xff09;内联函数、内建函数与可变参数宏 数组存储与指针学习笔记(一&#xff09;数…
阅读更多...
Spring MVC 和 WebFlux 上传文件

Spring MVC 和 WebFlux 上传文件

WebFlux 上传文件 1. 表单上传方式1.1 Spring MVC1.2 Spring WebFlux 2. 二进制流2.1 Spring MVC2.2 Spring WebFlux 开发环境&#xff1a;jdk 11 WebFlux&#xff1a;jdk 8 1. 表单上传方式 1.1 Spring MVC multipart大小限制 spring:servlet:multipart:max-file-size: 512…
阅读更多...
IS220PPRFH1B输电线路的先导继电器保护

IS220PPRFH1B输电线路的先导继电器保护

​ IS220PPRFH1B输电线路的先导继电器保护 导引线差动继电器是专为保护配电线路和输电线路而设计的高速继电器&#xff0c;主要用于40公里以内的短线路。它是开关设备继电器中速度最快的功率继电器&#xff0c;该方案的工作需要通信通道&#xff0c;以便它可以将系统电压和电流…
阅读更多...
2023.05.11-使用纯CPU来运行RWKV大语言模型

2023.05.11-使用纯CPU来运行RWKV大语言模型

1. 简介 使用CPU来运行C版本的RWKV rwkv.cpp 可以将 RWKV 原始模型的参数转化为 float16&#xff0c;并量化到 int4&#xff0c;可以在 CPU 上更快地运行&#xff0c;也可以节省更多的内存。 2. 下载项目 ## git clone --recursive https://github.com/saharNooby/rwkv.cpp…
阅读更多...
PostgreSQL11 | 视图

PostgreSQL11 | 视图

上一篇讲了索引&#xff0c;索引提高了表查询的速度&#xff0c;这一篇讲视图。 视图 视图&#xff0c;数据库中的一个虚拟表。 目录 视图 视图概述 前期准备 创建视图 单表视图 多表视图 查询视图 删除视图 视图概述 视图同真实表一样具有表的功能&#xff0c;但是…
阅读更多...
spring事务失效的12种场景

spring事务失效的12种场景

前言 对于从事java开发工作的同学来说&#xff0c;spring的事务肯定再熟悉不过了。 在某些业务场景下&#xff0c;如果一个请求中&#xff0c;需要同时写入多张表的数据。为了保证操作的原子性&#xff08;要么同时成功&#xff0c;要么同时失败&#xff09;&#xff0c;避免…
阅读更多...
H. Binary Craziness

H. Binary Craziness

题目链接 2023 Hubei Provincial Collegiate Programming Contest Examples input 6 6 1 3 2 3 1 4 2 5 3 6 4 6 output 30 input 6 4 1 2 3 5 2 4 3 6 output 0 题目大意&#xff1a; 给出结点个数 n n n和边的个数 m m m 下面依此给出 m m m个边&#xff0c;边是无向的&am…
阅读更多...
Linux三种网络模式 | 仅主机、桥接、NAT

Linux三种网络模式 | 仅主机、桥接、NAT

&#x1f497;wei_shuo的个人主页 &#x1f4ab;wei_shuo的学习社区 &#x1f310;Hello World &#xff01; Linux三种网络模式 仅主机模式&#xff1a;虚拟机只能访问物理机&#xff0c;不能上网 桥接模式&#xff1a;虚拟机和物理机连接同一网络&#xff0c;虚拟机和物理机…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023