feat: tag artifacts with the compiler version #3220

alexghr · 2023-11-03T11:38:02Z

This PR adds the Aztec.nr version used to compile a contract. The CLI's compile and deploy commands now check it against the expected version and warn the user of incompatibilities (just warns, doesn't stop the compilation/deployment).

Fix #2973

Compiling now yields:

$ node cli/dest/bin/index.js compile ~/host/contracts/token_contract/
Compiling contracts...
WARNING: Aztec.nr version mismatch: expected "aztec-packages-v0.1.0", got "aztec-packages-v0.12.0"
Writing Token artifact to ../../contracts/token_contract/target/Token.json

Deploying a contract with mismatched version:

$ aztec-cli deploy EasyPrivateTokenContractArtifact -a 1000 0x16efad912187aa8ef0dcc6ef4f3743ab327b06465d4d229943f2fe3f88b06ad9

Warning: Contract was compiled with a different version of Aztec.nr: aztec-packages-v0.12.0. Consider updating Aztec.nr to aztec-packages-v0.1.0


Contract deployed at 0x2464afb515db393ec3499713d7925de5d44e725838b5dac15e151674b17aa93c

Contract partial address 0x1480a4231670dc527dbe4d9db8e35f329fe34482e7092fbfb34c6c08af3e519f

(in these examples the expected version is aztec-packages-v0.1.0 because I was developing locally which doesn't read relese-please's version)

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).

AztecBot · 2023-11-03T12:08:57Z

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 3295fdd9 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	222,972	867,860	3,449,768
l1_rollup_execution_gas	842,059	3,594,968	22,205,137
l2_block_processing_time_in_ms	1,965 (-2%)	7,484 (-1%)	29,602
note_successful_decrypting_time_in_ms	288 (-1%)	856	3,125
note_trial_decrypting_time_in_ms	90.0 (-1%)	65.0 (-2%)	134
l2_block_building_time_in_ms	13,187	52,283	208,359
l2_block_rollup_simulation_time_in_ms	11,857	47,011 (-1%)	187,290
l2_block_public_tx_process_time_in_ms	1,291	5,136	20,578

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,400 (-2%)	45,651 (+7%)
note_history_successful_decrypting_time_in_ms	1,992 (-4%)	4,141 (+2%)
note_history_trial_decrypting_time_in_ms	121	146 (+3%)
node_database_size_in_bytes	1,631,559	1,099,340
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	775	61,697	18,905
private-kernel-ordering	123	24,297	8,153
base-rollup	1,776	656,311	814
root-rollup	77.8 (-9%)	4,072	1,097
private-kernel-inner	792	81,568	18,905
public-kernel-private-input	41.3	41,519	18,841
public-kernel-non-first-iteration	26.1 (-1%)	41,497	18,841
merge-rollup	0.942 (-4%)	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-11-03T13:17:52Z

yarn-project/aztec.js/src/artifacts/ecdsa_account_contract.json

@@ -695,5 +695,6 @@
      "verificationKey": "0000000200000800000000740000000f00000003515f3109623eb3c25aa5b16a1a79fd558bac7a7ce62c4560a8c537c77ce80dd339128d1d37b6582ee9e6df9567efb64313471dfa18f520f9ce53161b50dbf7731bc5f900000003515f322bc4cce83a486a92c92fd59bd84e0f92595baa639fc2ed86b00ffa0dfded2a092a669a3bdb7a273a015eda494457cc7ed5236f26cee330c290d45a33b9daa94800000003515f332729426c008c085a81bd34d8ef12dd31e80130339ef99d50013a89e4558eee6d0fa4ffe2ee7b7b62eb92608b2251ac31396a718f9b34978888789042b790a30100000003515f342be6b6824a913eb7a57b03cb1ee7bfb4de02f2f65fe8a4e97baa7766ddb353a82a8a25c49dc63778cd9fe96173f12a2bc77f3682f4c4448f98f1df82c75234a100000003515f351f85760d6ab567465aadc2f180af9eae3800e6958fec96aef53fd8a7b195d7c000c6267a0dd5cfc22b3fe804f53e266069c0e36f51885baec1e7e67650c62e170000000c515f41524954484d455449430d9d0f8ece2aa12012fa21e6e5c859e97bd5704e5c122064a66051294bc5e04213f61f54a0ebdf6fee4d4a6ecf693478191de0c2899bcd8e86a636c8d3eff43400000003515f43224a99d02c86336737c8dd5b746c40d2be6aead8393889a76a18d664029096e90f7fe81adcc92a74350eada9622ac453f49ebac24a066a1f83b394df54dfa0130000000c515f46495845445f42415345060e8a013ed289c2f9fd7473b04f6594b138ddb4b4cf6b901622a14088f04b8d2c83ff74fce56e3d5573b99c7b26d85d5046ce0c6559506acb7a675e7713eb3a00000007515f4c4f4749430721a91cb8da4b917e054f72147e1760cfe0ef3d45090ac0f4961d84ec1996961a25e787b26bd8b50b1a99450f77a424a83513c2b33af268cd253b0587ff50c700000003515f4d05dbd8623b8652511e1eb38d38887a69eceb082f807514f09e127237c5213b401b9325b48c6c225968002318095f89d0ef9cf629b2b7f0172e03bc39aacf6ed800000007515f52414e474504b57a3805e41df328f5ca9aefa40fad5917391543b7b65c6476e60b8f72e9ad07c92f3b3e11c8feae96dedc4b14a6226ef3201244f37cfc1ee5b96781f48d2b000000075349474d415f3125001d1954a18571eaa007144c5a567bb0d2be4def08a8be918b8c05e3b27d312c59ed41e09e144eab5de77ca89a2fd783be702a47c951d3112e3de02ce6e47c000000075349474d415f3223994e6a23618e60fa01c449a7ab88378709197e186d48d604bfb6931ffb15ad11c5ec7a0700570f80088fd5198ab5d5c227f2ad2a455a6edeec024156bb7beb000000075349474d415f3300cda5845f23468a13275d18bddae27c6bb189cf9aa95b6a03a0cb6688c7e8d829639b45cf8607c525cc400b55ebf90205f2f378626dc3406cc59b2d1b474fba000000075349474d415f342d299e7928496ea2d37f10b43afd6a80c90a33b483090d18069ffa275eedb2fc2f82121e8de43dc036d99b478b6227ceef34248939987a19011f065d8b5cef5c0000000010000000000000000100000002000000030000000400000005000000060000000700000008000000090000000a0000000b0000000c0000000d0000000e0000000f"
    }
  ],
-  "events": []
+  "events": [],
+  "aztecNrVersion": ""


I'm unhappy about this but there's no way to determine the version in a general way when using relative paths :(

alexghr · 2023-11-03T13:18:19Z

yarn-project/cli/src/index.ts

@@ -247,6 +248,14 @@ export function getProgram(log: LogFn, debugLogger: DebugLogger): Command {
      const constructorArtifact = contractArtifact.functions.find(({ name }) => name === 'constructor');

      const client = await createCompatibleClient(rpcUrl, debugLogger);
+      const nodeInfo = await client.getNodeInfo();
+      const expectedAztecNrVersion = `${GITHUB_TAG_PREFIX}-v${nodeInfo.sandboxVersion}`;


Might be a good idea to bake in this version in getNodeInfo.

spypsy · 2023-11-03T14:53:08Z

yarn-project/noir-compiler/src/compile/noir/dependencies/dependency-resolver.ts

+/**
+ * A Noir dependency
+ */
+export type Dependency = {


Dependency is a bit generic, would it make sense to name it NoirDependency?

I renamed it to NoirDependency and renamed the resolver to NoirDependencyResolver to keep consistent

rahul-kothari · 2023-11-06T13:23:24Z

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

@@ -3,6 +3,7 @@
 exports[`noir-compiler using nargo compiles the test contract 1`] = `
 [
  {
+    "aztecNrVersion": undefined,


why is this undefined?

Can't determine the aztec.nr version when imported via relative path. Will be fixed with noir-lang/noir#3427.
As for why it ends up being undefined in the snapshot.. just jest things 😆

rahul-kothari · 2023-11-06T13:24:22Z

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

+   * Gets the version of Aztec.nr that was used compiling this contract.
+   */
+  public getResolvedAztecNrVersion() {
+    // TODO eliminate this hardcoded library name!


might want to create an issue so we actually prioritise it!

rahul-kothari · 2023-11-06T13:25:05Z

yarn-project/foundation/src/abi/abi.ts

+  /**
+   * The version of compiler used to create this artifact
+   */
+  aztecNrVersion?: string;


does this need to be optional? Shouldn't every contract have this?

I made it optional because:

we still have to guard against contracts compiled with an old compiler that didn't do this

our own contracts inside yarn-project/noir-contracts currently don't get this field set because they use relative paths to import Aztec.nr rather than git tags. Once this lands we should be able to fix this feat: Add package version to Nargo.toml metadata noir-lang/noir#3427

🤖 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 marked this pull request as draft November 3, 2023 11:46

alexghr marked this pull request as ready for review November 3, 2023 13:16

alexghr commented Nov 3, 2023

View reviewed changes

alexghr force-pushed the alexg/feat/versioned-contract-artifacts branch 3 times, most recently from 1a919a0 to 67ce7cf Compare November 3, 2023 14:39

spypsy reviewed Nov 3, 2023

View reviewed changes

spypsy approved these changes Nov 3, 2023

View reviewed changes

alexghr added 3 commits November 6, 2023 11:23

feat: tag artifacts with the compiler version

bdc656e

refactor: check Aztec.nr version instead of Noir

8f87216

refactor: better names for noir dependencies

904d7cb

alexghr force-pushed the alexg/feat/versioned-contract-artifacts branch from 67ce7cf to 904d7cb Compare November 6, 2023 11:23

rahul-kothari reviewed Nov 6, 2023

View reviewed changes

rahul-kothari approved these changes Nov 6, 2023

View reviewed changes

alexghr merged commit c7490c5 into master Nov 6, 2023
82 checks passed

alexghr deleted the alexg/feat/versioned-contract-artifacts branch November 6, 2023 14:33

AztecBot mentioned this pull request Nov 6, 2023

chore(master): Release 0.14.0 #3158

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: tag artifacts with the compiler version #3220

feat: tag artifacts with the compiler version #3220

alexghr commented Nov 3, 2023 •

edited

Loading

AztecBot commented Nov 3, 2023 •

edited

Loading

L2 block published to L1

L2 chain processing

Circuits stats

Miscellaneous

alexghr Nov 3, 2023 •

edited

Loading

alexghr Nov 3, 2023

spypsy Nov 3, 2023

alexghr Nov 6, 2023

rahul-kothari Nov 6, 2023

alexghr Nov 6, 2023

rahul-kothari Nov 6, 2023

rahul-kothari Nov 6, 2023

alexghr Nov 6, 2023 •

edited

Loading

feat: tag artifacts with the compiler version #3220

feat: tag artifacts with the compiler version #3220

Conversation

alexghr commented Nov 3, 2023 • edited Loading

Checklist:

AztecBot commented Nov 3, 2023 • edited Loading

Benchmark results

L2 block published to L1

L2 chain processing

Circuits stats

Miscellaneous

alexghr Nov 3, 2023 • edited Loading

Choose a reason for hiding this comment

alexghr Nov 3, 2023

Choose a reason for hiding this comment

spypsy Nov 3, 2023

Choose a reason for hiding this comment

alexghr Nov 6, 2023

Choose a reason for hiding this comment

rahul-kothari Nov 6, 2023

Choose a reason for hiding this comment

alexghr Nov 6, 2023

Choose a reason for hiding this comment

rahul-kothari Nov 6, 2023

Choose a reason for hiding this comment

rahul-kothari Nov 6, 2023

Choose a reason for hiding this comment

alexghr Nov 6, 2023 • edited Loading

Choose a reason for hiding this comment

alexghr commented Nov 3, 2023 •

edited

Loading

AztecBot commented Nov 3, 2023 •

edited

Loading

alexghr Nov 3, 2023 •

edited

Loading

alexghr Nov 6, 2023 •

edited

Loading