Solidity 中 revert(), assert() 和 require() 的使用方法

2024-04-04 09:58

本文主要是介绍Solidity 中 revert(), assert() 和 require() 的使用方法,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

转载自:https://ethfans.org/posts/when-to-use-revert-assert-and-require-in-solidity

Solidity 0.4.10 版本发布了新的 assert() , require() 和 revert() 函数,解决了以前代码中有困惑的地方。特别地,新 assert() 和 require() 代码会“确保”提高合约代码逻辑条理清晰,但是也需要知道如何区别使用它们。

本文中,将会:

  1. 解释新函数解决的问题
  2. 讨论 Solidity 编译器如何处理新 assert() 、 require() 和 revert() 调用
  3. 给出使用新代码的最佳实践

为了更好理解,我生成了使用这些新功能的简单合约,用户可以在 remix 上进行测试。

如果只是想看“太长不看版”,那么 ethereum stackexchange 上的回答可以解答疑问。

Solidity 的错误处理模式

传统方法:采用 throw 和 if ... throw 模式

例如合约中有一些功能,只能被授权为 拥有者 的地址才能调用。

Solidity 0.4.10之前(以及其后一段时间),这种强制授权处理方式很普遍:


contract HasAnOwner {address owner;function useSuperPowers(){ if (msg.sender != owner) { throw; }// do something only the owner should be allowed to do}
}

如果 useSuperPowers() 函数被其它非拥有者调用,此函数将抛出“返回无效操作代码错误”,回滚所有状态改变,而且消耗掉剩下的gas(更多关于 gas 与费用的信息可以参考这篇 ethereum 中的文章)。

现在,“throw(抛出)”关键字已经过时了,最终将会被弃用。幸运的是,新函数 assert() 、 require() 和 revert() 提供了同样功能,而且上下文更加干净。

新文法

咱们看看用新代码函数如何处理传统 if ... throw 模式,

这行代码:

if(msg.sender != owner) { throw; }

完全等价于如下三种形式:

  • if(msg.sender != owner) { revert(); }

  • assert(msg.sender == owner);

  • require(msg.sender == owner);

注意在 assert() 和 require() 例子中的条件声明,是 if 例子中条件块取反,也就是用 ==代替了 != 。

assert()和require()之间的区别

首先,可以将 assert() 想象为一个过于自信的实现方式,即使有错误,也会执行并扣除gas。然而 require() 可以被想象为一个更有礼貌些的实现方式,会发现错误,并且原谅所犯错误(译注:不扣除 gas)。

基于以上理解,以上两个函数真正区别在哪里呢?在拜占庭网络更新前, require() 和 assert() 表现完全一样,但是他们的二进制代码却有略微区别。

  1. assert() 使用 0xfe 操作码引起错误条件
  2. require() 使用 0xfd 操作码引起错误条件

如果在黄皮书中查找这些操作码,会发现找不到。也就是为什么会看到 无效操作码 错误,因为并没有客户端如何处理这些错误的明确定义。

拜占庭网络升级并实现 EIP-140:以太坊虚机回滚指南之后,会解决这个问题。0xfd 操作码的改变将在 REVERT 指南中反映出来。

以下是这一激动人心功能的描述:

在0.4.10版本之后部署了许多合约,其中包括一个暂时不用的新操作代码。现在,它被激活了,就是 REVERT 。

注: throw 和 revert() 都是用 0xfd 操作码。而 0.4.10 之前,throw 就是使用的 0xfe

REVERT 操作码实现功能

REVERT 碰到无效代码后,仍将回滚所有状态,但是会用两种不同于“无效代码”方式处理:

  1. 允许返回一个数值
  2. 将剩余gas返还调用者

1. 允许返回一个数值

许多智能合约开发者对以前那种无用的无效代码错误很熟悉。幸运的是,很快新代码可以返回一个错误信息,或者代表某种错误类型的数值。

看起来像这样:

revert(‘Something bad happened’);

或者

require(condition, ‘Something bad happened’);

注:Solidity 暂时还不支持返回变量,但是可以参见这个问题更新。

2. 将剩余 gas 返还调用者

目前的合约处理 throws 后会消耗剩余的 gas。尽管可以视为对矿工的慷慨捐助,但是往往会消耗用户大量金钱。

一旦 REVERT 在 EVM 中实现,将会抛弃旧方式转而将剩余 gas 返还用户。

在revert(), assert()和require()中作出选择

那么,如果 revert() 和 require() 都会返还剩余 gas,而且允许返回一个数值,那么为什么还使用 assert() 这种会消耗 gas 的调用呢?

不同点在于输出的二进制代码,引用如下文档以便更清楚解释(我做的着重强调)

require函数用于:
- 确认有效条件,例如输入,
- 确认合约声明变量是一致的
- 从调用到外部合约返回有效值

如果正确使用,分析工具会评估合约并分辨出引起 assert 调用错误的条件和函数。正确函数代码将会避免引起调用错误的 assert 声明;如果发生就意味着合约中存在需要修复的bug。

为了更清楚地解释:require() 声明失败应该被认为是正常和健壮的情况(跟 revert() 一样);而当 assert() 声明失败时,则意味着有些东西失控了,需要修复代码中的问题。

如果遵循以上实践指南,静态分析和正式验证工具可以用于检查合约,发现并证实合约中的隐患,或者确保合约安全无漏洞地运行。

特别地,我会使用如下准则来帮助判断正确使用场景。

以下场景使用 require() :

  • 验证用户输入,即: require(input<20);
  • 验证外部合约响应,即: require(external.send(amount));
  • 执行合约前,验证状态条件,即: require(block.number > SOME_BLOCK_NUMBER) 或者 require(balance[msg.sender]>=amount)
  • 一般地,尽量使用 require 函数
  • 一般地,require 应该在函数最开始的地方使用

在我们的智能合约最佳实践中有很多使用 require() 的例子供参考。

以下场景使用 revert() :

  • 处理与 require() 同样的类型,但是需要更复杂处理逻辑的场景

如果有复杂的 if/else 逻辑流,那么应该考虑使用 revert() 函数而不是require()。记住,复杂逻辑意味着更多的代码。

以下场景使用 assert()

  • 检查 overflow/underflow,即:c = a+b; assert(c > b)
  • 检查非变量(invariants),即:assert(this.balance >= totalSupply);
  • 验证改变后的状态
  • 预防不应该发生的条件
  • 一般地,尽量少使用 assert 调用
  • 一般地,assert 应该在函数结尾处使用

基本上,require() 应该被用于函数中检查条件,assert() 用于预防不应该发生的情况,但不应该使条件错误。

另外,“除非认为之前的检查(用 if 或 require )会导致无法验证 overflow,否则不应该盲目使用 assert 来检查 overflow”——来自于@chriseth

结论

这些函数是安全性检查工具库中很强大的工具。知道如何以及何时使用这些函数不仅能帮助你的代码免受攻击,而且会使代码更加对用户友好,更加面向未来变化。


喜欢这种类型文章吗?

我来自ConsenSys Diligence团队。如果你有 Solidity 和 EVM 方面深入技能,而且对提高智能合约安全性很感兴趣,我们希望你能加入智能合约审查部门(从这里申请)。

如果你看到了这里但还达不到工作描述中的要求,也没关系。只需要在消息中引用此文,并说出你的技能和对以太坊的兴趣即可。

这篇关于Solidity 中 revert(), assert() 和 require() 的使用方法的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/875480

相关文章

PHP轻松处理千万行数据的方法详解

《PHP轻松处理千万行数据的方法详解》说到处理大数据集,PHP通常不是第一个想到的语言,但如果你曾经需要处理数百万行数据而不让服务器崩溃或内存耗尽,你就会知道PHP用对了工具有多强大,下面小编就... 目录问题的本质php 中的数据流处理:为什么必不可少生成器:内存高效的迭代方式流量控制:避免系统过载一次性

Python使用FastAPI实现大文件分片上传与断点续传功能

《Python使用FastAPI实现大文件分片上传与断点续传功能》大文件直传常遇到超时、网络抖动失败、失败后只能重传的问题,分片上传+断点续传可以把大文件拆成若干小块逐个上传,并在中断后从已完成分片继... 目录一、接口设计二、服务端实现(FastAPI)2.1 运行环境2.2 目录结构建议2.3 serv

Spring Security简介、使用与最佳实践

《SpringSecurity简介、使用与最佳实践》SpringSecurity是一个能够为基于Spring的企业应用系统提供声明式的安全访问控制解决方案的安全框架,本文给大家介绍SpringSec... 目录一、如何理解 Spring Security?—— 核心思想二、如何在 Java 项目中使用?——

springboot中使用okhttp3的小结

《springboot中使用okhttp3的小结》OkHttp3是一个JavaHTTP客户端,可以处理各种请求类型,比如GET、POST、PUT等,并且支持高效的HTTP连接池、请求和响应缓存、以及异... 在 Spring Boot 项目中使用 OkHttp3 进行 HTTP 请求是一个高效且流行的方式。

python获取指定名字的程序的文件路径的两种方法

《python获取指定名字的程序的文件路径的两种方法》本文主要介绍了python获取指定名字的程序的文件路径的两种方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要... 最近在做项目,需要用到给定一个程序名字就可以自动获取到这个程序在Windows系统下的绝对路径,以下

Java使用Javassist动态生成HelloWorld类

《Java使用Javassist动态生成HelloWorld类》Javassist是一个非常强大的字节码操作和定义库,它允许开发者在运行时创建新的类或者修改现有的类,本文将简单介绍如何使用Javass... 目录1. Javassist简介2. 环境准备3. 动态生成HelloWorld类3.1 创建CtC

JavaScript中的高级调试方法全攻略指南

《JavaScript中的高级调试方法全攻略指南》什么是高级JavaScript调试技巧,它比console.log有何优势,如何使用断点调试定位问题,通过本文,我们将深入解答这些问题,带您从理论到实... 目录观点与案例结合观点1观点2观点3观点4观点5高级调试技巧详解实战案例断点调试:定位变量错误性能分

使用Python批量将.ncm格式的音频文件转换为.mp3格式的实战详解

《使用Python批量将.ncm格式的音频文件转换为.mp3格式的实战详解》本文详细介绍了如何使用Python通过ncmdump工具批量将.ncm音频转换为.mp3的步骤,包括安装、配置ffmpeg环... 目录1. 前言2. 安装 ncmdump3. 实现 .ncm 转 .mp34. 执行过程5. 执行结

Python中 try / except / else / finally 异常处理方法详解

《Python中try/except/else/finally异常处理方法详解》:本文主要介绍Python中try/except/else/finally异常处理方法的相关资料,涵... 目录1. 基本结构2. 各部分的作用tryexceptelsefinally3. 执行流程总结4. 常见用法(1)多个e

Java使用jar命令配置服务器端口的完整指南

《Java使用jar命令配置服务器端口的完整指南》本文将详细介绍如何使用java-jar命令启动应用,并重点讲解如何配置服务器端口,同时提供一个实用的Web工具来简化这一过程,希望对大家有所帮助... 目录1. Java Jar文件简介1.1 什么是Jar文件1.2 创建可执行Jar文件2. 使用java