Solidity ERC20代币：从零开始构建智能合约

时间：2025-03-04 阅读数：46人阅读

Solidity智能合约编写：从零开始构建一个简单的ERC-20代币

1. 环境搭建与工具选择

Solidity 智能合约的编写需要一个高效且可靠的开发环境。选择合适的工具和搭建完善的开发环境是智能合约开发的基础。以下是一些常用的工具及其环境搭建步骤，旨在帮助开发者快速上手并提升开发效率：

安装Node.js 和 npm: Solidity 开发工具通常依赖 Node.js 环境。前往 nodejs.org 下载并安装最新稳定版本的 Node.js。npm (Node Package Manager) 会随 Node.js 一起安装。

安装 Truffle: Truffle 是一个流行的智能合约开发框架，提供编译、部署、测试和调试功能。使用 npm 安装 Truffle：

bash npm install -g truffle

安装 Ganache: Ganache 提供一个本地的区块链环境，用于测试智能合约。可以下载 Ganache 图形界面版本或使用 npm 安装命令行版本：

bash npm install -g ganache-cli

选择编辑器: 推荐使用 VS Code，并安装 Solidity 插件，例如 "Solidity by Juan Blanco"。

2. 创建 Truffle 项目

初始化一个新的 Truffle 项目是智能合约开发的第一步。Truffle 提供了一个便捷的命令来快速搭建项目框架：

mkdir mytoken 创建一个新的目录，命名为 "mytoken"，用于存放项目文件。
cd mytoken 进入 "mytoken" 目录，后续操作将在该目录下进行。
truffle init 使用 Truffle 初始化命令，生成项目所需的必要文件和目录结构。

Truffle 初始化后，会自动创建以下目录和文件，它们在智能合约的开发、部署和测试中扮演着关键角色：

contracts/ : 这是存放 Solidity 智能合约源文件的目录。你所有的 .sol 文件都应该放在这里。每个智能合约代表一个区块链上的可执行代码单元。
migrations/ : 存放合约部署脚本的目录。部署脚本使用 JavaScript 编写，用于指导 Truffle 如何将智能合约部署到区块链上。脚本通常包含合约编译、部署和可能的初始化操作。脚本文件以数字开头，表明执行顺序，例如 1_initial_migration.js 。
test/ : 存放测试文件的目录。测试文件用于验证智能合约的功能是否符合预期。可以使用 JavaScript 或 Solidity 编写测试用例，并通过 Truffle 提供的测试框架运行。良好的测试覆盖率对于确保智能合约的安全性和可靠性至关重要。
truffle-config.js : Truffle 配置文件，包含了项目的各种配置信息，例如网络配置 (development, testnet, mainnet)、编译器版本、合约源代码目录、构建输出目录等。你可以根据实际需要修改此文件，以适应不同的开发和部署环境。该文件导出一个 JavaScript 对象，允许您配置 Truffle 的行为。例如，您可以指定要使用的 Solidity 编译器版本，以及要部署到的区块链网络。

3. 编写 ERC-20 代币合约

在 contracts/ 目录下创建一个名为 MyToken.sol 的文件。这个文件将包含你的 ERC-20 代币的智能合约代码，定义了代币的名称、符号、总供应量以及如何发行和转移代币的规则。

将以下 Solidity 代码写入 MyToken.sol 文件：

pragma solidity ^0.8.0;

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

contract MyToken is ERC20 {
    uint256 public constant INITIAL_SUPPLY = 10000 * (10 ** decimals());

    constructor() ERC20("MyToken", "MTK") {
        _mint(msg.sender, INITIAL_SUPPLY);
    }
}

这段代码片段做了以下几件事，共同定义了一个符合 ERC-20 标准的代币：

pragma solidity ^0.8.0; : 这行代码声明了该合约所使用的 Solidity 编译器的版本。 ^0.8.0 表示合约与 0.8.0 或更高版本，但不低于 0.9.0 的编译器兼容。指定编译器版本有助于确保合约的行为可预测且与编译器保持一致。
import "@openzeppelin/contracts/token/ERC20/ERC20.sol"; : 这一行导入了 OpenZeppelin 库中预先编写好的 ERC-20 合约。OpenZeppelin 提供了一套安全、可靠的智能合约标准实现。通过导入 ERC20 合约，你无需从头开始编写所有 ERC-20 功能，减少了代码量，并利用了经过审计的安全代码。
contract MyToken is ERC20 { ... } : 这行代码定义了一个名为 MyToken 的合约，它继承自 OpenZeppelin 的 ERC20 合约。继承意味着 MyToken 合约自动拥有 ERC20 合约定义的所有函数和变量，例如 transfer , balanceOf , 和 totalSupply 。
uint256 public constant INITIAL_SUPPLY = 10000 * (10 ** decimals()); : 这一行定义了一个公共常量 INITIAL_SUPPLY ，它表示代币的初始发行总量。 uint256 表示一个 256 位的无符号整数。 decimals() 是 ERC-20 标准的一部分，定义了代币可以分割成的小数位数。通常，ERC-20 代币有 18 位小数，这意味着 10 ** decimals() 等于 10 ** 18 。这个初始供应量被设置为 10000 个代币，然后乘以 10 的 decimals 次方（比如10的18次方），确保代币可以被细分到指定的精度。
constructor() ERC20("MyToken", "MTK") { ... } : 这是 MyToken 合约的构造函数。构造函数是在合约部署到区块链时自动执行的代码。 ERC20("MyToken", "MTK") 调用了父类 ERC20 合约的构造函数，并设置了代币的名称为 "MyToken"，符号为 "MTK"。名称是代币的全名，而符号是一个较短的，通常为 3-4 个字符的缩写，用于在交易所和钱包中标识代币。
_mint(msg.sender, INITIAL_SUPPLY); : 这一行代码调用了 ERC20 合约的 _mint 函数。 _mint 函数是 OpenZeppelin 提供的，用于创建新的代币并将它们分配给指定的地址。在这里， msg.sender 表示部署合约的账户地址，即合约的创建者。 INITIAL_SUPPLY 是之前定义的初始发行量。这行代码将所有初始代币都分配给部署合约的人。 _mint 函数是内部函数，只能在合约内部调用。

4. 编写部署脚本

为了将编译好的智能合约部署到区块链上，我们需要创建一个部署脚本。Truffle 使用 JavaScript 文件作为部署脚本，这些脚本位于 migrations/ 目录下。创建一个名为 2_deploy_mytoken.js 的文件，该文件将包含部署 MyToken 合约的逻辑。

2_deploy_mytoken.js 文件的内容如下：


const MyToken = artifacts.require("MyToken");

module.exports = function (deployer) {
  deployer.deploy(MyToken);
};

该脚本的核心作用是指导 Truffle 如何将 MyToken 合约部署到目标区块链网络。下面对代码的每一部分进行详细解释：

const MyToken = artifacts.require("MyToken"); : 这行代码使用 artifacts.require() 函数导入 MyToken 合约的 artifact。artifact 是 Truffle 编译智能合约后生成的 JSON 文件，它包含了合约的应用程序二进制接口 (ABI) 和字节码 (bytecode)。ABI 描述了如何与合约进行交互，字节码则是合约在以太坊虚拟机 (EVM) 上执行的代码。通过导入 artifact，部署脚本能够访问合约的元数据，从而正确地部署和初始化合约。
module.exports = function (deployer) { ... } : 这行代码定义了一个函数，并将它导出为 Node.js 模块。Truffle 会自动调用这个函数来执行部署操作。 deployer 是一个 Truffle 提供的对象，它提供了一系列用于部署智能合约的方法。
deployer.deploy(MyToken); : 这行代码是部署脚本的关键部分。它使用 deployer 对象的 deploy() 方法来部署 MyToken 合约。 deploy() 方法会将合约的字节码发送到区块链网络，并创建一个新的合约实例。在部署过程中，Truffle 会自动处理 Gas 限制和交易签名等细节。

5. 配置 Truffle

打开 truffle-config.js 文件，这是 Truffle 项目的核心配置文件，用于定义项目的各种设置，包括网络配置、编译器版本、部署选项等。我们需要配置网络信息，以便 Truffle 能够连接到区块链网络，并进行合约的部署和测试。

例如，要配置 Ganache 网络，Ganache 是一个流行的本地以太坊区块链模拟器，非常适合用于开发和测试智能合约。以下是一个配置 Ganache 网络的示例代码：


