feat!: make note_getter return BoundedVec instead of an Option array

[nventuro]

note_getter was collapsing all returned notes at the beginning of the options array, which allowed us to iterate over options.limit instead of len(), but this was quite tricky to realize and harder to explain and realize was correct. This new interface avoids this issue entirely, though it does require for the user to be familiar with usage of BoundedVec and the fact that Noir loops must be compile-time bounded.

This slightly reduces gate counts since we no longer have all of the _is_some booleans, but the big win will be once we begin setting limit properly. Also, once this is merged, we can use the utils::colapse function from #7016 inside note_getter for further gate count reductions.

[benesjan]

Nice improvement. LGTM

[AztecBot]

Docs Preview

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

[AztecBot]

Benchmark results

Metrics with a significant change:

• avm_simulation_time_ms (Token:transfer_public): 54.1 (+38%)

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.

Proof generation

Each column represents the number of threads used in proof generation.

Metric	1 threads	4 threads	16 threads	32 threads	64 threads
proof_construction_time_sha256_30_ms	11,421	3,171 (+4%)	1,371 (-2%)	1,431 (-10%)	1,457 (-5%)
proof_construction_time_sha256_100_ms	45,177 (+1%)	12,116 (+1%)	5,755 (+2%)	5,692 (+2%)	5,537 (+1%)
proof_construction_time_poseidon_hash_ms	78.0	34.0	34.0	57.0	85.0 (-3%)
proof_construction_time_poseidon_hash_30_ms	1,515	417	202	225 (-3%)	263
proof_construction_time_poseidon_hash_100_ms	5,743	1,572	728	788 (+2%)	797

L2 block published to L1

Each column represents the number of txs on an L2 block published to L1.

Metric	4 txs	8 txs	16 txs
l1_rollup_calldata_size_in_bytes	1,412	1,412	1,412
l1_rollup_calldata_gas	9,476	9,468	9,464
l1_rollup_execution_gas	610,297	610,289	610,285
l2_block_processing_time_in_ms	751	1,443 (+4%)	2,679 (+1%)
l2_block_building_time_in_ms	25,527 (+1%)	51,432 (+2%)	99,578 (+1%)
l2_block_rollup_simulation_time_in_ms	25,432 (+1%)	51,112 (+2%)	99,227 (+1%)
l2_block_public_tx_process_time_in_ms	21,829 (+1%)	47,326 (+2%)	95,533 (+1%)

L2 chain processing

Each column represents the number of blocks on the L2 chain where each block has 8 txs.

Metric	3 blocks	5 blocks
node_history_sync_time_in_ms	7,045 (+2%)	9,937 (+3%)
node_database_size_in_bytes	12,165,200	16,023,632
pxe_database_size_in_bytes	16,254	26,813

Circuits stats

Stats on running time and I/O sizes collected for every kernel circuit run across all benchmarks.

Circuit	simulation_time_in_ms	witness_generation_time_in_ms	proving_time_in_ms	input_size_in_bytes	output_size_in_bytes	proof_size_in_bytes	num_public_inputs	size_in_gates
private-kernel-init	130 (+2%)	472	13,560 (+5%)	20,634	67,190	92,352	2,819	524,288
private-kernel-inner	393 (+1%)	980 (+3%)	48,912 (-2%)	94,902	67,190	92,352	2,819	2,097,152
private-kernel-tail	371 (+1%)	1,810 (-3%)	49,853 (-1%)	99,121	71,733	14,912	399	2,097,152
base-parity	6.21 (-3%)	1,951 (+2%)	2,853 (+5%)	128	64.0	2,208	2.00	131,072
root-parity	49.3 (+2%)	70.1 (+5%)	41,422 (+4%)	27,100	64.0	2,720	18.0	2,097,152
base-rollup	7,921 (+2%)	4,455 (+3%)	86,618 (-1%)	170,330	756	3,648	47.0	4,194,304
root-rollup	110	80.8 (+1%)	25,219 (+14%)	25,309	620	3,456	41.0	1,048,576
public-kernel-setup	722 (+1%)	3,256 (-1%)	45,023	116,905	93,334	125,344	3,850	2,097,152
public-kernel-app-logic	613 (+1%)	4,152 (+1%)	50,345 (+11%)	116,905	93,334	125,344	3,850	2,097,152
public-kernel-tail	1,424 (+2%)	34,026 (-4%)	188,186 (-3%)	511,910	10,014	14,912	399	8,388,608
private-kernel-reset-small	595 (+1%)	2,185 (+11%)	46,366	123,313	67,190	92,352	2,819	2,097,152
public-kernel-teardown	620 (+1%)	4,274 (+2%)	48,341 (+2%)	116,905	93,334	125,344	3,850	2,097,152
merge-rollup	28.9 (+1%)	N/A	N/A	16,542	756	N/A	N/A	N/A
private-kernel-tail-to-public	N/A	7,093 (+3%)	98,911 (-2%)	N/A	N/A	125,344	3,850	4,194,304

