← COMP5521 全部讲次
Lab3 · 第 5 周

Lab3 ERC-20 与 Hardhat:亲手发一枚只有你能增发的代币

从 init 到 mint 把 MST 代币完整跑一遍,弄懂 approve 和 transferFrom 这对下一讲要用的函数。

一句话版

用 Hardhat 和 OpenZeppelin 写一枚只有 owner 能增发的 ERC-20 代币 MST,它是期末 Project 里被锁进 HTLC 的那份资产。

先认识这几个词

词 全称 / 读法 一句人话
ERC-20 以太坊同质化代币标准 所有「每一枚都一样」的代币共用的一套函数名
HTLC Hash Time-Locked Contract,哈希时间锁合约 凭密码在期限内取钱、过期退回的托管合约,下一讲细讲
Hardhat 以太坊开发框架 把编译、测试、部署整合成几条命令的工具
OpenZeppelin 开源合约库 经过审计的标准合约,直接继承就能用
owner / mint 所有者 / 铸币 部署合约的那个账户;凭空增发新代币
approve / transferFrom 授权 / 代扣 先许可别人拿多少,再由对方自己来拿

题目地图

期末 Project 是「用 HTLC 做跨链资产交换」。它有四个组件:Chain A(Ethereum Sepolia 测试网)上的代币和 ERC20 HTLC,Chain B(Arbitrum Sepolia)上的 ETH HTLC,一个网页 UI。这一讲只做代币,后面所有组件都要用到它。

段落 学什么 主要失分点
Project 全景 四个组件、三个动作 lock / claim / refund(锁定、领取、退款) 以为合约里写了「锚定港币」就真的锚定了
开发框架 Hardhat 解决手工流程的哪几个痛点 说不出本地网络为什么是最大卖点
ERC-20 统一接口、approve 与 transferFrom 照抄课件把 name 当成必需函数
安全与演示 OpenZeppelin、从零建项目到 mint 装错 toolbox 版本、私钥进了 git

前三段是概念,最后一段动手。课件只给了命令和代码片段,下面「逐题拆解」补齐了完整代码,在本地 Hardhat 网络实测通过。

概念卡

1. 开发框架与本地网络(Hardhat)

人话定义:它解决「每改一行代码都要上测试网等出块」的麻烦。Hardhat 把编译、测试、部署、调试整合成一套命令,并自带一条在内存里运行的本地以太坊网络。

例子:没有框架时,每改一行就要部署到公共测试网、付 gas、等出块。出了错只能盯着交易数据猜。有了 Hardhat,npx hardhat test 和不带 --network 的 npx hardhat run 都在本地临时链上跑。几秒钟一轮,脚本结束链就消失。项目目录也固定下来:contracts/ 放合约,scripts/ 放脚本,test/ 放测试,hardhat.config.js 管配置。

常见误解

以为 npx hardhat init 会生成 scripts/ 目录 → 实测 Hardhat 2.29.1 的 JavaScript 模板没有 scripts/,要自己建。它生成的是 contracts/Lock.sol、ignition/modules/Lock.js 和 test/。课件的写法照样能用。

回讲义:L01d 加密货币:电子支付的四条弱点,比特币、以太坊和稳定币

2. ERC-20 接口标准

人话定义:它解决「每种代币各有一套函数名,钱包对接不过来」的问题。ERC-20 是一组所有同质化代币(每一枚都等价、可互换)都实现的函数名和参数。钱包、交易所、别的合约用同一套代码,就能操作任何代币。

例子:标准出现之前,Token A 的转账叫 transferTokens,Token B 叫 send,Token C 叫 move_assets。钱包每支持一种代币都要单独写对接代码。更危险的是 Token C 用 if 判断余额,余额不足时什么都不做,交易照样成功。调用方以为钱转了,其实没转。统一接口之后,MetaMask 只要会调 balanceOf、symbol、decimals,就能显示任意 ERC-20 代币。

常见误解

以为 name、symbol、decimals 是必须实现的 → 按 EIP-20 原文它们是 OPTIONAL(可选),别的合约不应假定它们存在。必需的是六个函数加两个事件,见下面「课件里的坑」。

