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

fix(docs): Update quickstart.md #5021

Merged
merged 2 commits into from
Mar 12, 2024
Merged

fix(docs): Update quickstart.md #5021

merged 2 commits into from
Mar 12, 2024

Conversation

critesjosh
Copy link
Contributor

Adding a link to tutorials at the bottom of the quickstart based on feedback from the eng offsite.

@critesjosh critesjosh requested a review from catmcgee March 7, 2024 02:33
@AztecBot
Copy link
Collaborator

AztecBot commented Mar 7, 2024

Docs Preview

Hey there! 👋 You can check your preview at https://65f094f3f7389d1e5465f870--aztec-docs-dev.netlify.app

@critesjosh critesjosh requested a review from a team March 7, 2024 14:45
@AztecBot
Copy link
Collaborator

Benchmark results

Metrics with a significant change:

  • note_successful_decrypting_time_in_ms (8): 171 (+33%)
  • note_trial_decrypting_time_in_ms (8): 75.6 (+114%)
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 426bd6d2 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,668 18,820 36,356
l1_rollup_calldata_gas 65,992 238,816 469,352
l1_rollup_execution_gas 666,624 953,677 1,336,660
l2_block_processing_time_in_ms 1,305 4,704 (-2%) 9,487 (+3%)
note_successful_decrypting_time_in_ms ⚠️ 171 (+33%) 489 (-12%) 988 (-2%)
note_trial_decrypting_time_in_ms ⚠️ 75.6 (+114%) 105 (+49%) 123 (-7%)
l2_block_building_time_in_ms 12,847 (-1%) 50,953 102,512 (+1%)
l2_block_rollup_simulation_time_in_ms 7,015 (+1%) 27,962 55,439
l2_block_public_tx_process_time_in_ms 5,800 (-4%) 22,931 46,973 (+2%)

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,383 (+3%) 25,656 (+2%)
note_history_successful_decrypting_time_in_ms 1,216 (+2%) 2,554 (+5%)
note_history_trial_decrypting_time_in_ms 68.6 (+11%) 145 (-4%)
node_database_size_in_bytes 19,030,096 35,852,368 (+1%)
pxe_database_size_in_bytes 29,859 59,414

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 273 44,338 27,700
private-kernel-ordering 206 (+1%) 52,324 14,326
base-rollup 630 177,083 925
root-rollup 68.5 (+1%) 4,176 789
private-kernel-inner 359 73,197 27,700
public-kernel-app-logic 186 (+1%) 35,198 28,215
public-kernel-tail 177 (+2%) 40,926 28,215
merge-rollup 8.38 (+1%) 2,696 925

Tree insertion stats

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

Metric 1 leaves 16 leaves 64 leaves 128 leaves 512 leaves 1024 leaves 2048 leaves 4096 leaves 32 leaves
batch_insert_into_append_only_tree_16_depth_ms 9.99 16.0 (+1%) N/A N/A N/A N/A N/A N/A N/A
batch_insert_into_append_only_tree_16_depth_hash_count 16.8 31.6 N/A N/A N/A N/A N/A N/A N/A
batch_insert_into_append_only_tree_16_depth_hash_ms 0.582 0.495 (+1%) N/A N/A N/A N/A N/A N/A N/A
batch_insert_into_append_only_tree_32_depth_ms N/A N/A 46.1 71.8 230 446 (+1%) 866 1,715 N/A
batch_insert_into_append_only_tree_32_depth_hash_count N/A N/A 96.0 159 543 1,055 2,079 4,127 N/A
batch_insert_into_append_only_tree_32_depth_hash_ms N/A N/A 0.473 0.443 0.420 0.417 (+1%) 0.413 0.410 N/A
batch_insert_into_indexed_tree_20_depth_ms N/A N/A 53.4 (+1%) 106 334 657 1,307 2,596 N/A
batch_insert_into_indexed_tree_20_depth_hash_count N/A N/A 104 207 691 1,363 2,707 5,395 N/A
batch_insert_into_indexed_tree_20_depth_hash_ms N/A N/A 0.477 (+1%) 0.479 0.455 0.453 0.453 0.452 N/A
batch_insert_into_indexed_tree_40_depth_ms N/A N/A N/A N/A N/A N/A N/A N/A 61.3
batch_insert_into_indexed_tree_40_depth_hash_count N/A N/A N/A N/A N/A N/A N/A N/A 109
batch_insert_into_indexed_tree_40_depth_hash_ms N/A N/A N/A N/A N/A N/A N/A N/A 0.536

