🛶 Updates for hardhat v2.11 (#795)

Author: rzadp

.changeset/ten-turtles-brake.md

@@ -0,0 +1,5 @@
+---
+"@ethereum-waffle/chai": patch
+---
+
+🛶 Updates for hardhat v2.11

.github/workflows/CI.yml

@@ -65,8 +65,8 @@ jobs:
       - name: Install latest versions of hardhat packages
         run: |
           pnpm add hardhat@2.11.2
-          pnpm add -D @nomiclabs/hardhat-waffle@2.1.1
-          pnpm add -D @nomiclabs/hardhat-ethers@2.0.3
+          pnpm add -D @nomiclabs/hardhat-waffle@2.0.3
+          pnpm add -D @nomiclabs/hardhat-ethers@2.1.1
         working-directory: waffle-hardhat
       - run: pnpm run test
         working-directory: waffle-hardhat

waffle-chai/src/inject-call-history.ts

@@ -44,30 +44,14 @@ const inject = () => {
   waffle.provider._hardhatNetwork.provider._wrapped._wrapped._wrapped._init = async function () {
     await init.apply(this);
     if (typeof beforeMessageListener === 'function') {
-    // has to be here because of weird behaviour of init function, which requires us to re-register the handler.
-      waffle.provider
-        ?._hardhatNetwork
-        ?.provider
-        ?._wrapped
-        ?._wrapped
-        ?._wrapped
-        ?._node
-        ?._vmTracer
-        ?._vm
-        ?.off?.('beforeMessage', beforeMessageListener);
+      // has to be here because of weird behaviour of init function, which requires us to re-register the handler.
+      getHardhatVMEventEmitter(waffle)?.off?.('beforeMessage', beforeMessageListener);
     }
     beforeMessageListener = (message: any) => {
       callHistory.addUniqueCall(toRecordedCall(message));
     };
     waffle.provider.callHistory = callHistory.recordedCalls;
-    waffle.provider
-      ?._hardhatNetwork.provider
-      ?._wrapped._wrapped
-      ?._wrapped
-      ?._node
-      ?._vmTracer
-      ?._vm
-      ?.on?.('beforeMessage', beforeMessageListener);
+    getHardhatVMEventEmitter(waffle)?.on?.('beforeMessage', beforeMessageListener);
   };
 };
 
@@ -76,3 +60,19 @@ if (!injected && !!process.env.WAFFLE_EXPERIMENTAL_HARDHAT_CALL_HISTORY) {
   injected = true;
   inject();
 }
+
+function getHardhatVMEventEmitter(waffle: any) {
+  const vm = waffle.provider
+    ?._hardhatNetwork.provider
+    ?._wrapped._wrapped
+    ?._wrapped
+    ?._node
+    ?._vmTracer
+    ?._vm;
+
+  /**
+   * There were changes related to the location of event emitter introduced
+   * in Hardhat version 2.11.0.
+   */
+  return vm?.evm?.events ?? vm;
+}

waffle-chai/test/matchers/revertedWithTest.ts

@@ -86,14 +86,42 @@ export const revertedWithTest = (provider: TestProvider, options: RevertedWithTe
   });
 
   it('Throw with modification: success', async () => {
-    await expect(matchers.doThrowAndModify()).to.be.revertedWith('');
+    let oneOrTheOtherRejected = false;
+    // Both are OK, exact output depends on installed version of Hardhat.
+    try {
+      await expect(matchers.doThrowAndModify()).to.be.revertedWith('');
+    } catch {
+      oneOrTheOtherRejected = !oneOrTheOtherRejected;
+    }
+    try {
+      await expect(matchers.doThrowAndModify()).to.be.revertedWith('panic code 0x1');
+    } catch {
+      oneOrTheOtherRejected = !oneOrTheOtherRejected;
+    }
+    expect(oneOrTheOtherRejected).to.be.true;
   });
 
   it('Throw with modification: success, properly handle common substring', async () => {
     // https://github.com/NomicFoundation/hardhat/issues/2234#issuecomment-1045974424
-    await expect(
-      expect(matchers.doThrowAndModify()).to.be.revertedWith('fa')
-    ).to.eventually.be.rejectedWith('Expected transaction to be reverted with "fa", but other reason was found: ""');
+    let oneOrTheOtherRejected = false;
+    // Both are OK, exact output depends on installed version of Hardhat.
+    try {
+      await expect(
+        expect(matchers.doThrowAndModify()).to.be.revertedWith('fa')
+      ).to.eventually.be.rejectedWith('Expected transaction to be reverted with "fa", but other reason was found: ""');
+    } catch {
+      oneOrTheOtherRejected = !oneOrTheOtherRejected;
+    }
+    try {
+      await expect(
+        expect(matchers.doThrowAndModify()).to.be.revertedWith('fa')
+      ).to.eventually.be.rejectedWith(
+        'Expected transaction to be reverted with "fa", but other reason was found: "panic code 0x1"'
+      );
+    } catch {
+      oneOrTheOtherRejected = !oneOrTheOtherRejected;
+    }
+    expect(oneOrTheOtherRejected).to.be.true;
   });
 
   it('Throw with modification: fail when message is expected', async () => {