Merge pull request #7095 from NomicFoundation/viem-predicates-readme

Add viem predicates examples to the readme

Author: kanej

v-next/hardhat-viem-assertions/README.md

@@ -106,6 +106,28 @@ await viem.assertions.revertWithCustomErrorWithArgs(
 );
 ```
 
+This assertion can take predicate functions to match some of the arguments:
+
+```ts
+await viem.assertions.revertWithCustomErrorWithArgs(
+  contract.read.revertWithCustomErrorWithUintAndString([1n, "test"]),
+  contract,
+  "CustomErrorWithUintAndString",
+  [(arg: bigint) => arg === 1n, "test"],
+);
+```
+
+```ts
+import { anyValue } from "@nomicfoundation/hardhat-toolbox-viem/predicates";
+
+await viem.assertions.revertWithCustomErrorWithArgs(
+  contract.read.revertWithCustomErrorWithUintAndString([1n, "test"]),
+  contract,
+  "CustomErrorWithUintAndString",
+  [1n, anyValue],
+);
+```
+
 ### Events
 
 #### `.emit`
@@ -133,6 +155,28 @@ await viem.assertions.emitWithArgs(
 );
 ```
 
+This assertion can take predicate functions to match some of the arguments:
+
+```ts
+await viem.assertions.emitWithArgs(
+  contract.write.emitTwoUints([1n, 2n]),
+  contract,
+  "WithTwoUintArgs",
+  [1n, (arg: bigint) => arg >= 2],
+);
+```
+
+```ts
+import { anyValue } from "@nomicfoundation/hardhat-toolbox-viem/predicates";
+
+await viem.assertions.emitWithArgs(
+  contract.write.emitTwoUints([1n, 2n]),
+  contract,
+  "WithTwoUintArgs",
+  [anyValue, 2n],
+);
+```
+
 ### Balance change
 
 These assertions can be used to check how a given transaction affects the ether balance of a specific address.