Miscellaneous

Transaction sizes based on how many contract classes are registered in the tx.

Metric 0 registered classes
tx_size_in_bytes 22,014

Transaction processing duration by data writes.

Metric 0 new note hashes 1 new note hashes
tx_pxe_processing_time_ms 3,081 1,438 (+1%)
Metric 0 public data writes 1 public data writes
tx_sequencer_processing_time_ms 13.5 (+12%) 723 (+2%)

@critesjosh critesjosh merged commit be9f8a1 into master Mar 12, 2024
97 checks passed
@critesjosh critesjosh deleted the jc/docs-quickstart-links branch March 12, 2024 18:15
critesjosh pushed a commit that referenced this pull request Mar 13, 2024
🤖 I have created a release *beep* *boop*
---


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

##
[0.27.2](aztec-package-v0.27.1...aztec-package-v0.27.2)
(2024-03-13)


### Miscellaneous

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

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

##
[0.27.2](barretenberg.js-v0.27.1...barretenberg.js-v0.27.2)
(2024-03-13)


### Miscellaneous

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

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

##
[0.27.2](aztec-cli-v0.27.1...aztec-cli-v0.27.2)
(2024-03-13)


### Miscellaneous

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

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

##
[0.27.2](aztec-packages-v0.27.1...aztec-packages-v0.27.2)
(2024-03-13)


### Features

