🧢 Decode error string presented in newer versions of hardhat (#763)

Author: rzadp

.changeset/shy-nails-design.md

@@ -0,0 +1,7 @@
+---
+"@ethereum-waffle/chai": patch
+"@ethereum-waffle/hardhat": patch
+"@ethereum-waffle/provider": patch
+---
+
+Decode revert string in hardhat 2.9.4+

.github/workflows/CI.yml

@@ -28,6 +28,48 @@ jobs:
         run: sudo cp ./.github/workflows/solc /bin
       - run: pnpm run build
       - run: pnpm run test
+  test-hardhat-pre-244:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16.x
+      - run: npm i -g pnpm@7.1.9
+      - run: pnpm install --frozen-lockfile --strict-peer-dependencies
+      - name: setup-solc
+        run: sudo cp ./.github/workflows/solc /bin
+      - run: pnpm run build
+      - name: Install versions of hardhat packages pre 2.4.4
+        run: |
+          pnpm add hardhat@2.9.2
+          pnpm add -D @nomiclabs/hardhat-waffle@2.0.3
+          pnpm add -D @nomiclabs/hardhat-ethers@2.0.3
+        working-directory: waffle-hardhat
+      - run: pnpm run test
+        working-directory: waffle-hardhat
+  test-hardhat-latest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16.x
+      - run: npm i -g pnpm@7.1.9
+      - run: pnpm install --frozen-lockfile --strict-peer-dependencies
+      - name: setup-solc
+        run: sudo cp ./.github/workflows/solc /bin
+      - run: pnpm run build
+      - name: Install latest versions of hardhat packages
+        run: |
+          pnpm add hardhat@latest
+          pnpm add -D @nomiclabs/hardhat-waffle@latest
+          pnpm add -D @nomiclabs/hardhat-ethers@latest
+        working-directory: waffle-hardhat
+      - run: pnpm run test
+        working-directory: waffle-hardhat
   docs-and-linter:
     runs-on: ubuntu-latest
     env:

pnpm-lock.yaml

@@ -43,6 +43,22 @@ export function supportRevertedWith(Assertion: Chai.AssertionStatic) {
 
 const decodeHardhatError = (error: any, context: any) => {
   const tryDecode = (error: any) => {
+    if (
+      error?.errorName &&
+      /**
+       * Preserve old behaviour for non-custom errors,
+       * because if the case of regular errors,
+       * with revertedWith we match against the argument of error (single string),
+       * not against the error name like in the case of custom errors - because it is always just Error.
+       * We don't want to require the user to do `expect(tx).to.be.revertedWith('Error').withArgs('Require cause')`.
+       */
+      error?.errorName !== 'Error' &&
+      error.errorArgs
+    ) {
+      context.args = [error.errorArgs];
+      context.txErrorName = error.errorName;
+      return error.errorName;
+    }
     const errorString = String(error);
     {
       const regexp = /VM Exception while processing transaction: reverted with custom error '([a-zA-Z0-9]+)\((.*)\)'/g;
@@ -69,6 +85,14 @@ const decodeHardhatError = (error: any, context: any) => {
         return matches[1];
       }
     }
+    {
+      const regexp = new RegExp('reverted with reason string "(.*?)"');
+
+      const matches = regexp.exec(errorString);
+      if (matches && matches.length >= 1) {
+        return matches[1];
+      }
+    }
     return undefined;
   };
 

waffle-chai/src/matchers/revertedWith.ts

@@ -1,5 +1,5 @@
 import {expect} from 'chai';
-import {Wallet, Contract, ContractFactory} from 'ethers';
+import {Wallet, Contract, ContractFactory, BigNumber} from 'ethers';
 import {MATCHERS_ABI, MATCHERS_BYTECODE} from '../contracts/Matchers';
 
 import type {TestProvider} from '@ethereum-waffle/provider';
@@ -34,7 +34,17 @@ export const revertedWithTest = (provider: TestProvider, options: RevertedWithTe
   });
 
   it('Throw: success', async () => {
-    await expect(matchers.doThrow()).to.be.revertedWith('');
+    let oneOrTheOtherPassing = false;
+    // Both are OK, exact output depends on installed version of Hardhat.
+    try {
+      await expect(matchers.doThrow()).to.be.revertedWith('');
+      oneOrTheOtherPassing = !oneOrTheOtherPassing;
+    } catch {}
+    try {
+      await expect(matchers.doThrow()).to.be.revertedWith('Panic');
+      oneOrTheOtherPassing = !oneOrTheOtherPassing;
+    } catch (e) {}
+    expect(oneOrTheOtherPassing).to.be.true;
   });
 
   it('Throw: fail when message is expected', async () => {
@@ -164,9 +174,19 @@ export const revertedWithTest = (provider: TestProvider, options: RevertedWithTe
   });
 
   it('Not to revert: fail', async () => {
-    await expect(
-      expect(matchers.doThrow()).not.to.be.revertedWith('')
-    ).to.be.eventually.rejected;
+    let oneOrTheOtherRejected = false;
+    // Both are OK, exact output depends on installed version of Hardhat.
+    try {
+      await expect(matchers.doThrow()).not.to.be.revertedWith('');
+    } catch {
+      oneOrTheOtherRejected = !oneOrTheOtherRejected;
+    }
+    try {
+      await expect(matchers.doThrow()).not.to.be.revertedWith('Panic');
+    } catch {
+      oneOrTheOtherRejected = !oneOrTheOtherRejected;
+    }
+    expect(oneOrTheOtherRejected).to.be.true;
   });
 
   it('Revert: fail when same message was thrown', async () => {
@@ -189,7 +209,17 @@ export const revertedWithTest = (provider: TestProvider, options: RevertedWithTe
 
   if (panicCodes) {
     it('Handle panic error', async () => {
-      await expect(matchers.doPanic()).to.be.revertedWith('panic code 0x12');
+      let oneOrTheOtherPassing = false;
+      // Both are OK, exact output depends on installed version of Hardhat.
+      try {
+        await expect(matchers.doPanic()).to.be.revertedWith('panic code 0x12');
+        oneOrTheOtherPassing = !oneOrTheOtherPassing;
+      } catch {}
+      try {
+        await expect(matchers.doPanic()).to.be.revertedWith('Panic').withArgs(BigNumber.from('0x12'));
+        oneOrTheOtherPassing = !oneOrTheOtherPassing;
+      } catch (e) {}
+      expect(oneOrTheOtherPassing).to.be.true;
     });
   }
 };

waffle-chai/test/matchers/revertedWithTest.ts

@@ -20,12 +20,12 @@
   },
   "dependencies": {
     "ethers": "5.6.2",
-    "hardhat": "^2.9.2"
+    "hardhat": "2.10.1"
   },
   "devDependencies": {
     "@ethereum-waffle/chai": "workspace:*",
-    "@nomiclabs/hardhat-ethers": "^2.0.3",
-    "@nomiclabs/hardhat-waffle": "^2.0.3",
+    "@nomiclabs/hardhat-ethers": "2.1.0",
+    "@nomiclabs/hardhat-waffle": "2.0.3",
     "@types/node": "^17.0.41",
     "eslint": "^7.14.0",
     "ethereum-waffle": "workspace:*",

waffle-hardhat/package.json

@@ -69,7 +69,7 @@ describe('INTEGRATION: Matchers: revertedWith', () => {
           'message',
           '0x00cfbbaf7ddb3a1476767101c12a0162e241fbad2a0162e2410cfbbaf7162123'
         )
-      ).to.be.eventually.rejectedWith('expected 0 to equal 1');
+      ).to.be.eventually.rejectedWith(/Expected (")?0(")? to (be )?equal 1/i); // It may or may not have the quote marks
       await expect(expect(matchers.doRevertWithOne())
         .to.be.revertedWith('One')
         .withArgs(
@@ -116,7 +116,7 @@ describe('INTEGRATION: Matchers: revertedWith', () => {
             '0x00cfbbaf7ddb3a1476767101c12a0162e241fbad2a0162e2410cfbbaf7162124'
           ]
         )
-      ).to.be.eventually.rejectedWith('expected 3 to equal 4');
+      ).to.be.eventually.rejectedWith(/Expected (")?3(")? to (be )?equal 4/i); // It may or may not have the quote marks
       await expect(expect(matchers.doRevertWithTwo())
         .to.be.revertedWith('Two')
         .withArgs(