Foundry单元测试之模拟地址

• 1. vm.prank
  • 特点：
  • 示例：
• 2. vm.startPrank
• 3. 总结对比
• 4. 何时使用 vm.prank 与 vm.startPrank？
• 5. 推荐的使用方式

vm.startPrank 和 vm.prank 都是 Foundry 中用于模拟（prank）不同地址执行合约操作的函数。它们的作用相似，但在使用场景和行为上有一些细微的区别。以下是这两个函数的对比。

1. vm.prank

vm.prank 是用来模拟当前调用者为某个地址的一种简便方式。它在执行下一次合约调用时，会模拟调用者的地址，但它只对下一次调用有效。

特点：

• 模拟一次：vm.prank 只在下一次调用中有效。
• 即时生效：每次使用 vm.prank 后，立即生效，且只有紧接着的调用会使用模拟的地址。
• 不可连续模拟：如果你需要对多个函数调用模拟同一个地址，需要多次使用 vm.prank。

示例：

function testPrank() public {
    address nonOwner = address(0x123);

    // 使用 vm.prank 模拟非拥有者调用
    vm.prank(nonOwner);
    myToken.freezeAccount(address(0x456));  // 只会在这次调用时模拟 nonOwner 地址
}

在上面的例子中，vm.prank(nonOwner) 只会影响 myToken.freezeAccount(address(0x456)) 这一调用，模拟地址为 nonOwner。

2. vm.startPrank

vm.startPrank 是 vm.prank 的改进版，它提供了一个 开始模拟的接口，并且支持 持续模拟，直到你显式停止。vm.startPrank 会持续将指定的地址作为调用者，直到调用 vm.stopPrank() 来恢复原本的调用者。

特点：

• 持续模拟：vm.startPrank 会持续模拟指定地址，直到调用 vm.stopPrank() 来停止。
• 多次模拟调用：如果你需要在多个操作中都模拟同一个地址，只需要调用一次 vm.startPrank。
• 显式停止模拟：使用 vm.stopPrank() 可以结束对地址的模拟。

示例：

function testStartPrank() public {
    address nonOwner = address(0x123);

    // 开始模拟 nonOwner 地址
    vm.startPrank(nonOwner);

    // 在多个调用中，模拟的地址都会是 nonOwner
    myToken.freezeAccount(address(0x456));  // 由 nonOwner 模拟调用
    myToken.transfer(address(0x789), 100);  // 由 nonOwner 模拟调用

    // 停止模拟，恢复为原本的调用者
    vm.stopPrank();
}

在这个例子中，vm.startPrank(nonOwner) 会持续模拟 nonOwner 地址进行后续的所有调用，直到调用 vm.stopPrank() 恢复为原本的调用者。

3. 总结对比

4. 何时使用 vm.prank 与 vm.startPrank？

• vm.prank 适用于简单的测试场景，尤其是你只需要模拟一次调用的情况。例如，当你需要验证某个操作是否会因权限检查而失败时，可以用 vm.prank 来模拟非拥有者的调用。
• vm.startPrank 适用于需要在多个合约调用中持续模拟同一个地址的场景。例如，如果你需要模拟某个地址执行多个操作，vm.startPrank 会非常有用，避免了重复调用 vm.prank，并且在所有操作中都使用同一个地址进行模拟。

5. 推荐的使用方式

• 如果你只需要模拟一次调用，使用 vm.prank 可能更直观、更简洁。
• 如果你需要模拟多个连续调用，或者当你预计将来会有扩展时，使用 vm.startPrank 可能会更灵活，因为它提供了持续的模拟，并且在调用过程中无需重复设置模拟地址。

总之，根据具体需求选择使用 vm.prank 或 vm.startPrank，并根据合约的扩展性考虑未来可能需要的功能。如果模拟多个调用的场景较为复杂，vm.startPrank 会提供更多的灵活性。

声明：本作品采用署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)进行许可，使用时请注明出处。
Author: mengbin
blog: mengbin
Github: mengbin92
cnblogs: 恋水无意
腾讯云开发者社区：孟斯特
—