跳到主要内容

Ethers极简入门: 11. CallStatic

我最近在重新学ethers.js,巩固一下细节,也写一个WTF Ethers极简入门,供小白们使用。

推特@0xAA_Science

WTF Academy社群: 官网 wtf.academy | WTF Solidity教程 | discord | 微信群申请

所有代码和教程开源在github: github.com/WTFAcademy/WTFEthers


这一讲,我们介绍合约类的callStatic方法,在发送交易之前检查交易是否会失败,节省大量gas。

可能失败的交易

在以太坊上发交易需要付昂贵的gas,并且有失败的风险,发送失败的交易并不会把gas返还给你。因此,在发送交易前知道哪些交易可能会失败非常重要。如果你用过metamask小狐狸钱包,那对下图不会陌生。

你的交易可能失败!

如果你的交易将失败,小狐狸会告诉你this transaction may fail,翻译过来就是“这笔交易可能失败”。当用户看到这个红字提示,就知道要取消这笔交易了,除非他想尝尝失败的滋味。

它是怎么做到的呢?这是因为以太坊节点有一个eth_call方法,让用户可以模拟一笔交易,并返回可能的交易结果,但不真正在区块链上执行它(交易不上链)。

callStatic

ethers.js中你可以利用contract对象的callStatic()来调用以太坊节点的eth_call。如果调用成功,则返回ture;如果失败,则报错并返回失败原因。方法:

    const tx = await contract.callStatic.函数名( 参数, {override})
console.log(`交易会成功吗?:`, tx)
  • 函数名:为模拟调用的函数名。
  • 参数:调用函数的参数。
  • {override}:选填,可包含一下参数:
    • from:执行时的msg.sender,也就是你可以模拟任何一个人的调用,比如V神。
    • value:执行时的msg.value
    • blockTag:执行时的区块高度。
    • gasPrice
    • gasLimit
    • nonce

callStatic模拟DAI转账

  1. 创建providerwallet对象。

    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.providers.JsonRpcProvider(ALCHEMY_MAINNET_URL);

    // 利用私钥和provider创建wallet对象
    const privateKey = '0x227dbb8586117d55284e26620bc76534dfbd2394be34cf4a09cb775d593b6f2b'
    const wallet = new ethers.Wallet(privateKey, provider)
  2. 创建DAI合约对象,注意,这里生成合约时要用provider而不是wallet,不然则不能更改callStatic方法中的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)
  3. 查看钱包中DAI余额,为0。

    const address = await wallet.getAddress()
    console.log("\n1. 读取测试钱包的DAI余额")
    const balanceDAI = await contractDAI.balanceOf(address)
    console.log(`DAI持仓: ${ethers.utils.formatEther(balanceDAI)}\n`)

    钱包DAI余额

  4. callStatic调用transfer()函数,将from参数填为V神地址,模拟V神转账10000 DAI。这笔交易将成功,因为V神钱包有充足的DAI

    console.log("\n2.  用callStatic尝试调用transfer转账1 DAI,msg.sender为V神地址")
    // 发起交易
    const tx = await contractDAI.callStatic.transfer("vitalik.eth", ethers.utils.parseEther("10000"), {from: "vitalik.eth"})
    console.log(`交易会成功吗?:`, tx)

    模拟V神转账

  5. callStatic调用transfer()函数,将from参数填为测试钱包地址,模拟转账10000 DAI。这笔交易将失败,报错,并返回原因Dai/insufficient-balance

    console.log("\n3.  用callStatic尝试调用transfer转账1 DAI,msg.sender为测试钱包地址")
    const tx2 = await contractDAI.callStatic.transfer("vitalik.eth", ethers.utils.parseEther("10000"), {from: address})
    console.log(`交易会成功吗?:`, tx)

    模拟测试钱包转账

总结

ethers.jseth_call封装在callStatic方法中,方便开发者模拟交易的结果,并避免发送可能失败的交易。我们利用callStatic模拟了V神和测试钱包的转账。当然,这个方法还有更多用处,比如计算土狗币的交易滑点。开动你的想象力,你会将callStatic用在什么地方呢?