docs: document stable public state usage

[LHerskind]

Please read contributing guidelines and remove this line.

[LHerskind]

Current dependencies on/for this PR:

• master
  • PR docs: document stable public state usage #4324 👈

This stack of pull requests is managed by Graphite.

[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 f85a8708 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	179,524	716,068
l1_rollup_calldata_gas	221,716	866,980	3,446,584
l1_rollup_execution_gas	314,203	984,720	3,666,241
l2_block_processing_time_in_ms	1,151 (-1%)	4,362	17,253 (-1%)
note_successful_decrypting_time_in_ms	326 (-5%)	904 (-10%)	3,630 (-4%)
note_trial_decrypting_time_in_ms	38.7 (-29%)	36.1 (-28%)	147 (-1%)
l2_block_building_time_in_ms	18,149 (-1%)	71,913	289,842
l2_block_rollup_simulation_time_in_ms	13,057 (-1%)	51,706	208,955
l2_block_public_tx_process_time_in_ms	5,064 (-1%)	20,110 (-1%)	80,632

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,810	26,369 (-1%)
note_history_successful_decrypting_time_in_ms	2,351 (-4%)	4,631 (-4%)
note_history_trial_decrypting_time_in_ms	113 (+26%)	327 (+54%)
node_database_size_in_bytes	17,317,968	33,222,736 (+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	316	44,897	26,193
private-kernel-ordering	192 (-1%)	44,513	14,929
base-rollup	1,414	128,970	881
root-rollup	83.0	4,088	677
private-kernel-inner	422	72,056	26,193
public-kernel-private-input	242	32,615	26,193
public-kernel-non-first-iteration	241	32,657	26,193
merge-rollup	7.60 (-1%)	2,608	881

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.2	10.6 (-7%)	12.6	17.2 (+2%)	26.9 (+18%)	63.8 (-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.594	0.591 (-7%)	0.537	0.532 (+2%)	0.565 (+18%)	0.441 (-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.3 (-2%)	47.5	238 (-1%)	463	901	3,548 (-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 (-2%)	0.488	0.436	0.434	0.429	0.427 (-1%)
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	N/A	N/A	N/A	103 (-2%)	56.6 (-1%)	350	691	1,363	5,406
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.495 (-1%)	0.497	0.474	0.476	0.473 (-1%)	0.471
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	N/A	56.5	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.579	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	37,677

Transaction processing duration by data writes.

Metric	0 new commitments	1 new commitments
tx_pxe_processing_time_ms	604 (+3%)	1,362

Metric	1 public data writes
tx_sequencer_processing_time_ms	626 (-1%)

[benesjan]

LGTM. Just a nit