From af7f463c9ade22b99b2e6def4f79a8d994abbe64 Mon Sep 17 00:00:00 2001 From: destinyae <109734765+destinyae@users.noreply.github.com> Date: Sun, 3 Aug 2025 17:18:20 +0100 Subject: [PATCH] Fix the typos --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b4b4161e..c36b4b02 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # zk-regex -A library to compile regex verification in circom. Explained on [our blog post](https://zk.email/blog/zkregex). You can use regex to specify how to parse an email in a ZK Email proof when defining a new patterm on [the ZK Email SDK registry](https://registry.zk.email/). Noir coming soon. +A library to compile regex verification in circom. Explained on [our blog post](https://zk.email/blog/zkregex). You can use regex to specify how to parse an email in a ZK Email proof when defining a new pattern on [the ZK Email SDK registry](https://registry.zk.email/). Noir coming soon. @@ -36,11 +36,11 @@ The regular expressions supported by our compiler version 2.1.1 are **audited by 3. The end anchor $ must appear at the end of the regular expression. 4. Regular expressions that, when converted to DFA (Deterministic Finite Automaton), include transitions to the initial state are not supported (e.g., .*). 5. Regular expressions that, when converted to DFA, have multiple accepting states are not supported. -6. Decomposed regex defintions must alternate public and private states. +6. Decomposed regex definitions must alternate public and private states. Note that all international characters are supported. -If you want to use this circuit in practice, we strongly recommend using [AssertZero](https://github.com/zkemail/zk-email-verify/blob/29d5c873161c30ebb98a00efb3a145275d0f0833/packages/circuits/utils/array.circom#L144) on the bytes before and after your match. This is because you likely have shift viaan unconstrained index passed in as the witnesss to represent the start of the regex match. Since that value can be arbitrarily manipulated, you need to manually constrain that there are no extra matches that can be used to exploit the circuit. You can see how we do this in [zk-email here](https://github.com/zkemail/zk-email-verify/blob/29d5c873161c30ebb98a00efb3a145275d0f0833/packages/circuits/email-verifier.circom#L99). +If you want to use this circuit in practice, we strongly recommend using [AssertZero](https://github.com/zkemail/zk-email-verify/blob/29d5c873161c30ebb98a00efb3a145275d0f0833/packages/circuits/utils/array.circom#L144) on the bytes before and after your match. This is because you likely have shift viaan unconstrained index passed in as the witness to represent the start of the regex match. Since that value can be arbitrarily manipulated, you need to manually constrain that there are no extra matches that can be used to exploit the circuit. You can see how we do this in [zk-email here](https://github.com/zkemail/zk-email-verify/blob/29d5c873161c30ebb98a00efb3a145275d0f0833/packages/circuits/email-verifier.circom#L99). ## How to use