@aztec/aztec 0.0.1-commit.381b1a9 → 0.0.1-commit.3a4ae741b

package/scripts/add_crate.sh

@@ -0,0 +1,102 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Creates a contract+test crate pair and adds them to an existing workspace.
+# Usage: add_crate.sh <crate_name>
+# Must be called from a workspace root that already has Nargo.toml with [workspace].
+
+crate_name=$1
+
+if [ -z "$crate_name" ]; then
+  echo "Error: crate name is required"
+  exit 1
+fi
+
+if [[ "$crate_name" == *"/"* ]] || [[ "$crate_name" == *"\\"* ]]; then
+  echo "Error: crate name must not contain path separators"
+  exit 1
+fi
+
+contract_dir="${crate_name}_contract"
+test_dir="${crate_name}_test"
+
+if [ -d "$contract_dir" ]; then
+  echo "Error: directory '$contract_dir' already exists"
+  exit 1
+fi
+if [ -d "$test_dir" ]; then
+  echo "Error: directory '$test_dir' already exists"
+  exit 1
+fi
+
+# Get the actual aztec version for the git tag.
+AZTEC_VERSION=$(jq -r '.version' $(dirname $0)/../package.json)
+
+# Create contract crate
+mkdir -p "$contract_dir/src"
+cat > "$contract_dir/Nargo.toml" << CEOF
+[package]
+name = "${crate_name}_contract"
+type = "contract"
+
+[dependencies]
+aztec = { git="https://github.com/AztecProtocol/aztec-nr", tag="v${AZTEC_VERSION}", directory="aztec" }
+CEOF
+
+cat > "$contract_dir/src/main.nr" << 'EOF'
+use aztec::macros::aztec;
+
+#[aztec]
+pub contract Main {
+    use aztec::macros::functions::{external, initializer};
+
+    #[initializer]
+    #[external("private")]
+    fn constructor() {}
+}
+EOF
+
+# Create test crate
+mkdir -p "$test_dir/src"
+cat > "$test_dir/Nargo.toml" << TEOF
+[package]
+name = "${crate_name}_test"
+type = "lib"
+
+[dependencies]
+aztec = { git="https://github.com/AztecProtocol/aztec-nr", tag="v${AZTEC_VERSION}", directory="aztec" }
+${crate_name}_contract = { path = "../${contract_dir}" }
+TEOF
+
+cat > "$test_dir/src/lib.nr" << 'NOIR'
+use aztec::test::helpers::test_environment::TestEnvironment;
+use __CRATE_NAME___contract::Main;
+
+#[test]
+unconstrained fn test_constructor() {
+    let mut env = TestEnvironment::new();
+    let deployer = env.create_light_account();
+
+    // Deploy the contract with the default constructor:
+    let contract_address = env.deploy("@__CRATE_NAME___contract/Main").with_private_initializer(
+        deployer,
+        Main::interface().constructor(),
+    );
+
+    // Deploy without an initializer:
+    let contract_address = env.deploy("@__CRATE_NAME___contract/Main").without_initializer();
+}
+NOIR
+
+sed -i "s/__CRATE_NAME__/${crate_name}/g" "$test_dir/src/lib.nr"
+
+# Add members to workspace Nargo.toml
+if grep -q 'members\s*=\s*\[\s*\]' Nargo.toml; then
+  # Empty array: members = []
+  sed -i "s|members\s*=\s*\[\s*\]|members = [\"${contract_dir}\", \"${test_dir}\"]|" Nargo.toml
+else
+  # Non-empty array: add before closing ]
+  sed -i "s|\(members\s*=\s*\[.*\)\]|\1, \"${contract_dir}\", \"${test_dir}\"]|" Nargo.toml
+fi
+
+echo "Created crates '${contract_dir}' and '${test_dir}'"

package/scripts/aztec.sh

@@ -1,6 +1,5 @@
 #!/usr/bin/env bash
 set -euo pipefail
-shopt -s inherit_errexit
 
 # Re-execute using correct version if we have an .aztecrc file.
 if [ "${AZTEC_VERSIONED:-0}" -eq 0 ] && [ -f .aztecrc ] && command -v aztec-up &>/dev/null; then
@@ -21,6 +20,9 @@ function aztec {
 
 case $cmd in
   test)
+    # Attempt to compile, no-op if there are no changes
+    node --no-warnings "$script_dir/../dest/bin/index.js" compile
+
     export LOG_LEVEL="${LOG_LEVEL:-"error;trace:contract_log"}"
     aztec start --txe --port 8081 &
     server_pid=$!
