Skip to content

add readme for viem matchers #6734

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

Merged
merged 4 commits into from
May 23, 2025
Merged

Conversation

kanej
Copy link
Member

@kanej kanej commented May 22, 2025

This PR adds a few elements to allow us to include the new @nomicfoundation/hardhat-viem-matchers plugin in the template projects:

  1. It adds a basic README.md that shows basic usage of each assertion function.
  2. It adds the plugin to the viem toolbox
  3. It adds a changeset
  4. It adds the plugin to the example project to ease manual testing

The README.md is roughly based on the chai matcher reference page of the docs: https://hardhat.org/hardhat-chai-matchers/docs/reference.

Copy link

changeset-bot bot commented May 22, 2025

🦋 Changeset detected

Latest commit: 8993959

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 21 packages
Name Type
@nomicfoundation/hardhat-viem-matchers Patch
@nomicfoundation/hardhat-toolbox-viem Patch
hardhat Patch
@nomicfoundation/hardhat-errors Patch
@nomicfoundation/hardhat-ethers-chai-matchers Patch
@nomicfoundation/hardhat-ignition Patch
@nomicfoundation/ignition-core Patch
@nomicfoundation/hardhat-ignition-ethers Patch
@nomicfoundation/ignition-ui Patch
@nomicfoundation/hardhat-ignition-viem Patch
@nomicfoundation/hardhat-keystore Patch
@nomicfoundation/hardhat-mocha Patch
@nomicfoundation/hardhat-network-helpers Patch
@nomicfoundation/hardhat-node-test-reporter Patch
@nomicfoundation/hardhat-node-test-runner Patch
@nomicfoundation/hardhat-test-utils Patch
@nomicfoundation/hardhat-typechain Patch
@nomicfoundation/hardhat-utils Patch
@nomicfoundation/hardhat-toolbox-mocha-ethers Patch
@nomicfoundation/hardhat-viem Patch
@nomicfoundation/hardhat-zod-utils Patch

Not sure what this means? Click here to learn what changesets are.

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

@github-actions github-actions bot added the status:ready This issue is ready to be worked on label May 22, 2025
@github-project-automation github-project-automation bot moved this to Backlog in Hardhat May 22, 2025
Copy link
Contributor

github-actions bot commented May 22, 2025

hardhat

Total size of the bundle: 226M
Total number of dependencies (including transitive): 113

