-
Notifications
You must be signed in to change notification settings - Fork 4
docs: block productino #84
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
base: dev
Are you sure you want to change the base?
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work! The information provided looks complete and concise!
I’ve left a few comments, mostly small things around typos and phrasing.
Fixes the bug describe in #84 (comment) <img width="286" height="356" alt="Screenshot 2025-09-30 at 10 39 43 AM" src="https://github.com/user-attachments/assets/7436ff74-a45e-4298-ab43-6d34e166b504" />
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, great writing, Minim! I left some comments, and in general I feel like a quite more verbose writing, more blog-ish. I think we could improve that : )
@@ -0,0 +1,65 @@ | |||
# Overview | |||
|
|||
Aztec is a Zero-Knowledge SNARK L2. The blockchain's state is committed to in an L1 contract known |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure 'zero-knowledge SNARK L2' is the best phrasing. Since readers have already seen the overview, they likely know what Aztec is. I suggest rephrasing the paragraph to: ‘As Aztec is a L2, its state resides in a Layer 1 contract called the rollup contract. When updating the state, this contract requires a valid zk-proof of the state transition.’
an entire epoch. Once an epoch's proof is submitted and accepted by the contract, the epoch is | ||
finalized and no Aztec reorg can happen unless the L1 itself reorgs. | ||
|
||
Aztec block production can be divided into four parts: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can break down Aztec's block production into four distinct stages: ... I would try to make the general tone more conversational. You are telling a story, a technical one, but still!
|
||
### Transaction propagation | ||
|
||
Users' PXEs produce and gossip `Tx` objects. Amongst other information, these contain: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PXEs produce and share Tx
objects, which include the following information:
- The ZK proof for the private execution | ||
- The enqueued public calls | ||
|
||
These are gossiped to at least one node. Uppon receival of a `Tx` object, a node checks its validity |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rephrase, maybe: These transactions are gossiped to at least one node. Once a node receives a Tx
object, it verifies its validity and then forwards it to its known peers. This process forms a mempool *, which consists of transactions awaiting execution. The validity check confirms that the ZK proof for private execution is correct and that fees will be paid appropriately.
- We should link the concept of mempool.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
Roughly, when a new epoch begins | ||
|
||
1) A random committee is elected from the validator set |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A random comitte... how random?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we can add a callout with a nerd snipping note about how this is done, or link to an external source, or link to the section in our docs where we explain it
- [Aztec's Block Production System](https://forum.aztec.network/t/request-for-comments-aztecs-block-production-system/6155) | ||
|
||
### Source code | ||
- [Tx object](https://github.com/AztecProtocol/aztec-packages/blob/286fbfae25b173d372164eedd7b22926eac32b2a/yarn-project/stdlib/src/tx/tx.ts#L27) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Incluiding sources is cool, but let's try to link them in the moment they are mentioned.
|
||
## References | ||
|
||
### Source code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add the links directly when each file is mentioned. This section looooks good
No description provided.