@@ -47,7 +49,7 @@ case $cmd in
       export ETHEREUM_HOSTS=${ETHEREUM_HOSTS:-"http://127.0.0.1:${ANVIL_PORT}"}
 
       anvil --version
-      anvil --silent &
+      anvil --silent --port "$ANVIL_PORT" &
       anvil_pid=$!
       trap 'kill $anvil_pid &>/dev/null' EXIT
     fi

package/scripts/init.sh

@@ -1,35 +1,39 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
-NARGO=${NARGO:-nargo}
 script_path=$(realpath $(dirname "$0"))
 
-for arg in "$@"; do
-  if [ "$arg" == "--help" ] || [ "$arg" == "-h" ]; then
-    cat << 'EOF'
+# Parse arguments
+while [[ $# -gt 0 ]]; do
+  case $1 in
+    --help|-h)
+      cat << 'EOF'
 Aztec Init - Create a new Aztec Noir project in the current directory
 
-Usage: aztec init [OPTIONS]
+Usage: aztec init
 
 Options:
-  --name <NAME>  Name of the package [default: current directory name]
-  --lib          Use a library template
   -h, --help     Print help
 
-This command creates a new Aztec Noir project in the current directory using nargo
-and automatically adds the Aztec.nr dependency to your Nargo.toml file.
+This command creates a new Aztec Noir project in the current directory with
+a workspace containing a contract crate and a test crate, and automatically
+adds the Aztec.nr dependency to both.
 
+If a workspace already exists in the current directory, use
+'aztec new <name>' instead to add another contract.
 EOF
-    exit 0
-  fi
-  if [ "$arg" == "--lib" ]; then
-    is_contract=0
-  fi
+      exit 0
+      ;;
+    *)
+      echo "Error: unexpected argument '$1'"
+      echo "Usage: aztec init"
+      echo "Run 'aztec init --help' for more information"
+      exit 1
+      ;;
+  esac
 done
 
-echo "Initializing Noir project..."
-$NARGO init "$@"
+package_name="$(basename $(pwd))"
 
-if [ "${is_contract:-1}" -eq 1 ]; then
-  $script_path/setup_project.sh
-fi
+echo "Initializing Aztec contract project..."
+$script_path/setup_workspace.sh "$package_name"

package/scripts/new.sh

@@ -1,59 +1,83 @@
 #!/usr/bin/env bash
 set -euo pipefail
 
-NARGO=${NARGO:-nargo}
 script_path=$(realpath $(dirname "$0"))
 
-type_arg="--contract"
+project_path=""
 
 while [[ $# -gt 0 ]]; do
   case $1 in
     --help|-h)
       cat << 'EOF'
-Aztec New - Create a new Aztec Noir project in a new directory
+Aztec New - Create a new Aztec Noir project or add a contract to an existing workspace
 
-Usage: aztec new [OPTIONS] <PATH>
+Usage: aztec new <NAME>
 
 Arguments:
-  <PATH>  The path to save the new project
+  <NAME>  The name for the new contract (also used as the directory name when
+          creating a new workspace)
 
 Options:
-  --name <NAME>  Name of the package [default: package directory name]
-  --lib          Create a library template instead of a contract
   -h, --help     Print help
 
-This command creates a new Aztec Noir project using nargo and automatically
-adds the Aztec.nr dependency to your Nargo.toml file.
+When run outside an existing workspace:
+  Creates a new directory with a workspace containing a contract crate and a
+  test crate, and automatically adds the Aztec.nr dependency to both.
+
+When run inside an existing workspace (Nargo.toml with [workspace] exists):
+  Adds a new contract crate and test crate to the existing workspace.
 EOF
       exit 0
       ;;
-    --lib)
-      type_arg="--lib"
-      shift
-      ;;
-    --name)
-      name_arg="--name $2"
-      shift 2
+    -*)
+      echo "Error: unknown option '$1'"
+      echo "Usage: aztec new <NAME>"
+      echo "Run 'aztec new --help' for more information"
+      exit 1
       ;;
     *)
+      if [ -n "$project_path" ]; then
+        echo "Error: unexpected argument '$1'"
+        echo "Usage: aztec new <NAME>"
+        echo "Run 'aztec new --help' for more information"
+        exit 1
+      fi
       project_path=$1
       shift
