github/zk-email-verify
1
1
Fork 0
mirror of https://github.com/zkemail/zk-email-verify.git synced 2026-01-09 21:48:14 -05:00
Code Issues Packages Projects Releases Wiki Activity

circuit: add input assumptions to docs

Browse Source
This commit is contained in:
Saleel
2024-05-16 09:16:59 +04:00
parent ea2226ee8c
commit 4a0572c9b3
6 changed files with 25 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/circuits/README.md
View File

@@ -125,7 +125,9 @@ Base64Decode: Decodes a base64 encoded string into binary data.
</details>
## Utils
This section provides an overview of utility circom templates available in the `@zk-email/circuits/utils` directory. These templates assist in the construction of zk circuits for various applications beyond the core ZK Email functionalities.
This section provides an overview of utility circom templates available in the `@zk-email/circuits/utils` directory. These templates assist in the construction of ZK circuits for various applications beyond the core ZK Email functionalities.
> Important: When using these templates outside of zk-email, please ensure you read the assumptions on the input signals that are documented above each template source code. You would need to constrain the inputs accordingly before you pass them to these utility circuits.
### `utils/array.circom`