feat(docs): Autogenerated Aztec-nr reference docs

[catmcgee]

JS script with a bunch of Regex for autogenerating Aztec.nr reference in the docs

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]

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 c5eeb4c4 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	54,212	214,436	855,332
l1_rollup_calldata_gas	259,796	1,019,732	4,060,256
l1_rollup_execution_gas	353,982	1,139,180	4,281,657
l2_block_processing_time_in_ms	1,265 (-2%)	5,068 (+5%)	19,053 (-1%)
note_successful_decrypting_time_in_ms	214 (-4%)	617 (-15%)	2,159 (-4%)
note_trial_decrypting_time_in_ms	25.7 (-27%)	55.9 (-13%)	184 (-6%)
l2_block_building_time_in_ms	21,313 (-1%)	84,571 (-1%)	344,346
l2_block_rollup_simulation_time_in_ms	15,987 (-1%)	63,405	259,533
l2_block_public_tx_process_time_in_ms	5,298 (-1%)	21,089 (-1%)	84,566

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	16,082 (-1%)	31,525 (-2%)
note_history_successful_decrypting_time_in_ms	1,408	2,847 (+5%)
note_history_trial_decrypting_time_in_ms	171 (-7%)	265 (+19%)
node_database_size_in_bytes	18,698,320	35,885,136 (-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	333 (-1%)	44,664	27,457
private-kernel-ordering	214	45,777	14,627
base-rollup	1,745	175,344	933
root-rollup	83.8	4,192	825
private-kernel-inner	445	73,099	27,457
public-kernel-app-logic	275	32,254	25,379
merge-rollup	7.81 (-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	128 leaves	64 leaves	512 leaves	1024 leaves	2048 leaves	8192 leaves
batch_insert_into_append_only_tree_16_depth_ms	10.3 (-2%)	11.4 (+2%)	13.0 (-23%)	17.2 (+1%)	23.1 (-1%)	64.6 (-1%)	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	143	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_16_depth_hash_ms	0.597 (-2%)	0.632 (+2%)	0.550 (-23%)	0.530 (+1%)	0.483 (-1%)	0.446 (-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	75.4 (-1%)	48.1 (-2%)	245 (-1%)	468	909 (-1%)	3,589 (-1%)
batch_insert_into_append_only_tree_32_depth_hash_count	N/A	N/A	N/A	N/A	N/A	159	96.0	543	1,055	2,079	8,223
batch_insert_into_append_only_tree_32_depth_hash_ms	N/A	N/A	N/A	N/A	N/A	0.465 (-1%)	0.493 (-2%)	0.441 (-2%)	0.438	0.433 (-1%)	0.432 (-1%)
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	N/A	N/A	N/A	105	57.7 (-1%)	353 (-2%)	699 (+1%)	1,373 (-1%)	5,481 (-1%)
batch_insert_into_indexed_tree_20_depth_hash_count	N/A	N/A	N/A	N/A	N/A	197	104	691	1,363	2,707	10,771
batch_insert_into_indexed_tree_20_depth_hash_ms	N/A	N/A	N/A	N/A	N/A	0.497	0.502 (-1%)	0.480 (-2%)	0.479	0.474 (-1%)	0.475 (-1%)
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	N/A	N/A	65.0	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	110	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.561	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	1 deployed contracts
tx_size_in_bytes	15,388	36,001

Transaction processing duration by data writes.

Metric	0 new commitments	1 new commitments
tx_pxe_processing_time_ms	575 (-1%)	1,505

Metric	0 public data writes	1 public data writes
tx_sequencer_processing_time_ms	0.0260 (-18%)	655

[critesjosh]

I like how in the other reference sections there are short descriptions and an occasional example of the functions with a link to the source code. How difficult would it be to add those to these autogen docs?

It would probably require adding code comments to everything in Aztec.nr...

[catmcgee]

@critesjosh

How difficult would it be to add those to these autogen docs

there are a few descriptions - this script takes any comments written above things as a description. there just aren't many comments. but we could easily go through and comment descriptions. I think we can have that as another task. it's probably good to have those comments in the aztec.nr codebase anyway

added in an autogenerated codeblock which doesnt really help but it looks nice

[signorecello]

Hey @catmcgee does the script parse any pattern like "@description"? Or does it take whatever comment is on top? Just thinking of a situation a dev wants to actually comment something without necessarily being in the docs...

As for the descriptions @critesjosh we can add some but just like with Noir devs, this would go and be maintained by the engineering team.

Great work Cat!

[catmcgee]

@signorecello it just takes the comment above the declaration (unless its a docs: comment, then it takes a comment above). most of the non-description related comments aren't in that position, but there are a few TODOs and warnings that are getting picked up

what do you think? should we have a specific description keyword?

[critesjosh]

for now do you think we should get this one merged, and add more descriptive comments & parsing as another task (probably wont be done til after eng offsite)?

yea sounds good to me

[socket-security]

No dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No dependency changes detected in pull request