feat: create a mocha/ethers template project #5806

kanej · 2024-10-04T17:04:34Z

As part of the Alpha prep this adds a mocha/ethers template project (used during hardhat --init), that tries to recreate the functionality (we are currently able to support`f of the v2 Ethers typescript project in v3.

It pulls in the v-next versions of the mocha test runner, the test helpers and hardhat-ethers.

It adds a the Lock.sol and Lock.ts test file. The test file has been modified to allow for running the tests while we still have rough edges.

Specifically the rough edges are:

we need to import plugin types to get the full connection type
we need new patterns for sharing connection among tests (I added a beforeEach)
we don't have chai matchers so I added chai-as-promised and adapted the tests, sometime crudely.

vercel · 2024-10-04T17:04:37Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
hardhat	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 28, 2024 11:06pm

changeset-bot · 2024-10-04T17:04:38Z

⚠️ No Changeset found

Latest commit: 84f8aef

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions · 2024-10-07T12:23:05Z

hardhat

Total size of the bundle: 225M
Total number of dependencies (including transitive): 58

List of dependencies (sorted by size)

220M	total
30M	@ignored/edr-optimism-linux-x64-musl
30M	@ignored/edr-optimism-linux-x64-gnu
27M	@ignored/edr-optimism-linux-arm64-musl
27M	@ignored/edr-optimism-linux-arm64-gnu
22M	@ignored/edr-optimism-win32-x64-msvc
21M	@ignored/edr-optimism-darwin-x64
20M	esbuild
20M	@ignored/edr-optimism-darwin-arm64
8.9M	solc
2.8M	@sentry/tracing
1.9M	@noble/curves
1.7M	undici
1.2M	@sentry/types
1.2M	@noble/hashes
932K	@sentry/node
920K	@sentry/utils
824K	zod
816K	@ignored/hardhat-vnext-utils
576K	tsx
548K	@sentry/core
504K	fast-equals
492K	@scure/bip39
460K	@ignored/edr
384K	@ignored/edr-optimism
368K	ethereum-cryptography
344K	@sentry/hub
320K	enquirer
284K	semver
268K	@ignored/hardhat-vnext-errors
188K	commander
168K	@scure/base
136K	adm-zip
128K	get-tsconfig
96K	@scure/bip32
92K	chalk
88K	tslib
88K	@sentry/minimal
84K	js-sha3
76K	agent-base
72K	@nomicfoundation/solidity-analyzer
68K	debug
64K	lru_map
64K	https-proxy-agent
60K	@ignored/hardhat-vnext-zod-utils
56K	rfdc
56K	follow-redirects
48K	memorystream
48K	command-exists
48K	ansi-colors
44K	tmp
40K	resolve-pkg-maps
36K	p-map
32K	cookie
24K	strip-ansi
24K	env-paths
24K	ansi-regex
20K	os-tmpdir
20K	ms

kanej · 2024-10-07T13:37:28Z

v-next/hardhat/templates/mocha-ethers/package.json

+    "@types/chai-as-promised": "^8.0.1",
+    "@types/mocha": ">=9.1.0",
+    "chai": "^4.4.1",
+    "chai-as-promised": "^8.0.0",


We may be able to drop the direct dev dependency once hardhat-chai-matchers has been ported.

kanej · 2024-10-07T13:39:56Z

v-next/hardhat/templates/mocha-ethers/test/Lock.ts

+import * as chai from "chai";
+import chaiAsPromised from "chai-as-promised";
+chai.use(chaiAsPromised);
+const { expect } = chai;


I applied the chaiAsPromised setup directly here.
I don't think we currently have support .mochars.json files to allow us to setup up supporting setup files.

kanej · 2024-10-07T14:18:36Z

v-next/hardhat/templates/mocha-ethers/test/Lock.ts

+const { expect } = chai;
+
+describe("Lock", function () {
+  let connection: NetworkConnection<"l1">;


Now that the connection is not ambient to the global context we need a new pattern for tests.
I have no strong feelings here so opted for a shared connection that is explicitly typed for the expected network connection and that is setup for each test.

I suspect we may want to go with something other than connection as the variable name. Maybe networkConnection is less ambiguous?

+1 to networkConnection. That's the name I used in the network-manager tests.

I'm not sure we need to reset it between tests, though.

schaable

Looks good, just a minor comment regarding the networkConnection reset.

As part of the Alpha prep this adds a mocha/ethers template project that tries to recreate the functionality (we are currently able to support) of the v2 Ethers typescript project in v3. It pulls in the `v-next` versions of the mocha test runner, the `hardhat-test-helpers` and `hardhat-ethers`. It adds a the `Lock.sol` and `Lock.ts` test file. The test file has been modified to allow for running the tests while we still have rough edges. Specifically the rough edges are: - we need new patterns for sharing `connection` among tests (I added a `beforeEach`) - we don't have chai matchers so I added `chai-as-promised` and adapted the tests ... crudely.

github-actions bot added the status:ready This issue is ready to be worked on label Oct 4, 2024

kanej force-pushed the chore/vnext-release branch from fc68dbd to 867b848 Compare October 7, 2024 11:33

Base automatically changed from chore/vnext-release to v-next October 7, 2024 11:49

kanej force-pushed the feat/update-sample-projects-with-hh-ethers branch from 8f9369c to fb535c6 Compare October 7, 2024 12:21

vercel bot deployed to Preview October 7, 2024 12:23 View deployment

kanej force-pushed the feat/update-sample-projects-with-hh-ethers branch from fb535c6 to b979fdf Compare October 7, 2024 13:30

vercel bot deployed to Preview October 7, 2024 13:31 View deployment

kanej commented Oct 7, 2024

View reviewed changes

kanej force-pushed the feat/update-sample-projects-with-hh-ethers branch from b979fdf to 5badc23 Compare October 7, 2024 13:42

vercel bot deployed to Preview October 7, 2024 13:43 View deployment

kanej force-pushed the feat/update-sample-projects-with-hh-ethers branch from 5badc23 to 2b9a6b6 Compare October 7, 2024 14:11

vercel bot deployed to Preview October 7, 2024 14:12 View deployment

kanej commented Oct 7, 2024

View reviewed changes

kanej marked this pull request as ready for review October 7, 2024 14:19

kanej requested review from alcuadrado and schaable October 7, 2024 14:19

schaable approved these changes Oct 9, 2024

View reviewed changes

alcuadrado added the v-next A Hardhat v3 development task label Oct 25, 2024

kanej force-pushed the feat/update-sample-projects-with-hh-ethers branch from 2b9a6b6 to 5e9955a Compare October 28, 2024 22:56

vercel bot deployed to Preview October 28, 2024 22:57 View deployment

kanej force-pushed the feat/update-sample-projects-with-hh-ethers branch from 5e9955a to 84f8aef Compare October 28, 2024 23:05

vercel bot deployed to Preview October 28, 2024 23:06 View deployment

kanej added this pull request to the merge queue Oct 28, 2024

Merged via the queue into v-next with commit 2ebd3c9 Oct 28, 2024
137 checks passed

kanej deleted the feat/update-sample-projects-with-hh-ethers branch October 28, 2024 23:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: create a mocha/ethers template project #5806

feat: create a mocha/ethers template project #5806

kanej commented Oct 4, 2024 •

edited

Loading

vercel bot commented Oct 4, 2024 •

edited

Loading

changeset-bot bot commented Oct 4, 2024 •

edited

Loading

github-actions bot commented Oct 7, 2024 •

edited

Loading

kanej Oct 7, 2024 •

edited

Loading

kanej Oct 7, 2024 •

edited

Loading

kanej Oct 7, 2024

schaable Oct 9, 2024

schaable Oct 9, 2024

schaable left a comment

feat: create a mocha/ethers template project #5806

feat: create a mocha/ethers template project #5806

Conversation

kanej commented Oct 4, 2024 • edited Loading

vercel bot commented Oct 4, 2024 • edited Loading

changeset-bot bot commented Oct 4, 2024 • edited Loading

⚠️ No Changeset found

github-actions bot commented Oct 7, 2024 • edited Loading

hardhat

kanej Oct 7, 2024 • edited Loading

Choose a reason for hiding this comment

kanej Oct 7, 2024 • edited Loading

Choose a reason for hiding this comment

kanej Oct 7, 2024

Choose a reason for hiding this comment

schaable Oct 9, 2024

Choose a reason for hiding this comment

schaable Oct 9, 2024

Choose a reason for hiding this comment

schaable left a comment

Choose a reason for hiding this comment

kanej commented Oct 4, 2024 •

edited

Loading

vercel bot commented Oct 4, 2024 •

edited

Loading

changeset-bot bot commented Oct 4, 2024 •

edited

Loading

github-actions bot commented Oct 7, 2024 •

edited

Loading

kanej Oct 7, 2024 •

edited

Loading

kanej Oct 7, 2024 •

edited

Loading