feat: PublicImmutable impl

[benesjan]

Fixes #4757

[benesjan]

Current dependencies on/for this PR:

• feat: PublicImmutable impl #4758 👈
• feat!: renamings of state var wrappers #4739
• master

This stack of pull requests is managed by Graphite.

[AztecBot]

Benchmark results

Metrics with a significant change:

• circuit_simulation_time_in_ms (private-kernel-init): 293 (+21%)
• circuit_simulation_time_in_ms (base-rollup): 1,546 (+18%)
• circuit_simulation_time_in_ms (private-kernel-inner): 378 (+22%)
• circuit_simulation_time_in_ms (public-kernel-app-logic): 234 (+24%)
• tx_pxe_processing_time_ms (0): 1,081 (-57%)
• tx_sequencer_processing_time_ms (1): 564 (+22%)
• l2_block_building_time_in_ms (8): 21,738 (+36%)
• l2_block_building_time_in_ms (32): 85,995 (+35%)
• l2_block_building_time_in_ms (128): 348,513 (+36%)
• l2_block_rollup_simulation_time_in_ms (8): 16,277 (+33%)
• l2_block_rollup_simulation_time_in_ms (32): 64,421 (+32%)
• l2_block_rollup_simulation_time_in_ms (128): 262,719 (+33%)
• l2_block_public_tx_process_time_in_ms (8): 5,431 (+47%)
• l2_block_public_tx_process_time_in_ms (32): 21,496 (+46%)
• l2_block_public_tx_process_time_in_ms (128): 85,537 (+46%)
• note_trial_decrypting_time_in_ms (8): 36.1 (+125%)

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 237f870c 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,928	1,019,336	4,060,328
l1_rollup_execution_gas	354,114	1,138,784	4,281,729
l2_block_processing_time_in_ms	1,287 (+6%)	4,812 (-5%)	19,030 (+5%)
note_successful_decrypting_time_in_ms	224 (+11%)	614 (+6%)	2,178 (+11%)
note_trial_decrypting_time_in_ms	⚠️ 36.1 (+125%)	56.6 (-52%)	186 (+13%)
l2_block_building_time_in_ms	⚠️ 21,738 (+36%)	⚠️ 85,995 (+35%)	⚠️ 348,513 (+36%)
l2_block_rollup_simulation_time_in_ms	⚠️ 16,277 (+33%)	⚠️ 64,421 (+32%)	⚠️ 262,719 (+33%)
l2_block_public_tx_process_time_in_ms	⚠️ 5,431 (+47%)	⚠️ 21,496 (+46%)	⚠️ 85,537 (+46%)

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	14,933 (-3%)	29,025 (-2%)
note_history_successful_decrypting_time_in_ms	1,248 (-14%)	2,419 (-7%)
note_history_trial_decrypting_time_in_ms	104 (-34%)	148 (-44%)
node_database_size_in_bytes	18,600,016 (-3%)	35,242,064 (-3%)
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	⚠️ 293 (+21%)	44,664	27,457
private-kernel-ordering	187 (+20%)	45,777	14,627
base-rollup	⚠️ 1,546 (+18%)	175,344	933
root-rollup	76.1 (+6%)	4,192	825
private-kernel-inner	⚠️ 378 (+22%)	73,099	27,457
public-kernel-app-logic	⚠️ 234 (+24%)	32,254	25,379
merge-rollup	6.93 (+19%)	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.2 (+3%)	11.3 (-2%)	13.4 (+5%)	16.5 (-2%)	23.5 (+6%)	64.8 (-20%)	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.590 (+3%)	0.627 (-2%)	0.565 (+6%)	0.508 (-2%)	0.490 (+5%)	0.447 (-20%)	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 (+3%)	48.0 (+4%)	244 (+4%)	446	925 (+6%)	3,609 (+5%)
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 (+2%)	0.491 (+4%)	0.444 (+6%)	0.417	0.439 (+6%)	0.433 (+5%)
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	N/A	N/A	N/A	104 (+3%)	56.3 (+1%)	359 (+5%)	669	1,380 (+3%)	5,481 (+4%)
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.493 (+3%)	0.491 (+1%)	0.482 (+4%)	0.459 (+1%)	0.477 (+3%)	0.476 (+4%)
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	N/A	N/A	63.9 (+3%)	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.550 (+2%)	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	16,162 (-12%)	36,001

Transaction processing duration by data writes.

Metric	0 new note hashes	1 new note hashes
tx_pxe_processing_time_ms	⚠️ 1,081 (-57%)	1,413 (+8%)

Metric	0 public data writes	1 public data writes
tx_sequencer_processing_time_ms	0.0292 (-18%)	⚠️ 564 (+22%)

[LHerskind]

I don't really see the value in this type of storage. The readability from the shared, is still only for your own contract so you would get the same properties as here just by not calling the read_private function. Would it be better to simple call the read_public in for read and then it seems like you have this one, and if you don't need the private read don't use it, zero extra cost 🤷

That said, code wise it looks fine. Calling in help for input, but if Rahul is ok with it, then I think the code is fine, with a small comment on the markdown

@rahul-kothari do you have any input here?

[LHerskind]

I'm not really sure if you would really want to do it this way. For stuff like decimals that you might rely on in other contexts, it seems a bit painful to then also have it in private and need to handle it both places to have the features.

On that note. Might be useful for us to consider looking into autogenerating some of the getter/view functions for storage? 👀

[benesjan]

Addressed in 215bafb

[LHerskind]

Is this actually true? It is public storage so you would just be reading from the value at the storage slot, so if it is updated you would just get the updated value.

[benesjan]

Addressed in 215bafb

[rahul-kothari]

@LHerskind I see what you mean. Code wise there is no difference between SharedImmutable and this. But no one will know to use sharedImmutable for public

Maybe if the maintenance cost becomes too high we can kill it?

[AztecBot]

Docs Preview

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