回讲义:L01d 加密货币:电子支付的四条弱点,比特币、以太坊和稳定币

3. 授权与代扣(approve / transferFrom)

人话定义:它解决「合约怎么收走你的代币」。approve 由持有人调用,记下「某个地址最多可以从我这里拿多少」;transferFrom 由被授权方调用,把代币转走并扣减额度。

例子:合约没法「察觉」你转进来的 ERC-20。所以惯例是你先 approve,合约再用 transferFrom 自己拉。本地测试里授权 30,被授权方拉走 30 后额度归零。再拉 1 个就报 ERC20InsufficientAllowance(授权额度不足)。下一讲 Alice 把 MST 锁进 HTLC 用的就是这一对。

常见误解

以为 approve 之后代币就离开了账户 → approve 只改 allowance(剩余额度),余额不变。真正转走发生在 transferFrom。approve 是一张权限很大的授权单,不要授权给不信任的合约。

回讲义:L01d 加密货币:电子支付的四条弱点,比特币、以太坊和稳定币

4. 继承 OpenZeppelin(ERC20 + Ownable)

人话定义:它解决「标准组件自己写容易出错」。做法是直接继承经过审计的实现,只写自己的业务逻辑。

例子:MySimpleToken 正文只有一个构造函数和一个 mint。转账、授权、余额记账全部来自 ERC20。owner 记录和 onlyOwner 修饰符(只许 owner 调用的开关)来自 Ownable。构造函数没有铸币,所以部署后 totalSupply(总发行量)是 0。decimals(小数位数)没写,继承默认值 18。

常见误解

以为用了 OpenZeppelin 就整份合约安全 → 库是安全的,你加在上面的逻辑不一定。mint 如果漏了 onlyOwner,任何人都能无限增发。课件提到的 The DAO 事件是重入漏洞:合约转钱出去时被对方回头反复调用。下一讲 HTLC 要转钱出去,同样要防。

回讲义:L01d 加密货币:电子支付的四条弱点,比特币、以太坊和稳定币

逐题拆解

第一步:建项目。顺序和版本号都要照抄:

mkdir project-intro-1 && cd project-intro-1
npm init -y
npm install --save-dev hardhat@^2
npx hardhat init                      # 选 Create a JavaScript project
npm install --save-dev "@nomicfoundation/hardhat-toolbox@hh2"
npm install @openzeppelin/contracts
npm install dotenv

hardhat 的 latest(最新版)已经是 3.20.0,不写 @^2 会装上 Hardhat 3,后面全对不上。课件第五行原本没有 @hh2。按课件顺序先 init 不会出事,因为 init 已经装好了 toolbox ^6.1.2。但跳过 init 直接装,就会装上 7.0.0,编译时报 does not work with Hardhat 2 nor 3。上面直接写 @hh2,两种顺序都安全。

第二步:配置。.env(存私密配置的文件)放三个变量,值全是占位符。确认 .gitignore 里有 .env 和 node_modules:

SEPOLIA_RPC_URL=https://sepolia.infura.io/v3/<你的 key>
ETHERSCAN_API_KEY=<你的 key>
PRIVATE_KEY=<64 位十六进制私钥>
// hardhat.config.js
require("@nomicfoundation/hardhat-toolbox");
require("dotenv").config();
const { SEPOLIA_RPC_URL, PRIVATE_KEY, ETHERSCAN_API_KEY } = process.env;
module.exports = {
  solidity: "0.8.28",
  networks: { sepolia: { url: SEPOLIA_RPC_URL || "", accounts: PRIVATE_KEY ? [PRIVATE_KEY] : [] } },
  etherscan: { apiKey: ETHERSCAN_API_KEY || "" },
};

|| "" 让 .env 还没填时本地网络也能跑。ETHERSCAN_API_KEY 只在验证源码时用,部署本身不需要。

第三步:合约。contracts/MySimpleToken.sol:

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.20;
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import "@openzeppelin/contracts/access/Ownable.sol";

