Add MockProviderLike (#184)

TrueFiEng · Feb 5, 2020 · 0f221ae · 0f221ae
1 parent eb7ccb1
commit 0f221ae
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 4 deletions.
diff --git a/docs/release-notes/2.3.2.md b/docs/release-notes/2.3.2.md
@@ -0,0 +1,2 @@
+Changes:
+* Introduce `MockProviderLike` interface that enables third party providers to use the legacy `getWallets` api.
diff --git a/waffle-cli/package.json b/waffle-cli/package.json
@@ -1,7 +1,7 @@
 {
   "name": "ethereum-waffle",
   "description": "Sweeter, faster and simpler than truffle.",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "author": "Marek Kirejczyk <[email protected]> (http://ethworks.io)",
   "repository": "[email protected]:EthWorks/Waffle.git",
   "private": false,
@@ -42,7 +42,7 @@
     "node": ">=10.0"
   },
   "dependencies": {
-    "@ethereum-waffle/provider": "^2.3.1",
+    "@ethereum-waffle/provider": "^2.3.2",
     "@ethereum-waffle/chai": "^2.3.0",
     "@ethereum-waffle/compiler": "^2.3.0",
     "ethers": "^4.0.0"

diff --git a/waffle-provider/package.json b/waffle-provider/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@ethereum-waffle/provider",
   "description": "A mock provider for your blockchain testing needs.",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "author": "Marek Kirejczyk <[email protected]> (http://ethworks.io)",
   "repository": "[email protected]:EthWorks/Waffle.git",
   "private": false,

diff --git a/waffle-provider/src/legacyApi.ts b/waffle-provider/src/legacyApi.ts
@@ -1,4 +1,5 @@
 import Ganache from 'ganache-core';
+import {providers, Wallet} from 'ethers';
 import {MockProvider} from './MockProvider';
 import {deprecate} from './deprecate';
 
@@ -22,10 +23,19 @@ export function getGanacheOptions(ganacheOptionsOrPathToConfig: string | Ganache
   return require(ganacheOptionsOrPathToConfig).ganacheOptions;
 }
 
+/**
+ * Enables third party providers to use the legacy `getWallets` api.
+ * @deprecated
+ */
+export interface MockProviderLike extends providers.Provider {
+  getWallets(): Wallet[];
+  createEmptyWallet(): Wallet;
+}
+
 /**
  * @deprecated Use `mockProvider.getWallets()`
  */
-export function getWallets(provider: MockProvider) {
+export function getWallets(provider: MockProviderLike) {
   deprecate('getWallets', 'Use "mockProvider.getWallets()" instead.');
   return provider.getWallets();
 }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Changes:
		* Introduce `MockProviderLike` interface that enables third party providers to use the legacy `getWallets` api.