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

chore(docs): add Singleton and ImmutableSingleton view_note methods #2934

Merged
merged 2 commits into from
Oct 23, 2023

Conversation

critesjosh
Copy link
Contributor

@critesjosh critesjosh commented Oct 19, 2023

Adds missing docs around the Singleton and ImmutableSingleton view_note methods.

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

@AztecBot
Copy link
Collaborator

AztecBot commented Oct 19, 2023

Benchmark results

No metrics with a significant change found.

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 c4d8d963 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,900 868,208 3,448,160
l1_rollup_execution_gas 841,987 3,595,316 22,203,529
l2_block_processing_time_in_ms 1,045 (+3%) 3,946 (+2%) 15,635 (+3%)
note_successful_decrypting_time_in_ms 341 (+3%) 1,059 (+4%) 4,075 (+3%)
note_trial_decrypting_time_in_ms 43.0 (+23%) 109 (+1%) 137
l2_block_building_time_in_ms 9,074 (+2%) 36,109 (+1%) 159,310 (+2%)
l2_block_rollup_simulation_time_in_ms 6,692 (+2%) 26,619 (+1%) 106,077 (+1%)
l2_block_public_tx_process_time_in_ms 2,345 (+2%) 9,364 (+1%) 52,612 (+3%)

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 11,529 (+3%) 22,307 (+3%)
note_history_successful_decrypting_time_in_ms 2,410 (+3%) 4,719 (+3%)
note_history_trial_decrypting_time_in_ms 122 193 (+5%)
node_database_size_in_bytes 1,663,837 1,203,033
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 47.5 (+1%) 61,697 18,841
private-kernel-ordering 23.6 (+2%) 24,233 8,089
base-rollup 854 639,797 811
root-rollup 37.9 4,072 1,097
private-kernel-inner 42.7 (+2%) 81,504 18,841
public-kernel-private-input 47.8 41,455 18,841
public-kernel-non-first-iteration 31.1 41,497 18,841
merge-rollup 0.819 (-3%) 2,592 873

Miscellaneous

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

Metric 0 deployed contracts 1 deployed contracts
tx_size_in_bytes 8,723 27,508

@critesjosh critesjosh changed the title docs: chore: add Singleton view_note method docs: chore: add Singleton and ImmutableSingleton view_note methods Oct 20, 2023
@kevaundray kevaundray changed the title docs: chore: add Singleton and ImmutableSingleton view_note methods chore(docs): add Singleton and ImmutableSingleton view_note methods Oct 21, 2023
@critesjosh critesjosh merged commit c1497f8 into master Oct 23, 2023
5 checks passed
@critesjosh critesjosh deleted the docs/jc/singleton-view-note branch October 23, 2023 20:37
rahul-kothari pushed a commit that referenced this pull request Oct 24, 2023
🤖 I have created a release *beep* *boop*
---


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

##
[0.10.0](aztec-packages-v0.9.0...aztec-packages-v0.10.0)
(2023-10-24)


### ⚠ BREAKING CHANGES

* Emitting encrypted log by default
([#2926](#2926))

### Features

* Added register-account command to cli
([#2980](#2980))
([0977a90](0977a90))
* **docs:** Fix portals tutorial formatting
([#2929](#2929))
([ab19b67](ab19b67))
* Emitting encrypted log by default
([#2926](#2926))
([1ea2d4f](1ea2d4f)),
closes
[#2912](#2912)
* Goblin translator non-native field relation (Goblin Translator part 6)
([#2871](#2871))
([c4d8d96](c4d8d96))
* Honk profiling by pass, tsan preset
([#2982](#2982))
([a1592fd](a1592fd))
* Incorporate docs feedback and add "intermediate" level intros to some
pages
([#2598](#2598))
([78f9f52](78f9f52))
* Nuking `Pokeable` contract
([#2939](#2939))
([583d6fb](583d6fb))
* Protogalaxy Combiner
([#2436](#2436))
([a60c70d](a60c70d))
* Protogalaxy perturbator!
([#2624](#2624))
([509dee6](509dee6))
* Refactor pedersen hash standard
([#2592](#2592))
([3085676](3085676))
* Widget benchmarking
([#2897](#2897))
([0e927e9](0e927e9))


### Bug Fixes

* Add @jest/types to box deps
([#2903](#2903))
([db3fa62](db3fa62))
* Add lint rule for focused tests
([#2901](#2901))
([fd1a1a8](fd1a1a8))
* Avoid tsc OOM by unignoring an old contract artifact
([#2932](#2932))
([7310600](7310600))
* Bad it.only in tests
([#2900](#2900))
([a1f3af1](a1f3af1))
* Boxes boostrap dont use ts-node directly and add .prettierignore
([#2890](#2890))
([a3b1804](a3b1804))
* Confusing "Unknown complete address" error
([#2967](#2967))
([3a8f54a](3a8f54a))
* Force jest to quit, otherwise CI can rack up to 3hrs of credits per
job.
([#2899](#2899))
([ba2f671](ba2f671))
* Honk sumcheck performance
([#2925](#2925))
([5fbfe6e](5fbfe6e))
* Pending commitments contract using the wrong number of arguments
([#2959](#2959))
([655c322](655c322))
* Prettierignore in boxes
([#2902](#2902))
([8f7a200](8f7a200))
* Randomness in `AddressNote`
([#2965](#2965))
([4dc49a9](4dc49a9))
* Yarn lock
([#2923](#2923))
([7042bc6](7042bc6))


### Miscellaneous

* `Private Data Tree` --&gt; `Note Hash Tree`
([#2945](#2945))
([abaec9c](abaec9c)),
closes
[#2906](#2906)
* Apply hash abstraction over aztec-nr
([#2958](#2958))
([52f01ae](52f01ae))
* **docs:** Add Singleton and ImmutableSingleton `view_note` methods
([#2934](#2934))
([c1497f8](c1497f8))
* Fix box frontend styling
([#2919](#2919))
([7e9e8cc](7e9e8cc))
* Less noisy benchmark reports
([#2916](#2916))
([0df166c](0df166c))
* Remove unused nix files
([#2933](#2933))
([3174f84](3174f84))
* Run all e2e tests against sandbox
([#2891](#2891))
([6c4e26c](6c4e26c))
* Token box copies noir source files from noir-contracts on bootstrap
([#2940](#2940))
([a467b96](a467b96))


### Documentation

* Fix: update cheat codes to connect to ethRpcUrl
([#2922](#2922))
([4ffe9be](4ffe9be))
</details>

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

##
[0.10.0](barretenberg.js-v0.9.0...barretenberg.js-v0.10.0)
(2023-10-24)


### Features

* Refactor pedersen hash standard
([#2592](#2592))
([3085676](3085676))
</details>

<details><summary>barretenberg: 0.10.0</summary>

##
[0.10.0](barretenberg-v0.9.0...barretenberg-v0.10.0)
(2023-10-24)


### Features

* Goblin translator non-native field relation (Goblin Translator part 6)
([#2871](#2871))
([c4d8d96](c4d8d96))
* Honk profiling by pass, tsan preset
([#2982](#2982))
([a1592fd](a1592fd))
* Protogalaxy Combiner
([#2436](#2436))
([a60c70d](a60c70d))
* Protogalaxy perturbator!
([#2624](#2624))
([509dee6](509dee6))
* Refactor pedersen hash standard
([#2592](#2592))
([3085676](3085676))
* Widget benchmarking
([#2897](#2897))
([0e927e9](0e927e9))


### Bug Fixes

* Honk sumcheck performance
([#2925](#2925))
([5fbfe6e](5fbfe6e))


### Miscellaneous

* Remove unused nix files
([#2933](#2933))
([3174f84](3174f84))
</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 27, 2023
🤖 I have created a release *beep* *boop*
---


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

##
[0.10.0](AztecProtocol/aztec-packages@aztec-packages-v0.9.0...aztec-packages-v0.10.0)
(2023-10-24)


### ⚠ BREAKING CHANGES

* Emitting encrypted log by default
([#2926](AztecProtocol/aztec-packages#2926))

### Features

* Added register-account command to cli
([#2980](AztecProtocol/aztec-packages#2980))
([0977a90](AztecProtocol/aztec-packages@0977a90))
* **docs:** Fix portals tutorial formatting
([#2929](AztecProtocol/aztec-packages#2929))
([ab19b67](AztecProtocol/aztec-packages@ab19b67))
* Emitting encrypted log by default
([#2926](AztecProtocol/aztec-packages#2926))
([1ea2d4f](AztecProtocol/aztec-packages@1ea2d4f)),
closes
[#2912](AztecProtocol/aztec-packages#2912)
* Goblin translator non-native field relation (Goblin Translator part 6)
([#2871](AztecProtocol/aztec-packages#2871))
([c4d8d96](AztecProtocol/aztec-packages@c4d8d96))
* Honk profiling by pass, tsan preset
([#2982](AztecProtocol/aztec-packages#2982))
([a1592fd](AztecProtocol/aztec-packages@a1592fd))
* Incorporate docs feedback and add "intermediate" level intros to some
pages
([#2598](AztecProtocol/aztec-packages#2598))
([78f9f52](AztecProtocol/aztec-packages@78f9f52))
* Nuking `Pokeable` contract
([#2939](AztecProtocol/aztec-packages#2939))
([583d6fb](AztecProtocol/aztec-packages@583d6fb))
* Protogalaxy Combiner
([#2436](AztecProtocol/aztec-packages#2436))
([a60c70d](AztecProtocol/aztec-packages@a60c70d))
* Protogalaxy perturbator!
([#2624](AztecProtocol/aztec-packages#2624))
([509dee6](AztecProtocol/aztec-packages@509dee6))
* Refactor pedersen hash standard
([#2592](AztecProtocol/aztec-packages#2592))
([3085676](AztecProtocol/aztec-packages@3085676))
* Widget benchmarking
([#2897](AztecProtocol/aztec-packages#2897))
([0e927e9](AztecProtocol/aztec-packages@0e927e9))


### Bug Fixes

* Add @jest/types to box deps
([#2903](AztecProtocol/aztec-packages#2903))
([db3fa62](AztecProtocol/aztec-packages@db3fa62))
* Add lint rule for focused tests
([#2901](AztecProtocol/aztec-packages#2901))
([fd1a1a8](AztecProtocol/aztec-packages@fd1a1a8))
* Avoid tsc OOM by unignoring an old contract artifact
([#2932](AztecProtocol/aztec-packages#2932))
([7310600](AztecProtocol/aztec-packages@7310600))
* Bad it.only in tests
([#2900](AztecProtocol/aztec-packages#2900))
([a1f3af1](AztecProtocol/aztec-packages@a1f3af1))
* Boxes boostrap dont use ts-node directly and add .prettierignore
([#2890](AztecProtocol/aztec-packages#2890))
([a3b1804](AztecProtocol/aztec-packages@a3b1804))
* Confusing "Unknown complete address" error
([#2967](AztecProtocol/aztec-packages#2967))
([3a8f54a](AztecProtocol/aztec-packages@3a8f54a))
* Force jest to quit, otherwise CI can rack up to 3hrs of credits per
job.
([#2899](AztecProtocol/aztec-packages#2899))
([ba2f671](AztecProtocol/aztec-packages@ba2f671))
* Honk sumcheck performance
([#2925](AztecProtocol/aztec-packages#2925))
([5fbfe6e](AztecProtocol/aztec-packages@5fbfe6e))
* Pending commitments contract using the wrong number of arguments
([#2959](AztecProtocol/aztec-packages#2959))
([655c322](AztecProtocol/aztec-packages@655c322))
* Prettierignore in boxes
([#2902](AztecProtocol/aztec-packages#2902))
([8f7a200](AztecProtocol/aztec-packages@8f7a200))
* Randomness in `AddressNote`
([#2965](AztecProtocol/aztec-packages#2965))
([4dc49a9](AztecProtocol/aztec-packages@4dc49a9))
* Yarn lock
([#2923](AztecProtocol/aztec-packages#2923))
([7042bc6](AztecProtocol/aztec-packages@7042bc6))


### Miscellaneous

* `Private Data Tree` --&gt; `Note Hash Tree`
([#2945](AztecProtocol/aztec-packages#2945))
([abaec9c](AztecProtocol/aztec-packages@abaec9c)),
closes
[#2906](AztecProtocol/aztec-packages#2906)
* Apply hash abstraction over aztec-nr
([#2958](AztecProtocol/aztec-packages#2958))
([52f01ae](AztecProtocol/aztec-packages@52f01ae))
* **docs:** Add Singleton and ImmutableSingleton `view_note` methods
([#2934](AztecProtocol/aztec-packages#2934))
([c1497f8](AztecProtocol/aztec-packages@c1497f8))
* Fix box frontend styling
([#2919](AztecProtocol/aztec-packages#2919))
([7e9e8cc](AztecProtocol/aztec-packages@7e9e8cc))
* Less noisy benchmark reports
([#2916](AztecProtocol/aztec-packages#2916))
([0df166c](AztecProtocol/aztec-packages@0df166c))
* Remove unused nix files
([#2933](AztecProtocol/aztec-packages#2933))
([3174f84](AztecProtocol/aztec-packages@3174f84))
* Run all e2e tests against sandbox
([#2891](AztecProtocol/aztec-packages#2891))
([6c4e26c](AztecProtocol/aztec-packages@6c4e26c))
* Token box copies noir source files from noir-contracts on bootstrap
([#2940](AztecProtocol/aztec-packages#2940))
([a467b96](AztecProtocol/aztec-packages@a467b96))


### Documentation

* Fix: update cheat codes to connect to ethRpcUrl
([#2922](AztecProtocol/aztec-packages#2922))
([4ffe9be](AztecProtocol/aztec-packages@4ffe9be))
</details>

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

##
[0.10.0](AztecProtocol/aztec-packages@barretenberg.js-v0.9.0...barretenberg.js-v0.10.0)
(2023-10-24)


### Features

* Refactor pedersen hash standard
([#2592](AztecProtocol/aztec-packages#2592))
([3085676](AztecProtocol/aztec-packages@3085676))
</details>

<details><summary>barretenberg: 0.10.0</summary>

##
[0.10.0](AztecProtocol/aztec-packages@barretenberg-v0.9.0...barretenberg-v0.10.0)
(2023-10-24)


### Features

* Goblin translator non-native field relation (Goblin Translator part 6)
([#2871](AztecProtocol/aztec-packages#2871))
([c4d8d96](AztecProtocol/aztec-packages@c4d8d96))
* Honk profiling by pass, tsan preset
([#2982](AztecProtocol/aztec-packages#2982))
([a1592fd](AztecProtocol/aztec-packages@a1592fd))
* Protogalaxy Combiner
([#2436](AztecProtocol/aztec-packages#2436))
([a60c70d](AztecProtocol/aztec-packages@a60c70d))
* Protogalaxy perturbator!
([#2624](AztecProtocol/aztec-packages#2624))
([509dee6](AztecProtocol/aztec-packages@509dee6))
* Refactor pedersen hash standard
([#2592](AztecProtocol/aztec-packages#2592))
([3085676](AztecProtocol/aztec-packages@3085676))
* Widget benchmarking
([#2897](AztecProtocol/aztec-packages#2897))
([0e927e9](AztecProtocol/aztec-packages@0e927e9))


### Bug Fixes

* Honk sumcheck performance
([#2925](AztecProtocol/aztec-packages#2925))
([5fbfe6e](AztecProtocol/aztec-packages@5fbfe6e))


### Miscellaneous

* Remove unused nix files
([#2933](AztecProtocol/aztec-packages#2933))
([3174f84](AztecProtocol/aztec-packages@3174f84))
</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.

3 participants