* Check initialization arguments in constructors
([#5144](#5144))
([d003bd6](d003bd6))
* Multithreaded prover folding
([#5147](#5147))
([94922fc](94922fc))
* Run tests in parallel in `nargo test`
(noir-lang/noir#4484)
([58e15ed](58e15ed))
* Track stack frames and their variables in the debugger
(noir-lang/noir#4188)
([58e15ed](58e15ed))


### Bug Fixes

* **acir_gen:** More granular element sizes array check
(noir-lang/noir#4528)
([58e15ed](58e15ed))
* Add `follow_bindings` to follow `Type::Alias` links
(noir-lang/noir#4521)
([58e15ed](58e15ed))
* Allow type aliases in main
(noir-lang/noir#4505)
([58e15ed](58e15ed))
* Constant gen
([#5172](#5172))
([394a0e0](394a0e0))
* **docs:** Update quickstart.md
([#5021](#5021))
([be9f8a1](be9f8a1))
* Dynamic assert messages in brillig
(noir-lang/noir#4531)
([58e15ed](58e15ed))
* Fix brillig slowdown when assigning arrays in loops
(noir-lang/noir#4472)
([58e15ed](58e15ed))
* Fix deployments
([#5183](#5183))
([596253b](596253b))
* Force src impl for == on slices
(noir-lang/noir#4507)
([58e15ed](58e15ed))
* Handling of gh deps in noir_wasm
(noir-lang/noir#4499)
([58e15ed](58e15ed))
* Intermittent invert 0 in Goblin
([#5174](#5174))
([3e68b49](3e68b49))
* Iterative flattening pass
(noir-lang/noir#4492)
([58e15ed](58e15ed))
* Noir mirror merge strat
([#5166](#5166))
([74fa8d6](74fa8d6))
* **ssa:** Handle mergers of slices returned from calls
(noir-lang/noir#4496)
([58e15ed](58e15ed))


### Miscellaneous

* Add `ModuleDeclaration` struct
(noir-lang/noir#4512)
([58e15ed](58e15ed))
* Add HashMap docs (noir-lang/noir#4457)
([58e15ed](58e15ed))
* Add regression test for issue 4449
(noir-lang/noir#4503)
([58e15ed](58e15ed))
* Better output in ci_deploy_contracts.sh
([#5171](#5171))
([8d73f8a](8d73f8a))
* Bump bb to 0.26.3 (noir-lang/noir#4488)
([58e15ed](58e15ed))
* **ci:** Fix JS publishing workflow checking out inconsistent commits
(noir-lang/noir#4493)
([58e15ed](58e15ed))
* Custom hash for eddsa (noir-lang/noir#4440)
([58e15ed](58e15ed))
* Deterministic mode
([#5155](#5155))
([e68b56a](e68b56a))
* Document big integers (noir-lang/noir#4487)
([58e15ed](58e15ed))
* Generalise `FunctionVisibility` to `ItemVisibility`
(noir-lang/noir#4495)
([58e15ed](58e15ed))
* Interaction for a mock first circuit handled inside the `EccOpQueue`
([#4854](#4854))
([d9cbdc8](d9cbdc8))
* Move `check_method_signatures` to type checking phase
(noir-lang/noir#4516)
([58e15ed](58e15ed))
* Move templated code for assert_message into the stdlib
(noir-lang/noir#4475)
([58e15ed](58e15ed))
* Organize the `blackbox_solver` crate
(noir-lang/noir#4519)
([58e15ed](58e15ed))
* Pass `import_directive` by reference
(noir-lang/noir#4511)
([58e15ed](58e15ed))
* Pass macro processors by reference
(noir-lang/noir#4501)
([58e15ed](58e15ed))
* Pull out separate function for compiling and running a test
([58e15ed](58e15ed))
* Release Noir(0.25.0) (noir-lang/noir#4352)
([58e15ed](58e15ed))
* Update cargo deny config (noir-lang/noir#4486)
([58e15ed](58e15ed))
* Update various dependencies
(noir-lang/noir#4513)
([58e15ed](58e15ed))
</details>

<details><summary>barretenberg: 0.27.2</summary>

##
[0.27.2](barretenberg-v0.27.1...barretenberg-v0.27.2)
(2024-03-13)


### Features

* Multithreaded prover folding
([#5147](#5147))
([94922fc](94922fc))


### Bug Fixes

* Intermittent invert 0 in Goblin
([#5174](#5174))
([3e68b49](3e68b49))


### Miscellaneous

* Interaction for a mock first circuit handled inside the `EccOpQueue`
([#4854](#4854))
([d9cbdc8](d9cbdc8))
</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 14, 2024
🤖 I have created a release *beep* *boop*
---


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

##
[0.27.2](AztecProtocol/aztec-packages@aztec-package-v0.27.1...aztec-package-v0.27.2)
(2024-03-13)


### Miscellaneous

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

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

##
[0.27.2](AztecProtocol/aztec-packages@barretenberg.js-v0.27.1...barretenberg.js-v0.27.2)
(2024-03-13)


### Miscellaneous

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

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

##
[0.27.2](AztecProtocol/aztec-packages@aztec-cli-v0.27.1...aztec-cli-v0.27.2)
(2024-03-13)


### Miscellaneous

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

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

##
[0.27.2](AztecProtocol/aztec-packages@aztec-packages-v0.27.1...aztec-packages-v0.27.2)
(2024-03-13)


### Features

* Check initialization arguments in constructors
([#5144](AztecProtocol/aztec-packages#5144))
([d003bd6](AztecProtocol/aztec-packages@d003bd6))
* Multithreaded prover folding
([#5147](AztecProtocol/aztec-packages#5147))
([94922fc](AztecProtocol/aztec-packages@94922fc))
* Run tests in parallel in `nargo test`
(noir-lang/noir#4484)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Track stack frames and their variables in the debugger
(noir-lang/noir#4188)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))


### Bug Fixes

* **acir_gen:** More granular element sizes array check
(noir-lang/noir#4528)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Add `follow_bindings` to follow `Type::Alias` links
(noir-lang/noir#4521)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Allow type aliases in main
(noir-lang/noir#4505)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Constant gen
([#5172](AztecProtocol/aztec-packages#5172))
([394a0e0](AztecProtocol/aztec-packages@394a0e0))
* **docs:** Update quickstart.md
([#5021](AztecProtocol/aztec-packages#5021))
([be9f8a1](AztecProtocol/aztec-packages@be9f8a1))
* Dynamic assert messages in brillig
(noir-lang/noir#4531)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Fix brillig slowdown when assigning arrays in loops
(noir-lang/noir#4472)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Fix deployments
([#5183](AztecProtocol/aztec-packages#5183))
([596253b](AztecProtocol/aztec-packages@596253b))
* Force src impl for == on slices
(noir-lang/noir#4507)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Handling of gh deps in noir_wasm
(noir-lang/noir#4499)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Intermittent invert 0 in Goblin
([#5174](AztecProtocol/aztec-packages#5174))
([3e68b49](AztecProtocol/aztec-packages@3e68b49))
* Iterative flattening pass
(noir-lang/noir#4492)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Noir mirror merge strat
([#5166](AztecProtocol/aztec-packages#5166))
([74fa8d6](AztecProtocol/aztec-packages@74fa8d6))
* **ssa:** Handle mergers of slices returned from calls
(noir-lang/noir#4496)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))


### Miscellaneous

* Add `ModuleDeclaration` struct
(noir-lang/noir#4512)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Add HashMap docs (noir-lang/noir#4457)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Add regression test for issue 4449
(noir-lang/noir#4503)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Better output in ci_deploy_contracts.sh
([#5171](AztecProtocol/aztec-packages#5171))
([8d73f8a](AztecProtocol/aztec-packages@8d73f8a))
* Bump bb to 0.26.3 (noir-lang/noir#4488)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* **ci:** Fix JS publishing workflow checking out inconsistent commits
(noir-lang/noir#4493)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Custom hash for eddsa (noir-lang/noir#4440)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Deterministic mode
([#5155](AztecProtocol/aztec-packages#5155))
([e68b56a](AztecProtocol/aztec-packages@e68b56a))
* Document big integers (noir-lang/noir#4487)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Generalise `FunctionVisibility` to `ItemVisibility`
(noir-lang/noir#4495)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Interaction for a mock first circuit handled inside the `EccOpQueue`
([#4854](AztecProtocol/aztec-packages#4854))
([d9cbdc8](AztecProtocol/aztec-packages@d9cbdc8))
* Move `check_method_signatures` to type checking phase
(noir-lang/noir#4516)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Move templated code for assert_message into the stdlib
(noir-lang/noir#4475)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Organize the `blackbox_solver` crate
(noir-lang/noir#4519)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Pass `import_directive` by reference
(noir-lang/noir#4511)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Pass macro processors by reference
(noir-lang/noir#4501)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Pull out separate function for compiling and running a test
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Release Noir(0.25.0) (noir-lang/noir#4352)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Update cargo deny config (noir-lang/noir#4486)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
* Update various dependencies
(noir-lang/noir#4513)
([58e15ed](AztecProtocol/aztec-packages@58e15ed))
</details>

<details><summary>barretenberg: 0.27.2</summary>

##
[0.27.2](AztecProtocol/aztec-packages@barretenberg-v0.27.1...barretenberg-v0.27.2)
(2024-03-13)


### Features

* Multithreaded prover folding
([#5147](AztecProtocol/aztec-packages#5147))
([94922fc](AztecProtocol/aztec-packages@94922fc))


### Bug Fixes

* Intermittent invert 0 in Goblin
([#5174](AztecProtocol/aztec-packages#5174))
([3e68b49](AztecProtocol/aztec-packages@3e68b49))


### Miscellaneous

* Interaction for a mock first circuit handled inside the `EccOpQueue`
([#4854](AztecProtocol/aztec-packages#4854))
([d9cbdc8](AztecProtocol/aztec-packages@d9cbdc8))
</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