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

将 Solidity 断言转为模糊属性

将 Solidity 断言转为模糊属性

合约里的 assert 往往只检查某一次调用是否满足条件,而 Echidna 可以反复生成交易序列,尝试寻找破坏条件的操作。本篇以资金池资产守恒为例,将业务断言改写为 echidna_ 属性函数,再使用 assertion 模式交叉验证,并观察真实缺陷如何被发现。

学习目标

  • 将资产守恒等业务约束转换为可执行的布尔属性。
  • 使用 Echidna 的 property 与 assertion 模式运行测试。
  • 识别状态属性、操作后置条件和测试覆盖范围之间的区别。

将业务约束写成可检查的属性

假设一个简化资金池接受用户存款与提款,必须满足两个条件:所有用户的账面余额总和等于 totalDeposits,并且合约实际持有的 ETH 不少于账面负债。

本例只有两个固定测试账户,分别由 balanceA 和 balanceB 表示。业务约束可以写成:

totalDeposits=balanceA+balanceB\text{totalDeposits}=\text{balanceA}+\text{balanceB}
contractBalance≥totalDeposits\text{contractBalance}\geq\text{totalDeposits}

第一个等式检查内部记账守恒,第二个不等式检查资产覆盖率。第二个条件使用不小于而非严格相等,是因为合约可能被强制转入 ETH,导致实际资产高于账面负债。

Echidna 默认使用 property 模式,识别名称以 echidna_ 开头、无参数、返回 bool 的 Solidity 函数。返回 false 或执行时发生回滚,都可能使属性被报告为失败。

编写属性时,需要区分两种检查位置:

  • 状态属性:检查当前合约状态,例如总负债是否等于各账户余额之和。
  • 操作后置条件:检查执行特定操作后的结果,例如提款后用户余额是否减少指定数量。

对于可由状态变量直接计算的约束,优先使用状态属性。它可以在不同交易序列之后反复检查,而不依赖某个固定输入。

编写可被 Echidna 执行的合约

下面创建 Conservation.sol。示例使用 Solidity 0.8.20,要求本地安装兼容的 Solidity 编译器以及 Echidna。为了让资产关系容易核算,合约限定两个账户,每次存款由调用者指定账户编号。

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

contract Conservation {
    uint256 public balanceA;
    uint256 public balanceB;
    uint256 public totalDeposits;

    // 账户编号仅用于简化资产守恒实验,不代表真实用户鉴权。
    function deposit(uint8 account) external payable {
        require(account < 2, "invalid account");
        require(msg.value > 0, "zero deposit");
        if (account == 0) {
            balanceA += msg.value;
        } else {
            balanceB += msg.value;
        }
        totalDeposits += msg.value;
    }

    function withdraw(uint8 account, uint256 amount) external {
        require(account < 2, "invalid account");
        require(amount > 0, "zero amount");
        if (account == 0) {
            require(balanceA >= amount, "insufficient");
            balanceA -= amount;
        } else {
            require(balanceB >= amount, "insufficient");
            balanceB -= amount;
        }

        // 故意遗漏 totalDeposits -= amount,用于验证属性能否发现错误。
        (bool ok, ) = payable(msg.sender).call{value: amount}("");
        require(ok, "transfer failed");
    }

    function echidna_accounting_conservation()
        public view returns (bool)
    {
        return totalDeposits == balanceA + balanceB;
    }

    function echidna_asset_coverage()
        public view returns (bool)
    {
        return address(this).balance >= totalDeposits;
    }
}

这里故意引入一个记账缺陷:提款减少用户余额,却没有同步减少 totalDeposits。如果用户先存入 10 wei,再成功提取 4 wei,内部账面会变为:

指标 提款前 提款后
balanceA 10 6
totalDeposits 10 10
实际资产 10 6

两个属性都会从 true 变成 false。不过这是预期的业务层面分析,并不代表 Echidna 一定生成这组精确输入。实际能否触发取决于生成的调用序列、ETH 转账成功与否及测试预算。

在 property 模式下寻找反例

创建 echidna-property.yaml,使用适度的交易序列长度,允许模糊测试先存款再提款。

yaml
testMode: property
testLimit: 20000
seqLen: 20
shrinkLimit: 5000

这份配置中,testLimit 控制测试序列的生成预算,seqLen 控制每条序列的最大交易数,shrinkLimit 控制发现失败后缩减反例的工作量。对于依赖多次交易才会显现的状态错误,不应一开始就将 seqLen 设为 1。

