Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Port hardhat-chai-matchers #5946

Merged
merged 65 commits into from
Dec 18, 2024
Merged

Conversation

ChristopherDedominici
Copy link
Contributor

@ChristopherDedominici ChristopherDedominici commented Nov 13, 2024

GOAL:
This PR ports the hardhat-chai-matchers v2 code to v3.

RELATED ISSUES (TODOs):

OVERVIEW:
The v2 code has been ported to v3 by preserving the core logic and structure while introducing minor adjustments.
The adjustments mostly relate to the plugin's initialization process. For a detailed overview, refer to the design doc.

NOTES:

  • In v2, some errors were thrown using the chai constructor AssertionError. This behavior has been retained rather than switching to HardhatError
  • Where applicable, methods from ethers have been replaced with those from hardhat-utils.
    E.G.: toBeHex -> numberToHexString

Copy link

changeset-bot bot commented Nov 13, 2024

⚠️ No Changeset found

Latest commit: 393b9e3

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

Copy link

vercel bot commented Nov 13, 2024

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 Dec 18, 2024 10:46am

Copy link
Contributor

github-actions bot commented Nov 19, 2024

hardhat

Total size of the bundle: 228M
Total number of dependencies (including transitive): 61

List of dependencies (sorted by size)
224M	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
2.4M	micro-eth-signer
1.9M	@noble/curves
1.7M	undici
1.2M	@sentry/types
1.2M	@noble/hashes
932K	@sentry/node
920K	@sentry/utils
856K	zod
816K	@ignored/hardhat-vnext-utils
616K	micro-packed
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
320K	@ignored/hardhat-vnext-errors
284K	semver
192K	ws
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

Switch the `./src/types.ts` file to a `./src/types.d.ts` file. This
allows typescript to correctly pick up the Chai types being extended.

There were some small built fixes as well (e.g. changing the type of
a passed arg to be `bigint[]`.

I added in the type declaration as an import from `./index.ts` and
imported the `add-chai-matchers` bootstrap code.
@ChristopherDedominici ChristopherDedominici marked this pull request as ready for review December 17, 2024 10:06
@ChristopherDedominici ChristopherDedominici added v-next A Hardhat v3 development task status:ready This issue is ready to be worked on labels Dec 17, 2024
Copy link
Member

@alcuadrado alcuadrado left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some more comments, but feel free to merge after resolving them.

@ChristopherDedominici ChristopherDedominici added this pull request to the merge queue Dec 18, 2024
Merged via the queue into v-next with commit da570a3 Dec 18, 2024
142 checks passed
@ChristopherDedominici ChristopherDedominici deleted the hardhat-chai-matchers branch December 18, 2024 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no changeset needed This PR doesn't require a changeset status:ready This issue is ready to be worked on v-next A Hardhat v3 development task
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Port hardhat-chai-matchers to v3
4 participants