@aztec/simulator v0.38.0

Simulator

Responsibilities

This library package is responsible for simulating function circuits compiled to ACIR / AVM.

Simulating a function implies generating the partial witness and the public inputs of the function, as well as collecting all the data (such as created notes or nullifiers, or state changes) that are necessary for components upstream.

It's able to simulate three different types of functions:

Private 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.

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

Private functions can call another private function, and can request to call a public function, but the public function execution will be performed by the sequencer asynchronously, thus having no access to the return values.

Public Functions

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.

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.

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 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.

At the moment, unconstrained functions cannot call any other function. It would be possible to allow them to call other unconstrained functions.

Usage

Development

Same steps as any other library. They are detailed here

Testing

Same steps as any other library. They are detailed here