refactor: Make get notes return all notes at beginning of array #4991

[sklppy88]

Resolves #4991

[AztecBot]

Benchmark results

Metrics with a significant change:

• circuit_simulation_time_in_ms (private-kernel-inner): 407 (+75%)
• circuit_simulation_time_in_ms (public-kernel-app-logic): 243 (+157%)
• circuit_simulation_time_in_ms (public-kernel-setup): 138 (+54%)
• tx_pxe_processing_time_ms (0): 2,274 (+30%)
• tx_pxe_processing_time_ms (1): 1,412 (+16%)
• tx_pxe_processing_time_ms (2): 6,196 (+42%)
• tx_sequencer_processing_time_ms (0): 15.8 (+59%)
• tx_sequencer_processing_time_ms (1): 853 (+48%)
• tx_sequencer_processing_time_ms (4): 591 (+24%)
• tx_sequencer_processing_time_ms (5): 2,897 (+46%)
• tx_size_in_bytes (0): 18,451 (+23%)
• l2_block_building_time_in_ms (8): 14,695 (+25%)
• l2_block_building_time_in_ms (32): 54,976 (+27%)
• l2_block_building_time_in_ms (64): 109,549 (+28%)
• l2_block_public_tx_process_time_in_ms (8): 6,943 (+52%)
• l2_block_public_tx_process_time_in_ms (32): 27,519 (+53%)
• l2_block_public_tx_process_time_in_ms (64): 55,292 (+52%)
• note_successful_decrypting_time_in_ms (8): 201 (+23%)
• note_trial_decrypting_time_in_ms (32): 108 (+222%)

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 4064e180 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,412	6,412	6,418
l1_rollup_execution_gas	585,745	585,745	585,751
l2_block_processing_time_in_ms	1,376 (+4%)	4,809 (+3%)	9,372 (+4%)
note_successful_decrypting_time_in_ms	⚠️ 201 (+23%)	540 (+5%)	1,021 (+4%)
note_trial_decrypting_time_in_ms	55.8 (-18%)	⚠️ 108 (+222%)	101 (-9%)
l2_block_building_time_in_ms	⚠️ 14,695 (+25%)	⚠️ 54,976 (+27%)	⚠️ 109,549 (+28%)
l2_block_rollup_simulation_time_in_ms	7,732 (+8%)	27,405 (+9%)	54,139 (+10%)
l2_block_public_tx_process_time_in_ms	⚠️ 6,943 (+52%)	⚠️ 27,519 (+53%)	⚠️ 55,292 (+52%)

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,117 (-5%)	27,008 (-4%)
note_history_successful_decrypting_time_in_ms	1,267 (-1%)	2,486 (+1%)
note_history_trial_decrypting_time_in_ms	94.1 (-29%)	157 (+6%)
node_database_size_in_bytes	18,640,976	34,975,824
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	211 (+13%)	44,378	28,214
private-kernel-ordering	191 (+12%)	52,880	14,296
base-parity	3,903 (+13%)	128	311
root-parity	1,380 (+10%)	1,244	311
base-rollup	16,633 (+13%)	165,760	861
root-rollup	49.8 (+1%)	4,359	725
private-kernel-inner	⚠️ 407 (+75%)	73,794	28,214
public-kernel-app-logic	⚠️ 243 (+157%)	35,251	28,217
public-kernel-tail	156 (+15%)	40,928	28,217
merge-rollup	8.27 (-9%)	2,568	861
public-kernel-teardown	94.6 (+4%)	35,252	28,217
public-kernel-setup	⚠️ 138 (+54%)	35,252	28,217

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	10.0 (+1%)	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.585 (+1%)	0.493 (+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	47.1 (+3%)	72.7 (+3%)	235 (+5%)	445	884 (+5%)	1,726 (+4%)	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.484 (+3%)	0.448 (+3%)	0.429 (+5%)	0.416	0.419 (+5%)	0.414 (+4%)	N/A
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	55.2 (+1%)	107 (+2%)	337 (+2%)	661	1,319 (+4%)	2,607 (+4%)	N/A
batch_insert_into_indexed_tree_20_depth_hash_count	N/A	N/A	104 (-1%)	207	691	1,363	2,707	5,395	N/A
batch_insert_into_indexed_tree_20_depth_hash_ms	N/A	N/A	0.488 (+1%)	0.483 (+2%)	0.460 (+3%)	0.455	0.457 (+4%)	0.454 (+4%)	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.6 (+2%)
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.538 (+2%)

Miscellaneous

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

Metric	0 registered classes	1 registered classes
tx_size_in_bytes	⚠️ 18,451 (+23%)	495,320

Transaction size based on fee payment method

Metric	none fee payment method	native fee payment method	fpc_public fee payment method	fpc_private fee payment method
tx_with_fee_size_in_bytes	773	905	1,161	1,377

Transaction processing duration by data writes.

Metric	0 new note hashes	1 new note hashes	2 new note hashes
tx_pxe_processing_time_ms	⚠️ 2,274 (+30%)	⚠️ 1,412 (+16%)	⚠️ 6,196 (+42%)

Metric	0 public data writes	1 public data writes	2 public data writes	3 public data writes	4 public data writes	5 public data writes	8 public data writes
tx_sequencer_processing_time_ms	⚠️ 15.8 (+59%)	⚠️ 853 (+48%)	457 (+6%)	1,172 (+2%)	⚠️ 591 (+24%)	⚠️ 2,897 (+46%)	563 (+3%)

[sklppy88]

@LHerskind: Requested as a sanity check, of the main impl. Also having some pain figuring out the best way to mock the response, as it seems that the code surrounding the one we need is unable to deserialize an undefined value. Maybe I'm doing it wrong though and not mocking the right place. Anywho I have a few qns for tomorrow 🙏 😄

[LHerskind]

Can you create a test that explicitly make this return a different array that what the oracle produces 👍

[nventuro]

I'd strongly recommend holding this off until we can test this from noir directly. There we'd simply mock the oracle response and test the noir return value from noir itself. The end to end approach has a million in-between layers that make the test a) way harder to write b) way harder to read and ensure correctness c) way slower.

[sklppy88]

I'd strongly recommend holding this off until we can test this from noir directly. There we'd simply mock the oracle response and test the noir return value from noir itself. The end to end approach has a million in-between layers that make the test a) way harder to write b) way harder to read and ensure correctness c) way slower.

I don't disagree, I've had to deal with the pain of trying to write this test that hopefully made even a modicum of sense. Somewhere down the line I realized that to do it optimally I needed to be able to mock a function from noir directly—even the oracle mock wouldn't allow for what I'd want it to do; and when I realized the above, I had to do this dumb work around.

That said, I'm also happy with merging and opening another issue that can be addressed to directly test in noir once noir has support for it. Up to you guys !

[benesjan]

Looks good. Just please clean up the 2 things.

[sklppy88]

Looks good. Just please clean up the 2 things.

Addressed, thanks for the review(s) 🙏