feat(docs): DIP1 - Extracting how-tos

[catmcgee]

Closes AztecProtocol/dev-rel#110
Closes #3282
Closes AztecProtocol/dev-rel#114
Closes AztecProtocol/dev-rel#116

[AztecBot]

Benchmark results

Metrics with a significant change:

• note_trial_decrypting_time_in_ms (32): 114 (+159%)

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 e78b86f9 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,412 (-1%)	179,524 (-1%)	716,068 (-1%)
l1_rollup_calldata_gas	221,644 (-1%)	866,908	3,448,492 (-1%)
l1_rollup_execution_gas	314,131 (-1%)	984,648 (-1%)	3,668,149
l2_block_processing_time_in_ms	1,146 (-2%)	4,380	17,170 (-2%)
note_successful_decrypting_time_in_ms	325	878 (-14%)	3,546 (-8%)
note_trial_decrypting_time_in_ms	37.6 (+13%)	⚠️ 114 (+159%)	141 (-10%)
l2_block_building_time_in_ms	18,007 (+1%)	71,519 (+1%)	286,591 (+1%)
l2_block_rollup_simulation_time_in_ms	12,927 (-1%)	51,367 (-1%)	206,645 (-1%)
l2_block_public_tx_process_time_in_ms	5,055 (+8%)	20,029 (+7%)	79,696 (+7%)

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	13,442 (-2%)	25,546 (-4%)
note_history_successful_decrypting_time_in_ms	2,297 (-3%)	4,465 (-5%)
note_history_trial_decrypting_time_in_ms	165 (+59%)	199 (-14%)
node_database_size_in_bytes	17,293,392	33,206,352 (+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	315 (+3%)	44,897 (+1%)	26,193 (+1%)
private-kernel-ordering	191 (-2%)	44,513 (+1%)	14,929 (-8%)
base-rollup	1,394 (-1%)	128,970	881 (-6%)
root-rollup	81.6 (-3%)	4,088 (-2%)	677 (-7%)
private-kernel-inner	421 (-4%)	72,056 (+1%)	26,193 (+1%)
public-kernel-private-input	240	32,615 (+1%)	26,193 (+1%)
public-kernel-non-first-iteration	239 (+1%)	32,657 (+1%)	26,193 (+1%)
merge-rollup	7.91 (-1%)	2,608 (-4%)	881 (-6%)

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	10.8 (-1%)	12.6 (-2%)	17.0 (-4%)	22.9 (-1%)	63.6 (-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	143	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_16_depth_hash_ms	0.597	0.602 (-1%)	0.540 (-1%)	0.526 (-3%)	0.478 (-1%)	0.439 (-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	74.4 (-5%)	47.7	238 (-1%)	461	899 (-1%)	3,538 (-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.460 (-5%)	0.490	0.435 (-1%)	0.432	0.428	0.426 (-1%)
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	N/A	N/A	N/A	104 (-1%)	56.7	349 (-3%)	687	1,369	5,398 (-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.494 (-1%)	0.497	0.474 (-2%)	0.474	0.474	0.471 (-1%)
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	N/A	56.6	N/A	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	94.1	N/A	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	0.580	N/A	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,575 (-8%)	36,576 (-9%)

Transaction processing duration by data writes.

Metric	0 new commitments	1 new commitments
tx_pxe_processing_time_ms	582 (+5%)	1,357 (+4%)

Metric	1 public data writes
tx_sequencer_processing_time_ms	621 (+8%)

[critesjosh]

Overall i really like the new structure and I think it will make it easier to navigate. Most of my suggestions are just implementation details (links, code refs, missing pages in the sidebar) and not pertaining to the overall structure.

[critesjosh]

Should we link the reference code to source somewhere, so if the API changes the docs automatically reflect that?

[catmcgee]

i cant find it anywhere in the monorepo. only overcomplicated examples. wdyt?

[critesjosh]

Should we link the reference code to source somewhere, so if the API changes the docs automatically reflect that?

[critesjosh]

could be this https://github.com/AztecProtocol/aztec-packages/blob/master//yarn-project/end-to-end/src/guides/writing_an_account_contract.test.ts#L58-L63

[critesjosh]

Should we link the reference code to source somewhere, so if the API changes the docs automatically reflect that?

[critesjosh]

Should we link the reference code to source somewhere, so if the API changes the docs automatically reflect that?

[signorecello]

I'm approving because it looks good to me, but don't merge before solving the git conflicts I pointed out!