feat!: Unify ABIs between nargo and yarn-project

[spalladino]

Changes the output of nargo and noir-wasm to generate a single artifact that includes debug information. Compiled contracts now have a file_map at the root of the artifact, and a debug_symbols within each function. For consistency, compiled programs also have file_map and debug_symbols. Debug symbols are compressed and base64-encoded, as they were by the former noir-compiler postprocessing. The debug json artifact is no longer emitted.

Removes all code related to generating yarn-project-specific ABIs from noir compiler. Instead, types now exposes a loadContractArtifact that renames fields as needed (and use camel instead of snake case), and is required when loading a noir contract artifact. Autogenerated types run this automatically.

Since we are no longer post-processing artifacts, the noir-contracts project shape is changed. JSON files live in the target folder where nargo outputs them (this is not configurable), and are loaded by the autogenerated typescript interfaces from there.

As part of the refactor, moves functions for getting functions debug info out of acir-simulator and into types.

Breaking change: This removes the need to run codegen for using a compiled contract. However, when creating a new contract object from aztec.js, a dev needs to call loadContractArtifact.

Future changes: Type information for a compilation artifact is now spread all over the place, and duplicated in more than one place. There are types defined within rust code in Noir as [wasm_bindgen(typescript_custom_section)], others defined within typescript code in the noir_wasm package, others in foundation, and others in types. We should unify it in a single place.

Fixes #3812

Supersedes #3906

Noir subrepo has been pushed to noir-lang/noir#4035 to run the Noir CI

[socket-security]

New dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
@types/pako	2.0.3	None	+0	7.8 kB	types

[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 dda7c9c4 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,444	179,588	716,132
l1_rollup_calldata_gas	220,992	866,240	3,447,848
l1_rollup_execution_gas	934,136	3,968,714	24,791,384
l2_block_processing_time_in_ms	1,406 (-13%)	5,320	21,742 (-1%)
note_successful_decrypting_time_in_ms	310 (-3%)	922 (-3%)	3,314 (-4%)
note_trial_decrypting_time_in_ms	23.7 (-16%)	49.9 (-36%)	144 (-1%)
l2_block_building_time_in_ms	16,101 (-1%)	63,861	255,669 (-1%)
l2_block_rollup_simulation_time_in_ms	11,697 (-1%)	46,502	186,514 (-1%)
l2_block_public_tx_process_time_in_ms	4,369	17,268	68,863 (-1%)

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	16,669 (+4%)	30,925 (+1%)
note_history_successful_decrypting_time_in_ms	2,238 (+1%)	4,338
note_history_trial_decrypting_time_in_ms	148 (-42%)	199 (-2%)
node_database_size_in_bytes	3,581,567	3,643,551
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	214	44,681	25,561
private-kernel-ordering	166	43,753	14,809
base-rollup	1,193	128,338	881
root-rollup	79.4	4,088	677
private-kernel-inner	292	71,208	25,561
public-kernel-private-input	205	31,863	25,561
public-kernel-non-first-iteration	204	31,905	25,561
merge-rollup	7.64 (-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	12.6	24.6 (+15%)	13.6 (-11%)	19.8 (-2%)	25.3 (-1%)	65.2 (-3%)	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.629	0.807 (+20%)	0.544 (-11%)	0.544	0.484	0.441	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	109 (+19%)	52.0 (-1%)	254 (+1%)	488 (+2%)	915 (-1%)	3,564 (-1%)
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.554 (+10%)	0.498 (-1%)	0.439	0.442 (+1%)	0.430	0.426
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	N/A	N/A	N/A	121 (-8%)	62.7 (-1%)	378 (-10%)	783 (+2%)	1,432 (-1%)	5,893 (-2%)
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.507 (-2%)	0.504	0.485 (-6%)	0.490 (+1%)	0.475	0.487 (+1%)
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	N/A	68.4	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.598	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,455	32,219

Transaction processing duration by data writes.

Metric	0 new commitments	1 new commitments
tx_pxe_processing_time_ms	374	1,087

Metric	1 public data writes
tx_sequencer_processing_time_ms	536

[spalladino]

Future changes: Type information for a compilation artifact is now spread all over the place, and duplicated in more than one place. There are types defined within rust code in Noir as [wasm_bindgen(typescript_custom_section)], others defined within typescript code in the noir_wasm package, others in foundation, and others in types. We should unify it in a single place.

About this, I suggest creating a new types-only package in the Noir repo with typescript types for Noir abi and compilation artifacts (and potentially a zod validator, already implemented on a discarded commit), and can be consumed from yarn-project. Reason for not reusing noir-wasm is because the types are needed also when building with nargo and consuming from ts, and it makes no sense to pull in the whole wasm package just for the type information.

This would allow us to remove the type info from within the rust files, and also from foundation and types in yarn-packages. Thoughts @TomAFrench?

[TomAFrench]

new types-only package in the Noir repo with typescript types for Noir abi and compilation artifacts

That works for me as long as we have tests to check for drift against these types.