合约开发和测试

开发合约

上篇文章 中我们我们创建了一个带有 Mint 功能的 ERC721 的基础合约，接下来我们再继续了解下合约的功能编写和编译测试。

下面的代码我们简单实现一个新的 mint 方法来取代默认生成的 safeMint，新的 mint 方法和我们在上一章用到的方法接口保持一致，这样当我们部署完成这个合约之后就可以把课程的合约替换为新的合约了。

具体要修改的内有：

1. 把 initialOwner 设置为合约发行人，这样在部署合约的时候就会更简单，不用指定 initialOwner。
2. 定义了一个名为 _nextTokenId 类型为uint256合约私有变量private，用来标记当前的进度，每新增一个 NFT 该值需要加一；
3. 在 mint 方法中要求传入的类型为 uint256 的 quantity，代表这次要铸造多少个 NFT。在这里，我们先简化逻辑，限制每次只能铸造一个。
4. 去掉 onlyOwner 修饰符，这样就可以让任何人都可以调用 mint 方法了。
5. 添加 payable 修饰符，这样就可以让调用 mint 方法的人可以同时向合约转账了。
6. _safeMint 也要改为 _mint，这个主要是为了避免在后面通过 Remix 合约调用合约来测试的时候报错，to 也对应改为 msg.sender，代表 NFT 铸造给发起交易的地址。

代码如下：

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

import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
import "@openzeppelin/contracts/access/Ownable.sol";

contract MyToken is ERC721, Ownable {
+    uint256 private _nextTokenId = 0;
-    constructor(address initialOwner)
+    constructor()
        ERC721("MyToken", "MTK")
-        Ownable(initialOwner)
+        Ownable(msg.sender)
    {}
-    function safeMint(address to, uint256 tokenId) public onlyOwner {
+    function mint(uint256 quantity) public payable {
+        require(quantity == 1, "quantity must be 1");
+        require(msg.value == 0.01 ether, "must pay 0.01 ether");
+        uint256 tokenId = _nextTokenId++;
-        _safeMint(to, tokenId);
+        _mint(msg.sender, tokenId);
    }
}

private 是指只有部署前合约里才能调用的方法和变量，public 方法和变量则是所有人都可以访问的

测试合约

1. 单元测试插件

我们需要点击左下角的 Plugin Manager图标在插件管理器搜索 unit 关键字，然后会出现搜索结果 SOLIDITY UNIT TESTING，点击 Activate，安装激活插件，如下图所示：

然后，Solidity unit testing 的图标将出现在左侧图标栏中，单击该图标将在侧面板中加载插件。

成功加载后，插件看起来应该是这样子的：

2. 单元测试文件

Remix 注入了一个内置的 assert 库，可用于测试。您可以在此处查看库的文档 这里。
除此之外，Remix 允许在测试文件中使用一些特殊函数，以使测试更具结构性。它们是：

• beforeEach() - 在每次测试之前运行
• beforeAll() - 在所有测试之前运行
• afterEach() - 在每次测试之后运行
• afterAll() - 在所有测试之后运行

我们的单元测试文件，在目录tests/MyToken_test.sol，这是因为我们选择的模板合约自动帮我们创建了测试合约。如果我们是新建的空白文件夹，那么就需要点击通过Generate 按钮来生成测试文件，如下图所示：

然后我们在File explorer中点击我们的测试文件tests/MyToken_test.sol，并编写以下测试内容：

1. remix_tests.sol 由 Remix 自动注入的；
2. remix_accounts.sol 为我们生成了测试账户的地址列表；
3. ../contracts/MyToken.sol 引入了我们编写过的合约文件；
4. 在beforeAll() 里实例化我们的合约MyToken定义为s，并拿一个测试地址存起来TestsAccounts.getAccount(0)定义为acc0；
5. testTokenNameAndSymbol() 里验证了，实例化后的合约name()要获取到的值为MyToken，symbol() 的值为MTK；
6. 编写函数testMint()，调用我们的mint(1)方法，铸造过一次的 balanceOf()值应该为 1;

tests/MyToken_test.sol文件代码如下：

// SPDX-License-Identifier: GPL-3.0

pragma solidity >=0.8.0 <0.9.0;
import "remix_tests.sol";
import "remix_accounts.sol";
import "../contracts/MyToken.sol";

contract MyTokenTest {
    MyToken s;
    function beforeAll () public {
        s = new MyToken();
    }

    function testTokenNameAndSymbol () public {
        Assert.equal(s.name(), "MyToken", "token name did not match");
        Assert.equal(s.symbol(), "MTK", "token symbol did not match");
    }
    /// #value: 10000000000000000
    function testMint() public payable {
        s.mint{value: msg.value}(1);
        Assert.equal(s.balanceOf(address(this)), 1, "balance did not match");
    }
}

Remix 的单测是在一个合约中调用我们要测试的合约来进行测试的，具体就先不展开了，大家可以参考 Remix 单元测试插件的文档。

3. 运行单元测试

当我们完成编写测试后，选择文件并点击Run 以执行测试。执行将在单独的环境中运行。完成一个文件的执行后，将显示如下的测试摘要：

到这里，我们合约的单元测试就完成啦。

当然如果你更擅长使用 Chai 和 Mocha 测试的话，Remix也是支持的。

Chai 是一个用于 Node.js 和浏览器的 BDD / TDD 断言库，可以与任何 JavaScript 测试框架愉快地配对使用。Mocha 是一个功能丰富的 JavaScript 测试框架，在 Node.js 和浏览器上运行，使异步测试变得简单而有趣。

只需要在工作区创建一个 js 文件，最好将其创建在 scripts 文件夹中。然后右键新建并编写好测试代码的 js 文件，点击Run。
大概像这样：

点击 Run ，执行测试后结果会显示在终端上。

这里只是一个示例，提供了可以操作的方式和方法，如果你擅长这种方式的话，完全是支持的。

接下来我们会尝试，把我们编写好的合约文件编译并部署上链 。