Refactor hardhat-ethers.

Add a types module that defines the interface for additional Hardhat
fields.
Separate out compilation projects for the plugin and its tests.

packages/hardhat-ethers/.gitignore

@@ -4,6 +4,8 @@
 # Compilation output
 /build-test/
 /dist
+/plugin
+/types
 
 # Code coverage artifacts
 /coverage

packages/hardhat-ethers/package.json

@@ -6,8 +6,8 @@
   "repository": "github:nomiclabs/hardhat",
   "author": "Nomic Labs LLC",
   "license": "MIT",
-  "main": "dist/src/index.js",
-  "types": "dist/src/index.d.ts",
+  "main": "plugin/index.js",
+  "types": "plugin/index.d.ts",
   "keywords": [
     "ethereum",
     "smart-contracts",
@@ -17,14 +17,19 @@
   ],
   "scripts": {
     "lint:fix": "node ../../node_modules/prettier/bin-prettier.js --write \"src/**/*.{js,ts}\" \"test/**/*.{js,ts}\" && yarn lint --fix",
-    "lint": "node ../../node_modules/tslint/bin/tslint --config tslint.json --project ./tsconfig.json",
+    "lint": "yarn lint-src && yarn lint-tests",
+    "lint-tests": "node -r ts-node/register/transpile-only ../../node_modules/tslint/bin/tslint --config tslint.json --project ./tsconfig.json",
+    "lint-src": "node -r ts-node/register/transpile-only ../../node_modules/tslint/bin/tslint --config tslint.json --project ./src/tsconfig.json",
     "test": "node ../../node_modules/mocha/bin/mocha --recursive \"test/**/*.ts\" --exit",
-    "build": "node ../../node_modules/typescript/bin/tsc --build .",
-    "clean": "node ../../node_modules/rimraf/bin.js dist"
+    "build": "node ../../node_modules/typescript/bin/tsc --build src",
+    "build-test": "node ../../node_modules/typescript/bin/tsc --build .",
+    "clean": "node ../../node_modules/rimraf/bin.js dist plugin types build-test tsconfig.tsbuildinfo"
   },
   "files": [
     "dist/src/",
     "src/",
+    "plugin/",
+    "types/",
     "LICENSE",
     "README.md"
   ],

packages/hardhat-ethers/src/dist/src/ethers-provider-wrapper.ts

@@ -0,0 +1 @@
+export * from "../../plugin/ethers-provider-wrapper";

packages/hardhat-ethers/src/dist/src/helpers.ts

@@ -0,0 +1 @@
+export * from "../../plugin/helpers";

packages/hardhat-ethers/src/dist/src/index.ts

@@ -0,0 +1 @@
+import "../../plugin/index";

packages/hardhat-ethers/src/dist/src/provider-proxy.ts

@@ -0,0 +1 @@
+export * from "../../plugin/provider-proxy";

packages/hardhat-ethers/src/dist/src/signer-with-address.ts

@@ -0,0 +1 @@
+export * from "../../plugin/signer-with-address";

packages/hardhat-ethers/src/dist/src/type-extensions.ts

@@ -0,0 +1 @@
+import "../../plugin/type-extensions";

packages/hardhat-ethers/src/dist/src/updatable-target-proxy.ts

@@ -0,0 +1 @@
+export * from "../../plugin/updatable-target-proxy";

packages/hardhat-ethers/src/helpers.ts → packages/hardhat-ethers/src/plugin/helpers.ts

@@ -6,6 +6,8 @@ import {
   NetworkConfig,
 } from "hardhat/types";
 
+import type { FactoryOptions, Libraries } from "../types";
+
 import type { SignerWithAddress } from "./signer-with-address";
 
 interface Link {
@@ -14,15 +16,6 @@ interface Link {
   address: string;
 }
 
-export interface Libraries {
-  [libraryName: string]: string;
-}
-
-export interface FactoryOptions {
-  signer?: ethers.Signer;
-  libraries?: Libraries;
-}
-
 const pluginName = "hardhat-ethers";
 
 export async function getSigners(

packages/hardhat-ethers/src/plugin/type-extensions.ts

@@ -0,0 +1,23 @@
+import * as ethers from "ethers";
+import "hardhat/types/runtime";
+
+import type {
+  FactoryOptions as FactoryOptionsT,
+  getContractFactory as getContractFactoryT,
+  HardhatEthers,
+  Libraries as LibrariesT,
+} from "../types";
+
+declare module "hardhat/types/runtime" {
+  // Beware, adding new types to any hardhat type submodule is not a good practice in a Hardhat plugin.
+  // Doing so increases the risk of a type clash with another plugin.
+  type Libraries = LibrariesT;
+  type FactoryOptions = FactoryOptionsT;
+  // tslint:disable-next-line: naming-convention
+  type getContractFactory = typeof getContractFactoryT;
+
+  interface HardhatRuntimeEnvironment {
+    // We omit the ethers field because it is redundant.
+    ethers: Omit<typeof ethers, "ethers"> & HardhatEthers;
+  }
+}

packages/hardhat-ethers/src/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../../config/typescript/tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../",
+    "rootDirs": ["."],
+    "composite": true
+  },
+  "include": ["./**/*.ts"],
+  "exclude": []
+}

packages/hardhat-ethers/src/types/index.ts

@@ -0,0 +1,34 @@
+import type * as ethers from "ethers";
+
+import type { SignerWithAddress } from "../plugin/signer-with-address";
+
+export interface Libraries {
+  [libraryName: string]: string;
+}
+
+export interface FactoryOptions {
+  signer?: ethers.Signer;
+  libraries?: Libraries;
+}
+
+export declare function getContractFactory(
+  name: string,
+  signerOrOptions?: ethers.Signer | FactoryOptions
+): Promise<ethers.ContractFactory>;
+export declare function getContractFactory(
+  abi: any[],
+  bytecode: ethers.utils.BytesLike,
+  signer?: ethers.Signer
+): Promise<ethers.ContractFactory>;
+
+export interface HardhatEthers {
+  provider: ethers.providers.JsonRpcProvider;
+
+  getContractFactory: typeof getContractFactory;
+  getContractAt: (
+    nameOrAbi: string | any[],
+    address: string,
+    signer?: ethers.Signer
+  ) => Promise<ethers.Contract>;
+  getSigners: () => Promise<SignerWithAddress[]>;
+}

packages/hardhat-ethers/test/ethers-provider-wrapper.ts

@@ -1,7 +1,7 @@
 import { assert } from "chai";
 import { ethers } from "ethers";
 
-import { EthersProviderWrapper } from "../src/ethers-provider-wrapper";
+import { EthersProviderWrapper } from "../src/plugin/ethers-provider-wrapper";
 
 import { useEnvironment } from "./helpers";
 

packages/hardhat-ethers/test/fixture-projects/hardhat-project/hardhat.config.js

@@ -1,4 +1,4 @@
-require("../../../src/index");
+require("../../../src/plugin/index");
 
 module.exports = {
   solidity: "0.5.15",

packages/hardhat-ethers/test/helpers.ts

@@ -2,6 +2,9 @@ import { resetHardhatContext } from "hardhat/plugins-testing";
 import { HardhatRuntimeEnvironment } from "hardhat/types";
 import path from "path";
 
+// Import this plugin type extensions for the HardhatRuntimeEnvironment
+import type {} from "../src/plugin/index";
+
 declare module "mocha" {
   interface Context {
     env: HardhatRuntimeEnvironment;

packages/hardhat-ethers/test/updatable-target-proxy.ts

@@ -1,6 +1,6 @@
 import { assert } from "chai";
 
-import { createUpdatableTargetProxy } from "../src/updatable-target-proxy";
+import { createUpdatableTargetProxy } from "../src/plugin/updatable-target-proxy";
 
 describe("updatable target proxy", function () {
   it("should proxy properties", function () {

packages/hardhat-ethers/tsconfig.json

@@ -1,13 +1,15 @@
 {
   "extends": "../../config/typescript/tsconfig.json",
   "compilerOptions": {
-    "outDir": "./dist",
+    "outDir": "./build-test",
+    "rootDirs": ["./test"],
     "composite": true
   },
-  "exclude": ["./dist", "./node_modules", "./test/**/hardhat.config.ts"],
+  "include": ["./test/**/*.ts"],
+  "exclude": ["./node_modules", "./test/**/hardhat.config.ts"],
   "references": [
     {
-      "path": "../hardhat-core/src"
+      "path": "./src"
     }
   ]
 }