Skip to content

feat: throw compile error if read/write public state from private#2804

Merged
LHerskind merged 2 commits into
masterfrom
lh/throw_compile_err_if_private_fn_uses_public_state
Oct 12, 2023
Merged

feat: throw compile error if read/write public state from private#2804
LHerskind merged 2 commits into
masterfrom
lh/throw_compile_err_if_private_fn_uses_public_state

Conversation

@LHerskind

Copy link
Copy Markdown
Contributor

Currently if accessing public state from private functions you will only get an error at runtime. This pr changes such that you will receive a compile-time error instead.

Checklist:

Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.

  • If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag.
  • I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code.
  • Every change is related to the PR description.
  • I have linked this pull request to relevant issues (if any exist).

@LHerskind LHerskind requested a review from sirasistant October 11, 2023 17:21
@LHerskind

Copy link
Copy Markdown
Contributor Author

Initially only allowed public to read. But need to disallow private instead. Reason being that unconstrained functions should be allowed to read from public storage even though it is not a public function.

@AztecBot

Copy link
Copy Markdown
Collaborator

Benchmark results

All benchmarks are run on txs on the Benchmarking contract on the repository. Each tx consists of a batch call to create_note and increment_balance, which guarantees that each tx has a private call, a nested private call, a public call, and a nested public call, as well as an emitted private note, an unencrypted log, and public storage read and write.

This benchmark source data is available in JSON format on S3 here.

Values are compared against data from master at commit 6d855270 and shown if the difference exceeds 1%.

L2 block published to L1

Each column represents the number of txs on an L2 block published to L1.

Metric 8 txs 32 txs 128 txs
l1_rollup_calldata_size_in_bytes 45,444 179,588 716,132
l1_rollup_calldata_gas 222,996 868,280 3,449,708
l1_rollup_execution_gas 842,083 3,595,388 22,205,077
l2_block_processing_time_in_ms 1,016 (-4%) 3,928 (-4%) 15,312 (-5%)
note_successful_decrypting_time_in_ms 324 (-2%) 1,009 (-3%) 3,687 (-5%)
note_trial_decrypting_time_in_ms ⚠️ 26.0 (-21%) 108 (+1%) 137 (-1%)
l2_block_building_time_in_ms 8,956 (-4%) 35,919 (-3%) 149,838 (-4%)
l2_block_rollup_simulation_time_in_ms 6,642 (-4%) 26,646 (-3%) 105,257 (-4%)
l2_block_public_tx_process_time_in_ms 2,271 (-2%) 9,149 (-2%) 43,793 (-4%)

L2 chain processing

Each column represents the number of blocks on the L2 chain where each block has 16 txs.

Metric 5 blocks 10 blocks
node_history_sync_time_in_ms 14,421 (-3%) 31,571 (-2%)
note_history_successful_decrypting_time_in_ms 2,336 (-3%) 4,784 (-3%)
note_history_trial_decrypting_time_in_ms 122 (+1%) 146 (-1%)
node_database_size_in_bytes 1,650,157 1,196,023
pxe_database_size_in_bytes 27,188 54,187

Circuits stats

Stats on running time and I/O sizes collected for every circuit run across all benchmarks.

Circuit circuit_simulation_time_in_ms circuit_input_size_in_bytes circuit_output_size_in_bytes
private-kernel-init 43.8 (-2%) 56,577 14,745
private-kernel-ordering 21.1 (-3%) 20,137 8,089
base-rollup 851 (-1%) 631,605 811
root-rollup 37.9 (-1%) 4,072 1,097
private-kernel-inner 35.8 (-6%) 72,288 14,745
public-kernel-private-input 47.1 (-2%) 37,359 14,745
public-kernel-non-first-iteration 28.0 (-4%) 37,401 14,745
merge-rollup ⚠️ 0.870 (-12%) 2,592 873

@LHerskind LHerskind merged commit a3649df into master Oct 12, 2023
@LHerskind LHerskind deleted the lh/throw_compile_err_if_private_fn_uses_public_state branch October 12, 2023 08:41
PhilWindle pushed a commit that referenced this pull request Oct 13, 2023
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-packages: 0.8.11</summary>

##
[0.8.11](aztec-packages-v0.8.10...aztec-packages-v0.8.11)
(2023-10-13)


### Features

