search

reclaimprotocol / circom-symmetric-crypto

A circom library for zero-knowledge proofs of symmetric encryption key ownership without key revelation.
3 stars 1 forks source link

Refactor CONFIG object for better maintainability #3

Open adithyaakrishna opened 4 days ago

adithyaakrishna commented 4 days ago

The CONFIG object in config.ts contains configuration for different encryption algorithms. Refactoring this object could improve maintainability and readability.

Tasks:

  1. Create separate configuration objects for each encryption algorithm (chacha20, aes-256-ctr, aes-128-ctr).
  2. Use a factory function or a class to generate these configuration objects.
  3. Implement type checking for the configuration objects.
  4. Add comments explaining the purpose of each configuration property.
  5. Consider using TypeScript interfaces to define the structure of the configuration objects.

Refactoring the CONFIG object will make it easier to add new encryption algorithms in the future and improve code organization.

Contributors: Please note that by submitting a pull request, you are agreeing to accept and sign the Contributor License Agreement (CLA) found at https://github.com/reclaimprotocol/.github/blob/main/CLA.md

varun-doshi commented 2 days ago

I'd like to take this up

adithyaakrishna commented 2 days ago

@varun-doshi Assigned to you :)