feat(docs): applied structure feedback #9288
Conversation
Docs PreviewHey there! 👋 You can check your preview at https://674d9850c22aade4ba8e2a95--aztec-docs-dev.netlify.app |
docs/docs/guides/developer_guides/smart_contracts/writing_contracts/call_functions.md
Outdated
Show resolved
Hide resolved
| @@ -1,17 +1,20 @@ | |||
| --- | |||
| id: index | |||
| sidebar_position: 0 | |||
| title: Guides | |||
| title: Guides and Tutorials | |||
There was a problem hiding this comment.
It would be good to get Rafi and David to take a glance at this page (https://6745d8432cc71f5fffa51888--aztec-docs-dev.netlify.app/guides) and provide their input based on their conversations with devs.
docs/docs/tutorials/codealong/contract_tutorials/crowdfunding_contract.md
Outdated
Show resolved
Hide resolved
docs/docs/tutorials/codealong/js_tutorials/simple_dapp/4_testing.md
Outdated
Show resolved
Hide resolved
|
lets get this merged @critesjosh but i think based on feedback after hackerhouse i want to merge references & guides again, just split by learn and build. will be a smaller lift after this |
| @@ -20,50 +23,71 @@ This page outlines Aztec's fundamental technical concepts. | |||
| 5. The Public VM rolls up the private & public transaction rollups | |||
| 6. These rollups are submitted to Ethereum | |||
|
|
|||
| ## Private and public execution | |||
|
|
|||
| Private functions and public functions are executed in different environments. | |||
There was a problem hiding this comment.
| Private functions and public functions are executed in different environments. | |
| Private functions are executed client side, on user devices to maintain maximum privacy. Public functions are executed by a remote network of nodes, similar to other blockchains. These distinct execution environments create a directional execution flow for a single transaction--a transaction begins in the private context on the user's device then moves to the public network. This means that private functions executed by a transaction can enqueue public functions to be executed later in the transaction life cycle, but public functions cannot call private functions. |
|
|
||
| ## High level view | ||
|
|
||
| <Image img={require("/img/aztec-high-level.png")} /> | ||
|
|
||
| 1. A user interacts with Aztec through Aztec.js (like web3js or ethersjs) | ||
| 2. Private functions are executed in the PXE, which is client-side |
There was a problem hiding this comment.
In the following line "They are rolled up and sent to the Public VM (running on an Aztec node)".
I don't think it's correct to say that transactions are rolled up and sent to the public VM. I think it would be more accurate just to say that proofs and note hash and nullifier tree updates are sent to the public VM
| @@ -20,50 +23,71 @@ This page outlines Aztec's fundamental technical concepts. | |||
| 5. The Public VM rolls up the private & public transaction rollups | |||
There was a problem hiding this comment.
| 5. The Public VM rolls up the private & public transaction rollups | |
| 5. The Public VM rolls up the transactions that include private and public state updates into blocks |
| @@ -20,50 +23,71 @@ This page outlines Aztec's fundamental technical concepts. | |||
| 5. The Public VM rolls up the private & public transaction rollups | |||
| 6. These rollups are submitted to Ethereum | |||
There was a problem hiding this comment.
| 6. These rollups are submitted to Ethereum | |
| 6. The block data and proof of a correct state transition are submitted to Ethereum for verification |
Closes AztecProtocol/dev-rel#346
Closes AztecProtocol/dev-rel#415
Closes AztecProtocol/dev-rel#353
Closes AztecProtocol/dev-rel#429