智能合约与以太坊 / 系统课时

校验事件日志和账户余额

校验事件日志和账户余额

支付合约即使成功执行,也可能记录错误金额、遗漏事件,或者把 ETH 转给错误账户。本课使用 Foundry 的 vm.expectEmit 验证事件名称、参数和发出者,再用余额断言检查存款、提款前后的实际资金变化,完成一条可重复运行的支付测试。

学习目标

  • 使用 vm.expectEmit 校验事件的 indexed 参数、非 indexed 数据及事件发出地址。
  • 使用 vm.deal、vm.startPrank 和 assertEq 验证 ETH 转移与内部账本更新。
  • 区分事件日志正确与实际资金流向正确,定位支付测试中的常见遗漏。

准备支付合约与测试场景

在已经初始化、包含 forge-std 依赖的 Foundry 项目中,创建 test/PaymentVault.t.sol。本例使用 Solidity ^0.8.24,不依赖真实 RPC、钱包私钥或测试网 ETH。

测试对象是一个简化金库 PaymentVault,包含两个入口:

  1. deposit():接收 ETH,增加调用者的 credit,发出 Deposited 事件。
  2. withdraw(amount):检查余额、扣减内部账本,再通过 call 把 ETH 退还给调用者,成功后发出 Withdrawn 事件。

使用固定账户 0xA11CE 作为付款人,并通过 vm.deal 将其初始余额设置为 3 ETH。测试执行一笔 1 ETH 存款,再提取 0.4 ETH。

检查阶段 付款人余额 金库余额 内部 credit
初始 3 ETH 0 ETH 0 ETH
存入 1 ETH 2 ETH 1 ETH 1 ETH
提取 0.4 ETH 2.4 ETH 0.6 ETH 0.6 ETH

这里的账户余额指 EVM 原生 ETH 余额,通过 address.balance 读取;credit 则是合约维护的业务账本。两者不是同一个数据来源,必须分别检查。

编写事件与余额联合测试

将下面完整代码保存到 test/PaymentVault.t.sol。文件同时包含被测合约和测试合约,可以直接在标准 Foundry 项目中运行。

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

import {Test} from "forge-std/Test.sol";

contract PaymentVault {
    mapping(address => uint256) public credit;

    event Deposited(address indexed payer, uint256 amount);
    event Withdrawn(address indexed payer, uint256 amount);

    function deposit() external payable {
        require(msg.value > 0, "zero value");
        credit[msg.sender] += msg.value;
        emit Deposited(msg.sender, msg.value);
    }

    function withdraw(uint256 amount) external {
        require(amount > 0 && credit[msg.sender] >= amount, "invalid amount");

        // 先扣减内部余额,再与外部账户交互
        credit[msg.sender] -= amount;
        (bool ok, ) = payable(msg.sender).call{value: amount}("");
        require(ok, "ETH transfer failed");

        // 只有实际转账成功才发布提款事件
        emit Withdrawn(msg.sender, amount);
    }
}

contract PaymentVaultTest is Test {
    PaymentVault vault;
    address payable payer = payable(address(0xA11CE));

    // 测试中重新声明相同事件签名,用于构造期望日志
    event Deposited(address indexed payer, uint256 amount);
    event Withdrawn(address indexed payer, uint256 amount);

    function setUp() public {
        vault = new PaymentVault();
        vm.deal(payer, 3 ether);
    }

    function testPaymentFlow() public {
        vm.startPrank(payer);

        uint256 payerBefore = payer.balance;
        uint256 vaultBefore = address(vault).balance;

        // 检查 topic1、data 和实际发出日志的合约地址
        vm.expectEmit(true, false, false, true, address(vault));
        emit Deposited(payer, 1 ether);
        vault.deposit{value: 1 ether}();

        assertEq(payer.balance, payerBefore - 1 ether);
        assertEq(address(vault).balance, vaultBefore + 1 ether);
        assertEq(vault.credit(payer), 1 ether);

        // 再验证提款事件及资金返回方向
        vm.expectEmit(true, false, false, true, address(vault));
        emit Withdrawn(payer, 0.4 ether);
        vault.withdraw(0.4 ether);

        assertEq(payer.balance, 2.4 ether);
        assertEq(address(vault).balance, 0.6 ether);
        assertEq(vault.credit(payer), 0.6 ether);

        vm.stopPrank();
    }
}

vm.expectEmit 的四个布尔参数依次代表是否检查 topic1、topic2、topic3 和非 indexed 的 data。事件签名对应的 topic0 会被检查。本例只有 payer 一个 indexed 参数,因此选择 true, false, false, true,并通过第五个参数 address(vault) 限定真正的事件发出者。

