feat: nullified note retrieval in get_notes and view_notes

[nventuro]

Supercedes #4208, which was closed as that one was created from a fork and we therefore cannot run CI there.

Fixes #3755.

[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 382dfbed 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,728	866,908	3,446,896
l1_rollup_execution_gas	314,215	984,648	3,666,553
l2_block_processing_time_in_ms	1,155 (+1%)	4,320 (-1%)	17,126
note_successful_decrypting_time_in_ms	270 (+7%)	961 (+9%)	3,498 (+5%)
note_trial_decrypting_time_in_ms	82.3 (+27%)	174 (-8%)	147
l2_block_building_time_in_ms	16,695 (+2%)	65,884 (+2%)	264,064 (+1%)
l2_block_rollup_simulation_time_in_ms	11,902 (+1%)	46,957	189,089
l2_block_public_tx_process_time_in_ms	4,759 (+5%)	18,828 (+5%)	74,734 (+4%)

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,716 (+3%)	26,294 (+3%)
note_history_successful_decrypting_time_in_ms	2,285 (+6%)	4,406 (+5%)
note_history_trial_decrypting_time_in_ms	157 (-8%)	224 (+27%)
node_database_size_in_bytes	17,281,104	33,054,800
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	221	44,897	26,193
private-kernel-ordering	181 (+2%)	44,513	14,929 (+1%)
base-rollup	1,259	128,970	881
root-rollup	81.3 (-1%)	4,088	677
private-kernel-inner	321 (+3%)	72,056	26,193
public-kernel-private-input	223 (+3%)	32,615 (+1%)	26,193
public-kernel-non-first-iteration	222 (+4%)	32,657 (+1%)	26,193
merge-rollup	7.58 (-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	12.4 (+10%)	12.6	17.2	22.8	64.2 (+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.694 (+10%)	0.538	0.534	0.478	0.444 (+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	78.2	47.6	238	459	896 (-1%)	3,542
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.484 (+2%)	0.489	0.435	0.430	0.427	0.427
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	N/A	N/A	N/A	107 (+3%)	56.7 (-1%)	347	684	1,357	5,383
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.505 (+2%)	0.497 (-1%)	0.473	0.471	0.471	0.470
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	N/A	56.3	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.577	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 (+1%)	36,454 (+10%)

Transaction processing duration by data writes.

Metric	0 new commitments	1 new commitments
tx_pxe_processing_time_ms	400 (+1%)	1,144 (+2%)

Metric	1 public data writes
tx_sequencer_processing_time_ms	581 (+4%)

[nventuro]

CI fails due to tests shared with MemoryDB, which is not being used. I created #4241 to delete it, once that's merged we can update this branch.

[LHerskind]

You two references to an old pr which I think should have been an issue reference instead.

If you change those two seems good 👍

[critesjosh]

Nice! Should we update documentation anywhere regarding this change?

[nventuro]

Yes! I was not aware of those docs (or rather forgot 😅), will open a PR soon and tag you.