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.

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

feat: detect unknown note type ids in compute_note_hash #5086

Merged
merged 2 commits into from
Mar 8, 2024

Conversation

nventuro
Copy link
Contributor

@nventuro nventuro commented Mar 8, 2024

Closes #4520.

I did some work adding tests for this, but ultimately decided to go back on it. We don't really have any tests for other parts of the addNotes flow (such as the checks for note existence, inclusion in the provided tx, non-nullification, etc.), and this didn't feel like the right place to work on those.

We definitely should however. Part of the problem is that writing a contract that allows for manual note creation, deletion and retrieval from a test is quite annoying - I did some of this in TestContract for #4238. For this we'd also need to have different functions for different note types, and even then some of these notes can only be added automatically via broadcast due to the random values in the note.

@nventuro nventuro requested review from benesjan and sklppy88 March 8, 2024 13:02
@AztecBot
Copy link
Collaborator

AztecBot commented Mar 8, 2024

Benchmark results

Metrics with a significant change:

  • note_successful_decrypting_time_in_ms (32): 717 (+32%)
Detailed 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 507c374b 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 64 txs
l1_rollup_calldata_size_in_bytes 5,700 18,884 36,452
l1_rollup_calldata_gas 66,564 238,892 469,376
l1_rollup_execution_gas 674,027 979,713 1,388,150
l2_block_processing_time_in_ms 1,193 4,476 8,915
note_successful_decrypting_time_in_ms 203 ⚠️ 717 (+32%) 1,020 (+3%)
note_trial_decrypting_time_in_ms 10.0 (-6%) 45.1 (-26%) 33.3 (-72%)
l2_block_building_time_in_ms 11,985 47,327 (-1%) 95,422 (-1%)
l2_block_rollup_simulation_time_in_ms 7,298 28,919 (-1%) 58,583 (-1%)
l2_block_public_tx_process_time_in_ms 4,658 18,347 36,703

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,182 (-5%) 28,100 (+5%)
note_history_successful_decrypting_time_in_ms 1,238 (+1%) 2,371 (-1%)
note_history_trial_decrypting_time_in_ms 87.2 (+8%) 100 (-31%)
node_database_size_in_bytes 18,780,240 35,549,264
pxe_database_size_in_bytes 29,923 59,478

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 252 44,736 28,001
private-kernel-ordering 196 (+1%) 52,625 14,627
base-rollup 656 177,932 997
root-rollup 69.2 (+1%) 4,320 825
private-kernel-inner 320 73,715 28,001
public-kernel-app-logic 164 34,920 27,972
public-kernel-tail 82.1 34,507 27,972
merge-rollup 8.54 (-8%) 2,840 997

Tree insertion stats

The duration to insert a fixed batch of leaves into each tree type.

Metric 1 leaves 2 leaves 8 leaves 16 leaves 32 leaves 64 leaves 128 leaves 512 leaves 1024 leaves 2048 leaves 4096 leaves
batch_insert_into_append_only_tree_16_depth_ms 9.72 (-1%) 10.5 (+2%) 14.7 (-13%) 16.4 (-1%) 21.8 (-1%) 35.6 N/A N/A N/A N/A N/A
batch_insert_into_append_only_tree_16_depth_hash_count 16.9 17.5 23.0 31.6 47.0 79.0 N/A N/A N/A N/A N/A
batch_insert_into_append_only_tree_16_depth_hash_ms 0.565 0.581 (+2%) 0.625 (-12%) 0.508 (-1%) 0.457 (-1%) 0.442 N/A N/A N/A N/A N/A
batch_insert_into_append_only_tree_32_depth_ms N/A N/A N/A N/A N/A 45.6 (-2%) 71.9 (-5%) 230 452 (+1%) 865 1,729
batch_insert_into_append_only_tree_32_depth_hash_count N/A N/A N/A N/A N/A 96.0 159 543 1,055 2,079 4,127
batch_insert_into_append_only_tree_32_depth_hash_ms N/A N/A N/A N/A N/A 0.468 (-2%) 0.444 (-5%) 0.419 (-1%) 0.423 (+1%) 0.412 0.414
batch_insert_into_indexed_tree_20_depth_ms N/A N/A N/A N/A N/A 54.6 (+2%) 106 (-5%) 342 (+1%) 663 (+1%) 1,304 2,600
batch_insert_into_indexed_tree_20_depth_hash_count N/A N/A N/A N/A N/A 104 207 691 1,363 2,707 5,395
batch_insert_into_indexed_tree_20_depth_hash_ms N/A N/A N/A N/A N/A 0.487 (+2%) 0.479 (-5%) 0.464 (+1%) 0.457 (+1%) 0.454 0.452
batch_insert_into_indexed_tree_40_depth_ms N/A N/A N/A N/A 60.9 N/A N/A N/A N/A N/A N/A
batch_insert_into_indexed_tree_40_depth_hash_count N/A N/A N/A N/A 109 N/A N/A N/A N/A N/A N/A
batch_insert_into_indexed_tree_40_depth_hash_ms N/A N/A N/A N/A 0.533 N/A N/A N/A N/A N/A N/A

Miscellaneous

Transaction sizes based on how many contracts are deployed in the tx.

Metric 0 deployed contracts
tx_size_in_bytes 19,179

Transaction processing duration by data writes.

Metric 0 new note hashes 1 new note hashes
tx_pxe_processing_time_ms 2,701 1,377
Metric 0 public data writes 1 public data writes
tx_sequencer_processing_time_ms 6.43 (+14%) 574

@nventuro nventuro removed request for benesjan and sklppy88 March 8, 2024 13:42
@nventuro
Copy link
Contributor Author

nventuro commented Mar 8, 2024

CI is failing due to imports on the boxes, which seems entirely unrelated.

@nventuro nventuro enabled auto-merge (squash) March 8, 2024 16:01
@nventuro nventuro merged commit 6206bec into master Mar 8, 2024
95 checks passed
@nventuro nventuro deleted the nv/compute_note_hash_assert branch March 8, 2024 17:07
AztecBot added a commit to noir-lang/noir that referenced this pull request Mar 8, 2024
…l/aztec-packages#5086)

Closes #4520.

I did some work adding tests for this, but ultimately decided to go back
on it. We don't really have any tests for other parts of the `addNotes`
flow (such as the checks for note existence, inclusion in the provided
tx, non-nullification, etc.), and this didn't feel like the right place
to work on those.

We definitely should however. Part of the problem is that writing a
contract that allows for manual note creation, deletion and retrieval
from a test is quite annoying - I did some of this in `TestContract` for
#4238. For this we'd also need to have different functions for different
note types, and even then some of these notes can only be added
automatically via broadcast due to the random values in the note.
AztecBot added a commit to noir-lang/noir that referenced this pull request Mar 8, 2024
…l/aztec-packages#5086)

Closes #4520.

I did some work adding tests for this, but ultimately decided to go back
on it. We don't really have any tests for other parts of the `addNotes`
flow (such as the checks for note existence, inclusion in the provided
tx, non-nullification, etc.), and this didn't feel like the right place
to work on those.

We definitely should however. Part of the problem is that writing a
contract that allows for manual note creation, deletion and retrieval
from a test is quite annoying - I did some of this in `TestContract` for
#4238. For this we'd also need to have different functions for different
note types, and even then some of these notes can only be added
automatically via broadcast due to the random values in the note.
PhilWindle pushed a commit that referenced this pull request Mar 8, 2024
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-package: 0.26.6</summary>

##
[0.26.6](aztec-package-v0.26.5...aztec-package-v0.26.6)
(2024-03-08)


### Miscellaneous

* **aztec-package:** Synchronize aztec-packages versions
</details>

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

##
[0.26.6](barretenberg.js-v0.26.5...barretenberg.js-v0.26.6)
(2024-03-08)


### Miscellaneous

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

<details><summary>aztec-cli: 0.26.6</summary>

##
[0.26.6](aztec-cli-v0.26.5...aztec-cli-v0.26.6)
(2024-03-08)


### Features