List of dependencies (sorted by size)
220M	total
24M	@ignored/edr-optimism-linux-x64-musl
24M	@ignored/edr-optimism-linux-x64-gnu
22M	@ignored/edr-optimism-win32-x64-msvc
21M	@ignored/edr-optimism-linux-arm64-musl
21M	@ignored/edr-optimism-linux-arm64-gnu
20M	esbuild
18M	@ignored/edr-optimism-darwin-x64
17M	@ignored/edr-optimism-darwin-arm64
7.7M	@opentelemetry/semantic-conventions
6.2M	@sentry/core
4.3M	@sentry/node
3.1M	@opentelemetry/api
2.5M	zod
2.5M	micro-eth-signer
2.3M	@opentelemetry/core
1.9M	@opentelemetry/resources
1.9M	@noble/curves
1.7M	undici
1.6M	@opentelemetry/sdk-trace-base
1.2M	@noble/hashes
956K	@opentelemetry/instrumentation
876K	@sentry/opentelemetry
864K	@streamparser/json
860K	@nomicfoundation/hardhat-utils
760K	@opentelemetry/api-logs
684K	import-in-the-middle
624K	resolve
624K	micro-packed
588K	minimatch
584K	tsx
572K	acorn
544K	fast-equals
492K	@scure/bip39
472K	@nomicfoundation/hardhat-errors
408K	json-stream-stringify
368K	ethereum-cryptography
348K	@ignored/edr
332K	@streamparser/json-node
320K	pg-protocol
320K	enquirer
304K	@ignored/edr-optimism
300K	@opentelemetry/instrumentation-http
288K	semver
224K	@opentelemetry/instrumentation-pg
212K	@opentelemetry/instrumentation-graphql
200K	undici-types
196K	ws
188K	@opentelemetry/instrumentation-mongodb
180K	@opentelemetry/instrumentation-undici
176K	@opentelemetry/instrumentation-express
172K	@opentelemetry/instrumentation-amqplib
168K	@scure/base
164K	cjs-module-lexer
156K	@opentelemetry/instrumentation-hapi
148K	@opentelemetry/instrumentation-redis-4
148K	@opentelemetry/instrumentation-mysql
144K	@opentelemetry/instrumentation-fs
136K	get-tsconfig
136K	adm-zip
136K	@opentelemetry/instrumentation-koa
132K	@opentelemetry/instrumentation-knex
124K	@opentelemetry/instrumentation-mongoose
124K	@opentelemetry/instrumentation-ioredis
120K	@opentelemetry/instrumentation-mysql2
120K	@opentelemetry/instrumentation-connect
116K	@opentelemetry/instrumentation-kafkajs
112K	@opentelemetry/instrumentation-tedious
112K	@opentelemetry/context-async-hooks
96K	@scure/bip32
96K	@opentelemetry/instrumentation-dataloader
92K	chalk
80K	@opentelemetry/instrumentation-generic-pool
76K	pg-types
76K	@prisma/instrumentation
72K	@nomicfoundation/solidity-analyzer
68K	debug
68K	@opentelemetry/sql-common
68K	@opentelemetry/instrumentation-lru-memoizer
64K	@nomicfoundation/hardhat-zod-utils
60K	acorn-import-attributes
60K	@opentelemetry/redis-common
56K	rfdc
56K	is-core-module
56K	function-bind
52K	@types/tedious
48K	shimmer
48K	ansi-colors
44K	resolve.exports
40K	resolve-pkg-maps
40K	require-in-the-middle
40K	forwarded-parse
40K	@types/mysql
36K	supports-preserve-symlinks-flag
36K	p-map
36K	@types/pg
32K	hasown
28K	xtend
28K	brace-expansion
24K	strip-ansi
24K	postgres-interval
24K	postgres-array
24K	env-paths
24K	ansi-regex
20K	postgres-date
20K	postgres-bytea
20K	pg-int8
20K	path-parse
20K	ms
20K	module-details-from-path
20K	balanced-match
20K	@types/shimmer
20K	@types/pg-pool
20K	@types/connect

@kanej kanej linked an issue May 22, 2025 that may be closed by this pull request
@kanej kanej force-pushed the chore/add-readme-for-viem-matchers branch 7 times, most recently from ccb1c9c to 8d25b18 Compare May 23, 2025 12:54
@kanej kanej marked this pull request as ready for review May 23, 2025 12:57
@kanej kanej removed the request for review from alcuadrado May 23, 2025 14:39
Base automatically changed from viem-matchers-first-iteration to v-next May 23, 2025 14:42
kanej added 4 commits May 23, 2025 16:00
Add a basic `README.md` to illustrate usage and the available functions.

Resolves #6713.
Add the viem matchers plugin to the viem toolbox.
To aid manual testing of assertions, add the viem assertion plugin to
the example project.
@kanej kanej force-pushed the chore/add-readme-for-viem-matchers branch from ad295a0 to 8993959 Compare May 23, 2025 15:00
@kanej kanej added this pull request to the merge queue May 23, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks May 23, 2025
@kanej kanej added this pull request to the merge queue May 23, 2025
Merged via the queue into v-next with commit 349fb0c May 23, 2025
137 checks passed
@kanej kanej deleted the chore/add-readme-for-viem-matchers branch May 23, 2025 16:04
@github-project-automation github-project-automation bot moved this from Backlog to Done in Hardhat May 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:ready This issue is ready to be worked on
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add per function docs for new viem assertions to README.md
2 participants