🗽 Introduce TestProvider type (#733)

TrueFiEng · May 17, 2022 · 1e479c3 · 1e479c3
1 parent a39f6f7
commit 1e479c3
Show file tree

Hide file tree

Showing 26 changed files with 139 additions and 68 deletions.
diff --git a/.changeset/smooth-yaks-hammer.md b/.changeset/smooth-yaks-hammer.md
@@ -0,0 +1,5 @@
+---
+"@ethereum-waffle/provider": patch
+---
+
+Introduce TestProvider type
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/waffle-chai/src/matchers/changeEtherBalance.ts b/waffle-chai/src/matchers/changeEtherBalance.ts
@@ -1,3 +1,4 @@
+import type {TestProvider} from '@ethereum-waffle/provider';
 import {BigNumber, BigNumberish, providers} from 'ethers';
 import {callPromise} from '../call-promise';
 import {ensure} from './calledOnContract/utils';
@@ -59,7 +60,7 @@ export async function getBalanceChange(
     const gasPrice = txResponse.gasPrice ?? txReceipt.effectiveGasPrice;
     const gasUsed = txReceipt.gasUsed;
     const txFee = gasPrice.mul(gasUsed);
-    const provider = account.provider as any;
+    const provider = account.provider as TestProvider;
     if (typeof provider.getL1Fee === 'function') {
       const l1Fee = await provider.getL1Fee(txReceipt.transactionHash);
       return balanceAfter.add(txFee).add(l1Fee).sub(balanceBefore);

diff --git a/waffle-chai/src/matchers/changeEtherBalances.ts b/waffle-chai/src/matchers/changeEtherBalances.ts
@@ -1,3 +1,4 @@
+import type {TestProvider} from '@ethereum-waffle/provider';
 import {BigNumber, BigNumberish, providers} from 'ethers';
 import {callPromise} from '../call-promise';
 import {getAddressOf, Account} from './misc/account';
@@ -70,7 +71,7 @@ async function getTxFees(
         const gasPrice = txResponse.gasPrice ?? txReceipt.effectiveGasPrice;
         const gasUsed = txReceipt.gasUsed;
         const txFee = gasPrice.mul(gasUsed);
-        const provider = account.provider as any;
+        const provider = account.provider as TestProvider;
         if (typeof provider.getL1Fee === 'function') {
           const l1Fee = await provider.getL1Fee(txReceipt.transactionHash);
           return txFee.add(l1Fee);

diff --git a/waffle-chai/src/types.ts b/waffle-chai/src/types.ts
@@ -7,7 +7,7 @@
 declare namespace Chai {
   interface Assertion extends LanguageChains, NumericComparison, TypeComparison {
     reverted: AsyncAssertion;
-    revertedWith(reason: string): RevertedWithAssertion;
+    revertedWith(reason: string | RegExp): RevertedWithAssertion;
     emit(contract: any, eventName: string): EmitAssertion;
     properHex(length: number): void;
     hexEqual(other: string): void;

diff --git a/waffle-chai/test/matchers/chainingTest.ts b/waffle-chai/test/matchers/chainingTest.ts
@@ -3,9 +3,9 @@ import {Wallet, Contract, ContractFactory} from 'ethers';
 import {MOCK_TOKEN_ABI, MOCK_TOKEN_BYTECODE} from '../contracts/MockToken';
 import {COMPLEX_ABI, COMPLEX_BYTECODE} from '../contracts/Complex';
 
-import {MockProvider} from '@ethereum-waffle/provider';
+import type {TestProvider} from '@ethereum-waffle/provider';
 
-export const chainingMatchersTest = (provider: MockProvider) => {
+export const chainingMatchersTest = (provider: TestProvider) => {
   let sender: Wallet;
   let receiver: Wallet;
   let token: Contract;

diff --git a/waffle-chai/test/matchers/changeEtherBalanceTest.ts b/waffle-chai/test/matchers/changeEtherBalanceTest.ts
@@ -1,4 +1,4 @@
-import {MockProvider} from '@ethereum-waffle/provider';
+import type {TestProvider} from '@ethereum-waffle/provider';
 import {expect, AssertionError} from 'chai';
 import {BigNumber, Contract, Wallet} from 'ethers';
 
@@ -8,7 +8,7 @@ interface ChangeEtherBalanceTestOptions {
 }
 
 export const changeEtherBalanceTest = (
-  provider: MockProvider,
+  provider: TestProvider,
   options: ChangeEtherBalanceTestOptions
 ) => {
   let txGasFees: number;