Stats on running time collected for app circuits

Function	input_size_in_bytes	output_size_in_bytes	witness_generation_time_in_ms	proof_size_in_bytes	proving_time_in_ms	size_in_gates	num_public_inputs
ContractClassRegisterer:register	1,344	9,944	405 (+2%)	N/A	N/A	N/A	N/A
ContractInstanceDeployer:deploy	1,408	9,944	40.0	N/A	N/A	N/A	N/A
MultiCallEntrypoint:entrypoint	1,920	9,944	1,771	N/A	N/A	N/A	N/A
GasToken:deploy	1,376	9,944	960 (-1%)	N/A	N/A	N/A	N/A
SchnorrAccount:constructor	1,312	9,944	1,424 (-1%)	N/A	N/A	N/A	N/A
SchnorrAccount:entrypoint	2,304	9,944	2,865 (+2%)	16,768	54,534	2,097,152	457
Token:privately_mint_private_note	1,280	9,944	1,672 (+1%)	N/A	N/A	N/A	N/A
FPC:fee_entrypoint_public	1,344	9,944	358	16,768	11,160 (+2%)	524,288	457
Token:transfer	1,312	9,944	4,807 (-1%)	16,768	50,279 (-1%)	2,097,152	457
AuthRegistry:set_authorized (avm)	21,043	N/A	N/A	87,200	1,395 (+5%)	N/A	N/A
Token:transfer_public (avm)	44,971	N/A	N/A	87,865	4,851 (+4%)	N/A	N/A
AuthRegistry:consume (avm)	34,973	N/A	N/A	87,616	3,063 (+5%)	N/A	N/A
Benchmarking:create_note	1,344	9,944	1,402 (+2%)	N/A	N/A	N/A	N/A
SchnorrAccount:spend_private_authwit	1,280	9,944	76.5	N/A	N/A	N/A	N/A
Token:unshield	1,376	9,944	3,978	N/A	N/A	N/A	N/A
FPC:fee_entrypoint_private	1,376	9,944	4,930	N/A	N/A	N/A	N/A

AVM Simulation

Time to simulate various public functions in the AVM.

Function	time_ms	bytecode_size_in_bytes
GasToken:_increase_public_balance	71.5 (+4%)	13,873
GasToken:set_portal	17.5 (+1%)	3,495
Token:constructor	95.0	24,207
FPC:constructor	62.4 (-3%)	13,893
GasToken:mint_public	53.4 (+3%)	10,241
Token:mint_public	71.0 (+16%)	19,216
Token:assert_minter_and_mint	222 (-2%)	13,034
AuthRegistry:set_authorized	33.3 (-3%)	7,869
FPC:prepare_fee	174 (-20%)	15,187
Token:transfer_public	⚠️ 54.1 (+38%)	31,425
FPC:pay_refund	148 (+3%)	20,080
Benchmarking:increment_balance	2,710 (+2%)	15,465
Token:_increase_public_balance	56.4 (-7%)	15,089
FPC:pay_refund_with_shielded_rebate	154 (-5%)	21,167

Public DB Access

Time to access various public DBs.

Function	time_ms
get-nullifier-index	0.183

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	256 leaves	512 leaves	1024 leaves
batch_insert_into_append_only_tree_16_depth_ms	10.3 (+1%)	16.7 (+1%)	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_16_depth_hash_count	16.8	31.7	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_16_depth_hash_ms	0.596 (+1%)	0.514 (+1%)	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_32_depth_ms	N/A	N/A	48.2	76.1 (+1%)	131	244 (+2%)	468 (+2%)
batch_insert_into_append_only_tree_32_depth_hash_count	N/A	N/A	95.9	159	287	543	1,055
batch_insert_into_append_only_tree_32_depth_hash_ms	N/A	N/A	0.492	0.467 (+1%)	0.450	0.443 (+2%)	0.437 (+2%)
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	59.3 (+1%)	111 (+2%)	181 (+1%)	381 (+11%)	688 (+1%)
batch_insert_into_indexed_tree_20_depth_hash_count	N/A	N/A	109	207	355	691	1,363
batch_insert_into_indexed_tree_20_depth_hash_ms	N/A	N/A	0.502 (+1%)	0.499 (+2%)	0.480	0.518 (+11%)	0.473 (+2%)
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	72.8 (+2%)	N/A	N/A	N/A	N/A
batch_insert_into_indexed_tree_40_depth_hash_count	N/A	N/A	133	N/A	N/A	N/A	N/A
batch_insert_into_indexed_tree_40_depth_hash_ms	N/A	N/A	0.519 (+2%)	N/A	N/A	N/A	N/A

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	85,672	670,983

Transaction size based on fee payment method

| Metric | |
| - | |

[LHerskind]

I like. Minor nit on a comment. 🚢