feat: add outgoing keys support to getEvents

[sklppy88]

Some considerations is the potential inefficiency with the current impl, but I think the UX is better passing in an array of heterogeneous keys.

[sklppy88]

• feat: add outgoing keys support to getEvents #7239 👈
• feat: add new lenses for encryted notes #7238
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @sklppy88 and the rest of your teammates on Graphite

[LHerskind]

Adding a small error on the getEncryptedEvents would be neat, otherwise I think it is good 👍

[LHerskind]

Think it would be useful to throw here if vpks is empty since we would not be able to decrypt anything, so it is essentially a no-op, where we might as well give a neat error instead of having him wait to fetch the blocks from node and then don't find anything 👀

[sklppy88]

Good point, have addressed 🙏

[AztecBot]

Benchmark results

Metrics with a significant change:

• avm_simulation_time_ms (Token:transfer_public): 36.3 (-30%)
• protocol_circuit_witness_generation_time_in_ms (private-kernel-tail-to-public): 8,879 (+24%)

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,517 (+1%)	3,152 (+3%)	1,772 (+6%)	1,552 (-3%)	1,472 (-2%)
proof_construction_time_sha256_100_ms	44,444 (+1%)	11,908 (+1%)	5,478	5,434 (+1%)	5,396 (+1%)
proof_construction_time_poseidon_hash_ms	78.0	34.0	34.0	57.0 (-3%)	88.0 (-1%)
proof_construction_time_poseidon_hash_30_ms	1,544 (+2%)	421 (+1%)	201 (+1%)	229	266
proof_construction_time_poseidon_hash_100_ms	5,825 (+1%)	1,590 (+2%)	725 (+1%)	787 (+5%)	796

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,470	9,464
l1_rollup_execution_gas	610,297	610,291	610,285
l2_block_processing_time_in_ms	775	1,409	2,701 (-1%)
l2_block_building_time_in_ms	25,377 (-1%)	51,194	100,243
l2_block_rollup_simulation_time_in_ms	25,377 (-1%)	51,194	100,243
l2_block_public_tx_process_time_in_ms	21,807 (-1%)	47,402	96,479

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,003	9,864
node_database_size_in_bytes	12,197,968	16,130,128
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	121	468 (-7%)	12,741 (+1%)	20,634	67,190	92,352	2,819	524,288
private-kernel-inner	380 (-1%)	956 (-10%)	49,923 (+1%)	94,902	67,190	92,352	2,819	2,097,152
private-kernel-tail	310 (-1%)	1,774	51,449 (+4%)	99,121	71,733	14,912	399	2,097,152
base-parity	6.27 (+1%)	1,917 (-3%)	2,763 (+1%)	128	64.0	2,208	2.00	131,072
root-parity	49.2	71.8 (-4%)	40,962 (-3%)	27,100	64.0	2,720	18.0	2,097,152
base-rollup	7,959	4,789 (-4%)	87,152 (+4%)	170,330	756	3,648	47.0	4,194,304
root-rollup	110	91.0 (-2%)	24,997 (+11%)	25,309	620	3,456	41.0	1,048,576
public-kernel-setup	720 (+1%)	3,752	45,319 (+2%)	116,905	93,334	125,344	3,850	2,097,152
public-kernel-app-logic	632	4,826 (+2%)	46,963	116,905	93,334	125,344	3,850	2,097,152
public-kernel-tail	1,397 (-1%)	39,552 (+6%)	197,103 (+2%)	511,910	10,014	14,912	399	8,388,608
private-kernel-reset-small	556 (-1%)	2,244 (+12%)	46,371	123,313	67,190	92,352	2,819	2,097,152
public-kernel-teardown	631	4,731	48,170 (+5%)	116,905	93,334	125,344	3,850	2,097,152
merge-rollup	29.3 (+1%)	N/A	N/A	16,542	756	N/A	N/A	N/A
private-kernel-tail-to-public	N/A	⚠️ 8,879 (+24%)	95,690 (-1%)	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	425	N/A	N/A	N/A	N/A
ContractInstanceDeployer:deploy	1,408	9,944	39.7	N/A	N/A	N/A	N/A
MultiCallEntrypoint:entrypoint	1,920	9,944	1,784	N/A	N/A	N/A	N/A
GasToken:deploy	1,376	9,944	975	N/A	N/A	N/A	N/A
SchnorrAccount:constructor	1,312	9,944	1,404 (-1%)	N/A	N/A	N/A	N/A
SchnorrAccount:entrypoint	2,304	9,944	2,826	16,768	55,472 (-3%)	2,097,152	457
Token:privately_mint_private_note	1,280	9,944	1,613 (-1%)	N/A	N/A	N/A	N/A
FPC:fee_entrypoint_public	1,344	9,944	352 (-1%)	16,768	11,262 (-7%)	524,288	457
Token:transfer	1,312	9,944	4,524 (+1%)	16,768	46,562 (+2%)	2,097,152	457
AuthRegistry:set_authorized (avm)	21,043	N/A	N/A	87,552	1,339 (-1%)	N/A	N/A
FPC:prepare_fee (avm)	28,495	N/A	N/A	88,448	5,630 (-4%)	N/A	N/A
Token:transfer_public (avm)	44,885	N/A	N/A	88,170	3,954 (+1%)	N/A	N/A
AuthRegistry:consume (avm)	34,973	N/A	N/A	87,968	2,906 (+1%)	N/A	N/A
FPC:pay_refund (avm)	41,394	N/A	N/A	89,248	23,171 (-7%)	N/A	N/A
Benchmarking:create_note	1,344	9,944	1,393 (-1%)	N/A	N/A	N/A	N/A
SchnorrAccount:verify_private_authwit	1,280	9,944	76.8 (+5%)	N/A	N/A	N/A	N/A
Token:unshield	1,376	9,944	3,729 (+1%)	N/A	N/A	N/A	N/A
FPC:fee_entrypoint_private	1,376	9,944	4,678 (+2%)	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	70.4 (+5%)	13,873 (+1%)
GasToken:set_portal	16.1 (-6%)	3,495 (+5%)
Token:constructor	91.6 (-1%)	24,207 (+2%)
FPC:constructor	62.7 (-1%)	13,893 (+2%)
GasToken:mint_public	53.0	10,241 (+1%)
Token:mint_public	63.7 (-2%)	19,216 (+1%)
Token:assert_minter_and_mint	235 (+10%)	13,034 (+1%)
AuthRegistry:set_authorized	32.6 (+2%)	7,869 (+1%)
FPC:prepare_fee	156 (+4%)	15,129
Token:transfer_public	⚠️ 36.3 (-30%)	31,425 (+1%)
FPC:pay_refund	201 (-4%)	28,061
Benchmarking:increment_balance	2,710	15,407 (+1%)
Token:_increase_public_balance	55.9	15,089 (+1%)
FPC:pay_refund_with_shielded_rebate	204	29,148

Public DB Access

Time to access various public DBs.

Function	time_ms
get-nullifier-index	0.154

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	16.7	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.597	0.512	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	75.7	131 (-1%)	245	471
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.466	0.451	0.443	0.440
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	59.5	112 (-1%)	183 (-2%)	351 (-1%)	694 (-2%)
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.504	0.501 (-1%)	0.484 (-2%)	0.477 (-1%)	0.477 (-2%)
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	72.6 (-1%)	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.518 (-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	85,672	670,983

Transaction size based on fee payment method

| Metric | |
| - | |