chore(docs): restructure improvs

[signorecello]

In line with the latest restructure, here are some QoL things we pointed out to be iterated:

• Added back api docs to their rightful place
• Removed nested structure to make links smaller
• Refactored all the links to reflect the above

To do in a later PR:

• Rewrite URLs to be relative

[signorecello]

• chore(docs): zp's nits #6608
• chore(docs): rewriting absolute paths #6511
• chore(docs): restructure improvs #6502 👈
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @signorecello and the rest of your teammates on Graphite

[AztecBot]

Docs Preview

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

[AztecBot]

Benchmark results

Metrics with a significant change:

• app_circuit_proving_time_in_ms (FPC:fee_entrypoint_public): 16,467 (+91%)
• app_circuit_proving_time_in_ms (FPC:fee_entrypoint_private): 8,999 (-45%)
• protocol_circuit_witness_generation_time_in_ms (base-parity): 352 (-54%)
• protocol_circuit_witness_generation_time_in_ms (public-kernel-setup): 360 (-19%)
• protocol_circuit_witness_generation_time_in_ms (public-kernel-app-logic): 298 (-41%)
• protocol_circuit_witness_generation_time_in_ms (public-kernel-tail): 974 (+40%)
• protocol_circuit_proving_time_in_ms (base-parity): 4,284 (+18%)
• protocol_circuit_proving_time_in_ms (public-kernel-app-logic): 668 (-33%)
• protocol_circuit_proving_time_in_ms (merge-rollup): 1,651 (-29%)

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.

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	772	772	772
l1_rollup_calldata_gas	6,820	6,856	6,856
l1_rollup_execution_gas	587,360	587,396	587,396
l2_block_processing_time_in_ms	1,378 (+2%)	5,174 (+2%)	10,286 (+3%)
l2_block_building_time_in_ms	33,458	131,912 (+1%)	262,853
l2_block_rollup_simulation_time_in_ms	33,275	131,267 (+1%)	261,501
l2_block_public_tx_process_time_in_ms	15,488	66,646 (+1%)	134,368 (-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	15,268 (+1%)	28,537 (+1%)
node_database_size_in_bytes	21,409,872	38,010,960
pxe_database_size_in_bytes	29,868	59,425

Circuits stats

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

Circuit	protocol_circuit_simulation_time_in_ms	protocol_circuit_witness_generation_time_in_ms	protocol_circuit_proving_time_in_ms	protocol_circuit_input_size_in_bytes	protocol_circuit_output_size_in_bytes	protocol_circuit_proof_size_in_bytes	protocol_circuit_num_public_inputs	protocol_circuit_size_in_gates
private-kernel-init	155 (+1%)	3,651 (-2%)	21,666 (-1%)	19,987	61,999	86,720	2,643	1,048,576
private-kernel-inner	543 (+1%)	4,367 (-11%)	43,493 (+1%)	89,054	61,999	86,720	2,643	2,097,152
private-kernel-reset	968 (+1%)	6,848 (+3%)	88,366 (+1%)	330,433	61,999	86,720	2,643	4,194,304
private-kernel-tail	537 (+1%)	4,884 (-4%)	39,039 (+1%)	86,849	79,454	10,688	267	2,097,152
base-parity	7.71 (+1%)	⚠️ 352 (-54%)	⚠️ 4,284 (+18%)	128	64.0	2,208	2.00	131,072
root-parity	48.7 (-1%)	131 (-9%)	39,631 (+1%)	27,064	64.0	2,720	18.0	2,097,152
base-rollup	854	4,773 (+4%)	43,225 (-1%)	111,158	957	3,136	31.0	2,097,152
root-rollup	65.7	172 (-3%)	8,348 (+1%)	11,518	821	3,456	41.0	524,288
public-kernel-app-logic	189	⚠️ 298 (-41%)	⚠️ 668 (-33%)	96,979	85,095	116,448	3,572	4,096
public-kernel-tail	852	⚠️ 974 (+40%)	1,189 (+9%)	388,207	7,755	10,176	251	512
public-kernel-setup	165 (+4%)	⚠️ 360 (-19%)	1,015 (+13%)	138,310	85,095	116,448	3,572	4,096
public-kernel-teardown	169 (-1%)	434 (-6%)	1,084 (-1%)	143,321	85,095	116,448	3,572	4,096
merge-rollup	6.53	84.2 (-29%)	⚠️ 1,651 (-29%)	2,760	957	3,136	31.0	65,536
private-kernel-tail-to-public	N/A	10,513 (-1%)	68,338 (-1%)	N/A	N/A	116,960	3,588	4,194,304

Stats on running time collected for app circuits

Function	app_circuit_proof_size_in_bytes	app_circuit_proving_time_in_ms	app_circuit_size_in_gates	app_circuit_num_public_inputs
SchnorrAccount:entrypoint	16,128	47,929 (-2%)	2,097,152	437
Test:emit_nullifier	16,128	2,680 (+15%)	65,536	437
FPC:fee_entrypoint_public	16,128	⚠️ 16,467 (+91%)	524,288	437
FPC:fee_entrypoint_private	16,128	⚠️ 8,999 (-45%)	524,288	437
Token:unshield	16,128	53,716 (-1%)	2,097,152	437
SchnorrAccount:spend_private_authwit	16,128	4,278 (+3%)	131,072	437
Token:transfer	16,128	35,112	2,097,152	437

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	11.3 (-1%)	18.4	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.7	31.8	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.658 (-2%)	0.565	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	52.6	81.5 (+1%)	266 (+2%)	505	1,008 (+2%)	1,990 (+2%)	N/A
batch_insert_into_append_only_tree_32_depth_hash_count	N/A	N/A	95.9	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.538 (-1%)	0.502 (+1%)	0.482 (+1%)	0.472	0.478 (+2%)	0.475 (+2%)	N/A
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	62.8 (+1%)	121 (+2%)	383 (+1%)	742	1,497	2,989 (+2%)	N/A
batch_insert_into_indexed_tree_20_depth_hash_count	N/A	N/A	106	208	692	1,363	2,707	5,395	N/A
batch_insert_into_indexed_tree_20_depth_hash_ms	N/A	N/A	0.545	0.543 (+1%)	0.519 (+1%)	0.510	0.518 (+2%)	0.520 (+2%)	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	68.1 (+1%)
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	108
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.596 (+1%)

Miscellaneous

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

Metric	0 registered classes	1 registered classes
tx_size_in_bytes	84,743	673,221

Transaction size based on fee payment method

| Metric | |
| - | |

Transaction processing duration by data writes.

Metric	0 new note hashes	1 new note hashes	2 new note hashes
tx_pxe_processing_time_ms	37,668 (+1%)	3,552	112,356

Metric	0 public data writes	1 public data writes	2 public data writes	4 public data writes	8 public data writes
tx_sequencer_processing_time_ms	1,478 (+1%)	2,130	1,847	2,760 (+1%)	1,764 (+1%)

[github-actions]

Changes to circuit sizes

Generated at commit: 1ecce50f19f63e60083b7145826667a0adff3846, compared to commit: 07dc0726501bc78d691e1d2360dda84d1a93b9c5

🧾 Summary (100% most significant diffs)

Program	ACIR opcodes (+/-)	%	Circuit size (+/-)	%
rollup_base_simulated	0 ➖	0.00%	+1 ❌	+2.17%
private_kernel_tail_simulated	0 ➖	0.00%	+1 ❌	+0.38%
public_kernel_tail_simulated	0 ➖	0.00%	+1 ❌	+0.38%
rollup_root	+2 ❌	+0.14%	+314 ❌	+0.11%
public_kernel_app_logic	+6 ❌	+0.00%	+598 ❌	+0.08%
public_kernel_teardown	+5 ❌	+0.00%	+316 ❌	+0.05%
public_kernel_setup	+2 ❌	+0.00%	+313 ❌	+0.05%
private_kernel_tail	+388 ❌	+0.20%	+543 ❌	+0.04%
private_kernel_init_simulated	0 ➖	0.00%	+1 ❌	+0.04%
private_kernel_inner_simulated	0 ➖	0.00%	+1 ❌	+0.04%
private_kernel_reset_simulated	0 ➖	0.00%	+1 ❌	+0.04%
private_kernel_inner	+8 ❌	+0.00%	+629 ❌	+0.04%
private_kernel_tail_to_public_simulated	0 ➖	0.00%	+1 ❌	+0.03%
public_kernel_app_logic_simulated	0 ➖	0.00%	+1 ❌	+0.03%
public_kernel_setup_simulated	0 ➖	0.00%	+1 ❌	+0.03%
public_kernel_teardown_simulated	0 ➖	0.00%	+1 ❌	+0.03%
private_kernel_tail_to_public	+388 ❌	+0.06%	+543 ❌	+0.03%
private_kernel_init	+7 ❌	+0.00%	+161 ❌	+0.02%
rollup_base	+2 ❌	+0.00%	+312 ❌	+0.02%
private_kernel_reset	+1 ❌	+0.00%	+157 ❌	+0.01%
public_kernel_tail	+1 ❌	+0.00%	+2 ❌	+0.00%
rollup_merge	+2 ❌	+0.66%	0 ➖	0.00%

---

Full diff report 👇

Program	ACIR opcodes (+/-)	%	Circuit size (+/-)	%
rollup_base_simulated	1 (0)	0.00%	47 (+1)	+2.17%
private_kernel_tail_simulated	1 (0)	0.00%	267 (+1)	+0.38%
public_kernel_tail_simulated	1 (0)	0.00%	267 (+1)	+0.38%
rollup_root	1,407 (+2)	+0.14%	296,070 (+314)	+0.11%
public_kernel_app_logic	251,898 (+6)	+0.00%	797,546 (+598)	+0.08%
public_kernel_teardown	223,524 (+5)	+0.00%	668,190 (+316)	+0.05%
public_kernel_setup	223,318 (+2)	+0.00%	667,897 (+313)	+0.05%
private_kernel_tail	195,033 (+388)	+0.20%	1,316,889 (+543)	+0.04%
private_kernel_init_simulated	1 (0)	0.00%	2,643 (+1)	+0.04%
private_kernel_inner_simulated	1 (0)	0.00%	2,643 (+1)	+0.04%
private_kernel_reset_simulated	1 (0)	0.00%	2,643 (+1)	+0.04%
private_kernel_inner	262,669 (+8)	+0.00%	1,712,686 (+629)	+0.04%
private_kernel_tail_to_public_simulated	1 (0)	0.00%	3,588 (+1)	+0.03%
public_kernel_app_logic_simulated	1 (0)	0.00%	3,588 (+1)	+0.03%
public_kernel_setup_simulated	1 (0)	0.00%	3,588 (+1)	+0.03%
public_kernel_teardown_simulated	1 (0)	0.00%	3,588 (+1)	+0.03%
private_kernel_tail_to_public	621,556 (+388)	+0.06%	2,147,294 (+543)	+0.03%
private_kernel_init	228,121 (+7)	+0.00%	836,653 (+161)	+0.02%
rollup_base	181,127 (+2)	+0.00%	1,776,900 (+312)	+0.02%
private_kernel_reset	249,713 (+1)	+0.00%	2,495,407 (+157)	+0.01%
public_kernel_tail	1,029,431 (+1)	+0.00%	3,709,841 (+2)	+0.00%
rollup_merge	304 (+2)	+0.66%	45,980 (0)	0.00%

[signorecello]

Merge activity

• May 29, 8:07 AM EDT: @signorecello started a stack merge that includes this pull request via Graphite.