-      break
       ;;
   esac
 done
 
 if [ -z "$project_path" ]; then
-  echo "Error: PATH argument is required"
-  echo "Usage: aztec new [OPTIONS] <PATH>"
+  echo "Error: NAME argument is required"
+  echo "Usage: aztec new <NAME>"
   echo "Run 'aztec new --help' for more information"
   exit 1
 fi
 
-echo "Creating new Noir project at $project_path..."
-$NARGO new $type_arg ${name_arg:-} $project_path
+package_name="$(basename $project_path)"
+
+# Validate that the name contains only valid Noir identifier characters
+if ! [[ "$package_name" =~ ^[a-zA-Z][a-zA-Z0-9_]*$ ]]; then
+  echo "Error: '$package_name' is not a valid contract name"
+  echo "Name must start with a letter and contain only letters, digits, and underscores"
+  exit 1
+fi
+
+# Check if we're inside an existing workspace
+if [ -f "Nargo.toml" ] && grep -q '\[workspace\]' Nargo.toml; then
+  # Add crate pair to existing workspace
+  echo "Adding contract '$package_name' to existing workspace..."
+  $script_path/add_crate.sh "$package_name"
+else
+  # Create new workspace
+  if [ -d "$project_path" ] && [ "$(ls -A $project_path 2>/dev/null)" ]; then
+    echo "Error: $project_path already exists and is not empty"
+    exit 1
+  fi
 
-if [ "$type_arg" == "--contract" ]; then
-  cd $project_path
-  $script_path/setup_project.sh
+  echo "Creating new Aztec contract project at $project_path..."
+  mkdir -p "$project_path"
+  cd "$project_path"
+  $script_path/setup_workspace.sh "$package_name"
 fi

package/scripts/setup_workspace.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Creates an Aztec contract workspace with a contract crate and a test crate.
+# Usage: setup_workspace.sh <package_name>
+# Must be called from the workspace root directory.
+
+package_name=$1
+script_path=$(realpath $(dirname "$0"))
+
+if [ -z "$package_name" ]; then
+  echo "Error: package name is required"
+  exit 1
+fi
+
+if [ -f "Nargo.toml" ]; then
+  echo "Error: Nargo.toml already exists in the current directory."
+  echo "To add another contract crate to this workspace, use 'aztec new <name>' instead."
+  exit 1
+fi
+
+# Create workspace root Nargo.toml with empty members (add_crate.sh will populate)
+cat > Nargo.toml << 'EOF'
+[workspace]
+members = []
+EOF
+
+# Create the first crate pair
+$script_path/add_crate.sh "$package_name"
+
+# Create README
+cat > README.md << REOF
+# ${package_name}
+
+An Aztec Noir contract project.
+
+## Compile
+
+\`\`\`bash
+aztec compile
+\`\`\`
+
+This compiles all contract crates and outputs artifacts to \`target/\`.
+
+## Test
+
+\`\`\`bash
+aztec test
+\`\`\`
+
+This runs all tests in the workspace.
+
+## Generate TypeScript bindings
+
+\`\`\`bash
+aztec codegen target -o src/artifacts
+\`\`\`
+
+This generates TypeScript contract artifacts from the compiled output in \`target/\` into \`src/artifacts/\`.
+REOF
+
+# Create .gitignore
+cat > .gitignore << 'GEOF'
+target/
+codegenCache.json
+GEOF
+
+echo "Created Aztec contract workspace with crates '${package_name}_contract' and '${package_name}_test'"

package/src/cli/aztec_start_action.ts

@@ -7,7 +7,7 @@ import {
 } from '@aztec/foundation/json-rpc/server';
 import type { LogFn, Logger } from '@aztec/foundation/log';
 import type { ChainConfig } from '@aztec/stdlib/config';
-import { AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
+import { AztecNodeAdminApiSchema, AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
 import { getPackageVersion } from '@aztec/stdlib/update-checker';
 import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
 import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
@@ -50,6 +50,7 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
     // Start Node and PXE JSON-RPC server
     signalHandlers.push(stop);
     services.node = [node, AztecNodeApiSchema];
+    adminServices.node = [node, AztecNodeAdminApiSchema];
   } else {
     // Route --prover-node through startNode
     if (options.proverNode && !options.node) {

package/src/cli/aztec_start_options.ts

@@ -12,7 +12,6 @@ import {
   isBooleanConfigValue,
   omitConfigMappings,
 } from '@aztec/foundation/config';
-import { dataConfigMappings } from '@aztec/kv-store/config';
 import { sharedNodeConfigMappings } from '@aztec/node-lib/config';
 import { bootnodeConfigMappings, p2pConfigMappings } from '@aztec/p2p/config';
 import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker/config';
@@ -20,6 +19,7 @@ import { proverNodeConfigMappings } from '@aztec/prover-node/config';
 import { allPxeConfigMappings } from '@aztec/pxe/config';
 import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
 import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
+import { dataConfigMappings } from '@aztec/stdlib/kv-store';
 import { telemetryClientConfigMappings } from '@aztec/telemetry-client/config';
 import { worldStateConfigMappings } from '@aztec/world-state/config';
 

package/src/cli/cli.ts

@@ -37,9 +37,9 @@ export function injectAztecCommands(program: Command, userLog: LogFn, debugLogge
       `
 Additional commands:
 
