github/zk-email-verify
1
1
Fork 0
mirror of https://github.com/zkemail/zk-email-verify.git synced 2026-01-06 20:23:54 -05:00
Code Issues Packages Projects Releases Wiki Activity

chore: Update new logo and links

Browse Source
This commit is contained in:
Shubham Gupta
2024-12-12 22:16:34 +05:30
parent d0e6f7ff9b
commit be029a2be1
3 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -1,7 +1,11 @@
# Welcome to ZK-Email
# Welcome to ZK Email
<p align="center">
<img src="docs/logo.jpg" width="300">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/logo-light.svg">
<source media="(prefers-color-scheme: light)" srcset="docs/logo-dark.svg">
<img alt="zkemail." src="docs/logo-light.svg">
</picture>
</p>
ZK Email is an application that allows for anonymous verification of email signatures while masking specific data. It enables verification of emails to/from specific domains or subsets of domains, as well as verification based on specific text in the email body. Our core SDK comes with libraries to assist with circuit generation as well as utility templates for general zk applications.
@@ -28,7 +32,7 @@ Try here: [https://twitter.prove.email/](https://twitter.prove.email/)
You can fork the project as a starting point for your own ZK-Email application.
Moreover, for those interested in creating the Twitter circuit from scratch, our [Proof of Twitter guide](https://prove.email/blog/twitter) offers a step-by-step tutorial on utilizing our SDKs for circuit construction.
Moreover, for those interested in creating the Twitter circuit from scratch, our [Proof of Twitter guide](https://zk.email/blog/twitter) offers a step-by-step tutorial on utilizing our SDKs for circuit construction.
## Audits

4
docs/logo-dark.svg Normal file
View File

@@ -0,0 +1,4 @@
<svg width="360" height="88" viewBox="0 0 360 88" fill="none" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" clip-rule="evenodd" d="M15.4491 37.1235C10.8503 41.7223 10.8503 49.1784 15.4491 53.7771L36.2461 74.5742C40.8449 79.173 48.301 79.173 52.8997 74.5742L73.6995 53.7744C78.2983 49.1757 78.2983 41.7196 73.6995 37.1208L52.9024 16.3238C48.3037 11.725 40.8476 11.725 36.2488 16.3238L15.4491 37.1235ZM28.3421 39.2725C27.519 41.4523 27.1074 43.7844 27.1074 46.269H30.3084C30.3084 44.2265 30.6362 42.3135 31.2916 40.5301C31.9471 38.7466 32.8769 37.1766 34.0811 35.82C35.2852 34.4634 36.7181 33.404 38.3796 32.6419C40.0563 31.8797 41.9159 31.4986 43.9585 31.4986C46.001 31.4986 47.914 31.8797 49.6974 32.6419C51.4808 33.4193 53.0432 34.4863 54.3846 35.8429C55.7412 37.1995 56.8006 38.7695 57.5627 40.5529C58.3249 42.3363 58.706 44.2417 58.706 46.269C58.706 48.2963 58.3249 50.1941 57.5627 51.9622C56.8006 53.7457 55.7412 55.3157 54.3846 56.6723C53.0432 58.0289 51.4808 59.0883 49.6974 59.8504C47.914 60.6278 46.001 61.0165 43.9584 61.0165C42.861 61.0165 41.7406 60.8793 40.5974 60.6049C39.4694 60.3306 38.5167 59.9038 37.7393 59.3245C36.9772 58.7453 36.5961 57.9984 36.5961 57.0838C36.5961 56.3674 36.84 55.7196 37.3278 55.1404C37.8156 54.5611 38.4253 54.2715 39.1569 54.2715H52.1896L52.5783 51.6879H49.9718C50.9016 51.0781 51.6409 50.2322 52.1896 49.1499C52.7536 48.0677 53.0356 46.8711 53.0356 45.5602C53.0356 43.8987 52.624 42.3745 51.8009 40.9874C50.993 39.6155 49.9032 38.518 48.5313 37.6949C47.1595 36.887 45.6352 36.4831 43.9585 36.4831C42.2817 36.4831 40.7498 36.887 39.3627 37.6949C37.9909 38.518 36.8934 39.6155 36.0703 40.9874C35.2624 42.3745 34.8584 43.8987 34.8584 45.5602C34.8584 46.9016 35.1404 48.0829 35.7044 49.1042C36.2837 50.1255 37.0534 50.9486 38.0137 51.5735C37.1449 51.6498 36.3599 51.9699 35.6587 52.5338C34.9575 53.0978 34.4012 53.799 33.9896 54.6374C33.5933 55.491 33.3951 56.3598 33.3951 57.2439C33.3951 58.3566 33.7 59.3398 34.3097 60.1934C34.9347 61.0622 35.7578 61.7939 36.779 62.3884C37.8156 62.9828 38.9588 63.4325 40.2087 63.7374C41.4586 64.0575 42.7085 64.2175 43.9584 64.2175C46.4278 64.2175 48.7447 63.7526 50.9092 62.8228C53.0737 61.9082 54.9791 60.6278 56.6253 58.9816C58.2715 57.3506 59.5596 55.4452 60.4894 53.2655C61.4344 51.101 61.907 48.7688 61.907 46.269C61.907 43.7844 61.4421 41.4523 60.5122 39.2725C59.5824 37.108 58.2944 35.2027 56.6482 33.5564C55.0019 31.9102 53.0889 30.6222 50.9092 29.6924C48.7447 28.7625 46.4278 28.2976 43.9585 28.2976C41.4891 28.2976 39.2255 28.7625 37.1677 29.6924C35.11 30.6222 33.3265 31.9102 31.8175 33.5564C30.3237 35.2027 29.1652 37.108 28.3421 39.2725ZM38.4253 48.8755C37.7698 48.0067 37.4421 46.9702 37.4421 45.766C37.4421 44.5923 37.7317 43.51 38.311 42.5193C38.8902 41.5285 39.6676 40.7358 40.6431 40.1414C41.6339 39.5469 42.739 39.2497 43.9585 39.2497C45.1626 39.2497 46.2525 39.5393 47.2281 40.1185C48.2188 40.713 49.0038 41.498 49.5831 42.4735C50.1623 43.4643 50.4519 44.5618 50.4519 45.766C50.4519 47.0464 50.1547 48.121 49.5602 48.9899C48.981 49.8587 48.2188 50.5065 47.2738 50.9333C46.3287 51.3754 45.3151 51.5964 44.2328 51.5964C43.1048 51.5964 42.015 51.3601 40.9632 50.8876C39.9267 50.4151 39.0807 49.7444 38.4253 48.8755Z" fill="#000"/>
<path d="M102.048 65V58.0998L127.061 31.1459L126.343 36.1054H102.264V28.7021H132.668V35.5304L107.726 62.6281L108.23 57.5248H132.668V65H102.048ZM142.497 58.6748V47.6776L160.897 28.7021H171.104V29.2771L142.497 58.6748ZM137.609 65V13.2485L145.66 12.2422L145.875 12.8172V65H137.609ZM162.047 65L149.541 46.7432L155.291 41.5681L171.248 64.425V65H162.047ZM189.553 66.0782C185.863 66.0782 182.605 65.2635 179.778 63.6343C176.998 62.0051 174.818 59.753 173.237 56.8779C171.655 54.0028 170.865 50.6485 170.865 46.8151C170.865 43.0296 171.631 39.6993 173.165 36.8242C174.746 33.9012 176.902 31.649 179.634 30.0677C182.413 28.4385 185.6 27.6239 189.193 27.6239C192.787 27.6239 195.902 28.4625 198.537 30.1396C201.221 31.7688 203.305 34.0689 204.791 37.0398C206.324 40.0107 207.091 43.4848 207.091 47.462V48.8277L206.013 49.9058H174.746V43.0056H203.353L198.969 44.6588C198.921 42.6462 198.442 40.9212 197.531 39.4836C196.669 37.9982 195.519 36.8721 194.081 36.1054C192.691 35.2908 191.11 34.8835 189.337 34.8835C187.42 34.8835 185.671 35.3387 184.09 36.2492C182.509 37.1117 181.287 38.3336 180.424 39.9149C179.562 41.4483 179.131 43.2452 179.131 45.3057V48.1808C179.131 50.1454 179.586 51.9423 180.496 53.5715C181.455 55.1528 182.725 56.4227 184.306 57.381C185.887 58.3394 187.636 58.8186 189.553 58.8186C191.374 58.8186 193.027 58.3394 194.512 57.381C196.046 56.3747 197.244 55.033 198.106 53.3559H198.969L205.653 56.231C204.216 59.3457 202.083 61.7655 199.256 63.4906C196.477 65.2156 193.243 66.0782 189.553 66.0782ZM212.78 65V28.7021H220.543V37.543L219.177 36.1773C219.991 34.3564 221.046 32.823 222.339 31.5772C223.633 30.3313 225.143 29.3729 226.868 28.7021C228.593 27.9833 230.533 27.6239 232.69 27.6239C235.709 27.6239 238.392 28.4625 240.74 30.1396C243.088 31.8167 244.669 34.2845 245.484 37.543L242.824 37.3992C243.639 35.3387 244.789 33.5897 246.275 32.1522C247.76 30.7146 249.485 29.6125 251.45 28.8458C253.462 28.0312 255.571 27.6239 257.775 27.6239C260.219 27.6239 262.447 28.1989 264.459 29.349C266.52 30.4511 268.149 32.1043 269.347 34.3085C270.593 36.4648 271.216 39.1722 271.216 42.4306V65H262.95V44.4432C262.95 42.2868 262.639 40.5378 262.016 39.1961C261.393 37.8065 260.53 36.8002 259.428 36.1773C258.326 35.5064 257.056 35.171 255.619 35.171C254.277 35.171 252.863 35.5304 251.378 36.2492C249.94 36.9679 248.694 38.1659 247.64 39.843C246.634 41.4722 246.131 43.7483 246.131 46.6713V65H237.865V44.4432C237.865 42.2868 237.553 40.5378 236.93 39.1961C236.308 37.8065 235.445 36.8002 234.343 36.1773C233.241 35.5064 231.971 35.171 230.533 35.171C229.192 35.171 227.778 35.5304 226.293 36.2492C224.855 36.9679 223.609 38.1659 222.555 39.843C221.549 41.5202 221.046 43.7963 221.046 46.6713V65H212.78ZM289.729 66.0782C287.238 66.0782 285.009 65.599 283.045 64.6406C281.128 63.6823 279.619 62.3405 278.516 60.6155C277.414 58.8904 276.863 56.9258 276.863 54.7216C276.863 51.3194 278.037 48.612 280.385 46.5995C282.733 44.539 286.111 43.341 290.52 43.0056L304.608 41.8556V48.6839L291.742 49.7621C289.442 49.9537 287.789 50.4329 286.782 51.1996C285.776 51.9663 285.273 52.9965 285.273 54.2903C285.273 55.5841 285.848 56.6383 286.998 57.4529C288.148 58.2675 289.609 58.6748 291.382 58.6748C293.251 58.6748 294.928 58.2196 296.414 57.3092C297.947 56.3508 299.169 55.1289 300.08 53.6434C300.99 52.158 301.445 50.5527 301.445 48.8277V42.8619C301.445 40.5618 300.679 38.669 299.145 37.1836C297.612 35.6502 295.599 34.8835 293.107 34.8835C290.999 34.8835 289.25 35.4106 287.86 36.4648C286.519 37.4711 285.656 38.7409 285.273 40.2743H284.482L277.438 38.5492C278.301 35.2908 280.098 32.6553 282.829 30.6428C285.608 28.6302 289.058 27.6239 293.179 27.6239C298.307 27.6239 302.308 29.1094 305.183 32.0803C308.058 35.0033 309.495 39.1482 309.495 44.515V65H302.164V54.4341L305.111 54.8653C304.536 56.9258 303.506 58.8186 302.02 60.5436C300.535 62.2208 298.738 63.5625 296.629 64.5687C294.569 65.575 292.269 66.0782 289.729 66.0782ZM316.808 65V28.7021H325.074V65H316.808ZM320.977 23.2394C319.539 23.2394 318.317 22.7363 317.311 21.73C316.305 20.7237 315.802 19.4778 315.802 17.9924C315.802 16.6028 316.305 15.4048 317.311 14.3985C318.317 13.3443 319.563 12.8172 321.049 12.8172C322.438 12.8172 323.636 13.3443 324.642 14.3985C325.697 15.4048 326.224 16.6267 326.224 18.0643C326.224 19.5018 325.697 20.7237 324.642 21.73C323.636 22.7363 322.414 23.2394 320.977 23.2394ZM333.839 65V13.2485L341.89 12.2422L342.105 12.8172V65H333.839Z" fill="#000"/>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 7.5 KiB

4
docs/logo-light.svg Normal file
View File

@@ -0,0 +1,4 @@
<svg width="360" height="88" viewBox="0 0 360 88" fill="none" xmlns="http://www.w3.org/2000/svg">
<path fill-rule="evenodd" clip-rule="evenodd" d="M15.4491 37.1235C10.8503 41.7223 10.8503 49.1784 15.4491 53.7771L36.2461 74.5742C40.8449 79.173 48.301 79.173 52.8997 74.5742L73.6995 53.7744C78.2983 49.1757 78.2983 41.7196 73.6995 37.1208L52.9024 16.3238C48.3037 11.725 40.8476 11.725 36.2488 16.3238L15.4491 37.1235ZM28.3421 39.2725C27.519 41.4523 27.1074 43.7844 27.1074 46.269H30.3084C30.3084 44.2265 30.6362 42.3135 31.2916 40.5301C31.9471 38.7466 32.8769 37.1766 34.0811 35.82C35.2852 34.4634 36.7181 33.404 38.3796 32.6419C40.0563 31.8797 41.9159 31.4986 43.9585 31.4986C46.001 31.4986 47.914 31.8797 49.6974 32.6419C51.4808 33.4193 53.0432 34.4863 54.3846 35.8429C55.7412 37.1995 56.8006 38.7695 57.5627 40.5529C58.3249 42.3363 58.706 44.2417 58.706 46.269C58.706 48.2963 58.3249 50.1941 57.5627 51.9622C56.8006 53.7457 55.7412 55.3157 54.3846 56.6723C53.0432 58.0289 51.4808 59.0883 49.6974 59.8504C47.914 60.6278 46.001 61.0165 43.9584 61.0165C42.861 61.0165 41.7406 60.8793 40.5974 60.6049C39.4694 60.3306 38.5167 59.9038 37.7393 59.3245C36.9772 58.7453 36.5961 57.9984 36.5961 57.0838C36.5961 56.3674 36.84 55.7196 37.3278 55.1404C37.8156 54.5611 38.4253 54.2715 39.1569 54.2715H52.1896L52.5783 51.6879H49.9718C50.9016 51.0781 51.6409 50.2322 52.1896 49.1499C52.7536 48.0677 53.0356 46.8711 53.0356 45.5602C53.0356 43.8987 52.624 42.3745 51.8009 40.9874C50.993 39.6155 49.9032 38.518 48.5313 37.6949C47.1595 36.887 45.6352 36.4831 43.9585 36.4831C42.2817 36.4831 40.7498 36.887 39.3627 37.6949C37.9909 38.518 36.8934 39.6155 36.0703 40.9874C35.2624 42.3745 34.8584 43.8987 34.8584 45.5602C34.8584 46.9016 35.1404 48.0829 35.7044 49.1042C36.2837 50.1255 37.0534 50.9486 38.0137 51.5735C37.1449 51.6498 36.3599 51.9699 35.6587 52.5338C34.9575 53.0978 34.4012 53.799 33.9896 54.6374C33.5933 55.491 33.3951 56.3598 33.3951 57.2439C33.3951 58.3566 33.7 59.3398 34.3097 60.1934C34.9347 61.0622 35.7578 61.7939 36.779 62.3884C37.8156 62.9828 38.9588 63.4325 40.2087 63.7374C41.4586 64.0575 42.7085 64.2175 43.9584 64.2175C46.4278 64.2175 48.7447 63.7526 50.9092 62.8228C53.0737 61.9082 54.9791 60.6278 56.6253 58.9816C58.2715 57.3506 59.5596 55.4452 60.4894 53.2655C61.4344 51.101 61.907 48.7688 61.907 46.269C61.907 43.7844 61.4421 41.4523 60.5122 39.2725C59.5824 37.108 58.2944 35.2027 56.6482 33.5564C55.0019 31.9102 53.0889 30.6222 50.9092 29.6924C48.7447 28.7625 46.4278 28.2976 43.9585 28.2976C41.4891 28.2976 39.2255 28.7625 37.1677 29.6924C35.11 30.6222 33.3265 31.9102 31.8175 33.5564C30.3237 35.2027 29.1652 37.108 28.3421 39.2725ZM38.4253 48.8755C37.7698 48.0067 37.4421 46.9702 37.4421 45.766C37.4421 44.5923 37.7317 43.51 38.311 42.5193C38.8902 41.5285 39.6676 40.7358 40.6431 40.1414C41.6339 39.5469 42.739 39.2497 43.9585 39.2497C45.1626 39.2497 46.2525 39.5393 47.2281 40.1185C48.2188 40.713 49.0038 41.498 49.5831 42.4735C50.1623 43.4643 50.4519 44.5618 50.4519 45.766C50.4519 47.0464 50.1547 48.121 49.5602 48.9899C48.981 49.8587 48.2188 50.5065 47.2738 50.9333C46.3287 51.3754 45.3151 51.5964 44.2328 51.5964C43.1048 51.5964 42.015 51.3601 40.9632 50.8876C39.9267 50.4151 39.0807 49.7444 38.4253 48.8755Z" fill="#F5F3EF"/>
<path d="M102.048 65V58.0998L127.061 31.1459L126.343 36.1054H102.264V28.7021H132.668V35.5304L107.726 62.6281L108.23 57.5248H132.668V65H102.048ZM142.497 58.6748V47.6776L160.897 28.7021H171.104V29.2771L142.497 58.6748ZM137.609 65V13.2485L145.66 12.2422L145.875 12.8172V65H137.609ZM162.047 65L149.541 46.7432L155.291 41.5681L171.248 64.425V65H162.047ZM189.553 66.0782C185.863 66.0782 182.605 65.2635 179.778 63.6343C176.998 62.0051 174.818 59.753 173.237 56.8779C171.655 54.0028 170.865 50.6485 170.865 46.8151C170.865 43.0296 171.631 39.6993 173.165 36.8242C174.746 33.9012 176.902 31.649 179.634 30.0677C182.413 28.4385 185.6 27.6239 189.193 27.6239C192.787 27.6239 195.902 28.4625 198.537 30.1396C201.221 31.7688 203.305 34.0689 204.791 37.0398C206.324 40.0107 207.091 43.4848 207.091 47.462V48.8277L206.013 49.9058H174.746V43.0056H203.353L198.969 44.6588C198.921 42.6462 198.442 40.9212 197.531 39.4836C196.669 37.9982 195.519 36.8721 194.081 36.1054C192.691 35.2908 191.11 34.8835 189.337 34.8835C187.42 34.8835 185.671 35.3387 184.09 36.2492C182.509 37.1117 181.287 38.3336 180.424 39.9149C179.562 41.4483 179.131 43.2452 179.131 45.3057V48.1808C179.131 50.1454 179.586 51.9423 180.496 53.5715C181.455 55.1528 182.725 56.4227 184.306 57.381C185.887 58.3394 187.636 58.8186 189.553 58.8186C191.374 58.8186 193.027 58.3394 194.512 57.381C196.046 56.3747 197.244 55.033 198.106 53.3559H198.969L205.653 56.231C204.216 59.3457 202.083 61.7655 199.256 63.4906C196.477 65.2156 193.243 66.0782 189.553 66.0782ZM212.78 65V28.7021H220.543V37.543L219.177 36.1773C219.991 34.3564 221.046 32.823 222.339 31.5772C223.633 30.3313 225.143 29.3729 226.868 28.7021C228.593 27.9833 230.533 27.6239 232.69 27.6239C235.709 27.6239 238.392 28.4625 240.74 30.1396C243.088 31.8167 244.669 34.2845 245.484 37.543L242.824 37.3992C243.639 35.3387 244.789 33.5897 246.275 32.1522C247.76 30.7146 249.485 29.6125 251.45 28.8458C253.462 28.0312 255.571 27.6239 257.775 27.6239C260.219 27.6239 262.447 28.1989 264.459 29.349C266.52 30.4511 268.149 32.1043 269.347 34.3085C270.593 36.4648 271.216 39.1722 271.216 42.4306V65H262.95V44.4432C262.95 42.2868 262.639 40.5378 262.016 39.1961C261.393 37.8065 260.53 36.8002 259.428 36.1773C258.326 35.5064 257.056 35.171 255.619 35.171C254.277 35.171 252.863 35.5304 251.378 36.2492C249.94 36.9679 248.694 38.1659 247.64 39.843C246.634 41.4722 246.131 43.7483 246.131 46.6713V65H237.865V44.4432C237.865 42.2868 237.553 40.5378 236.93 39.1961C236.308 37.8065 235.445 36.8002 234.343 36.1773C233.241 35.5064 231.971 35.171 230.533 35.171C229.192 35.171 227.778 35.5304 226.293 36.2492C224.855 36.9679 223.609 38.1659 222.555 39.843C221.549 41.5202 221.046 43.7963 221.046 46.6713V65H212.78ZM289.729 66.0782C287.238 66.0782 285.009 65.599 283.045 64.6406C281.128 63.6823 279.619 62.3405 278.516 60.6155C277.414 58.8904 276.863 56.9258 276.863 54.7216C276.863 51.3194 278.037 48.612 280.385 46.5995C282.733 44.539 286.111 43.341 290.52 43.0056L304.608 41.8556V48.6839L291.742 49.7621C289.442 49.9537 287.789 50.4329 286.782 51.1996C285.776 51.9663 285.273 52.9965 285.273 54.2903C285.273 55.5841 285.848 56.6383 286.998 57.4529C288.148 58.2675 289.609 58.6748 291.382 58.6748C293.251 58.6748 294.928 58.2196 296.414 57.3092C297.947 56.3508 299.169 55.1289 300.08 53.6434C300.99 52.158 301.445 50.5527 301.445 48.8277V42.8619C301.445 40.5618 300.679 38.669 299.145 37.1836C297.612 35.6502 295.599 34.8835 293.107 34.8835C290.999 34.8835 289.25 35.4106 287.86 36.4648C286.519 37.4711 285.656 38.7409 285.273 40.2743H284.482L277.438 38.5492C278.301 35.2908 280.098 32.6553 282.829 30.6428C285.608 28.6302 289.058 27.6239 293.179 27.6239C298.307 27.6239 302.308 29.1094 305.183 32.0803C308.058 35.0033 309.495 39.1482 309.495 44.515V65H302.164V54.4341L305.111 54.8653C304.536 56.9258 303.506 58.8186 302.02 60.5436C300.535 62.2208 298.738 63.5625 296.629 64.5687C294.569 65.575 292.269 66.0782 289.729 66.0782ZM316.808 65V28.7021H325.074V65H316.808ZM320.977 23.2394C319.539 23.2394 318.317 22.7363 317.311 21.73C316.305 20.7237 315.802 19.4778 315.802 17.9924C315.802 16.6028 316.305 15.4048 317.311 14.3985C318.317 13.3443 319.563 12.8172 321.049 12.8172C322.438 12.8172 323.636 13.3443 324.642 14.3985C325.697 15.4048 326.224 16.6267 326.224 18.0643C326.224 19.5018 325.697 20.7237 324.642 21.73C323.636 22.7363 322.414 23.2394 320.977 23.2394ZM333.839 65V13.2485L341.89 12.2422L342.105 12.8172V65H333.839Z" fill="#F5F3EF"/>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 7.5 KiB