Skip to content

docs: more docs typos #19701

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.

Sign up for GitHub

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

Draft
dbanks12 wants to merge 1 commit into
base: merge-train/avm
Choose a base branch
from
+4 −4
Draft

docs: more docs typos #19701

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions yarn-project/simulator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ It's able to simulate three different types of functions:

Private functions are simulated and proved client-side, and verified client-side in the private kernel circuit.

The public inputs of private functions is defined [here](../stdlib/src/structs/private_circuit_public_inputs.ts).
The public inputs of private functions are defined [here](../stdlib/src/structs/private_circuit_public_inputs.ts).

They are run with the assistance of a DB oracle that provides any private data requested by the function.

Expand All @@ -22,17 +22,17 @@ Private functions can call another private function, and can request to call a p

Public functions are simulated and proved on the sequencer side, and verified by the public kernel circuit.

The public inputs of public functions is defined [here](../stdlib/src/structs/avm/avm_circuit_public_inputs.ts).
The public inputs of public functions are defined [here](../stdlib/src/structs/avm/avm_circuit_public_inputs.ts).

They are run with the assistance of an oracle that provides any value read from the public state tree.

Public functions can call other public function, but no private functions.
Public functions can call other public functions, but cannot call private functions.

See the specifications of the [Aztec Virtual Machine (AVM) for public execution](./docs/avm/index.md).

### Unconstrained Functions

Unconstrained functions are useful to extract useful data for users that could produce very large execution traces - such as the summed balance of all a users notes
Unconstrained functions are useful to extract data for users that could produce very large execution traces - such as the summed balance of all of a user's notes.
They are not proved, and are simulated client-side.

They are run with the assistance of a DB oracle that provides any private data requested by the function.
Expand Down
Loading