Human generated abi format created with ethers v6 throws an error

[ra-sun-god]

Ethers Version

6.8.1

Search Terms

abi, contract

Describe the Problem

I created a script which converts solidity abi to a human readable format, specifically multicall3's abi, but after, using the new abi resulted in an error below:

TypeError: mCallContract.tryAggregate is not a function. (In 'mCallContract.tryAggregate(revertOnError, inputs)', 'mCallContract.tryAggregate.staticCall' is undefined) —

Code Snippet

let mCallContract = new Contract(mCallContractAddr, multicall3Abi)
let resultsArr =  await mCallContract.tryAggregate.staticCall(revertOnError, inputs)

Contract ABI

`["function aggregate(tuple(address,bytes)(address target, bytes callData)[] calls) payable returns (uint256 blockNumber, bytes[] returnData)","function aggregate3(tuple(address,bool,bytes)(address target, bool allowFailure, bytes callData)[] calls) payable returns (tuple(bool,bytes)(bool success, bytes returnData)[] returnData)","function aggregate3Value(tuple(address,bool,uint256,bytes)(address target, bool allowFailure, uint256 value, bytes callData)[] calls) payable returns (tuple(bool,bytes)(bool success, bytes returnData)[] returnData)","function blockAndAggregate(tuple(address,bytes)(address target, bytes callData)[] calls) payable returns (uint256 blockNumber, bytes32 blockHash, tuple(bool,bytes)(bool success, bytes returnData)[] returnData)","function getBasefee() view returns (uint256 basefee)","function getBlockHash(uint256 blockNumber) view returns (bytes32 blockHash)","function getBlockNumber() view returns (uint256 blockNumber)","function getChainId() view returns (uint256 chainid)","function getCurrentBlockCoinbase() view returns (address coinbase)","function getCurrentBlockDifficulty() view returns (uint256 difficulty)","function getCurrentBlockGasLimit() view returns (uint256 gaslimit)","function getCurrentBlockTimestamp() view returns (uint256 timestamp)","function getEthBalance(address addr) view returns (uint256 balance)","function getLastBlockHash() view returns (bytes32 blockHash)","function tryAggregate(bool requireSuccess, tuple(address,bytes)(address target, bytes callData)[] calls) payable returns (tuple(bool,bytes)(bool success, bytes returnData)[] returnData)","function tryBlockAndAggregate(bool requireSuccess, tuple(address,bytes)(address target, bytes callData)[] calls) payable returns (uint256 blockNumber, bytes32 blockHash, tuple(bool,bytes)(bool success, bytes returnData)[] returnData)"]`

Errors

TypeError: mCallContract.tryAggregate is not a function. (In 'mCallContract.tryAggregate(revertOnError, inputs)', 'mCallContract.tryAggregate.staticCall' is undefined) —

Environment

No response

Environment (Other)

No response

[ricmoo]

There seems to be some typos in the ABI; how did you use ethers to generate these? This might be related to #4329. I'll bump that issue up in priority and link it to this one.

The fixed ABI is:

  const abi = [
      "function aggregate((address target, bytes callData)[] calls) payable returns (uint256 blockNumber, bytes[] returnData)",
      "function aggregate3((address target, bool allowFailure, bytes callData)[] calls) payable returns ((bool success, bytes returnData)[] returnData)",
      "function aggregate3Value((address target, bool allowFailure, uint256 value, bytes callData)[] calls) payable returns ((bool success, bytes returnData)[] returnData)",
      "function blockAndAggregate((address target, bytes callData)[] calls) payable returns (uint256 blockNumber, bytes32 blockHash, (bool success, bytes returnData)[] returnData)",
      "function getBasefee() view returns (uint256 basefee)",
      "function getBlockHash(uint256 blockNumber) view returns (bytes32 blockHash)",
      "function getBlockNumber() view returns (uint256 blockNumber)",
      "function getChainId() view returns (uint256 chainid)",
      "function getCurrentBlockCoinbase() view returns (address coinbase)",
      "function getCurrentBlockDifficulty() view returns (uint256 difficulty)",
      "function getCurrentBlockGasLimit() view returns (uint256 gaslimit)",
      "function getCurrentBlockTimestamp() view returns (uint256 timestamp)",
      "function getEthBalance(address addr) view returns (uint256 balance)",
      "function getLastBlockHash() view returns (bytes32 blockHash)",
      "function tryAggregate(bool requireSuccess, (address target, bytes callData)[] calls) payable returns ((bool success, bytes returnData)[] returnData)",
      "function tryBlockAndAggregate(bool requireSuccess, (address target, bytes callData)[] calls) payable returns (uint256 blockNumber, bytes32 blockHash, (bool success, bytes returnData)[] returnData)"
  ];

[ra-sun-god]

I automatically generated it, the code I used is below:

const path = require("path")
const fg = require("fast-glob")
const fsp = require('fs/promises');
const { Interface: eInterface } = require("ethers")

const ABIsPath =  path.resolve(path.dirname(__dirname), "src/data/abi")
const optimizedABIPath =  path.resolve(path.dirname(__dirname), "src/data/abi_min")

const run = async () => {

    let dataArr = await fg(`${ABIsPath}/**/*.json`)

    console.log(`Optimizing ABI files in ${ABIsPath}`)

    for(let abiPath of dataArr){

        console.log()
        console.log(`Processing ABI File: ${abiPath}`)
        
        let abiData;
        try{ abiData = require(abiPath) } catch(e) { continue; }

        let filename = path.basename(abiPath)

        let fileSubDir = abiPath.replace(ABIsPath, "")

        let outPath = path.join(optimizedABIPath, fileSubDir)

        let outDir = path.dirname(outPath)

        await fsp.mkdir(outDir, { recursive: true })

        const iface = new eInterface(abiData)

        console.log()
        let minAbi = iface.format(false)

        console.log(`Saving Optimized ABI at ${outPath}`)

        await fsp.writeFile(outPath, JSON.stringify(minAbi))
        console.log()
    }
}

run()

[ricmoo]

Thanks!

I've added a fix to the current 6.9-WIP. If I can't get it out today I'll port it back to the latest 6.8 as a patch and get it out tonight.

[ricmoo]

This has been fixed in 6.9.0.

You will have to regenerate those ABIs in the latest version, but then all should be peachy. Please let me know if you have any more issues.

Thanks! :)