返回合约对象后无法调用智能合约方法问题排查

问题描述 #

尝试调用自定义智能合约方法时，编写了GetContract函数用于创建并返回合约实例：

• 函数内部可正常执行contract.methods.set("foo").encodeABI()
• 但主代码中调用返回的合约对象时，抛出如下错误：

const s = contract.methods.set("foo").encodeABI()
                           ^
TypeError: Cannot read properties of undefined (reading 'set')
    at Object.<anonymous>

主代码调用方式：

const GetContract = require('./Helpers/GetContract')

const contract = GetContract(web3, "Helloworld", process.env.HELLOWORLD_CONTRACT)
const s = contract.methods.set("foo").encodeABI()
console.log(s)

调试发现返回的合约对象_methods字段包含对应方法，但contract.methods返回undefined：

._methods: {
  get: [Function (anonymous)],
  'get()': [Function (anonymous)],
  '0x6d4ce63c': [Function (anonymous)],
  set: [Function (anonymous)],
  'set(string)': [Function (anonymous)],
  '0x4ed3885e': [Function (anonymous)]
}

原因分析 #

核心问题在于主代码中获取的contract并非预期的Web3合约实例，常见场景包括：

• GetContract是异步函数，但主代码未等待异步操作完成，直接获取了Promise对象而非合约实例
• GetContract函数内部遗漏了return语句，返回了默认的undefined
• 合约ABI加载过程出错，导致创建的合约实例不完整

解决方案 #

• 处理异步逻辑：如果GetContract函数中包含异步操作（比如读取本地编译后的合约JSON文件），必须将函数声明为async，并在主代码中用await获取结果：

  // GetContract.js示例（异步版本）
  const fs = require('fs/promises')
  
  async function GetContract(web3, contractName, contractAddress) {
    const contractJson = await fs.readFile(`./build/${contractName}.json`, 'utf8')
    const compiledContract = JSON.parse(contractJson)
    return new web3.eth.Contract(compiledContract.abi, contractAddress)
  }
  
  module.exports = GetContract
  

  主代码修改为：

  const GetContract = require('./Helpers/GetContract')
  
  async function main() {
    const contract = await GetContract(web3, "Helloworld", process.env.HELLOWORLD_CONTRACT)
    const s = contract.methods.set("foo").encodeABI()
    console.log(s)
  }
  
  main().catch(console.error)
  

• 检查返回语句：确认GetContract函数内部正确返回了合约实例，没有遗漏return关键字：

  // 同步版本示例（如果ABI是同步加载的）
  function GetContract(web3, contractName, contractAddress) {
    const compiledContract = require(`../build/${contractName}.json`)
    // 必须明确return合约实例
    return new web3.eth.Contract(compiledContract.abi, contractAddress)
  }
  

• 验证ABI正确性：确保加载的合约ABI是完整的，编译后的JSON文件中abi字段存在且格式正确，避免因ABI解析错误导致合约实例初始化异常。

内容的提问来源于stack exchange，提问作者Pranav Desai