Docs: Add high level info about transaction lifecycle #3764
Assignees
Labels
Comments
critesjosh
added
A-documentation
This was referenced Dec 21, 2023
critesjosh
added a commit
that referenced
this issue
Jan 8, 2024
- Include a high level overview in Foundational Concepts of the transaction lifecycle. - formatting the common patterns page - added a note about a generic error to the Debugging page Closes #3764 # Checklist: Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge. - [x] If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag. - [ ] I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code. - [x] Every change is related to the PR description. - [ ] I have [linked](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) this pull request to relevant issues (if any exist).
michaelelliot
pushed a commit
to Swoir/noir_rs
that referenced
this issue
Feb 28, 2024
- Include a high level overview in Foundational Concepts of the transaction lifecycle. - formatting the common patterns page - added a note about a generic error to the Debugging page Closes AztecProtocol#3764 # Checklist: Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge. - [x] If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag. - [ ] I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code. - [x] Every change is related to the PR description. - [ ] I have [linked](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) this pull request to relevant issues (if any exist).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Feedback:
One section I believe could improve developers', and even users', understanding/intuition of the private inner workings of Aztec is one dedicated to explaining what happens, for example, when a user calls a private function in a very thorough yet ELI5 way. When I say thorough, I mean explaining every piece involved in the interaction, from the user device to the wallet to the trees, and so on - the complete flow of what takes place when a function is called. The best example of this, and where I got the idea from, is this article by Tincho Abbate: https://www.notonlyowner.com/learn/what-happens-when-you-send-one-dai. His article is excellent albeit very long, I'm suggesting something more concise but with a similar concept: explaining most of what happens under the hood in an easy-to-understand way, unifying the entire flow, which should allow for improving intuition.
The text was updated successfully, but these errors were encountered: