feat!: refactor NoteGetterOptions::select API

[nventuro]

Closes #8413

By removing the default value for Option::none() and swaping the second and third param, it's now much easier to understand what is going on when this function is called:

- options.select(ValueNote::properties().value, amount, Option::none())
+ options.select(ValueNote::properties().value, Comparator.EQ, amount)

I also updated the docs and fixed some of the examples, which were outdated and plain wrong, since the code snippets did not match the text.

[AztecBot]

Docs Preview

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

[AztecBot]

Benchmark results

Metrics with a significant change:

• avm_simulation_time_ms (FeeJuice:_increase_public_balance): 47.7 (-66%)
• avm_simulation_time_ms (FeeJuice:set_portal): 11.4 (+48%)
• avm_simulation_time_ms (Token:assert_minter_and_mint): 300 (+482%)
• avm_simulation_time_ms (Token:transfer_public): 19.6 (-31%)
• l2_block_processing_time_in_ms (4): 256 (-18%)
• l2_block_processing_time_in_ms (16): 800 (-33%)

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_ms	5,758	1,550	712 (+1%)	758 (-1%)	782 (+1%)
proof_construction_time_sha256_30_ms	11,886 (+4%)	3,178 (+4%)	1,413 (+4%)	1,451 (+3%)	1,484 (+2%)
proof_construction_time_sha256_100_ms	44,253 (+1%)	11,876 (+1%)	5,556 (-6%)	5,958 (-2%)	5,415 (+1%)
proof_construction_time_poseidon_hash_ms	78.0	34.0	34.0	57.0	87.0 (+1%)
proof_construction_time_poseidon_hash_30_ms	1,530	419	200	227	269 (+1%)
proof_construction_time_poseidon_hash_100_ms	5,665 (+1%)	1,523 (+1%)	682 (+2%)	725 (-5%)	750

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	4,420 (-4%)	7,940 (-4%)	14,948 (-4%)
l1_rollup_calldata_gas	50,536 (-4%)	93,208 (-4%)	178,376 (-4%)
l1_rollup_execution_gas	815,681	1,548,872	3,333,207
l2_block_processing_time_in_ms	⚠️ 256 (-18%)	449 (-1%)	⚠️ 800 (-33%)
l2_block_building_time_in_ms	9,376 (+1%)	18,444 (-2%)	36,715
l2_block_rollup_simulation_time_in_ms	9,375 (+1%)	18,443 (-2%)	36,715
l2_block_public_tx_process_time_in_ms	7,976	17,018 (-2%)	35,221

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	3,160 (+2%)	4,022 (-3%)
node_database_size_in_bytes	14,225,648	18,215,152
pxe_database_size_in_bytes	16,258	26,818

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	input_size_in_bytes	output_size_in_bytes	proving_time_in_ms
private-kernel-init	74.7 (-1%)	416 (+3%)	20,975	44,933	N/A
private-kernel-inner	142 (+1%)	717 (-2%)	71,787	45,067	N/A
private-kernel-reset-tiny	328 (-2%)	723 (-5%)	64,273	44,922	N/A
private-kernel-tail	152 (-2%)	136 (-4%)	50,551	57,178	N/A
base-parity	5.58	N/A	160	96.0	N/A
root-parity	35.5 (+1%)	N/A	73,964	96.0	N/A
base-rollup	2,130 (-2%)	N/A	189,128	664	N/A
block-root-rollup	41.5	N/A	58,217	2,448	N/A
public-kernel-setup	87.0 (-1%)	N/A	114,433	79,670	N/A
public-kernel-app-logic	99.7	N/A	114,251	79,670	N/A
public-kernel-tail	586 (-3%)	N/A	487,098	16,414	N/A
private-kernel-reset-small	308 (-2%)	N/A	66,345	45,629	N/A
private-kernel-tail-to-public	1,462 (+4%)	621 (-4%)	448,120	1,825	N/A
public-kernel-teardown	86.7 (-1%)	N/A	114,697	79,670	N/A
merge-rollup	19.9	N/A	38,182	664	N/A
undefined	N/A	N/A	N/A	N/A	99,482 (-2%)

