How do I use names enums in a Contract method?

[bgits]

Describe the bug
When attempting to pass an enum to a function accepting an enum type parameter the following error is thrown:
Error: invalid type (argument="type", value="Test.fruit", code=INVALID_ARGUMENT, version=abi/5.5.0

Function being called: https://github.com/bgits/hardhat-enums/blob/main/contracts/Test.sol#L9

Failure point: https://github.com/bgits/hardhat-enums/blob/main/test/Test.ts#L9

Reproduction steps
A mock repo can be found here: https://github.com/bgits/hardhat-enums

test case can be run: npx hardhat test

Environment:

This is run as part of a hardhat development environment. Full project dependencies and configuration can be found in the example repo.

Search Terms
code=INVALID_ARGUMENT
invalid type

[ricmoo]

This isn’t something that is possible given the current ABI format. There is no way to know what value a given enum has, so it cannot be substituted in. I plan to add something to help with this to the human-readable ABI, but last I talked to Solidity about this, there was no plans to export that data.

So for enums you must pass the number of value. :s

[ricmoo]

The ABI does not include enough information to use named enums (I have requested this, but the solidity team does not plan to export that data). An enum should be a uint8 and it’s numeric value should be used.

In v6, there will (eventually) be a way in Human-Readable ABI to specify this though.

[bgits]

To summarize:

Hardhat is trying to use named enums? @alcuadrado

Ethers requires numeric enums to be passed in? @ricmoo

Until Solidity supports this in the ABI or v6 of ethers is released, the current viable solution is for hardhat to use numeric enums?

[alcuadrado]

I don't think this has anything to do with hardhat. Here's a reproduction script that only uses ethers

https://gist.github.com/alcuadrado/3c3e1c9f954b2ac38509e3f6fe8b1260

Note that that ABI has not been modified by hardhat. It was returned as is by solc.

[albertocevallos]

Hey @ricmoo

On a similar note, say you don't pass in an enum but pass in an interface like IERC20 or ISetToken as show here:

const abi = 'function issue(ISetToken _setToken, IERC20 _inputToken, uint256 _amount) external returns (uint256)'

Technically _setToken could be passed to an ethers Contract instance as a string since its just an address, but it looks like this throwing an error too.

[albertocevallos]

^ solved

[av1ctor]

I've exactly the same problem as op.

Can't pass enums as parameters to a library method, neither invoke a library method that returns an enum.

In the first case it returns INVALID_ARGUMENT when passing a uint8 value (hardhat + chai). In the second case it throws 'call revert exception' at Interface.decodeFunctionResult (node_modules@ethersproject\abi\src.ts\interface.ts:425:23).

[gabrielkrell]

Truffle+web3 are able to provide, e.g.

contract Withdraw  {
    ...
    enum WithdrawMode { Basic, Redeem, Settle }
}

const Withdraw = artifacts.require("Withdraw");
console.log(Withdraw.WithdrawMode.Basic); // 0

How are they doing it? Enums become significantly more brittle if you have to maintain a redundant {valueA: 0, valueB: 1, ...} mapping in your client code.