Forge是一个以太坊开发框架。您可以使用它来创建Solidity项目,管理依赖关系,运行测试等等。这是一个初学者指南。我将介绍如何创建项目,管理依赖
Forge是一个以太坊开发框架。您可以使用它来创建Solidity项目,管理依赖关系,运行测试等等。它受Dapp启发,与之有一个重要的相似之处,即测试是用Solidity编写的。这与迄今为止的其他以太坊开发框架不同。它是用Rust编写的,非常快速。
这是一个初学者指南。我将介绍如何创建项目,管理依赖项和编写测试。预期的受众是熟悉Solidity并希望了解如何使用Forge进行开发的人。
首先,您需要安装Foundty泛的以太坊工具包。我建议查看仓库以获取最新的安装说明,但这是当前的安装命令。
$ cargo install --git https://github.com/gakonst/foundry --bin forge --locked
请注意,如果您尚未安装Rust/Cargo,则需要先安装它。请查看这里的说明 (Forgeup是一个有用的工具,用于获取最新的Forge版本或指向特定分支。)
接下来,创建一个文件夹进行操作,并初始化一个项目。
$ mkdir forge-tutorial
$ cd forge-tutorial
$ forge init
Nice!现在在forge-tutorial目录下应该有两个目录:lib
和src
。
lib目录是所有安装的依赖项所处的位置。这些依赖项是作为git子模块进行管理的。您会发现在lib目录中已经有一个名为ds-test
的依赖项,默认已经安装好了。ds-test
是由Dapp的创建者开发的,其中包含了一些用于测试的有用的函数和事件的合约。您可以在Github上看到这个代码。
src目录是您的代码所在的位置。在顶层您会看到Contract.sol
和一个test
目录。在test
目录中有Contract.t.sol
。
由于这份文档是针对那些已经熟悉Solidity的人群,我将主要关注于测试,因为这正是在使用Forge时的独特之处。
运行forge test,您应该会看到类似这样的内容。
测试通过,并告诉您测试函数使用的 gas 量。
让我们打开Contract.t.sol
文件,看看发生了什么。
首先,您应该注意到我们在用Solidity编写测试!许多人已经习惯了用其他语言为Solidity编写测试,但当您考虑这一点时,这似乎有点奇怪。您能想到其他需要您使用不同语言来测试代码的编程语言吗?这是Forge的创作者的一个重要观点:如果每个Solidity开发者都必须同时了解其他语言,我们怎样才能培养出优秀的Solidity开发者呢?
让我们深入研究一下正在发生的事情。首先,我们注意到在顶部导入了ds-test
,合约正在继承自DSTest
,这就给ContractTest
提供了访问ds-test/test.sol
中所有方便的测试函数/事件的权限,正如我上面所提到的。例如,正在使用的assertTrue
函数是在DSTest
中定义的。我建议您查看ds-test
文件夹中的test.sol
文件,看看所有可用的不同类型的断言。
setUp
是一个特殊的函数,在任何测试运行之前将被调用。稍微修改代码以查看其运行原理。
如果您运行forge test
,这个测试应该通过。
将数字10
改为9
。
然后运行forge test
,您应该会看到结果。
Nice!如预期一样,测试失败了。请注意,测试函数的名称必须包含test
。如果函数只是叫做example
,它不会自动在运行forge test
时执行。
如果您期望测试失败,您可以将测试名称的前缀改为testFail
,而不仅仅是test
。
如果您运行forge test
,这个测试应该会通过。请注意,这也适用于回滚操作。
实际上,我也认为testFail模式有点奇怪(您知道有东西失败了,但不知道具体是什么)。在下面的“Cheat Codes”中,我们将讨论一个更好的选择,即expectRevert
。
要实际测试您的智能合约,首先我们需要在Contract.sol
中添加一些代码。
然后在Contract.t.sol
中,您可以导入这个合约,并像下面这样为其编写一个测试:
在运行测试时,您可以通过传递-v来指定详细程度。更多的-v,详细程度越高,5(-vvvvv
)是最高级别。以下是每个级别的作用:
1: 默认(在运行测试时通常看到的结果) 2: 打印日志 3: 为失败的测试打印测试跟踪 4: 总是打印测试跟踪,为失败的测试打印设置 5: 总是打印测试跟踪和设置
让我们添加一行日志并使用-vv
来运行我们的测试,以查看它。 我将在我的代码中添加一个 emit log_string
。
如果您对Solidity不太熟悉,合约可以发出事件。但是log_string
事件在哪里定义的呢?在ds-test
库中的test.sol
文件中。
运行forge test -vv
查看test.sol
中的其他日志事件,并尝试一些其他的事件!接下来,让我们传入-vvvv
,这样我们就可以看到来自我们测试的详细信息。运行forge test -vvvv
这向您展示了我们的测试函数testAddone 调用了addOne,addOne 调用使用了717 gas,并返回了3!
Forge的一个非常酷炫的功能是模糊测试。与指定函数的静态输入不同,模糊测试会为您提供特定类型的随机值。例如,我们可以通过更改函数以接受一个参数来将testAddOne制作成一个模糊测试,就像这样
如果您运行forge test
,会看到
这段文字告诉您它运行了256次(每次使用随机的uint256值x),平均gas是2789,中位数是2791。
作弊码是使用Forge进行测试的基础。 作弊码存在于Dapp中,并在Forge中得到拓展。 基本上,这些作弊码是对“VM”合约的调用,会导致VM修改其普通执行行为。 我在这里给出几个例子。
首先,让我们谈谈作弊码,它可以用来设置下一次调用的msg.sender。 如果这听起来没有意义,只需要继续阅读,您就会明白我的意思。
首先,我将在Contract.t.sol
的顶部添加一个合约。
接下来更新我们的测试合约
注意,我可以简化这个操作为
我正在尝试构建setUp的使用,这对于更复杂的设置是必需的。
现在,我们需要添加一个接收作弊码调用的VM合约。
该VM始终位于这个地址。它是从哪里来的呢?address(bytes20(uint160(uint256(keccak256(‘hevm cheat code’))))) = 0x7109709ecfa91a80626ff3989d68f67f5b1dd12d
。我们还需要定义一个VM接口,以便编译器知道我们希望能够调用哪些方法。你可以添加任意数量的作弊码,现在我将添加prank。
最后,让我们将我的测试更新为命名为testBar,并调用 foo.bar()
。我的测试文件现在看起来像这样。
运行forge test -vvvv
你会看到
这里发生了什么呢?嗯,bar 要求 msg.sender 是 address(1),但当前的 msg.sender 只是我们测试合约的地址。我们可以使用 prank 从 address(1) 调用 bar。
运行forge test -vvvv
现在,我们还可以使用另一个作弊码 expectRevert
来测试我们预期的 revert。将 expectRevert
添加到 Vm 接口中。
然后增加一个新的测试
运行forge test -vvvv
Nice!
假设我们想要使用其他人的合约。也许是来自 Rari 的 Solmate。我们可以通过运行 forge install rari-capital/solmate
来进行安装。运行此命令后,你会看到 solmate 已经被添加到 lib 中。
我可以像这样导入特定的合约:
你的一些合约或你导入的合约可能在 NPM 格式中有导入,例如 import "@openzeppelin/contracts/access/Ownable.sol;
。让我们看看如何处理这种情况。
首先安装 OpenZeppelin 合约:forge install OpenZeppelin/openzeppelin-contracts
。
接下来,让我们将该导入行添加到我们的测试文件中。
运行forge build
我们可以通过创建一个remappings.txt
文件来告诉 Forge 正确查找这个文件的位置。
$ touch remappings.txt
然后在该文件写入:
@openzeppelin/=lib/openzeppelin-contracts/
这告诉 Forge:“嘿,每当你遇到 @openzepplin/
,就在 lib/openzeppelin-contracts/
中查找。”
现在如果你运行 forge build
或 forge test
,应该可以正常工作。
如果你只想运行一些测试,有一个很方便的标志 -m
,它会匹配测试名称。例如,运行 forge test -vvvv -m Revert
,任何测试名称中包含“Revert”的测试都会运行!
通过运行 forge snapshot
来快照你的测试的 gas 使用情况。
与从空白状态开始不同,你可以使用来自实时以太坊网络的状态来运行你的测试。要做到这一点,你需要使用 -f
标志将以太坊节点 URI 传递给你的测试,即 forge test -f <uri>
。(你可以从 Alchemy 或 Infura 获取这样的 URI。)这非常酷:在你的测试中,你可以调用一个地址,比如 Mainnet 上的 USDC 地址,并获得实时网络状态的响应。这对于测试可能特别难以模拟的合约或状态非常有用。
如果觉得我的文章对您有用,请随意打赏。你的支持将鼓励我继续创作!