summa-dev / eip-draft

0 stars 1 forks source link

TODOs before Submitting as an EIP #1

Open adrianmcli opened 1 year ago

adrianmcli commented 1 year ago

TODOs as of 2023-10-19:

  1. Authorship Clarification: Discuss and decide who should be listed as authors based on their contributions.
  2. Core Circuits Expansion: Provide more details on the core circuits within the Specification section.
  3. Test Cases Addition:
    • Include tests for function inputs, both valid and invalid.
    • Test event emissions for correctness.
    • Test the ZK proof verification functionality.
  4. Security Considerations Expansion:
    • Detail potential risks and mitigation strategies concerning ZK proofs implementation.
    • Address security implications of off-chain verification.
    • Discuss error handling and potential exploitation by malicious actors.
    • Address dependency security and potential reentrancy attacks.
  5. Placeholder Text Removal: Replace or remove all placeholder text throughout the document.
  6. Community Engagement: Engage with the community on the provided discussion link to gather feedback.
  7. Final Compliance Review: Conduct a final review to ensure the document complies with EIP-1 guidelines.

Initial Steps (for reference)

According to the official README of the EIPs repo, we need to do the following:

Let's also keep this in mind:

It is highly recommended that a single EIP contain a single key proposal or new idea. The more focused the EIP, the more successful it tends to be.

adrianmcli commented 1 year ago

I have created 4 more issues to detail things that need to be complete before we submit the PR for an EIP number: