passing abi types to an object through a class

[glitch-txs]

Hi, I'm needing a little bit of help, I'm trying to use abitype in a class that creates a Contract object that has a function called write where I'm passing the name of the contract function as a string and the params.

type CallInfo<funcName> = {
    name: funcName;
    params: any[];
}

I'm trying to set abitype in the class constructor and trying to get the abi functions type in the write function argunments.

type CallInfo<funcName> = {
    name: funcName;
    params: any[];
}

export class InitContractTest {

  abi: unknown
  address: `0x${string}`
  chain: Chain
  contract: ethers.Contract

  constructor({address, abi, chain}: ContractInfo){
    this.abi = abi
    this.address = address
    this.chain = chain
    const rpcProvider = new ethers.providers.JsonRpcProvider(this.chain.rpcUrls[0])
    this.contract = new ethers.Contract(this.address, this.abi as ethers.ContractInterface, rpcProvider)
  }

  async write(callInfo: CallInfo<ExtractAbiFunctionNames<typeof this.abi, 'payable'>>, setStatus?: (status: string)=> void){
  
  //...call contract function
  }

I'm getting this error: Type 'unknown' does not satisfy the constraint 'Abi' when trying to extract the func names

[glitch-txs]

I got rid of the errors with this:

import { Abi, ExtractAbiFunctionNames } from 'abitype'

export type ContractInfo<ABI = any> = {
  address:`0x${string}`
  abi:ABI
  chain:Chain
}

export class InitContractTest<ABI extends Abi> {

  abi: ABI
  address: `0x${string}`
  chain: Chain
  contract: ethers.Contract

  constructor({address, abi, chain}: ContractInfo<ABI>){
    this.abi = abi
    this.address = address
    this.chain = chain
    const rpcProvider = new ethers.providers.JsonRpcProvider(this.chain.rpcUrls[0])
    this.contract = new ethers.Contract(this.address, this.abi as ethers.ContractInterface, rpcProvider)
  }

  async write(callInfo: CallInfo<ExtractAbiFunctionNames<typeof this.abi, 'payable'>>, setStatus?: (status: string)=> void){
  
  //...call contract function
  }

but I'm not getting autocomplete here:

import { abiERC20 } from './abiERC20'

  const newContract = new InitContractTest<typeof abiERC20>(contractInfo)

    const res = await newContract.read({
      name:'', // <-- no autocomplete here
      params:[]
    })

[Raiden1411]

You might also want to take a look at this

[glitch-txs]

hi, thanks for helping me, here I created a minimal reproduction example, I'm passing the abi as const as well
https://github.com/glitch-txs/minimal-repro

[glitch-txs]

btw in the readme of the repo ExtractAbiFunctions is imported but ExtractAbiFunctionNames is used (and not imported)

[Raiden1411]

The abi that you are using is missing the stateMutability property and that's why you are not getting that autocomplete. The abi that you are using seems like it's from a old solidity version where constants were used to represent the mutability of a contract. That property is now considered deprecated and it was replaced by the stateMutability.

Abitype stills supports the constants properties but the stateMutability must always be present on the abi. You can use the provided erc20Abi from abitype/test for a generic erc20 abi.

Made a pr on that repo to fix the problem.

[glitch-txs]

thanks a lot! <3