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

用事件发布链上状态变化

用事件发布链上状态变化

当合约里的计数值改变时,前端不仅要知道当前值,还需要知道谁触发了变更、从多少变成多少。本课用一个 Solidity 计数器发出事件,再用 Forge 检查交易日志,区分事件记录与持久化状态。

学习目标

  • 使用 event、indexed 和 emit 发布可检索的状态变更事件。
  • 区分交易日志的 topics、data 与合约存储,并验证它们的实际内容。
  • 判断何时应该读取状态、何时应该消费事件,以及交易回滚对日志的影响。

声明事件并记录变更

在已安装 Foundry 的 Solidity 0.8.24 及以上兼容环境中,把下面的完整合约保存为 src/Counter.sol。count 保留最新值;CountChanged 记录每次成功递增的操作者和变更前后数值。

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

contract Counter {
    uint256 public count;

    // 操作者用于链下过滤,前后数值供事件消费方解码
    event CountChanged(
        address indexed operator,
        uint256 previousValue,
        uint256 newValue
    );

    function increment() external {
        uint256 previousValue = count;
        count = previousValue + 1;
        // 状态与事件同属一次交易,回滚时两者均不生效
        emit CountChanged(msg.sender, previousValue, count);
    }
}

预期行为:首次成功调用 increment(),count() 返回 1,并产生一条 CountChanged(调用者, 0, 1) 日志。第二次调用后,存储值为 2,新日志记录 1 和 2;之前的日志不会被覆盖。emit 不会把历史记录写入可供合约查询的数组。

读懂 topics 与 data 的分工

普通非匿名事件最多支持三个 indexed 参数。此例的 operator 被放到 topics[1],便于 RPC 按调用者过滤;两个计数值没有索引,按 ABI 编码放到 data。不要把事件声明里的参数顺序误当作日志原始字段排列顺序。

交易日志字段 本例保存的内容 主要用途
address 发出事件的 Counter 合约地址 限定日志来源
topics[0] keccak256("CountChanged(address,uint256,uint256)") 识别事件类型
topics[1] 32 字节编码的 operator 地址 按操作者过滤
data 依次编码的 previousValue、newValue 解码变更详情

计数器更新时持久化存储与事件日志的分流关系

例如,前端想列出某个账户触发的递增,可以同时限定合约地址、事件签名与 operator 的 topic;想展示“0 变成 1”,则须按事件 ABI 解码 data。如果将 string 或动态数组设为 indexed,topic 保存的是特殊编码后的哈希,不能直接还原原值。

用 Forge 验证日志和合约存储

在 Bash 终端执行以下命令初始化项目,然后用上面的合约替换生成的 src/Counter.sol;把接下来的测试内容写入并覆盖 test/Counter.t.sol。示例依赖项目自带的 forge-std。

bash
forge init counter-events
cd counter-events

预期结果:创建 counter-events 项目目录,其中包含 src、test 和 lib/forge-std 等项目内容;初始化需要能够获取所需依赖。

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

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

contract CounterEventTest is Test {
    Counter private counter;

    function setUp() public {
        counter = new Counter();
    }

    function testIncrementWritesStorageAndLog() public {
        vm.recordLogs();
        counter.increment();
        Vm.Log[] memory entries = vm.getRecordedLogs();

        assertEq(counter.count(), 1);
        assertEq(entries.length, 1);
        assertEq(entries[0].emitter, address(counter));
        assertEq(entries[0].topics.length, 2);
        // 事件签名和 indexed 参数分别占用前两个 topic
        assertEq(entries[0].topics[0], keccak256("CountChanged(address,uint256,uint256)"));
        assertEq(entries[0].topics[1], bytes32(uint256(uint160(address(this)))));

        // 未索引的两个数值需要从 data 解码
        (uint256 beforeValue, uint256 afterValue) =
            abi.decode(entries[0].data, (uint256, uint256));
        assertEq(beforeValue, 0);
        assertEq(afterValue, 1);
    }
}

这份测试同时检查存储值、事件来源、主题数目、操作者和数据区,避免只看 count == 1 就以为日志一定正确。执行:

bash
forge test --match-test testIncrementWritesStorageAndLog -vv

预期输出(节选,Gas 与耗时随环境变化):

text
[PASS] testIncrementWritesStorageAndLog()
Suite result: ok. 1 passed; 0 failed; 0 skipped

如果编译器提示找不到 forge-std/Test.sol,先检查是否位于项目根目录、lib/forge-std 是否存在;缺少依赖时可以在项目根目录运行 forge install foundry-rs/forge-std,然后重新测试。

不要用事件代替链上状态

合约读取当前计数应调用 count(),而不是尝试从历史事件中计算:EVM 合约无法直接查询过去交易的日志。日志适合供链下索引、审计、通知及界面刷新使用,并非其他合约可读取的持久状态。indexed 用于过滤,不代表加密;事件参数仍可从公开链数据中观察。

如果 increment() 后面的逻辑发生 revert,本次交易的存储写入和 emit 日志都会被撤销,不能把“代码执行过 emit”当作事件已上链的证据。生产监听器应只处理已实际收录的日志,保存处理进度,并考虑链重组导致日志被移除或重新出现的情况;需要展示即时权威值时,再读取合约状态校验。

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

目录与阅读设置

阅读设置

17

记录一个想法

用事件发布链上状态变化

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

登录哪都通