Web3.py 模式:回退原因查找

2022-11-07 10:08:56 浏览数 (1)

本文作者:一个程序猿[1]

在编写智能合约时,鼓励包含人类可读的错误信息。在 Solidity 中,可以在require 或者 revert 语句[2]中声明。如:

代码语言:javascript复制
function subtract(uint256 a, uint256 b) public pure returns (uint256) {
    require(b <= a, "(a) must be larger than (b)!");
    uint256 c = a - b;
    return c;
}

像 Etherscan 这样的区块链浏览器,会自动收集并显示错误信息,但是如果你需要以编程的方式找出为什么交易失败了,还需要做很多工作。

如果取到一笔以太坊交易,你会发现所有相关信息都包含在交易的发送中,如to, from, value, 和 data。另一方面,交易收据会指出交易失败,但不包含回退原因字符串。

一种获取回退原因的方法是用eth_call方法重现交易。这个RPC[3]方法是用来在本地执行交易 —— 不会被广播到网络上,但是你可以看到结果,就好像交易真的被打包了一样。

为了重现交易,需要这笔交易最初执行时的上下文,如,当时账户中的余额。eth_call允许传入一个你想要重现的交易的区块号。注意,如果交易被打包在区块n中,你会想要用区块n-1的上下文来重现它。伪代码如下:

代码语言:javascript复制
from web3 import Web3

w3 = Web3(<your-provider>)
w3.eth.call(replay_tx, block_number - 1)

* 注意这里有一个很重要的限制:重现交易的执行是孤立的。这意味着同一个区块中的在原始交易之前的交易不会被计入。如果你觉得之前的交易是导致失败的原因,请跳到本文末尾的“更新”部分。

有一个问题,默认情况下,以太坊客户端不会存储对旧交易进行此类检查的所有历史上下文。存储由“归档”节点执行,这需要更多的存储空间。如果你没有运行自己的归档节点,就需要支持这个功能的供应商。

把所有归结在一起 —— 交易哈希就是准备重现交易所需的所有内容。获取该交易提供了交易的输入和所在的区块。看看下面的完整代码示例,用了一个随机选择的 Uniswap 失败交易:

代码语言:javascript复制
import os
from web3 import Web3, HTTPProvider

# instantiate your (archive-capable) provider:
w3 = Web3(HTTPProvider(os.environ['MAINNET_URL']))

# fetch a reverted transaction:
tx = w3.eth.get_transaction('0x2e7aa4314eeb171d4...')

# build a new transaction to replay:
replay_tx = {
    'to': tx['to'],
    'from': tx['from'],
    'value': tx['value'],
    'data': tx['input'],
}

# replay the transaction locally:
try:
    w3.eth.call(replay_tx, tx.blockNumber - 1)
except Exception as e:
    print(e)
    # execution reverted: UniswapV2Router: INSUFFICIENT_OUTPUT_AMOUNT

更新: 这个方案需要同一个区块中较早的交易数据,如果不适用你的用例,你可以考虑用像Tenderly[4]的工具或者用 Erigon 自定义像Otterscan[5]ots_getTransactionError一样的 RPC 方法。

感谢pintail[6]对本文的宝贵反馈。

原文链接:https://snakecharmers.ethereum.org/web3py-revert-reason-parsing/

参考资料

[1]

一个程序猿: https://learnblockchain.cn/people/9

[2]

require 或者 revert 语句: https://solidity-by-example.org/error/

[3]

RPC: https://ethereum.org/en/developers/docs/apis/json-rpc/

[4]

Tenderly: https://tenderly.co/

[5]

Otterscan: https://github.com/wmitsuda/otterscan

[6]

pintail: https://twitter.com/pintail_xyz

0 人点赞