Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General specs cleanup for consistency and completeness #69

Closed
cwgoes opened this issue Jul 2, 2023 · 3 comments
Closed

General specs cleanup for consistency and completeness #69

cwgoes opened this issue Jul 2, 2023 · 3 comments
Assignees

Comments

@cwgoes
Copy link
Contributor

cwgoes commented Jul 2, 2023

The specs still need a lot of cleanup in order to be readable as a clear standalone document. In particular:

  • the language was clearly written by different people and often differs in tone, tense, and style; it should be standardised
  • subsections differ in levels of abstraction - some are high-level and others contain lots of implementation details
  • some old names persist (e.g. "burn & mint")
  • specification should be reviewed alongside code to check for correspondence
@cwgoes
Copy link
Contributor Author

cwgoes commented Jul 4, 2023

Notes/questions from readthrough:

  • Governance, multitoken, and multisignature (established accounts) should probably just get their own sections.
  • Are we still using the block space allocator?
  • MASP section
    • Include an abstract definition from the cryptographic spec
    • Clearly describe validity predicate correctness conditions
    • Combine burn & mint / convert circuit sections
    • Move trusted setup docs somewhere else (and link to them)
  • Ethereum bridge
    • Appears to be a lot of duplication between the top-level section and the sub-section content
  • IBC
    • Should define IBC validity predicate correctness conditions
  • Proof-of-stake
    • Section content needs to be updated
  • Shielded pool incentives
    • Should define MASP incentives validity predicate correctness conditions

@sug0
Copy link

sug0 commented Jul 26, 2023

  • Ethereum bridge
  • Block space allocator
    • We are still using it, but its specs are outdated, as they do not mention gas fees, and the order of allocation is wrong (we now allocate encrypted, then decrypted and finally protocol txs, in this order)

@cwgoes
Copy link
Contributor Author

cwgoes commented May 18, 2024

Closing in favor of #277.

@cwgoes cwgoes closed this as completed May 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants