Update ethers.deployContract with DeployContractOptions (#853)

Co-authored-by: Dainis Gorbunovs <dgdev@protonmail.com>
dethcrypto · Jul 17, 2023 · c2b3f1b · c2b3f1b
1 parent 33879dc
commit c2b3f1b
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 37 deletions.
diff --git a/.changeset/cuddly-ghosts-drum.md b/.changeset/cuddly-ghosts-drum.md
@@ -0,0 +1,6 @@
+---
+'@typechain/hardhat': patch
+'@typechain/ethers-v6': patch
+---
+
+Support for the newest hardhat-ethers version
diff --git a/examples/hardhat/package.json b/examples/hardhat/package.json
@@ -11,7 +11,7 @@
     "typecheck": "pnpm compile && pnpm test && pnpm tsc --noEmit"
   },
   "devDependencies": {
-    "@nomicfoundation/hardhat-ethers": "^3.0.0",
+    "@nomicfoundation/hardhat-ethers": "^3.0.4",
     "@nomicfoundation/hardhat-chai-matchers": "^2.0.0",
     "@typechain/ethers-v6": "workspace:^0.4.0",
     "@typechain/hardhat": "workspace:^8.0.0",

diff --git a/examples/hardhat/test/counter.ts b/examples/hardhat/test/counter.ts
@@ -2,6 +2,7 @@ import chai from 'chai'
 import chaiAsPromised from 'chai-as-promised'
 import { solidity } from 'ethereum-waffle'
 import { ethers } from 'hardhat'
+import { DeployContractOptions } from '@nomicfoundation/hardhat-ethers/types'
 
 import type { Counter } from '../typechain-types'
 
@@ -17,13 +18,15 @@ describe('Counter', () => {
     const signers = await ethers.getSigners()
 
     // 2
-    counter = await ethers.deployContract('Counter')
-
+    const gasPrice = 1637083528
+    const options: DeployContractOptions = { gasPrice }
+    counter = await ethers.deployContract('Counter', options)
     const initialCount = await counter.getCount()
 
     // 3
     expect(initialCount).to.eq(0)
     expect(await counter.getAddress()).to.properAddress
+    expect(counter.deploymentTransaction()?.gasPrice).to.eq(gasPrice)
   })
 
   // 4

diff --git a/packages/hardhat-test/typechain-types/hardhat.d.ts b/packages/hardhat-test/typechain-types/hardhat.d.ts
@@ -4,6 +4,7 @@
 
 import { ethers } from "ethers";
 import {
+  DeployContractOptions,
   FactoryOptions,
   HardhatEthersHelpers as HardhatEthersHelpersBase,
 } from "@nomicfoundation/hardhat-ethers/types";
@@ -52,40 +53,40 @@ declare module "hardhat/types/runtime" {
 
     deployContract(
       name: "Counter",
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.Counter>;
     deployContract(
       name: "Demo",
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.Demo>;
     deployContract(
       name: "Hello",
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.Hello>;
     deployContract(
       name: "StructsInConstructor",
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.StructsInConstructor>;
 
     deployContract(
       name: "Counter",
       args: any[],
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.Counter>;
     deployContract(
       name: "Demo",
       args: any[],
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.Demo>;
     deployContract(
       name: "Hello",
       args: any[],
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.Hello>;
     deployContract(
       name: "StructsInConstructor",
       args: any[],
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.StructsInConstructor>;
 
     // default types
@@ -105,12 +106,12 @@ declare module "hardhat/types/runtime" {
     ): Promise<ethers.Contract>;
     deployContract(
       name: string,
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<ethers.Contract>;
     deployContract(
       name: string,
       args: any[],
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<ethers.Contract>;
   }
 }
diff --git a/packages/hardhat/test/fixture-projects/hardhat-project/typechain-types/hardhat.d.ts b/packages/hardhat/test/fixture-projects/hardhat-project/typechain-types/hardhat.d.ts
@@ -4,6 +4,7 @@
 
 import { ethers } from "ethers";
 import {
+  DeployContractOptions,
   FactoryOptions,
   HardhatEthersHelpers as HardhatEthersHelpersBase,
 } from "@nomicfoundation/hardhat-ethers/types";
@@ -61,49 +62,49 @@ declare module "hardhat/types/runtime" {
 
     deployContract(
       name: "EdgeCases",
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.EdgeCases>;
     deployContract(
       name: "SafeMath",
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.SafeMath>;
     deployContract(
       name: "TestContract",
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.TestContract>;
     deployContract(
       name: "TestContract1",
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.TestContract1>;
     deployContract(
       name: "ERC20",
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.ERC20>;
 
     deployContract(
       name: "EdgeCases",
       args: any[],
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.EdgeCases>;
     deployContract(
       name: "SafeMath",
       args: any[],
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.SafeMath>;
     deployContract(
       name: "TestContract",
       args: any[],
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.TestContract>;
     deployContract(
       name: "TestContract1",
       args: any[],
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.TestContract1>;
     deployContract(
       name: "ERC20",
       args: any[],
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<Contracts.ERC20>;
 
     // default types
@@ -123,12 +124,12 @@ declare module "hardhat/types/runtime" {
     ): Promise<ethers.Contract>;
     deployContract(
       name: string,
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<ethers.Contract>;
     deployContract(
       name: string,
       args: any[],
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<ethers.Contract>;
   }
 }
diff --git a/packages/target-ethers-v6/src/codegen/hardhat.ts b/packages/target-ethers-v6/src/codegen/hardhat.ts
@@ -5,7 +5,7 @@ export function generateHardhatHelper(contracts: string[]): string {
   return `
 
 import { ethers } from 'ethers'
-import { FactoryOptions, HardhatEthersHelpers as HardhatEthersHelpersBase} from "@nomicfoundation/hardhat-ethers/types";
+import { DeployContractOptions, FactoryOptions, HardhatEthersHelpers as HardhatEthersHelpersBase} from "@nomicfoundation/hardhat-ethers/types";
 
 import * as Contracts from "."
 
@@ -29,14 +29,15 @@ declare module "hardhat/types/runtime" {
 
   ${contracts
     .map(
-      (n) => `deployContract(name: '${n}', signerOrOptions?: ethers.Signer | FactoryOptions): Promise<Contracts.${n}>`,
+      (n) =>
+        `deployContract(name: '${n}', signerOrOptions?: ethers.Signer | DeployContractOptions): Promise<Contracts.${n}>`,
     )
     .join('\n')}
 
   ${contracts
     .map(
       (n) =>
-        `deployContract(name: '${n}', args: any[], signerOrOptions?: ethers.Signer | FactoryOptions): Promise<Contracts.${n}>`,
+        `deployContract(name: '${n}', args: any[], signerOrOptions?: ethers.Signer | DeployContractOptions): Promise<Contracts.${n}>`,
     )
     .join('\n')}
 
@@ -57,12 +58,12 @@ declare module "hardhat/types/runtime" {
     ): Promise<ethers.Contract>;
     deployContract(
       name: string,
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<ethers.Contract>;
     deployContract(
       name: string,
       args: any[],
-      signerOrOptions?: ethers.Signer | FactoryOptions
+      signerOrOptions?: ethers.Signer | DeployContractOptions
     ): Promise<ethers.Contract>;
   }
 }

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml