From afca819166b9b5882b5d94062ac50cbb8dc590fb Mon Sep 17 00:00:00 2001 From: Santiago Palladino Date: Thu, 18 Jan 2024 07:37:49 -0300 Subject: [PATCH] chore: Remove unused noir-version json (#4105) Given we're now releasing aztec nargo from the monorepo with the same versioning as the other packages, `noir-version.json` is no longer needed. As part of this changeset, removes all references to noir versions from the docs (last ones were around installing nargo just for LSP, which are being removed [here](https://github.com/AztecProtocol/aztec-packages/pull/4110/)), removes the exported noir-version from noir-compiler, and removes the `compatibleNargoVersion` from node-info since it's no longer used. And besides, we were returning the string `portal:../../noir/packages/noir_wasm` as `compatibleNargoVersion` from the pxe :facepalm:. --- build_manifest.yml | 1 - docs/README.md | 11 ----------- docs/docs/dev_docs/contracts/main.md | 4 ---- .../getting_started/aztecjs-getting-started.md | 5 ----- .../getting_started/aztecnr-getting-started.md | 4 ---- docs/docusaurus.config.js | 10 +--------- .../src/components/InstallNargoInstructions/index.js | 12 ------------ docs/src/components/Version/index.js | 1 - docs/src/preprocess/include_version.js | 8 -------- docs/src/theme/MDXComponents.js | 8 +------- yarn-project/aztec-sandbox/src/bin/index.ts | 9 ++++----- yarn-project/aztec.js/src/contract/contract.test.ts | 1 - yarn-project/cli/src/cmds/get_node_info.ts | 1 - yarn-project/end-to-end/src/cli_docs_sandbox.test.ts | 1 - yarn-project/noir-compiler/package.json | 4 +--- yarn-project/noir-compiler/src/index.ts | 2 -- yarn-project/noir-compiler/src/noir-version.json | 4 ---- yarn-project/noir-compiler/src/versions.ts | 12 ------------ yarn-project/pxe/src/pxe_service/pxe_service.ts | 2 -- yarn-project/types/src/interfaces/node-info.ts | 4 ---- yarn-project/yarn.lock | 9 --------- 21 files changed, 7 insertions(+), 106 deletions(-) delete mode 100644 docs/src/components/InstallNargoInstructions/index.js delete mode 100644 yarn-project/noir-compiler/src/noir-version.json delete mode 100644 yarn-project/noir-compiler/src/versions.ts diff --git a/build_manifest.yml b/build_manifest.yml index 8924d81aa80..ea8880f74d0 100644 --- a/build_manifest.yml +++ b/build_manifest.yml @@ -201,7 +201,6 @@ docs: - ^.*.hpp$ - ^.*.ts$ - ^.release-please-manifest.json$ - - ^.*/noir-version.json$ - ^.*.nr$ dependencies: - yarn-project diff --git a/docs/README.md b/docs/README.md index d07cc7f3981..f1fae6d86ce 100644 --- a/docs/README.md +++ b/docs/README.md @@ -133,14 +133,3 @@ Alternatively, you can also use the `AztecPackagesVersion()` js function, which import { AztecPackagesVersion } from "@site/src/components/Version"; <>{AztecPackagesVersion()} ``` - - ### `#include_noir_version` - -This macros will be replaced inline with the required nargo version, which is `0.11.1-aztec.0` at the time of these writing. This value is sourced from `yarn-project/noir-compiler/src/noir-version.json`. - -Alternatively, you can also use the `NoirVersion()` js function, which you need to import explicitly: - -``` -import { NoirVersion } from "@site/src/components/Version"; -<>{NoirVersion()} -``` diff --git a/docs/docs/dev_docs/contracts/main.md b/docs/docs/dev_docs/contracts/main.md index 152ef5f0a8a..36a2d59f496 100644 --- a/docs/docs/dev_docs/contracts/main.md +++ b/docs/docs/dev_docs/contracts/main.md @@ -30,10 +30,6 @@ For those coming from vanilla Noir, the version used for aztec.nr is tracked sep `aztec-nargo` comes with the Noir compiler, so installing `nargo` is not required, however it is recommended as it provides a better developer experience for writing contracts. You will need nargo installed to take advantage of the [Noir Language Server](https://noir-lang.org/docs/getting_started/tooling/language_server), which provides syntax highlighting and formatting for your Aztec contracts. -You can install `nargo` with the following commands: - - - ## Install Noir tooling There are a number of tools to make writing Aztec.nr contracts in Noir more pleasant. See [here](https://github.com/noir-lang/awesome-noir#get-coding). diff --git a/docs/docs/dev_docs/getting_started/aztecjs-getting-started.md b/docs/docs/dev_docs/getting_started/aztecjs-getting-started.md index f71af8aa883..637da709e60 100644 --- a/docs/docs/dev_docs/getting_started/aztecjs-getting-started.md +++ b/docs/docs/dev_docs/getting_started/aztecjs-getting-started.md @@ -122,7 +122,6 @@ A successful run should show something like this: ``` token Aztec Sandbox Info { token sandboxVersion: '#include_aztec_short_version', - token compatibleNargoVersion: '#include_noir_version', token chainId: 31337, token protocolVersion: 1, token l1ContractAddresses: { @@ -168,7 +167,6 @@ Now that we have our accounts loaded, let's move on to deploy our pre-compiled t ``` token Aztec Sandbox Info { token sandboxVersion: '#include_aztec_short_version', - token compatibleNargoVersion: '#include_noir_version', token chainId: 31337, token protocolVersion: 1, token l1ContractAddresses: { @@ -220,7 +218,6 @@ Running now should yield output: ``` token Aztec Sandbox Info { token sandboxVersion: '#include_aztec_short_version', - token compatibleNargoVersion: '#include_noir_version', token chainId: 31337, token protocolVersion: 1, token l1ContractAddresses: { @@ -282,7 +279,6 @@ Our output should now look like this: ``` token Aztec Sandbox Info { token sandboxVersion: '#include_aztec_short_version', - token compatibleNargoVersion: '#include_noir_version', token chainId: 31337, token protocolVersion: 1, token l1ContractAddresses: { @@ -339,7 +335,6 @@ Our complete output should now be something like: ``` token Aztec Sandbox Info { token sandboxVersion: '#include_aztec_short_version', - token compatibleNargoVersion: '#include_noir_version', token chainId: 31337, token protocolVersion: 1, token l1ContractAddresses: { diff --git a/docs/docs/dev_docs/getting_started/aztecnr-getting-started.md b/docs/docs/dev_docs/getting_started/aztecnr-getting-started.md index 846a8c8b848..f9c7906b10c 100644 --- a/docs/docs/dev_docs/getting_started/aztecnr-getting-started.md +++ b/docs/docs/dev_docs/getting_started/aztecnr-getting-started.md @@ -211,10 +211,6 @@ The CLI comes with the Noir compiler, so installing `nargo` is not required, how You will also need `nargo` if you want to run unit tests in Noir. -You can install `nargo` with the following commands: - - - ## What's next? Now you can explore. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 5f19cd0a574..efe1271187e 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -82,13 +82,6 @@ const config = { name: "load-versions", async loadContent() { try { - const noirVersionPath = path.resolve( - __dirname, - "../yarn-project/noir-compiler/src/noir-version.json" - ); - const noirVersion = JSON.parse( - fs.readFileSync(noirVersionPath).toString() - ).tag; const aztecVersionPath = path.resolve( __dirname, "../.release-please-manifest.json" @@ -97,12 +90,11 @@ const config = { fs.readFileSync(aztecVersionPath).toString() )["."]; return { - noir: noirVersion, "aztec-packages": `aztec-packages-v${aztecVersion}`, }; } catch (err) { throw new Error( - `Error loading Noir version from noir-compiler in docusaurus build. Check load-versions in docusaurus.config.js.\n${err}` + `Error loading versions in docusaurus build. Check load-versions in docusaurus.config.js.\n${err}` ); } }, diff --git a/docs/src/components/InstallNargoInstructions/index.js b/docs/src/components/InstallNargoInstructions/index.js deleted file mode 100644 index 2ee7437259b..00000000000 --- a/docs/src/components/InstallNargoInstructions/index.js +++ /dev/null @@ -1,12 +0,0 @@ -import React from "react"; -import CodeBlock from "@theme/CodeBlock"; -import { NoirVersion } from "@site/src/components/Version"; - -export default function InstallNargoInstructions() { - return ( - - {`curl -L https://raw.githubusercontent.com/noir-lang/noirup/main/install | bash -noirup -v ${NoirVersion()}`} - - ); -} diff --git a/docs/src/components/Version/index.js b/docs/src/components/Version/index.js index 01bf315f222..36599d90c82 100644 --- a/docs/src/components/Version/index.js +++ b/docs/src/components/Version/index.js @@ -7,5 +7,4 @@ export default function Version({ what }) { return Versions()[what]; } -export const NoirVersion = () => Versions()["noir"]; export const AztecPackagesVersion = () => Versions()["aztec-packages"]; \ No newline at end of file diff --git a/docs/src/preprocess/include_version.js b/docs/src/preprocess/include_version.js index afa372e0a04..529e93d0adb 100644 --- a/docs/src/preprocess/include_version.js +++ b/docs/src/preprocess/include_version.js @@ -7,13 +7,6 @@ let versions; async function getVersions() { if (!versions) { try { - const noirVersionPath = path.resolve( - __dirname, - "../../../yarn-project/noir-compiler/src/noir-version.json" - ); - const noirVersion = JSON.parse( - fs.readFileSync(noirVersionPath).toString() - ).tag; const aztecVersionPath = path.resolve( __dirname, "../../../.release-please-manifest.json" @@ -22,7 +15,6 @@ async function getVersions() { fs.readFileSync(aztecVersionPath).toString() )["."]; versions = { - noir: noirVersion, aztec: `aztec-packages-v${aztecVersion}`, aztec_short: aztecVersion, }; diff --git a/docs/src/theme/MDXComponents.js b/docs/src/theme/MDXComponents.js index 4593ab51e68..28e247751f4 100644 --- a/docs/src/theme/MDXComponents.js +++ b/docs/src/theme/MDXComponents.js @@ -1,18 +1,12 @@ import React from "react"; import MDXComponents from "@theme-original/MDXComponents"; -import Version, { - NoirVersion, - AztecPackagesVersion, -} from "@site/src/components/Version"; -import InstallNargoInstructions from "@site/src/components/InstallNargoInstructions"; +import Version, { AztecPackagesVersion } from "@site/src/components/Version"; import CodeBlock from "@theme/CodeBlock"; // https://docusaurus.io/docs/markdown-features/react#mdx-component-scope export default { ...MDXComponents, Version, - NoirVersion, AztecPackagesVersion, - InstallNargoInstructions, CodeBlock, }; diff --git a/yarn-project/aztec-sandbox/src/bin/index.ts b/yarn-project/aztec-sandbox/src/bin/index.ts index 75b8d311347..97aa2d790ea 100644 --- a/yarn-project/aztec-sandbox/src/bin/index.ts +++ b/yarn-project/aztec-sandbox/src/bin/index.ts @@ -7,7 +7,6 @@ import { init } from '@aztec/foundation/crypto'; import { createStatusRouter, startHttpRpcServer } from '@aztec/foundation/json-rpc/server'; import { createDebugLogger } from '@aztec/foundation/log'; import { fileURLToPath } from '@aztec/foundation/url'; -import { NoirCommit, NoirTag } from '@aztec/noir-compiler/versions'; import { BootstrapNode, getP2PConfigEnvVars } from '@aztec/p2p'; import { GrumpkinScalar, PXEService, createPXERpcServer } from '@aztec/pxe'; @@ -121,7 +120,7 @@ async function main() { // Code path for starting Sandbox if (mode === SandboxMode.Sandbox) { - logger.info(`Setting up Aztec Sandbox v${version} (noir ${NoirCommit} ${NoirTag}), please stand by...`); + logger.info(`Setting up Aztec Sandbox v${version} please stand by...`); const { pxe, node, stop, accounts } = await createAndInitialiseSandbox(deployTestAccounts); @@ -139,7 +138,7 @@ async function main() { const accountLogStrings = await createAccountLogs(accounts, pxe); logStrings.push(...accountLogStrings); } - logStrings.push(`Aztec Sandbox v${version} (noir ${NoirCommit}) is now ready for use!`); + logStrings.push(`Aztec Sandbox v${version} is now ready for use!`); } else if (mode === SandboxMode.Node) { // Code path for starting Node only const nodeConfig = getNodeConfigEnvVars(); @@ -170,7 +169,7 @@ async function main() { const httpServer = http.createServer(app.callback()); httpServer.listen(port); - logStrings.push(`Aztec Node v${version} (noir ${NoirCommit}) is now ready for use in port ${port}!`); + logStrings.push(`Aztec Node v${version} is now ready for use in port ${port}!`); } else if (mode === SandboxMode.PXE) { // Code path for starting PXE only @@ -190,7 +189,7 @@ async function main() { logStrings.push(...accountLogStrings); } - logStrings.push(`PXE v${version} (noir ${NoirCommit}) is now ready for use in port ${PXE_PORT}!`); + logStrings.push(`PXE v${version} is now ready for use in port ${PXE_PORT}!`); } else if (mode === SandboxMode.P2PBootstrap) { // Code path for starting a P2P bootstrap node const config = getP2PConfigEnvVars(); diff --git a/yarn-project/aztec.js/src/contract/contract.test.ts b/yarn-project/aztec.js/src/contract/contract.test.ts index 8f05d08a139..f9800982b05 100644 --- a/yarn-project/aztec.js/src/contract/contract.test.ts +++ b/yarn-project/aztec.js/src/contract/contract.test.ts @@ -29,7 +29,6 @@ describe('Contract Class', () => { }; const mockNodeInfo: NodeInfo = { nodeVersion: 'vx.x.x', - compatibleNargoVersion: 'vx.x.x-aztec.x', chainId: 1, protocolVersion: 2, l1ContractAddresses: l1Addresses, diff --git a/yarn-project/cli/src/cmds/get_node_info.ts b/yarn-project/cli/src/cmds/get_node_info.ts index 4d98da411cd..2f14d5f5a24 100644 --- a/yarn-project/cli/src/cmds/get_node_info.ts +++ b/yarn-project/cli/src/cmds/get_node_info.ts @@ -10,7 +10,6 @@ export async function getNodeInfo(rpcUrl: string, debugLogger: DebugLogger, log: const info = await client.getNodeInfo(); log(`\nNode Info:\n`); log(`Node Version: ${info.nodeVersion}\n`); - log(`Compatible Nargo Version: ${info.compatibleNargoVersion}\n`); log(`Chain Id: ${info.chainId}\n`); log(`Protocol Version: ${info.protocolVersion}\n`); log(`Rollup Address: ${info.l1ContractAddresses.rollupAddress.toString()}`); diff --git a/yarn-project/end-to-end/src/cli_docs_sandbox.test.ts b/yarn-project/end-to-end/src/cli_docs_sandbox.test.ts index 46411f3e3af..c03353a9a88 100644 --- a/yarn-project/end-to-end/src/cli_docs_sandbox.test.ts +++ b/yarn-project/end-to-end/src/cli_docs_sandbox.test.ts @@ -30,7 +30,6 @@ describe('CLI docs sandbox', () => { Node Info: Node Version: #include_aztec_short_version -Compatible Nargo Version: #include_noir_version Chain Id: 31337 Protocol Version: 1 Rollup Address: 0x0dcd1bf9a1b36ce34237eeafef220932846bcd82 diff --git a/yarn-project/noir-compiler/package.json b/yarn-project/noir-compiler/package.json index 71c96a4db41..dc90ce3ca62 100644 --- a/yarn-project/noir-compiler/package.json +++ b/yarn-project/noir-compiler/package.json @@ -4,8 +4,7 @@ "type": "module", "exports": { ".": "./dest/index.js", - "./cli": "./dest/cli/index.js", - "./versions": "./dest/versions.js" + "./cli": "./dest/cli/index.js" }, "typedocOptions": { "entryPoints": [ @@ -49,7 +48,6 @@ "@aztec/foundation": "workspace:^", "@aztec/types": "workspace:^", "@iarna/toml": "^2.2.5", - "@noir-lang/noir_wasm": "portal:../../noir/packages/noir_wasm", "base64-js": "^1.5.1", "commander": "^9.0.0", "fs-extra": "^11.1.1", diff --git a/yarn-project/noir-compiler/src/index.ts b/yarn-project/noir-compiler/src/index.ts index 88416ef4282..a28e4f09303 100644 --- a/yarn-project/noir-compiler/src/index.ts +++ b/yarn-project/noir-compiler/src/index.ts @@ -1,4 +1,2 @@ -export * from './versions.js'; - export { generateTypescriptContractInterface } from './contract-interface-gen/typescript.js'; export { generateNoirContractInterface } from './contract-interface-gen/noir.js'; diff --git a/yarn-project/noir-compiler/src/noir-version.json b/yarn-project/noir-compiler/src/noir-version.json deleted file mode 100644 index e81ecb08315..00000000000 --- a/yarn-project/noir-compiler/src/noir-version.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "tag": "v0.18.0-aztec.5", - "commit": "6ca33a223ccce6a295414a3ce078180e8a22b68c" -} diff --git a/yarn-project/noir-compiler/src/versions.ts b/yarn-project/noir-compiler/src/versions.ts deleted file mode 100644 index 9cf6fd768b3..00000000000 --- a/yarn-project/noir-compiler/src/versions.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { readFile } from 'node:fs/promises'; - -import NoirVersion from './noir-version.json' assert { type: 'json' }; - -// read package.json at runtime instead of compile time so that we keep rootDir as-is in tsconfig -const pkg = JSON.parse(await readFile(new URL('../package.json', import.meta.url), 'utf-8')); - -export const NoirWasmVersion = pkg.dependencies['@noir-lang/noir_wasm']; -export const NoirTag = NoirVersion.tag; -export const NoirCommit = NoirVersion.commit; - -export { NoirVersion }; diff --git a/yarn-project/pxe/src/pxe_service/pxe_service.ts b/yarn-project/pxe/src/pxe_service/pxe_service.ts index 3350aea7d65..0d732971158 100644 --- a/yarn-project/pxe/src/pxe_service/pxe_service.ts +++ b/yarn-project/pxe/src/pxe_service/pxe_service.ts @@ -52,7 +52,6 @@ import { Fr } from '@aztec/foundation/fields'; import { SerialQueue } from '@aztec/foundation/fifo'; import { DebugLogger, createDebugLogger } from '@aztec/foundation/log'; import { Timer } from '@aztec/foundation/timer'; -import { NoirWasmVersion } from '@aztec/noir-compiler/versions'; import { NodeInfo } from '@aztec/types/interfaces'; import { PXEServiceConfig, getPackageInfo } from '../config/index.js'; @@ -488,7 +487,6 @@ export class PXEService implements PXE { const nodeInfo: NodeInfo = { nodeVersion: this.nodeVersion, - compatibleNargoVersion: NoirWasmVersion, chainId, protocolVersion: version, l1ContractAddresses: contractAddresses, diff --git a/yarn-project/types/src/interfaces/node-info.ts b/yarn-project/types/src/interfaces/node-info.ts index 1831263c0e3..48d77996d89 100644 --- a/yarn-project/types/src/interfaces/node-info.ts +++ b/yarn-project/types/src/interfaces/node-info.ts @@ -8,10 +8,6 @@ export interface NodeInfo { * Version as tracked in the aztec-packages repository. */ nodeVersion: string; - /** - * The nargo version compatible with this node version - */ - compatibleNargoVersion: string; /** * L1 chain id. */ diff --git a/yarn-project/yarn.lock b/yarn-project/yarn.lock index b5e32659fad..305751891f5 100644 --- a/yarn-project/yarn.lock +++ b/yarn-project/yarn.lock @@ -611,7 +611,6 @@ __metadata: "@aztec/types": "workspace:^" "@iarna/toml": ^2.2.5 "@jest/globals": ^29.5.0 - "@noir-lang/noir_wasm": "portal:../../noir/packages/noir_wasm" "@types/fs-extra": ^11.0.1 "@types/jest": ^29.5.0 "@types/lodash.camelcase": ^4.3.7 @@ -2814,14 +2813,6 @@ __metadata: languageName: node linkType: soft -"@noir-lang/noir_wasm@portal:../noir/packages/noir_wasm::locator=%40aztec%2Faztec3-packages%40workspace%3A.": - version: 0.0.0-use.local - resolution: "@noir-lang/noir_wasm@portal:../noir/packages/noir_wasm::locator=%40aztec%2Faztec3-packages%40workspace%3A." - dependencies: - pako: ^2.1.0 - languageName: node - linkType: soft - "@noir-lang/noirc_abi@portal:../noir/packages/noirc_abi::locator=%40aztec%2Faztec3-packages%40workspace%3A.": version: 0.0.0-use.local resolution: "@noir-lang/noirc_abi@portal:../noir/packages/noirc_abi::locator=%40aztec%2Faztec3-packages%40workspace%3A."