Skip to content
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

Jump to bottom

docs(yellow-paper): changes to circuit sections #4616

Merged
merged 11 commits into from
Mar 1, 2024
Merged

docs(yellow-paper): changes to circuit sections #4616

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3e55f52
Rename read_requests to note_hash_read_requests.
LeilaWang Feb 8, 2024
d640d3c
Add nullifier_read_requests.
LeilaWang Feb 10, 2024
6d7347a
Consolidate read requests.
LeilaWang Feb 10, 2024
902f7ca
Rename variables for nullifier key validation requests.
LeilaWang Feb 10, 2024
fd22a3b
Update function type and remove unnecessary checks.
LeilaWang Feb 10, 2024
7c42402
Update counters and call requests and various stuffs.
LeilaWang Feb 13, 2024
bf8b89d
Use constants in types.
LeilaWang Feb 14, 2024
3a0ee28
Change counter to u32.
LeilaWang Feb 15, 2024
48a2e0d
Merge remote-tracking branch 'origin/master' into lw/yp_circuits
LeilaWang Feb 21, 2024
ddc4051
Update counters and splitting accumulated data.
LeilaWang Mar 1, 2024
68a5eac
Merge remote-tracking branch 'origin/master' into lw/yp_circuits
LeilaWang Mar 1, 2024
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
91 changes: 51 additions & 40 deletions yellow-paper/docs/circuits/private-function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,33 +38,28 @@ Some tweaks might be needed following this discussion: https://docs.google.com/s

The public inputs of _every_ private function _must_ adhere to the following ABI:

| Field | Type | Description |
| ----------------------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `call_context` | [`CallContext`](#callcontext) | Context of the call corresponding to this function execution. |
| `args_hash` | `field` | Hash of the function arguments. |
| `return_values` | `[field; C]` | Return values of this function call. |
| `read_requests` | [`[ReadRequest; C]`](#readrequest) | Requests to read notes in the note hash tree. |
| `nullifier_key_validation_requests` | [`[NullifierKeyValidationRequest]; C]`](#nullifierkeyvalidationrequest) | Requests to validate nullifier keys used in this function call. |
| `note_hashes` | [`[NoteHash; C]`](#notehash) | New note hashes created in this function call. |
| `nullifiers` | [`[Nullifier; C]`](#nullifier) | New nullifiers created in this function call. |
| `l2_to_l1_messages` | `[field; C]` | New L2 to L1 messages created in this function call. |
| `unencrypted_log_hashes` | [`[UnencryptedLogHash; C]`](#unencryptedloghash) | Hashes of the unencrypted logs emitted in this function call. |
| `encrypted_log_hashes` | [`[EncryptedLogHash; C]`](#encryptedloghash) | Hashes of the encrypted logs emitted in this function call. |
| `encrypted_note_preimage_hashes` | [`[EncryptedNotePreimageHash]; C]`](#encryptednotepreimagehash) | Hashes of the encrypted note preimages emitted in this function call. |
| `private_call_stack_item_hashes` | `[field; C]` | Hashes of the private function calls initiated by this function. |
| `public_call_stack_item_hashes` | `[field; C]` | Hashes of the public function calls initiated by this function. |
| `block_header` | [`BlockHeader`](#blockheader) | Information about the trees used for the transaction. |
| `chain_id` | `field` | Chain ID of the transaction. |
| `version` | `field` | Version of the transaction. |
| Field | Type | Description |
| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `call_context` | [`CallContext`](#callcontext) | Context of the call corresponding to this function execution. |
| `args_hash` | `field` | Hash of the function arguments. |
| `return_values` | [`field`; [`RETURN_VALUES_LENGTH`](../constants.md#circuit-constants)] | Return values of this function call. |
| `note_hashes` | [[`NoteHash`](#notehash); [`MAX_NEW_NOTE_HASHES_PER_CALL`](../constants.md#circuit-constants)] | New note hashes created in this function call. |
| `nullifiers` | [[`Nullifier`](#nullifier); [`MAX_NEW_NULLIFIERS_PER_CALL`](../constants.md#circuit-constants)] | New nullifiers created in this function call. |
| `l2_to_l1_messages` | [`field`; [`MAX_NEW_L2_TO_L1_MSGS_PER_CALL`](../constants.md#circuit-constants)] | New L2 to L1 messages created in this function call. |
| `unencrypted_log_hashes` | [[`UnencryptedLogHash`](#unencryptedloghash); [`MAX_UNENCRYPTED_LOG_HASHES_PER_CALL`](../constants.md#circuit-constants)] | Hashes of the unencrypted logs emitted in this function call. |
| `encrypted_log_hashes` | [[`EncryptedLogHash`](#encryptedloghash); [`MAX_ENCRYPTED_LOG_HASHES_PER_CALL`](../constants.md#circuit-constants)] | Hashes of the encrypted logs emitted in this function call. |
| `encrypted_note_preimage_hashes` | [[`EncryptedNotePreimageHash`](#encryptednotepreimagehash); [`MAX_ENCRYPTED_NOTE_PREIMAGE_HASHES_PER_CALL`](../constants.md#circuit-constants)] | Hashes of the encrypted note preimages emitted in this function call. |
| `note_hash_read_requests` | [[`ReadRequest`](#readrequest); [`MAX_NOTE_HASH_READ_REQUESTS_PER_CALL`](../constants.md#circuit-constants)] | Requests to prove the note hashes being read exist. |
| `nullifier_read_requests` | [[`ReadRequest`](#readrequest); [`MAX_NULLIFIER_READ_REQUESTS_PER_CALL`](../constants.md#circuit-constants)] | Requests to prove the nullifiers being read exist. |
| `nullifier_key_validation_requests` | [[`ParentSecretKeyValidationRequest`](#parentsecretkeyvalidationrequest); [`MAX_NULLIFIER_KEY_VALIDATION_REQUESTS_PER_CALL`](../constants.md#circuit-constants)] | Requests to validate nullifier keys used in this function call. |
| `public_call_requests` | [[`PublicCallRequest`](#publiccallrequest); [`MAX_PUBLIC_CALL_STACK_LENGTH_PER_CALL`](../constants.md#circuit-constants)] | Requests to call public functions. |
| `private_call_requests` | [[`PrivateCallRequest`](#privatecallrequest); [`MAX_PRIVATE_CALL_STACK_LENGTH_PER_CALL`](../constants.md#circuit-constants)] | Requests to call Private functions. |
| `block_header` | [`BlockHeader`](#blockheader) | Information about the trees used for the transaction. |
| `chain_id` | `field` | Chain ID of the transaction. |
| `version` | `field` | Version of the transaction. |

After generating a proof for a private function circuit, that proof (and associated public inputs) will be passed-into a private kernel circuit as private inputs. Private kernel circuits use the private function's proof, public inputs, and verification key, to verify the correct execution of the private function. Private kernel circuits then perform a number of checks and computations on the private function's public inputs.

> The above `C`s represent constants defined by the protocol. Each `C` might have a different value from the others.

<!--
TODO: use different values for each constant, instead of `C`, so that this document is as precise as possible.
-->

## Types

### `CallContext`
Expand All @@ -77,22 +72,6 @@ TODO: use different values for each constant, instead of `C`, so that this docum
| `is_delegate_call` | `bool` | A flag indicating whether the call is a [delegate call](../calls/delegate-calls.md). |
| `is_static_call` | `bool` | A flag indicating whether the call is a [static call](../calls/static-calls.md). |

### `ReadRequest`

| Field | Type | Description |
| ----------- | ------- | -------------------------------------- |
| `note_hash` | `field` | Hash of the note to be read. |
| `counter` | `field` | Counter at which the request was made. |

### `NullifierKeyValidationRequest`

<!-- These types might be wrong. The public key needs to be some encoding of a grumpkin point. The secret key needs to be an Fq field instead of an Fr field. -->

| Field | Type | Description |
| ------------ | ------- | -------------------------------------------------------------------- |
| `public_key` | `field` | Nullifier public key of an account. |
| `secret_key` | `field` | Nullifier secret key of an account siloed with the contract address. |

### `NoteHash`

| Field | Type | Description |
Expand Down Expand Up @@ -136,6 +115,38 @@ TODO: use different values for each constant, instead of `C`, so that this docum
| `counter` | `field` | Counter at which the hash was emitted. |
| `note_hash_counter` | `field` | Counter of the corresponding note hash. |

### `ReadRequest`

| Field | Type | Description |
| ------------------ | -------------- | ---------------------------------------------- |
| `value` | `field` | Value being read. |
| `contract_address` | `AztecAddress` | Address of the contract the value was created. |
| `counter` | `field` | Counter at which the request was made. |

### `ParentSecretKeyValidationRequest`

| Field | Type | Description |
| --------------------------- | --------------- | -------------------------------------------- |
| `parent_public_key` | `GrumpkinPoint` | Claimed parent public key of the secret key. |
| `hardened_child_secret_key` | `fq` | Secret key passed to the function. |

### `PublicCallRequest`

| Field | Type | Description |
| ---------------------- | ------- | -------------------------------------- |
| `call_stack_item_hash` | `field` | Hash of the call stack item. |
| `counter` | `field` | Counter at which the request was made. |

<!-- TODO: change call_stack_item_hash to actual data for the public call request -->

### `PrivateCallRequest`

| Field | Type | Description |
| ---------------------- | ------- | ---------------------------------------- |
| `call_stack_item_hash` | `field` | Hash of the call stack item. |
| `counter_start` | `field` | Counter at which the call was initiated. |
| `counter_end` | `field` | Counter at which the call ended. |

### `BlockHeader`

| Field | Type | Description |
Expand Down
Loading
Loading