JavaScript Hardhat – Solving ‘Property revertedWith Does Not Exist on Type Assertion’ Error

chaihardhatjavascriptmochawaffle

I'm running a test using waffle in hardhat.

import { assert, expect } from "chai"
.
.
.

  it("can only be changed through governance", async () => {
    await expect(box.store(55)).to.be.revertedWith("Nope, you bad")
  })

However when I run tests, I run into:

test/unit/testflow.test.ts:31:39 - error TS2339: Property 'revertedWith' does not exist on type 'Assertion'.

I have the package imported in my hardhat.config.ts

import "@nomiclabs/hardhat-waffle"

And I have the package installed:

package.json

    "@nomiclabs/hardhat-waffle": "^2.0.2",

What am I missing?

Best Answer

Pre June 2022

You need to also add ethereum-waffle to your package, not just the nomiclabs one @nomiclabs/hardhat-waffle. you need both

yarn add --dev ethereum-waffle

you just only need to install it, other than that in the hardhat.config.js file this will not be "require" or "import". menas in hardhat.config.js only this will be imported

require("@nomiclabs/hardhat-waffle")

Post Just 2022

Hardhat has released a new package named hardhat-toolbox to replace hardhat-waffle.

Install it with npm install --save-dev @nomicfoundation/hardhat-toolbox or yarn add --dev @nomicfoundation/hardhat-toolbox and then import it in your hardhat.config.js like this:

require('@nomicfoundation/hardhat-toolbox')

/** @type import('hardhat/config').HardhatUserConfig */
module.exports = {
  solidity: '0.8.9',
  paths: {  },
  networks: {  },
}

Once done, you'll be able to use revertWith like this:

 it('my contract reverting', async () => {
    await expect(myContract.method()).to.be.revertedWith(
      'My revert error message'
    )
  })

Related Solutions

[Ethereum] Property ‘getContractFactory’ does not exist on type

ethers.getContractFactory is a one of the helpers that Hardhat added to the ethers object so you need to call hre first.

https://hardhat.org/plugins/nomiclabs-hardhat-ethers.html#helpers

Notice getContractFactory doesn't exist in the Ethers.js docs:

https://docs.ethers.io/v4/search.html?q=getContractFactory&check_keywords=yes&area=default#

Hardhat – Property ‘revertedWithCustomError’ Not Existing on Type ‘Assertion’

Ok I resolved this. The documentation in both their website and in the post I reference are off.

I created a new typescript project using npx hardhat and realized they import ethers through hardhat-chai-matchers. So I made these changes and my tests pass now:

// const ethers = require("ethers"); //Removed
import { loadFixture } from "@nomicfoundation/hardhat-network-helpers";
import "@nomicfoundation/hardhat-chai-matchers"; //Added for revertWithCustomErrors
import { expect } from "chai";
import { BigNumber, constants } from "ethers";
import hre from "hardhat";

// within test code using hre.ethers
await expect(marketplace.connect(USER).listNFT(
    marketplace.address, 
    hre.ethers.utils.parseEther("1"), 
    { value: listingFee}
)).to.be.revertedWithCustomError(marketplace, "UnsupportedNftInterface");

Alternatively I found you can do this import without hre like below though I am unsure of the correctness:

import { ethers } from "hardhat";

// within test code using ethers
await expect(marketplace.connect(USER).listNFT(
    marketplace.address, 
    ethers.utils.parseEther("1"), 
    { value: listingFee}
)).to.be.revertedWithCustomError(marketplace, "UnsupportedNftInterface");