feat!: rename storage inclusion proof to historical storage read

[nventuro]

prove_public_value_inclusion forces the caller to produce and pass a historical public storage value. This is subpar because it introduces an oracle requirement for no good reason - there is only one correct value that can be passed.

This PR renames public_value_inclusion to history::storage, and prove_public_value_inclusion to storage_historical_read. The function now returns the historical storage value, so no oracles are needed. If comparison with some value is required, the caller can still manually do this against the return value (though this seems an unlikely use case).

I also updated slightly some of the docs, added some notes, and liberally touched the tests a little bit. This is another example of how annoying it is to not be able to return anything from a private call (forcing us to to perform the assertion inside noir, which makes the test obscure).

[AztecBot]

Docs Preview

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

[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 0f09b63d 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	676	676	676
l1_rollup_calldata_gas	6,388 (-1%)	6,400 (-1%)	6,424
l1_rollup_execution_gas	585,721 (+1%)	585,733 (+1%)	585,757 (+1%)
l2_block_processing_time_in_ms	1,356 (+3%)	4,710 (-3%)	9,018 (-1%)
note_successful_decrypting_time_in_ms	194	521 (-7%)	964 (-7%)
note_trial_decrypting_time_in_ms	97.8 (-5%)	41.6 (-48%)	95.0 (+72%)
l2_block_building_time_in_ms	17,276 (-3%)	65,069 (-3%)	128,973 (-3%)
l2_block_rollup_simulation_time_in_ms	8,032 (-1%)	28,421 (-1%)	56,151
l2_block_public_tx_process_time_in_ms	9,223 (-5%)	36,595 (-5%)	72,725 (-6%)

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,693 (-4%)	26,375 (-2%)
note_history_successful_decrypting_time_in_ms	1,243 (-1%)	2,396 (-3%)
note_history_trial_decrypting_time_in_ms	89.8 (-8%)	143 (-26%)
node_database_size_in_bytes	18,649,168	34,984,016
pxe_database_size_in_bytes	29,859	59,414

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	246 (-13%)	44,302	28,181
private-kernel-ordering	212 (-3%)	52,805	14,263
base-parity	1,829	128	311
base-rollup	703 (-2%)	165,724	861 (-7%)
root-parity	1,512 (-6%)	1,244	311
root-rollup	49.9 (-4%)	4,359 (-3%)	725
private-kernel-inner	590 (-10%)	73,644	28,181
public-kernel-app-logic	396 (-9%)	35,164	28,151
public-kernel-tail	171 (-2%)	40,862	28,151
merge-rollup	7.02 (-19%)	2,568 (-5%)	861 (-7%)

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	9.91 (-2%)	15.9 (-1%)	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.8	31.6	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.577 (-2%)	0.491 (-1%)	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	45.4 (-4%)	72.5	232	441 (-3%)	866	1,716	N/A
batch_insert_into_append_only_tree_32_depth_hash_count	N/A	N/A	96.0	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.466 (-4%)	0.447	0.422	0.411 (-4%)	0.412	0.412	N/A
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	53.3 (-5%)	106 (-1%)	336 (-1%)	650 (-3%)	1,311 (-1%)	2,612	N/A
batch_insert_into_indexed_tree_20_depth_hash_count	N/A	N/A	104	207	691	1,363	2,707	5,395	N/A
batch_insert_into_indexed_tree_20_depth_hash_ms	N/A	N/A	0.474 (-4%)	0.478	0.457 (-1%)	0.447 (-3%)	0.454	0.452	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	61.1 (-3%)
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	109
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.534 (-3%)

Miscellaneous

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

Metric	0 registered classes
tx_size_in_bytes	21,949

Transaction processing duration by data writes.

Metric	0 new note hashes	1 new note hashes
tx_pxe_processing_time_ms	3,069 (-4%)	1,637 (-8%)

Metric	0 public data writes	1 public data writes
tx_sequencer_processing_time_ms	10.5 (-21%)	1,138 (-7%)

[benesjan]

It's a nice improvement. Feel free to merge once you address my nits

[LHerskind]

Few comments on the naming, think it could be more clear that is is public storage.