docs: add versions section to updating doc

[jzaki]

No description provided.

[AztecBot]

Docs Preview

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

[AztecBot]

Benchmark results

Metrics with a significant change:

• note_trial_decrypting_time_in_ms (8): 16.7 (-85%)

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 6eb6778c 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,180	238,940	469,952
l1_rollup_execution_gas	194,128	500,246	909,210
l2_block_processing_time_in_ms	1,206 (+2%)	4,502	9,115 (+2%)
note_successful_decrypting_time_in_ms	206 (+5%)	548 (+1%)	1,012 (+2%)
note_trial_decrypting_time_in_ms	⚠️ 16.7 (-85%)	67.3 (+1%)	37.7 (-70%)
l2_block_building_time_in_ms	15,945 (-2%)	64,188 (-1%)	127,885 (-1%)
l2_block_rollup_simulation_time_in_ms	12,115 (-2%)	48,719 (-1%)	97,647 (-1%)
l2_block_public_tx_process_time_in_ms	3,801 (-2%)	15,379	30,088 (-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,361	27,492
note_history_successful_decrypting_time_in_ms	1,251	2,364 (-2%)
note_history_trial_decrypting_time_in_ms	94.7 (-2%)	101 (-28%)
node_database_size_in_bytes	18,788,432	35,586,128 (+1%)
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	256 (+2%)	44,736	28,001
private-kernel-ordering	192	52,625	14,627
base-rollup	1,315	177,932	933
root-rollup	70.2 (-1%)	4,192	825
private-kernel-inner	328 (+3%)	73,715	28,001
public-kernel-app-logic	195	32,254	25,379
merge-rollup	5.77 (+1%)	2,712	933

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.86	10.2 (+1%)	18.0 (+19%)	16.5 (+2%)	22.3	35.9 (+2%)	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.572	0.567	0.761 (+19%)	0.507 (+2%)	0.466	0.445 (+1%)	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.8	72.4	230	445	873	1,745 (+1%)
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.469	0.446	0.420	0.417	0.416 (+1%)	0.416 (+1%)
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	N/A	N/A	N/A	53.8	108	343 (+1%)	659	1,309	2,636 (+1%)
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.479	0.485	0.463 (+1%)	0.455	0.455	0.455
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	N/A	N/A	61.1	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.535	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,610 (-1%)	1,400 (+2%)

Metric	0 public data writes	1 public data writes
tx_sequencer_processing_time_ms	0.0282 (-6%)	476

[critesjosh]

Suggested change

	::note
	:::note

[critesjosh]

Suggested change

	`aztec = { git="https://github.com/AztecProtocol/aztec-packages/", tag="aztec-packages-v0.23.0", directory="yarn-project/aztec-nr/aztec" }`
	```toml
	aztec = { git="https://github.com/AztecProtocol/aztec-packages/", tag="aztec-packages-v0.23.0", directory="yarn-project/aztec-nr/aztec" }

[critesjosh]

formatting got weird because the suggestion is delineated with three back ticks . just need to make sure the code block is closed with three

[critesjosh]

Suggested change

	`aztec = { git="https://github.com/AztecProtocol/aztec-packages/", tag="aztec-packages-v0.24.0", directory="noir-projects/aztec-nr/aztec" }`
	```toml
	aztec = { git="https://github.com/AztecProtocol/aztec-packages/", tag="aztec-packages-v0.24.0", directory="noir-projects/aztec-nr/aztec" }

[critesjosh]

Suggested change

	Example contracts serve as an especially helpful reference between versions of the aztec-nr framework.
	Example contracts serve as a helpful reference between versions of the aztec-nr framework.

[critesjosh]

Maybe link directly to this directory, since you mention it.

[critesjosh]

Suggested change

	The path of the former (once installed) can be seen by hovering over "Nargo" in the bottom status bar, and the latter via `which aztec-nargo`.
	The path of the former (once installed) can be seen by hovering over "Nargo" in the bottom status bar of VS Code, and the latter via the `which aztec-nargo` command.

[critesjosh]

Suggested change

	The second point requires a restart of the extension.
	The second point requires a restart of the extension, which you can trigger with Ctrl + Shift + P and typing "Reload Window".

[critesjosh]

How does a separate window help? Doesn't the LSP always use locally installed version of nargo?

[jzaki]

If you're using the correct version of aztec-nargo with the correct version of your code, all is well. If you happen to open an older versioned contract, and unlucky to hit some error with aztec-nargo and that code version, then vscode will try rerun the extension. This happens 5 times before the extension decides to stop trying.
At that point, even if you close the older example, you'll have to restart Noir LSP extension in the window.

To prevent this scenario the suggestion is to keep your primary window pure, and reference the old code elsewhere. If in another vscode window (not tab), the main window's extension is fine.

Happy to drop this since the "tip" tag is overly prominent for this minor/low-probability devexp optimisation.

[signorecello]

Just a small nit regarding "show don't tell" 👍

[critesjosh]

This is mentioned in the migration notes page. Consider linking there to reduce redundant information. Any developers coming after v0.24 don't need to see this

[critesjosh]

You could remove all of the following lines until ### Example contract versions