module.exports = {
  networks: {
    development: {
      host: "127.0.0.1",      // Localhost (默认: none)  通常情况下Ganache运行在本机，地址为127.0.0.1或localhost
      port: 7545,               // Standard Ganache UI port (默认: none) Ganache默认监听7545端口，也可以在Ganache界面中自定义端口
      network_id: "*",        // Any network (默认: none)  设置为"*"允许连接到任何网络ID的区块链，方便本地开发
      gas: 6721975,            // Gas limit used for deploys (优化gas使用,根据合约复杂性调整)
      gasPrice: 20000000000     // 20 gwei (优化gas价格,根据网络情况调整)
    },
  },

  // Configure your compilers
  compilers: {
    solc: {
      version: "0.8.0",    // Fetch exact version from solc-bin (默认: truffle's version)  指定Solidity编译器的版本，建议与合约编译版本一致
      settings: {          // See the solidity docs for advice about optimization and gas consumption.
       optimizer: {
         enabled: true,
         runs: 200
       }
      }
    }
  },

  mocha: {
    timeout: 100000  // 设置mocha测试超时时间
  },
};

确保 port 和 Ganache 监听的端口一致。 Ganache 启动后会显示其监听的端口，请确保 truffle-config.js 中的 port 设置与之匹配，否则 Truffle 将无法连接到 Ganache 网络。同时，需要指定 Solidity 编译器的版本为 0.8.0 ，这保证了合约的编译与指定的Solidity编译器版本兼容。建议使用与合约源代码pragma声明一致的编译器版本，避免潜在的编译错误或不兼容问题。还可以配置gasLimit和gasPrice来优化交易成本，以及设置优化器来提高合约性能，降低gas消耗。为了应对复杂的合约，还需设置一个足够长的mocha测试超时时间。

6. 编译智能合约

在完成智能合约的编写后，下一步是将其编译成以太坊虚拟机（EVM）可以理解的字节码。Truffle 提供了一个便捷的命令来执行此操作。

在终端或命令提示符中，导航到您的 Truffle 项目根目录，并执行以下命令：

truffle compile

此命令会指示 Truffle 使用配置的编译器（通常是 Solidity 编译器 solc ）来处理项目中的所有合约文件。编译过程包括语法检查、类型验证和代码优化等步骤，以确保合约的正确性和效率。

编译结果：

如果编译过程成功完成，Truffle 会在 build/contracts 目录下生成一系列 . 文件。每个 . 文件对应一个已编译的合约，并包含以下关键信息：

ABI (Application Binary Interface)： ABI 是一个 JSON 格式的接口描述，定义了合约的函数、事件和数据结构。它允许外部应用程序（例如 JavaScript 前端或另一个智能合约）与已部署的合约进行交互。ABI 描述了如何调用合约函数，以及如何解码合约返回的数据。
Bytecode (字节码)： Bytecode 是 EVM 可以执行的低级代码。它是合约的编译结果，将被部署到以太坊区块链上。Bytecode 包含了合约的所有逻辑和指令。
Deployed Bytecode (部署后的字节码): 与bytecode 类似，但包括了constructor 构造函数运行时需要的代码。
Source Map (源代码地图): 方便debug，将bytecode映射回源代码。

这些 . 文件是部署和与合约交互所必需的。您需要 ABI 来生成合约的客户端接口，并需要 bytecode 将合约部署到区块链上。

7. 部署合约

在本地环境中部署智能合约通常需要一个模拟区块链环境，Ganache 就是一个常用的选择。如果你选择使用 Ganache 的命令行版本，请在终端中运行 ganache-cli 命令来启动它。确保 Ganache 已经成功启动并运行，为合约部署提供一个可用的区块链网络。

部署合约的核心步骤是使用 Truffle 提供的 migrate 命令。在终端中，导航到你的 Truffle 项目根目录，然后运行以下命令：

truffle migrate

Truffle 将会按照 migrations/ 目录下的编号顺序执行迁移脚本，这些脚本定义了合约的部署过程。每个迁移脚本通常包含部署特定合约的指令，以及可能的合约初始化操作。 Truffle 会连接到你配置的网络（例如 Ganache），并使用这些脚本将合约部署到区块链上。

部署成功后，Truffle 会在终端中显示详细的部署信息，包括每个合约的交易哈希、gas 使用量以及最重要的——合约的地址。这个地址是与已部署合约进行交互的关键，你需要记录下合约地址，以便后续在应用程序中使用，例如前端界面或与其他智能合约交互。