在保存合约和配置文件的目录执行:

bash
echidna Conservation.sol --contract Conservation --config echidna-property.yaml

预期结果:如果生成了成功的存款与提款序列,Echidna 应报告至少一个属性失败,并给出可用于复现的调用序列。由于生成过程具有随机性,具体交易参数和反例长度不固定。

text
echidna_accounting_conservation: failed!
echidna_asset_coverage: failed!

以上是关键结果的示意摘录,不是完整终端输出;不同版本可能使用不同的状态显示格式。如果测试没有找到反例,先检查是否生成非零存款、提款是否实际成功,以及测试账户是否拥有足够 ETH。

修复缺陷时,在 withdraw 中完成余额扣减后、外部转账前增加:

solidity
// 片段示例:放在 Conservation.withdraw 内部,依赖已定义的 amount。
totalDeposits -= amount;

该修改使账面负债与用户余额同步减少。重新运行相同命令后,两个属性预期不再因为这处记账缺陷失败。但测试通过只能说明当前预算内没有找到反例,不能证明合约绝对安全。

使用 assertion 模式进行交叉验证

如果希望检查操作执行后的内部条件,可以将 assert 放入业务函数。Echidna 的 assertion 模式会针对执行过程中的断言失败报告问题,与 property 模式检查独立属性函数的方式不同。

先恢复上一节故意遗漏扣减的有缺陷版本,并在 withdraw 完成转账之后添加断言:

solidity
// 片段示例:放在 Conservation.withdraw 的末尾,依赖合约状态变量。
assert(totalDeposits == balanceA + balanceB);
assert(address(this).balance >= totalDeposits);

创建独立配置文件 echidna-assertion.yaml:

yaml
testMode: assertion
testLimit: 20000
seqLen: 20
shrinkLimit: 5000

执行以下命令:

bash
echidna Conservation.sol --contract Conservation --config echidna-assertion.yaml

预期结果:当模糊测试触发一次成功的正数提款,且执行到新增的断言时,第一条 assert 应当失败;Echidna 将报告断言失败及其反例序列。具体输出包含的函数名称、交易参数与状态信息依 Echidna 版本而不同。

需要注意,两个模式不能简单互换。property 模式可以检查每轮交易后的整体状态;assertion 模式只有执行路径真正到达断言位置时,才可能发现对应断言失败。

Echidna 两种属性检查模式的执行关系

两种模式的选择可按下面的规则判断:

需求 推荐模式 检查位置
资产守恒、供应量上限 property 独立 echidna_ 函数
转账后余额变化正确 assertion 业务操作执行路径
测试 Foundry 风格测试函数 foundry 测试合约入口
搜索数值函数的最大结果 optimization 返回整数的属性函数

foundry 与 optimization 是其他测试模式,不应将它们的命名规则直接套用到 property 模式。以上模式名称以 Echidna 项目当前公开文档为依据,运行前可通过 echidna --help 检查本机版本支持的选项。

避免属性检查出现假安全感

属性失败未必等于业务代码存在漏洞,属性通过也未必说明业务安全。交付前应检查三个具体边界。

首先,属性必须覆盖所有相关状态。本例只有两个固定账户,因此可以直接相加。真实 ERC-20 合约如果只累加两个测试地址,却宣称证明 totalSupply 等于所有地址余额之和,就是错误建模。应在测试模型中维护完整的受控账户集合或使用影子记账变量。

其次,不能只测试不发生状态变化的路径。deposit 要求 msg.value > 0,如果测试环境始终没有生成有效的带 ETH 交易,两个属性可能一直通过。需要查看覆盖率、成功调用记录及反例语料,确认存款和提款路径确实被执行。

最后,要区分内部记账与真实资金流。本例检查的资产覆盖条件是实际 ETH 余额不少于内部负债;对于真实金库,还需要考虑外部代币转账失败、手续费代币、重入风险和舍入误差,不能直接照搬这个等式。

可以进行一次回归练习:先运行存在缺陷的版本,确认至少发现一次守恒失败;再补上 totalDeposits -= amount,分别执行 property 与 assertion 测试,确认原有反例不再违反守恒条件。修复后仍要保留两个模式的测试,因为它们从不同检查位置验证同一个业务约束。

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

目录与阅读设置

阅读设置

17

记录一个想法

将 Solidity 断言转为模糊属性

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

登录哪都通