* **archiver:** Use registry to fetch searchStartBlock
([#2830](#2830))
([e5bc067](e5bc067))
* Configure sandbox for network
([#2818](#2818))
([d393a59](d393a59))
* **docker-sandbox:** Allow forks in sandbox
([#2831](#2831))
([ed8431c](ed8431c)),
closes
[#2726](#2726)
* Goblin Translator Decomposition relation (Goblin Translator part 4)
([#2802](#2802))
([3c3cd9f](3c3cd9f))
* Goblin Translator GenPermSort relation (Goblin Translator part 3)
([#2795](#2795))
([b36fdc4](b36fdc4))
* Goblin translator opcode constraint and accumulator transfer relations
(Goblin Translator part 5)
([#2805](#2805))
([b3d1f28](b3d1f28))
* Goblin Translator Permutation relation (Goblin Translator part 2)
([#2790](#2790))
([9a354c9](9a354c9))
* Integrate ZeroMorph into Honk
([#2774](#2774))
([ea86869](ea86869))
* Purge non native token + reorder params in token portal
([#2723](#2723))
([447dade](447dade))
* Throw compile error if read/write public state from private
([#2804](#2804))
([a3649df](a3649df))
* Unencrypted log filtering
([#2600](#2600))
([7ae554a](7ae554a)),
closes
[#1498](#1498)
[#1500](#1500)
* Update goblin translator circuit builder (Goblin Translator part 1)
([#2764](#2764))
([32c69ae](32c69ae))


### Bug Fixes

* Outdated `noir:clean`
([#2821](#2821))
([2ea199f](2ea199f))


### Miscellaneous

* Benchmark tx sizes in p2p pool
([#2810](#2810))
([f63219c](f63219c))
* Change acir_tests branch to point to master
([#2815](#2815))
([73f229d](73f229d))
* Fix typo
([#2839](#2839))
([5afdf91](5afdf91))
* From &lt; genesis allowed in getBlocks
([#2816](#2816))
([5622b50](5622b50))
* Remove Ultra Grumpkin flavor
([#2825](#2825))
([bde77b8](bde77b8))
* Remove work queue from honk
([#2814](#2814))
([bca7d12](bca7d12))
* Spell check
([#2817](#2817))
([4777a11](4777a11))


### Documentation

* Slight changes to update portal page
([#2799](#2799))
([eb65819](eb65819))
* Update aztec_connect_sunset.mdx
([#2808](#2808))
([5f659a7](5f659a7))
</details>

<details><summary>barretenberg.js: 0.8.11</summary>

##
[0.8.11](barretenberg.js-v0.8.10...barretenberg.js-v0.8.11)
(2023-10-13)


### Miscellaneous

* **barretenberg.js:** Synchronize aztec-packages versions
</details>

<details><summary>barretenberg: 0.8.11</summary>

##
[0.8.11](barretenberg-v0.8.10...barretenberg-v0.8.11)
(2023-10-13)


### Features

* Goblin Translator Decomposition relation (Goblin Translator part 4)
([#2802](#2802))
([3c3cd9f](3c3cd9f))
* Goblin Translator GenPermSort relation (Goblin Translator part 3)
([#2795](#2795))
([b36fdc4](b36fdc4))
* Goblin translator opcode constraint and accumulator transfer relations
(Goblin Translator part 5)
([#2805](#2805))
([b3d1f28](b3d1f28))
* Goblin Translator Permutation relation (Goblin Translator part 2)
([#2790](#2790))
([9a354c9](9a354c9))
* Integrate ZeroMorph into Honk
([#2774](#2774))
([ea86869](ea86869))
* Update goblin translator circuit builder (Goblin Translator part 1)
([#2764](#2764))
([32c69ae](32c69ae))


### Miscellaneous

* Change acir_tests branch to point to master
([#2815](#2815))
([73f229d](73f229d))
* Remove Ultra Grumpkin flavor
([#2825](#2825))
([bde77b8](bde77b8))
* Remove work queue from honk
([#2814](#2814))
([bca7d12](bca7d12))
* Spell check
([#2817](#2817))
([4777a11](4777a11))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
AztecBot added a commit to AztecProtocol/barretenberg that referenced this pull request Oct 14, 2023
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-packages: 0.8.11</summary>

##
[0.8.11](AztecProtocol/aztec-packages@aztec-packages-v0.8.10...aztec-packages-v0.8.11)
(2023-10-13)


### Features

* **archiver:** Use registry to fetch searchStartBlock
([#2830](AztecProtocol/aztec-packages#2830))
([e5bc067](AztecProtocol/aztec-packages@e5bc067))
* Configure sandbox for network
([#2818](AztecProtocol/aztec-packages#2818))
([d393a59](AztecProtocol/aztec-packages@d393a59))
* **docker-sandbox:** Allow forks in sandbox
([#2831](AztecProtocol/aztec-packages#2831))
([ed8431c](AztecProtocol/aztec-packages@ed8431c)),
closes
[#2726](AztecProtocol/aztec-packages#2726)
* Goblin Translator Decomposition relation (Goblin Translator part 4)
([#2802](AztecProtocol/aztec-packages#2802))
([3c3cd9f](AztecProtocol/aztec-packages@3c3cd9f))
* Goblin Translator GenPermSort relation (Goblin Translator part 3)
([#2795](AztecProtocol/aztec-packages#2795))
([b36fdc4](AztecProtocol/aztec-packages@b36fdc4))
* Goblin translator opcode constraint and accumulator transfer relations
(Goblin Translator part 5)
([#2805](AztecProtocol/aztec-packages#2805))
([b3d1f28](AztecProtocol/aztec-packages@b3d1f28))
* Goblin Translator Permutation relation (Goblin Translator part 2)
([#2790](AztecProtocol/aztec-packages#2790))
([9a354c9](AztecProtocol/aztec-packages@9a354c9))
* Integrate ZeroMorph into Honk
([#2774](AztecProtocol/aztec-packages#2774))
([ea86869](AztecProtocol/aztec-packages@ea86869))
* Purge non native token + reorder params in token portal
([#2723](AztecProtocol/aztec-packages#2723))
([447dade](AztecProtocol/aztec-packages@447dade))
* Throw compile error if read/write public state from private
([#2804](AztecProtocol/aztec-packages#2804))
([a3649df](AztecProtocol/aztec-packages@a3649df))
* Unencrypted log filtering
([#2600](AztecProtocol/aztec-packages#2600))
([7ae554a](AztecProtocol/aztec-packages@7ae554a)),
closes
[#1498](AztecProtocol/aztec-packages#1498)
[#1500](AztecProtocol/aztec-packages#1500)
* Update goblin translator circuit builder (Goblin Translator part 1)
([#2764](AztecProtocol/aztec-packages#2764))
([32c69ae](AztecProtocol/aztec-packages@32c69ae))


### Bug Fixes

* Outdated `noir:clean`
([#2821](AztecProtocol/aztec-packages#2821))
([2ea199f](AztecProtocol/aztec-packages@2ea199f))


### Miscellaneous

* Benchmark tx sizes in p2p pool
([#2810](AztecProtocol/aztec-packages#2810))
([f63219c](AztecProtocol/aztec-packages@f63219c))
* Change acir_tests branch to point to master
([#2815](AztecProtocol/aztec-packages#2815))
([73f229d](AztecProtocol/aztec-packages@73f229d))
* Fix typo
([#2839](AztecProtocol/aztec-packages#2839))
([5afdf91](AztecProtocol/aztec-packages@5afdf91))
* From &lt; genesis allowed in getBlocks
([#2816](AztecProtocol/aztec-packages#2816))
([5622b50](AztecProtocol/aztec-packages@5622b50))
* Remove Ultra Grumpkin flavor
([#2825](AztecProtocol/aztec-packages#2825))
([bde77b8](AztecProtocol/aztec-packages@bde77b8))
* Remove work queue from honk
([#2814](AztecProtocol/aztec-packages#2814))
([bca7d12](AztecProtocol/aztec-packages@bca7d12))
* Spell check
([#2817](AztecProtocol/aztec-packages#2817))
([4777a11](AztecProtocol/aztec-packages@4777a11))


### Documentation

* Slight changes to update portal page
([#2799](AztecProtocol/aztec-packages#2799))
([eb65819](AztecProtocol/aztec-packages@eb65819))
* Update aztec_connect_sunset.mdx
([#2808](AztecProtocol/aztec-packages#2808))
([5f659a7](AztecProtocol/aztec-packages@5f659a7))
</details>

<details><summary>barretenberg.js: 0.8.11</summary>

##
[0.8.11](AztecProtocol/aztec-packages@barretenberg.js-v0.8.10...barretenberg.js-v0.8.11)
(2023-10-13)


### Miscellaneous

* **barretenberg.js:** Synchronize aztec-packages versions
</details>

<details><summary>barretenberg: 0.8.11</summary>

##
[0.8.11](AztecProtocol/aztec-packages@barretenberg-v0.8.10...barretenberg-v0.8.11)
(2023-10-13)


### Features

* Goblin Translator Decomposition relation (Goblin Translator part 4)
([#2802](AztecProtocol/aztec-packages#2802))
([3c3cd9f](AztecProtocol/aztec-packages@3c3cd9f))
* Goblin Translator GenPermSort relation (Goblin Translator part 3)
([#2795](AztecProtocol/aztec-packages#2795))
([b36fdc4](AztecProtocol/aztec-packages@b36fdc4))
* Goblin translator opcode constraint and accumulator transfer relations
(Goblin Translator part 5)
([#2805](AztecProtocol/aztec-packages#2805))
([b3d1f28](AztecProtocol/aztec-packages@b3d1f28))
* Goblin Translator Permutation relation (Goblin Translator part 2)
([#2790](AztecProtocol/aztec-packages#2790))
([9a354c9](AztecProtocol/aztec-packages@9a354c9))
* Integrate ZeroMorph into Honk
([#2774](AztecProtocol/aztec-packages#2774))
([ea86869](AztecProtocol/aztec-packages@ea86869))
* Update goblin translator circuit builder (Goblin Translator part 1)
([#2764](AztecProtocol/aztec-packages#2764))
([32c69ae](AztecProtocol/aztec-packages@32c69ae))


### Miscellaneous

* Change acir_tests branch to point to master
([#2815](AztecProtocol/aztec-packages#2815))
([73f229d](AztecProtocol/aztec-packages@73f229d))
* Remove Ultra Grumpkin flavor
([#2825](AztecProtocol/aztec-packages#2825))
([bde77b8](AztecProtocol/aztec-packages@bde77b8))
* Remove work queue from honk
([#2814](AztecProtocol/aztec-packages#2814))
([bca7d12](AztecProtocol/aztec-packages@bca7d12))
* Spell check
([#2817](AztecProtocol/aztec-packages#2817))
([4777a11](AztecProtocol/aztec-packages@4777a11))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants