feat!: make noir_wasm the default compiler #3090

alexghr · 2023-10-27T16:04:55Z

In #2737 noir_wasm was added back for contract compilation but kept as a secondary option to Nargo because at the time noir_wasm did not output debug info. This PR switches the default to noir_wasm because it now supports everything we need for contract compilation

Checklist:

Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.

If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag.
I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code.
Every change is related to the PR description.
I have linked this pull request to relevant issues (if any exist).

socket-security · 2023-10-27T16:16:22Z

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

Packages	Version	New capabilities	Transitives	Size	Publisher
@noir-lang/source-resolver	0.18.0-3919619.aztec...0.18.0-6ca33a2.aztec	None	`+0/-0`	7.88 kB
@noir-lang/noir_wasm	0.18.0-3919619.aztec...0.18.0-6ca33a2.aztec	None	`+1/-1`	17.6 MB

AztecBot · 2023-10-27T16:56:43Z

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 410cae39 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	223,020	867,464	3,446,480
l1_rollup_execution_gas	842,107	3,594,572	22,201,849
l2_block_processing_time_in_ms	1,999	7,612 (+1%)	29,845 (+1%)
note_successful_decrypting_time_in_ms	295 (+1%)	879 (+2%)	3,195 (+1%)
note_trial_decrypting_time_in_ms	100 (+6%)	87.0 (+24%)	136 (+1%)
l2_block_building_time_in_ms	13,179	52,658	209,590
l2_block_rollup_simulation_time_in_ms	11,834	47,322	188,524
l2_block_public_tx_process_time_in_ms	1,301	5,203	20,576 (-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	21,702 (+1%)	42,066
note_history_successful_decrypting_time_in_ms	1,993	3,895 (-1%)
note_history_trial_decrypting_time_in_ms	121 (+1%)	142 (-1%)
node_database_size_in_bytes	1,629,030	1,095,971
pxe_database_size_in_bytes	29,748	59,307

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	773	61,697	18,905
private-kernel-ordering	123	24,297	8,153
base-rollup	1,772	656,311	814
root-rollup	79.9 (+1%)	4,072	1,097
private-kernel-inner	789	81,568	18,905
public-kernel-private-input	41.4	41,519	18,841
public-kernel-non-first-iteration	26.3	41,497	18,841
merge-rollup	0.870 (-2%)	2,592	873

Miscellaneous

Transaction sizes based on how many contracts are deployed in the tx.

Metric	0 deployed contracts	1 deployed contracts
tx_size_in_bytes	8,787	27,547

alexghr · 2023-10-27T17:02:13Z

yarn-project/noir-compiler/src/index.test.ts

-      expect(compiled).toMatchSnapshot();
+      expect(compiled.map(withoutDebug)).toMatchSnapshot();


This actually embedded my local path in the snapshot so it was failing in CI. The only reason it was passing before was because this test wasn't being run in CircleCI (no nargo there).

alexghr · 2023-11-01T16:19:17Z

yarn-project/bootstrap.sh

-yarn --cwd circuits.js remake-bindings
-yarn --cwd circuits.js remake-constants
+yarn workspace @aztec/circuits.js remake-bindings
+yarn workspace @aztec/circuits.js remake-constants


I don't understand why --cwd randomly started to fail on my system so I've changed it all to use workspace

spalladino

Added a few comments. Note that, if we're defaulting to wasm and not requiring nargo by default, we should probably update the docs in this same PR to clarify that nargo is optional (or even remove it from the basic tutorials, just to simplify things).

yarn-project/cli/src/unbox.ts

yarn-project/noir-compiler/src/compile/nargo.ts

build_manifest.yml

docs/docusaurus.config.js

rahul-kothari · 2023-11-02T10:58:01Z

@spalladino ok if we do docs PR later?
With this PR and #3128, there are LOTS of changes needed and I want devrel to know them properly. So a separate PR with the new update flow would make for a cleaner diff + better onramp for devrel

Created #3195

spypsy

LGTM tho have to admit I don't understand everything that's going on here

spalladino · 2023-11-02T17:20:44Z

@rahul-kothari fine for me!

* master: (95 commits) feat!: make noir_wasm the default compiler (#3090) feat: Add root rollup circuit (#3217) refactor: Move sumcheck (#3189) refactor: Move flavors (#3188) refactor: Move honk/pcs (#3187) feat: Extract types to a types crate (#3203) fix: better update steps for dockerized sandbox (#3204) refactor: Move transcripts (#3176) chore: Fix typo in aztec sandbox (#3191) feat: Enable pkc in noir (#3194) chore: more boiler plate code for merge rollup (#3182) fix: remove unused import (#3200) feat(docs): New getting started flow (#2957) feat!: adding all the (note, nonce) pairs in `PXE.addNote` and hiding `PXE.getNoteNonces` (#3196) chore: refactor e2e to not use @aztec/types (#3175) chore: bump noir (#3197) feat: add cli command update aztec dependencies (#3128) feat!: API inconsistency fix (#3190) chore: Add initial skeleton code for root/merge/mase rollups for Noir (#3178) feat: migrate cpp private kernel tests to noir (#3165) ...

🤖 I have created a release *beep* *boop* --- <details><summary>aztec-packages: 0.14.0</summary> ## [0.14.0](aztec-packages-v0.13.1...aztec-packages-v0.14.0) (2023-11-07) ### ⚠ BREAKING CHANGES * make noir_wasm the default compiler ([#3090](#3090)) * adding all the (note, nonce) pairs in `PXE.addNote` and hiding `PXE.getNoteNonces` ([#3196](#3196)) * API inconsistency fix ([#3190](#3190)) * tree leaf value as `Fr` everywhere in our public API ([#3173](#3173)) ### Features * Add cli command update aztec dependencies ([#3128](#3128)) ([0c05d8b](0c05d8b)) * Add root rollup circuit ([#3217](#3217)) ([fb4f7af](fb4f7af)) * Adding all the (note, nonce) pairs in `PXE.addNote` and hiding `PXE.getNoteNonces` ([#3196](#3196)) ([8c41664](8c41664)) * API inconsistency fix ([#3190](#3190)) ([272eda1](272eda1)) * **docs:** Aztec.nr errors in docs ([#3113](#3113)) ([fb1e80b](fb1e80b)) * **docs:** New getting started flow ([#2957](#2957)) ([f23f868](f23f868)) * Enable pkc in noir ([#3194](#3194)) ([1ef892b](1ef892b)) * Extract types to a types crate ([#3203](#3203)) ([4161be9](4161be9)) * Gperftools ([#3096](#3096)) ([ea2f9a7](ea2f9a7)) * Initial storage slots docs ([#2842](#2842)) ([e8bcd03](e8bcd03)) * Make noir_wasm the default compiler ([#3090](#3090)) ([ca52a3e](ca52a3e)) * Migrate cpp private kernel tests to noir ([#3165](#3165)) ([daee2f9](daee2f9)) * More test info in tx receipt ([#3221](#3221)) ([a7354dc](a7354dc)), closes [#3218](#3218) * Tag artifacts with the compiler version ([#3220](#3220)) ([c7490c5](c7490c5)) * Tree leaf value as `Fr` everywhere in our public API ([#3173](#3173)) ([09464ca](09464ca)) ### Bug Fixes * Attempt to fix spot request hangs. ([#3241](#3241)) ([a062026](a062026)) * Better update steps for dockerized sandbox ([#3204](#3204)) ([3ef0bee](3ef0bee)) * Build cli image before releasing ([#3140](#3140)) ([09c3b75](09c3b75)) * Cleanup gen_inner_proof_files.sh script. ([#3242](#3242)) ([ee57e00](ee57e00)) * Corrects typo in repo readme ([#3236](#3236)) ([0ed8c79](0ed8c79)) * Remove noirup from noir-contract's bootstrap ([#3252](#3252)) ([d10342e](d10342e)) * Remove unused import ([#3200](#3200)) ([520bba4](520bba4)) * Temporary fix for bb prove w/ ram rom blocks ([#3215](#3215)) ([af93a33](af93a33)) * Update noir-contracts path to types ([#3247](#3247)) ([c5fc95d](c5fc95d)) * Wasm-compiler `bin` package type ([#3254](#3254)) ([2d50f11](2d50f11)) * Yarn prepare ([#3251](#3251)) ([d02726f](d02726f)) ### Miscellaneous * Add initial skeleton code for root/merge/mase rollups for Noir ([#3178](#3178)) ([7b0d076](7b0d076)) * Bump noir ([#3197](#3197)) ([aa2042d](aa2042d)) * Clean up and refactor arithmetization ([#3164](#3164)) ([0370b13](0370b13)) * Continuation of note naming update ([#3137](#3137)) ([582150f](582150f)) * Disable canary. ([#3244](#3244)) ([1a56173](1a56173)) * Docs: fix broken link in functions.md ([#3183](#3183)) ([fb53f7a](fb53f7a)) * **docs:** Fix docs build ([#3249](#3249)) ([ec2c0cf](ec2c0cf)) * Fix typo in aztec sandbox ([#3191](#3191)) ([ed144b1](ed144b1)) * More boiler plate code for merge rollup ([#3182](#3182)) ([ffafcef](ffafcef)) * Move flavors ([#3188](#3188)) ([f1ff849](f1ff849)) * Move honk/pcs ([#3187](#3187)) ([3870ff8](3870ff8)) * Move log deriv lookup accum to library ([#3226](#3226)) ([189d1bb](189d1bb)) * Move sumcheck ([#3189](#3189)) ([410cae3](410cae3)) * Move transcripts ([#3176](#3176)) ([7372d19](7372d19)) * Noir circuit tests ([#3229](#3229)) ([dbfb086](dbfb086)) * Private kernel circuits ([#3240](#3240)) ([b7fbe19](b7fbe19)) * Prune 0 values from L2Tx ([#3224](#3224)) ([2de206d](2de206d)) * Refactor e2e to not use @aztec/types ([#3175](#3175)) ([006a07a](006a07a)), closes [#3157](#3157) * Remove extra println in noir protoco circuit ([#3219](#3219)) ([3295fdd](3295fdd)) * Split out relations, PG, Honk variants ([#3238](#3238)) ([8abd39f](8abd39f)) * Update Noir version ([#3082](#3082)) ([59eb6af](59eb6af)) ### Documentation * Fix bad shareable key crypto. better explanations ([#3228](#3228)) ([e4a0c4a](e4a0c4a)) * Fix in nullifier secrets doc ([#3167](#3167)) ([8c70845](8c70845)) * Move Updating.md file, add aztec tag to nargo update instruction ([#3213](#3213)) ([9f71c5d](9f71c5d)) * Update docs ([#3223](#3223)) ([7977064](7977064)) * Update storage doc ([#3212](#3212)) ([d707d4e](d707d4e)) * Updated stale tree docs ([#3166](#3166)) ([3d5c98c](3d5c98c)) </details> <details><summary>barretenberg.js: 0.14.0</summary> ## [0.14.0](barretenberg.js-v0.13.1...barretenberg.js-v0.14.0) (2023-11-07) ### Miscellaneous * **barretenberg.js:** Synchronize aztec-packages versions </details> <details><summary>barretenberg: 0.14.0</summary> ## [0.14.0](barretenberg-v0.13.1...barretenberg-v0.14.0) (2023-11-07) ### Features * Gperftools ([#3096](#3096)) ([ea2f9a7](ea2f9a7)) ### Bug Fixes * Cleanup gen_inner_proof_files.sh script. ([#3242](#3242)) ([ee57e00](ee57e00)) * Temporary fix for bb prove w/ ram rom blocks ([#3215](#3215)) ([af93a33](af93a33)) ### Miscellaneous * Clean up and refactor arithmetization ([#3164](#3164)) ([0370b13](0370b13)) * Move flavors ([#3188](#3188)) ([f1ff849](f1ff849)) * Move honk/pcs ([#3187](#3187)) ([3870ff8](3870ff8)) * Move log deriv lookup accum to library ([#3226](#3226)) ([189d1bb](189d1bb)) * Move sumcheck ([#3189](#3189)) ([410cae3](410cae3)) * Move transcripts ([#3176](#3176)) ([7372d19](7372d19)) * Split out relations, PG, Honk variants ([#3238](#3238)) ([8abd39f](8abd39f)) ### Documentation * Updated stale tree docs ([#3166](#3166)) ([3d5c98c](3d5c98c)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

alexghr force-pushed the alexg/feat/noir-wasm-as-default branch 3 times, most recently from d84918b to e9ebc32 Compare October 27, 2023 16:33

alexghr commented Oct 27, 2023

View reviewed changes

Base automatically changed from alexg/feat/noir-wasm to master October 27, 2023 17:42

alexghr force-pushed the alexg/feat/noir-wasm-as-default branch 2 times, most recently from e131062 to 59de4a9 Compare November 1, 2023 16:14

alexghr commented Nov 1, 2023

View reviewed changes

alexghr marked this pull request as ready for review November 1, 2023 18:17

alexghr force-pushed the alexg/feat/noir-wasm-as-default branch from cc25b0f to dabb6bc Compare November 1, 2023 18:20

spalladino reviewed Nov 1, 2023

View reviewed changes

yarn-project/cli/src/unbox.ts Outdated Show resolved Hide resolved

yarn-project/noir-compiler/src/compile/nargo.ts Outdated Show resolved Hide resolved

build_manifest.yml Outdated Show resolved Hide resolved

docs/docusaurus.config.js Outdated Show resolved Hide resolved

alexghr force-pushed the alexg/feat/noir-wasm-as-default branch from dabb6bc to d32979e Compare November 2, 2023 08:57

rahul-kothari mentioned this pull request Nov 2, 2023

New setup docs #3195

Closed

alexghr added 5 commits November 2, 2023 13:30

feat: make noir_wasm the default compiler

0d2d386

fix: remove debug info from snapshot

3242a14

chore: update bootstrap cd use

a536cf1

fix: update noir src fixtures

f4c008c

chore: rethrow

aa4b5b0

alexghr force-pushed the alexg/feat/noir-wasm-as-default branch from d32979e to aa4b5b0 Compare November 2, 2023 13:49

alexghr and others added 2 commits November 2, 2023 14:16

chore: bump noir_wasm

4fbdc95

Merge branch 'master' into alexg/feat/noir-wasm-as-default

ab67223

spypsy approved these changes Nov 2, 2023

View reviewed changes

alexghr changed the title ~~feat: make noir_wasm the default compiler~~ feat!: make noir_wasm the default compiler Nov 2, 2023

Merge branch 'master' into alexg/feat/noir-wasm-as-default

10ddb81

alexghr merged commit ca52a3e into master Nov 3, 2023
2 checks passed

alexghr deleted the alexg/feat/noir-wasm-as-default branch November 3, 2023 11:10

AztecBot mentioned this pull request Nov 3, 2023

chore(master): Release 0.14.0 #3158

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: make noir_wasm the default compiler #3090

feat!: make noir_wasm the default compiler #3090

alexghr commented Oct 27, 2023 •

edited

Loading

socket-security bot commented Oct 27, 2023 •

edited

Loading

AztecBot commented Oct 27, 2023 •

edited

Loading

L2 block published to L1

L2 chain processing

Circuits stats

Miscellaneous

alexghr Oct 27, 2023

alexghr Nov 1, 2023

spalladino left a comment •

edited

Loading

rahul-kothari commented Nov 2, 2023 •

edited

Loading

spypsy left a comment

spalladino commented Nov 2, 2023

		expect(compiled).toMatchSnapshot();
		expect(compiled.map(withoutDebug)).toMatchSnapshot();

feat!: make noir_wasm the default compiler #3090

feat!: make noir_wasm the default compiler #3090

Conversation

alexghr commented Oct 27, 2023 • edited Loading

Checklist:

socket-security bot commented Oct 27, 2023 • edited Loading

AztecBot commented Oct 27, 2023 • edited Loading

Benchmark results

L2 block published to L1

L2 chain processing

Circuits stats

Miscellaneous

alexghr Oct 27, 2023

Choose a reason for hiding this comment

alexghr Nov 1, 2023

Choose a reason for hiding this comment

spalladino left a comment • edited Loading

Choose a reason for hiding this comment

rahul-kothari commented Nov 2, 2023 • edited Loading

spypsy left a comment

Choose a reason for hiding this comment

spalladino commented Nov 2, 2023

alexghr commented Oct 27, 2023 •

edited

Loading

socket-security bot commented Oct 27, 2023 •

edited

Loading

AztecBot commented Oct 27, 2023 •

edited

Loading

spalladino left a comment •

edited

Loading

rahul-kothari commented Nov 2, 2023 •

edited

Loading