Stats on running time collected for app circuits

Function	input_size_in_bytes	output_size_in_bytes	witness_generation_time_in_ms
ContractClassRegisterer:register	1,344	11,731	349 (-1%)
ContractInstanceDeployer:deploy	1,408	11,731	18.3 (-3%)
MultiCallEntrypoint:entrypoint	1,920	11,731	425 (-2%)
FeeJuice:deploy	1,376	11,731	397
SchnorrAccount:constructor	1,312	11,731	60.7 (-2%)
SchnorrAccount:entrypoint	2,336	11,731	370
FeeJuice:claim	1,344	11,731	37.5 (-2%)
Token:privately_mint_private_note	1,280	11,731	73.2 (-2%)
FPC:fee_entrypoint_public	1,344	11,731	24.6 (-7%)
Token:transfer	1,312	11,731	213
Benchmarking:create_note	1,344	11,731	72.9 (-3%)
SchnorrAccount:verify_private_authwit	1,280	11,731	27.2 (+3%)
Token:unshield	1,376	11,731	514 (+6%)
FPC:fee_entrypoint_private	1,376	11,731	686 (+7%)

AVM Simulation

Time to simulate various public functions in the AVM.

Function	time_ms	bytecode_size_in_bytes
FeeJuice:_increase_public_balance	⚠️ 47.7 (-66%)	1,328 (+5%)
FeeJuice:set_portal	⚠️ 11.4 (+48%)	1,274 (+5%)
Token:constructor	254	11,412 (+6%)
FPC:constructor	74.4 (+9%)	8,425 (+6%)
FeeJuice:check_balance	36.1 (+1%)	1,135 (+4%)
Token:mint_public	251 (-3%)	2,413 (+5%)
Token:assert_minter_and_mint	⚠️ 300 (+482%)	1,629 (+5%)
AuthRegistry:set_authorized	46.1 (+2%)	567 (+4%)
FPC:prepare_fee	94.4 (+1%)	1,638 (+3%)
Token:transfer_public	⚠️ 19.6 (-31%)	9,301 (+6%)
FPC:pay_refund	47.8 (+12%)	2,170 (+3%)
Benchmarking:increment_balance	1,001 (-2%)	1,584 (+3%)
Token:_increase_public_balance	37.6 (-29%)	1,305 (+5%)
FPC:pay_refund_with_shielded_rebate	53.4 (+4%)	2,170 (+3%)

Public DB Access

Time to access various public DBs.

Function	time_ms
get-nullifier-index	0.162 (+2%)

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	2.17 (-2%)	3.87 (-1%)	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_16_depth_hash_count	16.7	31.8	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_16_depth_hash_ms	0.114 (-2%)	0.109 (-1%)	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_32_depth_ms	N/A	N/A	11.2	17.5 (-2%)	31.5 (+1%)	59.1 (-3%)	111 (-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.107 (-1%)	0.102 (-2%)	0.103 (+2%)	0.102 (-2%)	0.101
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	14.2 (-1%)	26.0	43.8 (-2%)	81.9 (-2%)	159 (-2%)
batch_insert_into_indexed_tree_20_depth_hash_count	N/A	N/A	109	207	357	691	1,363
batch_insert_into_indexed_tree_20_depth_hash_ms	N/A	N/A	0.109 (-1%)	0.105	0.104 (-2%)	0.101 (-2%)	0.100 (-2%)
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	16.1 (-1%)	N/A	N/A	N/A	N/A
batch_insert_into_indexed_tree_40_depth_hash_count	N/A	N/A	129	N/A	N/A	N/A	N/A
batch_insert_into_indexed_tree_40_depth_hash_ms	N/A	N/A	0.106 (-1%)	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	72,416	668,302

Transaction size based on fee payment method

| Metric | |
| - | |

[sklppy88]

🚀

[benesjan]

CUTE!

will merge this so that I can rebase my NFT PR on it