* Show bytecode size per function in CLI inspect-contract
([#5059](#5059))
([cb9fdc6](cb9fdc6))
</details>

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

##
[0.26.6](aztec-packages-v0.26.5...aztec-packages-v0.26.6)
(2024-03-08)


### Features

* Basic public reverts
([#4870](#4870))
([5cccc78](5cccc78))
* Deploying new inbox
([#5036](#5036))
([fed729d](fed729d))
* Detect unknown note type ids in compute_note_hash
([#5086](#5086))
([6206bec](6206bec))
* Easy deployment of protocol contracts in e2e
([#4983](#4983))
([480161f](480161f))
* IPA documentation
([#4924](#4924))
([48bd22e](48bd22e))
* Nullifier read requests in public kernel
([#4910](#4910))
([0e44247](0e44247))
* Show bytecode size per function in CLI inspect-contract
([#5059](#5059))
([cb9fdc6](cb9fdc6))
* Updating an SMT solver class
([#4981](#4981))
([4b94d58](4b94d58))


### Bug Fixes

* Canonical contract address
([#5030](#5030))
([b2af880](b2af880))
* Flaky deployment test
([#5035](#5035))
([039eafc](039eafc))
* Pull the correct platform image for noir
([#5097](#5097))
([3342371](3342371))
* Sleep function memory leak
([#5023](#5023))
([a72cfea](a72cfea)),
closes
[#4817](#4817)
* Storage v2
([#5027](#5027))
([fe3190e](fe3190e))
* Update protogalaxy cmake dependencies
([#5066](#5066))
([507c374](507c374))


### Miscellaneous

* Address warnings in noir test suite
([#4966](#4966))
([7ef4ef5](7ef4ef5))
* Bootstrap noir natively if nargo is invalid
([#5034](#5034))
([df089de](df089de))
* Build avm transpiler if we are on mac
([#5039](#5039))
([c2966b9](c2966b9))
* **ci:** Re-enable certain bb solidity ACIR tests
([#5065](#5065))
([58e1ff4](58e1ff4))
* Cleanup of prover and verifier instances
([#4959](#4959))
([f2fdefd](f2fdefd))
* Delete bootstrap scripts from `noir/noir-repo`
([#5044](#5044))
([add91ca](add91ca))
* Disable `hello_world_example` noir test in aztec-packages CI
([#5061](#5061))
([1be9243](1be9243))
* Join-split example Part 1
([#4965](#4965))
([b9de0f5](b9de0f5))
* Moving RootRollupInputs impl
([#5087](#5087))
([f3d9f9b](f3d9f9b))
* Remove eccvm functionality to update the op queue and ensure ultra ops
are populated through function
([#5084](#5084))
([77954ab](77954ab))


### Documentation

* Parity circuit naming fixes
([#5076](#5076))
([c255255](c255255))
</details>

<details><summary>barretenberg: 0.26.6</summary>

##
[0.26.6](barretenberg-v0.26.5...barretenberg-v0.26.6)
(2024-03-08)


### Features

* IPA documentation
([#4924](#4924))
([48bd22e](48bd22e))
* Updating an SMT solver class
([#4981](#4981))
([4b94d58](4b94d58))


### Bug Fixes

* Storage v2
([#5027](#5027))
([fe3190e](fe3190e))
* Update protogalaxy cmake dependencies
([#5066](#5066))
([507c374](507c374))


### Miscellaneous

* **ci:** Re-enable certain bb solidity ACIR tests
([#5065](#5065))
([58e1ff4](58e1ff4))
* Cleanup of prover and verifier instances
([#4959](#4959))
([f2fdefd](f2fdefd))
* Join-split example Part 1
([#4965](#4965))
([b9de0f5](b9de0f5))
* Remove eccvm functionality to update the op queue and ensure ultra ops
are populated through function
([#5084](#5084))
([77954ab](77954ab))
</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 Mar 9, 2024
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-package: 0.26.6</summary>

##
[0.26.6](AztecProtocol/aztec-packages@aztec-package-v0.26.5...aztec-package-v0.26.6)
(2024-03-08)


### Miscellaneous

* **aztec-package:** Synchronize aztec-packages versions
</details>

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

##
[0.26.6](AztecProtocol/aztec-packages@barretenberg.js-v0.26.5...barretenberg.js-v0.26.6)
(2024-03-08)


### Miscellaneous

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

<details><summary>aztec-cli: 0.26.6</summary>

##
[0.26.6](AztecProtocol/aztec-packages@aztec-cli-v0.26.5...aztec-cli-v0.26.6)
(2024-03-08)


### Features

* Show bytecode size per function in CLI inspect-contract
([#5059](AztecProtocol/aztec-packages#5059))
([cb9fdc6](AztecProtocol/aztec-packages@cb9fdc6))
</details>

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

##
[0.26.6](AztecProtocol/aztec-packages@aztec-packages-v0.26.5...aztec-packages-v0.26.6)
(2024-03-08)


### Features

* Basic public reverts
([#4870](AztecProtocol/aztec-packages#4870))
([5cccc78](AztecProtocol/aztec-packages@5cccc78))
* Deploying new inbox
([#5036](AztecProtocol/aztec-packages#5036))
([fed729d](AztecProtocol/aztec-packages@fed729d))
* Detect unknown note type ids in compute_note_hash
([#5086](AztecProtocol/aztec-packages#5086))
([6206bec](AztecProtocol/aztec-packages@6206bec))
* Easy deployment of protocol contracts in e2e
([#4983](AztecProtocol/aztec-packages#4983))
([480161f](AztecProtocol/aztec-packages@480161f))
* IPA documentation
([#4924](AztecProtocol/aztec-packages#4924))
([48bd22e](AztecProtocol/aztec-packages@48bd22e))
* Nullifier read requests in public kernel
([#4910](AztecProtocol/aztec-packages#4910))
([0e44247](AztecProtocol/aztec-packages@0e44247))
* Show bytecode size per function in CLI inspect-contract
([#5059](AztecProtocol/aztec-packages#5059))
([cb9fdc6](AztecProtocol/aztec-packages@cb9fdc6))
* Updating an SMT solver class
([#4981](AztecProtocol/aztec-packages#4981))
([4b94d58](AztecProtocol/aztec-packages@4b94d58))


### Bug Fixes

* Canonical contract address
([#5030](AztecProtocol/aztec-packages#5030))
([b2af880](AztecProtocol/aztec-packages@b2af880))
* Flaky deployment test
([#5035](AztecProtocol/aztec-packages#5035))
([039eafc](AztecProtocol/aztec-packages@039eafc))
* Pull the correct platform image for noir
([#5097](AztecProtocol/aztec-packages#5097))
([3342371](AztecProtocol/aztec-packages@3342371))
* Sleep function memory leak
([#5023](AztecProtocol/aztec-packages#5023))
([a72cfea](AztecProtocol/aztec-packages@a72cfea)),
closes
[#4817](AztecProtocol/aztec-packages#4817)
* Storage v2
([#5027](AztecProtocol/aztec-packages#5027))
([fe3190e](AztecProtocol/aztec-packages@fe3190e))
* Update protogalaxy cmake dependencies
([#5066](AztecProtocol/aztec-packages#5066))
([507c374](AztecProtocol/aztec-packages@507c374))


### Miscellaneous

* Address warnings in noir test suite
([#4966](AztecProtocol/aztec-packages#4966))
([7ef4ef5](AztecProtocol/aztec-packages@7ef4ef5))
* Bootstrap noir natively if nargo is invalid
([#5034](AztecProtocol/aztec-packages#5034))
([df089de](AztecProtocol/aztec-packages@df089de))
* Build avm transpiler if we are on mac
([#5039](AztecProtocol/aztec-packages#5039))
([c2966b9](AztecProtocol/aztec-packages@c2966b9))
* **ci:** Re-enable certain bb solidity ACIR tests
([#5065](AztecProtocol/aztec-packages#5065))
([58e1ff4](AztecProtocol/aztec-packages@58e1ff4))
* Cleanup of prover and verifier instances
([#4959](AztecProtocol/aztec-packages#4959))
([f2fdefd](AztecProtocol/aztec-packages@f2fdefd))
* Delete bootstrap scripts from `noir/noir-repo`
([#5044](AztecProtocol/aztec-packages#5044))
([add91ca](AztecProtocol/aztec-packages@add91ca))
* Disable `hello_world_example` noir test in aztec-packages CI
([#5061](AztecProtocol/aztec-packages#5061))
([1be9243](AztecProtocol/aztec-packages@1be9243))
* Join-split example Part 1
([#4965](AztecProtocol/aztec-packages#4965))
([b9de0f5](AztecProtocol/aztec-packages@b9de0f5))
* Moving RootRollupInputs impl
([#5087](AztecProtocol/aztec-packages#5087))
([f3d9f9b](AztecProtocol/aztec-packages@f3d9f9b))
* Remove eccvm functionality to update the op queue and ensure ultra ops
are populated through function
([#5084](AztecProtocol/aztec-packages#5084))
([77954ab](AztecProtocol/aztec-packages@77954ab))


### Documentation

* Parity circuit naming fixes
([#5076](AztecProtocol/aztec-packages#5076))
([c255255](AztecProtocol/aztec-packages@c255255))
</details>

<details><summary>barretenberg: 0.26.6</summary>

##
[0.26.6](AztecProtocol/aztec-packages@barretenberg-v0.26.5...barretenberg-v0.26.6)
(2024-03-08)


### Features

* IPA documentation
([#4924](AztecProtocol/aztec-packages#4924))
([48bd22e](AztecProtocol/aztec-packages@48bd22e))
* Updating an SMT solver class
([#4981](AztecProtocol/aztec-packages#4981))
([4b94d58](AztecProtocol/aztec-packages@4b94d58))


### Bug Fixes

* Storage v2
([#5027](AztecProtocol/aztec-packages#5027))
([fe3190e](AztecProtocol/aztec-packages@fe3190e))
* Update protogalaxy cmake dependencies
([#5066](AztecProtocol/aztec-packages#5066))
([507c374](AztecProtocol/aztec-packages@507c374))


### Miscellaneous

* **ci:** Re-enable certain bb solidity ACIR tests
([#5065](AztecProtocol/aztec-packages#5065))
([58e1ff4](AztecProtocol/aztec-packages@58e1ff4))
* Cleanup of prover and verifier instances
([#4959](AztecProtocol/aztec-packages#4959))
([f2fdefd](AztecProtocol/aztec-packages@f2fdefd))
* Join-split example Part 1
([#4965](AztecProtocol/aztec-packages#4965))
([b9de0f5](AztecProtocol/aztec-packages@b9de0f5))
* Remove eccvm functionality to update the op queue and ensure ultra ops
are populated through function
([#5084](AztecProtocol/aztec-packages#5084))
([77954ab](AztecProtocol/aztec-packages@77954ab))
</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
None yet
Development

Successfully merging this pull request may close these issues.

refactor(AztecMacro): Error out when computing hash for unknown notes
3 participants