-  init [folder] [options]  creates a new Aztec Noir project.
-  new <path> [options]     creates a new Aztec Noir project in a new directory.
-  test [options]           starts a TXE and runs "nargo test" using it as the oracle resolver.
+  init               creates a new Aztec Noir workspace in the current directory.
+  new <name>         creates a new Aztec Noir workspace in its own directory (or creates a new contract-test crates pair and adds it to the current workspace if run in workspace).
+  test [options]     starts a TXE and runs "nargo test" using it as the oracle resolver.
     `,
     );
   }

package/src/cli/cmds/compile.ts

@@ -1,10 +1,13 @@
+import { findBbBinary } from '@aztec/bb.js';
 import type { LogFn } from '@aztec/foundation/log';
 
 import { execFileSync } from 'child_process';
 import type { Command } from 'commander';
 import { readFile, writeFile } from 'fs/promises';
+import { join } from 'path';
 
 import { readArtifactFiles } from './utils/artifacts.js';
+import { needsRecompile } from './utils/needs_recompile.js';
 import { run } from './utils/spawn.js';
 
 /** Returns paths to contract artifacts in the target directory. */
@@ -34,13 +37,121 @@ async function stripInternalPrefixes(artifactPaths: string[]): Promise<void> {
   }
 }
 
+/** Returns the set of package names that are contract crates in the current workspace. */
+async function getContractPackageNames(): Promise<Set<string>> {
+  const contractNames = new Set<string>();
+
+  let rootToml: string;
+  try {
+    rootToml = await readFile('Nargo.toml', 'utf-8');
+  } catch {
+    return contractNames;
+  }
+
+  const membersMatch = rootToml.match(/members\s*=\s*\[([^\]]*)\]/);
+  if (membersMatch) {
+    const members = membersMatch[1]
+      .split(',')
+      .map(m => m.trim().replace(/^"|"$/g, ''))
+      .filter(m => m.length > 0);
+
+    for (const member of members) {
+      try {
+        const memberToml = await readFile(join(member, 'Nargo.toml'), 'utf-8');
+        if (/type\s*=\s*"contract"/.test(memberToml)) {
+          const nameMatch = memberToml.match(/name\s*=\s*"([^"]+)"/);
+          if (nameMatch) {
+            contractNames.add(nameMatch[1]);
+          }
+        }
+      } catch {
+        // Member directory might not exist or have no Nargo.toml; skip.
+      }
+    }
+  } else {
+    // Single-crate project (no workspace): check if the root Nargo.toml itself is a contract.
+    if (/type\s*=\s*"contract"/.test(rootToml)) {
+      const nameMatch = rootToml.match(/name\s*=\s*"([^"]+)"/);
+      if (nameMatch) {
+        contractNames.add(nameMatch[1]);
+      }
+    }
+  }
+
+  return contractNames;
+}
+
+/** Checks that no tests exist in contract crates and fails with a helpful message if they do. */
+async function checkNoTestsInContracts(nargo: string, log: LogFn): Promise<void> {
+  const contractPackages = await getContractPackageNames();
+  if (contractPackages.size === 0) {
+    return;
+  }
+
+  let output: string;
+  try {
+    // We list tests for all the crates in the workspace
+    output = execFileSync(nargo, ['test', '--list-tests', '--silence-warnings'], {
+      encoding: 'utf-8',
+      stdio: ['pipe', 'pipe', 'inherit'],
+    });
+  } catch {
+    // If listing tests fails (e.g. test crate has compile errors), skip the check.
+    return;
+  }
+
+  // The output of the `nargo test --list-tests` command is as follows:
+  // ```
+  // crate_name_1 test_name_1
+  // crate_name_2 test_name_2
+  // ...
+  // crate_name_n test_name_n
+  // ```
+  //
+  // We parse the individual lines and then we check if any contract crate appeared in the parsed output.
+  const lines = output
+    .trim()
+    .split('\n')
+    .filter(line => line.length > 0);
+  const testsInContracts: { packageName: string; testName: string }[] = [];
+
+  for (const line of lines) {
+    const spaceIndex = line.indexOf(' ');
+    if (spaceIndex === -1) {
+      continue;
+    }
+    const packageName = line.substring(0, spaceIndex);
+    const testName = line.substring(spaceIndex + 1);
+    if (contractPackages.has(packageName)) {
+      testsInContracts.push({ packageName, testName });
+    }
+  }
+
+  if (testsInContracts.length > 0) {
+    const details = testsInContracts.map(t => `  ${t.packageName}::${t.testName}`).join('\n');
+    log(
+      `WARNING: Found tests in contract crate(s):\n${details}\n\n` +
+        `Tests should be in a dedicated test crate, not in the contract crate.\n` +
+        `Learn more: https://docs.aztec.network/errors/1`,
+    );
+  }
+}
+
 /** Compiles Aztec Noir contracts and postprocesses artifacts. */
 async function compileAztecContract(nargoArgs: string[], log: LogFn): Promise<void> {
+  if (!(await needsRecompile())) {
+    log('No source changes detected, skipping compilation.');
+    return;
+  }
+
   const nargo = process.env.NARGO ?? 'nargo';
-  const bb = process.env.BB ?? 'bb';
+  const bb = process.env.BB ?? findBbBinary() ?? 'bb';
 
   await run(nargo, ['compile', ...nargoArgs]);
 
+  // Ensure contract crates contain no tests (tests belong in the test crate).
+  await checkNoTestsInContracts(nargo, log);
+
   const artifacts = await collectContractArtifacts();
 
   if (artifacts.length > 0) {

package/src/cli/cmds/profile_flamegraph.ts

@@ -1,3 +1,4 @@
+import { findBbBinary } from '@aztec/bb.js';
 import type { LogFn } from '@aztec/foundation/log';
 
 import { readFile, rename, rm, writeFile } from 'fs/promises';
@@ -33,7 +34,7 @@ export async function profileFlamegraph(artifactPath: string, functionName: stri
     await writeFile(functionArtifact, makeFunctionArtifact(artifact, func));
 
     const profiler = process.env.PROFILER_PATH ?? 'noir-profiler';
-    const bb = process.env.BB ?? 'bb';
+    const bb = process.env.BB ?? findBbBinary() ?? 'bb';
 
     await run(profiler, [
       'gates',

package/src/cli/cmds/profile_gates.ts

@@ -1,3 +1,4 @@
+import { findBbBinary } from '@aztec/bb.js';
 import { asyncPool } from '@aztec/foundation/async-pool';
 import type { LogFn } from '@aztec/foundation/log';
 
@@ -32,7 +33,7 @@ async function getGateCount(bb: string, artifactPath: string): Promise<number> {
 
 /** Profiles all compiled artifacts in a target directory and prints gate counts. */
 export async function profileGates(targetDir: string, log: LogFn): Promise<void> {
-  const bb = process.env.BB ?? 'bb';
+  const bb = process.env.BB ?? findBbBinary() ?? 'bb';
   const { artifacts, tmpDir } = await discoverArtifacts(targetDir);
 
   if (artifacts.length === 0) {

package/src/cli/cmds/start_archiver.ts

@@ -3,8 +3,8 @@ import { createLogger } from '@aztec/aztec.js/log';
 import { type BlobClientConfig, blobClientConfigMapping, createBlobClient } from '@aztec/blob-client/client';
 import { getL1Config } from '@aztec/cli/config';
 import type { NamespacedApiHandlers } from '@aztec/foundation/json-rpc/server';
-import { type DataStoreConfig, dataConfigMappings } from '@aztec/kv-store/config';
 import { ArchiverApiSchema } from '@aztec/stdlib/interfaces/server';
+import { type DataStoreConfig, dataConfigMappings } from '@aztec/stdlib/kv-store';
 import { getConfigEnvVars as getTelemetryClientConfig, initTelemetryClient } from '@aztec/telemetry-client';
 
 import { extractRelevantOptions } from '../util.js';