测试中的 emit Deposited(...) 和 emit Withdrawn(...) 是用于提供期望值的模板事件,不是被测合约的执行结果。Foundry 会在后续调用中寻找匹配日志;模板事件本身不能让一个没有发出对应事件的金库通过检查。

vm.startPrank(payer) 让后续外部合约调用使用付款人身份,因此存款记录在 credit[payer],提款也会向同一个账户付款。测试完成后通过 vm.stopPrank() 恢复默认调用身份。

执行测试并核对结果

在项目根目录运行:

bash
forge test --match-test testPaymentFlow -vv

预期输出中的关键内容如下,Gas 数值、编译信息和执行耗时会随 Foundry 版本与编译设置变化:

text
[PASS] testPaymentFlow() (gas: <GAS>)

这条测试通过,表示存款和提款两次操作同时满足三组检查:

  • 事件检查:Deposited 和 Withdrawn 的名称、付款人、金额及发出合约均与预期一致。
  • 原生余额检查:付款人从 3 ETH 下降至 2 ETH,提款后恢复至 2.4 ETH;金库余额最终为 0.6 ETH。
  • 内部账本检查:credit[payer] 先增加至 1 ETH,再下降至 0.6 ETH。

对于一笔存入金额为 DD、提款金额为 WW 的操作,可以分别检查:

Bpayer,final=Bpayer,initial−D+WB_{payer,final}=B_{payer,initial}-D+W
Bvault,final=Bvault,initial+D−WB_{vault,final}=B_{vault,initial}+D-W

本例代入 D=1D=1 ETH、W=0.4W=0.4 ETH,得到付款人 2.4 ETH、金库 0.6 ETH。两者合计仍为 3 ETH。这里比较的是 Foundry 测试中合约调用引起的余额变化,不包含真实链上交易发送者支付的 Gas 手续费。

识别事件日志与真实资金流向的区别

事件日志、合约内部账本和原生 ETH 余额属于三个独立的观测维度。事件记录了一次操作声明的结果,但不会自动转移资金;账本记录了业务余额,也不能单独证明 ETH 已经正确发送。

存款与提款过程中的事件日志、内部账本和 ETH 余额三路对照

以下三种错误具有不同表现:

合约缺陷 事件断言 余额或账本断言
实际存入 1 ETH,却记录 0.5 ETH 失败 可能通过
提款事件正确,但 ETH 转给错误账户 可能通过 失败
ETH 已到账,但忘记扣减 credit 可能通过 内部账本断言失败

尤其需要检查提款的资金接收者。如果合约错误地将 0.4 ETH 发送给第三方,即使 Withdrawn(payer, 0.4 ether) 的日志参数完全正确,付款人的余额也不会达到预期的 2.4 ETH。

定位测试失败的原因

测试失败时,优先根据报错来源区分是日志错误还是资金错误。使用更详细的执行跟踪:

bash
forge test --match-test testPaymentFlow -vvvv

预期结果:正确实现仍通过;发生断言失败时,测试报告会显示失败信息,并在详细 trace 中展示相关调用与事件。具体行号、Gas 和 trace 内容取决于实际代码,不应使用固定输出判断故障。

定位时遵循下面的顺序:

  1. 如果 expectEmit 失败,先检查事件是否实际执行,再核对 indexed 修饰、事件参数顺序、金额和发出者地址。
  2. 如果付款人余额错误,检查 call{value: amount} 的目标地址、金额,以及是否通过 vm.startPrank 使用了预期身份。
  3. 如果金库余额正确但 credit 错误,检查存款与提款中修改 mapping 的语句,特别是提款是否遗漏扣减。
  4. 如果调用整体回滚,检查 require 条件和 ETH 接收方是否能够接收转账;回滚后的状态修改与事件日志不会保留为成功执行的链上结果。

还可以做一次反向验证:将 deposit() 内的事件参数临时改为 emit Deposited(msg.sender, msg.value / 2),重新执行测试。此时 vm.expectEmit 应当报告事件不匹配;恢复正确金额后测试重新通过。这个实验可以确认测试并非只在检查交易是否成功,而是确实约束了日志内容。

最终验收一笔 ETH 支付时,应同时观察实际转账双方的原生余额、合约业务账本及事件日志。只有这三类结果都符合预期,才能排除日志看似正确、资金却流向错误账户的缺陷。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

校验事件日志和账户余额

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通