Ethers极简入门: 11. StaticCall
我最近在重新学ethers.js
,巩固一下细节,也写一个WTF Ethers极简入门
,供小白们使用。
WTF Academy社群: 官网 wtf.academy | WTF Solidity教程 | discord | 微信群申请
所有代码和教程开源在github: github.com/WTFAcademy/WTFEthers
这一讲,我们介绍合约类的staticCall
方法,在发送交易之前检查交易是否会失败,节省大量gas。
staticCall
方法是属于ethers.Contract
类的编写方法分析,同类的还有populateTransaction
和estimateGas
方法。
可能失败的交易
在以太坊上发交易需要付昂贵的gas
,并且有失败的风险,发送失败的交易并不会把gas
返还给你。因此,在发送交易前知道哪些交易可能会失败非常重要。如果你用过metamask
小狐狸钱包,那对下图不会陌生。
如果你的交易将失败,小狐狸会告诉你this transaction may fail
,翻译过来就是“这笔交易可能失败”。当用户看到这个红字提示,就知道要取消这笔交易了,除非他想尝尝失败的滋味。
它是怎么做到的呢?这是因为以太坊节点有一个eth_call
方法,让用户可以模拟一笔交易,并返回可能的交易结果,但不真正在区块链上执行它(交易不上链)。
staticCall
在 ethers.js 中,你可以使用 contract.函数名.staticCall()
方法来模拟执行一个可能会改变状态的函数,但不实际向区块链提交这个状态改变。这相当于调用以太坊节点的 eth_call
。这通常用于模拟状态改变函数的结果。如果函数调用成功,它将返回函数本身的返回值;如果函数调用失败,它将抛出异常。
请注意,这种调用适用于任何函数,无论它在智能合约中是标记为 view/pure 还是普通的状态改变函数。它使你能够安全地预测状态改变操作的结果,而不实际执行这些操作。
const tx = await contract.函数名.staticCall( 参数, {override})
console.log(`交易会成功吗?:`, tx)
- 函数名:为模拟调用的函数名。
- 参数:调用函数的参数。
- {override}:选填,可包含以下参数:
from
:执行时的msg.sender
,也就是你可以模拟任何一个人的调用,比如Vitalik。value
:执行时的msg.value
。blockTag
:执行时的区块高度。gasPrice
gasLimit
nonce
用staticCall
模拟DAI
转账
创建
provider
和wallet
对象。import { ethers } from "ethers";
//准备 alchemy API 可以参考https://github.com/AmazingAng/WTFSolidity/blob/main/Topics/Tools/TOOL04_Alchemy/readme.md
const ALCHEMY_MAINNET_URL = 'https://eth-mainnet.g.alchemy.com/v2/oKmOQKbneVkxgHZfibs-iFhIlIAl6HDN';
const provider = new ethers.JsonRpcProvider(ALCHEMY_MAINNET_URL);
// 利用私钥和provider创建wallet对象
const privateKey = '0x227dbb8586117d55284e26620bc76534dfbd2394be34cf4a09cb775d593b6f2b'
const wallet = new ethers.Wallet(privateKey, provider)创建
DAI
合约对象,注意,这里生成合约时要用provider
而不是wallet
,不然则不能更改staticCall
方法中的from
(可能是bug,也可能是feature)。// DAI的ABI
const abiDAI = [
"function balanceOf(address) public view returns(uint)",
"function transfer(address, uint) public returns (bool)",
];
// DAI合约地址(主网)
const addressDAI = '0x6B175474E89094C44Da98b954EedeAC495271d0F' // DAI Contract
// 创建DAI合约实例
const contractDAI = new ethers.Contract(addressDAI, abiDAI, provider)查看钱包中
DAI
余额,为0。const address = await wallet.getAddress()
console.log("\n1. 读取测试钱包的DAI余额")
const balanceDAI = await contractDAI.balanceOf(address)
console.log(`DAI持仓: ${ethers.formatEther(balanceDAI)}\n`)用
staticCall
调用transfer()
函数,将from
参数填为Vitalik地址,模拟Vitalik转账10000 DAI
。这笔交易将成功,因为Vitalik钱包有充足的DAI
。console.log("\n2. 用staticCall尝试调用transfer转账1 DAI,msg.sender为Vitalik地址")
// 发起交易
const tx = await contractDAI.transfer.staticCall("vitalik.eth", ethers.parseEther("1"), {from: await provider.resolveName("vitalik.eth")})
console.log(`交易会成功吗?:`, tx)用
staticCall
调用transfer()
函数,将from
参数填为测试钱包地址,模拟转账10000 DAI
。这笔交易将失败,报错,并返回原因Dai/insufficient-balance
。console.log("\n3. 用staticCall尝试调用transfer转账10000 DAI,msg.sender为测试钱包地址")
const tx2 = await contractDAI.transfer.staticCall("vitalik.eth", ethers.parseEther("10000"), {from: address})
console.log(`交易会成功吗?:`, tx2)
总结
ethers.js
将eth_call
封装在staticCall
方法中,方便开发者模拟交易的结果,并避免发送可能失败的交易。我们利用staticCall
模拟了Vitalik和测试钱包的转账。当然,这个方法还有更多用处,比如计算土狗币的交易滑点。开动你的想象力,你会将staticCall
用在什么地方呢?