contract MySimpleToken is ERC20, Ownable {
    constructor() ERC20("My Simple Token", "MST") Ownable(msg.sender) {}
    function mint(address to, uint256 amount) public onlyOwner {
        _mint(to, amount);
    }
}

Ownable(msg.sender) 是 OpenZeppelin 5.x 的写法,旧教程里不带参数的版本会编译失败。

第四步:部署与 mint。scripts/deploy.js 部署并打印地址。scripts/interact.js 给 owner mint 1000 MST,再让另一个账户试着 mint:

// scripts/deploy.js
const hre = require("hardhat");
async function main() {
  const token = await hre.ethers.deployContract("MySimpleToken");
  await token.waitForDeployment();
  console.log("MST_ADDRESS=" + (await token.getAddress()));
  console.log("name/symbol/decimals:", await token.name(), await token.symbol(), await token.decimals());
  console.log("totalSupply:", (await token.totalSupply()).toString());
}
main().catch((e) => { console.error(e); process.exitCode = 1; });
// scripts/interact.js
const hre = require("hardhat");
async function main() {
  const [owner, other] = await hre.ethers.getSigners();
  let address = process.env.MST_ADDRESS;
  if (!address) {   // 本地网络每次都是新链,没有地址就先部署
    const t = await hre.ethers.deployContract("MySimpleToken");
    await t.waitForDeployment();
    address = await t.getAddress();
  }
  const token = await hre.ethers.getContractAt("MySimpleToken", address, owner);
  const amount = hre.ethers.parseUnits("1000", await token.decimals());
  console.log("mint amount (raw):", amount.toString());
  await (await token.mint(owner.address, amount)).wait();
  console.log("owner balance:", hre.ethers.formatUnits(await token.balanceOf(owner.address), 18), "MST");
  if (!other) return;   // Sepolia 上只配了一个私钥
  try { await token.connect(other).mint(other.address, 1n); }
  catch (e) { console.log("non-owner mint reverted:", e.message.match(/custom error '([^']+)'/)?.[1]); }
}
main().catch((e) => { console.error(e); process.exitCode = 1; });

本地实测(不带 --network):deploy 打印 name/symbol/decimals: My Simple Token MST 18n 和 totalSupply: 0;interact 打印:

mint amount (raw): 1000000000000000000000
owner balance: 1000.0 MST
non-owner mint reverted: OwnableUnauthorizedAccount("0x7099…79C8")

本地跑通后,加上 --network sepolia 再跑一遍。把输出的 MST_ADDRESS 写回 .env,再在 MetaMask 用「导入代币」填合约地址查看余额。这一段需要真实 RPC 和测试币,本页没有实测。注解版另有一个三用例的测试文件,覆盖元数据、onlyOwner 和 approve/transferFrom。

课件里的坑

  • [课件有误] p.12 必需函数列错:课件说每个代币都必须实现 name、symbol、decimals 等八个函数。EIP-20 原文把这三个标为 OPTIONAL;同时课件漏了必需的 allowance 和 Transfer、Approval 两个事件。下一讲 p.14 列的六个函数加两个事件才是完整的必需集合。
  • [读图提醒] p.12 最后一句被截断:The HTLC contract uses the ERC20 interface. It does not need to know how the token stores 在页边断掉了,意思是 HTLC 只通过接口调用代币,不关心代币内部怎样存余额。
  • [适用条件] p.3 的「锚定港币」:MST 合约只有 mint,没有储备、赎回或价格机制,锚定是 Project 的设定,合约本身做不到。说它是「模拟稳定币」更准确。
  • [实测] p.18 的 toolbox 版本坑:见逐题拆解第一步。另外在没有交互终端的环境里 init 会报 ERR_USE_AFTER_CLOSE,加 HARDHAT_DISABLE_TELEMETRY_PROMPT=true 等环境变量用默认选项即可。
  • [实测] p.9 的目录:新版 init 不生成 scripts/,自己建。
  • [笔误] p.3 的 llows 应为 allows,p.5 的 transcation 应为 transaction,p.8 的 Solidarity 应为 Solidity,都不影响理解。

课后 10 分钟:考点复习

这 10 分钟怎么用:先默写 ERC-20 的六个必需函数和两个事件,再做完整例题,把「授权额度」和「余额」两条线分开记账;最后做变式题。

必背

  1. ERC-20 必需的是 totalSupply、balanceOf、transfer、transferFrom、approve、allowance 六个函数和 Transfer、Approval 两个事件;name、symbol、decimals 是可选元数据。
  2. approve 只记录授权额度、不动余额,transferFrom 由被授权方调用、真正转走代币并扣减额度。
  3. MySimpleToken 继承 ERC20 和 Ownable,部署时 totalSupply 为 0,代币只能由 owner 调 mint 产生。
  4. decimals 默认 18,链上存最小单位:1000 MST 写成 1000 × 10¹⁸。
  5. hardhat 要写 @^2,toolbox 要用 hh2 标签的 6.x;latest 的 toolbox 7.0.0 不支持 Hardhat 2。
  6. 私钥放 .env 并写进 .gitignore,任何时候都不公开、不截图、不提交。

完整例题

owner 部署 MST 后依次执行:mint 给自己 100 MST;approve 合约 H 额度 30 MST;H 调 transferFrom 把 30 MST 从 owner 转给 Bob;H 再想转 1 MST。每一步之后 totalSupply、owner 余额、Bob 余额、H 的剩余额度各是多少?

  1. 部署后:totalSupply = 0,所有余额和额度都是 0。
  2. mint 100:totalSupply = 100,owner = 100。链上存的是 100 × 10¹⁸ = 10²⁰ 个最小单位。
  3. approve 30:只改额度,H 的额度 = 30,owner 余额仍是 100。
  4. transferFrom 30:owner = 100 − 30 = 70,Bob = 30,额度 = 30 − 30 = 0,totalSupply 不变仍是 100。
  5. 再转 1:额度为 0,交易 revert,错误 ERC20InsufficientAllowance,所有数值不变。

答案:最终 totalSupply 100,owner 70,Bob 30,额度 0。

变式题(先自己做)

部署后:owner mint 给 Alice 50 MST;Alice approve 合约 H 额度 20;H 用 transferFrom 从 Alice 转 15 给 Bob;Bob 想调用 mint 给自己 5 MST;Alice 再 approve H 额度 40。(1) 各步之后 Alice 余额和 H 的额度是多少?(2) Bob 的 mint 会怎样?(3) 最终 totalSupply 是多少?

提示

额度和余额分开记。approve 是覆盖写入新额度,不是在旧额度上累加。Bob 不是 owner。

判分点与答案

(1) mint 后 Alice 50、额度 0;approve 后 Alice 50、额度 20;transferFrom 后 Alice 35、额度 5;再 approve 40 后额度变成 40(覆盖,不是 45),Alice 仍是 35。(2) revert,错误 OwnableUnauthorizedAccount,状态不变。(3) totalSupply 一直是 50,transferFrom 只是搬家,不改总量。

闪卡自测

1. Project 的四个组件分别在哪?

代币和 ERC20 HTLC 在 Ethereum Sepolia,ETH HTLC 在 Arbitrum Sepolia,再加一个网页 UI。

2. p.11 的 TokenC 为什么最危险?

余额不足时用 if 跳过,交易照样成功,调用方以为转账完成。

3. 部署后 totalSupply 为什么是 0?

构造函数没有铸币,代币只能通过 mint 产生。

4. 非 owner 调 mint 会怎样?

revert,错误名 OwnableUnauthorizedAccount。

下一步

下一讲进入 HTLC:Alice 先 approve、再把 MST 锁进 HTLC 合约,Bob 在另一条链上锁 ETH,同一个 secret 打开两把锁。先在本地把这一页的代码跑通,再领测试币上 Sepolia;带着一个问题去听:approve 之后,代币有没有离开 Alice 的账户?

下一讲 →
L05a L05a SET 的舞台和信封:六个角色、两张网、一封报文怎么封

个人整理的学习笔记,不是官方材料;数字与结论以课件和讲师为准。