8. 测试合约

在 test/ 目录下创建一个名为 mytoken.test.js 的文件，并写入以下 JavaScript 代码，用于验证 MyToken 合约的各项功能是否符合预期：

javascript const MyToken = artifacts.require("MyToken");

contract("MyToken", (accounts) => { it("应该将初始发行量分配给部署者账户", async () => { const token = await MyToken.deployed(); const totalSupply = await token.totalSupply(); const balance = await token.balanceOf(accounts[0]);

assert.equal(totalSupply.toNumber(), 10000 * (10 ** 18), "总发行量不正确");
assert.equal(balance.toNumber(), 10000 * (10 ** 18), "部署者账户余额不正确");

}); it("应该允许账户之间转移代币", async () => { const token = await MyToken.deployed(); const sender = accounts[0]; const receiver = accounts[1]; const amount = 100 * (10 ** 18); // 转移100个代币 await token.transfer(receiver, amount, { from: sender }); const receiverBalance = await token.balanceOf(receiver); assert.equal(receiverBalance.toNumber(), amount, "接收者余额不正确"); const senderBalance = await token.balanceOf(sender); assert.equal(senderBalance.toNumber(), 9900 * (10 ** 18), "发送者余额不正确"); }); });

这段代码使用 Mocha 和 Chai 测试框架来测试 MyToken 合约，确保其功能按照预期工作。Mocha 提供测试结构，而 Chai 提供断言方法来验证结果。

const MyToken = artifacts.require("MyToken"); : 导入 MyToken 合约的 artifact。Artifact 是 Truffle 编译合约时生成的 JSON 文件，包含了合约的 ABI（Application Binary Interface）和字节码，用于与合约进行交互。
contract("MyToken", (accounts) => { ... }); : 定义一个测试合约， accounts 是 Ganache 提供的测试账户数组。Ganache 是一个快速、轻量级的以太坊模拟器，用于本地开发和测试。
it("应该将初始发行量分配给部署者账户", async () => { ... }); : 定义一个测试用例，测试初始发行量是否正确分配给合约部署者（即部署合约的账户）。 async 关键字表示该函数是一个异步函数，可以使用 await 关键字等待异步操作完成。
const token = await MyToken.deployed(); : 获取已部署的 MyToken 合约实例。 MyToken.deployed() 返回一个 Promise，它会在合约部署完成后 resolve 成合约实例。
const totalSupply = await token.totalSupply(); : 调用 totalSupply 函数获取总发行量。 totalSupply() 是合约中定义的一个只读函数，返回代币的总供应量。
const balance = await token.balanceOf(accounts[0]); : 调用 balanceOf 函数获取部署者的余额。 balanceOf() 函数接受一个地址作为参数，返回该地址拥有的代币数量。 accounts[0] 是 Ganache 提供的第一个测试账户，通常是合约部署者的账户。
assert.equal(totalSupply.toNumber(), 10000 * (10 ** 18), "总发行量不正确"); : 使用 assert.equal 断言总发行量是否等于 10000 * (10 ** 18)。因为代币通常有小数位，所以需要将数量乘以 10 的 18 次方来表示整数形式。 totalSupply.toNumber() 将 BigNumber 对象转换为 JavaScript 的 Number 类型，以便进行比较。第三个参数是断言失败时显示的错误信息。
assert.equal(balance.toNumber(), 10000 * (10 ** 18), "部署者账户余额不正确"); : 使用 assert.equal 断言部署者的余额是否等于 10000 * (10 ** 18)。
it("应该允许账户之间转移代币", async () => { ... }); : 添加一个测试用例，验证代币转移功能是否正常。
await token.transfer(receiver, amount, { from: sender }); : 调用 transfer 函数将 amount 数量的代币从 sender 账户转移到 receiver 账户。 { from: sender } 指定交易的发送者账户。
const receiverBalance = await token.balanceOf(receiver); : 获取接收者的余额。
assert.equal(receiverBalance.toNumber(), amount, "接收者余额不正确"); : 断言接收者的余额是否等于转移的代币数量。
const senderBalance = await token.balanceOf(sender); : 获取发送者的余额。
assert.equal(senderBalance.toNumber(), 9900 * (10 ** 18), "发送者余额不正确"); : 断言发送者的余额是否等于初始余额减去转移的代币数量。