ERC20 - OpenZeppelin 文档

OpenZeppelin
发布于 2025-04-21 17:59
阅读 10

本文介绍了 ERC20 token 合约，它可以跟踪同质化代币，即任何一个代币与任何其他代币完全相等。文章通过一个 GLDToken 的示例，展示了如何使用 OpenZeppelin Contracts 创建自己的 ERC20 token 合约，并讨论了 decimals 字段的用途，以及如何使用 preset ERC20 合约。

你现在阅读的不是本文档的当前版本。[5.x](https://docs.openzeppelin.com/contracts/5.x/) 是当前版本。

## ERC20

一个 ERC20 token 合约会追踪 同质化 token: 任何一个 token 都完全等同于其他任何 token；没有 token 具有与之相关的特殊权利或行为。这使得 ERC20 token 适用于诸如 交换媒介货币、投票权、质押等事物。

OpenZeppelin 合约提供了许多与 ERC20 相关的合约。在 [`API 参考`](https://docs.openzeppelin.com/contracts/3.x/api/token/ERC20) 中，你将找到有关其属性和用法的详细信息。

### 构建 ERC20 Token 合约

使用 Contracts，我们可以轻松创建我们自己的 ERC20 token 合约，该合约将用于跟踪 Gold (GLD)，这是一种假想游戏中的内部货币。

以下是我们的 GLD token 的样子。

```solidity hljs
// contracts/GLDToken.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;

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

contract GLDToken is ERC20 {
    constructor(uint256 initialSupply) public ERC20("Gold", "GLD") {
        _mint(msg.sender, initialSupply);
    }
}
```

我们的合约通常通过 [继承](https://solidity.readthedocs.io/en/latest/contracts.html#inheritance) 来使用，在这里我们重用 [`ERC20`](https://docs.openzeppelin.com/contracts/3.x/api/token/ERC20#erc20) 来实现基本标准实现以及 [`name`](https://docs.openzeppelin.com/contracts/3.x/api/token/ERC20#ERC20-name--)、[`symbol`](https://docs.openzeppelin.com/contracts/3.x/api/token/ERC20#ERC20-symbol--) 和 [`decimals`](https://docs.openzeppelin.com/contracts/3.x/api/token/ERC20#ERC20-decimals--) 可选扩展。此外，我们正在创建一个 `initialSupply` 的 token，它将被分配给部署合约的地址。

|     |     |
| --- | --- |
|  | 有关 ERC20 供应机制的更完整讨论，请参阅 [创建 ERC20 供应](https://learnblockchain.cn/article/17817)。 |

就这样！部署后，我们将能够查询部署者的余额：

```javascript hljs
> GLDToken.balanceOf(deployerAddress)
1000000000000000000000
```

我们还可以将这些 token [转移](https://docs.openzeppelin.com/contracts/3.x/api/token/ERC20#IERC20-transfer-address-uint256-) 到其他帐户：

```javascript hljs
> GLDToken.transfer(otherAddress, 300000000000000000000)
> GLDToken.balanceOf(otherAddress)
300000000000000000000
> GLDToken.balanceOf(deployerAddress)
700000000000000000000
```

### 关于 `decimals` 的说明

通常，你希望能够将你的 token 分成任意数量：例如，如果你拥有 `5 GLD`，你可能希望将 `1.5 GLD` 发送给朋友，并将 `3.5 GLD` 留给自己。不幸的是，Solidity 和 EVM 不支持此行为：只能使用整数（整个）数字，这构成了一个问题。你可以发送 `1` 或 `2` 个 token，但不能发送 `1.5`。

为了解决这个问题，[`ERC20`](https://docs.openzeppelin.com/contracts/3.x/api/token/ERC20#ERC20) 提供了一个 [`decimals`](https://docs.openzeppelin.com/contracts/3.x/api/token/ERC20#ERC20-decimals--) 字段，用于指定 token 有多少位小数。为了能够转移 `1.5 GLD`，`decimals` 必须至少为 `1`，因为该数字有一位小数。

如何实现这一点？实际上非常简单：token 合约可以使用更大的整数值，因此 `50` 的余额将表示 `5 GLD`，`15` 的转移将对应于发送 `1.5 GLD`，等等。

重要的是要理解 `decimals` 仅用于显示目的。合约内的所有算术运算仍然在整数上执行，并且是不同的用户界面（钱包、交易所等）必须根据 `decimals` 调整显示的值。每个帐户的总 token 供应量和余额未在 `GLD` 中指定：你需要除以 `10^decimals` 才能获得实际的 `GLD` 金额。

你可能想要使用 `18` 的 `decimals` 值，就像 Ether 和大多数正在使用的 ERC20 token 合约一样，除非你有非常特殊的理由不这样做。在铸造 token 或将其转移时，你实际上将发送数字 `num GLD * 10^decimals`。

|     |     |
| --- | --- |
|  | 默认情况下，`ERC20` 对 `decimals` 使用 `18` 的值。要使用不同的值，你需要在构造函数中调用 [\_setupDecimals](https://docs.openzeppelin.com/contracts/3.x/api/token/ERC20#ERC20-_setupDecimals-uint8-)。 |

因此，如果你想使用具有 18 位小数的 token 合约发送 `5` 个 token，那么要调用的方法实际上是：

```solidity hljs
transfer(recipient, 5 * 10^18);
```

### 预设 ERC20 合约

提供了一个预设的 ERC20，即 [`ERC20PresetMinterPauser`](https://docs.openzeppelin.com/contracts/3.x/api/presets#ERC20PresetMinterPauser)。它被预设为允许 token 的铸造（创建），停止所有 token 转移（暂停）并允许持有者燃烧（销毁）他们的 token。该合约使用 [访问控制](https://learnblockchain.cn/article/17818) 来控制对铸造和暂停功能的访问。部署合约的帐户将被授予铸币者和暂停者角色，以及默认的管理员角色。

这个合约已经可以部署了，无需编写任何 Solidity 代码。它可以按原样用于快速原型设计和测试，但也适用于生产环境。

[← Tokens](https://docs.openzeppelin.com/contracts/3.x/tokens)

[创建供应 →](https://learnblockchain.cn/article/17817)

>- 原文链接： [docs.openzeppelin.com/co...](https://docs.openzeppelin.com/contracts/3.x/erc20)
>- 登链社区 AI 助手，为大家转译优秀英文文章，如有翻译不通的地方，还请包涵～

你现在阅读的不是本文档的当前版本。5.x 是当前版本。

ERC20

一个 ERC20 token 合约会追踪同质化 token: 任何一个 token 都完全等同于其他任何 token；没有 token 具有与之相关的特殊权利或行为。这使得 ERC20 token 适用于诸如交换媒介货币、投票权、质押等事物。

OpenZeppelin 合约提供了许多与 ERC20 相关的合约。在 API 参考 中，你将找到有关其属性和用法的详细信息。

构建 ERC20 Token 合约

使用 Contracts，我们可以轻松创建我们自己的 ERC20 token 合约，该合约将用于跟踪 Gold (GLD)，这是一种假想游戏中的内部货币。

以下是我们的 GLD token 的样子。

// contracts/GLDToken.sol
// SPDX-License-Identifier: MIT
pragma solidity ^0.6.0;

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

contract GLDToken is ERC20 {
    constructor(uint256 initialSupply) public ERC20("Gold", "GLD") {
        _mint(msg.sender, initialSupply);
    }
}

我们的合约通常通过继承来使用，在这里我们重用 ERC20 来实现基本标准实现以及 name、symbol 和 decimals 可选扩展。此外，我们正在创建一个 initialSupply 的 token，它将被分配给部署合约的地址。


	有关 ERC20 供应机制的更完整讨论，请参阅创建 ERC20 供应。

就这样！部署后，我们将能够查询部署者的余额：

> GLDToken.balanceOf(deployerAddress)
1000000000000000000000

我们还可以将这些 token 转移到其他帐户：

> GLDToken.transfer(otherAddress, 300000000000000000000)
> GLDToken.balanceOf(otherAddress)
300000000000000000000
> GLDToken.balanceOf(deployerAddress)
700000000000000000000

关于 `decimals` 的说明

通常，你希望能够将你的 token 分成任意数量：例如，如果你拥有 5 GLD，你可能希望将 1.5 GLD 发送给朋友，并将 3.5 GLD 留给自己。不幸的是，Solidity 和 EVM 不支持此行为：只能使用整数（整个）数字，这构成了一个问题。你可以发送 1 或 2 个 token，但不能发送 1.5。

为了解决这个问题，ERC20 提供了一个 decimals 字段，用于指定 token 有多少位小数。为了能够转移 1.5 GLD，decimals 必须至少为 1，因为该数字有一位小数。

如何实现这一点？实际上非常简单：token 合约可以使用更大的整数值，因此 50 的余额将表示 5 GLD，15 的转移将对应于发送 1.5 GLD，等等。

重要的是要理解 decimals 仅用于显示目的。合约内的所有算术运算仍然在整数上执行，并且是不同的用户界面（钱包、交易所等）必须根据 decimals 调整显示的值。每个帐户的总 token 供应量和余额未在 GLD 中指定：你需要除以 10^decimals 才能获得实际的 GLD 金额。

你可能想要使用 18 的 decimals 值，就像 Ether 和大多数正在使用的 ERC20 token 合约一样，除非你有非常特殊的理由不这样做。在铸造 token 或将其转移时，你实际上将发送数字 num GLD * 10^decimals。


	默认情况下，`ERC20` 对 `decimals` 使用 `18` 的值。要使用不同的值，你需要在构造函数中调用 _setupDecimals。

因此，如果你想使用具有 18 位小数的 token 合约发送 5 个 token，那么要调用的方法实际上是：

transfer(recipient, 5 * 10^18);

预设 ERC20 合约

提供了一个预设的 ERC20，即 ERC20PresetMinterPauser。它被预设为允许 token 的铸造（创建），停止所有 token 转移（暂停）并允许持有者燃烧（销毁）他们的 token。该合约使用访问控制来控制对铸造和暂停功能的访问。部署合约的帐户将被授予铸币者和暂停者角色，以及默认的管理员角色。

这个合约已经可以部署了，无需编写任何 Solidity 代码。它可以按原样用于快速原型设计和测试，但也适用于生产环境。

← Tokens

创建供应 →