Refactor circuit

[saleel]

Description

• EmailVerifier: Renamed signal names; minor refactoring like rearranging variables, updating comments, etc

  • in_padded -> emailHeader
  • in_len_padded_bytes -> emailHeaderLength
  • body_hash_idx -> bodyHashIndex
  • precomputed_sha -> precomputedSHA
  • in_body_padded -> emailBody
  • in_body_len_padded_bytes -> emailBodyLength
  • pubkey_hash -> pubkeyHash

• VarShiftLeft: Moved to utils/array.circom;

• QuinSelector: Moved to utils/array.circom; renamed to ItemAtIndex; Removed the second parameter of numBits and calculate it internally (log2Ceil(maxLength))

• AssertZeroes: Moved to utils/array.circom; renamed to AssertZeroPadding;

• Packed2Bytes: Removed - it was not used anywhere;

• Bytes2Packed and PackBytes: Removed and replaced with Bytes2Ints from email wallet - single circuit that does int[] to bytes[] - Bytes2Packed was doing "assign and then constrain later" which is not the case in Bytes2Ints; Renamed and added as PackBytes in bytes.circom.

• ShiftAndPack: Moved to utils/bytes.circom; Renamed to PackByteSubArray; Added logic to set value after subarray length (new input) to zero as packing without this is not safe (using a new circuit SelectSubArray in array.circom); we dont use these two circuits anywhere though; set packsize to 31

• VarShiftMaskedStr: Moved to utils/regex.circom; Renamed to ExtractRegexReveal; added assertions to check data after maxRevealLength is zero (old TODO); Renamed shift to startIndex

• ShiftAndPackMaskedStr: moved to utils/regex.circom; Renamed to PackRegexReveal; use 31 as pack size instead of template param

• ClearSubarrayAfterEndIndex: Removed - it was not used anywhere; also seems to have off by one error.

• ascii.circom was removed. Moved and renamed the similar circuit from email wallet to utils/bytes.circom (DigitBytesToInt)

• fp.circom, base64.circom, 'bigint.circom', bigint_func.circom (changed _ to - in filename) moved to lib

• sha.circom, sha256general.circom, sha256partial.circom merged to one file sha.circom and moved to lib; inputs in_padded and in_len_padded_bytes renamed to paddedIn and paddedInLength in all sha circuits; removed unused/commented out Sha256NBytes circuit

• rsa.circom moved to lib/rsa.circom; renamed to RSAVerifier65537 (from RSAVerify65537); base_message input renamed to message

• log2 - removed as this was off by one; replaced usages with log2Ceil

• log2Ceil - moved to utils/functions.circom

• Some constants (field max bytes, max length for domain, email addr) from email wallet moved to utils/constants.circom

• Email nullifier from email wallet moved to helpers/nullifier.circom

• PoseidonLarge circuit added to utils/hash.circom to hash large number of inputs; This is used to hash pub key in EmailVerifier and hash signature in EmailNullifier circuit

• Update all circuits to pragma 2.1.6

• Update input generation helper to use new input names

• Update tests to match new circuits

Type of Change

Please delete options that are not relevant.

• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [x] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [ ] This change requires a documentation update

Checklist:

• [ ] I have discussed with the team prior to submitting this PR
• [ ] I have performed a self-review of my code
• [ ] I have commented my code, particularly in hard-to-understand areas
• [ ] My changes generate no new warnings
• [ ] New and existing unit tests pass locally with my changes

[socket-security[bot]]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/circom_tester@0.0.20	filesystem, shell	0	33.6 kB	jbaylina

🚮 Removed packages: npm/child_process@1.0.2, npm/circom_tester@0.0.19

View full report↗︎