Solidity 异常处理
Solidity 是通过回退状态的方式来处理异常错误。发生异常时会撤消当前调用及其所有子调用所改变的状态,同时给调用者返回一个错误标识。
1. 条件检查
Solidity 提供了assert 和 require 来进行。
- require: require 函数用来输入变量或合约状态变量是否满足条件以及验证调用外部合约返回值。可以有返回值 require(condition, 'Something bad happened');
- assert: assert 函数用来检查(测试)内部错误。
同样作为判断一个条件是否满足的函数,require 会退回剩下的 gas,而 assert 会消耗所有的 gas。
例如:
pragma solidity ^0.8.0; contract GuessChallenge { bool public flag; function setFlag() external { //判断调用者的发送地址 是否等于当前地址,成立则继续运行。 require(msg.sender == address(this)); flag = true; }
2. 触发异常
提供了revert,throw 来触发异常:
- throw:关键字抛出异常(从 0.4.13 版本,throw关键字已被弃用),回滚所有状态改变,返回”无效操作代码错误”,而且消耗掉剩下的 gas;
- revert:函数可以用来标记错误并回退当前调用,允许返回一个数值,将剩余 gas 返还调用者。
传统处理异常的方式 if...throw 模式,即 if(msg.sender != owner) { throw; }。
等价于:
- if(msg.sender != owner) { revert(); } // 如果不等则异常
- assert(msg.sender == owner); // 校验是否等于
- require(msg.sender == owner);
3. 如何选择
require() 函数用于:
- 确认有效条件,例如输入;
- 确认合约声明变量是一致的;
- 从调用到外部合约返回有效值。
revert() 函数用于 :
- 处理与 require() 同样的类型,但是需要更复杂处理逻辑的场景;
- 如果有复杂的 if/else 逻辑流,那么应该考虑使用 revert() 函数而不是require()。
assert() 函数用于:
- 预防本不该发生的事情,如果发生就意味着合约中存在需要修复的bug(比如assert(1 > 2));
- 一般地,尽量少使用 assert 调用,一般assert 应该在函数结尾处使用。
4. try...catch
我们在当前合约发起对外部合约调用的话,如果外部合约调用执行失败被 revert,外部合约状态会被回滚,当前合约状态也会被回滚。
但有时候我们并不想这样,要是能够捕获外部合约调用异常,然后根据情况做自己的处理不是更好吗?所以,这种场景下适应于使用 try...catch 语句。
require 示例如下:
pragma solidity ^0.8.0; contract Manager { function count() public pure returns(int){ require(1==2,"require error"); return 2; } function test() public view returns(string memory) { try this.count() { return "success"; } catch Error(string memory reason/* 出错原因 */) { // 调用 count() 失败时执行,通常是不满足 require 语句条件或触发 revert 语句时所引起的调用失败 return reason; } catch (bytes memory) { // 调用 count() 异常时执行,通常是触发 assert 语句或除 0 等比较严重错误时会执行 return "assert error"; } } }
以上代码将会触发 catch Error(string memory reason) ,最终输出 require error。
assert 示例如下:
pragma solidity ^0.8.0; contract Manager { function count() public pure returns(int){ assert(1==2); return 2; } function test() public view returns(string memory) { try this.count() { return "success"; } catch Error(string memory reason/* 出错原因 */) { // 调用 count() 失败时执行,通常是不满足 require 语句条件或触发 revert 语句时所引起的调用失败 return reason; } catch (bytes memory) { // 调用 count() 异常时执行,通常是触发 assert 语句或除 0 等比较严重错误时会执行 return "assert error"; } } }
以上代码将会触发 catch (bytes memory) ,最终输出 assert error。
智能合约的访问权限共有 4 种类型: private、internal、public 和 external,本章节主要讲述它们之间的区别及应用。1. 访问权限1.1 privateprivate 函数 ...