👷 Add script for supporting calledOnContract matcher in hardhat (#755)

TrueFiEng · Jul 13, 2022 · 3ac5546 · 3ac5546
1 parent 09dccac
commit 3ac5546
Show file tree

Hide file tree

Showing 8 changed files with 84 additions and 118 deletions.
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/waffle-hardhat/.mocharc.js b/waffle-hardhat/.mocharc.js
@@ -2,5 +2,6 @@ process.env.NODE_ENV = 'test'
 module.exports = {
   require: 'ts-node/register/transpile-only',
   timeout: 50000,
-  spec: 'test/**/*.test.{js,ts}'
+  spec: 'test/**/*.test.{js,ts}',
+  file: 'test/test-setup.ts'
 }
diff --git a/waffle-hardhat/package.json b/waffle-hardhat/package.json
@@ -18,15 +18,17 @@
   "engines": {
     "node": ">=10.0"
   },
+  "dependencies": {
+    "ethers": "5.6.2",
+    "hardhat": "^2.9.2"
+  },
   "devDependencies": {
     "@ethereum-waffle/chai": "workspace:*",
     "@nomiclabs/hardhat-ethers": "^2.0.3",
     "@nomiclabs/hardhat-waffle": "^2.0.3",
     "@types/node": "^17.0.41",
     "eslint": "^7.14.0",
     "ethereum-waffle": "workspace:*",
-    "ethers": "5.6.2",
-    "hardhat": "^2.9.2",
     "mocha": "^8.2.1"
   }
 }
diff --git a/waffle-hardhat/src/inject-call-history.ts b/waffle-hardhat/src/inject-call-history.ts
@@ -0,0 +1,62 @@
+import {waffle} from 'hardhat';
+import type {RecordedCall} from 'ethereum-waffle';
+import {utils} from 'ethers';
+
+class CallHistory {
+  recordedCalls: RecordedCall[] = [];
+
+  addUniqueCall(call: RecordedCall) {
+    if (!this.recordedCalls.find(c => c.address === call.address && c.data === call.data)) {
+      this.recordedCalls.push(call);
+    }
+  }
+
+  clearAll() {
+    this.recordedCalls = [];
+  }
+}
+
+function toRecordedCall(message: any): RecordedCall {
+  return {
+    address: message.to?.buf ? utils.getAddress(utils.hexlify(message.to.buf)) : undefined,
+    data: message.data ? utils.hexlify(message.data) : '0x'
+  };
+}
+
+const callHistory = new CallHistory();
+(waffle.provider as any).clearCallHistory = () => {
+  callHistory.clearAll();
+};
+
+let beforeMessageListener: (message: any) => void | undefined;
+
+const init = (waffle.provider as any)._hardhatNetwork.provider._wrapped._wrapped._wrapped._init;
+(waffle.provider as any)._hardhatNetwork.provider._wrapped._wrapped._wrapped._init = async function () {
+  await init.apply(this);
+  if (typeof beforeMessageListener === 'function') {
+    // hast to be here because of weird behaviour of init function
+    (waffle.provider as any)
+      ._hardhatNetwork
+      .provider
+      ._wrapped
+      ._wrapped
+      ._wrapped
+      ._node
+      ._vmTracer
+      ._vm
+      .off('beforeMessage', beforeMessageListener);
+  }
+  beforeMessageListener = (message: any) => {
+    callHistory.addUniqueCall(toRecordedCall(message));
+  };
+  const provider: any = waffle.provider;
+  provider.callHistory = callHistory.recordedCalls;
+  (waffle.provider as any)
+    ._hardhatNetwork.provider
+    ._wrapped._wrapped
+    ._wrapped
+    ._node
+    ._vmTracer
+    ._vm
+    .on('beforeMessage', beforeMessageListener);
+};
diff --git a/waffle-hardhat/test/calledOnContract/calledOnContract.test.ts b/waffle-hardhat/test/calledOnContract/calledOnContract.test.ts
@@ -1,6 +1,6 @@
 import {waffle} from 'hardhat';
 import {MockProvider} from 'ethereum-waffle';
-// import {calledOnContractTest} from '@ethereum-waffle/chai/test';
+import {calledOnContractTest} from '@ethereum-waffle/chai/test';
 
 describe('INTEGRATION: calledOnContract', () => {
   const provider = waffle.provider as MockProvider;
@@ -9,5 +9,7 @@ describe('INTEGRATION: calledOnContract', () => {
     await provider.send('hardhat_reset', []);
   });
 
-  // calledOnContractTest(provider);
+  beforeEach(() => provider.clearCallHistory());
+
+  calledOnContractTest(provider);
 });
diff --git a/waffle-hardhat/test/calledOnContract/calledOnContractValidators.test.ts b/waffle-hardhat/test/calledOnContract/calledOnContractValidators.test.ts
@@ -1,6 +1,6 @@
 import {waffle} from 'hardhat';
 import {MockProvider} from 'ethereum-waffle';
-// import {calledOnContractValidatorsTest} from '@ethereum-waffle/chai/test';
+import {calledOnContractValidatorsTest} from '@ethereum-waffle/chai/test';
 
 describe('INTEGRATION: ethCalledValidators', () => {
   const provider = waffle.provider as MockProvider;
@@ -9,5 +9,7 @@ describe('INTEGRATION: ethCalledValidators', () => {
     await provider.send('hardhat_reset', []);
   });
 
-  // calledOnContractValidatorsTest(provider);
+  beforeEach(() => provider.clearCallHistory());
+
+  calledOnContractValidatorsTest(provider);
 });
diff --git a/waffle-hardhat/test/calledOnContract/calledOnContractWith.test.ts b/waffle-hardhat/test/calledOnContract/calledOnContractWith.test.ts
@@ -1,6 +1,6 @@
 import {waffle} from 'hardhat';
 import {MockProvider} from 'ethereum-waffle';
-// import {calledOnContractWithTest} from '@ethereum-waffle/chai/test';
+import {calledOnContractWithTest} from '@ethereum-waffle/chai/test';
 
 describe('INTEGRATION: calledOnContractWith', () => {
   const provider = waffle.provider as MockProvider;
@@ -9,5 +9,7 @@ describe('INTEGRATION: calledOnContractWith', () => {
     await provider.send('hardhat_reset', []);
   });
 
-  // calledOnContractWithTest(provider);
+  beforeEach(() => provider.clearCallHistory());
+
+  calledOnContractWithTest(provider);
 });
diff --git a/waffle-hardhat/test/test-setup.ts b/waffle-hardhat/test/test-setup.ts
@@ -0,0 +1 @@
+import '../src/inject-call-history';